Merge branch 'x86-urgent-for-linus' of git://git.kernel.org/pub/scm/linux/kernel...
[cris-mirror.git] / drivers / acpi / acpica / amlresrc.h
blobb680c229ddd592ea3fa3facefcf9890e68b89852
1 /******************************************************************************
3 * Module Name: amlresrc.h - AML resource descriptors
5 *****************************************************************************/
7 /*
8 * Copyright (C) 2000 - 2018, Intel Corp.
9 * All rights reserved.
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.
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.
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.
44 /* acpisrc:struct_defs -- for acpisrc conversion */
46 #ifndef __AMLRESRC_H
47 #define __AMLRESRC_H
50 * Resource descriptor tags, as defined in the ACPI specification.
51 * Used to symbolically reference fields within a descriptor.
53 #define ACPI_RESTAG_ADDRESS "_ADR"
54 #define ACPI_RESTAG_ALIGNMENT "_ALN"
55 #define ACPI_RESTAG_ADDRESSSPACE "_ASI"
56 #define ACPI_RESTAG_ACCESSSIZE "_ASZ"
57 #define ACPI_RESTAG_TYPESPECIFICATTRIBUTES "_ATT"
58 #define ACPI_RESTAG_BASEADDRESS "_BAS"
59 #define ACPI_RESTAG_BUSMASTER "_BM_" /* Master(1), Slave(0) */
60 #define ACPI_RESTAG_DEBOUNCETIME "_DBT"
61 #define ACPI_RESTAG_DECODE "_DEC"
62 #define ACPI_RESTAG_DEVICEPOLARITY "_DPL"
63 #define ACPI_RESTAG_DMA "_DMA"
64 #define ACPI_RESTAG_DMATYPE "_TYP" /* Compatible(0), A(1), B(2), F(3) */
65 #define ACPI_RESTAG_DRIVESTRENGTH "_DRS"
66 #define ACPI_RESTAG_ENDIANNESS "_END"
67 #define ACPI_RESTAG_FLOWCONTROL "_FLC"
68 #define ACPI_RESTAG_FUNCTION "_FUN"
69 #define ACPI_RESTAG_GRANULARITY "_GRA"
70 #define ACPI_RESTAG_INTERRUPT "_INT"
71 #define ACPI_RESTAG_INTERRUPTLEVEL "_LL_" /* active_lo(1), active_hi(0) */
72 #define ACPI_RESTAG_INTERRUPTSHARE "_SHR" /* Shareable(1), no_share(0) */
73 #define ACPI_RESTAG_INTERRUPTTYPE "_HE_" /* Edge(1), Level(0) */
74 #define ACPI_RESTAG_IORESTRICTION "_IOR"
75 #define ACPI_RESTAG_LENGTH "_LEN"
76 #define ACPI_RESTAG_LINE "_LIN"
77 #define ACPI_RESTAG_MEMATTRIBUTES "_MTP" /* Memory(0), Reserved(1), ACPI(2), NVS(3) */
78 #define ACPI_RESTAG_MEMTYPE "_MEM" /* non_cache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */
79 #define ACPI_RESTAG_MAXADDR "_MAX"
80 #define ACPI_RESTAG_MINADDR "_MIN"
81 #define ACPI_RESTAG_MAXTYPE "_MAF"
82 #define ACPI_RESTAG_MINTYPE "_MIF"
83 #define ACPI_RESTAG_MODE "_MOD"
84 #define ACPI_RESTAG_PARITY "_PAR"
85 #define ACPI_RESTAG_PHASE "_PHA"
86 #define ACPI_RESTAG_PIN "_PIN"
87 #define ACPI_RESTAG_PINCONFIG "_PPI"
88 #define ACPI_RESTAG_PINCONFIG_TYPE "_TYP"
89 #define ACPI_RESTAG_PINCONFIG_VALUE "_VAL"
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_" /* read_only(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"
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
117 struct asl_resource_node {
118 u32 buffer_length;
119 void *buffer;
120 struct asl_resource_node *next;
123 struct asl_resource_info {
124 union acpi_parse_object *descriptor_type_op; /* Resource descriptor parse node */
125 union acpi_parse_object *mapping_op; /* Used for mapfile support */
126 u32 current_byte_offset; /* Offset in resource template */
129 /* Macros used to generate AML resource length fields */
131 #define ACPI_AML_SIZE_LARGE(r) (sizeof (r) - sizeof (struct aml_resource_large_header))
132 #define ACPI_AML_SIZE_SMALL(r) (sizeof (r) - sizeof (struct aml_resource_small_header))
135 * Resource descriptors defined in the ACPI specification.
137 * Packing/alignment must be BYTE because these descriptors
138 * are used to overlay the raw AML byte stream.
140 #pragma pack(1)
143 * SMALL descriptors
145 #define AML_RESOURCE_SMALL_HEADER_COMMON \
146 u8 descriptor_type;
148 struct aml_resource_small_header {
149 AML_RESOURCE_SMALL_HEADER_COMMON};
151 struct aml_resource_irq {
152 AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask;
153 u8 flags;
156 struct aml_resource_irq_noflags {
157 AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask;
160 struct aml_resource_dma {
161 AML_RESOURCE_SMALL_HEADER_COMMON u8 dma_channel_mask;
162 u8 flags;
165 struct aml_resource_start_dependent {
166 AML_RESOURCE_SMALL_HEADER_COMMON u8 flags;
169 struct aml_resource_start_dependent_noprio {
170 AML_RESOURCE_SMALL_HEADER_COMMON};
172 struct aml_resource_end_dependent {
173 AML_RESOURCE_SMALL_HEADER_COMMON};
175 struct aml_resource_io {
176 AML_RESOURCE_SMALL_HEADER_COMMON u8 flags;
177 u16 minimum;
178 u16 maximum;
179 u8 alignment;
180 u8 address_length;
183 struct aml_resource_fixed_io {
184 AML_RESOURCE_SMALL_HEADER_COMMON u16 address;
185 u8 address_length;
188 struct aml_resource_vendor_small {
189 AML_RESOURCE_SMALL_HEADER_COMMON};
191 struct aml_resource_end_tag {
192 AML_RESOURCE_SMALL_HEADER_COMMON u8 checksum;
195 struct aml_resource_fixed_dma {
196 AML_RESOURCE_SMALL_HEADER_COMMON u16 request_lines;
197 u16 channels;
198 u8 width;
202 * LARGE descriptors
204 #define AML_RESOURCE_LARGE_HEADER_COMMON \
205 u8 descriptor_type;\
206 u16 resource_length;
208 struct aml_resource_large_header {
209 AML_RESOURCE_LARGE_HEADER_COMMON};
211 /* General Flags for address space resource descriptors */
213 #define ACPI_RESOURCE_FLAG_DEC 2
214 #define ACPI_RESOURCE_FLAG_MIF 4
215 #define ACPI_RESOURCE_FLAG_MAF 8
217 struct aml_resource_memory24 {
218 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
219 u16 minimum;
220 u16 maximum;
221 u16 alignment;
222 u16 address_length;
225 struct aml_resource_vendor_large {
226 AML_RESOURCE_LARGE_HEADER_COMMON};
228 struct aml_resource_memory32 {
229 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
230 u32 minimum;
231 u32 maximum;
232 u32 alignment;
233 u32 address_length;
236 struct aml_resource_fixed_memory32 {
237 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
238 u32 address;
239 u32 address_length;
242 #define AML_RESOURCE_ADDRESS_COMMON \
243 u8 resource_type; \
244 u8 flags; \
245 u8 specific_flags;
247 struct aml_resource_address {
248 AML_RESOURCE_LARGE_HEADER_COMMON AML_RESOURCE_ADDRESS_COMMON};
250 struct aml_resource_extended_address64 {
251 AML_RESOURCE_LARGE_HEADER_COMMON
252 AML_RESOURCE_ADDRESS_COMMON u8 revision_ID;
253 u8 reserved;
254 u64 granularity;
255 u64 minimum;
256 u64 maximum;
257 u64 translation_offset;
258 u64 address_length;
259 u64 type_specific;
262 #define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */
264 struct aml_resource_address64 {
265 AML_RESOURCE_LARGE_HEADER_COMMON
266 AML_RESOURCE_ADDRESS_COMMON u64 granularity;
267 u64 minimum;
268 u64 maximum;
269 u64 translation_offset;
270 u64 address_length;
273 struct aml_resource_address32 {
274 AML_RESOURCE_LARGE_HEADER_COMMON
275 AML_RESOURCE_ADDRESS_COMMON u32 granularity;
276 u32 minimum;
277 u32 maximum;
278 u32 translation_offset;
279 u32 address_length;
282 struct aml_resource_address16 {
283 AML_RESOURCE_LARGE_HEADER_COMMON
284 AML_RESOURCE_ADDRESS_COMMON u16 granularity;
285 u16 minimum;
286 u16 maximum;
287 u16 translation_offset;
288 u16 address_length;
291 struct aml_resource_extended_irq {
292 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
293 u8 interrupt_count;
294 u32 interrupts[1];
295 /* res_source_index, res_source optional fields follow */
298 struct aml_resource_generic_register {
299 AML_RESOURCE_LARGE_HEADER_COMMON u8 address_space_id;
300 u8 bit_width;
301 u8 bit_offset;
302 u8 access_size; /* ACPI 3.0, was previously Reserved */
303 u64 address;
306 /* Common descriptor for gpio_int and gpio_io (ACPI 5.0) */
308 struct aml_resource_gpio {
309 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
310 u8 connection_type;
311 u16 flags;
312 u16 int_flags;
313 u8 pin_config;
314 u16 drive_strength;
315 u16 debounce_timeout;
316 u16 pin_table_offset;
317 u8 res_source_index;
318 u16 res_source_offset;
319 u16 vendor_offset;
320 u16 vendor_length;
322 * Optional fields follow immediately:
323 * 1) PIN list (Words)
324 * 2) Resource Source String
325 * 3) Vendor Data bytes
329 #define AML_RESOURCE_GPIO_REVISION 1 /* ACPI 5.0 */
331 /* Values for connection_type above */
333 #define AML_RESOURCE_GPIO_TYPE_INT 0
334 #define AML_RESOURCE_GPIO_TYPE_IO 1
335 #define AML_RESOURCE_MAX_GPIOTYPE 1
337 /* Common preamble for all serial descriptors (ACPI 5.0) */
339 #define AML_RESOURCE_SERIAL_COMMON \
340 u8 revision_id; \
341 u8 res_source_index; \
342 u8 type; \
343 u8 flags; \
344 u16 type_specific_flags; \
345 u8 type_revision_id; \
346 u16 type_data_length; \
348 /* Values for the type field above */
350 #define AML_RESOURCE_I2C_SERIALBUSTYPE 1
351 #define AML_RESOURCE_SPI_SERIALBUSTYPE 2
352 #define AML_RESOURCE_UART_SERIALBUSTYPE 3
353 #define AML_RESOURCE_MAX_SERIALBUSTYPE 3
354 #define AML_RESOURCE_VENDOR_SERIALBUSTYPE 192 /* Vendor defined is 0xC0-0xFF (NOT SUPPORTED) */
356 struct aml_resource_common_serialbus {
357 AML_RESOURCE_LARGE_HEADER_COMMON AML_RESOURCE_SERIAL_COMMON};
359 struct aml_resource_i2c_serialbus {
360 AML_RESOURCE_LARGE_HEADER_COMMON
361 AML_RESOURCE_SERIAL_COMMON u32 connection_speed;
362 u16 slave_address;
364 * Optional fields follow immediately:
365 * 1) Vendor Data bytes
366 * 2) Resource Source String
370 #define AML_RESOURCE_I2C_REVISION 1 /* ACPI 5.0 */
371 #define AML_RESOURCE_I2C_TYPE_REVISION 1 /* ACPI 5.0 */
372 #define AML_RESOURCE_I2C_MIN_DATA_LEN 6
374 struct aml_resource_spi_serialbus {
375 AML_RESOURCE_LARGE_HEADER_COMMON
376 AML_RESOURCE_SERIAL_COMMON u32 connection_speed;
377 u8 data_bit_length;
378 u8 clock_phase;
379 u8 clock_polarity;
380 u16 device_selection;
382 * Optional fields follow immediately:
383 * 1) Vendor Data bytes
384 * 2) Resource Source String
388 #define AML_RESOURCE_SPI_REVISION 1 /* ACPI 5.0 */
389 #define AML_RESOURCE_SPI_TYPE_REVISION 1 /* ACPI 5.0 */
390 #define AML_RESOURCE_SPI_MIN_DATA_LEN 9
392 struct aml_resource_uart_serialbus {
393 AML_RESOURCE_LARGE_HEADER_COMMON
394 AML_RESOURCE_SERIAL_COMMON u32 default_baud_rate;
395 u16 rx_fifo_size;
396 u16 tx_fifo_size;
397 u8 parity;
398 u8 lines_enabled;
400 * Optional fields follow immediately:
401 * 1) Vendor Data bytes
402 * 2) Resource Source String
406 #define AML_RESOURCE_UART_REVISION 1 /* ACPI 5.0 */
407 #define AML_RESOURCE_UART_TYPE_REVISION 1 /* ACPI 5.0 */
408 #define AML_RESOURCE_UART_MIN_DATA_LEN 10
410 struct aml_resource_pin_function {
411 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
412 u16 flags;
413 u8 pin_config;
414 u16 function_number;
415 u16 pin_table_offset;
416 u8 res_source_index;
417 u16 res_source_offset;
418 u16 vendor_offset;
419 u16 vendor_length;
421 * Optional fields follow immediately:
422 * 1) PIN list (Words)
423 * 2) Resource Source String
424 * 3) Vendor Data bytes
428 #define AML_RESOURCE_PIN_FUNCTION_REVISION 1 /* ACPI 6.2 */
430 struct aml_resource_pin_config {
431 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
432 u16 flags;
433 u8 pin_config_type;
434 u32 pin_config_value;
435 u16 pin_table_offset;
436 u8 res_source_index;
437 u16 res_source_offset;
438 u16 vendor_offset;
439 u16 vendor_length;
441 * Optional fields follow immediately:
442 * 1) PIN list (Words)
443 * 2) Resource Source String
444 * 3) Vendor Data bytes
448 #define AML_RESOURCE_PIN_CONFIG_REVISION 1 /* ACPI 6.2 */
450 struct aml_resource_pin_group {
451 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
452 u16 flags;
453 u16 pin_table_offset;
454 u16 label_offset;
455 u16 vendor_offset;
456 u16 vendor_length;
458 * Optional fields follow immediately:
459 * 1) PIN list (Words)
460 * 2) Resource Label String
461 * 3) Vendor Data bytes
465 #define AML_RESOURCE_PIN_GROUP_REVISION 1 /* ACPI 6.2 */
467 struct aml_resource_pin_group_function {
468 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
469 u16 flags;
470 u16 function_number;
471 u8 res_source_index;
472 u16 res_source_offset;
473 u16 res_source_label_offset;
474 u16 vendor_offset;
475 u16 vendor_length;
477 * Optional fields follow immediately:
478 * 1) Resource Source String
479 * 2) Resource Source Label String
480 * 3) Vendor Data bytes
484 #define AML_RESOURCE_PIN_GROUP_FUNCTION_REVISION 1 /* ACPI 6.2 */
486 struct aml_resource_pin_group_config {
487 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
488 u16 flags;
489 u8 pin_config_type;
490 u32 pin_config_value;
491 u8 res_source_index;
492 u16 res_source_offset;
493 u16 res_source_label_offset;
494 u16 vendor_offset;
495 u16 vendor_length;
497 * Optional fields follow immediately:
498 * 1) Resource Source String
499 * 2) Resource Source Label String
500 * 3) Vendor Data bytes
504 #define AML_RESOURCE_PIN_GROUP_CONFIG_REVISION 1 /* ACPI 6.2 */
506 /* restore default alignment */
508 #pragma pack()
510 /* Union of all resource descriptors, so we can allocate the worst case */
512 union aml_resource {
513 /* Descriptor headers */
515 u8 descriptor_type;
516 struct aml_resource_small_header small_header;
517 struct aml_resource_large_header large_header;
519 /* Small resource descriptors */
521 struct aml_resource_irq irq;
522 struct aml_resource_dma dma;
523 struct aml_resource_start_dependent start_dpf;
524 struct aml_resource_end_dependent end_dpf;
525 struct aml_resource_io io;
526 struct aml_resource_fixed_io fixed_io;
527 struct aml_resource_fixed_dma fixed_dma;
528 struct aml_resource_vendor_small vendor_small;
529 struct aml_resource_end_tag end_tag;
531 /* Large resource descriptors */
533 struct aml_resource_memory24 memory24;
534 struct aml_resource_generic_register generic_reg;
535 struct aml_resource_vendor_large vendor_large;
536 struct aml_resource_memory32 memory32;
537 struct aml_resource_fixed_memory32 fixed_memory32;
538 struct aml_resource_address16 address16;
539 struct aml_resource_address32 address32;
540 struct aml_resource_address64 address64;
541 struct aml_resource_extended_address64 ext_address64;
542 struct aml_resource_extended_irq extended_irq;
543 struct aml_resource_gpio gpio;
544 struct aml_resource_i2c_serialbus i2c_serial_bus;
545 struct aml_resource_spi_serialbus spi_serial_bus;
546 struct aml_resource_uart_serialbus uart_serial_bus;
547 struct aml_resource_common_serialbus common_serial_bus;
548 struct aml_resource_pin_function pin_function;
549 struct aml_resource_pin_config pin_config;
550 struct aml_resource_pin_group pin_group;
551 struct aml_resource_pin_group_function pin_group_function;
552 struct aml_resource_pin_group_config pin_group_config;
554 /* Utility overlays */
556 struct aml_resource_address address;
557 u32 dword_item;
558 u16 word_item;
559 u8 byte_item;
562 /* Interfaces used by both the disassembler and compiler */
564 void
565 mp_save_gpio_info(union acpi_parse_object *op,
566 union aml_resource *resource,
567 u32 pin_count, u16 *pin_list, char *device_name);
569 void
570 mp_save_serial_info(union acpi_parse_object *op,
571 union aml_resource *resource, char *device_name);
573 char *mp_get_hid_from_parse_tree(struct acpi_namespace_node *hid_node);
575 char *mp_get_hid_via_namestring(char *device_name);
577 char *mp_get_connection_info(union acpi_parse_object *op,
578 u32 pin_index,
579 struct acpi_namespace_node **target_node,
580 char **target_name);
582 char *mp_get_parent_device_hid(union acpi_parse_object *op,
583 struct acpi_namespace_node **target_node,
584 char **parent_device_name);
586 char *mp_get_ddn_value(char *device_name);
588 char *mp_get_hid_value(struct acpi_namespace_node *device_node);
590 #endif