1 /****************************************************************************** 2 * 3 * Name: acresrc.h - Resource Manager function prototypes 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2016, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 26 * make derivatives, distribute, use and display any portion of the Covered 27 * Code in any form, with the right to sublicense such rights; and 28 * 29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 30 * license (with the right to sublicense), under only those claims of Intel 31 * patents that are infringed by the Original Intel Code, to make, use, sell, 32 * offer to sell, and import the Covered Code and derivative works thereof 33 * solely to the minimum extent necessary to exercise the above copyright 34 * license, and in no event shall the patent license extend to any additions 35 * to or modifications of the Original Intel Code. No other license or right 36 * is granted directly or by implication, estoppel or otherwise; 37 * 38 * The above copyright and patent license is granted only if the following 39 * conditions are met: 40 * 41 * 3. Conditions 42 * 43 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 44 * Redistribution of source code of any substantial portion of the Covered 45 * Code or modification with rights to further distribute source must include 46 * the above Copyright Notice, the above License, this list of Conditions, 47 * and the following Disclaimer and Export Compliance provision. In addition, 48 * Licensee must cause all Covered Code to which Licensee contributes to 49 * contain a file documenting the changes Licensee made to create that Covered 50 * Code and the date of any change. Licensee must include in that file the 51 * documentation of any changes made by any predecessor Licensee. Licensee 52 * must include a prominent statement that the modification is derived, 53 * directly or indirectly, from Original Intel Code. 54 * 55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 56 * Redistribution of source code of any substantial portion of the Covered 57 * Code or modification without rights to further distribute source must 58 * include the following Disclaimer and Export Compliance provision in the 59 * documentation and/or other materials provided with distribution. In 60 * addition, Licensee may not authorize further sublicense of source of any 61 * portion of the Covered Code, and must include terms to the effect that the 62 * license from Licensee to its licensee is limited to the intellectual 63 * property embodied in the software Licensee provides to its licensee, and 64 * not to intellectual property embodied in modifications its licensee may 65 * make. 66 * 67 * 3.3. Redistribution of Executable. Redistribution in executable form of any 68 * substantial portion of the Covered Code or modification must reproduce the 69 * above Copyright Notice, and the following Disclaimer and Export Compliance 70 * provision in the documentation and/or other materials provided with the 71 * distribution. 72 * 73 * 3.4. Intel retains all right, title, and interest in and to the Original 74 * Intel Code. 75 * 76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 77 * Intel shall be used in advertising or otherwise to promote the sale, use or 78 * other dealings in products derived from or relating to the Covered Code 79 * without prior written authorization from Intel. 80 * 81 * 4. Disclaimer and Export Compliance 82 * 83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 89 * PARTICULAR PURPOSE. 90 * 91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 98 * LIMITED REMEDY. 99 * 100 * 4.3. Licensee shall not export, either directly or indirectly, any of this 101 * software or system incorporating such software without first obtaining any 102 * required license or other approval from the U. S. Department of Commerce or 103 * any other agency or department of the United States Government. In the 104 * event Licensee exports any such software from the United States or 105 * re-exports any such software from a foreign destination, Licensee shall 106 * ensure that the distribution and export/re-export of the software is in 107 * compliance with all laws, regulations, orders, or other restrictions of the 108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 109 * any of its subsidiaries will export/re-export any technical data, process, 110 * software, or service, directly or indirectly, to any country for which the 111 * United States government or any agency thereof requires an export license, 112 * other governmental approval, or letter of assurance, without first obtaining 113 * such license, approval or letter. 114 * 115 *****************************************************************************/ 116 117 #ifndef __ACRESRC_H__ 118 #define __ACRESRC_H__ 119 120 /* Need the AML resource descriptor structs */ 121 122 #include "amlresrc.h" 123 124 125 /* 126 * If possible, pack the following structures to byte alignment, since we 127 * don't care about performance for debug output. Two cases where we cannot 128 * pack the structures: 129 * 130 * 1) Hardware does not support misaligned memory transfers 131 * 2) Compiler does not support pointers within packed structures 132 */ 133 #if (!defined(ACPI_MISALIGNMENT_NOT_SUPPORTED) && !defined(ACPI_PACKED_POINTERS_NOT_SUPPORTED)) 134 #pragma pack(1) 135 #endif 136 137 /* 138 * Individual entry for the resource conversion tables 139 */ 140 typedef const struct acpi_rsconvert_info 141 { 142 UINT8 Opcode; 143 UINT8 ResourceOffset; 144 UINT8 AmlOffset; 145 UINT8 Value; 146 147 } ACPI_RSCONVERT_INFO; 148 149 /* Resource conversion opcodes */ 150 151 typedef enum 152 { 153 ACPI_RSC_INITGET = 0, 154 ACPI_RSC_INITSET, 155 ACPI_RSC_FLAGINIT, 156 ACPI_RSC_1BITFLAG, 157 ACPI_RSC_2BITFLAG, 158 ACPI_RSC_3BITFLAG, 159 ACPI_RSC_ADDRESS, 160 ACPI_RSC_BITMASK, 161 ACPI_RSC_BITMASK16, 162 ACPI_RSC_COUNT, 163 ACPI_RSC_COUNT16, 164 ACPI_RSC_COUNT_GPIO_PIN, 165 ACPI_RSC_COUNT_GPIO_RES, 166 ACPI_RSC_COUNT_GPIO_VEN, 167 ACPI_RSC_COUNT_SERIAL_RES, 168 ACPI_RSC_COUNT_SERIAL_VEN, 169 ACPI_RSC_DATA8, 170 ACPI_RSC_EXIT_EQ, 171 ACPI_RSC_EXIT_LE, 172 ACPI_RSC_EXIT_NE, 173 ACPI_RSC_LENGTH, 174 ACPI_RSC_MOVE_GPIO_PIN, 175 ACPI_RSC_MOVE_GPIO_RES, 176 ACPI_RSC_MOVE_SERIAL_RES, 177 ACPI_RSC_MOVE_SERIAL_VEN, 178 ACPI_RSC_MOVE8, 179 ACPI_RSC_MOVE16, 180 ACPI_RSC_MOVE32, 181 ACPI_RSC_MOVE64, 182 ACPI_RSC_SET8, 183 ACPI_RSC_SOURCE, 184 ACPI_RSC_SOURCEX 185 186 } ACPI_RSCONVERT_OPCODES; 187 188 /* Resource Conversion sub-opcodes */ 189 190 #define ACPI_RSC_COMPARE_AML_LENGTH 0 191 #define ACPI_RSC_COMPARE_VALUE 1 192 193 #define ACPI_RSC_TABLE_SIZE(d) (sizeof (d) / sizeof (ACPI_RSCONVERT_INFO)) 194 195 #define ACPI_RS_OFFSET(f) (UINT8) ACPI_OFFSET (ACPI_RESOURCE,f) 196 #define AML_OFFSET(f) (UINT8) ACPI_OFFSET (AML_RESOURCE,f) 197 198 199 /* 200 * Individual entry for the resource dump tables 201 */ 202 typedef const struct acpi_rsdump_info 203 { 204 UINT8 Opcode; 205 UINT8 Offset; 206 const char *Name; 207 const char **Pointer; 208 209 } ACPI_RSDUMP_INFO; 210 211 /* Values for the Opcode field above */ 212 213 typedef enum 214 { 215 ACPI_RSD_TITLE = 0, 216 ACPI_RSD_1BITFLAG, 217 ACPI_RSD_2BITFLAG, 218 ACPI_RSD_3BITFLAG, 219 ACPI_RSD_ADDRESS, 220 ACPI_RSD_DWORDLIST, 221 ACPI_RSD_LITERAL, 222 ACPI_RSD_LONGLIST, 223 ACPI_RSD_SHORTLIST, 224 ACPI_RSD_SHORTLISTX, 225 ACPI_RSD_SOURCE, 226 ACPI_RSD_STRING, 227 ACPI_RSD_UINT8, 228 ACPI_RSD_UINT16, 229 ACPI_RSD_UINT32, 230 ACPI_RSD_UINT64, 231 ACPI_RSD_WORDLIST 232 233 } ACPI_RSDUMP_OPCODES; 234 235 /* restore default alignment */ 236 237 #pragma pack() 238 239 240 /* Resource tables indexed by internal resource type */ 241 242 extern const UINT8 AcpiGbl_AmlResourceSizes[]; 243 extern const UINT8 AcpiGbl_AmlResourceSerialBusSizes[]; 244 extern ACPI_RSCONVERT_INFO *AcpiGbl_SetResourceDispatch[]; 245 246 /* Resource tables indexed by raw AML resource descriptor type */ 247 248 extern const UINT8 AcpiGbl_ResourceStructSizes[]; 249 extern const UINT8 AcpiGbl_ResourceStructSerialBusSizes[]; 250 extern ACPI_RSCONVERT_INFO *AcpiGbl_GetResourceDispatch[]; 251 252 extern ACPI_RSCONVERT_INFO *AcpiGbl_ConvertResourceSerialBusDispatch[]; 253 254 typedef struct acpi_vendor_walk_info 255 { 256 ACPI_VENDOR_UUID *Uuid; 257 ACPI_BUFFER *Buffer; 258 ACPI_STATUS Status; 259 260 } ACPI_VENDOR_WALK_INFO; 261 262 263 /* 264 * rscreate 265 */ 266 ACPI_STATUS 267 AcpiRsCreateResourceList ( 268 ACPI_OPERAND_OBJECT *AmlBuffer, 269 ACPI_BUFFER *OutputBuffer); 270 271 ACPI_STATUS 272 AcpiRsCreateAmlResources ( 273 ACPI_BUFFER *ResourceList, 274 ACPI_BUFFER *OutputBuffer); 275 276 ACPI_STATUS 277 AcpiRsCreatePciRoutingTable ( 278 ACPI_OPERAND_OBJECT *PackageObject, 279 ACPI_BUFFER *OutputBuffer); 280 281 282 /* 283 * rsutils 284 */ 285 ACPI_STATUS 286 AcpiRsGetPrtMethodData ( 287 ACPI_NAMESPACE_NODE *Node, 288 ACPI_BUFFER *RetBuffer); 289 290 ACPI_STATUS 291 AcpiRsGetCrsMethodData ( 292 ACPI_NAMESPACE_NODE *Node, 293 ACPI_BUFFER *RetBuffer); 294 295 ACPI_STATUS 296 AcpiRsGetPrsMethodData ( 297 ACPI_NAMESPACE_NODE *Node, 298 ACPI_BUFFER *RetBuffer); 299 300 ACPI_STATUS 301 AcpiRsGetMethodData ( 302 ACPI_HANDLE Handle, 303 const char *Path, 304 ACPI_BUFFER *RetBuffer); 305 306 ACPI_STATUS 307 AcpiRsSetSrsMethodData ( 308 ACPI_NAMESPACE_NODE *Node, 309 ACPI_BUFFER *RetBuffer); 310 311 ACPI_STATUS 312 AcpiRsGetAeiMethodData ( 313 ACPI_NAMESPACE_NODE *Node, 314 ACPI_BUFFER *RetBuffer); 315 316 /* 317 * rscalc 318 */ 319 ACPI_STATUS 320 AcpiRsGetListLength ( 321 UINT8 *AmlBuffer, 322 UINT32 AmlBufferLength, 323 ACPI_SIZE *SizeNeeded); 324 325 ACPI_STATUS 326 AcpiRsGetAmlLength ( 327 ACPI_RESOURCE *ResourceList, 328 ACPI_SIZE ResourceListSize, 329 ACPI_SIZE *SizeNeeded); 330 331 ACPI_STATUS 332 AcpiRsGetPciRoutingTableLength ( 333 ACPI_OPERAND_OBJECT *PackageObject, 334 ACPI_SIZE *BufferSizeNeeded); 335 336 ACPI_STATUS 337 AcpiRsConvertAmlToResources ( 338 UINT8 *Aml, 339 UINT32 Length, 340 UINT32 Offset, 341 UINT8 ResourceIndex, 342 void **Context); 343 344 ACPI_STATUS 345 AcpiRsConvertResourcesToAml ( 346 ACPI_RESOURCE *Resource, 347 ACPI_SIZE AmlSizeNeeded, 348 UINT8 *OutputBuffer); 349 350 351 /* 352 * rsaddr 353 */ 354 void 355 AcpiRsSetAddressCommon ( 356 AML_RESOURCE *Aml, 357 ACPI_RESOURCE *Resource); 358 359 BOOLEAN 360 AcpiRsGetAddressCommon ( 361 ACPI_RESOURCE *Resource, 362 AML_RESOURCE *Aml); 363 364 365 /* 366 * rsmisc 367 */ 368 ACPI_STATUS 369 AcpiRsConvertAmlToResource ( 370 ACPI_RESOURCE *Resource, 371 AML_RESOURCE *Aml, 372 ACPI_RSCONVERT_INFO *Info); 373 374 ACPI_STATUS 375 AcpiRsConvertResourceToAml ( 376 ACPI_RESOURCE *Resource, 377 AML_RESOURCE *Aml, 378 ACPI_RSCONVERT_INFO *Info); 379 380 381 /* 382 * rsutils 383 */ 384 void 385 AcpiRsMoveData ( 386 void *Destination, 387 void *Source, 388 UINT16 ItemCount, 389 UINT8 MoveType); 390 391 UINT8 392 AcpiRsDecodeBitmask ( 393 UINT16 Mask, 394 UINT8 *List); 395 396 UINT16 397 AcpiRsEncodeBitmask ( 398 UINT8 *List, 399 UINT8 Count); 400 401 ACPI_RS_LENGTH 402 AcpiRsGetResourceSource ( 403 ACPI_RS_LENGTH ResourceLength, 404 ACPI_RS_LENGTH MinimumLength, 405 ACPI_RESOURCE_SOURCE *ResourceSource, 406 AML_RESOURCE *Aml, 407 char *StringPtr); 408 409 ACPI_RSDESC_SIZE 410 AcpiRsSetResourceSource ( 411 AML_RESOURCE *Aml, 412 ACPI_RS_LENGTH MinimumLength, 413 ACPI_RESOURCE_SOURCE *ResourceSource); 414 415 void 416 AcpiRsSetResourceHeader ( 417 UINT8 DescriptorType, 418 ACPI_RSDESC_SIZE TotalLength, 419 AML_RESOURCE *Aml); 420 421 void 422 AcpiRsSetResourceLength ( 423 ACPI_RSDESC_SIZE TotalLength, 424 AML_RESOURCE *Aml); 425 426 427 /* 428 * rsdump - Debugger support 429 */ 430 #ifdef ACPI_DEBUGGER 431 void 432 AcpiRsDumpResourceList ( 433 ACPI_RESOURCE *Resource); 434 435 void 436 AcpiRsDumpIrqList ( 437 UINT8 *RouteTable); 438 #endif 439 440 441 /* 442 * Resource conversion tables 443 */ 444 extern ACPI_RSCONVERT_INFO AcpiRsConvertDma[]; 445 extern ACPI_RSCONVERT_INFO AcpiRsConvertEndDpf[]; 446 extern ACPI_RSCONVERT_INFO AcpiRsConvertIo[]; 447 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedIo[]; 448 extern ACPI_RSCONVERT_INFO AcpiRsConvertEndTag[]; 449 extern ACPI_RSCONVERT_INFO AcpiRsConvertMemory24[]; 450 extern ACPI_RSCONVERT_INFO AcpiRsConvertGenericReg[]; 451 extern ACPI_RSCONVERT_INFO AcpiRsConvertMemory32[]; 452 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedMemory32[]; 453 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress32[]; 454 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress16[]; 455 extern ACPI_RSCONVERT_INFO AcpiRsConvertExtIrq[]; 456 extern ACPI_RSCONVERT_INFO AcpiRsConvertAddress64[]; 457 extern ACPI_RSCONVERT_INFO AcpiRsConvertExtAddress64[]; 458 extern ACPI_RSCONVERT_INFO AcpiRsConvertGpio[]; 459 extern ACPI_RSCONVERT_INFO AcpiRsConvertFixedDma[]; 460 extern ACPI_RSCONVERT_INFO AcpiRsConvertI2cSerialBus[]; 461 extern ACPI_RSCONVERT_INFO AcpiRsConvertSpiSerialBus[]; 462 extern ACPI_RSCONVERT_INFO AcpiRsConvertUartSerialBus[]; 463 464 /* These resources require separate get/set tables */ 465 466 extern ACPI_RSCONVERT_INFO AcpiRsGetIrq[]; 467 extern ACPI_RSCONVERT_INFO AcpiRsGetStartDpf[]; 468 extern ACPI_RSCONVERT_INFO AcpiRsGetVendorSmall[]; 469 extern ACPI_RSCONVERT_INFO AcpiRsGetVendorLarge[]; 470 471 extern ACPI_RSCONVERT_INFO AcpiRsSetIrq[]; 472 extern ACPI_RSCONVERT_INFO AcpiRsSetStartDpf[]; 473 extern ACPI_RSCONVERT_INFO AcpiRsSetVendor[]; 474 475 476 #if defined(ACPI_DEBUG_OUTPUT) || defined(ACPI_DEBUGGER) 477 /* 478 * rsinfo 479 */ 480 extern ACPI_RSDUMP_INFO *AcpiGbl_DumpResourceDispatch[]; 481 extern ACPI_RSDUMP_INFO *AcpiGbl_DumpSerialBusDispatch[]; 482 483 /* 484 * rsdumpinfo 485 */ 486 extern ACPI_RSDUMP_INFO AcpiRsDumpIrq[]; 487 extern ACPI_RSDUMP_INFO AcpiRsDumpPrt[]; 488 extern ACPI_RSDUMP_INFO AcpiRsDumpDma[]; 489 extern ACPI_RSDUMP_INFO AcpiRsDumpStartDpf[]; 490 extern ACPI_RSDUMP_INFO AcpiRsDumpEndDpf[]; 491 extern ACPI_RSDUMP_INFO AcpiRsDumpIo[]; 492 extern ACPI_RSDUMP_INFO AcpiRsDumpIoFlags[]; 493 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedIo[]; 494 extern ACPI_RSDUMP_INFO AcpiRsDumpVendor[]; 495 extern ACPI_RSDUMP_INFO AcpiRsDumpEndTag[]; 496 extern ACPI_RSDUMP_INFO AcpiRsDumpMemory24[]; 497 extern ACPI_RSDUMP_INFO AcpiRsDumpMemory32[]; 498 extern ACPI_RSDUMP_INFO AcpiRsDumpMemoryFlags[]; 499 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedMemory32[]; 500 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress16[]; 501 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress32[]; 502 extern ACPI_RSDUMP_INFO AcpiRsDumpAddress64[]; 503 extern ACPI_RSDUMP_INFO AcpiRsDumpExtAddress64[]; 504 extern ACPI_RSDUMP_INFO AcpiRsDumpExtIrq[]; 505 extern ACPI_RSDUMP_INFO AcpiRsDumpGenericReg[]; 506 extern ACPI_RSDUMP_INFO AcpiRsDumpGpio[]; 507 extern ACPI_RSDUMP_INFO AcpiRsDumpFixedDma[]; 508 extern ACPI_RSDUMP_INFO AcpiRsDumpCommonSerialBus[]; 509 extern ACPI_RSDUMP_INFO AcpiRsDumpI2cSerialBus[]; 510 extern ACPI_RSDUMP_INFO AcpiRsDumpSpiSerialBus[]; 511 extern ACPI_RSDUMP_INFO AcpiRsDumpUartSerialBus[]; 512 extern ACPI_RSDUMP_INFO AcpiRsDumpGeneralFlags[]; 513 #endif 514 515 #endif /* __ACRESRC_H__ */ 516