]> git.proxmox.com Git - mirror_ubuntu-zesty-kernel.git/blame - include/acpi/actbl3.h
ACPICA: Headers: Add support for CSRT and DBG2 ACPI tables.
[mirror_ubuntu-zesty-kernel.git] / include / acpi / actbl3.h
CommitLineData
c5bd6537
BM
1/******************************************************************************
2 *
3 * Name: actbl3.h - ACPI Table Definitions
4 *
5 *****************************************************************************/
6
7/*
75e7386b 8 * Copyright (C) 2000 - 2012, Intel Corp.
c5bd6537
BM
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 * 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 */
71
72#define ACPI_SIG_S3PT "S3PT" /* S3 Performance (sub)Table */
73#define ACPI_SIG_PCCS "PCC" /* PCC Shared Memory Region */
74
75/* Reserved table signatures */
76
77#define ACPI_SIG_CSRT "CSRT" /* Core System Resources Table */
c5bd6537
BM
78#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/*
89 * Note about bitfields: The u8 type is used for bitfields in ACPI tables.
90 * This is the only type that is even remotely portable. Anything else is not
91 * portable, so do not use any other bitfield types.
92 */
93
94/*******************************************************************************
95 *
96 * BGRT - Boot Graphics Resource Table (ACPI 5.0)
97 * Version 1
98 *
99 ******************************************************************************/
100
101struct acpi_table_bgrt {
102 struct acpi_table_header header; /* Common ACPI table header */
103 u16 version;
104 u8 status;
105 u8 image_type;
106 u64 image_address;
107 u32 image_offset_x;
108 u32 image_offset_y;
109};
110
111/*******************************************************************************
112 *
113 * DRTM - Dynamic Root of Trust for Measurement table
114 *
115 ******************************************************************************/
116
117struct acpi_table_drtm {
118 struct acpi_table_header header; /* Common ACPI table header */
119 u64 entry_base_address;
120 u64 entry_length;
121 u32 entry_address32;
122 u64 entry_address64;
123 u64 exit_address;
124 u64 log_area_address;
125 u32 log_area_length;
126 u64 arch_dependent_address;
127 u32 flags;
128};
129
130/* 1) Validated Tables List */
131
132struct acpi_drtm_vtl_list {
133 u32 validated_table_list_count;
134};
135
136/* 2) Resources List */
137
138struct acpi_drtm_resource_list {
139 u32 resource_list_count;
140};
141
142/* 3) Platform-specific Identifiers List */
143
144struct acpi_drtm_id_list {
145 u32 id_list_count;
146};
147
148/*******************************************************************************
149 *
150 * FPDT - Firmware Performance Data Table (ACPI 5.0)
151 * Version 1
152 *
153 ******************************************************************************/
154
155struct acpi_table_fpdt {
156 struct acpi_table_header header; /* Common ACPI table header */
157};
158
159/* FPDT subtable header */
160
161struct acpi_fpdt_header {
162 u16 type;
163 u8 length;
164 u8 revision;
165};
166
167/* Values for Type field above */
168
169enum acpi_fpdt_type {
170 ACPI_FPDT_TYPE_BOOT = 0,
171 ACPI_FPDT_TYPE_S3PERF = 1,
172};
173
174/*
175 * FPDT subtables
176 */
177
178/* 0: Firmware Basic Boot Performance Record */
179
180struct acpi_fpdt_boot {
181 struct acpi_fpdt_header header;
182 u8 reserved[4];
183 u64 reset_end;
184 u64 load_start;
185 u64 startup_start;
186 u64 exit_services_entry;
187 u64 exit_services_exit;
188};
189
190/* 1: S3 Performance Table Pointer Record */
191
192struct acpi_fpdt_s3pt_ptr {
193 struct acpi_fpdt_header header;
194 u8 reserved[4];
195 u64 address;
196};
197
198/*
199 * S3PT - S3 Performance Table. This table is pointed to by the
200 * FPDT S3 Pointer Record above.
201 */
202struct acpi_table_s3pt {
203 u8 signature[4]; /* "S3PT" */
204 u32 length;
205};
206
207/*
208 * S3PT Subtables
209 */
210struct acpi_s3pt_header {
211 u16 type;
212 u8 length;
213 u8 revision;
214};
215
216/* Values for Type field above */
217
218enum acpi_s3pt_type {
219 ACPI_S3PT_TYPE_RESUME = 0,
220 ACPI_S3PT_TYPE_SUSPEND = 1,
221};
222
223struct acpi_s3pt_resume {
224 struct acpi_s3pt_header header;
225 u32 resume_count;
226 u64 full_resume;
227 u64 average_resume;
228};
229
230struct acpi_s3pt_suspend {
231 struct acpi_s3pt_header header;
232 u64 suspend_start;
233 u64 suspend_end;
234};
235
236/*******************************************************************************
237 *
238 * GTDT - Generic Timer Description Table (ACPI 5.0)
239 * Version 1
240 *
241 ******************************************************************************/
242
243struct acpi_table_gtdt {
244 struct acpi_table_header header; /* Common ACPI table header */
245 u64 address;
246 u32 flags;
247 u32 secure_pl1_interrupt;
248 u32 secure_pl1_flags;
249 u32 non_secure_pl1_interrupt;
250 u32 non_secure_pl1_flags;
251 u32 virtual_timer_interrupt;
252 u32 virtual_timer_flags;
253 u32 non_secure_pl2_interrupt;
254 u32 non_secure_pl2_flags;
255};
256
257/* Values for Flags field above */
258
259#define ACPI_GTDT_MAPPED_BLOCK_PRESENT 1
260
261/* Values for all "TimerFlags" fields above */
262
263#define ACPI_GTDT_INTERRUPT_MODE 1
264#define ACPI_GTDT_INTERRUPT_POLARITY 2
265
266/*******************************************************************************
267 *
268 * MPST - Memory Power State Table (ACPI 5.0)
269 * Version 1
270 *
271 ******************************************************************************/
272
273#define ACPI_MPST_CHANNEL_INFO \
274 u16 reserved1; \
275 u8 channel_id; \
276 u8 reserved2; \
277 u16 power_node_count;
278
279/* Main table */
280
281struct acpi_table_mpst {
282 struct acpi_table_header header; /* Common ACPI table header */
283 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
284};
285
286/* Memory Platform Communication Channel Info */
287
288struct acpi_mpst_channel {
289 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
290};
291
292/* Memory Power Node Structure */
293
294struct acpi_mpst_power_node {
295 u8 flags;
296 u8 reserved1;
297 u16 node_id;
298 u32 length;
299 u64 range_address;
300 u64 range_length;
301 u8 num_power_states;
302 u8 num_physical_components;
303 u16 reserved2;
304};
305
306/* Values for Flags field above */
307
308#define ACPI_MPST_ENABLED 1
309#define ACPI_MPST_POWER_MANAGED 2
310#define ACPI_MPST_HOT_PLUG_CAPABLE 4
311
312/* Memory Power State Structure (follows POWER_NODE above) */
313
314struct acpi_mpst_power_state {
315 u8 power_state;
316 u8 info_index;
317};
318
319/* Physical Component ID Structure (follows POWER_STATE above) */
320
321struct acpi_mpst_component {
322 u16 component_id;
323};
324
325/* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
326
327struct acpi_mpst_data_hdr {
328 u16 characteristics_count;
329};
330
331struct acpi_mpst_power_data {
332 u8 revision;
333 u8 flags;
334 u16 reserved1;
335 u32 average_power;
336 u32 power_saving;
337 u64 exit_latency;
338 u64 reserved2;
339};
340
341/* Values for Flags field above */
342
343#define ACPI_MPST_PRESERVE 1
344#define ACPI_MPST_AUTOENTRY 2
345#define ACPI_MPST_AUTOEXIT 4
346
347/* Shared Memory Region (not part of an ACPI table) */
348
349struct acpi_mpst_shared {
350 u32 signature;
351 u16 pcc_command;
352 u16 pcc_status;
353 u16 command_register;
354 u16 status_register;
355 u16 power_state_id;
356 u16 power_node_id;
357 u64 energy_consumed;
358 u64 average_power;
359};
360
361/*******************************************************************************
362 *
363 * PCCT - Platform Communications Channel Table (ACPI 5.0)
364 * Version 1
365 *
366 ******************************************************************************/
367
368struct acpi_table_pcct {
369 struct acpi_table_header header; /* Common ACPI table header */
370 u32 flags;
371 u32 latency;
372 u32 reserved;
373};
374
375/* Values for Flags field above */
376
377#define ACPI_PCCT_DOORBELL 1
378
379/*
380 * PCCT subtables
381 */
382
383/* 0: Generic Communications Subspace */
384
385struct acpi_pcct_subspace {
386 struct acpi_subtable_header header;
387 u8 reserved[6];
388 u64 base_address;
389 u64 length;
390 struct acpi_generic_address doorbell_register;
391 u64 preserve_mask;
392 u64 write_mask;
393};
394
395/*
396 * PCC memory structures (not part of the ACPI table)
397 */
398
399/* Shared Memory Region */
400
401struct acpi_pcct_shared_memory {
402 u32 signature;
403 u16 command;
404 u16 status;
405};
406
407/*******************************************************************************
408 *
409 * PMTT - Platform Memory Topology Table (ACPI 5.0)
410 * Version 1
411 *
412 ******************************************************************************/
413
414struct acpi_table_pmtt {
415 struct acpi_table_header header; /* Common ACPI table header */
416 u32 reserved;
417};
418
419/* Common header for PMTT subtables that follow main table */
420
421struct acpi_pmtt_header {
422 u8 type;
423 u8 reserved1;
424 u16 length;
425 u16 flags;
426 u16 reserved2;
427};
428
429/* Values for Type field above */
430
431#define ACPI_PMTT_TYPE_SOCKET 0
432#define ACPI_PMTT_TYPE_CONTROLLER 1
433#define ACPI_PMTT_TYPE_DIMM 2
434#define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */
435
436/* Values for Flags field above */
437
438#define ACPI_PMTT_TOP_LEVEL 0x0001
439#define ACPI_PMTT_PHYSICAL 0x0002
440#define ACPI_PMTT_MEMORY_TYPE 0x000C
441
442/*
443 * PMTT subtables, correspond to Type in struct acpi_pmtt_header
444 */
445
446/* 0: Socket Structure */
447
448struct acpi_pmtt_socket {
449 struct acpi_pmtt_header header;
450 u16 socket_id;
451 u16 reserved;
452};
453
454/* 1: Memory Controller subtable */
455
456struct acpi_pmtt_controller {
457 struct acpi_pmtt_header header;
458 u32 read_latency;
459 u32 write_latency;
460 u32 read_bandwidth;
461 u32 write_bandwidth;
462 u16 access_width;
463 u16 alignment;
464 u16 reserved;
465 u16 domain_count;
466};
467
468/* 1a: Proximity Domain substructure */
469
470struct acpi_pmtt_domain {
471 u32 proximity_domain;
472};
473
474/* 2: Physical Component Identifier (DIMM) */
475
476struct acpi_pmtt_physical_component {
477 struct acpi_pmtt_header header;
478 u16 component_id;
479 u16 reserved;
480 u32 memory_size;
481 u32 bios_handle;
482};
483
484/*******************************************************************************
485 *
486 * RASF - RAS Feature Table (ACPI 5.0)
487 * Version 1
488 *
489 ******************************************************************************/
490
491struct acpi_table_rasf {
492 struct acpi_table_header header; /* Common ACPI table header */
493 u8 channel_id[12];
494};
495
496/* RASF Platform Communication Channel Shared Memory Region */
497
498struct acpi_rasf_shared_memory {
499 u32 signature;
500 u16 command;
501 u16 status;
502 u64 requested_address;
503 u64 requested_length;
504 u64 actual_address;
505 u64 actual_length;
506 u16 flags;
507 u8 speed;
508};
509
510/* Masks for Flags and Speed fields above */
511
512#define ACPI_RASF_SCRUBBER_RUNNING 1
513#define ACPI_RASF_SPEED (7<<1)
514
515/* Channel Commands */
516
517enum acpi_rasf_commands {
518 ACPI_RASF_GET_RAS_CAPABILITIES = 1,
519 ACPI_RASF_GET_PATROL_PARAMETERS = 2,
520 ACPI_RASF_START_PATROL_SCRUBBER = 3,
521 ACPI_RASF_STOP_PATROL_SCRUBBER = 4
522};
523
524/* Channel Command flags */
525
526#define ACPI_RASF_GENERATE_SCI (1<<15)
527
528/* Status values */
529
530enum acpi_rasf_status {
531 ACPI_RASF_SUCCESS = 0,
532 ACPI_RASF_NOT_VALID = 1,
533 ACPI_RASF_NOT_SUPPORTED = 2,
534 ACPI_RASF_BUSY = 3,
535 ACPI_RASF_FAILED = 4,
536 ACPI_RASF_ABORTED = 5,
537 ACPI_RASF_INVALID_DATA = 6
538};
539
540/* Status flags */
541
542#define ACPI_RASF_COMMAND_COMPLETE (1)
543#define ACPI_RASF_SCI_DOORBELL (1<<1)
544#define ACPI_RASF_ERROR (1<<2)
545#define ACPI_RASF_STATUS (0x1F<<3)
546
547/* Reset to default packing */
548
549#pragma pack()
550
551#endif /* __ACTBL3_H__ */