blob: e2c0931a3d675092f0757a98e61c3ecb75e15f0b [file] [log] [blame]
Bob Moorec5bd6532011-11-16 11:04:00 +08001/******************************************************************************
2 *
3 * Name: actbl3.h - ACPI Table Definitions
4 *
5 *****************************************************************************/
6
7/*
Bob Moore25f044e2013-01-25 05:38:56 +00008 * Copyright (C) 2000 - 2013, Intel Corp.
Bob Moorec5bd6532011-11-16 11:04:00 +08009 * 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 * The tables in this file are fully defined within the ACPI specification.
55 *
56 ******************************************************************************/
57
58/*
59 * Values for description table header signatures for tables defined in this
60 * file. Useful because they make it more difficult to inadvertently type in
61 * the wrong signature.
62 */
63#define ACPI_SIG_BGRT "BGRT" /* Boot Graphics Resource Table */
64#define ACPI_SIG_DRTM "DRTM" /* Dynamic Root of Trust for Measurement table */
65#define ACPI_SIG_FPDT "FPDT" /* Firmware Performance Data Table */
66#define ACPI_SIG_GTDT "GTDT" /* Generic Timer Description Table */
67#define ACPI_SIG_MPST "MPST" /* Memory Power State Table */
68#define ACPI_SIG_PCCT "PCCT" /* Platform Communications Channel Table */
69#define ACPI_SIG_PMTT "PMTT" /* Platform Memory Topology Table */
70#define ACPI_SIG_RASF "RASF" /* RAS Feature table */
Bob Moore99c93f52012-12-31 00:05:52 +000071#define ACPI_SIG_TPM2 "TPM2" /* Trusted Platform Module 2.0 H/W interface table */
Bob Moorec5bd6532011-11-16 11:04:00 +080072
73#define ACPI_SIG_S3PT "S3PT" /* S3 Performance (sub)Table */
74#define ACPI_SIG_PCCS "PCC" /* PCC Shared Memory Region */
75
76/* Reserved table signatures */
77
Bob Moorec5bd6532011-11-16 11:04:00 +080078#define ACPI_SIG_MATR "MATR" /* Memory Address Translation Table */
79#define ACPI_SIG_MSDM "MSDM" /* Microsoft Data Management Table */
80#define ACPI_SIG_WPBT "WPBT" /* Windows Platform Binary Table */
81
82/*
83 * All tables must be byte-packed to match the ACPI specification, since
84 * the tables are provided by the system BIOS.
85 */
86#pragma pack(1)
87
88/*
Bob Moorebe030a52012-08-17 13:07:54 +080089 * Note: C bitfields are not used for this reason:
90 *
91 * "Bitfields are great and easy to read, but unfortunately the C language
92 * does not specify the layout of bitfields in memory, which means they are
93 * essentially useless for dealing with packed data in on-disk formats or
94 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
95 * this decision was a design error in C. Ritchie could have picked an order
96 * and stuck with it." Norman Ramsey.
97 * See http://stackoverflow.com/a/1053662/41661
Bob Moorec5bd6532011-11-16 11:04:00 +080098 */
99
100/*******************************************************************************
101 *
102 * BGRT - Boot Graphics Resource Table (ACPI 5.0)
103 * Version 1
104 *
105 ******************************************************************************/
106
107struct acpi_table_bgrt {
108 struct acpi_table_header header; /* Common ACPI table header */
109 u16 version;
110 u8 status;
111 u8 image_type;
112 u64 image_address;
113 u32 image_offset_x;
114 u32 image_offset_y;
115};
116
117/*******************************************************************************
118 *
119 * DRTM - Dynamic Root of Trust for Measurement table
120 *
121 ******************************************************************************/
122
123struct acpi_table_drtm {
124 struct acpi_table_header header; /* Common ACPI table header */
125 u64 entry_base_address;
126 u64 entry_length;
127 u32 entry_address32;
128 u64 entry_address64;
129 u64 exit_address;
130 u64 log_area_address;
131 u32 log_area_length;
132 u64 arch_dependent_address;
133 u32 flags;
134};
135
136/* 1) Validated Tables List */
137
138struct acpi_drtm_vtl_list {
139 u32 validated_table_list_count;
140};
141
142/* 2) Resources List */
143
144struct acpi_drtm_resource_list {
145 u32 resource_list_count;
146};
147
148/* 3) Platform-specific Identifiers List */
149
150struct acpi_drtm_id_list {
151 u32 id_list_count;
152};
153
154/*******************************************************************************
155 *
156 * FPDT - Firmware Performance Data Table (ACPI 5.0)
157 * Version 1
158 *
159 ******************************************************************************/
160
161struct acpi_table_fpdt {
162 struct acpi_table_header header; /* Common ACPI table header */
163};
164
165/* FPDT subtable header */
166
167struct acpi_fpdt_header {
168 u16 type;
169 u8 length;
170 u8 revision;
171};
172
173/* Values for Type field above */
174
175enum acpi_fpdt_type {
176 ACPI_FPDT_TYPE_BOOT = 0,
Bob Moore6be58e22013-03-08 09:22:48 +0000177 ACPI_FPDT_TYPE_S3PERF = 1
Bob Moorec5bd6532011-11-16 11:04:00 +0800178};
179
180/*
181 * FPDT subtables
182 */
183
184/* 0: Firmware Basic Boot Performance Record */
185
186struct acpi_fpdt_boot {
187 struct acpi_fpdt_header header;
188 u8 reserved[4];
189 u64 reset_end;
190 u64 load_start;
191 u64 startup_start;
192 u64 exit_services_entry;
193 u64 exit_services_exit;
194};
195
196/* 1: S3 Performance Table Pointer Record */
197
198struct acpi_fpdt_s3pt_ptr {
199 struct acpi_fpdt_header header;
200 u8 reserved[4];
201 u64 address;
202};
203
204/*
205 * S3PT - S3 Performance Table. This table is pointed to by the
206 * FPDT S3 Pointer Record above.
207 */
208struct acpi_table_s3pt {
209 u8 signature[4]; /* "S3PT" */
210 u32 length;
211};
212
213/*
214 * S3PT Subtables
215 */
216struct acpi_s3pt_header {
217 u16 type;
218 u8 length;
219 u8 revision;
220};
221
222/* Values for Type field above */
223
224enum acpi_s3pt_type {
225 ACPI_S3PT_TYPE_RESUME = 0,
Bob Moore6be58e22013-03-08 09:22:48 +0000226 ACPI_S3PT_TYPE_SUSPEND = 1
Bob Moorec5bd6532011-11-16 11:04:00 +0800227};
228
229struct acpi_s3pt_resume {
230 struct acpi_s3pt_header header;
231 u32 resume_count;
232 u64 full_resume;
233 u64 average_resume;
234};
235
236struct acpi_s3pt_suspend {
237 struct acpi_s3pt_header header;
238 u64 suspend_start;
239 u64 suspend_end;
240};
241
242/*******************************************************************************
243 *
244 * GTDT - Generic Timer Description Table (ACPI 5.0)
245 * Version 1
246 *
247 ******************************************************************************/
248
249struct acpi_table_gtdt {
250 struct acpi_table_header header; /* Common ACPI table header */
251 u64 address;
252 u32 flags;
253 u32 secure_pl1_interrupt;
254 u32 secure_pl1_flags;
255 u32 non_secure_pl1_interrupt;
256 u32 non_secure_pl1_flags;
257 u32 virtual_timer_interrupt;
258 u32 virtual_timer_flags;
259 u32 non_secure_pl2_interrupt;
260 u32 non_secure_pl2_flags;
261};
262
263/* Values for Flags field above */
264
265#define ACPI_GTDT_MAPPED_BLOCK_PRESENT 1
266
267/* Values for all "TimerFlags" fields above */
268
269#define ACPI_GTDT_INTERRUPT_MODE 1
270#define ACPI_GTDT_INTERRUPT_POLARITY 2
271
272/*******************************************************************************
273 *
274 * MPST - Memory Power State Table (ACPI 5.0)
275 * Version 1
276 *
277 ******************************************************************************/
278
279#define ACPI_MPST_CHANNEL_INFO \
Bob Moorec5bd6532011-11-16 11:04:00 +0800280 u8 channel_id; \
Bob Moore2d2dd502012-10-31 02:27:56 +0000281 u8 reserved1[3]; \
282 u16 power_node_count; \
283 u16 reserved2;
Bob Moorec5bd6532011-11-16 11:04:00 +0800284
285/* Main table */
286
287struct acpi_table_mpst {
288 struct acpi_table_header header; /* Common ACPI table header */
289 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
290};
291
292/* Memory Platform Communication Channel Info */
293
294struct acpi_mpst_channel {
295 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
296};
297
298/* Memory Power Node Structure */
299
300struct acpi_mpst_power_node {
301 u8 flags;
302 u8 reserved1;
303 u16 node_id;
304 u32 length;
305 u64 range_address;
306 u64 range_length;
Bob Moore2d2dd502012-10-31 02:27:56 +0000307 u32 num_power_states;
308 u32 num_physical_components;
Bob Moorec5bd6532011-11-16 11:04:00 +0800309};
310
311/* Values for Flags field above */
312
313#define ACPI_MPST_ENABLED 1
314#define ACPI_MPST_POWER_MANAGED 2
315#define ACPI_MPST_HOT_PLUG_CAPABLE 4
316
317/* Memory Power State Structure (follows POWER_NODE above) */
318
319struct acpi_mpst_power_state {
320 u8 power_state;
321 u8 info_index;
322};
323
324/* Physical Component ID Structure (follows POWER_STATE above) */
325
326struct acpi_mpst_component {
327 u16 component_id;
328};
329
330/* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
331
332struct acpi_mpst_data_hdr {
333 u16 characteristics_count;
Bob Moore2d2dd502012-10-31 02:27:56 +0000334 u16 reserved;
Bob Moorec5bd6532011-11-16 11:04:00 +0800335};
336
337struct acpi_mpst_power_data {
Bob Moore2d2dd502012-10-31 02:27:56 +0000338 u8 structure_id;
Bob Moorec5bd6532011-11-16 11:04:00 +0800339 u8 flags;
340 u16 reserved1;
341 u32 average_power;
342 u32 power_saving;
343 u64 exit_latency;
344 u64 reserved2;
345};
346
347/* Values for Flags field above */
348
349#define ACPI_MPST_PRESERVE 1
350#define ACPI_MPST_AUTOENTRY 2
351#define ACPI_MPST_AUTOEXIT 4
352
353/* Shared Memory Region (not part of an ACPI table) */
354
355struct acpi_mpst_shared {
356 u32 signature;
357 u16 pcc_command;
358 u16 pcc_status;
Bob Moore2d2dd502012-10-31 02:27:56 +0000359 u32 command_register;
360 u32 status_register;
361 u32 power_state_id;
362 u32 power_node_id;
Bob Moorec5bd6532011-11-16 11:04:00 +0800363 u64 energy_consumed;
364 u64 average_power;
365};
366
367/*******************************************************************************
368 *
369 * PCCT - Platform Communications Channel Table (ACPI 5.0)
370 * Version 1
371 *
372 ******************************************************************************/
373
374struct acpi_table_pcct {
375 struct acpi_table_header header; /* Common ACPI table header */
376 u32 flags;
377 u32 latency;
378 u32 reserved;
379};
380
381/* Values for Flags field above */
382
383#define ACPI_PCCT_DOORBELL 1
384
385/*
386 * PCCT subtables
387 */
388
389/* 0: Generic Communications Subspace */
390
391struct acpi_pcct_subspace {
392 struct acpi_subtable_header header;
393 u8 reserved[6];
394 u64 base_address;
395 u64 length;
396 struct acpi_generic_address doorbell_register;
397 u64 preserve_mask;
398 u64 write_mask;
399};
400
401/*
402 * PCC memory structures (not part of the ACPI table)
403 */
404
405/* Shared Memory Region */
406
407struct acpi_pcct_shared_memory {
408 u32 signature;
409 u16 command;
410 u16 status;
411};
412
413/*******************************************************************************
414 *
415 * PMTT - Platform Memory Topology Table (ACPI 5.0)
416 * Version 1
417 *
418 ******************************************************************************/
419
420struct acpi_table_pmtt {
421 struct acpi_table_header header; /* Common ACPI table header */
422 u32 reserved;
423};
424
425/* Common header for PMTT subtables that follow main table */
426
427struct acpi_pmtt_header {
428 u8 type;
429 u8 reserved1;
430 u16 length;
431 u16 flags;
432 u16 reserved2;
433};
434
435/* Values for Type field above */
436
437#define ACPI_PMTT_TYPE_SOCKET 0
438#define ACPI_PMTT_TYPE_CONTROLLER 1
439#define ACPI_PMTT_TYPE_DIMM 2
440#define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */
441
442/* Values for Flags field above */
443
444#define ACPI_PMTT_TOP_LEVEL 0x0001
445#define ACPI_PMTT_PHYSICAL 0x0002
446#define ACPI_PMTT_MEMORY_TYPE 0x000C
447
448/*
449 * PMTT subtables, correspond to Type in struct acpi_pmtt_header
450 */
451
452/* 0: Socket Structure */
453
454struct acpi_pmtt_socket {
455 struct acpi_pmtt_header header;
456 u16 socket_id;
457 u16 reserved;
458};
459
460/* 1: Memory Controller subtable */
461
462struct acpi_pmtt_controller {
463 struct acpi_pmtt_header header;
464 u32 read_latency;
465 u32 write_latency;
466 u32 read_bandwidth;
467 u32 write_bandwidth;
468 u16 access_width;
469 u16 alignment;
470 u16 reserved;
471 u16 domain_count;
472};
473
474/* 1a: Proximity Domain substructure */
475
476struct acpi_pmtt_domain {
477 u32 proximity_domain;
478};
479
480/* 2: Physical Component Identifier (DIMM) */
481
482struct acpi_pmtt_physical_component {
483 struct acpi_pmtt_header header;
484 u16 component_id;
485 u16 reserved;
486 u32 memory_size;
487 u32 bios_handle;
488};
489
490/*******************************************************************************
491 *
492 * RASF - RAS Feature Table (ACPI 5.0)
493 * Version 1
494 *
495 ******************************************************************************/
496
497struct acpi_table_rasf {
498 struct acpi_table_header header; /* Common ACPI table header */
499 u8 channel_id[12];
500};
501
502/* RASF Platform Communication Channel Shared Memory Region */
503
504struct acpi_rasf_shared_memory {
505 u32 signature;
506 u16 command;
507 u16 status;
Lv Zheng8c280912013-03-08 09:20:21 +0000508 u16 version;
509 u8 capabilities[16];
510 u8 set_capabilities[16];
511 u16 num_parameter_blocks;
512 u32 set_capabilities_status;
513};
514
515/* RASF Parameter Block Structure Header */
516
517struct acpi_rasf_parameter_block {
518 u16 type;
519 u16 version;
520 u16 length;
521};
522
523/* RASF Parameter Block Structure for PATROL_SCRUB */
524
525struct acpi_rasf_patrol_scrub_parameter {
526 struct acpi_rasf_parameter_block header;
527 u16 patrol_scrub_command;
528 u64 requested_address_range[2];
529 u64 actual_address_range[2];
Bob Moorec5bd6532011-11-16 11:04:00 +0800530 u16 flags;
Lv Zheng8c280912013-03-08 09:20:21 +0000531 u8 requested_speed;
Bob Moorec5bd6532011-11-16 11:04:00 +0800532};
533
534/* Masks for Flags and Speed fields above */
535
536#define ACPI_RASF_SCRUBBER_RUNNING 1
537#define ACPI_RASF_SPEED (7<<1)
Lv Zheng8c280912013-03-08 09:20:21 +0000538#define ACPI_RASF_SPEED_SLOW (0<<1)
539#define ACPI_RASF_SPEED_MEDIUM (4<<1)
540#define ACPI_RASF_SPEED_FAST (7<<1)
Bob Moorec5bd6532011-11-16 11:04:00 +0800541
542/* Channel Commands */
543
544enum acpi_rasf_commands {
Lv Zheng8c280912013-03-08 09:20:21 +0000545 ACPI_RASF_EXECUTE_RASF_COMMAND = 1
546};
547
548/* Platform RAS Capabilities */
549
550enum acpi_rasf_capabiliities {
551 ACPI_HW_PATROL_SCRUB_SUPPORTED = 0,
552 ACPI_SW_PATROL_SCRUB_EXPOSED = 1
553};
554
555/* Patrol Scrub Commands */
556
557enum acpi_rasf_patrol_scrub_commands {
558 ACPI_RASF_GET_PATROL_PARAMETERS = 1,
559 ACPI_RASF_START_PATROL_SCRUBBER = 2,
560 ACPI_RASF_STOP_PATROL_SCRUBBER = 3
Bob Moorec5bd6532011-11-16 11:04:00 +0800561};
562
563/* Channel Command flags */
564
565#define ACPI_RASF_GENERATE_SCI (1<<15)
566
567/* Status values */
568
569enum acpi_rasf_status {
570 ACPI_RASF_SUCCESS = 0,
571 ACPI_RASF_NOT_VALID = 1,
572 ACPI_RASF_NOT_SUPPORTED = 2,
573 ACPI_RASF_BUSY = 3,
574 ACPI_RASF_FAILED = 4,
575 ACPI_RASF_ABORTED = 5,
576 ACPI_RASF_INVALID_DATA = 6
577};
578
579/* Status flags */
580
581#define ACPI_RASF_COMMAND_COMPLETE (1)
582#define ACPI_RASF_SCI_DOORBELL (1<<1)
583#define ACPI_RASF_ERROR (1<<2)
584#define ACPI_RASF_STATUS (0x1F<<3)
585
Bob Moore99c93f52012-12-31 00:05:52 +0000586/*******************************************************************************
587 *
588 * TPM2 - Trusted Platform Module (TPM) 2.0 Hardware Interface Table
589 * Version 3
590 *
591 * Conforms to "TPM 2.0 Hardware Interface Table (TPM2)" 29 November 2011
592 *
593 ******************************************************************************/
594
595struct acpi_table_tpm2 {
596 struct acpi_table_header header; /* Common ACPI table header */
597 u32 flags;
598 u64 control_address;
599 u32 start_method;
600};
601
602/* Control area structure (not part of table, pointed to by control_address) */
603
604struct acpi_tpm2_control {
605 u32 reserved;
606 u32 error;
607 u32 cancel;
608 u32 start;
609 u64 interrupt_control;
610 u32 command_size;
611 u64 command_address;
612 u32 response_size;
613 u64 response_address;
614};
615
Bob Moorec5bd6532011-11-16 11:04:00 +0800616/* Reset to default packing */
617
618#pragma pack()
619
620#endif /* __ACTBL3_H__ */