1/******************************************************************************
2 *
3 * Name: acrestyp.h - Defines, types, and structures for resource descriptors
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2019, Intel Corp.
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/*
49 * Definitions for Resource Attributes
50 */
51typedef UINT16 ACPI_RS_LENGTH; /* Resource Length field is fixed at 16 bits */
52typedef UINT32 ACPI_RSDESC_SIZE; /* Max Resource Descriptor size is (Length+3) = (64K-1)+3 */
53
54/*
55 * Memory Attributes
56 */
57#define ACPI_READ_ONLY_MEMORY (UINT8) 0x00
58#define ACPI_READ_WRITE_MEMORY (UINT8) 0x01
59
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
64
65/*! [Begin] no source code translation */
66/*
67 * IO Attributes
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.
70 */
71/*! [End] no source code translation !*/
72
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)
76
77/* Type of translation - 1=Sparse, 0=Dense */
78
79#define ACPI_SPARSE_TRANSLATION (UINT8) 0x01
80
81/*
82 * IO Port Descriptor Decode
83 */
84#define ACPI_DECODE_10 (UINT8) 0x00 /* 10-bit IO address decode */
85#define ACPI_DECODE_16 (UINT8) 0x01 /* 16-bit IO address decode */
86
87/*
88 * Interrupt attributes - used in multiple descriptors
89 */
90
91/* Triggering */
92
93#define ACPI_LEVEL_SENSITIVE (UINT8) 0x00
94#define ACPI_EDGE_SENSITIVE (UINT8) 0x01
95
96/* Polarity */
97
98#define ACPI_ACTIVE_HIGH (UINT8) 0x00
99#define ACPI_ACTIVE_LOW (UINT8) 0x01
100#define ACPI_ACTIVE_BOTH (UINT8) 0x02
101
102/* Sharing */
103
104#define ACPI_EXCLUSIVE (UINT8) 0x00
105#define ACPI_SHARED (UINT8) 0x01
106
107/* Wake */
108
109#define ACPI_NOT_WAKE_CAPABLE (UINT8) 0x00
110#define ACPI_WAKE_CAPABLE (UINT8) 0x01
111
112/*
113 * DMA Attributes
114 */
115#define ACPI_COMPATIBILITY (UINT8) 0x00
116#define ACPI_TYPE_A (UINT8) 0x01
117#define ACPI_TYPE_B (UINT8) 0x02
118#define ACPI_TYPE_F (UINT8) 0x03
119
120#define ACPI_NOT_BUS_MASTER (UINT8) 0x00
121#define ACPI_BUS_MASTER (UINT8) 0x01
122
123#define ACPI_TRANSFER_8 (UINT8) 0x00
124#define ACPI_TRANSFER_8_16 (UINT8) 0x01
125#define ACPI_TRANSFER_16 (UINT8) 0x02
126
127/*
128 * Start Dependent Functions Priority definitions
129 */
130#define ACPI_GOOD_CONFIGURATION (UINT8) 0x00
131#define ACPI_ACCEPTABLE_CONFIGURATION (UINT8) 0x01
132#define ACPI_SUB_OPTIMAL_CONFIGURATION (UINT8) 0x02
133
134/*
135 * 16, 32 and 64-bit Address Descriptor resource types
136 */
137#define ACPI_MEMORY_RANGE (UINT8) 0x00
138#define ACPI_IO_RANGE (UINT8) 0x01
139#define ACPI_BUS_NUMBER_RANGE (UINT8) 0x02
140
141#define ACPI_ADDRESS_NOT_FIXED (UINT8) 0x00
142#define ACPI_ADDRESS_FIXED (UINT8) 0x01
143
144#define ACPI_POS_DECODE (UINT8) 0x00
145#define ACPI_SUB_DECODE (UINT8) 0x01
146
147/* Producer/Consumer */
148
149#define ACPI_PRODUCER (UINT8) 0x00
150#define ACPI_CONSUMER (UINT8) 0x01
151
152
153/*
154 * If possible, pack the following structures to byte alignment
155 */
156#ifndef ACPI_MISALIGNMENT_NOT_SUPPORTED
157#pragma pack(1)
158#endif
159
160/* UUID data structures for use in vendor-defined resource descriptors */
161
162typedef struct acpi_uuid
163{
164 UINT8 Data[ACPI_UUID_LENGTH];
165} ACPI_UUID;
166
167typedef struct acpi_vendor_uuid
168{
169 UINT8 Subtype;
170 UINT8 Data[ACPI_UUID_LENGTH];
171
172} ACPI_VENDOR_UUID;
173
174/*
175 * Structures used to describe device resources
176 */
177typedef struct acpi_resource_irq
178{
179 UINT8 DescriptorLength;
180 UINT8 Triggering;
181 UINT8 Polarity;
182 UINT8 Shareable;
183 UINT8 WakeCapable;
184 UINT8 InterruptCount;
185 UINT8 Interrupts[1];
186
187} ACPI_RESOURCE_IRQ;
188
189typedef struct acpi_resource_dma
190{
191 UINT8 Type;
192 UINT8 BusMaster;
193 UINT8 Transfer;
194 UINT8 ChannelCount;
195 UINT8 Channels[1];
196
197} ACPI_RESOURCE_DMA;
198
199typedef struct acpi_resource_start_dependent
200{
201 UINT8 DescriptorLength;
202 UINT8 CompatibilityPriority;
203 UINT8 PerformanceRobustness;
204
205} ACPI_RESOURCE_START_DEPENDENT;
206
207
208/*
209 * The END_DEPENDENT_FUNCTIONS_RESOURCE struct is not
210 * needed because it has no fields
211 */
212
213
214typedef struct acpi_resource_io
215{
216 UINT8 IoDecode;
217 UINT8 Alignment;
218 UINT8 AddressLength;
219 UINT16 Minimum;
220 UINT16 Maximum;
221
222} ACPI_RESOURCE_IO;
223
224typedef struct acpi_resource_fixed_io
225{
226 UINT16 Address;
227 UINT8 AddressLength;
228
229} ACPI_RESOURCE_FIXED_IO;
230
231typedef struct acpi_resource_fixed_dma
232{
233 UINT16 RequestLines;
234 UINT16 Channels;
235 UINT8 Width;
236
237} ACPI_RESOURCE_FIXED_DMA;
238
239/* Values for Width field above */
240
241#define ACPI_DMA_WIDTH8 0
242#define ACPI_DMA_WIDTH16 1
243#define ACPI_DMA_WIDTH32 2
244#define ACPI_DMA_WIDTH64 3
245#define ACPI_DMA_WIDTH128 4
246#define ACPI_DMA_WIDTH256 5
247
248
249typedef struct acpi_resource_vendor
250{
251 UINT16 ByteLength;
252 UINT8 ByteData[1];
253
254} ACPI_RESOURCE_VENDOR;
255
256/* Vendor resource with UUID info (introduced in ACPI 3.0) */
257
258typedef struct acpi_resource_vendor_typed
259{
260 UINT16 ByteLength;
261 UINT8 UuidSubtype;
262 UINT8 Uuid[ACPI_UUID_LENGTH];
263 UINT8 ByteData[1];
264
265} ACPI_RESOURCE_VENDOR_TYPED;
266
267typedef struct acpi_resource_end_tag
268{
269 UINT8 Checksum;
270
271} ACPI_RESOURCE_END_TAG;
272
273typedef struct acpi_resource_memory24
274{
275 UINT8 WriteProtect;
276 UINT16 Minimum;
277 UINT16 Maximum;
278 UINT16 Alignment;
279 UINT16 AddressLength;
280
281} ACPI_RESOURCE_MEMORY24;
282
283typedef struct acpi_resource_memory32
284{
285 UINT8 WriteProtect;
286 UINT32 Minimum;
287 UINT32 Maximum;
288 UINT32 Alignment;
289 UINT32 AddressLength;
290
291} ACPI_RESOURCE_MEMORY32;
292
293typedef struct acpi_resource_fixed_memory32
294{
295 UINT8 WriteProtect;
296 UINT32 Address;
297 UINT32 AddressLength;
298
299} ACPI_RESOURCE_FIXED_MEMORY32;
300
301typedef struct acpi_memory_attribute
302{
303 UINT8 WriteProtect;
304 UINT8 Caching;
305 UINT8 RangeType;
306 UINT8 Translation;
307
308} ACPI_MEMORY_ATTRIBUTE;
309
310typedef struct acpi_io_attribute
311{
312 UINT8 RangeType;
313 UINT8 Translation;
314 UINT8 TranslationType;
315 UINT8 Reserved1;
316
317} ACPI_IO_ATTRIBUTE;
318
319typedef union acpi_resource_attribute
320{
321 ACPI_MEMORY_ATTRIBUTE Mem;
322 ACPI_IO_ATTRIBUTE Io;
323
324 /* Used for the *WordSpace macros */
325
326 UINT8 TypeSpecific;
327
328} ACPI_RESOURCE_ATTRIBUTE;
329
330typedef struct acpi_resource_label
331{
332 UINT16 StringLength;
333 char *StringPtr;
334
335} ACPI_RESOURCE_LABEL;
336
337typedef struct acpi_resource_source
338{
339 UINT8 Index;
340 UINT16 StringLength;
341 char *StringPtr;
342
343} ACPI_RESOURCE_SOURCE;
344
345/* Fields common to all address descriptors, 16/32/64 bit */
346
347#define ACPI_RESOURCE_ADDRESS_COMMON \
348 UINT8 ResourceType; \
349 UINT8 ProducerConsumer; \
350 UINT8 Decode; \
351 UINT8 MinAddressFixed; \
352 UINT8 MaxAddressFixed; \
353 ACPI_RESOURCE_ATTRIBUTE Info;
354
355typedef struct acpi_address16_attribute
356{
357 UINT16 Granularity;
358 UINT16 Minimum;
359 UINT16 Maximum;
360 UINT16 TranslationOffset;
361 UINT16 AddressLength;
362
363} ACPI_ADDRESS16_ATTRIBUTE;
364
365typedef struct acpi_address32_attribute
366{
367 UINT32 Granularity;
368 UINT32 Minimum;
369 UINT32 Maximum;
370 UINT32 TranslationOffset;
371 UINT32 AddressLength;
372
373} ACPI_ADDRESS32_ATTRIBUTE;
374
375typedef struct acpi_address64_attribute
376{
377 UINT64 Granularity;
378 UINT64 Minimum;
379 UINT64 Maximum;
380 UINT64 TranslationOffset;
381 UINT64 AddressLength;
382
383} ACPI_ADDRESS64_ATTRIBUTE;
384
385typedef struct acpi_resource_address
386{
387 ACPI_RESOURCE_ADDRESS_COMMON
388
389} ACPI_RESOURCE_ADDRESS;
390
391typedef struct acpi_resource_address16
392{
393 ACPI_RESOURCE_ADDRESS_COMMON
394 ACPI_ADDRESS16_ATTRIBUTE Address;
395 ACPI_RESOURCE_SOURCE ResourceSource;
396
397} ACPI_RESOURCE_ADDRESS16;
398
399typedef struct acpi_resource_address32
400{
401 ACPI_RESOURCE_ADDRESS_COMMON
402 ACPI_ADDRESS32_ATTRIBUTE Address;
403 ACPI_RESOURCE_SOURCE ResourceSource;
404
405} ACPI_RESOURCE_ADDRESS32;
406
407typedef struct acpi_resource_address64
408{
409 ACPI_RESOURCE_ADDRESS_COMMON
410 ACPI_ADDRESS64_ATTRIBUTE Address;
411 ACPI_RESOURCE_SOURCE ResourceSource;
412
413} ACPI_RESOURCE_ADDRESS64;
414
415typedef struct acpi_resource_extended_address64
416{
417 ACPI_RESOURCE_ADDRESS_COMMON
418 UINT8 RevisionID;
419 ACPI_ADDRESS64_ATTRIBUTE Address;
420 UINT64 TypeSpecific;
421
422} ACPI_RESOURCE_EXTENDED_ADDRESS64;
423
424typedef struct acpi_resource_extended_irq
425{
426 UINT8 ProducerConsumer;
427 UINT8 Triggering;
428 UINT8 Polarity;
429 UINT8 Shareable;
430 UINT8 WakeCapable;
431 UINT8 InterruptCount;
432 ACPI_RESOURCE_SOURCE ResourceSource;
433 UINT32 Interrupts[1];
434
435} ACPI_RESOURCE_EXTENDED_IRQ;
436
437typedef struct acpi_resource_generic_register
438{
439 UINT8 SpaceId;
440 UINT8 BitWidth;
441 UINT8 BitOffset;
442 UINT8 AccessSize;
443 UINT64 Address;
444
445} ACPI_RESOURCE_GENERIC_REGISTER;
446
447typedef struct acpi_resource_gpio
448{
449 UINT8 RevisionId;
450 UINT8 ConnectionType;
451 UINT8 ProducerConsumer; /* For values, see Producer/Consumer above */
452 UINT8 PinConfig;
453 UINT8 Shareable; /* For values, see Interrupt Attributes above */
454 UINT8 WakeCapable; /* For values, see Interrupt Attributes above */
455 UINT8 IoRestriction;
456 UINT8 Triggering; /* For values, see Interrupt Attributes above */
457 UINT8 Polarity; /* For values, see Interrupt Attributes above */
458 UINT16 DriveStrength;
459 UINT16 DebounceTimeout;
460 UINT16 PinTableLength;
461 UINT16 VendorLength;
462 ACPI_RESOURCE_SOURCE ResourceSource;
463 UINT16 *PinTable;
464 UINT8 *VendorData;
465
466} ACPI_RESOURCE_GPIO;
467
468/* Values for GPIO ConnectionType field above */
469
470#define ACPI_RESOURCE_GPIO_TYPE_INT 0
471#define ACPI_RESOURCE_GPIO_TYPE_IO 1
472
473/* Values for PinConfig field above */
474
475#define ACPI_PIN_CONFIG_DEFAULT 0
476#define ACPI_PIN_CONFIG_PULLUP 1
477#define ACPI_PIN_CONFIG_PULLDOWN 2
478#define ACPI_PIN_CONFIG_NOPULL 3
479
480/* Values for IoRestriction field above */
481
482#define ACPI_IO_RESTRICT_NONE 0
483#define ACPI_IO_RESTRICT_INPUT 1
484#define ACPI_IO_RESTRICT_OUTPUT 2
485#define ACPI_IO_RESTRICT_NONE_PRESERVE 3
486
487
488/* Common structure for I2C, SPI, and UART serial descriptors */
489
490#define ACPI_RESOURCE_SERIAL_COMMON \
491 UINT8 RevisionId; \
492 UINT8 Type; \
493 UINT8 ProducerConsumer; /* For values, see Producer/Consumer above */\
494 UINT8 SlaveMode; \
495 UINT8 ConnectionSharing; \
496 UINT8 TypeRevisionId; \
497 UINT16 TypeDataLength; \
498 UINT16 VendorLength; \
499 ACPI_RESOURCE_SOURCE ResourceSource; \
500 UINT8 *VendorData;
501
502typedef struct acpi_resource_common_serialbus
503{
504 ACPI_RESOURCE_SERIAL_COMMON
505
506} ACPI_RESOURCE_COMMON_SERIALBUS;
507
508/* Values for the Type field above */
509
510#define ACPI_RESOURCE_SERIAL_TYPE_I2C 1
511#define ACPI_RESOURCE_SERIAL_TYPE_SPI 2
512#define ACPI_RESOURCE_SERIAL_TYPE_UART 3
513
514/* Values for SlaveMode field above */
515
516#define ACPI_CONTROLLER_INITIATED 0
517#define ACPI_DEVICE_INITIATED 1
518
519
520typedef struct acpi_resource_i2c_serialbus
521{
522 ACPI_RESOURCE_SERIAL_COMMON
523 UINT8 AccessMode;
524 UINT16 SlaveAddress;
525 UINT32 ConnectionSpeed;
526
527} ACPI_RESOURCE_I2C_SERIALBUS;
528
529/* Values for AccessMode field above */
530
531#define ACPI_I2C_7BIT_MODE 0
532#define ACPI_I2C_10BIT_MODE 1
533
534
535typedef struct acpi_resource_spi_serialbus
536{
537 ACPI_RESOURCE_SERIAL_COMMON
538 UINT8 WireMode;
539 UINT8 DevicePolarity;
540 UINT8 DataBitLength;
541 UINT8 ClockPhase;
542 UINT8 ClockPolarity;
543 UINT16 DeviceSelection;
544 UINT32 ConnectionSpeed;
545
546} ACPI_RESOURCE_SPI_SERIALBUS;
547
548/* Values for WireMode field above */
549
550#define ACPI_SPI_4WIRE_MODE 0
551#define ACPI_SPI_3WIRE_MODE 1
552
553/* Values for DevicePolarity field above */
554
555#define ACPI_SPI_ACTIVE_LOW 0
556#define ACPI_SPI_ACTIVE_HIGH 1
557
558/* Values for ClockPhase field above */
559
560#define ACPI_SPI_FIRST_PHASE 0
561#define ACPI_SPI_SECOND_PHASE 1
562
563/* Values for ClockPolarity field above */
564
565#define ACPI_SPI_START_LOW 0
566#define ACPI_SPI_START_HIGH 1
567
568
569typedef struct acpi_resource_uart_serialbus
570{
571 ACPI_RESOURCE_SERIAL_COMMON
572 UINT8 Endian;
573 UINT8 DataBits;
574 UINT8 StopBits;
575 UINT8 FlowControl;
576 UINT8 Parity;
577 UINT8 LinesEnabled;
578 UINT16 RxFifoSize;
579 UINT16 TxFifoSize;
580 UINT32 DefaultBaudRate;
581
582} ACPI_RESOURCE_UART_SERIALBUS;
583
584/* Values for Endian field above */
585
586#define ACPI_UART_LITTLE_ENDIAN 0
587#define ACPI_UART_BIG_ENDIAN 1
588
589/* Values for DataBits field above */
590
591#define ACPI_UART_5_DATA_BITS 0
592#define ACPI_UART_6_DATA_BITS 1
593#define ACPI_UART_7_DATA_BITS 2
594#define ACPI_UART_8_DATA_BITS 3
595#define ACPI_UART_9_DATA_BITS 4
596
597/* Values for StopBits field above */
598
599#define ACPI_UART_NO_STOP_BITS 0
600#define ACPI_UART_1_STOP_BIT 1
601#define ACPI_UART_1P5_STOP_BITS 2
602#define ACPI_UART_2_STOP_BITS 3
603
604/* Values for FlowControl field above */
605
606#define ACPI_UART_FLOW_CONTROL_NONE 0
607#define ACPI_UART_FLOW_CONTROL_HW 1
608#define ACPI_UART_FLOW_CONTROL_XON_XOFF 2
609
610/* Values for Parity field above */
611
612#define ACPI_UART_PARITY_NONE 0
613#define ACPI_UART_PARITY_EVEN 1
614#define ACPI_UART_PARITY_ODD 2
615#define ACPI_UART_PARITY_MARK 3
616#define ACPI_UART_PARITY_SPACE 4
617
618/* Values for LinesEnabled bitfield above */
619
620#define ACPI_UART_CARRIER_DETECT (1<<2)
621#define ACPI_UART_RING_INDICATOR (1<<3)
622#define ACPI_UART_DATA_SET_READY (1<<4)
623#define ACPI_UART_DATA_TERMINAL_READY (1<<5)
624#define ACPI_UART_CLEAR_TO_SEND (1<<6)
625#define ACPI_UART_REQUEST_TO_SEND (1<<7)
626
627typedef struct acpi_resource_pin_function
628{
629 UINT8 RevisionId;
630 UINT8 PinConfig;
631 UINT8 Shareable; /* For values, see Interrupt Attributes above */
632 UINT16 FunctionNumber;
633 UINT16 PinTableLength;
634 UINT16 VendorLength;
635 ACPI_RESOURCE_SOURCE ResourceSource;
636 UINT16 *PinTable;
637 UINT8 *VendorData;
638
639} ACPI_RESOURCE_PIN_FUNCTION;
640
641typedef struct acpi_resource_pin_config
642{
643 UINT8 RevisionId;
644 UINT8 ProducerConsumer; /* For values, see Producer/Consumer above */
645 UINT8 Shareable; /* For values, see Interrupt Attributes above */
646 UINT8 PinConfigType;
647 UINT32 PinConfigValue;
648 UINT16 PinTableLength;
649 UINT16 VendorLength;
650 ACPI_RESOURCE_SOURCE ResourceSource;
651 UINT16 *PinTable;
652 UINT8 *VendorData;
653
654} ACPI_RESOURCE_PIN_CONFIG;
655
656/* Values for PinConfigType field above */
657
658#define ACPI_PIN_CONFIG_DEFAULT 0
659#define ACPI_PIN_CONFIG_BIAS_PULL_UP 1
660#define ACPI_PIN_CONFIG_BIAS_PULL_DOWN 2
661#define ACPI_PIN_CONFIG_BIAS_DEFAULT 3
662#define ACPI_PIN_CONFIG_BIAS_DISABLE 4
663#define ACPI_PIN_CONFIG_BIAS_HIGH_IMPEDANCE 5
664#define ACPI_PIN_CONFIG_BIAS_BUS_HOLD 6
665#define ACPI_PIN_CONFIG_DRIVE_OPEN_DRAIN 7
666#define ACPI_PIN_CONFIG_DRIVE_OPEN_SOURCE 8
667#define ACPI_PIN_CONFIG_DRIVE_PUSH_PULL 9
668#define ACPI_PIN_CONFIG_DRIVE_STRENGTH 10
669#define ACPI_PIN_CONFIG_SLEW_RATE 11
670#define ACPI_PIN_CONFIG_INPUT_DEBOUNCE 12
671#define ACPI_PIN_CONFIG_INPUT_SCHMITT_TRIGGER 13
672
673typedef struct acpi_resource_pin_group
674{
675 UINT8 RevisionId;
676 UINT8 ProducerConsumer; /* For values, see Producer/Consumer above */
677 UINT16 PinTableLength;
678 UINT16 VendorLength;
679 UINT16 *PinTable;
680 ACPI_RESOURCE_LABEL ResourceLabel;
681 UINT8 *VendorData;
682
683} ACPI_RESOURCE_PIN_GROUP;
684
685typedef struct acpi_resource_pin_group_function
686{
687 UINT8 RevisionId;
688 UINT8 ProducerConsumer; /* For values, see Producer/Consumer above */
689 UINT8 Shareable; /* For values, see Interrupt Attributes above */
690 UINT16 FunctionNumber;
691 UINT16 VendorLength;
692 ACPI_RESOURCE_SOURCE ResourceSource;
693 ACPI_RESOURCE_LABEL ResourceSourceLabel;
694 UINT8 *VendorData;
695
696} ACPI_RESOURCE_PIN_GROUP_FUNCTION;
697
698typedef struct acpi_resource_pin_group_config
699{
700 UINT8 RevisionId;
701 UINT8 ProducerConsumer; /* For values, see Producer/Consumer above */
702 UINT8 Shareable; /* For values, see Interrupt Attributes above */
703 UINT8 PinConfigType; /* For values, see PinConfigType above */
704 UINT32 PinConfigValue;
705 UINT16 VendorLength;
706 ACPI_RESOURCE_SOURCE ResourceSource;
707 ACPI_RESOURCE_LABEL ResourceSourceLabel;
708 UINT8 *VendorData;
709
710} ACPI_RESOURCE_PIN_GROUP_CONFIG;
711
712/* ACPI_RESOURCE_TYPEs */
713
714#define ACPI_RESOURCE_TYPE_IRQ 0
715#define ACPI_RESOURCE_TYPE_DMA 1
716#define ACPI_RESOURCE_TYPE_START_DEPENDENT 2
717#define ACPI_RESOURCE_TYPE_END_DEPENDENT 3
718#define ACPI_RESOURCE_TYPE_IO 4
719#define ACPI_RESOURCE_TYPE_FIXED_IO 5
720#define ACPI_RESOURCE_TYPE_VENDOR 6
721#define ACPI_RESOURCE_TYPE_END_TAG 7
722#define ACPI_RESOURCE_TYPE_MEMORY24 8
723#define ACPI_RESOURCE_TYPE_MEMORY32 9
724#define ACPI_RESOURCE_TYPE_FIXED_MEMORY32 10
725#define ACPI_RESOURCE_TYPE_ADDRESS16 11
726#define ACPI_RESOURCE_TYPE_ADDRESS32 12
727#define ACPI_RESOURCE_TYPE_ADDRESS64 13
728#define ACPI_RESOURCE_TYPE_EXTENDED_ADDRESS64 14 /* ACPI 3.0 */
729#define ACPI_RESOURCE_TYPE_EXTENDED_IRQ 15
730#define ACPI_RESOURCE_TYPE_GENERIC_REGISTER 16
731#define ACPI_RESOURCE_TYPE_GPIO 17 /* ACPI 5.0 */
732#define ACPI_RESOURCE_TYPE_FIXED_DMA 18 /* ACPI 5.0 */
733#define ACPI_RESOURCE_TYPE_SERIAL_BUS 19 /* ACPI 5.0 */
734#define ACPI_RESOURCE_TYPE_PIN_FUNCTION 20 /* ACPI 6.2 */
735#define ACPI_RESOURCE_TYPE_PIN_CONFIG 21 /* ACPI 6.2 */
736#define ACPI_RESOURCE_TYPE_PIN_GROUP 22 /* ACPI 6.2 */
737#define ACPI_RESOURCE_TYPE_PIN_GROUP_FUNCTION 23 /* ACPI 6.2 */
738#define ACPI_RESOURCE_TYPE_PIN_GROUP_CONFIG 24 /* ACPI 6.2 */
739#define ACPI_RESOURCE_TYPE_MAX 24
740
741/* Master union for resource descriptors */
742
743typedef union acpi_resource_data
744{
745 ACPI_RESOURCE_IRQ Irq;
746 ACPI_RESOURCE_DMA Dma;
747 ACPI_RESOURCE_START_DEPENDENT StartDpf;
748 ACPI_RESOURCE_IO Io;
749 ACPI_RESOURCE_FIXED_IO FixedIo;
750 ACPI_RESOURCE_FIXED_DMA FixedDma;
751 ACPI_RESOURCE_VENDOR Vendor;
752 ACPI_RESOURCE_VENDOR_TYPED VendorTyped;
753 ACPI_RESOURCE_END_TAG EndTag;
754 ACPI_RESOURCE_MEMORY24 Memory24;
755 ACPI_RESOURCE_MEMORY32 Memory32;
756 ACPI_RESOURCE_FIXED_MEMORY32 FixedMemory32;
757 ACPI_RESOURCE_ADDRESS16 Address16;
758 ACPI_RESOURCE_ADDRESS32 Address32;
759 ACPI_RESOURCE_ADDRESS64 Address64;
760 ACPI_RESOURCE_EXTENDED_ADDRESS64 ExtAddress64;
761 ACPI_RESOURCE_EXTENDED_IRQ ExtendedIrq;
762 ACPI_RESOURCE_GENERIC_REGISTER GenericReg;
763 ACPI_RESOURCE_GPIO Gpio;
764 ACPI_RESOURCE_I2C_SERIALBUS I2cSerialBus;
765 ACPI_RESOURCE_SPI_SERIALBUS SpiSerialBus;
766 ACPI_RESOURCE_UART_SERIALBUS UartSerialBus;
767 ACPI_RESOURCE_COMMON_SERIALBUS CommonSerialBus;
768 ACPI_RESOURCE_PIN_FUNCTION PinFunction;
769 ACPI_RESOURCE_PIN_CONFIG PinConfig;
770 ACPI_RESOURCE_PIN_GROUP PinGroup;
771 ACPI_RESOURCE_PIN_GROUP_FUNCTION PinGroupFunction;
772 ACPI_RESOURCE_PIN_GROUP_CONFIG PinGroupConfig;
773
774 /* Common fields */
775
776 ACPI_RESOURCE_ADDRESS Address; /* Common 16/32/64 address fields */
777
778} ACPI_RESOURCE_DATA;
779
780
781/* Common resource header */
782
783typedef struct acpi_resource
784{
785 UINT32 Type;
786 UINT32 Length;
787 ACPI_RESOURCE_DATA Data;
788
789} ACPI_RESOURCE;
790
791/* restore default alignment */
792
793#pragma pack()
794
795
796#define ACPI_RS_SIZE_NO_DATA 8 /* Id + Length fields */
797#define ACPI_RS_SIZE_MIN (UINT32) ACPI_ROUND_UP_TO_NATIVE_WORD (12)
798#define ACPI_RS_SIZE(Type) (UINT32) (ACPI_RS_SIZE_NO_DATA + sizeof (Type))
799
800/* Macro for walking resource templates with multiple descriptors */
801
802#define ACPI_NEXT_RESOURCE(Res) \
803 ACPI_ADD_PTR (ACPI_RESOURCE, (Res), (Res)->Length)
804
805
806typedef struct acpi_pci_routing_table
807{
808 UINT32 Length;
809 UINT32 Pin;
810 UINT64 Address; /* here for 64-bit alignment */
811 UINT32 SourceIndex;
812 char Source[4]; /* pad to 64 bits so sizeof() works in all cases */
813
814} ACPI_PCI_ROUTING_TABLE;
815
816#endif /* __ACRESTYP_H__ */
817