1 2 /****************************************************************************** 3 * 4 * Module Name: amlresrc.h - AML resource descriptors 5 * $Revision: 29 $ 6 * 7 *****************************************************************************/ 8 9 /****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2005, 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 /* 176 * Resource descriptors defined in the ACPI specification. 177 * 178 * Packing/alignment must be BYTE because these descriptors 179 * are used to overlay the AML byte stream. 180 */ 181 #pragma pack(1) 182 183 typedef struct asl_irq_format_desc 184 { 185 UINT8 DescriptorType; 186 UINT16 IrqMask; 187 UINT8 Flags; 188 189 } ASL_IRQ_FORMAT_DESC; 190 191 192 typedef struct asl_irq_noflags_desc 193 { 194 UINT8 DescriptorType; 195 UINT16 IrqMask; 196 197 } ASL_IRQ_NOFLAGS_DESC; 198 199 200 typedef struct asl_dma_format_desc 201 { 202 UINT8 DescriptorType; 203 UINT8 DmaChannelMask; 204 UINT8 Flags; 205 206 } ASL_DMA_FORMAT_DESC; 207 208 209 typedef struct asl_start_dependent_desc 210 { 211 UINT8 DescriptorType; 212 UINT8 Flags; 213 214 } ASL_START_DEPENDENT_DESC; 215 216 217 typedef struct asl_start_dependent_noprio_desc 218 { 219 UINT8 DescriptorType; 220 221 } ASL_START_DEPENDENT_NOPRIO_DESC; 222 223 224 typedef struct asl_end_dependent_desc 225 { 226 UINT8 DescriptorType; 227 228 } ASL_END_DEPENDENT_DESC; 229 230 231 typedef struct asl_io_port_desc 232 { 233 UINT8 DescriptorType; 234 UINT8 Information; 235 UINT16 AddressMin; 236 UINT16 AddressMax; 237 UINT8 Alignment; 238 UINT8 Length; 239 240 } ASL_IO_PORT_DESC; 241 242 243 typedef struct asl_fixed_io_port_desc 244 { 245 UINT8 DescriptorType; 246 UINT16 BaseAddress; 247 UINT8 Length; 248 249 } ASL_FIXED_IO_PORT_DESC; 250 251 252 typedef struct asl_small_vendor_desc 253 { 254 UINT8 DescriptorType; 255 UINT8 VendorDefined[7]; 256 257 } ASL_SMALL_VENDOR_DESC; 258 259 260 typedef struct asl_end_tag_desc 261 { 262 UINT8 DescriptorType; 263 UINT8 Checksum; 264 265 } ASL_END_TAG_DESC; 266 267 268 /* LARGE descriptors */ 269 270 typedef struct asl_memory_24_desc 271 { 272 UINT8 DescriptorType; 273 UINT16 Length; 274 UINT8 Information; 275 UINT16 AddressMin; 276 UINT16 AddressMax; 277 UINT16 Alignment; 278 UINT16 RangeLength; 279 280 } ASL_MEMORY_24_DESC; 281 282 283 typedef struct asl_large_vendor_desc 284 { 285 UINT8 DescriptorType; 286 UINT16 Length; 287 UINT8 VendorDefined[1]; 288 289 } ASL_LARGE_VENDOR_DESC; 290 291 292 typedef struct asl_memory_32_desc 293 { 294 UINT8 DescriptorType; 295 UINT16 Length; 296 UINT8 Information; 297 UINT32 AddressMin; 298 UINT32 AddressMax; 299 UINT32 Alignment; 300 UINT32 RangeLength; 301 302 } ASL_MEMORY_32_DESC; 303 304 305 typedef struct asl_fixed_memory_32_desc 306 { 307 UINT8 DescriptorType; 308 UINT16 Length; 309 UINT8 Information; 310 UINT32 BaseAddress; 311 UINT32 RangeLength; 312 313 } ASL_FIXED_MEMORY_32_DESC; 314 315 316 typedef struct asl_extended_address_desc 317 { 318 UINT8 DescriptorType; 319 UINT16 Length; 320 UINT8 ResourceType; 321 UINT8 Flags; 322 UINT8 SpecificFlags; 323 UINT8 RevisionID; 324 UINT8 Reserved; 325 UINT64 Granularity; 326 UINT64 AddressMin; 327 UINT64 AddressMax; 328 UINT64 TranslationOffset; 329 UINT64 AddressLength; 330 UINT64 TypeSpecificAttributes; 331 UINT8 OptionalFields[2]; /* Used for length calculation only */ 332 333 } ASL_EXTENDED_ADDRESS_DESC; 334 335 #define ASL_EXTENDED_ADDRESS_DESC_REVISION 1 /* ACPI 3.0 */ 336 337 338 typedef struct asl_qword_address_desc 339 { 340 UINT8 DescriptorType; 341 UINT16 Length; 342 UINT8 ResourceType; 343 UINT8 Flags; 344 UINT8 SpecificFlags; 345 UINT64 Granularity; 346 UINT64 AddressMin; 347 UINT64 AddressMax; 348 UINT64 TranslationOffset; 349 UINT64 AddressLength; 350 UINT8 OptionalFields[2]; 351 352 } ASL_QWORD_ADDRESS_DESC; 353 354 355 typedef struct asl_dword_address_desc 356 { 357 UINT8 DescriptorType; 358 UINT16 Length; 359 UINT8 ResourceType; 360 UINT8 Flags; 361 UINT8 SpecificFlags; 362 UINT32 Granularity; 363 UINT32 AddressMin; 364 UINT32 AddressMax; 365 UINT32 TranslationOffset; 366 UINT32 AddressLength; 367 UINT8 OptionalFields[2]; 368 369 } ASL_DWORD_ADDRESS_DESC; 370 371 372 typedef struct asl_word_address_desc 373 { 374 UINT8 DescriptorType; 375 UINT16 Length; 376 UINT8 ResourceType; 377 UINT8 Flags; 378 UINT8 SpecificFlags; 379 UINT16 Granularity; 380 UINT16 AddressMin; 381 UINT16 AddressMax; 382 UINT16 TranslationOffset; 383 UINT16 AddressLength; 384 UINT8 OptionalFields[2]; 385 386 } ASL_WORD_ADDRESS_DESC; 387 388 389 typedef struct asl_extended_xrupt_desc 390 { 391 UINT8 DescriptorType; 392 UINT16 Length; 393 UINT8 Flags; 394 UINT8 TableLength; 395 UINT32 InterruptNumber[1]; 396 /* ResSourceIndex, ResSource optional fields follow */ 397 398 } ASL_EXTENDED_XRUPT_DESC; 399 400 401 typedef struct asl_general_register_desc 402 { 403 UINT8 DescriptorType; 404 UINT16 Length; 405 UINT8 AddressSpaceId; 406 UINT8 BitWidth; 407 UINT8 BitOffset; 408 UINT8 AccessSize; /* ACPI 3.0, was Reserved */ 409 UINT64 Address; 410 411 } ASL_GENERAL_REGISTER_DESC; 412 413 /* restore default alignment */ 414 415 #pragma pack() 416 417 /* Union of all resource descriptors, so we can allocate the worst case */ 418 419 typedef union asl_resource_desc 420 { 421 ASL_IRQ_FORMAT_DESC Irq; 422 ASL_DMA_FORMAT_DESC Dma; 423 ASL_START_DEPENDENT_DESC Std; 424 ASL_END_DEPENDENT_DESC End; 425 ASL_IO_PORT_DESC Iop; 426 ASL_FIXED_IO_PORT_DESC Fio; 427 ASL_SMALL_VENDOR_DESC Smv; 428 ASL_END_TAG_DESC Et; 429 430 ASL_MEMORY_24_DESC M24; 431 ASL_LARGE_VENDOR_DESC Lgv; 432 ASL_MEMORY_32_DESC M32; 433 ASL_FIXED_MEMORY_32_DESC F32; 434 ASL_QWORD_ADDRESS_DESC Qas; 435 ASL_DWORD_ADDRESS_DESC Das; 436 ASL_WORD_ADDRESS_DESC Was; 437 ASL_EXTENDED_ADDRESS_DESC Eas; 438 ASL_EXTENDED_XRUPT_DESC Exx; 439 ASL_GENERAL_REGISTER_DESC Grg; 440 UINT32 U32Item; 441 UINT16 U16Item; 442 UINT8 U8Item; 443 444 } ASL_RESOURCE_DESC; 445 446 447 #endif 448 449