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