2 /******************************************************************************
4 * Module Name: amlresrc.h - AML resource descriptors
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2012, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 /* acpisrc:StructDefs -- for acpisrc conversion */
52 * Resource descriptor tags, as defined in the ACPI specification.
53 * Used to symbolically reference fields within a descriptor.
55 #define ACPI_RESTAG_ADDRESS "_ADR"
56 #define ACPI_RESTAG_ALIGNMENT "_ALN"
57 #define ACPI_RESTAG_ADDRESSSPACE "_ASI"
58 #define ACPI_RESTAG_ACCESSSIZE "_ASZ"
59 #define ACPI_RESTAG_TYPESPECIFICATTRIBUTES "_ATT"
60 #define ACPI_RESTAG_BASEADDRESS "_BAS"
61 #define ACPI_RESTAG_BUSMASTER "_BM_" /* Master(1), Slave(0) */
62 #define ACPI_RESTAG_DEBOUNCETIME "_DBT"
63 #define ACPI_RESTAG_DECODE "_DEC"
64 #define ACPI_RESTAG_DEVICEPOLARITY "_DPL"
65 #define ACPI_RESTAG_DMA "_DMA"
66 #define ACPI_RESTAG_DMATYPE "_TYP" /* Compatible(0), A(1), B(2), F(3) */
67 #define ACPI_RESTAG_DRIVESTRENGTH "_DRS"
68 #define ACPI_RESTAG_ENDIANNESS "_END"
69 #define ACPI_RESTAG_FLOWCONTROL "_FLC"
70 #define ACPI_RESTAG_GRANULARITY "_GRA"
71 #define ACPI_RESTAG_INTERRUPT "_INT"
72 #define ACPI_RESTAG_INTERRUPTLEVEL "_LL_" /* ActiveLo(1), ActiveHi(0) */
73 #define ACPI_RESTAG_INTERRUPTSHARE "_SHR" /* Shareable(1), NoShare(0) */
74 #define ACPI_RESTAG_INTERRUPTTYPE "_HE_" /* Edge(1), Level(0) */
75 #define ACPI_RESTAG_IORESTRICTION "_IOR"
76 #define ACPI_RESTAG_LENGTH "_LEN"
77 #define ACPI_RESTAG_LINE "_LIN"
78 #define ACPI_RESTAG_MEMATTRIBUTES "_MTP" /* Memory(0), Reserved(1), ACPI(2), NVS(3) */
79 #define ACPI_RESTAG_MEMTYPE "_MEM" /* NonCache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */
80 #define ACPI_RESTAG_MAXADDR "_MAX"
81 #define ACPI_RESTAG_MINADDR "_MIN"
82 #define ACPI_RESTAG_MAXTYPE "_MAF"
83 #define ACPI_RESTAG_MINTYPE "_MIF"
84 #define ACPI_RESTAG_MODE "_MOD"
85 #define ACPI_RESTAG_PARITY "_PAR"
86 #define ACPI_RESTAG_PHASE "_PHA"
87 #define ACPI_RESTAG_PIN "_PIN"
88 #define ACPI_RESTAG_PINCONFIG "_PPI"
89 #define ACPI_RESTAG_POLARITY "_POL"
90 #define ACPI_RESTAG_REGISTERBITOFFSET "_RBO"
91 #define ACPI_RESTAG_REGISTERBITWIDTH "_RBW"
92 #define ACPI_RESTAG_RANGETYPE "_RNG"
93 #define ACPI_RESTAG_READWRITETYPE "_RW_" /* ReadOnly(0), Writeable (1) */
94 #define ACPI_RESTAG_LENGTH_RX "_RXL"
95 #define ACPI_RESTAG_LENGTH_TX "_TXL"
96 #define ACPI_RESTAG_SLAVEMODE "_SLV"
97 #define ACPI_RESTAG_SPEED "_SPE"
98 #define ACPI_RESTAG_STOPBITS "_STB"
99 #define ACPI_RESTAG_TRANSLATION "_TRA"
100 #define ACPI_RESTAG_TRANSTYPE "_TRS" /* Sparse(1), Dense(0) */
101 #define ACPI_RESTAG_TYPE "_TTP" /* Translation(1), Static (0) */
102 #define ACPI_RESTAG_XFERTYPE "_SIZ" /* 8(0), 8And16(1), 16(2) */
103 #define ACPI_RESTAG_VENDORDATA "_VEN"
106 /* Default sizes for "small" resource descriptors */
108 #define ASL_RDESC_IRQ_SIZE 0x02
109 #define ASL_RDESC_DMA_SIZE 0x02
110 #define ASL_RDESC_ST_DEPEND_SIZE 0x00
111 #define ASL_RDESC_END_DEPEND_SIZE 0x00
112 #define ASL_RDESC_IO_SIZE 0x07
113 #define ASL_RDESC_FIXED_IO_SIZE 0x03
114 #define ASL_RDESC_FIXED_DMA_SIZE 0x05
115 #define ASL_RDESC_END_TAG_SIZE 0x01
118 typedef struct asl_resource_node
122 struct asl_resource_node *Next;
127 /* Macros used to generate AML resource length fields */
129 #define ACPI_AML_SIZE_LARGE(r) (sizeof (r) - sizeof (AML_RESOURCE_LARGE_HEADER))
130 #define ACPI_AML_SIZE_SMALL(r) (sizeof (r) - sizeof (AML_RESOURCE_SMALL_HEADER))
133 * Resource descriptors defined in the ACPI specification.
135 * Packing/alignment must be BYTE because these descriptors
136 * are used to overlay the raw AML byte stream.
143 #define AML_RESOURCE_SMALL_HEADER_COMMON \
144 UINT8 DescriptorType;
146 typedef struct aml_resource_small_header
148 AML_RESOURCE_SMALL_HEADER_COMMON
150 } AML_RESOURCE_SMALL_HEADER;
153 typedef struct aml_resource_irq
155 AML_RESOURCE_SMALL_HEADER_COMMON
162 typedef struct aml_resource_irq_noflags
164 AML_RESOURCE_SMALL_HEADER_COMMON
167 } AML_RESOURCE_IRQ_NOFLAGS;
170 typedef struct aml_resource_dma
172 AML_RESOURCE_SMALL_HEADER_COMMON
173 UINT8 DmaChannelMask;
179 typedef struct aml_resource_start_dependent
181 AML_RESOURCE_SMALL_HEADER_COMMON
184 } AML_RESOURCE_START_DEPENDENT;
187 typedef struct aml_resource_start_dependent_noprio
189 AML_RESOURCE_SMALL_HEADER_COMMON
191 } AML_RESOURCE_START_DEPENDENT_NOPRIO;
194 typedef struct aml_resource_end_dependent
196 AML_RESOURCE_SMALL_HEADER_COMMON
198 } AML_RESOURCE_END_DEPENDENT;
201 typedef struct aml_resource_io
203 AML_RESOURCE_SMALL_HEADER_COMMON
213 typedef struct aml_resource_fixed_io
215 AML_RESOURCE_SMALL_HEADER_COMMON
219 } AML_RESOURCE_FIXED_IO;
222 typedef struct aml_resource_vendor_small
224 AML_RESOURCE_SMALL_HEADER_COMMON
226 } AML_RESOURCE_VENDOR_SMALL;
229 typedef struct aml_resource_end_tag
231 AML_RESOURCE_SMALL_HEADER_COMMON
234 } AML_RESOURCE_END_TAG;
237 typedef struct aml_resource_fixed_dma
239 AML_RESOURCE_SMALL_HEADER_COMMON
244 } AML_RESOURCE_FIXED_DMA;
250 #define AML_RESOURCE_LARGE_HEADER_COMMON \
251 UINT8 DescriptorType;\
252 UINT16 ResourceLength;
254 typedef struct aml_resource_large_header
256 AML_RESOURCE_LARGE_HEADER_COMMON
258 } AML_RESOURCE_LARGE_HEADER;
261 /* General Flags for address space resource descriptors */
263 #define ACPI_RESOURCE_FLAG_DEC 2
264 #define ACPI_RESOURCE_FLAG_MIF 4
265 #define ACPI_RESOURCE_FLAG_MAF 8
267 typedef struct aml_resource_memory24
269 AML_RESOURCE_LARGE_HEADER_COMMON
274 UINT16 AddressLength;
276 } AML_RESOURCE_MEMORY24;
279 typedef struct aml_resource_vendor_large
281 AML_RESOURCE_LARGE_HEADER_COMMON
283 } AML_RESOURCE_VENDOR_LARGE;
286 typedef struct aml_resource_memory32
288 AML_RESOURCE_LARGE_HEADER_COMMON
293 UINT32 AddressLength;
295 } AML_RESOURCE_MEMORY32;
298 typedef struct aml_resource_fixed_memory32
300 AML_RESOURCE_LARGE_HEADER_COMMON
303 UINT32 AddressLength;
305 } AML_RESOURCE_FIXED_MEMORY32;
308 #define AML_RESOURCE_ADDRESS_COMMON \
309 UINT8 ResourceType; \
314 typedef struct aml_resource_address
316 AML_RESOURCE_LARGE_HEADER_COMMON
317 AML_RESOURCE_ADDRESS_COMMON
319 } AML_RESOURCE_ADDRESS;
322 typedef struct aml_resource_extended_address64
324 AML_RESOURCE_LARGE_HEADER_COMMON
325 AML_RESOURCE_ADDRESS_COMMON
331 UINT64 TranslationOffset;
332 UINT64 AddressLength;
335 } AML_RESOURCE_EXTENDED_ADDRESS64;
337 #define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */
340 typedef struct aml_resource_address64
342 AML_RESOURCE_LARGE_HEADER_COMMON
343 AML_RESOURCE_ADDRESS_COMMON
347 UINT64 TranslationOffset;
348 UINT64 AddressLength;
350 } AML_RESOURCE_ADDRESS64;
353 typedef struct aml_resource_address32
355 AML_RESOURCE_LARGE_HEADER_COMMON
356 AML_RESOURCE_ADDRESS_COMMON
360 UINT32 TranslationOffset;
361 UINT32 AddressLength;
363 } AML_RESOURCE_ADDRESS32;
366 typedef struct aml_resource_address16
368 AML_RESOURCE_LARGE_HEADER_COMMON
369 AML_RESOURCE_ADDRESS_COMMON
373 UINT16 TranslationOffset;
374 UINT16 AddressLength;
376 } AML_RESOURCE_ADDRESS16;
379 typedef struct aml_resource_extended_irq
381 AML_RESOURCE_LARGE_HEADER_COMMON
383 UINT8 InterruptCount;
384 UINT32 Interrupts[1];
385 /* ResSourceIndex, ResSource optional fields follow */
387 } AML_RESOURCE_EXTENDED_IRQ;
390 typedef struct aml_resource_generic_register
392 AML_RESOURCE_LARGE_HEADER_COMMON
393 UINT8 AddressSpaceId;
396 UINT8 AccessSize; /* ACPI 3.0, was previously Reserved */
399 } AML_RESOURCE_GENERIC_REGISTER;
402 /* Common descriptor for GpioInt and GpioIo (ACPI 5.0) */
404 typedef struct aml_resource_gpio
406 AML_RESOURCE_LARGE_HEADER_COMMON
408 UINT8 ConnectionType;
412 UINT16 DriveStrength;
413 UINT16 DebounceTimeout;
414 UINT16 PinTableOffset;
415 UINT8 ResSourceIndex;
416 UINT16 ResSourceOffset;
420 * Optional fields follow immediately:
421 * 1) PIN list (Words)
422 * 2) Resource Source String
423 * 3) Vendor Data bytes
428 #define AML_RESOURCE_GPIO_REVISION 1 /* ACPI 5.0 */
430 /* Values for ConnectionType above */
432 #define AML_RESOURCE_GPIO_TYPE_INT 0
433 #define AML_RESOURCE_GPIO_TYPE_IO 1
434 #define AML_RESOURCE_MAX_GPIOTYPE 1
437 /* Common preamble for all serial descriptors (ACPI 5.0) */
439 #define AML_RESOURCE_SERIAL_COMMON \
441 UINT8 ResSourceIndex; \
444 UINT16 TypeSpecificFlags; \
445 UINT8 TypeRevisionId; \
446 UINT16 TypeDataLength; \
448 /* Values for the type field above */
450 #define AML_RESOURCE_I2C_SERIALBUSTYPE 1
451 #define AML_RESOURCE_SPI_SERIALBUSTYPE 2
452 #define AML_RESOURCE_UART_SERIALBUSTYPE 3
453 #define AML_RESOURCE_MAX_SERIALBUSTYPE 3
454 #define AML_RESOURCE_VENDOR_SERIALBUSTYPE 192 /* Vendor defined is 0xC0-0xFF (NOT SUPPORTED) */
456 typedef struct aml_resource_common_serialbus
458 AML_RESOURCE_LARGE_HEADER_COMMON
459 AML_RESOURCE_SERIAL_COMMON
461 } AML_RESOURCE_COMMON_SERIALBUS;
463 typedef struct aml_resource_i2c_serialbus
465 AML_RESOURCE_LARGE_HEADER_COMMON
466 AML_RESOURCE_SERIAL_COMMON
467 UINT32 ConnectionSpeed;
470 * Optional fields follow immediately:
471 * 1) Vendor Data bytes
472 * 2) Resource Source String
475 } AML_RESOURCE_I2C_SERIALBUS;
477 #define AML_RESOURCE_I2C_REVISION 1 /* ACPI 5.0 */
478 #define AML_RESOURCE_I2C_TYPE_REVISION 1 /* ACPI 5.0 */
479 #define AML_RESOURCE_I2C_MIN_DATA_LEN 6
481 typedef struct aml_resource_spi_serialbus
483 AML_RESOURCE_LARGE_HEADER_COMMON
484 AML_RESOURCE_SERIAL_COMMON
485 UINT32 ConnectionSpeed;
489 UINT16 DeviceSelection;
491 * Optional fields follow immediately:
492 * 1) Vendor Data bytes
493 * 2) Resource Source String
496 } AML_RESOURCE_SPI_SERIALBUS;
498 #define AML_RESOURCE_SPI_REVISION 1 /* ACPI 5.0 */
499 #define AML_RESOURCE_SPI_TYPE_REVISION 1 /* ACPI 5.0 */
500 #define AML_RESOURCE_SPI_MIN_DATA_LEN 9
503 typedef struct aml_resource_uart_serialbus
505 AML_RESOURCE_LARGE_HEADER_COMMON
506 AML_RESOURCE_SERIAL_COMMON
507 UINT32 DefaultBaudRate;
513 * Optional fields follow immediately:
514 * 1) Vendor Data bytes
515 * 2) Resource Source String
518 } AML_RESOURCE_UART_SERIALBUS;
520 #define AML_RESOURCE_UART_REVISION 1 /* ACPI 5.0 */
521 #define AML_RESOURCE_UART_TYPE_REVISION 1 /* ACPI 5.0 */
522 #define AML_RESOURCE_UART_MIN_DATA_LEN 10
525 /* restore default alignment */
529 /* Union of all resource descriptors, so we can allocate the worst case */
531 typedef union aml_resource
533 /* Descriptor headers */
535 UINT8 DescriptorType;
536 AML_RESOURCE_SMALL_HEADER SmallHeader;
537 AML_RESOURCE_LARGE_HEADER LargeHeader;
539 /* Small resource descriptors */
541 AML_RESOURCE_IRQ Irq;
542 AML_RESOURCE_DMA Dma;
543 AML_RESOURCE_START_DEPENDENT StartDpf;
544 AML_RESOURCE_END_DEPENDENT EndDpf;
546 AML_RESOURCE_FIXED_IO FixedIo;
547 AML_RESOURCE_FIXED_DMA FixedDma;
548 AML_RESOURCE_VENDOR_SMALL VendorSmall;
549 AML_RESOURCE_END_TAG EndTag;
551 /* Large resource descriptors */
553 AML_RESOURCE_MEMORY24 Memory24;
554 AML_RESOURCE_GENERIC_REGISTER GenericReg;
555 AML_RESOURCE_VENDOR_LARGE VendorLarge;
556 AML_RESOURCE_MEMORY32 Memory32;
557 AML_RESOURCE_FIXED_MEMORY32 FixedMemory32;
558 AML_RESOURCE_ADDRESS16 Address16;
559 AML_RESOURCE_ADDRESS32 Address32;
560 AML_RESOURCE_ADDRESS64 Address64;
561 AML_RESOURCE_EXTENDED_ADDRESS64 ExtAddress64;
562 AML_RESOURCE_EXTENDED_IRQ ExtendedIrq;
563 AML_RESOURCE_GPIO Gpio;
564 AML_RESOURCE_I2C_SERIALBUS I2cSerialBus;
565 AML_RESOURCE_SPI_SERIALBUS SpiSerialBus;
566 AML_RESOURCE_UART_SERIALBUS UartSerialBus;
567 AML_RESOURCE_COMMON_SERIALBUS CommonSerialBus;
569 /* Utility overlays */
571 AML_RESOURCE_ADDRESS Address;