xref: /openbmc/linux/include/acpi/actbl2.h (revision 84d517f3)
1 /******************************************************************************
2  *
3  * Name: actbl2.h - ACPI Table Definitions (tables not in ACPI spec)
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2014, 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 __ACTBL2_H__
45 #define __ACTBL2_H__
46 
47 /*******************************************************************************
48  *
49  * Additional ACPI Tables (2)
50  *
51  * These tables are not consumed directly by the ACPICA subsystem, but are
52  * included here to support device drivers and the AML disassembler.
53  *
54  * The tables in this file are defined by third-party specifications, and are
55  * not defined directly by the ACPI specification itself.
56  *
57  ******************************************************************************/
58 
59 /*
60  * Values for description table header signatures for tables defined in this
61  * file. Useful because they make it more difficult to inadvertently type in
62  * the wrong signature.
63  */
64 #define ACPI_SIG_ASF            "ASF!"	/* Alert Standard Format table */
65 #define ACPI_SIG_BOOT           "BOOT"	/* Simple Boot Flag Table */
66 #define ACPI_SIG_CSRT           "CSRT"	/* Core System Resource Table */
67 #define ACPI_SIG_DBG2           "DBG2"	/* Debug Port table type 2 */
68 #define ACPI_SIG_DBGP           "DBGP"	/* Debug Port table */
69 #define ACPI_SIG_DMAR           "DMAR"	/* DMA Remapping table */
70 #define ACPI_SIG_HPET           "HPET"	/* High Precision Event Timer table */
71 #define ACPI_SIG_IBFT           "IBFT"	/* iSCSI Boot Firmware Table */
72 #define ACPI_SIG_IVRS           "IVRS"	/* I/O Virtualization Reporting Structure */
73 #define ACPI_SIG_LPIT           "LPIT"	/* Low Power Idle Table */
74 #define ACPI_SIG_MCFG           "MCFG"	/* PCI Memory Mapped Configuration table */
75 #define ACPI_SIG_MCHI           "MCHI"	/* Management Controller Host Interface table */
76 #define ACPI_SIG_MTMR           "MTMR"	/* MID Timer table */
77 #define ACPI_SIG_SLIC           "SLIC"	/* Software Licensing Description Table */
78 #define ACPI_SIG_SPCR           "SPCR"	/* Serial Port Console Redirection table */
79 #define ACPI_SIG_SPMI           "SPMI"	/* Server Platform Management Interface table */
80 #define ACPI_SIG_TCPA           "TCPA"	/* Trusted Computing Platform Alliance table */
81 #define ACPI_SIG_UEFI           "UEFI"	/* Uefi Boot Optimization Table */
82 #define ACPI_SIG_VRTC           "VRTC"	/* Virtual Real Time Clock Table */
83 #define ACPI_SIG_WAET           "WAET"	/* Windows ACPI Emulated devices Table */
84 #define ACPI_SIG_WDAT           "WDAT"	/* Watchdog Action Table */
85 #define ACPI_SIG_WDDT           "WDDT"	/* Watchdog Timer Description Table */
86 #define ACPI_SIG_WDRT           "WDRT"	/* Watchdog Resource Table */
87 
88 #ifdef ACPI_UNDEFINED_TABLES
89 /*
90  * These tables have been seen in the field, but no definition has been found
91  */
92 #define ACPI_SIG_ATKG           "ATKG"
93 #define ACPI_SIG_GSCI           "GSCI"	/* GMCH SCI table */
94 #define ACPI_SIG_IEIT           "IEIT"
95 #endif
96 
97 /*
98  * All tables must be byte-packed to match the ACPI specification, since
99  * the tables are provided by the system BIOS.
100  */
101 #pragma pack(1)
102 
103 /*
104  * Note: C bitfields are not used for this reason:
105  *
106  * "Bitfields are great and easy to read, but unfortunately the C language
107  * does not specify the layout of bitfields in memory, which means they are
108  * essentially useless for dealing with packed data in on-disk formats or
109  * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
110  * this decision was a design error in C. Ritchie could have picked an order
111  * and stuck with it." Norman Ramsey.
112  * See http://stackoverflow.com/a/1053662/41661
113  */
114 
115 /*******************************************************************************
116  *
117  * ASF - Alert Standard Format table (Signature "ASF!")
118  *       Revision 0x10
119  *
120  * Conforms to the Alert Standard Format Specification V2.0, 23 April 2003
121  *
122  ******************************************************************************/
123 
124 struct acpi_table_asf {
125 	struct acpi_table_header header;	/* Common ACPI table header */
126 };
127 
128 /* ASF subtable header */
129 
130 struct acpi_asf_header {
131 	u8 type;
132 	u8 reserved;
133 	u16 length;
134 };
135 
136 /* Values for Type field above */
137 
138 enum acpi_asf_type {
139 	ACPI_ASF_TYPE_INFO = 0,
140 	ACPI_ASF_TYPE_ALERT = 1,
141 	ACPI_ASF_TYPE_CONTROL = 2,
142 	ACPI_ASF_TYPE_BOOT = 3,
143 	ACPI_ASF_TYPE_ADDRESS = 4,
144 	ACPI_ASF_TYPE_RESERVED = 5
145 };
146 
147 /*
148  * ASF subtables
149  */
150 
151 /* 0: ASF Information */
152 
153 struct acpi_asf_info {
154 	struct acpi_asf_header header;
155 	u8 min_reset_value;
156 	u8 min_poll_interval;
157 	u16 system_id;
158 	u32 mfg_id;
159 	u8 flags;
160 	u8 reserved2[3];
161 };
162 
163 /* Masks for Flags field above */
164 
165 #define ACPI_ASF_SMBUS_PROTOCOLS    (1)
166 
167 /* 1: ASF Alerts */
168 
169 struct acpi_asf_alert {
170 	struct acpi_asf_header header;
171 	u8 assert_mask;
172 	u8 deassert_mask;
173 	u8 alerts;
174 	u8 data_length;
175 };
176 
177 struct acpi_asf_alert_data {
178 	u8 address;
179 	u8 command;
180 	u8 mask;
181 	u8 value;
182 	u8 sensor_type;
183 	u8 type;
184 	u8 offset;
185 	u8 source_type;
186 	u8 severity;
187 	u8 sensor_number;
188 	u8 entity;
189 	u8 instance;
190 };
191 
192 /* 2: ASF Remote Control */
193 
194 struct acpi_asf_remote {
195 	struct acpi_asf_header header;
196 	u8 controls;
197 	u8 data_length;
198 	u16 reserved2;
199 };
200 
201 struct acpi_asf_control_data {
202 	u8 function;
203 	u8 address;
204 	u8 command;
205 	u8 value;
206 };
207 
208 /* 3: ASF RMCP Boot Options */
209 
210 struct acpi_asf_rmcp {
211 	struct acpi_asf_header header;
212 	u8 capabilities[7];
213 	u8 completion_code;
214 	u32 enterprise_id;
215 	u8 command;
216 	u16 parameter;
217 	u16 boot_options;
218 	u16 oem_parameters;
219 };
220 
221 /* 4: ASF Address */
222 
223 struct acpi_asf_address {
224 	struct acpi_asf_header header;
225 	u8 eprom_address;
226 	u8 devices;
227 };
228 
229 /*******************************************************************************
230  *
231  * BOOT - Simple Boot Flag Table
232  *        Version 1
233  *
234  * Conforms to the "Simple Boot Flag Specification", Version 2.1
235  *
236  ******************************************************************************/
237 
238 struct acpi_table_boot {
239 	struct acpi_table_header header;	/* Common ACPI table header */
240 	u8 cmos_index;		/* Index in CMOS RAM for the boot register */
241 	u8 reserved[3];
242 };
243 
244 /*******************************************************************************
245  *
246  * CSRT - Core System Resource Table
247  *        Version 0
248  *
249  * Conforms to the "Core System Resource Table (CSRT)", November 14, 2011
250  *
251  ******************************************************************************/
252 
253 struct acpi_table_csrt {
254 	struct acpi_table_header header;	/* Common ACPI table header */
255 };
256 
257 /* Resource Group subtable */
258 
259 struct acpi_csrt_group {
260 	u32 length;
261 	u32 vendor_id;
262 	u32 subvendor_id;
263 	u16 device_id;
264 	u16 subdevice_id;
265 	u16 revision;
266 	u16 reserved;
267 	u32 shared_info_length;
268 
269 	/* Shared data immediately follows (Length = shared_info_length) */
270 };
271 
272 /* Shared Info subtable */
273 
274 struct acpi_csrt_shared_info {
275 	u16 major_version;
276 	u16 minor_version;
277 	u32 mmio_base_low;
278 	u32 mmio_base_high;
279 	u32 gsi_interrupt;
280 	u8 interrupt_polarity;
281 	u8 interrupt_mode;
282 	u8 num_channels;
283 	u8 dma_address_width;
284 	u16 base_request_line;
285 	u16 num_handshake_signals;
286 	u32 max_block_size;
287 
288 	/* Resource descriptors immediately follow (Length = Group length - shared_info_length) */
289 };
290 
291 /* Resource Descriptor subtable */
292 
293 struct acpi_csrt_descriptor {
294 	u32 length;
295 	u16 type;
296 	u16 subtype;
297 	u32 uid;
298 
299 	/* Resource-specific information immediately follows */
300 };
301 
302 /* Resource Types */
303 
304 #define ACPI_CSRT_TYPE_INTERRUPT    0x0001
305 #define ACPI_CSRT_TYPE_TIMER        0x0002
306 #define ACPI_CSRT_TYPE_DMA          0x0003
307 
308 /* Resource Subtypes */
309 
310 #define ACPI_CSRT_XRUPT_LINE        0x0000
311 #define ACPI_CSRT_XRUPT_CONTROLLER  0x0001
312 #define ACPI_CSRT_TIMER             0x0000
313 #define ACPI_CSRT_DMA_CHANNEL       0x0000
314 #define ACPI_CSRT_DMA_CONTROLLER    0x0001
315 
316 /*******************************************************************************
317  *
318  * DBG2 - Debug Port Table 2
319  *        Version 0 (Both main table and subtables)
320  *
321  * Conforms to "Microsoft Debug Port Table 2 (DBG2)", May 22 2012.
322  *
323  ******************************************************************************/
324 
325 struct acpi_table_dbg2 {
326 	struct acpi_table_header header;	/* Common ACPI table header */
327 	u32 info_offset;
328 	u32 info_count;
329 };
330 
331 struct acpi_dbg2_header {
332 	u32 info_offset;
333 	u32 info_count;
334 };
335 
336 /* Debug Device Information Subtable */
337 
338 struct acpi_dbg2_device {
339 	u8 revision;
340 	u16 length;
341 	u8 register_count;	/* Number of base_address registers */
342 	u16 namepath_length;
343 	u16 namepath_offset;
344 	u16 oem_data_length;
345 	u16 oem_data_offset;
346 	u16 port_type;
347 	u16 port_subtype;
348 	u16 reserved;
349 	u16 base_address_offset;
350 	u16 address_size_offset;
351 	/*
352 	 * Data that follows:
353 	 *    base_address (required) - Each in 12-byte Generic Address Structure format.
354 	 *    address_size (required) - Array of u32 sizes corresponding to each base_address register.
355 	 *    Namepath    (required) - Null terminated string. Single dot if not supported.
356 	 *    oem_data    (optional) - Length is oem_data_length.
357 	 */
358 };
359 
360 /* Types for port_type field above */
361 
362 #define ACPI_DBG2_SERIAL_PORT       0x8000
363 #define ACPI_DBG2_1394_PORT         0x8001
364 #define ACPI_DBG2_USB_PORT          0x8002
365 #define ACPI_DBG2_NET_PORT          0x8003
366 
367 /* Subtypes for port_subtype field above */
368 
369 #define ACPI_DBG2_16550_COMPATIBLE  0x0000
370 #define ACPI_DBG2_16550_SUBSET      0x0001
371 
372 #define ACPI_DBG2_1394_STANDARD     0x0000
373 
374 #define ACPI_DBG2_USB_XHCI          0x0000
375 #define ACPI_DBG2_USB_EHCI          0x0001
376 
377 /*******************************************************************************
378  *
379  * DBGP - Debug Port table
380  *        Version 1
381  *
382  * Conforms to the "Debug Port Specification", Version 1.00, 2/9/2000
383  *
384  ******************************************************************************/
385 
386 struct acpi_table_dbgp {
387 	struct acpi_table_header header;	/* Common ACPI table header */
388 	u8 type;		/* 0=full 16550, 1=subset of 16550 */
389 	u8 reserved[3];
390 	struct acpi_generic_address debug_port;
391 };
392 
393 /*******************************************************************************
394  *
395  * DMAR - DMA Remapping table
396  *        Version 1
397  *
398  * Conforms to "Intel Virtualization Technology for Directed I/O",
399  * Version 1.2, Sept. 2008
400  *
401  ******************************************************************************/
402 
403 struct acpi_table_dmar {
404 	struct acpi_table_header header;	/* Common ACPI table header */
405 	u8 width;		/* Host Address Width */
406 	u8 flags;
407 	u8 reserved[10];
408 };
409 
410 /* Masks for Flags field above */
411 
412 #define ACPI_DMAR_INTR_REMAP        (1)
413 
414 /* DMAR subtable header */
415 
416 struct acpi_dmar_header {
417 	u16 type;
418 	u16 length;
419 };
420 
421 /* Values for subtable type in struct acpi_dmar_header */
422 
423 enum acpi_dmar_type {
424 	ACPI_DMAR_TYPE_HARDWARE_UNIT = 0,
425 	ACPI_DMAR_TYPE_RESERVED_MEMORY = 1,
426 	ACPI_DMAR_TYPE_ATSR = 2,
427 	ACPI_DMAR_HARDWARE_AFFINITY = 3,
428 	ACPI_DMAR_TYPE_ANDD = 4,
429 	ACPI_DMAR_TYPE_RESERVED = 5	/* 5 and greater are reserved */
430 };
431 
432 /* DMAR Device Scope structure */
433 
434 struct acpi_dmar_device_scope {
435 	u8 entry_type;
436 	u8 length;
437 	u16 reserved;
438 	u8 enumeration_id;
439 	u8 bus;
440 };
441 
442 /* Values for entry_type in struct acpi_dmar_device_scope */
443 
444 enum acpi_dmar_scope_type {
445 	ACPI_DMAR_SCOPE_TYPE_NOT_USED = 0,
446 	ACPI_DMAR_SCOPE_TYPE_ENDPOINT = 1,
447 	ACPI_DMAR_SCOPE_TYPE_BRIDGE = 2,
448 	ACPI_DMAR_SCOPE_TYPE_IOAPIC = 3,
449 	ACPI_DMAR_SCOPE_TYPE_HPET = 4,
450 	ACPI_DMAR_SCOPE_TYPE_ACPI = 5,
451 	ACPI_DMAR_SCOPE_TYPE_RESERVED = 6	/* 6 and greater are reserved */
452 };
453 
454 struct acpi_dmar_pci_path {
455 	u8 device;
456 	u8 function;
457 };
458 
459 /*
460  * DMAR Subtables, correspond to Type in struct acpi_dmar_header
461  */
462 
463 /* 0: Hardware Unit Definition */
464 
465 struct acpi_dmar_hardware_unit {
466 	struct acpi_dmar_header header;
467 	u8 flags;
468 	u8 reserved;
469 	u16 segment;
470 	u64 address;		/* Register Base Address */
471 };
472 
473 /* Masks for Flags field above */
474 
475 #define ACPI_DMAR_INCLUDE_ALL       (1)
476 
477 /* 1: Reserved Memory Defininition */
478 
479 struct acpi_dmar_reserved_memory {
480 	struct acpi_dmar_header header;
481 	u16 reserved;
482 	u16 segment;
483 	u64 base_address;	/* 4K aligned base address */
484 	u64 end_address;	/* 4K aligned limit address */
485 };
486 
487 /* Masks for Flags field above */
488 
489 #define ACPI_DMAR_ALLOW_ALL         (1)
490 
491 /* 2: Root Port ATS Capability Reporting Structure */
492 
493 struct acpi_dmar_atsr {
494 	struct acpi_dmar_header header;
495 	u8 flags;
496 	u8 reserved;
497 	u16 segment;
498 };
499 
500 /* Masks for Flags field above */
501 
502 #define ACPI_DMAR_ALL_PORTS         (1)
503 
504 /* 3: Remapping Hardware Static Affinity Structure */
505 
506 struct acpi_dmar_rhsa {
507 	struct acpi_dmar_header header;
508 	u32 reserved;
509 	u64 base_address;
510 	u32 proximity_domain;
511 };
512 
513 /* 4: ACPI Namespace Device Declaration Structure */
514 
515 struct acpi_dmar_andd {
516 	struct acpi_dmar_header header;
517 	u8 reserved[3];
518 	u8 device_number;
519 	u8 object_name[];
520 };
521 
522 /*******************************************************************************
523  *
524  * HPET - High Precision Event Timer table
525  *        Version 1
526  *
527  * Conforms to "IA-PC HPET (High Precision Event Timers) Specification",
528  * Version 1.0a, October 2004
529  *
530  ******************************************************************************/
531 
532 struct acpi_table_hpet {
533 	struct acpi_table_header header;	/* Common ACPI table header */
534 	u32 id;			/* Hardware ID of event timer block */
535 	struct acpi_generic_address address;	/* Address of event timer block */
536 	u8 sequence;		/* HPET sequence number */
537 	u16 minimum_tick;	/* Main counter min tick, periodic mode */
538 	u8 flags;
539 };
540 
541 /* Masks for Flags field above */
542 
543 #define ACPI_HPET_PAGE_PROTECT_MASK (3)
544 
545 /* Values for Page Protect flags */
546 
547 enum acpi_hpet_page_protect {
548 	ACPI_HPET_NO_PAGE_PROTECT = 0,
549 	ACPI_HPET_PAGE_PROTECT4 = 1,
550 	ACPI_HPET_PAGE_PROTECT64 = 2
551 };
552 
553 /*******************************************************************************
554  *
555  * IBFT - Boot Firmware Table
556  *        Version 1
557  *
558  * Conforms to "iSCSI Boot Firmware Table (iBFT) as Defined in ACPI 3.0b
559  * Specification", Version 1.01, March 1, 2007
560  *
561  * Note: It appears that this table is not intended to appear in the RSDT/XSDT.
562  * Therefore, it is not currently supported by the disassembler.
563  *
564  ******************************************************************************/
565 
566 struct acpi_table_ibft {
567 	struct acpi_table_header header;	/* Common ACPI table header */
568 	u8 reserved[12];
569 };
570 
571 /* IBFT common subtable header */
572 
573 struct acpi_ibft_header {
574 	u8 type;
575 	u8 version;
576 	u16 length;
577 	u8 index;
578 	u8 flags;
579 };
580 
581 /* Values for Type field above */
582 
583 enum acpi_ibft_type {
584 	ACPI_IBFT_TYPE_NOT_USED = 0,
585 	ACPI_IBFT_TYPE_CONTROL = 1,
586 	ACPI_IBFT_TYPE_INITIATOR = 2,
587 	ACPI_IBFT_TYPE_NIC = 3,
588 	ACPI_IBFT_TYPE_TARGET = 4,
589 	ACPI_IBFT_TYPE_EXTENSIONS = 5,
590 	ACPI_IBFT_TYPE_RESERVED = 6	/* 6 and greater are reserved */
591 };
592 
593 /* IBFT subtables */
594 
595 struct acpi_ibft_control {
596 	struct acpi_ibft_header header;
597 	u16 extensions;
598 	u16 initiator_offset;
599 	u16 nic0_offset;
600 	u16 target0_offset;
601 	u16 nic1_offset;
602 	u16 target1_offset;
603 };
604 
605 struct acpi_ibft_initiator {
606 	struct acpi_ibft_header header;
607 	u8 sns_server[16];
608 	u8 slp_server[16];
609 	u8 primary_server[16];
610 	u8 secondary_server[16];
611 	u16 name_length;
612 	u16 name_offset;
613 };
614 
615 struct acpi_ibft_nic {
616 	struct acpi_ibft_header header;
617 	u8 ip_address[16];
618 	u8 subnet_mask_prefix;
619 	u8 origin;
620 	u8 gateway[16];
621 	u8 primary_dns[16];
622 	u8 secondary_dns[16];
623 	u8 dhcp[16];
624 	u16 vlan;
625 	u8 mac_address[6];
626 	u16 pci_address;
627 	u16 name_length;
628 	u16 name_offset;
629 };
630 
631 struct acpi_ibft_target {
632 	struct acpi_ibft_header header;
633 	u8 target_ip_address[16];
634 	u16 target_ip_socket;
635 	u8 target_boot_lun[8];
636 	u8 chap_type;
637 	u8 nic_association;
638 	u16 target_name_length;
639 	u16 target_name_offset;
640 	u16 chap_name_length;
641 	u16 chap_name_offset;
642 	u16 chap_secret_length;
643 	u16 chap_secret_offset;
644 	u16 reverse_chap_name_length;
645 	u16 reverse_chap_name_offset;
646 	u16 reverse_chap_secret_length;
647 	u16 reverse_chap_secret_offset;
648 };
649 
650 /*******************************************************************************
651  *
652  * IVRS - I/O Virtualization Reporting Structure
653  *        Version 1
654  *
655  * Conforms to "AMD I/O Virtualization Technology (IOMMU) Specification",
656  * Revision 1.26, February 2009.
657  *
658  ******************************************************************************/
659 
660 struct acpi_table_ivrs {
661 	struct acpi_table_header header;	/* Common ACPI table header */
662 	u32 info;		/* Common virtualization info */
663 	u64 reserved;
664 };
665 
666 /* Values for Info field above */
667 
668 #define ACPI_IVRS_PHYSICAL_SIZE     0x00007F00	/* 7 bits, physical address size */
669 #define ACPI_IVRS_VIRTUAL_SIZE      0x003F8000	/* 7 bits, virtual address size */
670 #define ACPI_IVRS_ATS_RESERVED      0x00400000	/* ATS address translation range reserved */
671 
672 /* IVRS subtable header */
673 
674 struct acpi_ivrs_header {
675 	u8 type;		/* Subtable type */
676 	u8 flags;
677 	u16 length;		/* Subtable length */
678 	u16 device_id;		/* ID of IOMMU */
679 };
680 
681 /* Values for subtable Type above */
682 
683 enum acpi_ivrs_type {
684 	ACPI_IVRS_TYPE_HARDWARE = 0x10,
685 	ACPI_IVRS_TYPE_MEMORY1 = 0x20,
686 	ACPI_IVRS_TYPE_MEMORY2 = 0x21,
687 	ACPI_IVRS_TYPE_MEMORY3 = 0x22
688 };
689 
690 /* Masks for Flags field above for IVHD subtable */
691 
692 #define ACPI_IVHD_TT_ENABLE         (1)
693 #define ACPI_IVHD_PASS_PW           (1<<1)
694 #define ACPI_IVHD_RES_PASS_PW       (1<<2)
695 #define ACPI_IVHD_ISOC              (1<<3)
696 #define ACPI_IVHD_IOTLB             (1<<4)
697 
698 /* Masks for Flags field above for IVMD subtable */
699 
700 #define ACPI_IVMD_UNITY             (1)
701 #define ACPI_IVMD_READ              (1<<1)
702 #define ACPI_IVMD_WRITE             (1<<2)
703 #define ACPI_IVMD_EXCLUSION_RANGE   (1<<3)
704 
705 /*
706  * IVRS subtables, correspond to Type in struct acpi_ivrs_header
707  */
708 
709 /* 0x10: I/O Virtualization Hardware Definition Block (IVHD) */
710 
711 struct acpi_ivrs_hardware {
712 	struct acpi_ivrs_header header;
713 	u16 capability_offset;	/* Offset for IOMMU control fields */
714 	u64 base_address;	/* IOMMU control registers */
715 	u16 pci_segment_group;
716 	u16 info;		/* MSI number and unit ID */
717 	u32 reserved;
718 };
719 
720 /* Masks for Info field above */
721 
722 #define ACPI_IVHD_MSI_NUMBER_MASK   0x001F	/* 5 bits, MSI message number */
723 #define ACPI_IVHD_UNIT_ID_MASK      0x1F00	/* 5 bits, unit_ID */
724 
725 /*
726  * Device Entries for IVHD subtable, appear after struct acpi_ivrs_hardware structure.
727  * Upper two bits of the Type field are the (encoded) length of the structure.
728  * Currently, only 4 and 8 byte entries are defined. 16 and 32 byte entries
729  * are reserved for future use but not defined.
730  */
731 struct acpi_ivrs_de_header {
732 	u8 type;
733 	u16 id;
734 	u8 data_setting;
735 };
736 
737 /* Length of device entry is in the top two bits of Type field above */
738 
739 #define ACPI_IVHD_ENTRY_LENGTH      0xC0
740 
741 /* Values for device entry Type field above */
742 
743 enum acpi_ivrs_device_entry_type {
744 	/* 4-byte device entries, all use struct acpi_ivrs_device4 */
745 
746 	ACPI_IVRS_TYPE_PAD4 = 0,
747 	ACPI_IVRS_TYPE_ALL = 1,
748 	ACPI_IVRS_TYPE_SELECT = 2,
749 	ACPI_IVRS_TYPE_START = 3,
750 	ACPI_IVRS_TYPE_END = 4,
751 
752 	/* 8-byte device entries */
753 
754 	ACPI_IVRS_TYPE_PAD8 = 64,
755 	ACPI_IVRS_TYPE_NOT_USED = 65,
756 	ACPI_IVRS_TYPE_ALIAS_SELECT = 66,	/* Uses struct acpi_ivrs_device8a */
757 	ACPI_IVRS_TYPE_ALIAS_START = 67,	/* Uses struct acpi_ivrs_device8a */
758 	ACPI_IVRS_TYPE_EXT_SELECT = 70,	/* Uses struct acpi_ivrs_device8b */
759 	ACPI_IVRS_TYPE_EXT_START = 71,	/* Uses struct acpi_ivrs_device8b */
760 	ACPI_IVRS_TYPE_SPECIAL = 72	/* Uses struct acpi_ivrs_device8c */
761 };
762 
763 /* Values for Data field above */
764 
765 #define ACPI_IVHD_INIT_PASS         (1)
766 #define ACPI_IVHD_EINT_PASS         (1<<1)
767 #define ACPI_IVHD_NMI_PASS          (1<<2)
768 #define ACPI_IVHD_SYSTEM_MGMT       (3<<4)
769 #define ACPI_IVHD_LINT0_PASS        (1<<6)
770 #define ACPI_IVHD_LINT1_PASS        (1<<7)
771 
772 /* Types 0-4: 4-byte device entry */
773 
774 struct acpi_ivrs_device4 {
775 	struct acpi_ivrs_de_header header;
776 };
777 
778 /* Types 66-67: 8-byte device entry */
779 
780 struct acpi_ivrs_device8a {
781 	struct acpi_ivrs_de_header header;
782 	u8 reserved1;
783 	u16 used_id;
784 	u8 reserved2;
785 };
786 
787 /* Types 70-71: 8-byte device entry */
788 
789 struct acpi_ivrs_device8b {
790 	struct acpi_ivrs_de_header header;
791 	u32 extended_data;
792 };
793 
794 /* Values for extended_data above */
795 
796 #define ACPI_IVHD_ATS_DISABLED      (1<<31)
797 
798 /* Type 72: 8-byte device entry */
799 
800 struct acpi_ivrs_device8c {
801 	struct acpi_ivrs_de_header header;
802 	u8 handle;
803 	u16 used_id;
804 	u8 variety;
805 };
806 
807 /* Values for Variety field above */
808 
809 #define ACPI_IVHD_IOAPIC            1
810 #define ACPI_IVHD_HPET              2
811 
812 /* 0x20, 0x21, 0x22: I/O Virtualization Memory Definition Block (IVMD) */
813 
814 struct acpi_ivrs_memory {
815 	struct acpi_ivrs_header header;
816 	u16 aux_data;
817 	u64 reserved;
818 	u64 start_address;
819 	u64 memory_length;
820 };
821 
822 /*******************************************************************************
823  *
824  * LPIT - Low Power Idle Table
825  *
826  * Conforms to "ACPI Low Power Idle Table (LPIT) and _LPD Proposal (DRAFT)"
827  *
828  ******************************************************************************/
829 
830 struct acpi_table_lpit {
831 	struct acpi_table_header header;	/* Common ACPI table header */
832 };
833 
834 /* LPIT subtable header */
835 
836 struct acpi_lpit_header {
837 	u32 type;		/* Subtable type */
838 	u32 length;		/* Subtable length */
839 	u16 unique_id;
840 	u16 reserved;
841 	u32 flags;
842 };
843 
844 /* Values for subtable Type above */
845 
846 enum acpi_lpit_type {
847 	ACPI_LPIT_TYPE_NATIVE_CSTATE = 0x00,
848 	ACPI_LPIT_TYPE_SIMPLE_IO = 0x01
849 };
850 
851 /* Masks for Flags field above  */
852 
853 #define ACPI_LPIT_STATE_DISABLED    (1)
854 #define ACPI_LPIT_NO_COUNTER        (1<<1)
855 
856 /*
857  * LPIT subtables, correspond to Type in struct acpi_lpit_header
858  */
859 
860 /* 0x00: Native C-state instruction based LPI structure */
861 
862 struct acpi_lpit_native {
863 	struct acpi_lpit_header header;
864 	struct acpi_generic_address entry_trigger;
865 	u32 residency;
866 	u32 latency;
867 	struct acpi_generic_address residency_counter;
868 	u64 counter_frequency;
869 };
870 
871 /* 0x01: Simple I/O based LPI structure */
872 
873 struct acpi_lpit_io {
874 	struct acpi_lpit_header header;
875 	struct acpi_generic_address entry_trigger;
876 	u32 trigger_action;
877 	u64 trigger_value;
878 	u64 trigger_mask;
879 	struct acpi_generic_address minimum_idle_state;
880 	u32 residency;
881 	u32 latency;
882 	struct acpi_generic_address residency_counter;
883 	u64 counter_frequency;
884 };
885 
886 /*******************************************************************************
887  *
888  * MCFG - PCI Memory Mapped Configuration table and subtable
889  *        Version 1
890  *
891  * Conforms to "PCI Firmware Specification", Revision 3.0, June 20, 2005
892  *
893  ******************************************************************************/
894 
895 struct acpi_table_mcfg {
896 	struct acpi_table_header header;	/* Common ACPI table header */
897 	u8 reserved[8];
898 };
899 
900 /* Subtable */
901 
902 struct acpi_mcfg_allocation {
903 	u64 address;		/* Base address, processor-relative */
904 	u16 pci_segment;	/* PCI segment group number */
905 	u8 start_bus_number;	/* Starting PCI Bus number */
906 	u8 end_bus_number;	/* Final PCI Bus number */
907 	u32 reserved;
908 };
909 
910 /*******************************************************************************
911  *
912  * MCHI - Management Controller Host Interface Table
913  *        Version 1
914  *
915  * Conforms to "Management Component Transport Protocol (MCTP) Host
916  * Interface Specification", Revision 1.0.0a, October 13, 2009
917  *
918  ******************************************************************************/
919 
920 struct acpi_table_mchi {
921 	struct acpi_table_header header;	/* Common ACPI table header */
922 	u8 interface_type;
923 	u8 protocol;
924 	u64 protocol_data;
925 	u8 interrupt_type;
926 	u8 gpe;
927 	u8 pci_device_flag;
928 	u32 global_interrupt;
929 	struct acpi_generic_address control_register;
930 	u8 pci_segment;
931 	u8 pci_bus;
932 	u8 pci_device;
933 	u8 pci_function;
934 };
935 
936 /*******************************************************************************
937  *
938  * MTMR - MID Timer Table
939  *        Version 1
940  *
941  * Conforms to "Simple Firmware Interface Specification",
942  * Draft 0.8.2, Oct 19, 2010
943  * NOTE: The ACPI MTMR is equivalent to the SFI MTMR table.
944  *
945  ******************************************************************************/
946 
947 struct acpi_table_mtmr {
948 	struct acpi_table_header header;	/* Common ACPI table header */
949 };
950 
951 /* MTMR entry */
952 
953 struct acpi_mtmr_entry {
954 	struct acpi_generic_address physical_address;
955 	u32 frequency;
956 	u32 irq;
957 };
958 
959 /*******************************************************************************
960  *
961  * SLIC - Software Licensing Description Table
962  *        Version 1
963  *
964  * Conforms to "OEM Activation 2.0 for Windows Vista Operating Systems",
965  * Copyright 2006
966  *
967  ******************************************************************************/
968 
969 /* Basic SLIC table is only the common ACPI header */
970 
971 struct acpi_table_slic {
972 	struct acpi_table_header header;	/* Common ACPI table header */
973 };
974 
975 /* Common SLIC subtable header */
976 
977 struct acpi_slic_header {
978 	u32 type;
979 	u32 length;
980 };
981 
982 /* Values for Type field above */
983 
984 enum acpi_slic_type {
985 	ACPI_SLIC_TYPE_PUBLIC_KEY = 0,
986 	ACPI_SLIC_TYPE_WINDOWS_MARKER = 1,
987 	ACPI_SLIC_TYPE_RESERVED = 2	/* 2 and greater are reserved */
988 };
989 
990 /*
991  * SLIC Subtables, correspond to Type in struct acpi_slic_header
992  */
993 
994 /* 0: Public Key Structure */
995 
996 struct acpi_slic_key {
997 	struct acpi_slic_header header;
998 	u8 key_type;
999 	u8 version;
1000 	u16 reserved;
1001 	u32 algorithm;
1002 	char magic[4];
1003 	u32 bit_length;
1004 	u32 exponent;
1005 	u8 modulus[128];
1006 };
1007 
1008 /* 1: Windows Marker Structure */
1009 
1010 struct acpi_slic_marker {
1011 	struct acpi_slic_header header;
1012 	u32 version;
1013 	char oem_id[ACPI_OEM_ID_SIZE];	/* ASCII OEM identification */
1014 	char oem_table_id[ACPI_OEM_TABLE_ID_SIZE];	/* ASCII OEM table identification */
1015 	char windows_flag[8];
1016 	u32 slic_version;
1017 	u8 reserved[16];
1018 	u8 signature[128];
1019 };
1020 
1021 /*******************************************************************************
1022  *
1023  * SPCR - Serial Port Console Redirection table
1024  *        Version 1
1025  *
1026  * Conforms to "Serial Port Console Redirection Table",
1027  * Version 1.00, January 11, 2002
1028  *
1029  ******************************************************************************/
1030 
1031 struct acpi_table_spcr {
1032 	struct acpi_table_header header;	/* Common ACPI table header */
1033 	u8 interface_type;	/* 0=full 16550, 1=subset of 16550 */
1034 	u8 reserved[3];
1035 	struct acpi_generic_address serial_port;
1036 	u8 interrupt_type;
1037 	u8 pc_interrupt;
1038 	u32 interrupt;
1039 	u8 baud_rate;
1040 	u8 parity;
1041 	u8 stop_bits;
1042 	u8 flow_control;
1043 	u8 terminal_type;
1044 	u8 reserved1;
1045 	u16 pci_device_id;
1046 	u16 pci_vendor_id;
1047 	u8 pci_bus;
1048 	u8 pci_device;
1049 	u8 pci_function;
1050 	u32 pci_flags;
1051 	u8 pci_segment;
1052 	u32 reserved2;
1053 };
1054 
1055 /* Masks for pci_flags field above */
1056 
1057 #define ACPI_SPCR_DO_NOT_DISABLE    (1)
1058 
1059 /*******************************************************************************
1060  *
1061  * SPMI - Server Platform Management Interface table
1062  *        Version 5
1063  *
1064  * Conforms to "Intelligent Platform Management Interface Specification
1065  * Second Generation v2.0", Document Revision 1.0, February 12, 2004 with
1066  * June 12, 2009 markup.
1067  *
1068  ******************************************************************************/
1069 
1070 struct acpi_table_spmi {
1071 	struct acpi_table_header header;	/* Common ACPI table header */
1072 	u8 interface_type;
1073 	u8 reserved;		/* Must be 1 */
1074 	u16 spec_revision;	/* Version of IPMI */
1075 	u8 interrupt_type;
1076 	u8 gpe_number;		/* GPE assigned */
1077 	u8 reserved1;
1078 	u8 pci_device_flag;
1079 	u32 interrupt;
1080 	struct acpi_generic_address ipmi_register;
1081 	u8 pci_segment;
1082 	u8 pci_bus;
1083 	u8 pci_device;
1084 	u8 pci_function;
1085 	u8 reserved2;
1086 };
1087 
1088 /* Values for interface_type above */
1089 
1090 enum acpi_spmi_interface_types {
1091 	ACPI_SPMI_NOT_USED = 0,
1092 	ACPI_SPMI_KEYBOARD = 1,
1093 	ACPI_SPMI_SMI = 2,
1094 	ACPI_SPMI_BLOCK_TRANSFER = 3,
1095 	ACPI_SPMI_SMBUS = 4,
1096 	ACPI_SPMI_RESERVED = 5	/* 5 and above are reserved */
1097 };
1098 
1099 /*******************************************************************************
1100  *
1101  * TCPA - Trusted Computing Platform Alliance table
1102  *        Version 1
1103  *
1104  * Conforms to "TCG PC Specific Implementation Specification",
1105  * Version 1.1, August 18, 2003
1106  *
1107  ******************************************************************************/
1108 
1109 struct acpi_table_tcpa {
1110 	struct acpi_table_header header;	/* Common ACPI table header */
1111 	u16 reserved;
1112 	u32 max_log_length;	/* Maximum length for the event log area */
1113 	u64 log_address;	/* Address of the event log area */
1114 };
1115 
1116 /*******************************************************************************
1117  *
1118  * UEFI - UEFI Boot optimization Table
1119  *        Version 1
1120  *
1121  * Conforms to "Unified Extensible Firmware Interface Specification",
1122  * Version 2.3, May 8, 2009
1123  *
1124  ******************************************************************************/
1125 
1126 struct acpi_table_uefi {
1127 	struct acpi_table_header header;	/* Common ACPI table header */
1128 	u8 identifier[16];	/* UUID identifier */
1129 	u16 data_offset;	/* Offset of remaining data in table */
1130 };
1131 
1132 /*******************************************************************************
1133  *
1134  * VRTC - Virtual Real Time Clock Table
1135  *        Version 1
1136  *
1137  * Conforms to "Simple Firmware Interface Specification",
1138  * Draft 0.8.2, Oct 19, 2010
1139  * NOTE: The ACPI VRTC is equivalent to The SFI MRTC table.
1140  *
1141  ******************************************************************************/
1142 
1143 struct acpi_table_vrtc {
1144 	struct acpi_table_header header;	/* Common ACPI table header */
1145 };
1146 
1147 /* VRTC entry */
1148 
1149 struct acpi_vrtc_entry {
1150 	struct acpi_generic_address physical_address;
1151 	u32 irq;
1152 };
1153 
1154 /*******************************************************************************
1155  *
1156  * WAET - Windows ACPI Emulated devices Table
1157  *        Version 1
1158  *
1159  * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
1160  *
1161  ******************************************************************************/
1162 
1163 struct acpi_table_waet {
1164 	struct acpi_table_header header;	/* Common ACPI table header */
1165 	u32 flags;
1166 };
1167 
1168 /* Masks for Flags field above */
1169 
1170 #define ACPI_WAET_RTC_NO_ACK        (1)	/* RTC requires no int acknowledge */
1171 #define ACPI_WAET_TIMER_ONE_READ    (1<<1)	/* PM timer requires only one read */
1172 
1173 /*******************************************************************************
1174  *
1175  * WDAT - Watchdog Action Table
1176  *        Version 1
1177  *
1178  * Conforms to "Hardware Watchdog Timers Design Specification",
1179  * Copyright 2006 Microsoft Corporation.
1180  *
1181  ******************************************************************************/
1182 
1183 struct acpi_table_wdat {
1184 	struct acpi_table_header header;	/* Common ACPI table header */
1185 	u32 header_length;	/* Watchdog Header Length */
1186 	u16 pci_segment;	/* PCI Segment number */
1187 	u8 pci_bus;		/* PCI Bus number */
1188 	u8 pci_device;		/* PCI Device number */
1189 	u8 pci_function;	/* PCI Function number */
1190 	u8 reserved[3];
1191 	u32 timer_period;	/* Period of one timer count (msec) */
1192 	u32 max_count;		/* Maximum counter value supported */
1193 	u32 min_count;		/* Minimum counter value */
1194 	u8 flags;
1195 	u8 reserved2[3];
1196 	u32 entries;		/* Number of watchdog entries that follow */
1197 };
1198 
1199 /* Masks for Flags field above */
1200 
1201 #define ACPI_WDAT_ENABLED           (1)
1202 #define ACPI_WDAT_STOPPED           0x80
1203 
1204 /* WDAT Instruction Entries (actions) */
1205 
1206 struct acpi_wdat_entry {
1207 	u8 action;
1208 	u8 instruction;
1209 	u16 reserved;
1210 	struct acpi_generic_address register_region;
1211 	u32 value;		/* Value used with Read/Write register */
1212 	u32 mask;		/* Bitmask required for this register instruction */
1213 };
1214 
1215 /* Values for Action field above */
1216 
1217 enum acpi_wdat_actions {
1218 	ACPI_WDAT_RESET = 1,
1219 	ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
1220 	ACPI_WDAT_GET_COUNTDOWN = 5,
1221 	ACPI_WDAT_SET_COUNTDOWN = 6,
1222 	ACPI_WDAT_GET_RUNNING_STATE = 8,
1223 	ACPI_WDAT_SET_RUNNING_STATE = 9,
1224 	ACPI_WDAT_GET_STOPPED_STATE = 10,
1225 	ACPI_WDAT_SET_STOPPED_STATE = 11,
1226 	ACPI_WDAT_GET_REBOOT = 16,
1227 	ACPI_WDAT_SET_REBOOT = 17,
1228 	ACPI_WDAT_GET_SHUTDOWN = 18,
1229 	ACPI_WDAT_SET_SHUTDOWN = 19,
1230 	ACPI_WDAT_GET_STATUS = 32,
1231 	ACPI_WDAT_SET_STATUS = 33,
1232 	ACPI_WDAT_ACTION_RESERVED = 34	/* 34 and greater are reserved */
1233 };
1234 
1235 /* Values for Instruction field above */
1236 
1237 enum acpi_wdat_instructions {
1238 	ACPI_WDAT_READ_VALUE = 0,
1239 	ACPI_WDAT_READ_COUNTDOWN = 1,
1240 	ACPI_WDAT_WRITE_VALUE = 2,
1241 	ACPI_WDAT_WRITE_COUNTDOWN = 3,
1242 	ACPI_WDAT_INSTRUCTION_RESERVED = 4,	/* 4 and greater are reserved */
1243 	ACPI_WDAT_PRESERVE_REGISTER = 0x80	/* Except for this value */
1244 };
1245 
1246 /*******************************************************************************
1247  *
1248  * WDDT - Watchdog Descriptor Table
1249  *        Version 1
1250  *
1251  * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
1252  * Version 001, September 2002
1253  *
1254  ******************************************************************************/
1255 
1256 struct acpi_table_wddt {
1257 	struct acpi_table_header header;	/* Common ACPI table header */
1258 	u16 spec_version;
1259 	u16 table_version;
1260 	u16 pci_vendor_id;
1261 	struct acpi_generic_address address;
1262 	u16 max_count;		/* Maximum counter value supported */
1263 	u16 min_count;		/* Minimum counter value supported */
1264 	u16 period;
1265 	u16 status;
1266 	u16 capability;
1267 };
1268 
1269 /* Flags for Status field above */
1270 
1271 #define ACPI_WDDT_AVAILABLE     (1)
1272 #define ACPI_WDDT_ACTIVE        (1<<1)
1273 #define ACPI_WDDT_TCO_OS_OWNED  (1<<2)
1274 #define ACPI_WDDT_USER_RESET    (1<<11)
1275 #define ACPI_WDDT_WDT_RESET     (1<<12)
1276 #define ACPI_WDDT_POWER_FAIL    (1<<13)
1277 #define ACPI_WDDT_UNKNOWN_RESET (1<<14)
1278 
1279 /* Flags for Capability field above */
1280 
1281 #define ACPI_WDDT_AUTO_RESET    (1)
1282 #define ACPI_WDDT_ALERT_SUPPORT (1<<1)
1283 
1284 /*******************************************************************************
1285  *
1286  * WDRT - Watchdog Resource Table
1287  *        Version 1
1288  *
1289  * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
1290  * Version 1.01, August 28, 2006
1291  *
1292  ******************************************************************************/
1293 
1294 struct acpi_table_wdrt {
1295 	struct acpi_table_header header;	/* Common ACPI table header */
1296 	struct acpi_generic_address control_register;
1297 	struct acpi_generic_address count_register;
1298 	u16 pci_device_id;
1299 	u16 pci_vendor_id;
1300 	u8 pci_bus;		/* PCI Bus number */
1301 	u8 pci_device;		/* PCI Device number */
1302 	u8 pci_function;	/* PCI Function number */
1303 	u8 pci_segment;		/* PCI Segment number */
1304 	u16 max_count;		/* Maximum counter value supported */
1305 	u8 units;
1306 };
1307 
1308 /* Reset to default packing */
1309 
1310 #pragma pack()
1311 
1312 #endif				/* __ACTBL2_H__ */
1313