1 /******************************************************************************
3 * Module Name: amlresrc.h - AML resource descriptors
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
44 /* acpisrc:StructDefs -- for acpisrc conversion */
50 #pragma pack(push) /* Set default struct packing */
53 * Resource descriptor tags, as defined in the ACPI specification.
54 * Used to symbolically reference fields within a descriptor.
56 #define ACPI_RESTAG_ADDRESS "_ADR"
57 #define ACPI_RESTAG_ALIGNMENT "_ALN"
58 #define ACPI_RESTAG_ADDRESSSPACE "_ASI"
59 #define ACPI_RESTAG_ACCESSSIZE "_ASZ"
60 #define ACPI_RESTAG_TYPESPECIFICATTRIBUTES "_ATT"
61 #define ACPI_RESTAG_BASEADDRESS "_BAS"
62 #define ACPI_RESTAG_BUSMASTER "_BM_" /* Master(1), Slave(0) */
63 #define ACPI_RESTAG_DEBOUNCETIME "_DBT"
64 #define ACPI_RESTAG_DECODE "_DEC"
65 #define ACPI_RESTAG_DEVICEPOLARITY "_DPL"
66 #define ACPI_RESTAG_DMA "_DMA"
67 #define ACPI_RESTAG_DMATYPE "_TYP" /* Compatible(0), A(1), B(2), F(3) */
68 #define ACPI_RESTAG_DRIVESTRENGTH "_DRS"
69 #define ACPI_RESTAG_ENDIANNESS "_END"
70 #define ACPI_RESTAG_FLOWCONTROL "_FLC"
71 #define ACPI_RESTAG_GRANULARITY "_GRA"
72 #define ACPI_RESTAG_INTERRUPT "_INT"
73 #define ACPI_RESTAG_INTERRUPTLEVEL "_LL_" /* ActiveLo(1), ActiveHi(0) */
74 #define ACPI_RESTAG_INTERRUPTSHARE "_SHR" /* Shareable(1), NoShare(0) */
75 #define ACPI_RESTAG_INTERRUPTTYPE "_HE_" /* Edge(1), Level(0) */
76 #define ACPI_RESTAG_IORESTRICTION "_IOR"
77 #define ACPI_RESTAG_LENGTH "_LEN"
78 #define ACPI_RESTAG_LINE "_LIN"
79 #define ACPI_RESTAG_MEMATTRIBUTES "_MTP" /* Memory(0), Reserved(1), ACPI(2), NVS(3) */
80 #define ACPI_RESTAG_MEMTYPE "_MEM" /* NonCache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */
81 #define ACPI_RESTAG_MAXADDR "_MAX"
82 #define ACPI_RESTAG_MINADDR "_MIN"
83 #define ACPI_RESTAG_MAXTYPE "_MAF"
84 #define ACPI_RESTAG_MINTYPE "_MIF"
85 #define ACPI_RESTAG_MODE "_MOD"
86 #define ACPI_RESTAG_PARITY "_PAR"
87 #define ACPI_RESTAG_PHASE "_PHA"
88 #define ACPI_RESTAG_PIN "_PIN"
89 #define ACPI_RESTAG_PINCONFIG "_PPI"
90 #define ACPI_RESTAG_POLARITY "_POL"
91 #define ACPI_RESTAG_REGISTERBITOFFSET "_RBO"
92 #define ACPI_RESTAG_REGISTERBITWIDTH "_RBW"
93 #define ACPI_RESTAG_RANGETYPE "_RNG"
94 #define ACPI_RESTAG_READWRITETYPE "_RW_" /* ReadOnly(0), Writeable (1) */
95 #define ACPI_RESTAG_LENGTH_RX "_RXL"
96 #define ACPI_RESTAG_LENGTH_TX "_TXL"
97 #define ACPI_RESTAG_SLAVEMODE "_SLV"
98 #define ACPI_RESTAG_SPEED "_SPE"
99 #define ACPI_RESTAG_STOPBITS "_STB"
100 #define ACPI_RESTAG_TRANSLATION "_TRA"
101 #define ACPI_RESTAG_TRANSTYPE "_TRS" /* Sparse(1), Dense(0) */
102 #define ACPI_RESTAG_TYPE "_TTP" /* Translation(1), Static (0) */
103 #define ACPI_RESTAG_XFERTYPE "_SIZ" /* 8(0), 8And16(1), 16(2) */
104 #define ACPI_RESTAG_VENDORDATA "_VEN"
107 /* Default sizes for "small" resource descriptors */
109 #define ASL_RDESC_IRQ_SIZE 0x02
110 #define ASL_RDESC_DMA_SIZE 0x02
111 #define ASL_RDESC_ST_DEPEND_SIZE 0x00
112 #define ASL_RDESC_END_DEPEND_SIZE 0x00
113 #define ASL_RDESC_IO_SIZE 0x07
114 #define ASL_RDESC_FIXED_IO_SIZE 0x03
115 #define ASL_RDESC_FIXED_DMA_SIZE 0x05
116 #define ASL_RDESC_END_TAG_SIZE 0x01
119 typedef struct asl_resource_node
123 struct asl_resource_node *Next;
128 /* Macros used to generate AML resource length fields */
130 #define ACPI_AML_SIZE_LARGE(r) (sizeof (r) - sizeof (AML_RESOURCE_LARGE_HEADER))
131 #define ACPI_AML_SIZE_SMALL(r) (sizeof (r) - sizeof (AML_RESOURCE_SMALL_HEADER))
134 * Resource descriptors defined in the ACPI specification.
136 * Packing/alignment must be BYTE because these descriptors
137 * are used to overlay the raw AML byte stream.
144 #define AML_RESOURCE_SMALL_HEADER_COMMON \
145 UINT8 DescriptorType;
147 typedef struct aml_resource_small_header
149 AML_RESOURCE_SMALL_HEADER_COMMON
151 } AML_RESOURCE_SMALL_HEADER;
154 typedef struct aml_resource_irq
156 AML_RESOURCE_SMALL_HEADER_COMMON
163 typedef struct aml_resource_irq_noflags
165 AML_RESOURCE_SMALL_HEADER_COMMON
168 } AML_RESOURCE_IRQ_NOFLAGS;
171 typedef struct aml_resource_dma
173 AML_RESOURCE_SMALL_HEADER_COMMON
174 UINT8 DmaChannelMask;
180 typedef struct aml_resource_start_dependent
182 AML_RESOURCE_SMALL_HEADER_COMMON
185 } AML_RESOURCE_START_DEPENDENT;
188 typedef struct aml_resource_start_dependent_noprio
190 AML_RESOURCE_SMALL_HEADER_COMMON
192 } AML_RESOURCE_START_DEPENDENT_NOPRIO;
195 typedef struct aml_resource_end_dependent
197 AML_RESOURCE_SMALL_HEADER_COMMON
199 } AML_RESOURCE_END_DEPENDENT;
202 typedef struct aml_resource_io
204 AML_RESOURCE_SMALL_HEADER_COMMON
214 typedef struct aml_resource_fixed_io
216 AML_RESOURCE_SMALL_HEADER_COMMON
220 } AML_RESOURCE_FIXED_IO;
223 typedef struct aml_resource_vendor_small
225 AML_RESOURCE_SMALL_HEADER_COMMON
227 } AML_RESOURCE_VENDOR_SMALL;
230 typedef struct aml_resource_end_tag
232 AML_RESOURCE_SMALL_HEADER_COMMON
235 } AML_RESOURCE_END_TAG;
238 typedef struct aml_resource_fixed_dma
240 AML_RESOURCE_SMALL_HEADER_COMMON
245 } AML_RESOURCE_FIXED_DMA;
251 #define AML_RESOURCE_LARGE_HEADER_COMMON \
252 UINT8 DescriptorType;\
253 UINT16 ResourceLength;
255 typedef struct aml_resource_large_header
257 AML_RESOURCE_LARGE_HEADER_COMMON
259 } AML_RESOURCE_LARGE_HEADER;
262 /* General Flags for address space resource descriptors */
264 #define ACPI_RESOURCE_FLAG_DEC 2
265 #define ACPI_RESOURCE_FLAG_MIF 4
266 #define ACPI_RESOURCE_FLAG_MAF 8
268 typedef struct aml_resource_memory24
270 AML_RESOURCE_LARGE_HEADER_COMMON
275 UINT16 AddressLength;
277 } AML_RESOURCE_MEMORY24;
280 typedef struct aml_resource_vendor_large
282 AML_RESOURCE_LARGE_HEADER_COMMON
284 } AML_RESOURCE_VENDOR_LARGE;
287 typedef struct aml_resource_memory32
289 AML_RESOURCE_LARGE_HEADER_COMMON
294 UINT32 AddressLength;
296 } AML_RESOURCE_MEMORY32;
299 typedef struct aml_resource_fixed_memory32
301 AML_RESOURCE_LARGE_HEADER_COMMON
304 UINT32 AddressLength;
306 } AML_RESOURCE_FIXED_MEMORY32;
309 #define AML_RESOURCE_ADDRESS_COMMON \
310 UINT8 ResourceType; \
315 typedef struct aml_resource_address
317 AML_RESOURCE_LARGE_HEADER_COMMON
318 AML_RESOURCE_ADDRESS_COMMON
320 } AML_RESOURCE_ADDRESS;
323 typedef struct aml_resource_extended_address64
325 AML_RESOURCE_LARGE_HEADER_COMMON
326 AML_RESOURCE_ADDRESS_COMMON
332 UINT64 TranslationOffset;
333 UINT64 AddressLength;
336 } AML_RESOURCE_EXTENDED_ADDRESS64;
338 #define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */
341 typedef struct aml_resource_address64
343 AML_RESOURCE_LARGE_HEADER_COMMON
344 AML_RESOURCE_ADDRESS_COMMON
348 UINT64 TranslationOffset;
349 UINT64 AddressLength;
351 } AML_RESOURCE_ADDRESS64;
354 typedef struct aml_resource_address32
356 AML_RESOURCE_LARGE_HEADER_COMMON
357 AML_RESOURCE_ADDRESS_COMMON
361 UINT32 TranslationOffset;
362 UINT32 AddressLength;
364 } AML_RESOURCE_ADDRESS32;
367 typedef struct aml_resource_address16
369 AML_RESOURCE_LARGE_HEADER_COMMON
370 AML_RESOURCE_ADDRESS_COMMON
374 UINT16 TranslationOffset;
375 UINT16 AddressLength;
377 } AML_RESOURCE_ADDRESS16;
380 typedef struct aml_resource_extended_irq
382 AML_RESOURCE_LARGE_HEADER_COMMON
384 UINT8 InterruptCount;
385 UINT32 Interrupts[1];
386 /* ResSourceIndex, ResSource optional fields follow */
388 } AML_RESOURCE_EXTENDED_IRQ;
391 typedef struct aml_resource_generic_register
393 AML_RESOURCE_LARGE_HEADER_COMMON
394 UINT8 AddressSpaceId;
397 UINT8 AccessSize; /* ACPI 3.0, was previously Reserved */
400 } AML_RESOURCE_GENERIC_REGISTER;
403 /* Common descriptor for GpioInt and GpioIo (ACPI 5.0) */
405 typedef struct aml_resource_gpio
407 AML_RESOURCE_LARGE_HEADER_COMMON
409 UINT8 ConnectionType;
413 UINT16 DriveStrength;
414 UINT16 DebounceTimeout;
415 UINT16 PinTableOffset;
416 UINT8 ResSourceIndex;
417 UINT16 ResSourceOffset;
421 * Optional fields follow immediately:
422 * 1) PIN list (Words)
423 * 2) Resource Source String
424 * 3) Vendor Data bytes
429 #define AML_RESOURCE_GPIO_REVISION 1 /* ACPI 5.0 */
431 /* Values for ConnectionType above */
433 #define AML_RESOURCE_GPIO_TYPE_INT 0
434 #define AML_RESOURCE_GPIO_TYPE_IO 1
435 #define AML_RESOURCE_MAX_GPIOTYPE 1
438 /* Common preamble for all serial descriptors (ACPI 5.0) */
440 #define AML_RESOURCE_SERIAL_COMMON \
442 UINT8 ResSourceIndex; \
445 UINT16 TypeSpecificFlags; \
446 UINT8 TypeRevisionId; \
447 UINT16 TypeDataLength; \
449 /* Values for the type field above */
451 #define AML_RESOURCE_I2C_SERIALBUSTYPE 1
452 #define AML_RESOURCE_SPI_SERIALBUSTYPE 2
453 #define AML_RESOURCE_UART_SERIALBUSTYPE 3
454 #define AML_RESOURCE_MAX_SERIALBUSTYPE 3
455 #define AML_RESOURCE_VENDOR_SERIALBUSTYPE 192 /* Vendor defined is 0xC0-0xFF (NOT SUPPORTED) */
457 typedef struct aml_resource_common_serialbus
459 AML_RESOURCE_LARGE_HEADER_COMMON
460 AML_RESOURCE_SERIAL_COMMON
462 } AML_RESOURCE_COMMON_SERIALBUS;
464 typedef struct aml_resource_i2c_serialbus
466 AML_RESOURCE_LARGE_HEADER_COMMON
467 AML_RESOURCE_SERIAL_COMMON
468 UINT32 ConnectionSpeed;
471 * Optional fields follow immediately:
472 * 1) Vendor Data bytes
473 * 2) Resource Source String
476 } AML_RESOURCE_I2C_SERIALBUS;
478 #define AML_RESOURCE_I2C_REVISION 1 /* ACPI 5.0 */
479 #define AML_RESOURCE_I2C_TYPE_REVISION 1 /* ACPI 5.0 */
480 #define AML_RESOURCE_I2C_MIN_DATA_LEN 6
482 typedef struct aml_resource_spi_serialbus
484 AML_RESOURCE_LARGE_HEADER_COMMON
485 AML_RESOURCE_SERIAL_COMMON
486 UINT32 ConnectionSpeed;
490 UINT16 DeviceSelection;
492 * Optional fields follow immediately:
493 * 1) Vendor Data bytes
494 * 2) Resource Source String
497 } AML_RESOURCE_SPI_SERIALBUS;
499 #define AML_RESOURCE_SPI_REVISION 1 /* ACPI 5.0 */
500 #define AML_RESOURCE_SPI_TYPE_REVISION 1 /* ACPI 5.0 */
501 #define AML_RESOURCE_SPI_MIN_DATA_LEN 9
504 typedef struct aml_resource_uart_serialbus
506 AML_RESOURCE_LARGE_HEADER_COMMON
507 AML_RESOURCE_SERIAL_COMMON
508 UINT32 DefaultBaudRate;
514 * Optional fields follow immediately:
515 * 1) Vendor Data bytes
516 * 2) Resource Source String
519 } AML_RESOURCE_UART_SERIALBUS;
521 #define AML_RESOURCE_UART_REVISION 1 /* ACPI 5.0 */
522 #define AML_RESOURCE_UART_TYPE_REVISION 1 /* ACPI 5.0 */
523 #define AML_RESOURCE_UART_MIN_DATA_LEN 10
526 /* restore default alignment */
530 /* Union of all resource descriptors, so we can allocate the worst case */
532 typedef union aml_resource
534 /* Descriptor headers */
536 UINT8 DescriptorType;
537 AML_RESOURCE_SMALL_HEADER SmallHeader;
538 AML_RESOURCE_LARGE_HEADER LargeHeader;
540 /* Small resource descriptors */
542 AML_RESOURCE_IRQ Irq;
543 AML_RESOURCE_DMA Dma;
544 AML_RESOURCE_START_DEPENDENT StartDpf;
545 AML_RESOURCE_END_DEPENDENT EndDpf;
547 AML_RESOURCE_FIXED_IO FixedIo;
548 AML_RESOURCE_FIXED_DMA FixedDma;
549 AML_RESOURCE_VENDOR_SMALL VendorSmall;
550 AML_RESOURCE_END_TAG EndTag;
552 /* Large resource descriptors */
554 AML_RESOURCE_MEMORY24 Memory24;
555 AML_RESOURCE_GENERIC_REGISTER GenericReg;
556 AML_RESOURCE_VENDOR_LARGE VendorLarge;
557 AML_RESOURCE_MEMORY32 Memory32;
558 AML_RESOURCE_FIXED_MEMORY32 FixedMemory32;
559 AML_RESOURCE_ADDRESS16 Address16;
560 AML_RESOURCE_ADDRESS32 Address32;
561 AML_RESOURCE_ADDRESS64 Address64;
562 AML_RESOURCE_EXTENDED_ADDRESS64 ExtAddress64;
563 AML_RESOURCE_EXTENDED_IRQ ExtendedIrq;
564 AML_RESOURCE_GPIO Gpio;
565 AML_RESOURCE_I2C_SERIALBUS I2cSerialBus;
566 AML_RESOURCE_SPI_SERIALBUS SpiSerialBus;
567 AML_RESOURCE_UART_SERIALBUS UartSerialBus;
568 AML_RESOURCE_COMMON_SERIALBUS CommonSerialBus;
570 /* Utility overlays */
572 AML_RESOURCE_ADDRESS Address;
580 #pragma pack(pop) /* Restore original struct packing */