1 2 /****************************************************************************** 3 * 4 * Module Name: amlresrc.h - AML resource descriptors 5 * $Revision: 1.35 $ 6 * 7 *****************************************************************************/ 8 9 /****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2006, Intel Corp. 14 * All rights reserved. 15 * 16 * 2. License 17 * 18 * 2.1. This is your license from Intel Corp. under its intellectual property 19 * rights. You may have additional license terms from the party that provided 20 * you this software, covering your right to use that party's intellectual 21 * property rights. 22 * 23 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 24 * copy of the source code appearing in this file ("Covered Code") an 25 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 26 * base code distributed originally by Intel ("Original Intel Code") to copy, 27 * make derivatives, distribute, use and display any portion of the Covered 28 * Code in any form, with the right to sublicense such rights; and 29 * 30 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 31 * license (with the right to sublicense), under only those claims of Intel 32 * patents that are infringed by the Original Intel Code, to make, use, sell, 33 * offer to sell, and import the Covered Code and derivative works thereof 34 * solely to the minimum extent necessary to exercise the above copyright 35 * license, and in no event shall the patent license extend to any additions 36 * to or modifications of the Original Intel Code. No other license or right 37 * is granted directly or by implication, estoppel or otherwise; 38 * 39 * The above copyright and patent license is granted only if the following 40 * conditions are met: 41 * 42 * 3. Conditions 43 * 44 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 45 * Redistribution of source code of any substantial portion of the Covered 46 * Code or modification with rights to further distribute source must include 47 * the above Copyright Notice, the above License, this list of Conditions, 48 * and the following Disclaimer and Export Compliance provision. In addition, 49 * Licensee must cause all Covered Code to which Licensee contributes to 50 * contain a file documenting the changes Licensee made to create that Covered 51 * Code and the date of any change. Licensee must include in that file the 52 * documentation of any changes made by any predecessor Licensee. Licensee 53 * must include a prominent statement that the modification is derived, 54 * directly or indirectly, from Original Intel Code. 55 * 56 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 57 * Redistribution of source code of any substantial portion of the Covered 58 * Code or modification without rights to further distribute source must 59 * include the following Disclaimer and Export Compliance provision in the 60 * documentation and/or other materials provided with distribution. In 61 * addition, Licensee may not authorize further sublicense of source of any 62 * portion of the Covered Code, and must include terms to the effect that the 63 * license from Licensee to its licensee is limited to the intellectual 64 * property embodied in the software Licensee provides to its licensee, and 65 * not to intellectual property embodied in modifications its licensee may 66 * make. 67 * 68 * 3.3. Redistribution of Executable. Redistribution in executable form of any 69 * substantial portion of the Covered Code or modification must reproduce the 70 * above Copyright Notice, and the following Disclaimer and Export Compliance 71 * provision in the documentation and/or other materials provided with the 72 * distribution. 73 * 74 * 3.4. Intel retains all right, title, and interest in and to the Original 75 * Intel Code. 76 * 77 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 78 * Intel shall be used in advertising or otherwise to promote the sale, use or 79 * other dealings in products derived from or relating to the Covered Code 80 * without prior written authorization from Intel. 81 * 82 * 4. Disclaimer and Export Compliance 83 * 84 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 85 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 86 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 87 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 88 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 89 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 90 * PARTICULAR PURPOSE. 91 * 92 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 93 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 94 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 95 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 96 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 97 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 98 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 99 * LIMITED REMEDY. 100 * 101 * 4.3. Licensee shall not export, either directly or indirectly, any of this 102 * software or system incorporating such software without first obtaining any 103 * required license or other approval from the U. S. Department of Commerce or 104 * any other agency or department of the United States Government. In the 105 * event Licensee exports any such software from the United States or 106 * re-exports any such software from a foreign destination, Licensee shall 107 * ensure that the distribution and export/re-export of the software is in 108 * compliance with all laws, regulations, orders, or other restrictions of the 109 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 110 * any of its subsidiaries will export/re-export any technical data, process, 111 * software, or service, directly or indirectly, to any country for which the 112 * United States government or any agency thereof requires an export license, 113 * other governmental approval, or letter of assurance, without first obtaining 114 * such license, approval or letter. 115 * 116 *****************************************************************************/ 117 118 119 #ifndef __AMLRESRC_H 120 #define __AMLRESRC_H 121 122 123 #define ASL_RESNAME_ADDRESS "_ADR" 124 #define ASL_RESNAME_ALIGNMENT "_ALN" 125 #define ASL_RESNAME_ADDRESSSPACE "_ASI" 126 #define ASL_RESNAME_ACCESSSIZE "_ASZ" 127 #define ASL_RESNAME_TYPESPECIFICATTRIBUTES "_ATT" 128 #define ASL_RESNAME_BASEADDRESS "_BAS" 129 #define ASL_RESNAME_BUSMASTER "_BM_" /* Master(1), Slave(0) */ 130 #define ASL_RESNAME_DECODE "_DEC" 131 #define ASL_RESNAME_DMA "_DMA" 132 #define ASL_RESNAME_DMATYPE "_TYP" /* Compatible(0), A(1), B(2), F(3) */ 133 #define ASL_RESNAME_GRANULARITY "_GRA" 134 #define ASL_RESNAME_INTERRUPT "_INT" 135 #define ASL_RESNAME_INTERRUPTLEVEL "_LL_" /* ActiveLo(1), ActiveHi(0) */ 136 #define ASL_RESNAME_INTERRUPTSHARE "_SHR" /* Shareable(1), NoShare(0) */ 137 #define ASL_RESNAME_INTERRUPTTYPE "_HE_" /* Edge(1), Level(0) */ 138 #define ASL_RESNAME_LENGTH "_LEN" 139 #define ASL_RESNAME_MEMATTRIBUTES "_MTP" /* Memory(0), Reserved(1), ACPI(2), NVS(3) */ 140 #define ASL_RESNAME_MEMTYPE "_MEM" /* NonCache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */ 141 #define ASL_RESNAME_MAXADDR "_MAX" 142 #define ASL_RESNAME_MINADDR "_MIN" 143 #define ASL_RESNAME_MAXTYPE "_MAF" 144 #define ASL_RESNAME_MINTYPE "_MIF" 145 #define ASL_RESNAME_REGISTERBITOFFSET "_RBO" 146 #define ASL_RESNAME_REGISTERBITWIDTH "_RBW" 147 #define ASL_RESNAME_RANGETYPE "_RNG" 148 #define ASL_RESNAME_READWRITETYPE "_RW_" /* ReadOnly(0), Writeable (1) */ 149 #define ASL_RESNAME_TRANSLATION "_TRA" 150 #define ASL_RESNAME_TRANSTYPE "_TRS" /* Sparse(1), Dense(0) */ 151 #define ASL_RESNAME_TYPE "_TTP" /* Translation(1), Static (0) */ 152 #define ASL_RESNAME_XFERTYPE "_SIZ" /* 8(0), 8And16(1), 16(2) */ 153 154 155 /* Default sizes for "small" resource descriptors */ 156 157 #define ASL_RDESC_IRQ_SIZE 0x02 158 #define ASL_RDESC_DMA_SIZE 0x02 159 #define ASL_RDESC_ST_DEPEND_SIZE 0x00 160 #define ASL_RDESC_END_DEPEND_SIZE 0x00 161 #define ASL_RDESC_IO_SIZE 0x07 162 #define ASL_RDESC_FIXED_IO_SIZE 0x03 163 #define ASL_RDESC_END_TAG_SIZE 0x01 164 165 166 typedef struct asl_resource_node 167 { 168 UINT32 BufferLength; 169 void *Buffer; 170 struct asl_resource_node *Next; 171 172 } ASL_RESOURCE_NODE; 173 174 175 /* Macros used to generate AML resource length fields */ 176 177 #define ACPI_AML_SIZE_LARGE(r) (sizeof (r) - sizeof (AML_RESOURCE_LARGE_HEADER)) 178 #define ACPI_AML_SIZE_SMALL(r) (sizeof (r) - sizeof (AML_RESOURCE_SMALL_HEADER)) 179 180 /* 181 * Resource descriptors defined in the ACPI specification. 182 * 183 * Packing/alignment must be BYTE because these descriptors 184 * are used to overlay the raw AML byte stream. 185 */ 186 #pragma pack(1) 187 188 /* 189 * SMALL descriptors 190 */ 191 #define AML_RESOURCE_SMALL_HEADER_COMMON \ 192 UINT8 DescriptorType; 193 194 typedef struct aml_resource_small_header 195 { 196 AML_RESOURCE_SMALL_HEADER_COMMON 197 198 } AML_RESOURCE_SMALL_HEADER; 199 200 201 typedef struct aml_resource_irq 202 { 203 AML_RESOURCE_SMALL_HEADER_COMMON 204 UINT16 IrqMask; 205 UINT8 Flags; 206 207 } AML_RESOURCE_IRQ; 208 209 210 typedef struct aml_resource_irq_noflags 211 { 212 AML_RESOURCE_SMALL_HEADER_COMMON 213 UINT16 IrqMask; 214 215 } AML_RESOURCE_IRQ_NOFLAGS; 216 217 218 typedef struct aml_resource_dma 219 { 220 AML_RESOURCE_SMALL_HEADER_COMMON 221 UINT8 DmaChannelMask; 222 UINT8 Flags; 223 224 } AML_RESOURCE_DMA; 225 226 227 typedef struct aml_resource_start_dependent 228 { 229 AML_RESOURCE_SMALL_HEADER_COMMON 230 UINT8 Flags; 231 232 } AML_RESOURCE_START_DEPENDENT; 233 234 235 typedef struct aml_resource_start_dependent_noprio 236 { 237 AML_RESOURCE_SMALL_HEADER_COMMON 238 239 } AML_RESOURCE_START_DEPENDENT_NOPRIO; 240 241 242 typedef struct aml_resource_end_dependent 243 { 244 AML_RESOURCE_SMALL_HEADER_COMMON 245 246 } AML_RESOURCE_END_DEPENDENT; 247 248 249 typedef struct aml_resource_io 250 { 251 AML_RESOURCE_SMALL_HEADER_COMMON 252 UINT8 Flags; 253 UINT16 Minimum; 254 UINT16 Maximum; 255 UINT8 Alignment; 256 UINT8 AddressLength; 257 258 } AML_RESOURCE_IO; 259 260 261 typedef struct aml_resource_fixed_io 262 { 263 AML_RESOURCE_SMALL_HEADER_COMMON 264 UINT16 Address; 265 UINT8 AddressLength; 266 267 } AML_RESOURCE_FIXED_IO; 268 269 270 typedef struct aml_resource_vendor_small 271 { 272 AML_RESOURCE_SMALL_HEADER_COMMON 273 274 } AML_RESOURCE_VENDOR_SMALL; 275 276 277 typedef struct aml_resource_end_tag 278 { 279 AML_RESOURCE_SMALL_HEADER_COMMON 280 UINT8 Checksum; 281 282 } AML_RESOURCE_END_TAG; 283 284 285 /* 286 * LARGE descriptors 287 */ 288 #define AML_RESOURCE_LARGE_HEADER_COMMON \ 289 UINT8 DescriptorType;\ 290 UINT16 ResourceLength; 291 292 typedef struct aml_resource_large_header 293 { 294 AML_RESOURCE_LARGE_HEADER_COMMON 295 296 } AML_RESOURCE_LARGE_HEADER; 297 298 299 typedef struct aml_resource_memory24 300 { 301 AML_RESOURCE_LARGE_HEADER_COMMON 302 UINT8 Flags; 303 UINT16 Minimum; 304 UINT16 Maximum; 305 UINT16 Alignment; 306 UINT16 AddressLength; 307 308 } AML_RESOURCE_MEMORY24; 309 310 311 typedef struct aml_resource_vendor_large 312 { 313 AML_RESOURCE_LARGE_HEADER_COMMON 314 315 } AML_RESOURCE_VENDOR_LARGE; 316 317 318 typedef struct aml_resource_memory32 319 { 320 AML_RESOURCE_LARGE_HEADER_COMMON 321 UINT8 Flags; 322 UINT32 Minimum; 323 UINT32 Maximum; 324 UINT32 Alignment; 325 UINT32 AddressLength; 326 327 } AML_RESOURCE_MEMORY32; 328 329 330 typedef struct aml_resource_fixed_memory32 331 { 332 AML_RESOURCE_LARGE_HEADER_COMMON 333 UINT8 Flags; 334 UINT32 Address; 335 UINT32 AddressLength; 336 337 } AML_RESOURCE_FIXED_MEMORY32; 338 339 340 #define AML_RESOURCE_ADDRESS_COMMON \ 341 UINT8 ResourceType; \ 342 UINT8 Flags; \ 343 UINT8 SpecificFlags; 344 345 346 typedef struct aml_resource_address 347 { 348 AML_RESOURCE_LARGE_HEADER_COMMON 349 AML_RESOURCE_ADDRESS_COMMON 350 351 } AML_RESOURCE_ADDRESS; 352 353 354 typedef struct aml_resource_extended_address64 355 { 356 AML_RESOURCE_LARGE_HEADER_COMMON 357 AML_RESOURCE_ADDRESS_COMMON 358 UINT8 RevisionID; 359 UINT8 Reserved; 360 UINT64 Granularity; 361 UINT64 Minimum; 362 UINT64 Maximum; 363 UINT64 TranslationOffset; 364 UINT64 AddressLength; 365 UINT64 TypeSpecific; 366 367 } AML_RESOURCE_EXTENDED_ADDRESS64; 368 369 #define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */ 370 371 372 typedef struct aml_resource_address64 373 { 374 AML_RESOURCE_LARGE_HEADER_COMMON 375 AML_RESOURCE_ADDRESS_COMMON 376 UINT64 Granularity; 377 UINT64 Minimum; 378 UINT64 Maximum; 379 UINT64 TranslationOffset; 380 UINT64 AddressLength; 381 382 } AML_RESOURCE_ADDRESS64; 383 384 385 typedef struct aml_resource_address32 386 { 387 AML_RESOURCE_LARGE_HEADER_COMMON 388 AML_RESOURCE_ADDRESS_COMMON 389 UINT32 Granularity; 390 UINT32 Minimum; 391 UINT32 Maximum; 392 UINT32 TranslationOffset; 393 UINT32 AddressLength; 394 395 } AML_RESOURCE_ADDRESS32; 396 397 398 typedef struct aml_resource_address16 399 { 400 AML_RESOURCE_LARGE_HEADER_COMMON 401 AML_RESOURCE_ADDRESS_COMMON 402 UINT16 Granularity; 403 UINT16 Minimum; 404 UINT16 Maximum; 405 UINT16 TranslationOffset; 406 UINT16 AddressLength; 407 408 } AML_RESOURCE_ADDRESS16; 409 410 411 typedef struct aml_resource_extended_irq 412 { 413 AML_RESOURCE_LARGE_HEADER_COMMON 414 UINT8 Flags; 415 UINT8 InterruptCount; 416 UINT32 Interrupts[1]; 417 /* ResSourceIndex, ResSource optional fields follow */ 418 419 } AML_RESOURCE_EXTENDED_IRQ; 420 421 422 typedef struct aml_resource_generic_register 423 { 424 AML_RESOURCE_LARGE_HEADER_COMMON 425 UINT8 AddressSpaceId; 426 UINT8 BitWidth; 427 UINT8 BitOffset; 428 UINT8 AccessSize; /* ACPI 3.0, was previously Reserved */ 429 UINT64 Address; 430 431 } AML_RESOURCE_GENERIC_REGISTER; 432 433 /* restore default alignment */ 434 435 #pragma pack() 436 437 /* Union of all resource descriptors, so we can allocate the worst case */ 438 439 typedef union aml_resource 440 { 441 /* Descriptor headers */ 442 443 AML_RESOURCE_SMALL_HEADER SmallHeader; 444 AML_RESOURCE_LARGE_HEADER LargeHeader; 445 446 /* Small resource descriptors */ 447 448 AML_RESOURCE_IRQ Irq; 449 AML_RESOURCE_DMA Dma; 450 AML_RESOURCE_START_DEPENDENT StartDpf; 451 AML_RESOURCE_END_DEPENDENT EndDpf; 452 AML_RESOURCE_IO Io; 453 AML_RESOURCE_FIXED_IO FixedIo; 454 AML_RESOURCE_VENDOR_SMALL VendorSmall; 455 AML_RESOURCE_END_TAG EndTag; 456 457 /* Large resource descriptors */ 458 459 AML_RESOURCE_MEMORY24 Memory24; 460 AML_RESOURCE_GENERIC_REGISTER GenericReg; 461 AML_RESOURCE_VENDOR_LARGE VendorLarge; 462 AML_RESOURCE_MEMORY32 Memory32; 463 AML_RESOURCE_FIXED_MEMORY32 FixedMemory32; 464 AML_RESOURCE_ADDRESS16 Address16; 465 AML_RESOURCE_ADDRESS32 Address32; 466 AML_RESOURCE_ADDRESS64 Address64; 467 AML_RESOURCE_EXTENDED_ADDRESS64 ExtAddress64; 468 AML_RESOURCE_EXTENDED_IRQ ExtendedIrq; 469 470 /* Utility overlays */ 471 472 AML_RESOURCE_ADDRESS Address; 473 UINT32 U32Item; 474 UINT16 U16Item; 475 UINT8 U8Item; 476 477 } AML_RESOURCE; 478 479 480 #endif 481 482