1 /* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2 /******************************************************************************
4 * Module Name: amlresrc.h - AML resource descriptors
6 * Copyright (C) 2000 - 2022, Intel Corp.
8 *****************************************************************************/
10 /* acpisrc:struct_defs -- for acpisrc conversion */
16 * Resource descriptor tags, as defined in the ACPI specification.
17 * Used to symbolically reference fields within a descriptor.
19 #define ACPI_RESTAG_ADDRESS "_ADR"
20 #define ACPI_RESTAG_ALIGNMENT "_ALN"
21 #define ACPI_RESTAG_ADDRESSSPACE "_ASI"
22 #define ACPI_RESTAG_ACCESSSIZE "_ASZ"
23 #define ACPI_RESTAG_TYPESPECIFICATTRIBUTES "_ATT"
24 #define ACPI_RESTAG_BASEADDRESS "_BAS"
25 #define ACPI_RESTAG_BUSMASTER "_BM_" /* Master(1), Slave(0) */
26 #define ACPI_RESTAG_DEBOUNCETIME "_DBT"
27 #define ACPI_RESTAG_DECODE "_DEC"
28 #define ACPI_RESTAG_DEVICEPOLARITY "_DPL"
29 #define ACPI_RESTAG_DMA "_DMA"
30 #define ACPI_RESTAG_DMATYPE "_TYP" /* Compatible(0), A(1), B(2), F(3) */
31 #define ACPI_RESTAG_DRIVESTRENGTH "_DRS"
32 #define ACPI_RESTAG_ENDIANNESS "_END"
33 #define ACPI_RESTAG_FLOWCONTROL "_FLC"
34 #define ACPI_RESTAG_FUNCTION "_FUN"
35 #define ACPI_RESTAG_GRANULARITY "_GRA"
36 #define ACPI_RESTAG_INTERRUPT "_INT"
37 #define ACPI_RESTAG_INTERRUPTLEVEL "_LL_" /* active_lo(1), active_hi(0) */
38 #define ACPI_RESTAG_INTERRUPTSHARE "_SHR" /* Shareable(1), no_share(0) */
39 #define ACPI_RESTAG_INTERRUPTTYPE "_HE_" /* Edge(1), Level(0) */
40 #define ACPI_RESTAG_IORESTRICTION "_IOR"
41 #define ACPI_RESTAG_LENGTH "_LEN"
42 #define ACPI_RESTAG_LINE "_LIN"
43 #define ACPI_RESTAG_LOCALPORT "_PRT"
44 #define ACPI_RESTAG_MEMATTRIBUTES "_MTP" /* Memory(0), Reserved(1), ACPI(2), NVS(3) */
45 #define ACPI_RESTAG_MEMTYPE "_MEM" /* non_cache(0), Cacheable(1) Cache+combine(2), Cache+prefetch(3) */
46 #define ACPI_RESTAG_MAXADDR "_MAX"
47 #define ACPI_RESTAG_MINADDR "_MIN"
48 #define ACPI_RESTAG_MAXTYPE "_MAF"
49 #define ACPI_RESTAG_MINTYPE "_MIF"
50 #define ACPI_RESTAG_MODE "_MOD"
51 #define ACPI_RESTAG_PARITY "_PAR"
52 #define ACPI_RESTAG_PHASE "_PHA"
53 #define ACPI_RESTAG_PHYTYPE "_PHY"
54 #define ACPI_RESTAG_PIN "_PIN"
55 #define ACPI_RESTAG_PINCONFIG "_PPI"
56 #define ACPI_RESTAG_PINCONFIG_TYPE "_TYP"
57 #define ACPI_RESTAG_PINCONFIG_VALUE "_VAL"
58 #define ACPI_RESTAG_POLARITY "_POL"
59 #define ACPI_RESTAG_REGISTERBITOFFSET "_RBO"
60 #define ACPI_RESTAG_REGISTERBITWIDTH "_RBW"
61 #define ACPI_RESTAG_RANGETYPE "_RNG"
62 #define ACPI_RESTAG_READWRITETYPE "_RW_" /* read_only(0), Writeable (1) */
63 #define ACPI_RESTAG_LENGTH_RX "_RXL"
64 #define ACPI_RESTAG_LENGTH_TX "_TXL"
65 #define ACPI_RESTAG_SLAVEMODE "_SLV"
66 #define ACPI_RESTAG_SPEED "_SPE"
67 #define ACPI_RESTAG_STOPBITS "_STB"
68 #define ACPI_RESTAG_TRANSLATION "_TRA"
69 #define ACPI_RESTAG_TRANSTYPE "_TRS" /* Sparse(1), Dense(0) */
70 #define ACPI_RESTAG_TYPE "_TTP" /* Translation(1), Static (0) */
71 #define ACPI_RESTAG_XFERTYPE "_SIZ" /* 8(0), 8And16(1), 16(2) */
72 #define ACPI_RESTAG_VENDORDATA "_VEN"
74 /* Default sizes for "small" resource descriptors */
76 #define ASL_RDESC_IRQ_SIZE 0x02
77 #define ASL_RDESC_DMA_SIZE 0x02
78 #define ASL_RDESC_ST_DEPEND_SIZE 0x00
79 #define ASL_RDESC_END_DEPEND_SIZE 0x00
80 #define ASL_RDESC_IO_SIZE 0x07
81 #define ASL_RDESC_FIXED_IO_SIZE 0x03
82 #define ASL_RDESC_FIXED_DMA_SIZE 0x05
83 #define ASL_RDESC_END_TAG_SIZE 0x01
85 struct asl_resource_node {
88 struct asl_resource_node *next;
91 struct asl_resource_info {
92 union acpi_parse_object *descriptor_type_op; /* Resource descriptor parse node */
93 union acpi_parse_object *mapping_op; /* Used for mapfile support */
94 u32 current_byte_offset; /* Offset in resource template */
97 /* Macros used to generate AML resource length fields */
99 #define ACPI_AML_SIZE_LARGE(r) (sizeof (r) - sizeof (struct aml_resource_large_header))
100 #define ACPI_AML_SIZE_SMALL(r) (sizeof (r) - sizeof (struct aml_resource_small_header))
103 * Resource descriptors defined in the ACPI specification.
105 * Packing/alignment must be BYTE because these descriptors
106 * are used to overlay the raw AML byte stream.
113 #define AML_RESOURCE_SMALL_HEADER_COMMON \
116 struct aml_resource_small_header {
117 AML_RESOURCE_SMALL_HEADER_COMMON};
119 struct aml_resource_irq {
120 AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask;
124 struct aml_resource_irq_noflags {
125 AML_RESOURCE_SMALL_HEADER_COMMON u16 irq_mask;
128 struct aml_resource_dma {
129 AML_RESOURCE_SMALL_HEADER_COMMON u8 dma_channel_mask;
133 struct aml_resource_start_dependent {
134 AML_RESOURCE_SMALL_HEADER_COMMON u8 flags;
137 struct aml_resource_start_dependent_noprio {
138 AML_RESOURCE_SMALL_HEADER_COMMON};
140 struct aml_resource_end_dependent {
141 AML_RESOURCE_SMALL_HEADER_COMMON};
143 struct aml_resource_io {
144 AML_RESOURCE_SMALL_HEADER_COMMON u8 flags;
151 struct aml_resource_fixed_io {
152 AML_RESOURCE_SMALL_HEADER_COMMON u16 address;
156 struct aml_resource_vendor_small {
157 AML_RESOURCE_SMALL_HEADER_COMMON};
159 struct aml_resource_end_tag {
160 AML_RESOURCE_SMALL_HEADER_COMMON u8 checksum;
163 struct aml_resource_fixed_dma {
164 AML_RESOURCE_SMALL_HEADER_COMMON u16 request_lines;
172 #define AML_RESOURCE_LARGE_HEADER_COMMON \
176 struct aml_resource_large_header {
177 AML_RESOURCE_LARGE_HEADER_COMMON};
179 /* General Flags for address space resource descriptors */
181 #define ACPI_RESOURCE_FLAG_DEC 2
182 #define ACPI_RESOURCE_FLAG_MIF 4
183 #define ACPI_RESOURCE_FLAG_MAF 8
185 struct aml_resource_memory24 {
186 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
193 struct aml_resource_vendor_large {
194 AML_RESOURCE_LARGE_HEADER_COMMON};
196 struct aml_resource_memory32 {
197 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
204 struct aml_resource_fixed_memory32 {
205 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
210 #define AML_RESOURCE_ADDRESS_COMMON \
215 struct aml_resource_address {
216 AML_RESOURCE_LARGE_HEADER_COMMON AML_RESOURCE_ADDRESS_COMMON};
218 struct aml_resource_extended_address64 {
219 AML_RESOURCE_LARGE_HEADER_COMMON
220 AML_RESOURCE_ADDRESS_COMMON u8 revision_ID;
225 u64 translation_offset;
230 #define AML_RESOURCE_EXTENDED_ADDRESS_REVISION 1 /* ACPI 3.0 */
232 struct aml_resource_address64 {
233 AML_RESOURCE_LARGE_HEADER_COMMON
234 AML_RESOURCE_ADDRESS_COMMON u64 granularity;
237 u64 translation_offset;
241 struct aml_resource_address32 {
242 AML_RESOURCE_LARGE_HEADER_COMMON
243 AML_RESOURCE_ADDRESS_COMMON u32 granularity;
246 u32 translation_offset;
250 struct aml_resource_address16 {
251 AML_RESOURCE_LARGE_HEADER_COMMON
252 AML_RESOURCE_ADDRESS_COMMON u16 granularity;
255 u16 translation_offset;
259 struct aml_resource_extended_irq {
260 AML_RESOURCE_LARGE_HEADER_COMMON u8 flags;
263 /* res_source_index, res_source optional fields follow */
266 struct aml_resource_generic_register {
267 AML_RESOURCE_LARGE_HEADER_COMMON u8 address_space_id;
270 u8 access_size; /* ACPI 3.0, was previously Reserved */
274 /* Common descriptor for gpio_int and gpio_io (ACPI 5.0) */
276 struct aml_resource_gpio {
277 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
283 u16 debounce_timeout;
284 u16 pin_table_offset;
286 u16 res_source_offset;
290 * Optional fields follow immediately:
291 * 1) PIN list (Words)
292 * 2) Resource Source String
293 * 3) Vendor Data bytes
297 #define AML_RESOURCE_GPIO_REVISION 1 /* ACPI 5.0 */
299 /* Values for connection_type above */
301 #define AML_RESOURCE_GPIO_TYPE_INT 0
302 #define AML_RESOURCE_GPIO_TYPE_IO 1
303 #define AML_RESOURCE_MAX_GPIOTYPE 1
305 /* Common preamble for all serial descriptors (ACPI 5.0) */
307 #define AML_RESOURCE_SERIAL_COMMON \
309 u8 res_source_index; \
312 u16 type_specific_flags; \
313 u8 type_revision_id; \
314 u16 type_data_length; \
316 /* Values for the type field above */
318 #define AML_RESOURCE_I2C_SERIALBUSTYPE 1
319 #define AML_RESOURCE_SPI_SERIALBUSTYPE 2
320 #define AML_RESOURCE_UART_SERIALBUSTYPE 3
321 #define AML_RESOURCE_CSI2_SERIALBUSTYPE 4
322 #define AML_RESOURCE_MAX_SERIALBUSTYPE 4
323 #define AML_RESOURCE_VENDOR_SERIALBUSTYPE 192 /* Vendor defined is 0xC0-0xFF (NOT SUPPORTED) */
325 struct aml_resource_common_serialbus {
326 AML_RESOURCE_LARGE_HEADER_COMMON AML_RESOURCE_SERIAL_COMMON};
328 struct aml_resource_csi2_serialbus {
329 AML_RESOURCE_LARGE_HEADER_COMMON AML_RESOURCE_SERIAL_COMMON
331 * Optional fields follow immediately:
332 * 1) Vendor Data bytes
333 * 2) Resource Source String
337 #define AML_RESOURCE_CSI2_REVISION 1 /* ACPI 6.4 */
338 #define AML_RESOURCE_CSI2_TYPE_REVISION 1 /* ACPI 6.4 */
339 #define AML_RESOURCE_CSI2_MIN_DATA_LEN 0 /* ACPI 6.4 */
341 struct aml_resource_i2c_serialbus {
342 AML_RESOURCE_LARGE_HEADER_COMMON
343 AML_RESOURCE_SERIAL_COMMON u32 connection_speed;
346 * Optional fields follow immediately:
347 * 1) Vendor Data bytes
348 * 2) Resource Source String
352 #define AML_RESOURCE_I2C_REVISION 1 /* ACPI 5.0 */
353 #define AML_RESOURCE_I2C_TYPE_REVISION 1 /* ACPI 5.0 */
354 #define AML_RESOURCE_I2C_MIN_DATA_LEN 6
356 struct aml_resource_spi_serialbus {
357 AML_RESOURCE_LARGE_HEADER_COMMON
358 AML_RESOURCE_SERIAL_COMMON u32 connection_speed;
362 u16 device_selection;
364 * Optional fields follow immediately:
365 * 1) Vendor Data bytes
366 * 2) Resource Source String
370 #define AML_RESOURCE_SPI_REVISION 1 /* ACPI 5.0 */
371 #define AML_RESOURCE_SPI_TYPE_REVISION 1 /* ACPI 5.0 */
372 #define AML_RESOURCE_SPI_MIN_DATA_LEN 9
374 struct aml_resource_uart_serialbus {
375 AML_RESOURCE_LARGE_HEADER_COMMON
376 AML_RESOURCE_SERIAL_COMMON u32 default_baud_rate;
382 * Optional fields follow immediately:
383 * 1) Vendor Data bytes
384 * 2) Resource Source String
388 #define AML_RESOURCE_UART_REVISION 1 /* ACPI 5.0 */
389 #define AML_RESOURCE_UART_TYPE_REVISION 1 /* ACPI 5.0 */
390 #define AML_RESOURCE_UART_MIN_DATA_LEN 10
392 struct aml_resource_pin_function {
393 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
397 u16 pin_table_offset;
399 u16 res_source_offset;
403 * Optional fields follow immediately:
404 * 1) PIN list (Words)
405 * 2) Resource Source String
406 * 3) Vendor Data bytes
410 #define AML_RESOURCE_PIN_FUNCTION_REVISION 1 /* ACPI 6.2 */
412 struct aml_resource_pin_config {
413 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
416 u32 pin_config_value;
417 u16 pin_table_offset;
419 u16 res_source_offset;
423 * Optional fields follow immediately:
424 * 1) PIN list (Words)
425 * 2) Resource Source String
426 * 3) Vendor Data bytes
430 #define AML_RESOURCE_PIN_CONFIG_REVISION 1 /* ACPI 6.2 */
432 struct aml_resource_pin_group {
433 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
435 u16 pin_table_offset;
440 * Optional fields follow immediately:
441 * 1) PIN list (Words)
442 * 2) Resource Label String
443 * 3) Vendor Data bytes
447 #define AML_RESOURCE_PIN_GROUP_REVISION 1 /* ACPI 6.2 */
449 struct aml_resource_pin_group_function {
450 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
454 u16 res_source_offset;
455 u16 res_source_label_offset;
459 * Optional fields follow immediately:
460 * 1) Resource Source String
461 * 2) Resource Source Label String
462 * 3) Vendor Data bytes
466 #define AML_RESOURCE_PIN_GROUP_FUNCTION_REVISION 1 /* ACPI 6.2 */
468 struct aml_resource_pin_group_config {
469 AML_RESOURCE_LARGE_HEADER_COMMON u8 revision_id;
472 u32 pin_config_value;
474 u16 res_source_offset;
475 u16 res_source_label_offset;
479 * Optional fields follow immediately:
480 * 1) Resource Source String
481 * 2) Resource Source Label String
482 * 3) Vendor Data bytes
486 #define AML_RESOURCE_PIN_GROUP_CONFIG_REVISION 1 /* ACPI 6.2 */
488 /* restore default alignment */
492 /* Union of all resource descriptors, so we can allocate the worst case */
495 /* Descriptor headers */
498 struct aml_resource_small_header small_header;
499 struct aml_resource_large_header large_header;
501 /* Small resource descriptors */
503 struct aml_resource_irq irq;
504 struct aml_resource_dma dma;
505 struct aml_resource_start_dependent start_dpf;
506 struct aml_resource_end_dependent end_dpf;
507 struct aml_resource_io io;
508 struct aml_resource_fixed_io fixed_io;
509 struct aml_resource_fixed_dma fixed_dma;
510 struct aml_resource_vendor_small vendor_small;
511 struct aml_resource_end_tag end_tag;
513 /* Large resource descriptors */
515 struct aml_resource_memory24 memory24;
516 struct aml_resource_generic_register generic_reg;
517 struct aml_resource_vendor_large vendor_large;
518 struct aml_resource_memory32 memory32;
519 struct aml_resource_fixed_memory32 fixed_memory32;
520 struct aml_resource_address16 address16;
521 struct aml_resource_address32 address32;
522 struct aml_resource_address64 address64;
523 struct aml_resource_extended_address64 ext_address64;
524 struct aml_resource_extended_irq extended_irq;
525 struct aml_resource_gpio gpio;
526 struct aml_resource_i2c_serialbus i2c_serial_bus;
527 struct aml_resource_spi_serialbus spi_serial_bus;
528 struct aml_resource_uart_serialbus uart_serial_bus;
529 struct aml_resource_csi2_serialbus csi2_serial_bus;
530 struct aml_resource_common_serialbus common_serial_bus;
531 struct aml_resource_pin_function pin_function;
532 struct aml_resource_pin_config pin_config;
533 struct aml_resource_pin_group pin_group;
534 struct aml_resource_pin_group_function pin_group_function;
535 struct aml_resource_pin_group_config pin_group_config;
537 /* Utility overlays */
539 struct aml_resource_address address;
545 /* Interfaces used by both the disassembler and compiler */
548 mp_save_gpio_info(union acpi_parse_object *op,
549 union aml_resource *resource,
550 u32 pin_count, u16 *pin_list, char *device_name);
553 mp_save_serial_info(union acpi_parse_object *op,
554 union aml_resource *resource, char *device_name);
556 char *mp_get_hid_from_parse_tree(struct acpi_namespace_node *hid_node);
558 char *mp_get_hid_via_namestring(char *device_name);
560 char *mp_get_connection_info(union acpi_parse_object *op,
562 struct acpi_namespace_node **target_node,
565 char *mp_get_parent_device_hid(union acpi_parse_object *op,
566 struct acpi_namespace_node **target_node,
567 char **parent_device_name);
569 char *mp_get_ddn_value(char *device_name);
571 char *mp_get_hid_value(struct acpi_namespace_node *device_node);