amlresrc.h revision 100966
1 2/****************************************************************************** 3 * 4 * Module Name: amlresrc.h - AML resource descriptors 5 * $Revision: 20 $ 6 * 7 *****************************************************************************/ 8 9/****************************************************************************** 10 * 11 * 1. Copyright Notice 12 * 13 * Some or all of this work - Copyright (c) 1999 - 2002, 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_BASEADDRESS "_BAS" 127#define ASL_RESNAME_BUSMASTER "_BM_" /* Master(1), Slave(0) */ 128#define ASL_RESNAME_DECODE "_DEC" 129#define ASL_RESNAME_DMA "_DMA" 130#define ASL_RESNAME_DMATYPE "_TYP" /* Compatible(0), A(1), B(2), F(3) */ 131#define ASL_RESNAME_GRANULARITY "_GRA" 132#define ASL_RESNAME_INTERRUPT "_INT" 133#define ASL_RESNAME_INTERRUPTLEVEL "_LL_" /* ActiveLo(1), ActiveHi(0) */ 134#define ASL_RESNAME_INTERRUPTSHARE "_SHR" /* Shareable(1), NoShare(0) */ 135#define ASL_RESNAME_INTERRUPTTYPE "_HE_" /* Edge(1), Level(0) */ 136#define ASL_RESNAME_LENGTH "_LEN" 137#define ASL_RESNAME_MEMATTRIBUTES "_MTP" /* Memory(0), Reserved(1), ACPI(2), NVS(3) */ 138#define ASL_RESNAME_MEMTYPE "_MEM" /* NonCache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */ 139#define ASL_RESNAME_MAXADDR "_MAX" 140#define ASL_RESNAME_MINADDR "_MIN" 141#define ASL_RESNAME_MAXTYPE "_MAF" 142#define ASL_RESNAME_MINTYPE "_MIF" 143#define ASL_RESNAME_REGISTERBITOFFSET "_RBO" 144#define ASL_RESNAME_REGISTERBITWIDTH "_RBW" 145#define ASL_RESNAME_RANGETYPE "_RNG" 146#define ASL_RESNAME_READWRITETYPE "_RW_" /* ReadOnly(0), Writeable (1) */ 147#define ASL_RESNAME_TRANSLATION "_TRA" 148#define ASL_RESNAME_TRANSTYPE "_TRS" /* Sparse(1), Dense(0) */ 149#define ASL_RESNAME_TYPE "_TTP" /* Translation(1), Static (0) */ 150#define ASL_RESNAME_XFERTYPE "_SIZ" /* 8(0), 8And16(1), 16(2) */ 151 152 153/* Default sizes for "small" resource descriptors */ 154 155#define ASL_RDESC_IRQ_SIZE 0x02 156#define ASL_RDESC_DMA_SIZE 0x02 157#define ASL_RDESC_ST_DEPEND_SIZE 0x00 158#define ASL_RDESC_END_DEPEND_SIZE 0x00 159#define ASL_RDESC_IO_SIZE 0x07 160#define ASL_RDESC_FIXED_IO_SIZE 0x03 161#define ASL_RDESC_END_TAG_SIZE 0x01 162 163 164typedef struct asl_resource_node 165{ 166 UINT32 BufferLength; 167 void *Buffer; 168 struct asl_resource_node *Next; 169 170} ASL_RESOURCE_NODE; 171 172 173/* 174 * Resource descriptors defined in the ACPI specification. 175 * 176 * Alignment must be BYTE because these descriptors 177 * are used to overlay the AML byte stream. 178 */ 179#pragma pack(1) 180 181typedef struct asl_irq_format_desc 182{ 183 UINT8 DescriptorType; 184 UINT16 IrqMask; 185 UINT8 Flags; 186 187} ASL_IRQ_FORMAT_DESC; 188 189 190typedef struct asl_irq_noflags_desc 191{ 192 UINT8 DescriptorType; 193 UINT16 IrqMask; 194 195} ASL_IRQ_NOFLAGS_DESC; 196 197 198typedef struct asl_dma_format_desc 199{ 200 UINT8 DescriptorType; 201 UINT8 DmaChannelMask; 202 UINT8 Flags; 203 204} ASL_DMA_FORMAT_DESC; 205 206 207typedef struct asl_start_dependent_desc 208{ 209 UINT8 DescriptorType; 210 UINT8 Flags; 211 212} ASL_START_DEPENDENT_DESC; 213 214 215typedef struct asl_start_dependent_noprio_desc 216{ 217 UINT8 DescriptorType; 218 219} ASL_START_DEPENDENT_NOPRIO_DESC; 220 221 222typedef struct asl_end_dependent_desc 223{ 224 UINT8 DescriptorType; 225 226} ASL_END_DEPENDENT_DESC; 227 228 229typedef struct asl_io_port_desc 230{ 231 UINT8 DescriptorType; 232 UINT8 Information; 233 UINT16 AddressMin; 234 UINT16 AddressMax; 235 UINT8 Alignment; 236 UINT8 Length; 237 238} ASL_IO_PORT_DESC; 239 240 241typedef struct asl_fixed_io_port_desc 242{ 243 UINT8 DescriptorType; 244 UINT16 BaseAddress; 245 UINT8 Length; 246 247} ASL_FIXED_IO_PORT_DESC; 248 249 250typedef struct asl_small_vendor_desc 251{ 252 UINT8 DescriptorType; 253 UINT8 VendorDefined[7]; 254 255} ASL_SMALL_VENDOR_DESC; 256 257 258typedef struct asl_end_tag_desc 259{ 260 UINT8 DescriptorType; 261 UINT8 Checksum; 262 263} ASL_END_TAG_DESC; 264 265 266/* LARGE descriptors */ 267 268typedef struct asl_memory_24_desc 269{ 270 UINT8 DescriptorType; 271 UINT16 Length; 272 UINT8 Information; 273 UINT16 AddressMin; 274 UINT16 AddressMax; 275 UINT16 Alignment; 276 UINT16 RangeLength; 277 278} ASL_MEMORY_24_DESC; 279 280 281typedef struct asl_large_vendor_desc 282{ 283 UINT8 DescriptorType; 284 UINT16 Length; 285 UINT8 VendorDefined[1]; 286 287} ASL_LARGE_VENDOR_DESC; 288 289 290typedef struct asl_memory_32_desc 291{ 292 UINT8 DescriptorType; 293 UINT16 Length; 294 UINT8 Information; 295 UINT32 AddressMin; 296 UINT32 AddressMax; 297 UINT32 Alignment; 298 UINT32 RangeLength; 299 300} ASL_MEMORY_32_DESC; 301 302 303typedef struct asl_fixed_memory_32_desc 304{ 305 UINT8 DescriptorType; 306 UINT16 Length; 307 UINT8 Information; 308 UINT32 BaseAddress; 309 UINT32 RangeLength; 310 311} ASL_FIXED_MEMORY_32_DESC; 312 313 314typedef struct asl_qword_address_desc 315{ 316 UINT8 DescriptorType; 317 UINT16 Length; 318 UINT8 ResourceType; 319 UINT8 Flags; 320 UINT8 SpecificFlags; 321 UINT64 Granularity; 322 UINT64 AddressMin; 323 UINT64 AddressMax; 324 UINT64 TranslationOffset; 325 UINT64 AddressLength; 326 UINT8 OptionalFields[2]; 327 328} ASL_QWORD_ADDRESS_DESC; 329 330 331typedef struct asl_dword_address_desc 332{ 333 UINT8 DescriptorType; 334 UINT16 Length; 335 UINT8 ResourceType; 336 UINT8 Flags; 337 UINT8 SpecificFlags; 338 UINT32 Granularity; 339 UINT32 AddressMin; 340 UINT32 AddressMax; 341 UINT32 TranslationOffset; 342 UINT32 AddressLength; 343 UINT8 OptionalFields[2]; 344 345} ASL_DWORD_ADDRESS_DESC; 346 347 348typedef struct asl_word_address_desc 349{ 350 UINT8 DescriptorType; 351 UINT16 Length; 352 UINT8 ResourceType; 353 UINT8 Flags; 354 UINT8 SpecificFlags; 355 UINT16 Granularity; 356 UINT16 AddressMin; 357 UINT16 AddressMax; 358 UINT16 TranslationOffset; 359 UINT16 AddressLength; 360 UINT8 OptionalFields[2]; 361 362} ASL_WORD_ADDRESS_DESC; 363 364 365typedef struct asl_extended_xrupt_desc 366{ 367 UINT8 DescriptorType; 368 UINT16 Length; 369 UINT8 Flags; 370 UINT8 TableLength; 371 UINT32 InterruptNumber[1]; 372 /* ResSourceIndex, ResSource optional fields follow */ 373 374} ASL_EXTENDED_XRUPT_DESC; 375 376 377typedef struct asl_general_register_desc 378{ 379 UINT8 DescriptorType; 380 UINT16 Length; 381 UINT8 AddressSpaceId; 382 UINT8 BitWidth; 383 UINT8 BitOffset; 384 UINT8 Reserved; 385 UINT64 Address; 386 387} ASL_GENERAL_REGISTER_DESC; 388 389/* restore default alignment */ 390 391#pragma pack() 392 393/* Union of all resource descriptors, sow we can allocate the worst case */ 394 395typedef union asl_resource_desc 396{ 397 ASL_IRQ_FORMAT_DESC Irq; 398 ASL_DMA_FORMAT_DESC Dma; 399 ASL_START_DEPENDENT_DESC Std; 400 ASL_END_DEPENDENT_DESC End; 401 ASL_IO_PORT_DESC Iop; 402 ASL_FIXED_IO_PORT_DESC Fio; 403 ASL_SMALL_VENDOR_DESC Smv; 404 ASL_END_TAG_DESC Et; 405 406 ASL_MEMORY_24_DESC M24; 407 ASL_LARGE_VENDOR_DESC Lgv; 408 ASL_MEMORY_32_DESC M32; 409 ASL_FIXED_MEMORY_32_DESC F32; 410 ASL_QWORD_ADDRESS_DESC Qas; 411 ASL_DWORD_ADDRESS_DESC Das; 412 ASL_WORD_ADDRESS_DESC Was; 413 ASL_EXTENDED_XRUPT_DESC Exx; 414 ASL_GENERAL_REGISTER_DESC Grg; 415 UINT32 U32Item; 416 UINT16 U16Item; 417 UINT8 U8Item; 418 419} ASL_RESOURCE_DESC; 420 421 422#define NEXT_RESOURCE_DESC(a,b) (ASL_RESOURCE_DESC *) (((char *) (a)) + sizeof(b)) 423 424#define DEFAULT_RESOURCE_DESC_SIZE (sizeof (ASL_RESOURCE_DESC) + sizeof (ASL_END_TAG_DESC)) 425 426 427/* 428 * Resource utilities 429 */ 430 431ASL_RESOURCE_NODE * 432RsAllocateResourceNode ( 433 UINT32 Size); 434 435 void 436RsCreateBitField ( 437 ACPI_PARSE_OBJECT *Op, 438 char *Name, 439 UINT32 ByteOffset, 440 UINT32 BitOffset); 441 442void 443RsCreateByteField ( 444 ACPI_PARSE_OBJECT *Op, 445 char *Name, 446 UINT32 ByteOffset); 447 448void 449RsSetFlagBits ( 450 UINT8 *Flags, 451 ACPI_PARSE_OBJECT *Op, 452 UINT8 Position, 453 UINT8 Default); 454 455ACPI_PARSE_OBJECT * 456RsCompleteNodeAndGetNext ( 457 ACPI_PARSE_OBJECT *Op); 458 459ASL_RESOURCE_NODE * 460RsDoOneResourceDescriptor ( 461 ACPI_PARSE_OBJECT *DescriptorTypeOp, 462 UINT32 CurrentByteOffset); 463 464UINT32 465RsLinkDescriptorChain ( 466 ASL_RESOURCE_NODE **PreviousRnode, 467 ASL_RESOURCE_NODE *Rnode); 468 469 470/* 471 * Small descriptors 472 */ 473 474ASL_RESOURCE_NODE * 475RsDoDmaDescriptor ( 476 ACPI_PARSE_OBJECT *Op, 477 UINT32 CurrentByteOffset); 478 479ASL_RESOURCE_NODE * 480RsDoEndDependentDescriptor ( 481 ACPI_PARSE_OBJECT *Op, 482 UINT32 CurrentByteOffset); 483 484ASL_RESOURCE_NODE * 485RsDoFixedIoDescriptor ( 486 ACPI_PARSE_OBJECT *Op, 487 UINT32 CurrentByteOffset); 488 489ASL_RESOURCE_NODE * 490RsDoInterruptDescriptor ( 491 ACPI_PARSE_OBJECT *Op, 492 UINT32 CurrentByteOffset); 493 494ASL_RESOURCE_NODE * 495RsDoIoDescriptor ( 496 ACPI_PARSE_OBJECT *Op, 497 UINT32 CurrentByteOffset); 498 499ASL_RESOURCE_NODE * 500RsDoIrqDescriptor ( 501 ACPI_PARSE_OBJECT *Op, 502 UINT32 CurrentByteOffset); 503 504ASL_RESOURCE_NODE * 505RsDoIrqNoFlagsDescriptor ( 506 ACPI_PARSE_OBJECT *Op, 507 UINT32 CurrentByteOffset); 508 509ASL_RESOURCE_NODE * 510RsDoMemory24Descriptor ( 511 ACPI_PARSE_OBJECT *Op, 512 UINT32 CurrentByteOffset); 513 514ASL_RESOURCE_NODE * 515RsDoMemory32Descriptor ( 516 ACPI_PARSE_OBJECT *Op, 517 UINT32 CurrentByteOffset); 518 519ASL_RESOURCE_NODE * 520RsDoMemory32FixedDescriptor ( 521 ACPI_PARSE_OBJECT *Op, 522 UINT32 CurrentByteOffset); 523 524ASL_RESOURCE_NODE * 525RsDoStartDependentDescriptor ( 526 ACPI_PARSE_OBJECT *Op, 527 UINT32 CurrentByteOffset); 528 529ASL_RESOURCE_NODE * 530RsDoStartDependentNoPriDescriptor ( 531 ACPI_PARSE_OBJECT *Op, 532 UINT32 CurrentByteOffset); 533 534ASL_RESOURCE_NODE * 535RsDoVendorSmallDescriptor ( 536 ACPI_PARSE_OBJECT *Op, 537 UINT32 CurrentByteOffset); 538 539 540/* 541 * Large descriptors 542 */ 543 544UINT32 545RsGetStringDataLength ( 546 ACPI_PARSE_OBJECT *InitializerOp); 547 548ASL_RESOURCE_NODE * 549RsDoDwordIoDescriptor ( 550 ACPI_PARSE_OBJECT *Op, 551 UINT32 CurrentByteOffset); 552 553ASL_RESOURCE_NODE * 554RsDoDwordMemoryDescriptor ( 555 ACPI_PARSE_OBJECT *Op, 556 UINT32 CurrentByteOffset); 557 558ASL_RESOURCE_NODE * 559RsDoQwordIoDescriptor ( 560 ACPI_PARSE_OBJECT *Op, 561 UINT32 CurrentByteOffset); 562 563ASL_RESOURCE_NODE * 564RsDoQwordMemoryDescriptor ( 565 ACPI_PARSE_OBJECT *Op, 566 UINT32 CurrentByteOffset); 567 568ASL_RESOURCE_NODE * 569RsDoWordIoDescriptor ( 570 ACPI_PARSE_OBJECT *Op, 571 UINT32 CurrentByteOffset); 572 573ASL_RESOURCE_NODE * 574RsDoWordBusNumberDescriptor ( 575 ACPI_PARSE_OBJECT *Op, 576 UINT32 CurrentByteOffset); 577 578ASL_RESOURCE_NODE * 579RsDoVendorLargeDescriptor ( 580 ACPI_PARSE_OBJECT *Op, 581 UINT32 CurrentByteOffset); 582 583ASL_RESOURCE_NODE * 584RsDoGeneralRegisterDescriptor ( 585 ACPI_PARSE_OBJECT *Op, 586 UINT32 CurrentByteOffset); 587 588 589#endif 590 591