Loading...
1/******************************************************************************
2 *
3 * Name: actbl3.h - ACPI Table Definitions
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2016, 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 __ACTBL3_H__
45#define __ACTBL3_H__
46
47/*******************************************************************************
48 *
49 * Additional ACPI Tables (3)
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 * In general, the tables in this file are fully defined within the ACPI
55 * specification.
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_BGRT "BGRT" /* Boot Graphics Resource Table */
65#define ACPI_SIG_DRTM "DRTM" /* Dynamic Root of Trust for Measurement table */
66#define ACPI_SIG_FPDT "FPDT" /* Firmware Performance Data Table */
67#define ACPI_SIG_GTDT "GTDT" /* Generic Timer Description Table */
68#define ACPI_SIG_MPST "MPST" /* Memory Power State Table */
69#define ACPI_SIG_PCCT "PCCT" /* Platform Communications Channel Table */
70#define ACPI_SIG_PMTT "PMTT" /* Platform Memory Topology Table */
71#define ACPI_SIG_RASF "RASF" /* RAS Feature table */
72#define ACPI_SIG_STAO "STAO" /* Status Override table */
73#define ACPI_SIG_WPBT "WPBT" /* Windows Platform Binary Table */
74#define ACPI_SIG_XENV "XENV" /* Xen Environment table */
75
76#define ACPI_SIG_S3PT "S3PT" /* S3 Performance (sub)Table */
77#define ACPI_SIG_PCCS "PCC" /* PCC Shared Memory Region */
78
79/* Reserved table signatures */
80
81#define ACPI_SIG_MATR "MATR" /* Memory Address Translation Table */
82#define ACPI_SIG_MSDM "MSDM" /* Microsoft Data Management Table */
83
84/*
85 * All tables must be byte-packed to match the ACPI specification, since
86 * the tables are provided by the system BIOS.
87 */
88#pragma pack(1)
89
90/*
91 * Note: C bitfields are not used for this reason:
92 *
93 * "Bitfields are great and easy to read, but unfortunately the C language
94 * does not specify the layout of bitfields in memory, which means they are
95 * essentially useless for dealing with packed data in on-disk formats or
96 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
97 * this decision was a design error in C. Ritchie could have picked an order
98 * and stuck with it." Norman Ramsey.
99 * See http://stackoverflow.com/a/1053662/41661
100 */
101
102/*******************************************************************************
103 *
104 * BGRT - Boot Graphics Resource Table (ACPI 5.0)
105 * Version 1
106 *
107 ******************************************************************************/
108
109struct acpi_table_bgrt {
110 struct acpi_table_header header; /* Common ACPI table header */
111 u16 version;
112 u8 status;
113 u8 image_type;
114 u64 image_address;
115 u32 image_offset_x;
116 u32 image_offset_y;
117};
118
119/*******************************************************************************
120 *
121 * DRTM - Dynamic Root of Trust for Measurement table
122 * Conforms to "TCG D-RTM Architecture" June 17 2013, Version 1.0.0
123 * Table version 1
124 *
125 ******************************************************************************/
126
127struct acpi_table_drtm {
128 struct acpi_table_header header; /* Common ACPI table header */
129 u64 entry_base_address;
130 u64 entry_length;
131 u32 entry_address32;
132 u64 entry_address64;
133 u64 exit_address;
134 u64 log_area_address;
135 u32 log_area_length;
136 u64 arch_dependent_address;
137 u32 flags;
138};
139
140/* Flag Definitions for above */
141
142#define ACPI_DRTM_ACCESS_ALLOWED (1)
143#define ACPI_DRTM_ENABLE_GAP_CODE (1<<1)
144#define ACPI_DRTM_INCOMPLETE_MEASUREMENTS (1<<2)
145#define ACPI_DRTM_AUTHORITY_ORDER (1<<3)
146
147/* 1) Validated Tables List (64-bit addresses) */
148
149struct acpi_drtm_vtable_list {
150 u32 validated_table_count;
151 u64 validated_tables[1];
152};
153
154/* 2) Resources List (of Resource Descriptors) */
155
156/* Resource Descriptor */
157
158struct acpi_drtm_resource {
159 u8 size[7];
160 u8 type;
161 u64 address;
162};
163
164struct acpi_drtm_resource_list {
165 u32 resource_count;
166 struct acpi_drtm_resource resources[1];
167};
168
169/* 3) Platform-specific Identifiers List */
170
171struct acpi_drtm_dps_id {
172 u32 dps_id_length;
173 u8 dps_id[16];
174};
175
176/*******************************************************************************
177 *
178 * FPDT - Firmware Performance Data Table (ACPI 5.0)
179 * Version 1
180 *
181 ******************************************************************************/
182
183struct acpi_table_fpdt {
184 struct acpi_table_header header; /* Common ACPI table header */
185};
186
187/* FPDT subtable header */
188
189struct acpi_fpdt_header {
190 u16 type;
191 u8 length;
192 u8 revision;
193};
194
195/* Values for Type field above */
196
197enum acpi_fpdt_type {
198 ACPI_FPDT_TYPE_BOOT = 0,
199 ACPI_FPDT_TYPE_S3PERF = 1
200};
201
202/*
203 * FPDT subtables
204 */
205
206/* 0: Firmware Basic Boot Performance Record */
207
208struct acpi_fpdt_boot {
209 struct acpi_fpdt_header header;
210 u8 reserved[4];
211 u64 reset_end;
212 u64 load_start;
213 u64 startup_start;
214 u64 exit_services_entry;
215 u64 exit_services_exit;
216};
217
218/* 1: S3 Performance Table Pointer Record */
219
220struct acpi_fpdt_s3pt_ptr {
221 struct acpi_fpdt_header header;
222 u8 reserved[4];
223 u64 address;
224};
225
226/*
227 * S3PT - S3 Performance Table. This table is pointed to by the
228 * FPDT S3 Pointer Record above.
229 */
230struct acpi_table_s3pt {
231 u8 signature[4]; /* "S3PT" */
232 u32 length;
233};
234
235/*
236 * S3PT Subtables
237 */
238struct acpi_s3pt_header {
239 u16 type;
240 u8 length;
241 u8 revision;
242};
243
244/* Values for Type field above */
245
246enum acpi_s3pt_type {
247 ACPI_S3PT_TYPE_RESUME = 0,
248 ACPI_S3PT_TYPE_SUSPEND = 1
249};
250
251struct acpi_s3pt_resume {
252 struct acpi_s3pt_header header;
253 u32 resume_count;
254 u64 full_resume;
255 u64 average_resume;
256};
257
258struct acpi_s3pt_suspend {
259 struct acpi_s3pt_header header;
260 u64 suspend_start;
261 u64 suspend_end;
262};
263
264/*******************************************************************************
265 *
266 * GTDT - Generic Timer Description Table (ACPI 5.1)
267 * Version 2
268 *
269 ******************************************************************************/
270
271struct acpi_table_gtdt {
272 struct acpi_table_header header; /* Common ACPI table header */
273 u64 counter_block_addresss;
274 u32 reserved;
275 u32 secure_el1_interrupt;
276 u32 secure_el1_flags;
277 u32 non_secure_el1_interrupt;
278 u32 non_secure_el1_flags;
279 u32 virtual_timer_interrupt;
280 u32 virtual_timer_flags;
281 u32 non_secure_el2_interrupt;
282 u32 non_secure_el2_flags;
283 u64 counter_read_block_address;
284 u32 platform_timer_count;
285 u32 platform_timer_offset;
286};
287
288/* Flag Definitions: Timer Block Physical Timers and Virtual timers */
289
290#define ACPI_GTDT_INTERRUPT_MODE (1)
291#define ACPI_GTDT_INTERRUPT_POLARITY (1<<1)
292#define ACPI_GTDT_ALWAYS_ON (1<<2)
293
294/* Common GTDT subtable header */
295
296struct acpi_gtdt_header {
297 u8 type;
298 u16 length;
299};
300
301/* Values for GTDT subtable type above */
302
303enum acpi_gtdt_type {
304 ACPI_GTDT_TYPE_TIMER_BLOCK = 0,
305 ACPI_GTDT_TYPE_WATCHDOG = 1,
306 ACPI_GTDT_TYPE_RESERVED = 2 /* 2 and greater are reserved */
307};
308
309/* GTDT Subtables, correspond to Type in struct acpi_gtdt_header */
310
311/* 0: Generic Timer Block */
312
313struct acpi_gtdt_timer_block {
314 struct acpi_gtdt_header header;
315 u8 reserved;
316 u64 block_address;
317 u32 timer_count;
318 u32 timer_offset;
319};
320
321/* Timer Sub-Structure, one per timer */
322
323struct acpi_gtdt_timer_entry {
324 u8 frame_number;
325 u8 reserved[3];
326 u64 base_address;
327 u64 el0_base_address;
328 u32 timer_interrupt;
329 u32 timer_flags;
330 u32 virtual_timer_interrupt;
331 u32 virtual_timer_flags;
332 u32 common_flags;
333};
334
335/* Flag Definitions: timer_flags and virtual_timer_flags above */
336
337#define ACPI_GTDT_GT_IRQ_MODE (1)
338#define ACPI_GTDT_GT_IRQ_POLARITY (1<<1)
339
340/* Flag Definitions: common_flags above */
341
342#define ACPI_GTDT_GT_IS_SECURE_TIMER (1)
343#define ACPI_GTDT_GT_ALWAYS_ON (1<<1)
344
345/* 1: SBSA Generic Watchdog Structure */
346
347struct acpi_gtdt_watchdog {
348 struct acpi_gtdt_header header;
349 u8 reserved;
350 u64 refresh_frame_address;
351 u64 control_frame_address;
352 u32 timer_interrupt;
353 u32 timer_flags;
354};
355
356/* Flag Definitions: timer_flags above */
357
358#define ACPI_GTDT_WATCHDOG_IRQ_MODE (1)
359#define ACPI_GTDT_WATCHDOG_IRQ_POLARITY (1<<1)
360#define ACPI_GTDT_WATCHDOG_SECURE (1<<2)
361
362/*******************************************************************************
363 *
364 * MPST - Memory Power State Table (ACPI 5.0)
365 * Version 1
366 *
367 ******************************************************************************/
368
369#define ACPI_MPST_CHANNEL_INFO \
370 u8 channel_id; \
371 u8 reserved1[3]; \
372 u16 power_node_count; \
373 u16 reserved2;
374
375/* Main table */
376
377struct acpi_table_mpst {
378 struct acpi_table_header header; /* Common ACPI table header */
379 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
380};
381
382/* Memory Platform Communication Channel Info */
383
384struct acpi_mpst_channel {
385 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
386};
387
388/* Memory Power Node Structure */
389
390struct acpi_mpst_power_node {
391 u8 flags;
392 u8 reserved1;
393 u16 node_id;
394 u32 length;
395 u64 range_address;
396 u64 range_length;
397 u32 num_power_states;
398 u32 num_physical_components;
399};
400
401/* Values for Flags field above */
402
403#define ACPI_MPST_ENABLED 1
404#define ACPI_MPST_POWER_MANAGED 2
405#define ACPI_MPST_HOT_PLUG_CAPABLE 4
406
407/* Memory Power State Structure (follows POWER_NODE above) */
408
409struct acpi_mpst_power_state {
410 u8 power_state;
411 u8 info_index;
412};
413
414/* Physical Component ID Structure (follows POWER_STATE above) */
415
416struct acpi_mpst_component {
417 u16 component_id;
418};
419
420/* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
421
422struct acpi_mpst_data_hdr {
423 u16 characteristics_count;
424 u16 reserved;
425};
426
427struct acpi_mpst_power_data {
428 u8 structure_id;
429 u8 flags;
430 u16 reserved1;
431 u32 average_power;
432 u32 power_saving;
433 u64 exit_latency;
434 u64 reserved2;
435};
436
437/* Values for Flags field above */
438
439#define ACPI_MPST_PRESERVE 1
440#define ACPI_MPST_AUTOENTRY 2
441#define ACPI_MPST_AUTOEXIT 4
442
443/* Shared Memory Region (not part of an ACPI table) */
444
445struct acpi_mpst_shared {
446 u32 signature;
447 u16 pcc_command;
448 u16 pcc_status;
449 u32 command_register;
450 u32 status_register;
451 u32 power_state_id;
452 u32 power_node_id;
453 u64 energy_consumed;
454 u64 average_power;
455};
456
457/*******************************************************************************
458 *
459 * PCCT - Platform Communications Channel Table (ACPI 5.0)
460 * Version 1
461 *
462 ******************************************************************************/
463
464struct acpi_table_pcct {
465 struct acpi_table_header header; /* Common ACPI table header */
466 u32 flags;
467 u64 reserved;
468};
469
470/* Values for Flags field above */
471
472#define ACPI_PCCT_DOORBELL 1
473
474/* Values for subtable type in struct acpi_subtable_header */
475
476enum acpi_pcct_type {
477 ACPI_PCCT_TYPE_GENERIC_SUBSPACE = 0,
478 ACPI_PCCT_TYPE_HW_REDUCED_SUBSPACE = 1,
479 ACPI_PCCT_TYPE_RESERVED = 2 /* 2 and greater are reserved */
480};
481
482/*
483 * PCCT Subtables, correspond to Type in struct acpi_subtable_header
484 */
485
486/* 0: Generic Communications Subspace */
487
488struct acpi_pcct_subspace {
489 struct acpi_subtable_header header;
490 u8 reserved[6];
491 u64 base_address;
492 u64 length;
493 struct acpi_generic_address doorbell_register;
494 u64 preserve_mask;
495 u64 write_mask;
496 u32 latency;
497 u32 max_access_rate;
498 u16 min_turnaround_time;
499};
500
501/* 1: HW-reduced Communications Subspace (ACPI 5.1) */
502
503struct acpi_pcct_hw_reduced {
504 struct acpi_subtable_header header;
505 u32 doorbell_interrupt;
506 u8 flags;
507 u8 reserved;
508 u64 base_address;
509 u64 length;
510 struct acpi_generic_address doorbell_register;
511 u64 preserve_mask;
512 u64 write_mask;
513 u32 latency;
514 u32 max_access_rate;
515 u16 min_turnaround_time;
516};
517
518/* Values for doorbell flags above */
519
520#define ACPI_PCCT_INTERRUPT_POLARITY (1)
521#define ACPI_PCCT_INTERRUPT_MODE (1<<1)
522
523/*
524 * PCC memory structures (not part of the ACPI table)
525 */
526
527/* Shared Memory Region */
528
529struct acpi_pcct_shared_memory {
530 u32 signature;
531 u16 command;
532 u16 status;
533};
534
535/*******************************************************************************
536 *
537 * PMTT - Platform Memory Topology Table (ACPI 5.0)
538 * Version 1
539 *
540 ******************************************************************************/
541
542struct acpi_table_pmtt {
543 struct acpi_table_header header; /* Common ACPI table header */
544 u32 reserved;
545};
546
547/* Common header for PMTT subtables that follow main table */
548
549struct acpi_pmtt_header {
550 u8 type;
551 u8 reserved1;
552 u16 length;
553 u16 flags;
554 u16 reserved2;
555};
556
557/* Values for Type field above */
558
559#define ACPI_PMTT_TYPE_SOCKET 0
560#define ACPI_PMTT_TYPE_CONTROLLER 1
561#define ACPI_PMTT_TYPE_DIMM 2
562#define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */
563
564/* Values for Flags field above */
565
566#define ACPI_PMTT_TOP_LEVEL 0x0001
567#define ACPI_PMTT_PHYSICAL 0x0002
568#define ACPI_PMTT_MEMORY_TYPE 0x000C
569
570/*
571 * PMTT subtables, correspond to Type in struct acpi_pmtt_header
572 */
573
574/* 0: Socket Structure */
575
576struct acpi_pmtt_socket {
577 struct acpi_pmtt_header header;
578 u16 socket_id;
579 u16 reserved;
580};
581
582/* 1: Memory Controller subtable */
583
584struct acpi_pmtt_controller {
585 struct acpi_pmtt_header header;
586 u32 read_latency;
587 u32 write_latency;
588 u32 read_bandwidth;
589 u32 write_bandwidth;
590 u16 access_width;
591 u16 alignment;
592 u16 reserved;
593 u16 domain_count;
594};
595
596/* 1a: Proximity Domain substructure */
597
598struct acpi_pmtt_domain {
599 u32 proximity_domain;
600};
601
602/* 2: Physical Component Identifier (DIMM) */
603
604struct acpi_pmtt_physical_component {
605 struct acpi_pmtt_header header;
606 u16 component_id;
607 u16 reserved;
608 u32 memory_size;
609 u32 bios_handle;
610};
611
612/*******************************************************************************
613 *
614 * RASF - RAS Feature Table (ACPI 5.0)
615 * Version 1
616 *
617 ******************************************************************************/
618
619struct acpi_table_rasf {
620 struct acpi_table_header header; /* Common ACPI table header */
621 u8 channel_id[12];
622};
623
624/* RASF Platform Communication Channel Shared Memory Region */
625
626struct acpi_rasf_shared_memory {
627 u32 signature;
628 u16 command;
629 u16 status;
630 u16 version;
631 u8 capabilities[16];
632 u8 set_capabilities[16];
633 u16 num_parameter_blocks;
634 u32 set_capabilities_status;
635};
636
637/* RASF Parameter Block Structure Header */
638
639struct acpi_rasf_parameter_block {
640 u16 type;
641 u16 version;
642 u16 length;
643};
644
645/* RASF Parameter Block Structure for PATROL_SCRUB */
646
647struct acpi_rasf_patrol_scrub_parameter {
648 struct acpi_rasf_parameter_block header;
649 u16 patrol_scrub_command;
650 u64 requested_address_range[2];
651 u64 actual_address_range[2];
652 u16 flags;
653 u8 requested_speed;
654};
655
656/* Masks for Flags and Speed fields above */
657
658#define ACPI_RASF_SCRUBBER_RUNNING 1
659#define ACPI_RASF_SPEED (7<<1)
660#define ACPI_RASF_SPEED_SLOW (0<<1)
661#define ACPI_RASF_SPEED_MEDIUM (4<<1)
662#define ACPI_RASF_SPEED_FAST (7<<1)
663
664/* Channel Commands */
665
666enum acpi_rasf_commands {
667 ACPI_RASF_EXECUTE_RASF_COMMAND = 1
668};
669
670/* Platform RAS Capabilities */
671
672enum acpi_rasf_capabiliities {
673 ACPI_HW_PATROL_SCRUB_SUPPORTED = 0,
674 ACPI_SW_PATROL_SCRUB_EXPOSED = 1
675};
676
677/* Patrol Scrub Commands */
678
679enum acpi_rasf_patrol_scrub_commands {
680 ACPI_RASF_GET_PATROL_PARAMETERS = 1,
681 ACPI_RASF_START_PATROL_SCRUBBER = 2,
682 ACPI_RASF_STOP_PATROL_SCRUBBER = 3
683};
684
685/* Channel Command flags */
686
687#define ACPI_RASF_GENERATE_SCI (1<<15)
688
689/* Status values */
690
691enum acpi_rasf_status {
692 ACPI_RASF_SUCCESS = 0,
693 ACPI_RASF_NOT_VALID = 1,
694 ACPI_RASF_NOT_SUPPORTED = 2,
695 ACPI_RASF_BUSY = 3,
696 ACPI_RASF_FAILED = 4,
697 ACPI_RASF_ABORTED = 5,
698 ACPI_RASF_INVALID_DATA = 6
699};
700
701/* Status flags */
702
703#define ACPI_RASF_COMMAND_COMPLETE (1)
704#define ACPI_RASF_SCI_DOORBELL (1<<1)
705#define ACPI_RASF_ERROR (1<<2)
706#define ACPI_RASF_STATUS (0x1F<<3)
707
708/*******************************************************************************
709 *
710 * STAO - Status Override Table (_STA override) - ACPI 6.0
711 * Version 1
712 *
713 * Conforms to "ACPI Specification for Status Override Table"
714 * 6 January 2015
715 *
716 ******************************************************************************/
717
718struct acpi_table_stao {
719 struct acpi_table_header header; /* Common ACPI table header */
720 u8 ignore_uart;
721};
722
723/*******************************************************************************
724 *
725 * WPBT - Windows Platform Environment Table (ACPI 6.0)
726 * Version 1
727 *
728 * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
729 *
730 ******************************************************************************/
731
732struct acpi_table_wpbt {
733 struct acpi_table_header header; /* Common ACPI table header */
734 u32 handoff_size;
735 u64 handoff_address;
736 u8 layout;
737 u8 type;
738 u16 arguments_length;
739};
740
741/*******************************************************************************
742 *
743 * XENV - Xen Environment Table (ACPI 6.0)
744 * Version 1
745 *
746 * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
747 *
748 ******************************************************************************/
749
750struct acpi_table_xenv {
751 struct acpi_table_header header; /* Common ACPI table header */
752 u64 grant_table_address;
753 u64 grant_table_size;
754 u32 event_interrupt;
755 u8 event_flags;
756};
757
758/* Reset to default packing */
759
760#pragma pack()
761
762#endif /* __ACTBL3_H__ */
1/* SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0 */
2/******************************************************************************
3 *
4 * Name: actbl3.h - ACPI Table Definitions
5 *
6 * Copyright (C) 2000 - 2019, Intel Corp.
7 *
8 *****************************************************************************/
9
10#ifndef __ACTBL3_H__
11#define __ACTBL3_H__
12
13/*******************************************************************************
14 *
15 * Additional ACPI Tables
16 *
17 * These tables are not consumed directly by the ACPICA subsystem, but are
18 * included here to support device drivers and the AML disassembler.
19 *
20 ******************************************************************************/
21
22/*
23 * Values for description table header signatures for tables defined in this
24 * file. Useful because they make it more difficult to inadvertently type in
25 * the wrong signature.
26 */
27#define ACPI_SIG_SLIC "SLIC" /* Software Licensing Description Table */
28#define ACPI_SIG_SLIT "SLIT" /* System Locality Distance Information Table */
29#define ACPI_SIG_SPCR "SPCR" /* Serial Port Console Redirection table */
30#define ACPI_SIG_SPMI "SPMI" /* Server Platform Management Interface table */
31#define ACPI_SIG_SRAT "SRAT" /* System Resource Affinity Table */
32#define ACPI_SIG_STAO "STAO" /* Status Override table */
33#define ACPI_SIG_TCPA "TCPA" /* Trusted Computing Platform Alliance table */
34#define ACPI_SIG_TPM2 "TPM2" /* Trusted Platform Module 2.0 H/W interface table */
35#define ACPI_SIG_UEFI "UEFI" /* Uefi Boot Optimization Table */
36#define ACPI_SIG_VRTC "VRTC" /* Virtual Real Time Clock Table */
37#define ACPI_SIG_WAET "WAET" /* Windows ACPI Emulated devices Table */
38#define ACPI_SIG_WDAT "WDAT" /* Watchdog Action Table */
39#define ACPI_SIG_WDDT "WDDT" /* Watchdog Timer Description Table */
40#define ACPI_SIG_WDRT "WDRT" /* Watchdog Resource Table */
41#define ACPI_SIG_WPBT "WPBT" /* Windows Platform Binary Table */
42#define ACPI_SIG_WSMT "WSMT" /* Windows SMM Security Migrations Table */
43#define ACPI_SIG_XENV "XENV" /* Xen Environment table */
44#define ACPI_SIG_XXXX "XXXX" /* Intermediate AML header for ASL/ASL+ converter */
45
46/*
47 * All tables must be byte-packed to match the ACPI specification, since
48 * the tables are provided by the system BIOS.
49 */
50#pragma pack(1)
51
52/*
53 * Note: C bitfields are not used for this reason:
54 *
55 * "Bitfields are great and easy to read, but unfortunately the C language
56 * does not specify the layout of bitfields in memory, which means they are
57 * essentially useless for dealing with packed data in on-disk formats or
58 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
59 * this decision was a design error in C. Ritchie could have picked an order
60 * and stuck with it." Norman Ramsey.
61 * See http://stackoverflow.com/a/1053662/41661
62 */
63
64/*******************************************************************************
65 *
66 * SLIC - Software Licensing Description Table
67 *
68 * Conforms to "Microsoft Software Licensing Tables (SLIC and MSDM)",
69 * November 29, 2011. Copyright 2011 Microsoft
70 *
71 ******************************************************************************/
72
73/* Basic SLIC table is only the common ACPI header */
74
75struct acpi_table_slic {
76 struct acpi_table_header header; /* Common ACPI table header */
77};
78
79/*******************************************************************************
80 *
81 * SLIT - System Locality Distance Information Table
82 * Version 1
83 *
84 ******************************************************************************/
85
86struct acpi_table_slit {
87 struct acpi_table_header header; /* Common ACPI table header */
88 u64 locality_count;
89 u8 entry[1]; /* Real size = localities^2 */
90};
91
92/*******************************************************************************
93 *
94 * SPCR - Serial Port Console Redirection table
95 * Version 2
96 *
97 * Conforms to "Serial Port Console Redirection Table",
98 * Version 1.03, August 10, 2015
99 *
100 ******************************************************************************/
101
102struct acpi_table_spcr {
103 struct acpi_table_header header; /* Common ACPI table header */
104 u8 interface_type; /* 0=full 16550, 1=subset of 16550 */
105 u8 reserved[3];
106 struct acpi_generic_address serial_port;
107 u8 interrupt_type;
108 u8 pc_interrupt;
109 u32 interrupt;
110 u8 baud_rate;
111 u8 parity;
112 u8 stop_bits;
113 u8 flow_control;
114 u8 terminal_type;
115 u8 reserved1;
116 u16 pci_device_id;
117 u16 pci_vendor_id;
118 u8 pci_bus;
119 u8 pci_device;
120 u8 pci_function;
121 u32 pci_flags;
122 u8 pci_segment;
123 u32 reserved2;
124};
125
126/* Masks for pci_flags field above */
127
128#define ACPI_SPCR_DO_NOT_DISABLE (1)
129
130/* Values for Interface Type: See the definition of the DBG2 table */
131
132/*******************************************************************************
133 *
134 * SPMI - Server Platform Management Interface table
135 * Version 5
136 *
137 * Conforms to "Intelligent Platform Management Interface Specification
138 * Second Generation v2.0", Document Revision 1.0, February 12, 2004 with
139 * June 12, 2009 markup.
140 *
141 ******************************************************************************/
142
143struct acpi_table_spmi {
144 struct acpi_table_header header; /* Common ACPI table header */
145 u8 interface_type;
146 u8 reserved; /* Must be 1 */
147 u16 spec_revision; /* Version of IPMI */
148 u8 interrupt_type;
149 u8 gpe_number; /* GPE assigned */
150 u8 reserved1;
151 u8 pci_device_flag;
152 u32 interrupt;
153 struct acpi_generic_address ipmi_register;
154 u8 pci_segment;
155 u8 pci_bus;
156 u8 pci_device;
157 u8 pci_function;
158 u8 reserved2;
159};
160
161/* Values for interface_type above */
162
163enum acpi_spmi_interface_types {
164 ACPI_SPMI_NOT_USED = 0,
165 ACPI_SPMI_KEYBOARD = 1,
166 ACPI_SPMI_SMI = 2,
167 ACPI_SPMI_BLOCK_TRANSFER = 3,
168 ACPI_SPMI_SMBUS = 4,
169 ACPI_SPMI_RESERVED = 5 /* 5 and above are reserved */
170};
171
172/*******************************************************************************
173 *
174 * SRAT - System Resource Affinity Table
175 * Version 3
176 *
177 ******************************************************************************/
178
179struct acpi_table_srat {
180 struct acpi_table_header header; /* Common ACPI table header */
181 u32 table_revision; /* Must be value '1' */
182 u64 reserved; /* Reserved, must be zero */
183};
184
185/* Values for subtable type in struct acpi_subtable_header */
186
187enum acpi_srat_type {
188 ACPI_SRAT_TYPE_CPU_AFFINITY = 0,
189 ACPI_SRAT_TYPE_MEMORY_AFFINITY = 1,
190 ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY = 2,
191 ACPI_SRAT_TYPE_GICC_AFFINITY = 3,
192 ACPI_SRAT_TYPE_GIC_ITS_AFFINITY = 4, /* ACPI 6.2 */
193 ACPI_SRAT_TYPE_GENERIC_AFFINITY = 5, /* ACPI 6.3 */
194 ACPI_SRAT_TYPE_RESERVED = 6 /* 5 and greater are reserved */
195};
196
197/*
198 * SRAT Subtables, correspond to Type in struct acpi_subtable_header
199 */
200
201/* 0: Processor Local APIC/SAPIC Affinity */
202
203struct acpi_srat_cpu_affinity {
204 struct acpi_subtable_header header;
205 u8 proximity_domain_lo;
206 u8 apic_id;
207 u32 flags;
208 u8 local_sapic_eid;
209 u8 proximity_domain_hi[3];
210 u32 clock_domain;
211};
212
213/* Flags */
214
215#define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
216
217/* 1: Memory Affinity */
218
219struct acpi_srat_mem_affinity {
220 struct acpi_subtable_header header;
221 u32 proximity_domain;
222 u16 reserved; /* Reserved, must be zero */
223 u64 base_address;
224 u64 length;
225 u32 reserved1;
226 u32 flags;
227 u64 reserved2; /* Reserved, must be zero */
228};
229
230/* Flags */
231
232#define ACPI_SRAT_MEM_ENABLED (1) /* 00: Use affinity structure */
233#define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1) /* 01: Memory region is hot pluggable */
234#define ACPI_SRAT_MEM_NON_VOLATILE (1<<2) /* 02: Memory region is non-volatile */
235
236/* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
237
238struct acpi_srat_x2apic_cpu_affinity {
239 struct acpi_subtable_header header;
240 u16 reserved; /* Reserved, must be zero */
241 u32 proximity_domain;
242 u32 apic_id;
243 u32 flags;
244 u32 clock_domain;
245 u32 reserved2;
246};
247
248/* Flags for struct acpi_srat_cpu_affinity and struct acpi_srat_x2apic_cpu_affinity */
249
250#define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
251
252/* 3: GICC Affinity (ACPI 5.1) */
253
254struct acpi_srat_gicc_affinity {
255 struct acpi_subtable_header header;
256 u32 proximity_domain;
257 u32 acpi_processor_uid;
258 u32 flags;
259 u32 clock_domain;
260};
261
262/* Flags for struct acpi_srat_gicc_affinity */
263
264#define ACPI_SRAT_GICC_ENABLED (1) /* 00: Use affinity structure */
265
266/* 4: GCC ITS Affinity (ACPI 6.2) */
267
268struct acpi_srat_gic_its_affinity {
269 struct acpi_subtable_header header;
270 u32 proximity_domain;
271 u16 reserved;
272 u32 its_id;
273};
274
275/* 5: Generic Initiator Affinity Structure (ACPI 6.3) */
276
277struct acpi_srat_generic_affinity {
278 struct acpi_subtable_header header;
279 u8 reserved;
280 u8 device_handle_type;
281 u32 proximity_domain;
282 u8 device_handle[16];
283 u32 flags;
284 u32 reserved1;
285};
286
287/* Flags for struct acpi_srat_generic_affinity */
288
289#define ACPI_SRAT_GENERIC_AFFINITY_ENABLED (1) /* 00: Use affinity structure */
290
291/*******************************************************************************
292 *
293 * STAO - Status Override Table (_STA override) - ACPI 6.0
294 * Version 1
295 *
296 * Conforms to "ACPI Specification for Status Override Table"
297 * 6 January 2015
298 *
299 ******************************************************************************/
300
301struct acpi_table_stao {
302 struct acpi_table_header header; /* Common ACPI table header */
303 u8 ignore_uart;
304};
305
306/*******************************************************************************
307 *
308 * TCPA - Trusted Computing Platform Alliance table
309 * Version 2
310 *
311 * TCG Hardware Interface Table for TPM 1.2 Clients and Servers
312 *
313 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
314 * Version 1.2, Revision 8
315 * February 27, 2017
316 *
317 * NOTE: There are two versions of the table with the same signature --
318 * the client version and the server version. The common platform_class
319 * field is used to differentiate the two types of tables.
320 *
321 ******************************************************************************/
322
323struct acpi_table_tcpa_hdr {
324 struct acpi_table_header header; /* Common ACPI table header */
325 u16 platform_class;
326};
327
328/*
329 * Values for platform_class above.
330 * This is how the client and server subtables are differentiated
331 */
332#define ACPI_TCPA_CLIENT_TABLE 0
333#define ACPI_TCPA_SERVER_TABLE 1
334
335struct acpi_table_tcpa_client {
336 u32 minimum_log_length; /* Minimum length for the event log area */
337 u64 log_address; /* Address of the event log area */
338};
339
340struct acpi_table_tcpa_server {
341 u16 reserved;
342 u64 minimum_log_length; /* Minimum length for the event log area */
343 u64 log_address; /* Address of the event log area */
344 u16 spec_revision;
345 u8 device_flags;
346 u8 interrupt_flags;
347 u8 gpe_number;
348 u8 reserved2[3];
349 u32 global_interrupt;
350 struct acpi_generic_address address;
351 u32 reserved3;
352 struct acpi_generic_address config_address;
353 u8 group;
354 u8 bus; /* PCI Bus/Segment/Function numbers */
355 u8 device;
356 u8 function;
357};
358
359/* Values for device_flags above */
360
361#define ACPI_TCPA_PCI_DEVICE (1)
362#define ACPI_TCPA_BUS_PNP (1<<1)
363#define ACPI_TCPA_ADDRESS_VALID (1<<2)
364
365/* Values for interrupt_flags above */
366
367#define ACPI_TCPA_INTERRUPT_MODE (1)
368#define ACPI_TCPA_INTERRUPT_POLARITY (1<<1)
369#define ACPI_TCPA_SCI_VIA_GPE (1<<2)
370#define ACPI_TCPA_GLOBAL_INTERRUPT (1<<3)
371
372/*******************************************************************************
373 *
374 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
375 * Version 4
376 *
377 * TCG Hardware Interface Table for TPM 2.0 Clients and Servers
378 *
379 * Conforms to "TCG ACPI Specification, Family 1.2 and 2.0",
380 * Version 1.2, Revision 8
381 * February 27, 2017
382 *
383 ******************************************************************************/
384
385/* Revision 3 */
386
387struct acpi_table_tpm23 {
388 struct acpi_table_header header; /* Common ACPI table header */
389 u32 reserved;
390 u64 control_address;
391 u32 start_method;
392};
393
394/* Value for start_method above */
395
396#define ACPI_TPM23_ACPI_START_METHOD 2
397
398/*
399 * Optional trailer for revision 3. If start method is 2, there is a 4 byte
400 * reserved area of all zeros.
401 */
402struct acpi_tmp23_trailer {
403 u32 reserved;
404};
405
406/* Revision 4 */
407
408struct acpi_table_tpm2 {
409 struct acpi_table_header header; /* Common ACPI table header */
410 u16 platform_class;
411 u16 reserved;
412 u64 control_address;
413 u32 start_method;
414
415 /* Platform-specific data follows */
416};
417
418/* Values for start_method above */
419
420#define ACPI_TPM2_NOT_ALLOWED 0
421#define ACPI_TPM2_RESERVED1 1
422#define ACPI_TPM2_START_METHOD 2
423#define ACPI_TPM2_RESERVED3 3
424#define ACPI_TPM2_RESERVED4 4
425#define ACPI_TPM2_RESERVED5 5
426#define ACPI_TPM2_MEMORY_MAPPED 6
427#define ACPI_TPM2_COMMAND_BUFFER 7
428#define ACPI_TPM2_COMMAND_BUFFER_WITH_START_METHOD 8
429#define ACPI_TPM2_RESERVED9 9
430#define ACPI_TPM2_RESERVED10 10
431#define ACPI_TPM2_COMMAND_BUFFER_WITH_ARM_SMC 11 /* V1.2 Rev 8 */
432#define ACPI_TPM2_RESERVED 12
433
434/* Optional trailer appears after any start_method subtables */
435
436struct acpi_tpm2_trailer {
437 u8 method_parameters[12];
438 u32 minimum_log_length; /* Minimum length for the event log area */
439 u64 log_address; /* Address of the event log area */
440};
441
442/*
443 * Subtables (start_method-specific)
444 */
445
446/* 11: Start Method for ARM SMC (V1.2 Rev 8) */
447
448struct acpi_tpm2_arm_smc {
449 u32 global_interrupt;
450 u8 interrupt_flags;
451 u8 operation_flags;
452 u16 reserved;
453 u32 function_id;
454};
455
456/* Values for interrupt_flags above */
457
458#define ACPI_TPM2_INTERRUPT_SUPPORT (1)
459
460/* Values for operation_flags above */
461
462#define ACPI_TPM2_IDLE_SUPPORT (1)
463
464/*******************************************************************************
465 *
466 * UEFI - UEFI Boot optimization Table
467 * Version 1
468 *
469 * Conforms to "Unified Extensible Firmware Interface Specification",
470 * Version 2.3, May 8, 2009
471 *
472 ******************************************************************************/
473
474struct acpi_table_uefi {
475 struct acpi_table_header header; /* Common ACPI table header */
476 u8 identifier[16]; /* UUID identifier */
477 u16 data_offset; /* Offset of remaining data in table */
478};
479
480/*******************************************************************************
481 *
482 * VRTC - Virtual Real Time Clock Table
483 * Version 1
484 *
485 * Conforms to "Simple Firmware Interface Specification",
486 * Draft 0.8.2, Oct 19, 2010
487 * NOTE: The ACPI VRTC is equivalent to The SFI MRTC table.
488 *
489 ******************************************************************************/
490
491struct acpi_table_vrtc {
492 struct acpi_table_header header; /* Common ACPI table header */
493};
494
495/* VRTC entry */
496
497struct acpi_vrtc_entry {
498 struct acpi_generic_address physical_address;
499 u32 irq;
500};
501
502/*******************************************************************************
503 *
504 * WAET - Windows ACPI Emulated devices Table
505 * Version 1
506 *
507 * Conforms to "Windows ACPI Emulated Devices Table", version 1.0, April 6, 2009
508 *
509 ******************************************************************************/
510
511struct acpi_table_waet {
512 struct acpi_table_header header; /* Common ACPI table header */
513 u32 flags;
514};
515
516/* Masks for Flags field above */
517
518#define ACPI_WAET_RTC_NO_ACK (1) /* RTC requires no int acknowledge */
519#define ACPI_WAET_TIMER_ONE_READ (1<<1) /* PM timer requires only one read */
520
521/*******************************************************************************
522 *
523 * WDAT - Watchdog Action Table
524 * Version 1
525 *
526 * Conforms to "Hardware Watchdog Timers Design Specification",
527 * Copyright 2006 Microsoft Corporation.
528 *
529 ******************************************************************************/
530
531struct acpi_table_wdat {
532 struct acpi_table_header header; /* Common ACPI table header */
533 u32 header_length; /* Watchdog Header Length */
534 u16 pci_segment; /* PCI Segment number */
535 u8 pci_bus; /* PCI Bus number */
536 u8 pci_device; /* PCI Device number */
537 u8 pci_function; /* PCI Function number */
538 u8 reserved[3];
539 u32 timer_period; /* Period of one timer count (msec) */
540 u32 max_count; /* Maximum counter value supported */
541 u32 min_count; /* Minimum counter value */
542 u8 flags;
543 u8 reserved2[3];
544 u32 entries; /* Number of watchdog entries that follow */
545};
546
547/* Masks for Flags field above */
548
549#define ACPI_WDAT_ENABLED (1)
550#define ACPI_WDAT_STOPPED 0x80
551
552/* WDAT Instruction Entries (actions) */
553
554struct acpi_wdat_entry {
555 u8 action;
556 u8 instruction;
557 u16 reserved;
558 struct acpi_generic_address register_region;
559 u32 value; /* Value used with Read/Write register */
560 u32 mask; /* Bitmask required for this register instruction */
561};
562
563/* Values for Action field above */
564
565enum acpi_wdat_actions {
566 ACPI_WDAT_RESET = 1,
567 ACPI_WDAT_GET_CURRENT_COUNTDOWN = 4,
568 ACPI_WDAT_GET_COUNTDOWN = 5,
569 ACPI_WDAT_SET_COUNTDOWN = 6,
570 ACPI_WDAT_GET_RUNNING_STATE = 8,
571 ACPI_WDAT_SET_RUNNING_STATE = 9,
572 ACPI_WDAT_GET_STOPPED_STATE = 10,
573 ACPI_WDAT_SET_STOPPED_STATE = 11,
574 ACPI_WDAT_GET_REBOOT = 16,
575 ACPI_WDAT_SET_REBOOT = 17,
576 ACPI_WDAT_GET_SHUTDOWN = 18,
577 ACPI_WDAT_SET_SHUTDOWN = 19,
578 ACPI_WDAT_GET_STATUS = 32,
579 ACPI_WDAT_SET_STATUS = 33,
580 ACPI_WDAT_ACTION_RESERVED = 34 /* 34 and greater are reserved */
581};
582
583/* Values for Instruction field above */
584
585enum acpi_wdat_instructions {
586 ACPI_WDAT_READ_VALUE = 0,
587 ACPI_WDAT_READ_COUNTDOWN = 1,
588 ACPI_WDAT_WRITE_VALUE = 2,
589 ACPI_WDAT_WRITE_COUNTDOWN = 3,
590 ACPI_WDAT_INSTRUCTION_RESERVED = 4, /* 4 and greater are reserved */
591 ACPI_WDAT_PRESERVE_REGISTER = 0x80 /* Except for this value */
592};
593
594/*******************************************************************************
595 *
596 * WDDT - Watchdog Descriptor Table
597 * Version 1
598 *
599 * Conforms to "Using the Intel ICH Family Watchdog Timer (WDT)",
600 * Version 001, September 2002
601 *
602 ******************************************************************************/
603
604struct acpi_table_wddt {
605 struct acpi_table_header header; /* Common ACPI table header */
606 u16 spec_version;
607 u16 table_version;
608 u16 pci_vendor_id;
609 struct acpi_generic_address address;
610 u16 max_count; /* Maximum counter value supported */
611 u16 min_count; /* Minimum counter value supported */
612 u16 period;
613 u16 status;
614 u16 capability;
615};
616
617/* Flags for Status field above */
618
619#define ACPI_WDDT_AVAILABLE (1)
620#define ACPI_WDDT_ACTIVE (1<<1)
621#define ACPI_WDDT_TCO_OS_OWNED (1<<2)
622#define ACPI_WDDT_USER_RESET (1<<11)
623#define ACPI_WDDT_WDT_RESET (1<<12)
624#define ACPI_WDDT_POWER_FAIL (1<<13)
625#define ACPI_WDDT_UNKNOWN_RESET (1<<14)
626
627/* Flags for Capability field above */
628
629#define ACPI_WDDT_AUTO_RESET (1)
630#define ACPI_WDDT_ALERT_SUPPORT (1<<1)
631
632/*******************************************************************************
633 *
634 * WDRT - Watchdog Resource Table
635 * Version 1
636 *
637 * Conforms to "Watchdog Timer Hardware Requirements for Windows Server 2003",
638 * Version 1.01, August 28, 2006
639 *
640 ******************************************************************************/
641
642struct acpi_table_wdrt {
643 struct acpi_table_header header; /* Common ACPI table header */
644 struct acpi_generic_address control_register;
645 struct acpi_generic_address count_register;
646 u16 pci_device_id;
647 u16 pci_vendor_id;
648 u8 pci_bus; /* PCI Bus number */
649 u8 pci_device; /* PCI Device number */
650 u8 pci_function; /* PCI Function number */
651 u8 pci_segment; /* PCI Segment number */
652 u16 max_count; /* Maximum counter value supported */
653 u8 units;
654};
655
656/*******************************************************************************
657 *
658 * WPBT - Windows Platform Environment Table (ACPI 6.0)
659 * Version 1
660 *
661 * Conforms to "Windows Platform Binary Table (WPBT)" 29 November 2011
662 *
663 ******************************************************************************/
664
665struct acpi_table_wpbt {
666 struct acpi_table_header header; /* Common ACPI table header */
667 u32 handoff_size;
668 u64 handoff_address;
669 u8 layout;
670 u8 type;
671 u16 arguments_length;
672};
673
674/*******************************************************************************
675 *
676 * WSMT - Windows SMM Security Migrations Table
677 * Version 1
678 *
679 * Conforms to "Windows SMM Security Migrations Table",
680 * Version 1.0, April 18, 2016
681 *
682 ******************************************************************************/
683
684struct acpi_table_wsmt {
685 struct acpi_table_header header; /* Common ACPI table header */
686 u32 protection_flags;
687};
688
689/* Flags for protection_flags field above */
690
691#define ACPI_WSMT_FIXED_COMM_BUFFERS (1)
692#define ACPI_WSMT_COMM_BUFFER_NESTED_PTR_PROTECTION (2)
693#define ACPI_WSMT_SYSTEM_RESOURCE_PROTECTION (4)
694
695/*******************************************************************************
696 *
697 * XENV - Xen Environment Table (ACPI 6.0)
698 * Version 1
699 *
700 * Conforms to "ACPI Specification for Xen Environment Table" 4 January 2015
701 *
702 ******************************************************************************/
703
704struct acpi_table_xenv {
705 struct acpi_table_header header; /* Common ACPI table header */
706 u64 grant_table_address;
707 u64 grant_table_size;
708 u32 event_interrupt;
709 u8 event_flags;
710};
711
712/* Reset to default packing */
713
714#pragma pack()
715
716#endif /* __ACTBL3_H__ */