xref: /openbmc/linux/include/acpi/actbl2.h (revision e23feb16)
1 /******************************************************************************
2  *
3  * Name: actbl2.h - ACPI Table Definitions (tables not in ACPI spec)
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2013, 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 /* Debug Device Information Subtable */
331 
332 struct acpi_dbg2_device {
333 	u8 revision;
334 	u16 length;
335 	u8 register_count;	/* Number of base_address registers */
336 	u16 namepath_length;
337 	u16 namepath_offset;
338 	u16 oem_data_length;
339 	u16 oem_data_offset;
340 	u16 port_type;
341 	u16 port_subtype;
342 	u16 reserved;
343 	u16 base_address_offset;
344 	u16 address_size_offset;
345 	/*
346 	 * Data that follows:
347 	 *    base_address (required) - Each in 12-byte Generic Address Structure format.
348 	 *    address_size (required) - Array of u32 sizes corresponding to each base_address register.
349 	 *    Namepath    (required) - Null terminated string. Single dot if not supported.
350 	 *    oem_data    (optional) - Length is oem_data_length.
351 	 */
352 };
353 
354 /* Types for port_type field above */
355 
356 #define ACPI_DBG2_SERIAL_PORT       0x8000
357 #define ACPI_DBG2_1394_PORT         0x8001
358 #define ACPI_DBG2_USB_PORT          0x8002
359 #define ACPI_DBG2_NET_PORT          0x8003
360 
361 /* Subtypes for port_subtype field above */
362 
363 #define ACPI_DBG2_16550_COMPATIBLE  0x0000
364 #define ACPI_DBG2_16550_SUBSET      0x0001
365 
366 #define ACPI_DBG2_1394_STANDARD     0x0000
367 
368 #define ACPI_DBG2_USB_XHCI          0x0000
369 #define ACPI_DBG2_USB_EHCI          0x0001
370 
371 /*******************************************************************************
372  *
373  * DBGP - Debug Port table
374  *        Version 1
375  *
376  * Conforms to the "Debug Port Specification", Version 1.00, 2/9/2000
377  *
378  ******************************************************************************/
379 
380 struct acpi_table_dbgp {
381 	struct acpi_table_header header;	/* Common ACPI table header */
382 	u8 type;		/* 0=full 16550, 1=subset of 16550 */
383 	u8 reserved[3];
384 	struct acpi_generic_address debug_port;
385 };
386 
387 /*******************************************************************************
388  *
389  * DMAR - DMA Remapping table
390  *        Version 1
391  *
392  * Conforms to "Intel Virtualization Technology for Directed I/O",
393  * Version 1.2, Sept. 2008
394  *
395  ******************************************************************************/
396 
397 struct acpi_table_dmar {
398 	struct acpi_table_header header;	/* Common ACPI table header */
399 	u8 width;		/* Host Address Width */
400 	u8 flags;
401 	u8 reserved[10];
402 };
403 
404 /* Masks for Flags field above */
405 
406 #define ACPI_DMAR_INTR_REMAP        (1)
407 
408 /* DMAR subtable header */
409 
410 struct acpi_dmar_header {
411 	u16 type;
412 	u16 length;
413 };
414 
415 /* Values for subtable type in struct acpi_dmar_header */
416 
417 enum acpi_dmar_type {
418 	ACPI_DMAR_TYPE_HARDWARE_UNIT = 0,
419 	ACPI_DMAR_TYPE_RESERVED_MEMORY = 1,
420 	ACPI_DMAR_TYPE_ATSR = 2,
421 	ACPI_DMAR_HARDWARE_AFFINITY = 3,
422 	ACPI_DMAR_TYPE_RESERVED = 4	/* 4 and greater are reserved */
423 };
424 
425 /* DMAR Device Scope structure */
426 
427 struct acpi_dmar_device_scope {
428 	u8 entry_type;
429 	u8 length;
430 	u16 reserved;
431 	u8 enumeration_id;
432 	u8 bus;
433 };
434 
435 /* Values for entry_type in struct acpi_dmar_device_scope */
436 
437 enum acpi_dmar_scope_type {
438 	ACPI_DMAR_SCOPE_TYPE_NOT_USED = 0,
439 	ACPI_DMAR_SCOPE_TYPE_ENDPOINT = 1,
440 	ACPI_DMAR_SCOPE_TYPE_BRIDGE = 2,
441 	ACPI_DMAR_SCOPE_TYPE_IOAPIC = 3,
442 	ACPI_DMAR_SCOPE_TYPE_HPET = 4,
443 	ACPI_DMAR_SCOPE_TYPE_RESERVED = 5	/* 5 and greater are reserved */
444 };
445 
446 struct acpi_dmar_pci_path {
447 	u8 dev;
448 	u8 fn;
449 };
450 
451 /*
452  * DMAR Sub-tables, correspond to Type in struct acpi_dmar_header
453  */
454 
455 /* 0: Hardware Unit Definition */
456 
457 struct acpi_dmar_hardware_unit {
458 	struct acpi_dmar_header header;
459 	u8 flags;
460 	u8 reserved;
461 	u16 segment;
462 	u64 address;		/* Register Base Address */
463 };
464 
465 /* Masks for Flags field above */
466 
467 #define ACPI_DMAR_INCLUDE_ALL       (1)
468 
469 /* 1: Reserved Memory Defininition */
470 
471 struct acpi_dmar_reserved_memory {
472 	struct acpi_dmar_header header;
473 	u16 reserved;
474 	u16 segment;
475 	u64 base_address;	/* 4K aligned base address */
476 	u64 end_address;	/* 4K aligned limit address */
477 };
478 
479 /* Masks for Flags field above */
480 
481 #define ACPI_DMAR_ALLOW_ALL         (1)
482 
483 /* 2: Root Port ATS Capability Reporting Structure */
484 
485 struct acpi_dmar_atsr {
486 	struct acpi_dmar_header header;
487 	u8 flags;
488 	u8 reserved;
489 	u16 segment;
490 };
491 
492 /* Masks for Flags field above */
493 
494 #define ACPI_DMAR_ALL_PORTS         (1)
495 
496 /* 3: Remapping Hardware Static Affinity Structure */
497 
498 struct acpi_dmar_rhsa {
499 	struct acpi_dmar_header header;
500 	u32 reserved;
501 	u64 base_address;
502 	u32 proximity_domain;
503 };
504 
505 /*******************************************************************************
506  *
507  * HPET - High Precision Event Timer table
508  *        Version 1
509  *
510  * Conforms to "IA-PC HPET (High Precision Event Timers) Specification",
511  * Version 1.0a, October 2004
512  *
513  ******************************************************************************/
514 
515 struct acpi_table_hpet {
516 	struct acpi_table_header header;	/* Common ACPI table header */
517 	u32 id;			/* Hardware ID of event timer block */
518 	struct acpi_generic_address address;	/* Address of event timer block */
519 	u8 sequence;		/* HPET sequence number */
520 	u16 minimum_tick;	/* Main counter min tick, periodic mode */
521 	u8 flags;
522 };
523 
524 /* Masks for Flags field above */
525 
526 #define ACPI_HPET_PAGE_PROTECT_MASK (3)
527 
528 /* Values for Page Protect flags */
529 
530 enum acpi_hpet_page_protect {
531 	ACPI_HPET_NO_PAGE_PROTECT = 0,
532 	ACPI_HPET_PAGE_PROTECT4 = 1,
533 	ACPI_HPET_PAGE_PROTECT64 = 2
534 };
535 
536 /*******************************************************************************
537  *
538  * IBFT - Boot Firmware Table
539  *        Version 1
540  *
541  * Conforms to "iSCSI Boot Firmware Table (iBFT) as Defined in ACPI 3.0b
542  * Specification", Version 1.01, March 1, 2007
543  *
544  * Note: It appears that this table is not intended to appear in the RSDT/XSDT.
545  * Therefore, it is not currently supported by the disassembler.
546  *
547  ******************************************************************************/
548 
549 struct acpi_table_ibft {
550 	struct acpi_table_header header;	/* Common ACPI table header */
551 	u8 reserved[12];
552 };
553 
554 /* IBFT common subtable header */
555 
556 struct acpi_ibft_header {
557 	u8 type;
558 	u8 version;
559 	u16 length;
560 	u8 index;
561 	u8 flags;
562 };
563 
564 /* Values for Type field above */
565 
566 enum acpi_ibft_type {
567 	ACPI_IBFT_TYPE_NOT_USED = 0,
568 	ACPI_IBFT_TYPE_CONTROL = 1,
569 	ACPI_IBFT_TYPE_INITIATOR = 2,
570 	ACPI_IBFT_TYPE_NIC = 3,
571 	ACPI_IBFT_TYPE_TARGET = 4,
572 	ACPI_IBFT_TYPE_EXTENSIONS = 5,
573 	ACPI_IBFT_TYPE_RESERVED = 6	/* 6 and greater are reserved */
574 };
575 
576 /* IBFT subtables */
577 
578 struct acpi_ibft_control {
579 	struct acpi_ibft_header header;
580 	u16 extensions;
581 	u16 initiator_offset;
582 	u16 nic0_offset;
583 	u16 target0_offset;
584 	u16 nic1_offset;
585 	u16 target1_offset;
586 };
587 
588 struct acpi_ibft_initiator {
589 	struct acpi_ibft_header header;
590 	u8 sns_server[16];
591 	u8 slp_server[16];
592 	u8 primary_server[16];
593 	u8 secondary_server[16];
594 	u16 name_length;
595 	u16 name_offset;
596 };
597 
598 struct acpi_ibft_nic {
599 	struct acpi_ibft_header header;
600 	u8 ip_address[16];
601 	u8 subnet_mask_prefix;
602 	u8 origin;
603 	u8 gateway[16];
604 	u8 primary_dns[16];
605 	u8 secondary_dns[16];
606 	u8 dhcp[16];
607 	u16 vlan;
608 	u8 mac_address[6];
609 	u16 pci_address;
610 	u16 name_length;
611 	u16 name_offset;
612 };
613 
614 struct acpi_ibft_target {
615 	struct acpi_ibft_header header;
616 	u8 target_ip_address[16];
617 	u16 target_ip_socket;
618 	u8 target_boot_lun[8];
619 	u8 chap_type;
620 	u8 nic_association;
621 	u16 target_name_length;
622 	u16 target_name_offset;
623 	u16 chap_name_length;
624 	u16 chap_name_offset;
625 	u16 chap_secret_length;
626 	u16 chap_secret_offset;
627 	u16 reverse_chap_name_length;
628 	u16 reverse_chap_name_offset;
629 	u16 reverse_chap_secret_length;
630 	u16 reverse_chap_secret_offset;
631 };
632 
633 /*******************************************************************************
634  *
635  * IVRS - I/O Virtualization Reporting Structure
636  *        Version 1
637  *
638  * Conforms to "AMD I/O Virtualization Technology (IOMMU) Specification",
639  * Revision 1.26, February 2009.
640  *
641  ******************************************************************************/
642 
643 struct acpi_table_ivrs {
644 	struct acpi_table_header header;	/* Common ACPI table header */
645 	u32 info;		/* Common virtualization info */
646 	u64 reserved;
647 };
648 
649 /* Values for Info field above */
650 
651 #define ACPI_IVRS_PHYSICAL_SIZE     0x00007F00	/* 7 bits, physical address size */
652 #define ACPI_IVRS_VIRTUAL_SIZE      0x003F8000	/* 7 bits, virtual address size */
653 #define ACPI_IVRS_ATS_RESERVED      0x00400000	/* ATS address translation range reserved */
654 
655 /* IVRS subtable header */
656 
657 struct acpi_ivrs_header {
658 	u8 type;		/* Subtable type */
659 	u8 flags;
660 	u16 length;		/* Subtable length */
661 	u16 device_id;		/* ID of IOMMU */
662 };
663 
664 /* Values for subtable Type above */
665 
666 enum acpi_ivrs_type {
667 	ACPI_IVRS_TYPE_HARDWARE = 0x10,
668 	ACPI_IVRS_TYPE_MEMORY1 = 0x20,
669 	ACPI_IVRS_TYPE_MEMORY2 = 0x21,
670 	ACPI_IVRS_TYPE_MEMORY3 = 0x22
671 };
672 
673 /* Masks for Flags field above for IVHD subtable */
674 
675 #define ACPI_IVHD_TT_ENABLE         (1)
676 #define ACPI_IVHD_PASS_PW           (1<<1)
677 #define ACPI_IVHD_RES_PASS_PW       (1<<2)
678 #define ACPI_IVHD_ISOC              (1<<3)
679 #define ACPI_IVHD_IOTLB             (1<<4)
680 
681 /* Masks for Flags field above for IVMD subtable */
682 
683 #define ACPI_IVMD_UNITY             (1)
684 #define ACPI_IVMD_READ              (1<<1)
685 #define ACPI_IVMD_WRITE             (1<<2)
686 #define ACPI_IVMD_EXCLUSION_RANGE   (1<<3)
687 
688 /*
689  * IVRS subtables, correspond to Type in struct acpi_ivrs_header
690  */
691 
692 /* 0x10: I/O Virtualization Hardware Definition Block (IVHD) */
693 
694 struct acpi_ivrs_hardware {
695 	struct acpi_ivrs_header header;
696 	u16 capability_offset;	/* Offset for IOMMU control fields */
697 	u64 base_address;	/* IOMMU control registers */
698 	u16 pci_segment_group;
699 	u16 info;		/* MSI number and unit ID */
700 	u32 reserved;
701 };
702 
703 /* Masks for Info field above */
704 
705 #define ACPI_IVHD_MSI_NUMBER_MASK   0x001F	/* 5 bits, MSI message number */
706 #define ACPI_IVHD_UNIT_ID_MASK      0x1F00	/* 5 bits, unit_ID */
707 
708 /*
709  * Device Entries for IVHD subtable, appear after struct acpi_ivrs_hardware structure.
710  * Upper two bits of the Type field are the (encoded) length of the structure.
711  * Currently, only 4 and 8 byte entries are defined. 16 and 32 byte entries
712  * are reserved for future use but not defined.
713  */
714 struct acpi_ivrs_de_header {
715 	u8 type;
716 	u16 id;
717 	u8 data_setting;
718 };
719 
720 /* Length of device entry is in the top two bits of Type field above */
721 
722 #define ACPI_IVHD_ENTRY_LENGTH      0xC0
723 
724 /* Values for device entry Type field above */
725 
726 enum acpi_ivrs_device_entry_type {
727 	/* 4-byte device entries, all use struct acpi_ivrs_device4 */
728 
729 	ACPI_IVRS_TYPE_PAD4 = 0,
730 	ACPI_IVRS_TYPE_ALL = 1,
731 	ACPI_IVRS_TYPE_SELECT = 2,
732 	ACPI_IVRS_TYPE_START = 3,
733 	ACPI_IVRS_TYPE_END = 4,
734 
735 	/* 8-byte device entries */
736 
737 	ACPI_IVRS_TYPE_PAD8 = 64,
738 	ACPI_IVRS_TYPE_NOT_USED = 65,
739 	ACPI_IVRS_TYPE_ALIAS_SELECT = 66,	/* Uses struct acpi_ivrs_device8a */
740 	ACPI_IVRS_TYPE_ALIAS_START = 67,	/* Uses struct acpi_ivrs_device8a */
741 	ACPI_IVRS_TYPE_EXT_SELECT = 70,	/* Uses struct acpi_ivrs_device8b */
742 	ACPI_IVRS_TYPE_EXT_START = 71,	/* Uses struct acpi_ivrs_device8b */
743 	ACPI_IVRS_TYPE_SPECIAL = 72	/* Uses struct acpi_ivrs_device8c */
744 };
745 
746 /* Values for Data field above */
747 
748 #define ACPI_IVHD_INIT_PASS         (1)
749 #define ACPI_IVHD_EINT_PASS         (1<<1)
750 #define ACPI_IVHD_NMI_PASS          (1<<2)
751 #define ACPI_IVHD_SYSTEM_MGMT       (3<<4)
752 #define ACPI_IVHD_LINT0_PASS        (1<<6)
753 #define ACPI_IVHD_LINT1_PASS        (1<<7)
754 
755 /* Types 0-4: 4-byte device entry */
756 
757 struct acpi_ivrs_device4 {
758 	struct acpi_ivrs_de_header header;
759 };
760 
761 /* Types 66-67: 8-byte device entry */
762 
763 struct acpi_ivrs_device8a {
764 	struct acpi_ivrs_de_header header;
765 	u8 reserved1;
766 	u16 used_id;
767 	u8 reserved2;
768 };
769 
770 /* Types 70-71: 8-byte device entry */
771 
772 struct acpi_ivrs_device8b {
773 	struct acpi_ivrs_de_header header;
774 	u32 extended_data;
775 };
776 
777 /* Values for extended_data above */
778 
779 #define ACPI_IVHD_ATS_DISABLED      (1<<31)
780 
781 /* Type 72: 8-byte device entry */
782 
783 struct acpi_ivrs_device8c {
784 	struct acpi_ivrs_de_header header;
785 	u8 handle;
786 	u16 used_id;
787 	u8 variety;
788 };
789 
790 /* Values for Variety field above */
791 
792 #define ACPI_IVHD_IOAPIC            1
793 #define ACPI_IVHD_HPET              2
794 
795 /* 0x20, 0x21, 0x22: I/O Virtualization Memory Definition Block (IVMD) */
796 
797 struct acpi_ivrs_memory {
798 	struct acpi_ivrs_header header;
799 	u16 aux_data;
800 	u64 reserved;
801 	u64 start_address;
802 	u64 memory_length;
803 };
804 
805 /*******************************************************************************
806  *
807  * MCFG - PCI Memory Mapped Configuration table and sub-table
808  *        Version 1
809  *
810  * Conforms to "PCI Firmware Specification", Revision 3.0, June 20, 2005
811  *
812  ******************************************************************************/
813 
814 struct acpi_table_mcfg {
815 	struct acpi_table_header header;	/* Common ACPI table header */
816 	u8 reserved[8];
817 };
818 
819 /* Subtable */
820 
821 struct acpi_mcfg_allocation {
822 	u64 address;		/* Base address, processor-relative */
823 	u16 pci_segment;	/* PCI segment group number */
824 	u8 start_bus_number;	/* Starting PCI Bus number */
825 	u8 end_bus_number;	/* Final PCI Bus number */
826 	u32 reserved;
827 };
828 
829 /*******************************************************************************
830  *
831  * MCHI - Management Controller Host Interface Table
832  *        Version 1
833  *
834  * Conforms to "Management Component Transport Protocol (MCTP) Host
835  * Interface Specification", Revision 1.0.0a, October 13, 2009
836  *
837  ******************************************************************************/
838 
839 struct acpi_table_mchi {
840 	struct acpi_table_header header;	/* Common ACPI table header */
841 	u8 interface_type;
842 	u8 protocol;
843 	u64 protocol_data;
844 	u8 interrupt_type;
845 	u8 gpe;
846 	u8 pci_device_flag;
847 	u32 global_interrupt;
848 	struct acpi_generic_address control_register;
849 	u8 pci_segment;
850 	u8 pci_bus;
851 	u8 pci_device;
852 	u8 pci_function;
853 };
854 
855 /*******************************************************************************
856  *
857  * MTMR - MID Timer Table
858  *        Version 1
859  *
860  * Conforms to "Simple Firmware Interface Specification",
861  * Draft 0.8.2, Oct 19, 2010
862  * NOTE: The ACPI MTMR is equivalent to the SFI MTMR table.
863  *
864  ******************************************************************************/
865 
866 struct acpi_table_mtmr {
867 	struct acpi_table_header header;	/* Common ACPI table header */
868 };
869 
870 /* MTMR entry */
871 
872 struct acpi_mtmr_entry {
873 	struct acpi_generic_address physical_address;
874 	u32 frequency;
875 	u32 irq;
876 };
877 
878 /*******************************************************************************
879  *
880  * SLIC - Software Licensing Description Table
881  *        Version 1
882  *
883  * Conforms to "OEM Activation 2.0 for Windows Vista Operating Systems",
884  * Copyright 2006
885  *
886  ******************************************************************************/
887 
888 /* Basic SLIC table is only the common ACPI header */
889 
890 struct acpi_table_slic {
891 	struct acpi_table_header header;	/* Common ACPI table header */
892 };
893 
894 /* Common SLIC subtable header */
895 
896 struct acpi_slic_header {
897 	u32 type;
898 	u32 length;
899 };
900 
901 /* Values for Type field above */
902 
903 enum acpi_slic_type {
904 	ACPI_SLIC_TYPE_PUBLIC_KEY = 0,
905 	ACPI_SLIC_TYPE_WINDOWS_MARKER = 1,
906 	ACPI_SLIC_TYPE_RESERVED = 2	/* 2 and greater are reserved */
907 };
908 
909 /*
910  * SLIC Sub-tables, correspond to Type in struct acpi_slic_header
911  */
912 
913 /* 0: Public Key Structure */
914 
915 struct acpi_slic_key {
916 	struct acpi_slic_header header;
917 	u8 key_type;
918 	u8 version;
919 	u16 reserved;
920 	u32 algorithm;
921 	char magic[4];
922 	u32 bit_length;
923 	u32 exponent;
924 	u8 modulus[128];
925 };
926 
927 /* 1: Windows Marker Structure */
928 
929 struct acpi_slic_marker {
930 	struct acpi_slic_header header;
931 	u32 version;
932 	char oem_id[ACPI_OEM_ID_SIZE];	/* ASCII OEM identification */
933 	char oem_table_id[ACPI_OEM_TABLE_ID_SIZE];	/* ASCII OEM table identification */
934 	char windows_flag[8];
935 	u32 slic_version;
936 	u8 reserved[16];
937 	u8 signature[128];
938 };
939 
940 /*******************************************************************************
941  *
942  * SPCR - Serial Port Console Redirection table
943  *        Version 1
944  *
945  * Conforms to "Serial Port Console Redirection Table",
946  * Version 1.00, January 11, 2002
947  *
948  ******************************************************************************/
949 
950 struct acpi_table_spcr {
951 	struct acpi_table_header header;	/* Common ACPI table header */
952 	u8 interface_type;	/* 0=full 16550, 1=subset of 16550 */
953 	u8 reserved[3];
954 	struct acpi_generic_address serial_port;
955 	u8 interrupt_type;
956 	u8 pc_interrupt;
957 	u32 interrupt;
958 	u8 baud_rate;
959 	u8 parity;
960 	u8 stop_bits;
961 	u8 flow_control;
962 	u8 terminal_type;
963 	u8 reserved1;
964 	u16 pci_device_id;
965 	u16 pci_vendor_id;
966 	u8 pci_bus;
967 	u8 pci_device;
968 	u8 pci_function;
969 	u32 pci_flags;
970 	u8 pci_segment;
971 	u32 reserved2;
972 };
973 
974 /* Masks for pci_flags field above */
975 
976 #define ACPI_SPCR_DO_NOT_DISABLE    (1)
977 
978 /*******************************************************************************
979  *
980  * SPMI - Server Platform Management Interface table
981  *        Version 5
982  *
983  * Conforms to "Intelligent Platform Management Interface Specification
984  * Second Generation v2.0", Document Revision 1.0, February 12, 2004 with
985  * June 12, 2009 markup.
986  *
987  ******************************************************************************/
988 
989 struct acpi_table_spmi {
990 	struct acpi_table_header header;	/* Common ACPI table header */
991 	u8 interface_type;
992 	u8 reserved;		/* Must be 1 */
993 	u16 spec_revision;	/* Version of IPMI */
994 	u8 interrupt_type;
995 	u8 gpe_number;		/* GPE assigned */
996 	u8 reserved1;
997 	u8 pci_device_flag;
998 	u32 interrupt;
999 	struct acpi_generic_address ipmi_register;
1000 	u8 pci_segment;
1001 	u8 pci_bus;
1002 	u8 pci_device;
1003 	u8 pci_function;
1004 	u8 reserved2;
1005 };
1006 
1007 /* Values for interface_type above */
1008 
1009 enum acpi_spmi_interface_types {
1010 	ACPI_SPMI_NOT_USED = 0,
1011 	ACPI_SPMI_KEYBOARD = 1,
1012 	ACPI_SPMI_SMI = 2,
1013 	ACPI_SPMI_BLOCK_TRANSFER = 3,
1014 	ACPI_SPMI_SMBUS = 4,
1015 	ACPI_SPMI_RESERVED = 5	/* 5 and above are reserved */
1016 };
1017 
1018 /*******************************************************************************
1019  *
1020  * TCPA - Trusted Computing Platform Alliance table
1021  *        Version 1
1022  *
1023  * Conforms to "TCG PC Specific Implementation Specification",
1024  * Version 1.1, August 18, 2003
1025  *
1026  ******************************************************************************/
1027 
1028 struct acpi_table_tcpa {
1029 	struct acpi_table_header header;	/* Common ACPI table header */
1030 	u16 reserved;
1031 	u32 max_log_length;	/* Maximum length for the event log area */
1032 	u64 log_address;	/* Address of the event log area */
1033 };
1034 
1035 /*******************************************************************************
1036  *
1037  * UEFI - UEFI Boot optimization Table
1038  *        Version 1
1039  *
1040  * Conforms to "Unified Extensible Firmware Interface Specification",
1041  * Version 2.3, May 8, 2009
1042  *
1043  ******************************************************************************/
1044 
1045 struct acpi_table_uefi {
1046 	struct acpi_table_header header;	/* Common ACPI table header */
1047 	u8 identifier[16];	/* UUID identifier */
1048 	u16 data_offset;	/* Offset of remaining data in table */
1049 };
1050 
1051 /*******************************************************************************
1052  *
1053  * VRTC - Virtual Real Time Clock Table
1054  *        Version 1
1055  *
1056  * Conforms to "Simple Firmware Interface Specification",
1057  * Draft 0.8.2, Oct 19, 2010
1058  * NOTE: The ACPI VRTC is equivalent to The SFI MRTC table.
1059  *
1060  ******************************************************************************/
1061 
1062 struct acpi_table_vrtc {
1063 	struct acpi_table_header header;	/* Common ACPI table header */
1064 };
1065 
1066 /* VRTC entry */
1067 
1068 struct acpi_vrtc_entry {
1069 	struct acpi_generic_address physical_address;
1070 	u32 irq;
1071 };
1072 
1073 /*******************************************************************************
1074  *
1075  * WAET - Windows ACPI Emulated devices Table
1076  *        Version 1
1077  *
1078  * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
1079  *
1080  ******************************************************************************/
1081 
1082 struct acpi_table_waet {
1083 	struct acpi_table_header header;	/* Common ACPI table header */
1084 	u32 flags;
1085 };
1086 
1087 /* Masks for Flags field above */
1088 
1089 #define ACPI_WAET_RTC_NO_ACK        (1)	/* RTC requires no int acknowledge */
1090 #define ACPI_WAET_TIMER_ONE_READ    (1<<1)	/* PM timer requires only one read */
1091 
1092 /*******************************************************************************
1093  *
1094  * WDAT - Watchdog Action Table
1095  *        Version 1
1096  *
1097  * Conforms to "Hardware Watchdog Timers Design Specification",
1098  * Copyright 2006 Microsoft Corporation.
1099  *
1100  ******************************************************************************/
1101 
1102 struct acpi_table_wdat {
1103 	struct acpi_table_header header;	/* Common ACPI table header */
1104 	u32 header_length;	/* Watchdog Header Length */
1105 	u16 pci_segment;	/* PCI Segment number */
1106 	u8 pci_bus;		/* PCI Bus number */
1107 	u8 pci_device;		/* PCI Device number */
1108 	u8 pci_function;	/* PCI Function number */
1109 	u8 reserved[3];
1110 	u32 timer_period;	/* Period of one timer count (msec) */
1111 	u32 max_count;		/* Maximum counter value supported */
1112 	u32 min_count;		/* Minimum counter value */
1113 	u8 flags;
1114 	u8 reserved2[3];
1115 	u32 entries;		/* Number of watchdog entries that follow */
1116 };
1117 
1118 /* Masks for Flags field above */
1119 
1120 #define ACPI_WDAT_ENABLED           (1)
1121 #define ACPI_WDAT_STOPPED           0x80
1122 
1123 /* WDAT Instruction Entries (actions) */
1124 
1125 struct acpi_wdat_entry {
1126 	u8 action;
1127 	u8 instruction;
1128 	u16 reserved;
1129 	struct acpi_generic_address register_region;
1130 	u32 value;		/* Value used with Read/Write register */
1131 	u32 mask;		/* Bitmask required for this register instruction */
1132 };
1133 
1134 /* Values for Action field above */
1135 
1136 enum acpi_wdat_actions {
1137 	ACPI_WDAT_RESET = 1,
1138 	ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
1139 	ACPI_WDAT_GET_COUNTDOWN = 5,
1140 	ACPI_WDAT_SET_COUNTDOWN = 6,
1141 	ACPI_WDAT_GET_RUNNING_STATE = 8,
1142 	ACPI_WDAT_SET_RUNNING_STATE = 9,
1143 	ACPI_WDAT_GET_STOPPED_STATE = 10,
1144 	ACPI_WDAT_SET_STOPPED_STATE = 11,
1145 	ACPI_WDAT_GET_REBOOT = 16,
1146 	ACPI_WDAT_SET_REBOOT = 17,
1147 	ACPI_WDAT_GET_SHUTDOWN = 18,
1148 	ACPI_WDAT_SET_SHUTDOWN = 19,
1149 	ACPI_WDAT_GET_STATUS = 32,
1150 	ACPI_WDAT_SET_STATUS = 33,
1151 	ACPI_WDAT_ACTION_RESERVED = 34	/* 34 and greater are reserved */
1152 };
1153 
1154 /* Values for Instruction field above */
1155 
1156 enum acpi_wdat_instructions {
1157 	ACPI_WDAT_READ_VALUE = 0,
1158 	ACPI_WDAT_READ_COUNTDOWN = 1,
1159 	ACPI_WDAT_WRITE_VALUE = 2,
1160 	ACPI_WDAT_WRITE_COUNTDOWN = 3,
1161 	ACPI_WDAT_INSTRUCTION_RESERVED = 4,	/* 4 and greater are reserved */
1162 	ACPI_WDAT_PRESERVE_REGISTER = 0x80	/* Except for this value */
1163 };
1164 
1165 /*******************************************************************************
1166  *
1167  * WDDT - Watchdog Descriptor Table
1168  *        Version 1
1169  *
1170  * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
1171  * Version 001, September 2002
1172  *
1173  ******************************************************************************/
1174 
1175 struct acpi_table_wddt {
1176 	struct acpi_table_header header;	/* Common ACPI table header */
1177 	u16 spec_version;
1178 	u16 table_version;
1179 	u16 pci_vendor_id;
1180 	struct acpi_generic_address address;
1181 	u16 max_count;		/* Maximum counter value supported */
1182 	u16 min_count;		/* Minimum counter value supported */
1183 	u16 period;
1184 	u16 status;
1185 	u16 capability;
1186 };
1187 
1188 /* Flags for Status field above */
1189 
1190 #define ACPI_WDDT_AVAILABLE     (1)
1191 #define ACPI_WDDT_ACTIVE        (1<<1)
1192 #define ACPI_WDDT_TCO_OS_OWNED  (1<<2)
1193 #define ACPI_WDDT_USER_RESET    (1<<11)
1194 #define ACPI_WDDT_WDT_RESET     (1<<12)
1195 #define ACPI_WDDT_POWER_FAIL    (1<<13)
1196 #define ACPI_WDDT_UNKNOWN_RESET (1<<14)
1197 
1198 /* Flags for Capability field above */
1199 
1200 #define ACPI_WDDT_AUTO_RESET    (1)
1201 #define ACPI_WDDT_ALERT_SUPPORT (1<<1)
1202 
1203 /*******************************************************************************
1204  *
1205  * WDRT - Watchdog Resource Table
1206  *        Version 1
1207  *
1208  * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
1209  * Version 1.01, August 28, 2006
1210  *
1211  ******************************************************************************/
1212 
1213 struct acpi_table_wdrt {
1214 	struct acpi_table_header header;	/* Common ACPI table header */
1215 	struct acpi_generic_address control_register;
1216 	struct acpi_generic_address count_register;
1217 	u16 pci_device_id;
1218 	u16 pci_vendor_id;
1219 	u8 pci_bus;		/* PCI Bus number */
1220 	u8 pci_device;		/* PCI Device number */
1221 	u8 pci_function;	/* PCI Function number */
1222 	u8 pci_segment;		/* PCI Segment number */
1223 	u16 max_count;		/* Maximum counter value supported */
1224 	u8 units;
1225 };
1226 
1227 /* Reset to default packing */
1228 
1229 #pragma pack()
1230 
1231 #endif				/* __ACTBL2_H__ */
1232