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