1 /******************************************************************************
3 * Name: acrestyp.h - Defines, types, and structures for resource descriptors
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2017, 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__
48 * Definitions for Resource Attributes
50 typedef u16 acpi_rs_length; /* Resource Length field is fixed at 16 bits */
51 typedef u32 acpi_rsdesc_size; /* Max Resource Descriptor size is (Length+3) = (64K-1)+3 */
56 #define ACPI_READ_ONLY_MEMORY (u8) 0x00
57 #define ACPI_READ_WRITE_MEMORY (u8) 0x01
59 #define ACPI_NON_CACHEABLE_MEMORY (u8) 0x00
60 #define ACPI_CACHABLE_MEMORY (u8) 0x01
61 #define ACPI_WRITE_COMBINING_MEMORY (u8) 0x02
62 #define ACPI_PREFETCHABLE_MEMORY (u8) 0x03
64 /*! [Begin] no source code translation */
67 * The ISA IO ranges are: n000-n0FFh, n400-n4FFh, n800-n8FFh, nC00-nCFFh.
68 * The non-ISA IO ranges are: n100-n3FFh, n500-n7FFh, n900-nBFFh, nCD0-nFFFh.
70 /*! [End] no source code translation !*/
72 #define ACPI_NON_ISA_ONLY_RANGES (u8) 0x01
73 #define ACPI_ISA_ONLY_RANGES (u8) 0x02
74 #define ACPI_ENTIRE_RANGE (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)
76 /* Type of translation - 1=Sparse, 0=Dense */
78 #define ACPI_SPARSE_TRANSLATION (u8) 0x01
81 * IO Port Descriptor Decode
83 #define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */
84 #define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */
87 * Interrupt attributes - used in multiple descriptors
92 #define ACPI_LEVEL_SENSITIVE (u8) 0x00
93 #define ACPI_EDGE_SENSITIVE (u8) 0x01
97 #define ACPI_ACTIVE_HIGH (u8) 0x00
98 #define ACPI_ACTIVE_LOW (u8) 0x01
99 #define ACPI_ACTIVE_BOTH (u8) 0x02
103 #define ACPI_EXCLUSIVE (u8) 0x00
104 #define ACPI_SHARED (u8) 0x01
108 #define ACPI_NOT_WAKE_CAPABLE (u8) 0x00
109 #define ACPI_WAKE_CAPABLE (u8) 0x01
114 #define ACPI_COMPATIBILITY (u8) 0x00
115 #define ACPI_TYPE_A (u8) 0x01
116 #define ACPI_TYPE_B (u8) 0x02
117 #define ACPI_TYPE_F (u8) 0x03
119 #define ACPI_NOT_BUS_MASTER (u8) 0x00
120 #define ACPI_BUS_MASTER (u8) 0x01
122 #define ACPI_TRANSFER_8 (u8) 0x00
123 #define ACPI_TRANSFER_8_16 (u8) 0x01
124 #define ACPI_TRANSFER_16 (u8) 0x02
127 * Start Dependent Functions Priority definitions
129 #define ACPI_GOOD_CONFIGURATION (u8) 0x00
130 #define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01
131 #define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02
134 * 16, 32 and 64-bit Address Descriptor resource types
136 #define ACPI_MEMORY_RANGE (u8) 0x00
137 #define ACPI_IO_RANGE (u8) 0x01
138 #define ACPI_BUS_NUMBER_RANGE (u8) 0x02
140 #define ACPI_ADDRESS_NOT_FIXED (u8) 0x00
141 #define ACPI_ADDRESS_FIXED (u8) 0x01
143 #define ACPI_POS_DECODE (u8) 0x00
144 #define ACPI_SUB_DECODE (u8) 0x01
146 /* Producer/Consumer */
148 #define ACPI_PRODUCER (u8) 0x00
149 #define ACPI_CONSUMER (u8) 0x01
152 * If possible, pack the following structures to byte alignment
154 #ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
158 /* UUID data structures for use in vendor-defined resource descriptors */
161 u8 data[ACPI_UUID_LENGTH];
164 struct acpi_vendor_uuid {
166 u8 data[ACPI_UUID_LENGTH];
170 * Structures used to describe device resources
172 struct acpi_resource_irq {
173 u8 descriptor_length;
182 struct acpi_resource_dma {
190 struct acpi_resource_start_dependent {
191 u8 descriptor_length;
192 u8 compatibility_priority;
193 u8 performance_robustness;
197 * The END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
198 * needed because it has no fields
201 struct acpi_resource_io {
209 struct acpi_resource_fixed_io {
214 struct acpi_resource_fixed_dma {
220 /* Values for Width field above */
222 #define ACPI_DMA_WIDTH8 0
223 #define ACPI_DMA_WIDTH16 1
224 #define ACPI_DMA_WIDTH32 2
225 #define ACPI_DMA_WIDTH64 3
226 #define ACPI_DMA_WIDTH128 4
227 #define ACPI_DMA_WIDTH256 5
229 struct acpi_resource_vendor {
234 /* Vendor resource with UUID info (introduced in ACPI 3.0) */
236 struct acpi_resource_vendor_typed {
239 u8 uuid[ACPI_UUID_LENGTH];
243 struct acpi_resource_end_tag {
247 struct acpi_resource_memory24 {
255 struct acpi_resource_memory32 {
263 struct acpi_resource_fixed_memory32 {
269 struct acpi_memory_attribute {
276 struct acpi_io_attribute {
283 union acpi_resource_attribute {
284 struct acpi_memory_attribute mem;
285 struct acpi_io_attribute io;
287 /* Used for the *word_space macros */
292 struct acpi_resource_source {
298 /* Fields common to all address descriptors, 16/32/64 bit */
300 #define ACPI_RESOURCE_ADDRESS_COMMON \
302 u8 producer_consumer; \
304 u8 min_address_fixed; \
305 u8 max_address_fixed; \
306 union acpi_resource_attribute info;
308 struct acpi_address16_attribute {
312 u16 translation_offset;
316 struct acpi_address32_attribute {
320 u32 translation_offset;
324 struct acpi_address64_attribute {
328 u64 translation_offset;
332 struct acpi_resource_address {
333 ACPI_RESOURCE_ADDRESS_COMMON};
335 struct acpi_resource_address16 {
336 ACPI_RESOURCE_ADDRESS_COMMON struct acpi_address16_attribute address;
337 struct acpi_resource_source resource_source;
340 struct acpi_resource_address32 {
341 ACPI_RESOURCE_ADDRESS_COMMON struct acpi_address32_attribute address;
342 struct acpi_resource_source resource_source;
345 struct acpi_resource_address64 {
346 ACPI_RESOURCE_ADDRESS_COMMON struct acpi_address64_attribute address;
347 struct acpi_resource_source resource_source;
350 struct acpi_resource_extended_address64 {
351 ACPI_RESOURCE_ADDRESS_COMMON u8 revision_ID;
352 struct acpi_address64_attribute address;
356 struct acpi_resource_extended_irq {
357 u8 producer_consumer;
363 struct acpi_resource_source resource_source;
367 struct acpi_resource_generic_register {
375 struct acpi_resource_gpio {
378 u8 producer_consumer; /* For values, see Producer/Consumer above */
380 u8 sharable; /* For values, see Interrupt Attributes above */
381 u8 wake_capable; /* For values, see Interrupt Attributes above */
383 u8 triggering; /* For values, see Interrupt Attributes above */
384 u8 polarity; /* For values, see Interrupt Attributes above */
386 u16 debounce_timeout;
387 u16 pin_table_length;
389 struct acpi_resource_source resource_source;
394 /* Values for GPIO connection_type field above */
396 #define ACPI_RESOURCE_GPIO_TYPE_INT 0
397 #define ACPI_RESOURCE_GPIO_TYPE_IO 1
399 /* Values for pin_config field above */
401 #define ACPI_PIN_CONFIG_DEFAULT 0
402 #define ACPI_PIN_CONFIG_PULLUP 1
403 #define ACPI_PIN_CONFIG_PULLDOWN 2
404 #define ACPI_PIN_CONFIG_NOPULL 3
406 /* Values for io_restriction field above */
408 #define ACPI_IO_RESTRICT_NONE 0
409 #define ACPI_IO_RESTRICT_INPUT 1
410 #define ACPI_IO_RESTRICT_OUTPUT 2
411 #define ACPI_IO_RESTRICT_NONE_PRESERVE 3
413 /* Common structure for I2C, SPI, and UART serial descriptors */
415 #define ACPI_RESOURCE_SERIAL_COMMON \
418 u8 producer_consumer; /* For values, see Producer/Consumer above */\
420 u8 connection_sharing; \
421 u8 type_revision_id; \
422 u16 type_data_length; \
424 struct acpi_resource_source resource_source; \
427 struct acpi_resource_common_serialbus {
428 ACPI_RESOURCE_SERIAL_COMMON};
430 /* Values for the Type field above */
432 #define ACPI_RESOURCE_SERIAL_TYPE_I2C 1
433 #define ACPI_RESOURCE_SERIAL_TYPE_SPI 2
434 #define ACPI_RESOURCE_SERIAL_TYPE_UART 3
436 /* Values for slave_mode field above */
438 #define ACPI_CONTROLLER_INITIATED 0
439 #define ACPI_DEVICE_INITIATED 1
441 struct acpi_resource_i2c_serialbus {
442 ACPI_RESOURCE_SERIAL_COMMON u8 access_mode;
444 u32 connection_speed;
447 /* Values for access_mode field above */
449 #define ACPI_I2C_7BIT_MODE 0
450 #define ACPI_I2C_10BIT_MODE 1
452 struct acpi_resource_spi_serialbus {
453 ACPI_RESOURCE_SERIAL_COMMON u8 wire_mode;
458 u16 device_selection;
459 u32 connection_speed;
462 /* Values for wire_mode field above */
464 #define ACPI_SPI_4WIRE_MODE 0
465 #define ACPI_SPI_3WIRE_MODE 1
467 /* Values for device_polarity field above */
469 #define ACPI_SPI_ACTIVE_LOW 0
470 #define ACPI_SPI_ACTIVE_HIGH 1
472 /* Values for clock_phase field above */
474 #define ACPI_SPI_FIRST_PHASE 0
475 #define ACPI_SPI_SECOND_PHASE 1
477 /* Values for clock_polarity field above */
479 #define ACPI_SPI_START_LOW 0
480 #define ACPI_SPI_START_HIGH 1
482 struct acpi_resource_uart_serialbus {
483 ACPI_RESOURCE_SERIAL_COMMON u8 endian;
491 u32 default_baud_rate;
494 /* Values for Endian field above */
496 #define ACPI_UART_LITTLE_ENDIAN 0
497 #define ACPI_UART_BIG_ENDIAN 1
499 /* Values for data_bits field above */
501 #define ACPI_UART_5_DATA_BITS 0
502 #define ACPI_UART_6_DATA_BITS 1
503 #define ACPI_UART_7_DATA_BITS 2
504 #define ACPI_UART_8_DATA_BITS 3
505 #define ACPI_UART_9_DATA_BITS 4
507 /* Values for stop_bits field above */
509 #define ACPI_UART_NO_STOP_BITS 0
510 #define ACPI_UART_1_STOP_BIT 1
511 #define ACPI_UART_1P5_STOP_BITS 2
512 #define ACPI_UART_2_STOP_BITS 3
514 /* Values for flow_control field above */
516 #define ACPI_UART_FLOW_CONTROL_NONE 0
517 #define ACPI_UART_FLOW_CONTROL_HW 1
518 #define ACPI_UART_FLOW_CONTROL_XON_XOFF 2
520 /* Values for Parity field above */
522 #define ACPI_UART_PARITY_NONE 0
523 #define ACPI_UART_PARITY_EVEN 1
524 #define ACPI_UART_PARITY_ODD 2
525 #define ACPI_UART_PARITY_MARK 3
526 #define ACPI_UART_PARITY_SPACE 4
528 /* Values for lines_enabled bitfield above */
530 #define ACPI_UART_CARRIER_DETECT (1<<2)
531 #define ACPI_UART_RING_INDICATOR (1<<3)
532 #define ACPI_UART_DATA_SET_READY (1<<4)
533 #define ACPI_UART_DATA_TERMINAL_READY (1<<5)
534 #define ACPI_UART_CLEAR_TO_SEND (1<<6)
535 #define ACPI_UART_REQUEST_TO_SEND (1<<7)
537 struct acpi_resource_pin_function {
540 u8 sharable; /* For values, see Interrupt Attributes above */
542 u16 pin_table_length;
544 struct acpi_resource_source resource_source;
549 /* ACPI_RESOURCE_TYPEs */
551 #define ACPI_RESOURCE_TYPE_IRQ 0
552 #define ACPI_RESOURCE_TYPE_DMA 1
553 #define ACPI_RESOURCE_TYPE_START_DEPENDENT 2
554 #define ACPI_RESOURCE_TYPE_END_DEPENDENT 3
555 #define ACPI_RESOURCE_TYPE_IO 4
556 #define ACPI_RESOURCE_TYPE_FIXED_IO 5
557 #define ACPI_RESOURCE_TYPE_VENDOR 6
558 #define ACPI_RESOURCE_TYPE_END_TAG 7
559 #define ACPI_RESOURCE_TYPE_MEMORY24 8
560 #define ACPI_RESOURCE_TYPE_MEMORY32 9
561 #define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10
562 #define ACPI_RESOURCE_TYPE_ADDRESS16 11
563 #define ACPI_RESOURCE_TYPE_ADDRESS32 12
564 #define ACPI_RESOURCE_TYPE_ADDRESS64 13
565 #define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */
566 #define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15
567 #define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16
568 #define ACPI_RESOURCE_TYPE_GPIO 17 /* ACPI 5.0 */
569 #define ACPI_RESOURCE_TYPE_FIXED_DMA 18 /* ACPI 5.0 */
570 #define ACPI_RESOURCE_TYPE_SERIAL_BUS 19 /* ACPI 5.0 */
571 #define ACPI_RESOURCE_TYPE_PIN_FUNCTION 20 /* ACPI 6.2 */
572 #define ACPI_RESOURCE_TYPE_MAX 20
574 /* Master union for resource descriptors */
576 union acpi_resource_data {
577 struct acpi_resource_irq irq;
578 struct acpi_resource_dma dma;
579 struct acpi_resource_start_dependent start_dpf;
580 struct acpi_resource_io io;
581 struct acpi_resource_fixed_io fixed_io;
582 struct acpi_resource_fixed_dma fixed_dma;
583 struct acpi_resource_vendor vendor;
584 struct acpi_resource_vendor_typed vendor_typed;
585 struct acpi_resource_end_tag end_tag;
586 struct acpi_resource_memory24 memory24;
587 struct acpi_resource_memory32 memory32;
588 struct acpi_resource_fixed_memory32 fixed_memory32;
589 struct acpi_resource_address16 address16;
590 struct acpi_resource_address32 address32;
591 struct acpi_resource_address64 address64;
592 struct acpi_resource_extended_address64 ext_address64;
593 struct acpi_resource_extended_irq extended_irq;
594 struct acpi_resource_generic_register generic_reg;
595 struct acpi_resource_gpio gpio;
596 struct acpi_resource_i2c_serialbus i2c_serial_bus;
597 struct acpi_resource_spi_serialbus spi_serial_bus;
598 struct acpi_resource_uart_serialbus uart_serial_bus;
599 struct acpi_resource_common_serialbus common_serial_bus;
600 struct acpi_resource_pin_function pin_function;
604 struct acpi_resource_address address; /* Common 16/32/64 address fields */
607 /* Common resource header */
609 struct acpi_resource {
612 union acpi_resource_data data;
615 /* restore default alignment */
619 #define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */
620 #define ACPI_RS_SIZE_MIN (u32) ACPI_ROUND_UP_TO_NATIVE_WORD (12)
621 #define ACPI_RS_SIZE(type) (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))
623 /* Macro for walking resource templates with multiple descriptors */
625 #define ACPI_NEXT_RESOURCE(res) \
626 ACPI_ADD_PTR (struct acpi_resource, (res), (res)->length)
628 struct acpi_pci_routing_table {
631 u64 address; /* here for 64-bit alignment */
633 char source[4]; /* pad to 64 bits so sizeof() works in all cases */
636 #endif /* __ACRESTYP_H__ */