[GitHub/mt8127/android_kernel_alcatel_ttab.git] / include / acpi / acrestyp.h

/******************************************************************************
 *
 * Name: acrestyp.h - Defines, types, and structures for resource descriptors
 *
 *****************************************************************************/

/*
 * Copyright (C) 2000 - 2013, Intel Corp.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions, and the following disclaimer,
 *    without modification.
 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
 *    substantially similar to the "NO WARRANTY" disclaimer below
 *    ("Disclaimer") and any redistribution must be conditioned upon
 *    including a substantially similar Disclaimer requirement for further
 *    binary redistribution.
 * 3. Neither the names of the above-listed copyright holders nor the names
 *    of any contributors may be used to endorse or promote products derived
 *    from this software without specific prior written permission.
 *
 * Alternatively, this software may be distributed under the terms of the
 * GNU General Public License ("GPL") version 2 as published by the Free
 * Software Foundation.
 *
 * NO WARRANTY
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 * POSSIBILITY OF SUCH DAMAGES.
 */

#ifndef __ACRESTYP_H__
#define __ACRESTYP_H__

/*
 * Definitions for Resource Attributes
 */
typedef u16 acpi_rs_length;	/* Resource Length field is fixed at 16 bits */
typedef u32 acpi_rsdesc_size;	/* Max Resource Descriptor size is (Length+3) = (64K-1)+3 */

/*
 * Memory Attributes
 */
#define ACPI_READ_ONLY_MEMORY           (u8) 0x00
#define ACPI_READ_WRITE_MEMORY          (u8) 0x01

#define ACPI_NON_CACHEABLE_MEMORY       (u8) 0x00
#define ACPI_CACHABLE_MEMORY            (u8) 0x01
#define ACPI_WRITE_COMBINING_MEMORY     (u8) 0x02
#define ACPI_PREFETCHABLE_MEMORY        (u8) 0x03

/*! [Begin] no source code translation */
/*
 * IO Attributes
 * The ISA IO ranges are:     n000-n0FFh,  n400-n4FFh, n800-n8FFh, nC00-nCFFh.
 * The non-ISA IO ranges are: n100-n3FFh,  n500-n7FFh, n900-nBFFh, nCD0-nFFFh.
 */
/*! [End] no source code translation !*/

#define ACPI_NON_ISA_ONLY_RANGES        (u8) 0x01
#define ACPI_ISA_ONLY_RANGES            (u8) 0x02
#define ACPI_ENTIRE_RANGE               (ACPI_NON_ISA_ONLY_RANGES | ACPI_ISA_ONLY_RANGES)

/* Type of translation - 1=Sparse, 0=Dense */

#define ACPI_SPARSE_TRANSLATION         (u8) 0x01

/*
 * IO Port Descriptor Decode
 */
#define ACPI_DECODE_10                  (u8) 0x00	/* 10-bit IO address decode */
#define ACPI_DECODE_16                  (u8) 0x01	/* 16-bit IO address decode */

/*
 * Interrupt attributes - used in multiple descriptors
 */

/* Triggering */

#define ACPI_LEVEL_SENSITIVE            (u8) 0x00
#define ACPI_EDGE_SENSITIVE             (u8) 0x01

/* Polarity */

#define ACPI_ACTIVE_HIGH                (u8) 0x00
#define ACPI_ACTIVE_LOW                 (u8) 0x01
#define ACPI_ACTIVE_BOTH                (u8) 0x02

/* Sharing */

#define ACPI_EXCLUSIVE                  (u8) 0x00
#define ACPI_SHARED                     (u8) 0x01

/* Wake */

#define ACPI_NOT_WAKE_CAPABLE           (u8) 0x00
#define ACPI_WAKE_CAPABLE               (u8) 0x01

/*
 * DMA Attributes
 */
#define ACPI_COMPATIBILITY              (u8) 0x00
#define ACPI_TYPE_A                     (u8) 0x01
#define ACPI_TYPE_B                     (u8) 0x02
#define ACPI_TYPE_F                     (u8) 0x03

#define ACPI_NOT_BUS_MASTER             (u8) 0x00
#define ACPI_BUS_MASTER                 (u8) 0x01

#define ACPI_TRANSFER_8                 (u8) 0x00
#define ACPI_TRANSFER_8_16              (u8) 0x01
#define ACPI_TRANSFER_16                (u8) 0x02

/*
 * Start Dependent Functions Priority definitions
 */
#define ACPI_GOOD_CONFIGURATION         (u8) 0x00
#define ACPI_ACCEPTABLE_CONFIGURATION   (u8) 0x01
#define ACPI_SUB_OPTIMAL_CONFIGURATION  (u8) 0x02

/*
 * 16, 32 and 64-bit Address Descriptor resource types
 */
#define ACPI_MEMORY_RANGE               (u8) 0x00
#define ACPI_IO_RANGE                   (u8) 0x01
#define ACPI_BUS_NUMBER_RANGE           (u8) 0x02

#define ACPI_ADDRESS_NOT_FIXED          (u8) 0x00
#define ACPI_ADDRESS_FIXED              (u8) 0x01

#define ACPI_POS_DECODE                 (u8) 0x00
#define ACPI_SUB_DECODE                 (u8) 0x01

/* Producer/Consumer */

#define ACPI_PRODUCER                   (u8) 0x00
#define ACPI_CONSUMER                   (u8) 0x01

/*
 * If possible, pack the following structures to byte alignment
 */
#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
#pragma pack(1)
#endif

/* UUID data structures for use in vendor-defined resource descriptors */

struct acpi_uuid {
	u8 data[ACPI_UUID_LENGTH];
};

struct acpi_vendor_uuid {
	u8 subtype;
	u8 data[ACPI_UUID_LENGTH];
};

/*
 * Structures used to describe device resources
 */
struct acpi_resource_irq {
	u8 descriptor_length;
	u8 triggering;
	u8 polarity;
	u8 sharable;
	u8 wake_capable;
	u8 interrupt_count;
	u8 interrupts[1];
};

struct acpi_resource_dma {
	u8 type;
	u8 bus_master;
	u8 transfer;
	u8 channel_count;
	u8 channels[1];
};

struct acpi_resource_start_dependent {
	u8 descriptor_length;
	u8 compatibility_priority;
	u8 performance_robustness;
};

/*
 * The END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
 * needed because it has no fields
 */

struct acpi_resource_io {
	u8 io_decode;
	u8 alignment;
	u8 address_length;
	u16 minimum;
	u16 maximum;
};

struct acpi_resource_fixed_io {
	u16 address;
	u8 address_length;
};

struct acpi_resource_fixed_dma {
	u16 request_lines;
	u16 channels;
	u8 width;
};

/* Values for Width field above */

#define ACPI_DMA_WIDTH8                         0
#define ACPI_DMA_WIDTH16                        1
#define ACPI_DMA_WIDTH32                        2
#define ACPI_DMA_WIDTH64                        3
#define ACPI_DMA_WIDTH128                       4
#define ACPI_DMA_WIDTH256                       5

struct acpi_resource_vendor {
	u16 byte_length;
	u8 byte_data[1];
};

/* Vendor resource with UUID info (introduced in ACPI 3.0) */

struct acpi_resource_vendor_typed {
	u16 byte_length;
	u8 uuid_subtype;
	u8 uuid[ACPI_UUID_LENGTH];
	u8 byte_data[1];
};

struct acpi_resource_end_tag {
	u8 checksum;
};

struct acpi_resource_memory24 {
	u8 write_protect;
	u16 minimum;
	u16 maximum;
	u16 alignment;
	u16 address_length;
};

struct acpi_resource_memory32 {
	u8 write_protect;
	u32 minimum;
	u32 maximum;
	u32 alignment;
	u32 address_length;
};

struct acpi_resource_fixed_memory32 {
	u8 write_protect;
	u32 address;
	u32 address_length;
};

struct acpi_memory_attribute {
	u8 write_protect;
	u8 caching;
	u8 range_type;
	u8 translation;
};

struct acpi_io_attribute {
	u8 range_type;
	u8 translation;
	u8 translation_type;
	u8 reserved1;
};

union acpi_resource_attribute {
	struct acpi_memory_attribute mem;
	struct acpi_io_attribute io;

	/* Used for the *word_space macros */

	u8 type_specific;
};

struct acpi_resource_source {
	u8 index;
	u16 string_length;
	char *string_ptr;
};

/* Fields common to all address descriptors, 16/32/64 bit */

#define ACPI_RESOURCE_ADDRESS_COMMON \
	u8                                      resource_type; \
	u8                                      producer_consumer; \
	u8                                      decode; \
	u8                                      min_address_fixed; \
	u8                                      max_address_fixed; \
	union acpi_resource_attribute           info;

struct acpi_resource_address {
ACPI_RESOURCE_ADDRESS_COMMON};

struct acpi_resource_address16 {
	ACPI_RESOURCE_ADDRESS_COMMON u16 granularity;
	u16 minimum;
	u16 maximum;
	u16 translation_offset;
	u16 address_length;
	struct acpi_resource_source resource_source;
};

struct acpi_resource_address32 {
	ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
	u32 minimum;
	u32 maximum;
	u32 translation_offset;
	u32 address_length;
	struct acpi_resource_source resource_source;
};

struct acpi_resource_address64 {
	ACPI_RESOURCE_ADDRESS_COMMON u64 granularity;
	u64 minimum;
	u64 maximum;
	u64 translation_offset;
	u64 address_length;
	struct acpi_resource_source resource_source;
};

struct acpi_resource_extended_address64 {
	ACPI_RESOURCE_ADDRESS_COMMON u8 revision_ID;
	u64 granularity;
	u64 minimum;
	u64 maximum;
	u64 translation_offset;
	u64 address_length;
	u64 type_specific;
};

struct acpi_resource_extended_irq {
	u8 producer_consumer;
	u8 triggering;
	u8 polarity;
	u8 sharable;
	u8 wake_capable;
	u8 interrupt_count;
	struct acpi_resource_source resource_source;
	u32 interrupts[1];
};

struct acpi_resource_generic_register {
	u8 space_id;
	u8 bit_width;
	u8 bit_offset;
	u8 access_size;
	u64 address;
};

struct acpi_resource_gpio {
	u8 revision_id;
	u8 connection_type;
	u8 producer_consumer;	/* For values, see Producer/Consumer above */
	u8 pin_config;
	u8 sharable;		/* For values, see Interrupt Attributes above */
	u8 wake_capable;	/* For values, see Interrupt Attributes above */
	u8 io_restriction;
	u8 triggering;		/* For values, see Interrupt Attributes above */
	u8 polarity;		/* For values, see Interrupt Attributes above */
	u16 drive_strength;
	u16 debounce_timeout;
	u16 pin_table_length;
	u16 vendor_length;
	struct acpi_resource_source resource_source;
	u16 *pin_table;
	u8 *vendor_data;
};

/* Values for GPIO connection_type field above */

#define ACPI_RESOURCE_GPIO_TYPE_INT             0
#define ACPI_RESOURCE_GPIO_TYPE_IO              1

/* Values for pin_config field above */

#define ACPI_PIN_CONFIG_DEFAULT                 0
#define ACPI_PIN_CONFIG_PULLUP                  1
#define ACPI_PIN_CONFIG_PULLDOWN                2
#define ACPI_PIN_CONFIG_NOPULL                  3

/* Values for io_restriction field above */

#define ACPI_IO_RESTRICT_NONE                   0
#define ACPI_IO_RESTRICT_INPUT                  1
#define ACPI_IO_RESTRICT_OUTPUT                 2
#define ACPI_IO_RESTRICT_NONE_PRESERVE          3

/* Common structure for I2C, SPI, and UART serial descriptors */

#define ACPI_RESOURCE_SERIAL_COMMON \
	u8                                      revision_id; \
	u8                                      type; \
	u8                                      producer_consumer;   /* For values, see Producer/Consumer above */\
	u8                                      slave_mode; \
	u8                                      type_revision_id; \
	u16                                     type_data_length; \
	u16                                     vendor_length; \
	struct acpi_resource_source             resource_source; \
	u8                                      *vendor_data;

struct acpi_resource_common_serialbus {
ACPI_RESOURCE_SERIAL_COMMON};

/* Values for the Type field above */

#define ACPI_RESOURCE_SERIAL_TYPE_I2C           1
#define ACPI_RESOURCE_SERIAL_TYPE_SPI           2
#define ACPI_RESOURCE_SERIAL_TYPE_UART          3

/* Values for slave_mode field above */

#define ACPI_CONTROLLER_INITIATED               0
#define ACPI_DEVICE_INITIATED                   1

struct acpi_resource_i2c_serialbus {
	ACPI_RESOURCE_SERIAL_COMMON u8 access_mode;
	u16 slave_address;
	u32 connection_speed;
};

/* Values for access_mode field above */

#define ACPI_I2C_7BIT_MODE                      0
#define ACPI_I2C_10BIT_MODE                     1

struct acpi_resource_spi_serialbus {
	ACPI_RESOURCE_SERIAL_COMMON u8 wire_mode;
	u8 device_polarity;
	u8 data_bit_length;
	u8 clock_phase;
	u8 clock_polarity;
	u16 device_selection;
	u32 connection_speed;
};

/* Values for wire_mode field above */

#define ACPI_SPI_4WIRE_MODE                     0
#define ACPI_SPI_3WIRE_MODE                     1

/* Values for device_polarity field above */

#define ACPI_SPI_ACTIVE_LOW                     0
#define ACPI_SPI_ACTIVE_HIGH                    1

/* Values for clock_phase field above */

#define ACPI_SPI_FIRST_PHASE                    0
#define ACPI_SPI_SECOND_PHASE                   1

/* Values for clock_polarity field above */

#define ACPI_SPI_START_LOW                      0
#define ACPI_SPI_START_HIGH                     1

struct acpi_resource_uart_serialbus {
	ACPI_RESOURCE_SERIAL_COMMON u8 endian;
	u8 data_bits;
	u8 stop_bits;
	u8 flow_control;
	u8 parity;
	u8 lines_enabled;
	u16 rx_fifo_size;
	u16 tx_fifo_size;
	u32 default_baud_rate;
};

/* Values for Endian field above */

#define ACPI_UART_LITTLE_ENDIAN                 0
#define ACPI_UART_BIG_ENDIAN                    1

/* Values for data_bits field above */

#define ACPI_UART_5_DATA_BITS                   0
#define ACPI_UART_6_DATA_BITS                   1
#define ACPI_UART_7_DATA_BITS                   2
#define ACPI_UART_8_DATA_BITS                   3
#define ACPI_UART_9_DATA_BITS                   4

/* Values for stop_bits field above */

#define ACPI_UART_NO_STOP_BITS                  0
#define ACPI_UART_1_STOP_BIT                    1
#define ACPI_UART_1P5_STOP_BITS                 2
#define ACPI_UART_2_STOP_BITS                   3

/* Values for flow_control field above */

#define ACPI_UART_FLOW_CONTROL_NONE             0
#define ACPI_UART_FLOW_CONTROL_HW               1
#define ACPI_UART_FLOW_CONTROL_XON_XOFF         2

/* Values for Parity field above */

#define ACPI_UART_PARITY_NONE                   0
#define ACPI_UART_PARITY_EVEN                   1
#define ACPI_UART_PARITY_ODD                    2
#define ACPI_UART_PARITY_MARK                   3
#define ACPI_UART_PARITY_SPACE                  4

/* Values for lines_enabled bitfield above */

#define ACPI_UART_CARRIER_DETECT                (1<<2)
#define ACPI_UART_RING_INDICATOR                (1<<3)
#define ACPI_UART_DATA_SET_READY                (1<<4)
#define ACPI_UART_DATA_TERMINAL_READY           (1<<5)
#define ACPI_UART_CLEAR_TO_SEND                 (1<<6)
#define ACPI_UART_REQUEST_TO_SEND               (1<<7)

/* ACPI_RESOURCE_TYPEs */

#define ACPI_RESOURCE_TYPE_IRQ                  0
#define ACPI_RESOURCE_TYPE_DMA                  1
#define ACPI_RESOURCE_TYPE_START_DEPENDENT      2
#define ACPI_RESOURCE_TYPE_END_DEPENDENT        3
#define ACPI_RESOURCE_TYPE_IO                   4
#define ACPI_RESOURCE_TYPE_FIXED_IO             5
#define ACPI_RESOURCE_TYPE_VENDOR               6
#define ACPI_RESOURCE_TYPE_END_TAG              7
#define ACPI_RESOURCE_TYPE_MEMORY24             8
#define ACPI_RESOURCE_TYPE_MEMORY32             9
#define ACPI_RESOURCE_TYPE_FIXED_MEMORY32       10
#define ACPI_RESOURCE_TYPE_ADDRESS16            11
#define ACPI_RESOURCE_TYPE_ADDRESS32            12
#define ACPI_RESOURCE_TYPE_ADDRESS64            13
#define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64   14	/* ACPI 3.0 */
#define ACPI_RESOURCE_TYPE_EXTENDED_IRQ         15
#define ACPI_RESOURCE_TYPE_GENERIC_REGISTER     16
#define ACPI_RESOURCE_TYPE_GPIO                 17	/* ACPI 5.0 */
#define ACPI_RESOURCE_TYPE_FIXED_DMA            18	/* ACPI 5.0 */
#define ACPI_RESOURCE_TYPE_SERIAL_BUS           19	/* ACPI 5.0 */
#define ACPI_RESOURCE_TYPE_MAX                  19

/* Master union for resource descriptors */

union acpi_resource_data {
	struct acpi_resource_irq irq;
	struct acpi_resource_dma dma;
	struct acpi_resource_start_dependent start_dpf;
	struct acpi_resource_io io;
	struct acpi_resource_fixed_io fixed_io;
	struct acpi_resource_fixed_dma fixed_dma;
	struct acpi_resource_vendor vendor;
	struct acpi_resource_vendor_typed vendor_typed;
	struct acpi_resource_end_tag end_tag;
	struct acpi_resource_memory24 memory24;
	struct acpi_resource_memory32 memory32;
	struct acpi_resource_fixed_memory32 fixed_memory32;
	struct acpi_resource_address16 address16;
	struct acpi_resource_address32 address32;
	struct acpi_resource_address64 address64;
	struct acpi_resource_extended_address64 ext_address64;
	struct acpi_resource_extended_irq extended_irq;
	struct acpi_resource_generic_register generic_reg;
	struct acpi_resource_gpio gpio;
	struct acpi_resource_i2c_serialbus i2c_serial_bus;
	struct acpi_resource_spi_serialbus spi_serial_bus;
	struct acpi_resource_uart_serialbus uart_serial_bus;
	struct acpi_resource_common_serialbus common_serial_bus;

	/* Common fields */

	struct acpi_resource_address address;	/* Common 16/32/64 address fields */
};

/* Common resource header */

struct acpi_resource {
	u32 type;
	u32 length;
	union acpi_resource_data data;
};

/* restore default alignment */

#pragma pack()

#define ACPI_RS_SIZE_NO_DATA                8	/* Id + Length fields */
#define ACPI_RS_SIZE_MIN                    (u32) ACPI_ROUND_UP_TO_NATIVE_WORD (12)
#define ACPI_RS_SIZE(type)                  (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))

/* Macro for walking resource templates with multiple descriptors */

#define ACPI_NEXT_RESOURCE(res) \
	ACPI_ADD_PTR (struct acpi_resource, (res), (res)->length)

struct acpi_pci_routing_table {
	u32 length;
	u32 pin;
	u64 address;		/* here for 64-bit alignment */
	u32 source_index;
	char source[4];		/* pad to 64 bits so sizeof() works in all cases */
};

#endif				/* __ACRESTYP_H__ */
Commit	Line	Data
50df4d8b BM	1	/******************************************************************************
	2	*
	3	* Name: acrestyp.h - Defines, types, and structures for resource descriptors
	4	*
	5	*****************************************************************************/
	6
	7	/*
25f044e6	8	* Copyright (C) 2000 - 2013, Intel Corp.
50df4d8b BM	9	* All rights reserved.
	10	*
	11	* Redistribution and use in source and binary forms, with or without
	12	* modification, are permitted provided that the following conditions
	13	* are met:
	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.
	25	*
	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.
	29	*
	30	* NO WARRANTY
	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.
	42	*/
	43
	44	#ifndef __ACRESTYP_H__
	45	#define __ACRESTYP_H__
	46
	47	/*
	48	* Definitions for Resource Attributes
	49	*/
	50	typedef u16 acpi_rs_length; /* Resource Length field is fixed at 16 bits */
ba494bee	51	typedef u32 acpi_rsdesc_size; /* Max Resource Descriptor size is (Length+3) = (64K-1)+3 */
50df4d8b BM	52
	53	/*
	54	* Memory Attributes
	55	*/
	56	#define ACPI_READ_ONLY_MEMORY (u8) 0x00
	57	#define ACPI_READ_WRITE_MEMORY (u8) 0x01
	58
	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
	63
e0fe0a8d	64	/! [Begin] no source code translation /
50df4d8b BM	65	/*
50df4d8b BM	66	* IO Attributes
e0fe0a8d LM	67	* The ISA IO ranges are: n000-n0FFh, n400-n4FFh, n800-n8FFh, nC00-nCFFh.
e0fe0a8d LM	68	* The non-ISA IO ranges are: n100-n3FFh, n500-n7FFh, n900-nBFFh, nCD0-nFFFh.
50df4d8b	69	*/
e0fe0a8d LM	70	/! [End] no source code translation !/
e0fe0a8d LM	71
50df4d8b BM	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)
	75
	76	/* Type of translation - 1=Sparse, 0=Dense */
	77
	78	#define ACPI_SPARSE_TRANSLATION (u8) 0x01
	79
	80	/*
	81	* IO Port Descriptor Decode
	82	*/
	83	#define ACPI_DECODE_10 (u8) 0x00 /* 10-bit IO address decode */
	84	#define ACPI_DECODE_16 (u8) 0x01 /* 16-bit IO address decode */
	85
	86	/*
e0fe0a8d	87	* Interrupt attributes - used in multiple descriptors
50df4d8b	88	*/
e0fe0a8d LM	89
	90	/* Triggering */
	91
50df4d8b BM	92	#define ACPI_LEVEL_SENSITIVE (u8) 0x00
	93	#define ACPI_EDGE_SENSITIVE (u8) 0x01
	94
e0fe0a8d LM	95	/* Polarity */
e0fe0a8d LM	96
50df4d8b BM	97	#define ACPI_ACTIVE_HIGH (u8) 0x00
50df4d8b BM	98	#define ACPI_ACTIVE_LOW (u8) 0x01
e0fe0a8d LM	99	#define ACPI_ACTIVE_BOTH (u8) 0x02
	100
	101	/* Sharing */
50df4d8b BM	102
	103	#define ACPI_EXCLUSIVE (u8) 0x00
	104	#define ACPI_SHARED (u8) 0x01
9cea6249 BM	105
	106	/* Wake */
	107
	108	#define ACPI_NOT_WAKE_CAPABLE (u8) 0x00
	109	#define ACPI_WAKE_CAPABLE (u8) 0x01
50df4d8b BM	110
	111	/*
	112	* DMA Attributes
	113	*/
	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
	118
	119	#define ACPI_NOT_BUS_MASTER (u8) 0x00
	120	#define ACPI_BUS_MASTER (u8) 0x01
	121
	122	#define ACPI_TRANSFER_8 (u8) 0x00
	123	#define ACPI_TRANSFER_8_16 (u8) 0x01
	124	#define ACPI_TRANSFER_16 (u8) 0x02
	125
	126	/*
	127	* Start Dependent Functions Priority definitions
	128	*/
	129	#define ACPI_GOOD_CONFIGURATION (u8) 0x00
	130	#define ACPI_ACCEPTABLE_CONFIGURATION (u8) 0x01
	131	#define ACPI_SUB_OPTIMAL_CONFIGURATION (u8) 0x02
	132
	133	/*
	134	* 16, 32 and 64-bit Address Descriptor resource types
	135	*/
	136	#define ACPI_MEMORY_RANGE (u8) 0x00
	137	#define ACPI_IO_RANGE (u8) 0x01
	138	#define ACPI_BUS_NUMBER_RANGE (u8) 0x02
	139
	140	#define ACPI_ADDRESS_NOT_FIXED (u8) 0x00
	141	#define ACPI_ADDRESS_FIXED (u8) 0x01
	142
	143	#define ACPI_POS_DECODE (u8) 0x00
	144	#define ACPI_SUB_DECODE (u8) 0x01
	145
e0fe0a8d LM	146	/* Producer/Consumer */
e0fe0a8d LM	147
50df4d8b BM	148	#define ACPI_PRODUCER (u8) 0x00
	149	#define ACPI_CONSUMER (u8) 0x01
	150
	151	/*
	152	* If possible, pack the following structures to byte alignment
	153	*/
	154	#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
	155	#pragma pack(1)
	156	#endif
	157
	158	/* UUID data structures for use in vendor-defined resource descriptors */
	159
	160	struct acpi_uuid {
	161	u8 data[ACPI_UUID_LENGTH];
	162	};
	163
	164	struct acpi_vendor_uuid {
	165	u8 subtype;
	166	u8 data[ACPI_UUID_LENGTH];
	167	};
	168
	169	/*
	170	* Structures used to describe device resources
	171	*/
	172	struct acpi_resource_irq {
	173	u8 descriptor_length;
	174	u8 triggering;
	175	u8 polarity;
	176	u8 sharable;
9cea6249	177	u8 wake_capable;
50df4d8b BM	178	u8 interrupt_count;
	179	u8 interrupts[1];
	180	};
	181
	182	struct acpi_resource_dma {
	183	u8 type;
	184	u8 bus_master;
	185	u8 transfer;
	186	u8 channel_count;
	187	u8 channels[1];
	188	};
	189
	190	struct acpi_resource_start_dependent {
	191	u8 descriptor_length;
	192	u8 compatibility_priority;
	193	u8 performance_robustness;
	194	};
	195
	196	/*
	197	* The END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
	198	* needed because it has no fields
	199	*/
	200
	201	struct acpi_resource_io {
	202	u8 io_decode;
	203	u8 alignment;
	204	u8 address_length;
	205	u16 minimum;
	206	u16 maximum;
	207	};
	208
	209	struct acpi_resource_fixed_io {
	210	u16 address;
	211	u8 address_length;
	212	};
	213
e0fe0a8d LM	214	struct acpi_resource_fixed_dma {
	215	u16 request_lines;
	216	u16 channels;
	217	u8 width;
	218	};
	219
	220	/* Values for Width field above */
	221
	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
	228
50df4d8b BM	229	struct acpi_resource_vendor {
	230	u16 byte_length;
	231	u8 byte_data[1];
	232	};
	233
	234	/* Vendor resource with UUID info (introduced in ACPI 3.0) */
	235
	236	struct acpi_resource_vendor_typed {
	237	u16 byte_length;
	238	u8 uuid_subtype;
	239	u8 uuid[ACPI_UUID_LENGTH];
	240	u8 byte_data[1];
	241	};
	242
	243	struct acpi_resource_end_tag {
	244	u8 checksum;
	245	};
	246
	247	struct acpi_resource_memory24 {
	248	u8 write_protect;
	249	u16 minimum;
	250	u16 maximum;
	251	u16 alignment;
	252	u16 address_length;
	253	};
	254
	255	struct acpi_resource_memory32 {
	256	u8 write_protect;
	257	u32 minimum;
	258	u32 maximum;
	259	u32 alignment;
	260	u32 address_length;
	261	};
	262
	263	struct acpi_resource_fixed_memory32 {
	264	u8 write_protect;
	265	u32 address;
	266	u32 address_length;
	267	};
	268
	269	struct acpi_memory_attribute {
	270	u8 write_protect;
	271	u8 caching;
	272	u8 range_type;
	273	u8 translation;
	274	};
	275
	276	struct acpi_io_attribute {
	277	u8 range_type;
	278	u8 translation;
	279	u8 translation_type;
	280	u8 reserved1;
	281	};
	282
	283	union acpi_resource_attribute {
	284	struct acpi_memory_attribute mem;
	285	struct acpi_io_attribute io;
	286
	287	/* Used for the word_space macros /
	288
	289	u8 type_specific;
	290	};
	291
	292	struct acpi_resource_source {
293	u8 index;
294	u16 string_length;
295	char *string_ptr;
296	};
297
298	/* Fields common to all address descriptors, 16/32/64 bit */
299
300	#define ACPI_RESOURCE_ADDRESS_COMMON \
301	u8 resource_type; \
302	u8 producer_consumer; \
303	u8 decode; \
304	u8 min_address_fixed; \
305	u8 max_address_fixed; \
306	union acpi_resource_attribute info;
307
308	struct acpi_resource_address {
309	ACPI_RESOURCE_ADDRESS_COMMON};
310
311	struct acpi_resource_address16 {
312	ACPI_RESOURCE_ADDRESS_COMMON u16 granularity;
313	u16 minimum;
314	u16 maximum;
315	u16 translation_offset;
316	u16 address_length;
317	struct acpi_resource_source resource_source;
318	};
319
320	struct acpi_resource_address32 {
321	ACPI_RESOURCE_ADDRESS_COMMON u32 granularity;
322	u32 minimum;
323	u32 maximum;
324	u32 translation_offset;
325	u32 address_length;
326	struct acpi_resource_source resource_source;
327	};
328
329	struct acpi_resource_address64 {
330	ACPI_RESOURCE_ADDRESS_COMMON u64 granularity;
331	u64 minimum;
332	u64 maximum;
333	u64 translation_offset;
334	u64 address_length;
335	struct acpi_resource_source resource_source;
336	};
337
338	struct acpi_resource_extended_address64 {
ba494bee	339	ACPI_RESOURCE_ADDRESS_COMMON u8 revision_ID;
50df4d8b BM	340	u64 granularity;
	341	u64 minimum;
	342	u64 maximum;
	343	u64 translation_offset;
	344	u64 address_length;
	345	u64 type_specific;
	346	};
	347
	348	struct acpi_resource_extended_irq {
	349	u8 producer_consumer;
	350	u8 triggering;
	351	u8 polarity;
	352	u8 sharable;
9cea6249	353	u8 wake_capable;
50df4d8b BM	354	u8 interrupt_count;
	355	struct acpi_resource_source resource_source;
	356	u32 interrupts[1];
	357	};
	358
	359	struct acpi_resource_generic_register {
	360	u8 space_id;
	361	u8 bit_width;
	362	u8 bit_offset;
	363	u8 access_size;
	364	u64 address;
	365	};
	366
e0fe0a8d LM	367	struct acpi_resource_gpio {
	368	u8 revision_id;
	369	u8 connection_type;
	370	u8 producer_consumer; /* For values, see Producer/Consumer above */
	371	u8 pin_config;
	372	u8 sharable; /* For values, see Interrupt Attributes above */
9cea6249	373	u8 wake_capable; /* For values, see Interrupt Attributes above */
e0fe0a8d LM	374	u8 io_restriction;
	375	u8 triggering; /* For values, see Interrupt Attributes above */
	376	u8 polarity; /* For values, see Interrupt Attributes above */
	377	u16 drive_strength;
	378	u16 debounce_timeout;
	379	u16 pin_table_length;
	380	u16 vendor_length;
	381	struct acpi_resource_source resource_source;
	382	u16 *pin_table;
	383	u8 *vendor_data;
	384	};
	385
	386	/* Values for GPIO connection_type field above */
	387
	388	#define ACPI_RESOURCE_GPIO_TYPE_INT 0
	389	#define ACPI_RESOURCE_GPIO_TYPE_IO 1
	390
	391	/* Values for pin_config field above */
	392
	393	#define ACPI_PIN_CONFIG_DEFAULT 0
	394	#define ACPI_PIN_CONFIG_PULLUP 1
	395	#define ACPI_PIN_CONFIG_PULLDOWN 2
	396	#define ACPI_PIN_CONFIG_NOPULL 3
	397
	398	/* Values for io_restriction field above */
	399
	400	#define ACPI_IO_RESTRICT_NONE 0
	401	#define ACPI_IO_RESTRICT_INPUT 1
	402	#define ACPI_IO_RESTRICT_OUTPUT 2
	403	#define ACPI_IO_RESTRICT_NONE_PRESERVE 3
	404
	405	/* Common structure for I2C, SPI, and UART serial descriptors */
	406
	407	#define ACPI_RESOURCE_SERIAL_COMMON \
	408	u8 revision_id; \
	409	u8 type; \
	410	u8 producer_consumer; /* For values, see Producer/Consumer above */\
	411	u8 slave_mode; \
	412	u8 type_revision_id; \
	413	u16 type_data_length; \
	414	u16 vendor_length; \
	415	struct acpi_resource_source resource_source; \
	416	u8 *vendor_data;
	417
	418	struct acpi_resource_common_serialbus {
	419	ACPI_RESOURCE_SERIAL_COMMON};
	420
	421	/* Values for the Type field above */
	422
	423	#define ACPI_RESOURCE_SERIAL_TYPE_I2C 1
	424	#define ACPI_RESOURCE_SERIAL_TYPE_SPI 2
	425	#define ACPI_RESOURCE_SERIAL_TYPE_UART 3
	426
	427	/* Values for slave_mode field above */
	428
	429	#define ACPI_CONTROLLER_INITIATED 0
	430	#define ACPI_DEVICE_INITIATED 1
	431
	432	struct acpi_resource_i2c_serialbus {
	433	ACPI_RESOURCE_SERIAL_COMMON u8 access_mode;
	434	u16 slave_address;
	435	u32 connection_speed;
	436	};
	437
438	/* Values for access_mode field above */
439
440	#define ACPI_I2C_7BIT_MODE 0
441	#define ACPI_I2C_10BIT_MODE 1
442
443	struct acpi_resource_spi_serialbus {
444	ACPI_RESOURCE_SERIAL_COMMON u8 wire_mode;
445	u8 device_polarity;
446	u8 data_bit_length;
447	u8 clock_phase;
448	u8 clock_polarity;
449	u16 device_selection;
450	u32 connection_speed;
451	};
452
453	/* Values for wire_mode field above */
454
455	#define ACPI_SPI_4WIRE_MODE 0
456	#define ACPI_SPI_3WIRE_MODE 1
457
458	/* Values for device_polarity field above */
459
460	#define ACPI_SPI_ACTIVE_LOW 0
461	#define ACPI_SPI_ACTIVE_HIGH 1
462
463	/* Values for clock_phase field above */
464
465	#define ACPI_SPI_FIRST_PHASE 0
466	#define ACPI_SPI_SECOND_PHASE 1
467
468	/* Values for clock_polarity field above */
469
470	#define ACPI_SPI_START_LOW 0
471	#define ACPI_SPI_START_HIGH 1
472
473	struct acpi_resource_uart_serialbus {
474	ACPI_RESOURCE_SERIAL_COMMON u8 endian;
475	u8 data_bits;
476	u8 stop_bits;
477	u8 flow_control;
478	u8 parity;
479	u8 lines_enabled;
480	u16 rx_fifo_size;
481	u16 tx_fifo_size;
482	u32 default_baud_rate;
483	};
484
485	/* Values for Endian field above */
486
487	#define ACPI_UART_LITTLE_ENDIAN 0
488	#define ACPI_UART_BIG_ENDIAN 1
489
490	/* Values for data_bits field above */
491
492	#define ACPI_UART_5_DATA_BITS 0
493	#define ACPI_UART_6_DATA_BITS 1
494	#define ACPI_UART_7_DATA_BITS 2
495	#define ACPI_UART_8_DATA_BITS 3
496	#define ACPI_UART_9_DATA_BITS 4
497
498	/* Values for stop_bits field above */
499
500	#define ACPI_UART_NO_STOP_BITS 0
501	#define ACPI_UART_1_STOP_BIT 1
502	#define ACPI_UART_1P5_STOP_BITS 2
503	#define ACPI_UART_2_STOP_BITS 3
504
505	/* Values for flow_control field above */
506
507	#define ACPI_UART_FLOW_CONTROL_NONE 0
508	#define ACPI_UART_FLOW_CONTROL_HW 1
509	#define ACPI_UART_FLOW_CONTROL_XON_XOFF 2
510
511	/* Values for Parity field above */
512
513	#define ACPI_UART_PARITY_NONE 0
514	#define ACPI_UART_PARITY_EVEN 1
515	#define ACPI_UART_PARITY_ODD 2
516	#define ACPI_UART_PARITY_MARK 3
517	#define ACPI_UART_PARITY_SPACE 4
518
519	/* Values for lines_enabled bitfield above */
520
521	#define ACPI_UART_CARRIER_DETECT (1<<2)
522	#define ACPI_UART_RING_INDICATOR (1<<3)
523	#define ACPI_UART_DATA_SET_READY (1<<4)
524	#define ACPI_UART_DATA_TERMINAL_READY (1<<5)
525	#define ACPI_UART_CLEAR_TO_SEND (1<<6)
526	#define ACPI_UART_REQUEST_TO_SEND (1<<7)
527
50df4d8b BM	528	/* ACPI_RESOURCE_TYPEs */
	529
	530	#define ACPI_RESOURCE_TYPE_IRQ 0
	531	#define ACPI_RESOURCE_TYPE_DMA 1
	532	#define ACPI_RESOURCE_TYPE_START_DEPENDENT 2
	533	#define ACPI_RESOURCE_TYPE_END_DEPENDENT 3
	534	#define ACPI_RESOURCE_TYPE_IO 4
	535	#define ACPI_RESOURCE_TYPE_FIXED_IO 5
	536	#define ACPI_RESOURCE_TYPE_VENDOR 6
	537	#define ACPI_RESOURCE_TYPE_END_TAG 7
	538	#define ACPI_RESOURCE_TYPE_MEMORY24 8
	539	#define ACPI_RESOURCE_TYPE_MEMORY32 9
	540	#define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10
	541	#define ACPI_RESOURCE_TYPE_ADDRESS16 11
	542	#define ACPI_RESOURCE_TYPE_ADDRESS32 12
	543	#define ACPI_RESOURCE_TYPE_ADDRESS64 13
	544	#define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */
	545	#define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15
	546	#define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16
e0fe0a8d LM	547	#define ACPI_RESOURCE_TYPE_GPIO 17 /* ACPI 5.0 */
	548	#define ACPI_RESOURCE_TYPE_FIXED_DMA 18 /* ACPI 5.0 */
	549	#define ACPI_RESOURCE_TYPE_SERIAL_BUS 19 /* ACPI 5.0 */
	550	#define ACPI_RESOURCE_TYPE_MAX 19
50df4d8b BM	551
	552	/* Master union for resource descriptors */
	553
	554	union acpi_resource_data {
	555	struct acpi_resource_irq irq;
	556	struct acpi_resource_dma dma;
	557	struct acpi_resource_start_dependent start_dpf;
	558	struct acpi_resource_io io;
	559	struct acpi_resource_fixed_io fixed_io;
e0fe0a8d	560	struct acpi_resource_fixed_dma fixed_dma;
50df4d8b BM	561	struct acpi_resource_vendor vendor;
	562	struct acpi_resource_vendor_typed vendor_typed;
	563	struct acpi_resource_end_tag end_tag;
	564	struct acpi_resource_memory24 memory24;
	565	struct acpi_resource_memory32 memory32;
	566	struct acpi_resource_fixed_memory32 fixed_memory32;
	567	struct acpi_resource_address16 address16;
	568	struct acpi_resource_address32 address32;
	569	struct acpi_resource_address64 address64;
	570	struct acpi_resource_extended_address64 ext_address64;
	571	struct acpi_resource_extended_irq extended_irq;
	572	struct acpi_resource_generic_register generic_reg;
e0fe0a8d LM	573	struct acpi_resource_gpio gpio;
	574	struct acpi_resource_i2c_serialbus i2c_serial_bus;
	575	struct acpi_resource_spi_serialbus spi_serial_bus;
	576	struct acpi_resource_uart_serialbus uart_serial_bus;
	577	struct acpi_resource_common_serialbus common_serial_bus;
50df4d8b BM	578
	579	/* Common fields */
	580
	581	struct acpi_resource_address address; /* Common 16/32/64 address fields */
	582	};
	583
	584	/* Common resource header */
	585
	586	struct acpi_resource {
	587	u32 type;
	588	u32 length;
	589	union acpi_resource_data data;
	590	};
	591
	592	/* restore default alignment */
	593
	594	#pragma pack()
	595
	596	#define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */
	597	#define ACPI_RS_SIZE_MIN (u32) ACPI_ROUND_UP_TO_NATIVE_WORD (12)
	598	#define ACPI_RS_SIZE(type) (u32) (ACPI_RS_SIZE_NO_DATA + sizeof (type))
	599
fb4e5026 LZ	600	/* Macro for walking resource templates with multiple descriptors */
	601
	602	#define ACPI_NEXT_RESOURCE(res) \
	603	ACPI_ADD_PTR (struct acpi_resource, (res), (res)->length)
50df4d8b BM	604
	605	struct acpi_pci_routing_table {
	606	u32 length;
	607	u32 pin;
5df7e6cb	608	u64 address; /* here for 64-bit alignment */
50df4d8b BM	609	u32 source_index;
	610	char source[4]; /* pad to 64 bits so sizeof() works in all cases */
	611	};
	612
	613	#endif /* __ACRESTYP_H__ */