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