1 /******************************************************************************
3 * Name: acrestyp.h - Defines, types, and structures for resource descriptors
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2011, 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 #ifndef __ACRESTYP_H__
45 #define __ACRESTYP_H__
49 * Definitions for Resource Attributes
51 typedef UINT16 ACPI_RS_LENGTH; /* Resource Length field is fixed at 16 bits */
52 typedef UINT32 ACPI_RSDESC_SIZE; /* Max Resource Descriptor size is (Length+3) = (64K-1)+3 */
57 #define ACPI_READ_ONLY_MEMORY (UINT8) 0x00
58 #define ACPI_READ_WRITE_MEMORY (UINT8) 0x01
60 #define ACPI_NON_CACHEABLE_MEMORY (UINT8) 0x00
61 #define ACPI_CACHABLE_MEMORY (UINT8) 0x01
62 #define ACPI_WRITE_COMBINING_MEMORY (UINT8) 0x02
63 #define ACPI_PREFETCHABLE_MEMORY (UINT8) 0x03
65 /*! [Begin] no source code translation */
68 * The ISA IO ranges are: n000-n0FFh, n400-n4FFh, n800-n8FFh, nC00-nCFFh.
69 * The non-ISA IO ranges are: n100-n3FFh, n500-n7FFh, n900-nBFFh, nCD0-nFFFh.
71 /*! [End] no source code translation !*/
73 #define ACPI_NON_ISA_ONLY_RANGES (UINT8) 0x01
74 #define ACPI_ISA_ONLY_RANGES (UINT8) 0x02
75 #define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
77 /* Type of translation - 1=Sparse, 0=Dense */
79 #define ACPI_SPARSE_TRANSLATION (UINT8) 0x01
82 * IO Port Descriptor Decode
84 #define ACPI_DECODE_10 (UINT8) 0x00 /* 10-bit IO address decode */
85 #define ACPI_DECODE_16 (UINT8) 0x01 /* 16-bit IO address decode */
88 * Interrupt attributes - used in multiple descriptors
93 #define ACPI_LEVEL_SENSITIVE (UINT8) 0x00
94 #define ACPI_EDGE_SENSITIVE (UINT8) 0x01
98 #define ACPI_ACTIVE_HIGH (UINT8) 0x00
99 #define ACPI_ACTIVE_LOW (UINT8) 0x01
100 #define ACPI_ACTIVE_BOTH (UINT8) 0x02
104 #define ACPI_EXCLUSIVE (UINT8) 0x00
105 #define ACPI_SHARED (UINT8) 0x01
106 #define ACPI_EXCLUSIVE_AND_WAKE (UINT8) 0x02
107 #define ACPI_SHARED_AND_WAKE (UINT8) 0x03
112 #define ACPI_COMPATIBILITY (UINT8) 0x00
113 #define ACPI_TYPE_A (UINT8) 0x01
114 #define ACPI_TYPE_B (UINT8) 0x02
115 #define ACPI_TYPE_F (UINT8) 0x03
117 #define ACPI_NOT_BUS_MASTER (UINT8) 0x00
118 #define ACPI_BUS_MASTER (UINT8) 0x01
120 #define ACPI_TRANSFER_8 (UINT8) 0x00
121 #define ACPI_TRANSFER_8_16 (UINT8) 0x01
122 #define ACPI_TRANSFER_16 (UINT8) 0x02
125 * Start Dependent Functions Priority definitions
127 #define ACPI_GOOD_CONFIGURATION (UINT8) 0x00
128 #define ACPI_ACCEPTABLE_CONFIGURATION (UINT8) 0x01
129 #define ACPI_SUB_OPTIMAL_CONFIGURATION (UINT8) 0x02
132 * 16, 32 and 64-bit Address Descriptor resource types
134 #define ACPI_MEMORY_RANGE (UINT8) 0x00
135 #define ACPI_IO_RANGE (UINT8) 0x01
136 #define ACPI_BUS_NUMBER_RANGE (UINT8) 0x02
138 #define ACPI_ADDRESS_NOT_FIXED (UINT8) 0x00
139 #define ACPI_ADDRESS_FIXED (UINT8) 0x01
141 #define ACPI_POS_DECODE (UINT8) 0x00
142 #define ACPI_SUB_DECODE (UINT8) 0x01
144 /* Producer/Consumer */
146 #define ACPI_PRODUCER (UINT8) 0x00
147 #define ACPI_CONSUMER (UINT8) 0x01
151 * If possible, pack the following structures to byte alignment
153 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
157 /* UUID data structures for use in vendor-defined resource descriptors */
159 typedef struct acpi_uuid
161 UINT8 Data[ACPI_UUID_LENGTH];
164 typedef struct acpi_vendor_uuid
167 UINT8 Data[ACPI_UUID_LENGTH];
172 * Structures used to describe device resources
174 typedef struct acpi_resource_irq
176 UINT8 DescriptorLength;
180 UINT8 InterruptCount;
185 typedef struct acpi_resource_dma
195 typedef struct acpi_resource_start_dependent
197 UINT8 DescriptorLength;
198 UINT8 CompatibilityPriority;
199 UINT8 PerformanceRobustness;
201 } ACPI_RESOURCE_START_DEPENDENT;
205 * The END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
206 * needed because it has no fields
210 typedef struct acpi_resource_io
220 typedef struct acpi_resource_fixed_io
225 } ACPI_RESOURCE_FIXED_IO;
227 typedef struct acpi_resource_fixed_dma
233 } ACPI_RESOURCE_FIXED_DMA;
235 /* Values for Width field above */
237 #define ACPI_DMA_WIDTH8 0
238 #define ACPI_DMA_WIDTH16 1
239 #define ACPI_DMA_WIDTH32 2
240 #define ACPI_DMA_WIDTH64 3
241 #define ACPI_DMA_WIDTH128 4
242 #define ACPI_DMA_WIDTH256 5
245 typedef struct acpi_resource_vendor
250 } ACPI_RESOURCE_VENDOR;
252 /* Vendor resource with UUID info (introduced in ACPI 3.0) */
254 typedef struct acpi_resource_vendor_typed
258 UINT8 Uuid[ACPI_UUID_LENGTH];
261 } ACPI_RESOURCE_VENDOR_TYPED;
263 typedef struct acpi_resource_end_tag
267 } ACPI_RESOURCE_END_TAG;
269 typedef struct acpi_resource_memory24
275 UINT16 AddressLength;
277 } ACPI_RESOURCE_MEMORY24;
279 typedef struct acpi_resource_memory32
285 UINT32 AddressLength;
287 } ACPI_RESOURCE_MEMORY32;
289 typedef struct acpi_resource_fixed_memory32
293 UINT32 AddressLength;
295 } ACPI_RESOURCE_FIXED_MEMORY32;
297 typedef struct acpi_memory_attribute
304 } ACPI_MEMORY_ATTRIBUTE;
306 typedef struct acpi_io_attribute
310 UINT8 TranslationType;
315 typedef union acpi_resource_attribute
317 ACPI_MEMORY_ATTRIBUTE Mem;
318 ACPI_IO_ATTRIBUTE Io;
320 /* Used for the *WordSpace macros */
324 } ACPI_RESOURCE_ATTRIBUTE;
326 typedef struct acpi_resource_source
332 } ACPI_RESOURCE_SOURCE;
334 /* Fields common to all address descriptors, 16/32/64 bit */
336 #define ACPI_RESOURCE_ADDRESS_COMMON \
337 UINT8 ResourceType; \
338 UINT8 ProducerConsumer; \
340 UINT8 MinAddressFixed; \
341 UINT8 MaxAddressFixed; \
342 ACPI_RESOURCE_ATTRIBUTE Info;
344 typedef struct acpi_resource_address
346 ACPI_RESOURCE_ADDRESS_COMMON
348 } ACPI_RESOURCE_ADDRESS;
350 typedef struct acpi_resource_address16
352 ACPI_RESOURCE_ADDRESS_COMMON
356 UINT16 TranslationOffset;
357 UINT16 AddressLength;
358 ACPI_RESOURCE_SOURCE ResourceSource;
360 } ACPI_RESOURCE_ADDRESS16;
362 typedef struct acpi_resource_address32
364 ACPI_RESOURCE_ADDRESS_COMMON
368 UINT32 TranslationOffset;
369 UINT32 AddressLength;
370 ACPI_RESOURCE_SOURCE ResourceSource;
372 } ACPI_RESOURCE_ADDRESS32;
374 typedef struct acpi_resource_address64
376 ACPI_RESOURCE_ADDRESS_COMMON
380 UINT64 TranslationOffset;
381 UINT64 AddressLength;
382 ACPI_RESOURCE_SOURCE ResourceSource;
384 } ACPI_RESOURCE_ADDRESS64;
386 typedef struct acpi_resource_extended_address64
388 ACPI_RESOURCE_ADDRESS_COMMON
393 UINT64 TranslationOffset;
394 UINT64 AddressLength;
397 } ACPI_RESOURCE_EXTENDED_ADDRESS64;
399 typedef struct acpi_resource_extended_irq
401 UINT8 ProducerConsumer;
405 UINT8 InterruptCount;
406 ACPI_RESOURCE_SOURCE ResourceSource;
407 UINT32 Interrupts[1];
409 } ACPI_RESOURCE_EXTENDED_IRQ;
411 typedef struct acpi_resource_generic_register
419 } ACPI_RESOURCE_GENERIC_REGISTER;
421 typedef struct acpi_resource_gpio
424 UINT8 ConnectionType;
425 UINT8 ProducerConsumer; /* For values, see Producer/Consumer above */
427 UINT8 Sharable; /* For values, see Interrupt Attributes above */
429 UINT8 Triggering; /* For values, see Interrupt Attributes above */
430 UINT8 Polarity; /* For values, see Interrupt Attributes above */
431 UINT16 DriveStrength;
432 UINT16 DebounceTimeout;
433 UINT16 PinTableLength;
435 ACPI_RESOURCE_SOURCE ResourceSource;
439 } ACPI_RESOURCE_GPIO;
441 /* Values for GPIO ConnectionType field above */
443 #define ACPI_RESOURCE_GPIO_TYPE_INT 0
444 #define ACPI_RESOURCE_GPIO_TYPE_IO 1
446 /* Values for PinConfig field above */
448 #define ACPI_PIN_CONFIG_DEFAULT 0
449 #define ACPI_PIN_CONFIG_PULLUP 1
450 #define ACPI_PIN_CONFIG_PULLDOWN 2
451 #define ACPI_PIN_CONFIG_NOPULL 3
453 /* Values for IoRestriction field above */
455 #define ACPI_IO_RESTRICT_NONE 0
456 #define ACPI_IO_RESTRICT_INPUT 1
457 #define ACPI_IO_RESTRICT_OUTPUT 2
458 #define ACPI_IO_RESTRICT_NONE_PRESERVE 3
461 /* Common structure for I2C, SPI, and UART serial descriptors */
463 #define ACPI_RESOURCE_SERIAL_COMMON \
466 UINT8 ProducerConsumer; /* For values, see Producer/Consumer above */\
468 UINT8 TypeRevisionId; \
469 UINT16 TypeDataLength; \
470 UINT16 VendorLength; \
471 ACPI_RESOURCE_SOURCE ResourceSource; \
474 typedef struct acpi_resource_common_serialbus
476 ACPI_RESOURCE_SERIAL_COMMON
478 } ACPI_RESOURCE_COMMON_SERIALBUS;
480 /* Values for the Type field above */
482 #define ACPI_RESOURCE_SERIAL_TYPE_I2C 1
483 #define ACPI_RESOURCE_SERIAL_TYPE_SPI 2
484 #define ACPI_RESOURCE_SERIAL_TYPE_UART 3
486 /* Values for SlaveMode field above */
488 #define ACPI_CONTROLLER_INITIATED 0
489 #define ACPI_DEVICE_INITIATED 1
492 typedef struct acpi_resource_i2c_serialbus
494 ACPI_RESOURCE_SERIAL_COMMON
497 UINT32 ConnectionSpeed;
499 } ACPI_RESOURCE_I2C_SERIALBUS;
501 /* Values for AccessMode field above */
503 #define ACPI_I2C_7BIT_MODE 0
504 #define ACPI_I2C_10BIT_MODE 1
507 typedef struct acpi_resource_spi_serialbus
509 ACPI_RESOURCE_SERIAL_COMMON
511 UINT8 DevicePolarity;
515 UINT16 DeviceSelection;
516 UINT32 ConnectionSpeed;
518 } ACPI_RESOURCE_SPI_SERIALBUS;
520 /* Values for WireMode field above */
522 #define ACPI_SPI_4WIRE_MODE 0
523 #define ACPI_SPI_3WIRE_MODE 1
525 /* Values for DevicePolarity field above */
527 #define ACPI_SPI_ACTIVE_LOW 0
528 #define ACPI_SPI_ACTIVE_HIGH 1
530 /* Values for ClockPhase field above */
532 #define ACPI_SPI_FIRST_PHASE 0
533 #define ACPI_SPI_SECOND_PHASE 1
535 /* Values for ClockPolarity field above */
537 #define ACPI_SPI_START_LOW 0
538 #define ACPI_SPI_START_HIGH 1
541 typedef struct acpi_resource_uart_serialbus
543 ACPI_RESOURCE_SERIAL_COMMON
552 UINT32 DefaultBaudRate;
554 } ACPI_RESOURCE_UART_SERIALBUS;
556 /* Values for Endian field above */
558 #define ACPI_UART_LITTLE_ENDIAN 0
559 #define ACPI_UART_BIG_ENDIAN 1
561 /* Values for DataBits field above */
563 #define ACPI_UART_5_DATA_BITS 0
564 #define ACPI_UART_6_DATA_BITS 1
565 #define ACPI_UART_7_DATA_BITS 2
566 #define ACPI_UART_8_DATA_BITS 3
567 #define ACPI_UART_9_DATA_BITS 4
569 /* Values for StopBits field above */
571 #define ACPI_UART_NO_STOP_BITS 0
572 #define ACPI_UART_1_STOP_BIT 1
573 #define ACPI_UART_1P5_STOP_BITS 2
574 #define ACPI_UART_2_STOP_BITS 3
576 /* Values for FlowControl field above */
578 #define ACPI_UART_FLOW_CONTROL_NONE 0
579 #define ACPI_UART_FLOW_CONTROL_HW 1
580 #define ACPI_UART_FLOW_CONTROL_XON_XOFF 2
582 /* Values for Parity field above */
584 #define ACPI_UART_PARITY_NONE 0
585 #define ACPI_UART_PARITY_EVEN 1
586 #define ACPI_UART_PARITY_ODD 2
587 #define ACPI_UART_PARITY_MARK 3
588 #define ACPI_UART_PARITY_SPACE 4
590 /* Values for LinesEnabled bitfield above */
592 #define ACPI_UART_CARRIER_DETECT (1<<2)
593 #define ACPI_UART_RING_INDICATOR (1<<3)
594 #define ACPI_UART_DATA_SET_READY (1<<4)
595 #define ACPI_UART_DATA_TERMINAL_READY (1<<5)
596 #define ACPI_UART_CLEAR_TO_SEND (1<<6)
597 #define ACPI_UART_REQUEST_TO_SEND (1<<7)
600 /* ACPI_RESOURCE_TYPEs */
602 #define ACPI_RESOURCE_TYPE_IRQ 0
603 #define ACPI_RESOURCE_TYPE_DMA 1
604 #define ACPI_RESOURCE_TYPE_START_DEPENDENT 2
605 #define ACPI_RESOURCE_TYPE_END_DEPENDENT 3
606 #define ACPI_RESOURCE_TYPE_IO 4
607 #define ACPI_RESOURCE_TYPE_FIXED_IO 5
608 #define ACPI_RESOURCE_TYPE_VENDOR 6
609 #define ACPI_RESOURCE_TYPE_END_TAG 7
610 #define ACPI_RESOURCE_TYPE_MEMORY24 8
611 #define ACPI_RESOURCE_TYPE_MEMORY32 9
612 #define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10
613 #define ACPI_RESOURCE_TYPE_ADDRESS16 11
614 #define ACPI_RESOURCE_TYPE_ADDRESS32 12
615 #define ACPI_RESOURCE_TYPE_ADDRESS64 13
616 #define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */
617 #define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15
618 #define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16
619 #define ACPI_RESOURCE_TYPE_GPIO 17 /* ACPI 5.0 */
620 #define ACPI_RESOURCE_TYPE_FIXED_DMA 18 /* ACPI 5.0 */
621 #define ACPI_RESOURCE_TYPE_SERIAL_BUS 19 /* ACPI 5.0 */
622 #define ACPI_RESOURCE_TYPE_MAX 19
624 /* Master union for resource descriptors */
626 typedef union acpi_resource_data
628 ACPI_RESOURCE_IRQ Irq;
629 ACPI_RESOURCE_DMA Dma;
630 ACPI_RESOURCE_START_DEPENDENT StartDpf;
632 ACPI_RESOURCE_FIXED_IO FixedIo;
633 ACPI_RESOURCE_FIXED_DMA FixedDma;
634 ACPI_RESOURCE_VENDOR Vendor;
635 ACPI_RESOURCE_VENDOR_TYPED VendorTyped;
636 ACPI_RESOURCE_END_TAG EndTag;
637 ACPI_RESOURCE_MEMORY24 Memory24;
638 ACPI_RESOURCE_MEMORY32 Memory32;
639 ACPI_RESOURCE_FIXED_MEMORY32 FixedMemory32;
640 ACPI_RESOURCE_ADDRESS16 Address16;
641 ACPI_RESOURCE_ADDRESS32 Address32;
642 ACPI_RESOURCE_ADDRESS64 Address64;
643 ACPI_RESOURCE_EXTENDED_ADDRESS64 ExtAddress64;
644 ACPI_RESOURCE_EXTENDED_IRQ ExtendedIrq;
645 ACPI_RESOURCE_GENERIC_REGISTER GenericReg;
646 ACPI_RESOURCE_GPIO Gpio;
647 ACPI_RESOURCE_I2C_SERIALBUS I2cSerialBus;
648 ACPI_RESOURCE_SPI_SERIALBUS SpiSerialBus;
649 ACPI_RESOURCE_UART_SERIALBUS UartSerialBus;
650 ACPI_RESOURCE_COMMON_SERIALBUS CommonSerialBus;
654 ACPI_RESOURCE_ADDRESS Address; /* Common 16/32/64 address fields */
656 } ACPI_RESOURCE_DATA;
659 /* Common resource header */
661 typedef struct acpi_resource
665 ACPI_RESOURCE_DATA Data;
669 /* restore default alignment */
674 #define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */
675 #define ACPI_RS_SIZE_MIN (UINT32) ACPI_ROUND_UP_TO_NATIVE_WORD (12)
676 #define ACPI_RS_SIZE(Type) (UINT32) (ACPI_RS_SIZE_NO_DATA + sizeof (Type))
678 #define ACPI_NEXT_RESOURCE(Res) (ACPI_RESOURCE *)((UINT8 *) Res + Res->Length)
681 typedef struct acpi_pci_routing_table
685 UINT64 Address; /* here for 64-bit alignment */
687 char Source[4]; /* pad to 64 bits so sizeof() works in all cases */
689 } ACPI_PCI_ROUTING_TABLE;
691 #endif /* __ACRESTYP_H__ */