amlresrc.h revision 151937
168651Skris 268651Skris/****************************************************************************** 368651Skris * 468651Skris * Module Name: amlresrc.h - AML resource descriptors 568651Skris * $Revision: 1.33 $ 668651Skris * 768651Skris *****************************************************************************/ 868651Skris 968651Skris/****************************************************************************** 1068651Skris * 1168651Skris * 1. Copyright Notice 1268651Skris * 1368651Skris * Some or all of this work - Copyright (c) 1999 - 2005, Intel Corp. 1468651Skris * All rights reserved. 1568651Skris * 1668651Skris * 2. License 1768651Skris * 1868651Skris * 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 166typedef 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 raw AML byte stream. 180 */ 181#pragma pack(1) 182 183/* 184 * SMALL descriptors 185 */ 186#define AML_RESOURCE_SMALL_HEADER_COMMON \ 187 UINT8 DescriptorType; 188 189typedef struct aml_resource_small_header 190{ 191 AML_RESOURCE_SMALL_HEADER_COMMON 192 193} AML_RESOURCE_SMALL_HEADER; 194 195 196typedef struct aml_resource_irq 197{ 198 AML_RESOURCE_SMALL_HEADER_COMMON 199 UINT16 IrqMask; 200 UINT8 Flags; 201 202} AML_RESOURCE_IRQ; 203 204 205typedef struct aml_resource_irq_noflags 206{ 207 AML_RESOURCE_SMALL_HEADER_COMMON 208 UINT16 IrqMask; 209 210} AML_RESOURCE_IRQ_NOFLAGS; 211 212 213typedef struct aml_resource_dma 214{ 215 AML_RESOURCE_SMALL_HEADER_COMMON 216 UINT8 DmaChannelMask; 217 UINT8 Flags; 218 219} AML_RESOURCE_DMA; 220 221 222typedef struct aml_resource_start_dependent 223{ 224 AML_RESOURCE_SMALL_HEADER_COMMON 225 UINT8 Flags; 226 227} AML_RESOURCE_START_DEPENDENT; 228 229 230typedef struct aml_resource_start_dependent_noprio 231{ 232 AML_RESOURCE_SMALL_HEADER_COMMON 233 234} AML_RESOURCE_START_DEPENDENT_NOPRIO; 235 236 237typedef struct aml_resource_end_dependent 238{ 239 AML_RESOURCE_SMALL_HEADER_COMMON 240 241} AML_RESOURCE_END_DEPENDENT; 242 243 244typedef struct aml_resource_io 245{ 246 AML_RESOURCE_SMALL_HEADER_COMMON 247 UINT8 Flags; 248 UINT16 Minimum; 249 UINT16 Maximum; 250 UINT8 Alignment; 251 UINT8 AddressLength; 252 253} AML_RESOURCE_IO; 254 255 256typedef struct aml_resource_fixed_io 257{ 258 AML_RESOURCE_SMALL_HEADER_COMMON 259 UINT16 Address; 260 UINT8 AddressLength; 261 262} AML_RESOURCE_FIXED_IO; 263 264 265typedef struct aml_resource_vendor_small 266{ 267 AML_RESOURCE_SMALL_HEADER_COMMON 268 269} AML_RESOURCE_VENDOR_SMALL; 270 271 272typedef struct aml_resource_end_tag 273{ 274 AML_RESOURCE_SMALL_HEADER_COMMON 275 UINT8 Checksum; 276 277} AML_RESOURCE_END_TAG; 278 279 280/* 281 * LARGE descriptors 282 */ 283#define AML_RESOURCE_LARGE_HEADER_COMMON \ 284 UINT8 DescriptorType;\ 285 UINT16 ResourceLength; 286 287typedef struct aml_resource_large_header 288{ 289 AML_RESOURCE_LARGE_HEADER_COMMON 290 291} AML_RESOURCE_LARGE_HEADER; 292 293 294typedef struct aml_resource_memory24 295{ 296 AML_RESOURCE_LARGE_HEADER_COMMON 297 UINT8 Flags; 298 UINT16 Minimum; 299 UINT16 Maximum; 300 UINT16 Alignment; 301 UINT16 AddressLength; 302 303} AML_RESOURCE_MEMORY24; 304 305 306typedef struct aml_resource_vendor_large 307{ 308 AML_RESOURCE_LARGE_HEADER_COMMON 309 310} AML_RESOURCE_VENDOR_LARGE; 311 312 313typedef struct aml_resource_memory32 314{ 315 AML_RESOURCE_LARGE_HEADER_COMMON 316 UINT8 Flags; 317 UINT32 Minimum; 318 UINT32 Maximum; 319 UINT32 Alignment; 320 UINT32 AddressLength; 321 322} AML_RESOURCE_MEMORY32; 323 324 325typedef struct aml_resource_fixed_memory32 326{ 327 AML_RESOURCE_LARGE_HEADER_COMMON 328 UINT8 Flags; 329 UINT32 Address; 330 UINT32 AddressLength; 331 332} AML_RESOURCE_FIXED_MEMORY32; 333 334 335#define AML_RESOURCE_ADDRESS_COMMON \ 336 UINT8 ResourceType; \ 337 UINT8 Flags; \ 338 UINT8 SpecificFlags; 339 340 341typedef struct aml_resource_address 342{ 343 AML_RESOURCE_LARGE_HEADER_COMMON 344 AML_RESOURCE_ADDRESS_COMMON 345 346} AML_RESOURCE_ADDRESS; 347 348 349typedef struct aml_resource_extended_address64 350{ 351 AML_RESOURCE_LARGE_HEADER_COMMON 352 AML_RESOURCE_ADDRESS_COMMON 353 UINT8 RevisionID; 354 UINT8 Reserved; 355 UINT64 Granularity; 356 UINT64 Minimum; 357 UINT64 Maximum; 358 UINT64 TranslationOffset; 359 UINT64 AddressLength; 360 UINT64 TypeSpecific; 361 362} AML_RESOURCE_EXTENDED_ADDRESS64; 363 364#define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */ 365 366 367typedef struct aml_resource_address64 368{ 369 AML_RESOURCE_LARGE_HEADER_COMMON 370 AML_RESOURCE_ADDRESS_COMMON 371 UINT64 Granularity; 372 UINT64 Minimum; 373 UINT64 Maximum; 374 UINT64 TranslationOffset; 375 UINT64 AddressLength; 376 377} AML_RESOURCE_ADDRESS64; 378 379 380typedef struct aml_resource_address32 381{ 382 AML_RESOURCE_LARGE_HEADER_COMMON 383 AML_RESOURCE_ADDRESS_COMMON 384 UINT32 Granularity; 385 UINT32 Minimum; 386 UINT32 Maximum; 387 UINT32 TranslationOffset; 388 UINT32 AddressLength; 389 390} AML_RESOURCE_ADDRESS32; 391 392 393typedef struct aml_resource_address16 394{ 395 AML_RESOURCE_LARGE_HEADER_COMMON 396 AML_RESOURCE_ADDRESS_COMMON 397 UINT16 Granularity; 398 UINT16 Minimum; 399 UINT16 Maximum; 400 UINT16 TranslationOffset; 401 UINT16 AddressLength; 402 403} AML_RESOURCE_ADDRESS16; 404 405 406typedef struct aml_resource_extended_irq 407{ 408 AML_RESOURCE_LARGE_HEADER_COMMON 409 UINT8 Flags; 410 UINT8 InterruptCount; 411 UINT32 Interrupts[1]; 412 /* ResSourceIndex, ResSource optional fields follow */ 413 414} AML_RESOURCE_EXTENDED_IRQ; 415 416 417typedef struct aml_resource_generic_register 418{ 419 AML_RESOURCE_LARGE_HEADER_COMMON 420 UINT8 AddressSpaceId; 421 UINT8 BitWidth; 422 UINT8 BitOffset; 423 UINT8 AccessSize; /* ACPI 3.0, was previously Reserved */ 424 UINT64 Address; 425 426} AML_RESOURCE_GENERIC_REGISTER; 427 428/* restore default alignment */ 429 430#pragma pack() 431 432/* Union of all resource descriptors, so we can allocate the worst case */ 433 434typedef union aml_resource 435{ 436 /* Descriptor headers */ 437 438 AML_RESOURCE_SMALL_HEADER SmallHeader; 439 AML_RESOURCE_LARGE_HEADER LargeHeader; 440 441 /* Small resource descriptors */ 442 443 AML_RESOURCE_IRQ Irq; 444 AML_RESOURCE_DMA Dma; 445 AML_RESOURCE_START_DEPENDENT StartDpf; 446 AML_RESOURCE_END_DEPENDENT EndDpf; 447 AML_RESOURCE_IO Io; 448 AML_RESOURCE_FIXED_IO FixedIo; 449 AML_RESOURCE_VENDOR_SMALL VendorSmall; 450 AML_RESOURCE_END_TAG EndTag; 451 452 /* Large resource descriptors */ 453 454 AML_RESOURCE_MEMORY24 Memory24; 455 AML_RESOURCE_GENERIC_REGISTER GenericReg; 456 AML_RESOURCE_VENDOR_LARGE VendorLarge; 457 AML_RESOURCE_MEMORY32 Memory32; 458 AML_RESOURCE_FIXED_MEMORY32 FixedMemory32; 459 AML_RESOURCE_ADDRESS16 Address16; 460 AML_RESOURCE_ADDRESS32 Address32; 461 AML_RESOURCE_ADDRESS64 Address64; 462 AML_RESOURCE_EXTENDED_ADDRESS64 ExtAddress64; 463 AML_RESOURCE_EXTENDED_IRQ ExtendedIrq; 464 465 /* Utility overlays */ 466 467 AML_RESOURCE_ADDRESS Address; 468 UINT32 U32Item; 469 UINT16 U16Item; 470 UINT8 U8Item; 471 472} AML_RESOURCE; 473 474 475#endif 476 477