1/******************************************************************************
2 *
3 * Name: actbl3.h - ACPI Table Definitions
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2012, 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 *
50 * Additional ACPI Tables (3)
51 *
52 * These tables are not consumed directly by the ACPICA subsystem, but are
53 * included here to support device drivers and the AML disassembler.
54 *
55 * The tables in this file are fully defined within the ACPI specification.
56 *
57 ******************************************************************************/
58
59
60/*
61 * Values for description table header signatures for tables defined in this
62 * file. Useful because they make it more difficult to inadvertently type in
63 * the wrong signature.
64 */
65#define ACPI_SIG_BGRT "BGRT" /* Boot Graphics Resource Table */
66#define ACPI_SIG_DRTM "DRTM" /* Dynamic Root of Trust for Measurement table */
67#define ACPI_SIG_FPDT "FPDT" /* Firmware Performance Data Table */
68#define ACPI_SIG_GTDT "GTDT" /* Generic Timer Description Table */
69#define ACPI_SIG_MPST "MPST" /* Memory Power State Table */
70#define ACPI_SIG_PCCT "PCCT" /* Platform Communications Channel Table */
71#define ACPI_SIG_PMTT "PMTT" /* Platform Memory Topology Table */
72#define ACPI_SIG_RASF "RASF" /* RAS Feature table */
73
74#define ACPI_SIG_S3PT "S3PT" /* S3 Performance (sub)Table */
75#define ACPI_SIG_PCCS "PCC" /* PCC Shared Memory Region */
76
77/* Reserved table signatures */
78
79#define ACPI_SIG_CSRT "CSRT" /* Core System Resources Table */
|
80#define ACPI_SIG_DBG2 "DBG2" /* Debug Port table 2 */
|
80#define ACPI_SIG_MATR "MATR" /* Memory Address Translation Table */
81#define ACPI_SIG_MSDM "MSDM" /* Microsoft Data Management Table */
82#define ACPI_SIG_WPBT "WPBT" /* Windows Platform Binary 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/*
|
92 * Note about bitfields: The UINT8 type is used for bitfields in ACPI tables.
93 * This is the only type that is even remotely portable. Anything else is not
94 * portable, so do not use any other bitfield types.
|
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 *
105 * BGRT - Boot Graphics Resource Table (ACPI 5.0)
106 * Version 1
107 *
108 ******************************************************************************/
109
110typedef struct acpi_table_bgrt
111{
112 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
113 UINT16 Version;
114 UINT8 Status;
115 UINT8 ImageType;
116 UINT64 ImageAddress;
117 UINT32 ImageOffsetX;
118 UINT32 ImageOffsetY;
119
120} ACPI_TABLE_BGRT;
121
122
123/*******************************************************************************
124 *
125 * DRTM - Dynamic Root of Trust for Measurement table
126 *
127 ******************************************************************************/
128
129typedef struct acpi_table_drtm
130{
131 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
132 UINT64 EntryBaseAddress;
133 UINT64 EntryLength;
134 UINT32 EntryAddress32;
135 UINT64 EntryAddress64;
136 UINT64 ExitAddress;
137 UINT64 LogAreaAddress;
138 UINT32 LogAreaLength;
139 UINT64 ArchDependentAddress;
140 UINT32 Flags;
141
142} ACPI_TABLE_DRTM;
143
144/* 1) Validated Tables List */
145
146typedef struct acpi_drtm_vtl_list
147{
148 UINT32 ValidatedTableListCount;
149
150} ACPI_DRTM_VTL_LIST;
151
152/* 2) Resources List */
153
154typedef struct acpi_drtm_resource_list
155{
156 UINT32 ResourceListCount;
157
158} ACPI_DRTM_RESOURCE_LIST;
159
160/* 3) Platform-specific Identifiers List */
161
162typedef struct acpi_drtm_id_list
163{
164 UINT32 IdListCount;
165
166} ACPI_DRTM_ID_LIST;
167
168
169/*******************************************************************************
170 *
171 * FPDT - Firmware Performance Data Table (ACPI 5.0)
172 * Version 1
173 *
174 ******************************************************************************/
175
176typedef struct acpi_table_fpdt
177{
178 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
179
180} ACPI_TABLE_FPDT;
181
182
183/* FPDT subtable header */
184
185typedef struct acpi_fpdt_header
186{
187 UINT16 Type;
188 UINT8 Length;
189 UINT8 Revision;
190
191} ACPI_FPDT_HEADER;
192
193/* Values for Type field above */
194
195enum AcpiFpdtType
196{
197 ACPI_FPDT_TYPE_BOOT = 0,
198 ACPI_FPDT_TYPE_S3PERF = 1,
199};
200
201
202/*
203 * FPDT subtables
204 */
205
206/* 0: Firmware Basic Boot Performance Record */
207
208typedef struct acpi_fpdt_boot
209{
210 ACPI_FPDT_HEADER Header;
211 UINT8 Reserved[4];
212 UINT64 ResetEnd;
213 UINT64 LoadStart;
214 UINT64 StartupStart;
215 UINT64 ExitServicesEntry;
216 UINT64 ExitServicesExit;
217
218} ACPI_FPDT_BOOT;
219
220
221/* 1: S3 Performance Table Pointer Record */
222
223typedef struct acpi_fpdt_s3pt_ptr
224{
225 ACPI_FPDT_HEADER Header;
226 UINT8 Reserved[4];
227 UINT64 Address;
228
229} ACPI_FPDT_S3PT_PTR;
230
231
232/*
233 * S3PT - S3 Performance Table. This table is pointed to by the
234 * FPDT S3 Pointer Record above.
235 */
236typedef struct acpi_table_s3pt
237{
238 UINT8 Signature[4]; /* "S3PT" */
239 UINT32 Length;
240
241} ACPI_TABLE_S3PT;
242
243
244/*
245 * S3PT Subtables
246 */
247typedef struct acpi_s3pt_header
248{
249 UINT16 Type;
250 UINT8 Length;
251 UINT8 Revision;
252
253} ACPI_S3PT_HEADER;
254
255/* Values for Type field above */
256
257enum AcpiS3ptType
258{
259 ACPI_S3PT_TYPE_RESUME = 0,
260 ACPI_S3PT_TYPE_SUSPEND = 1,
261};
262
263typedef struct acpi_s3pt_resume
264{
265 ACPI_S3PT_HEADER Header;
266 UINT32 ResumeCount;
267 UINT64 FullResume;
268 UINT64 AverageResume;
269
270} ACPI_S3PT_RESUME;
271
272typedef struct acpi_s3pt_suspend
273{
274 ACPI_S3PT_HEADER Header;
275 UINT64 SuspendStart;
276 UINT64 SuspendEnd;
277
278} ACPI_S3PT_SUSPEND;
279
280
281/*******************************************************************************
282 *
283 * GTDT - Generic Timer Description Table (ACPI 5.0)
284 * Version 1
285 *
286 ******************************************************************************/
287
288typedef struct acpi_table_gtdt
289{
290 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
291 UINT64 Address;
292 UINT32 Flags;
293 UINT32 SecurePl1Interrupt;
294 UINT32 SecurePl1Flags;
295 UINT32 NonSecurePl1Interrupt;
296 UINT32 NonSecurePl1Flags;
297 UINT32 VirtualTimerInterrupt;
298 UINT32 VirtualTimerFlags;
299 UINT32 NonSecurePl2Interrupt;
300 UINT32 NonSecurePl2Flags;
301
302} ACPI_TABLE_GTDT;
303
304/* Values for Flags field above */
305
306#define ACPI_GTDT_MAPPED_BLOCK_PRESENT 1
307
308/* Values for all "TimerFlags" fields above */
309
310#define ACPI_GTDT_INTERRUPT_MODE 1
311#define ACPI_GTDT_INTERRUPT_POLARITY 2
312
313
314/*******************************************************************************
315 *
316 * MPST - Memory Power State Table (ACPI 5.0)
317 * Version 1
318 *
319 ******************************************************************************/
320
321#define ACPI_MPST_CHANNEL_INFO \
322 UINT16 Reserved1; \
323 UINT8 ChannelId; \
324 UINT8 Reserved2; \
325 UINT16 PowerNodeCount;
326
327/* Main table */
328
329typedef struct acpi_table_mpst
330{
331 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
332 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
333
334} ACPI_TABLE_MPST;
335
336
337/* Memory Platform Communication Channel Info */
338
339typedef struct acpi_mpst_channel
340{
341 ACPI_MPST_CHANNEL_INFO /* Platform Communication Channel */
342
343} ACPI_MPST_CHANNEL;
344
345
346/* Memory Power Node Structure */
347
348typedef struct acpi_mpst_power_node
349{
350 UINT8 Flags;
351 UINT8 Reserved1;
352 UINT16 NodeId;
353 UINT32 Length;
354 UINT64 RangeAddress;
355 UINT64 RangeLength;
356 UINT8 NumPowerStates;
357 UINT8 NumPhysicalComponents;
358 UINT16 Reserved2;
359
360} ACPI_MPST_POWER_NODE;
361
362/* Values for Flags field above */
363
364#define ACPI_MPST_ENABLED 1
365#define ACPI_MPST_POWER_MANAGED 2
366#define ACPI_MPST_HOT_PLUG_CAPABLE 4
367
368
369/* Memory Power State Structure (follows POWER_NODE above) */
370
371typedef struct acpi_mpst_power_state
372{
373 UINT8 PowerState;
374 UINT8 InfoIndex;
375
376} ACPI_MPST_POWER_STATE;
377
378
379/* Physical Component ID Structure (follows POWER_STATE above) */
380
381typedef struct acpi_mpst_component
382{
383 UINT16 ComponentId;
384
385} ACPI_MPST_COMPONENT;
386
387
388/* Memory Power State Characteristics Structure (follows all POWER_NODEs) */
389
390typedef struct acpi_mpst_data_hdr
391{
392 UINT16 CharacteristicsCount;
393
394} ACPI_MPST_DATA_HDR;
395
396typedef struct acpi_mpst_power_data
397{
398 UINT8 Revision;
399 UINT8 Flags;
400 UINT16 Reserved1;
401 UINT32 AveragePower;
402 UINT32 PowerSaving;
403 UINT64 ExitLatency;
404 UINT64 Reserved2;
405
406} ACPI_MPST_POWER_DATA;
407
408/* Values for Flags field above */
409
410#define ACPI_MPST_PRESERVE 1
411#define ACPI_MPST_AUTOENTRY 2
412#define ACPI_MPST_AUTOEXIT 4
413
414
415/* Shared Memory Region (not part of an ACPI table) */
416
417typedef struct acpi_mpst_shared
418{
419 UINT32 Signature;
420 UINT16 PccCommand;
421 UINT16 PccStatus;
422 UINT16 CommandRegister;
423 UINT16 StatusRegister;
424 UINT16 PowerStateId;
425 UINT16 PowerNodeId;
426 UINT64 EnergyConsumed;
427 UINT64 AveragePower;
428
429} ACPI_MPST_SHARED;
430
431
432/*******************************************************************************
433 *
434 * PCCT - Platform Communications Channel Table (ACPI 5.0)
435 * Version 1
436 *
437 ******************************************************************************/
438
439typedef struct acpi_table_pcct
440{
441 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
442 UINT32 Flags;
443 UINT32 Latency;
444 UINT32 Reserved;
445
446} ACPI_TABLE_PCCT;
447
448/* Values for Flags field above */
449
450#define ACPI_PCCT_DOORBELL 1
451
452/*
453 * PCCT subtables
454 */
455
456/* 0: Generic Communications Subspace */
457
458typedef struct acpi_pcct_subspace
459{
460 ACPI_SUBTABLE_HEADER Header;
461 UINT8 Reserved[6];
462 UINT64 BaseAddress;
463 UINT64 Length;
464 ACPI_GENERIC_ADDRESS DoorbellRegister;
465 UINT64 PreserveMask;
466 UINT64 WriteMask;
467
468} ACPI_PCCT_SUBSPACE;
469
470
471/*
472 * PCC memory structures (not part of the ACPI table)
473 */
474
475/* Shared Memory Region */
476
477typedef struct acpi_pcct_shared_memory
478{
479 UINT32 Signature;
480 UINT16 Command;
481 UINT16 Status;
482
483} ACPI_PCCT_SHARED_MEMORY;
484
485
486/*******************************************************************************
487 *
488 * PMTT - Platform Memory Topology Table (ACPI 5.0)
489 * Version 1
490 *
491 ******************************************************************************/
492
493typedef struct acpi_table_pmtt
494{
495 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
496 UINT32 Reserved;
497
498} ACPI_TABLE_PMTT;
499
500
501/* Common header for PMTT subtables that follow main table */
502
503typedef struct acpi_pmtt_header
504{
505 UINT8 Type;
506 UINT8 Reserved1;
507 UINT16 Length;
508 UINT16 Flags;
509 UINT16 Reserved2;
510
511} ACPI_PMTT_HEADER;
512
513/* Values for Type field above */
514
515#define ACPI_PMTT_TYPE_SOCKET 0
516#define ACPI_PMTT_TYPE_CONTROLLER 1
517#define ACPI_PMTT_TYPE_DIMM 2
518#define ACPI_PMTT_TYPE_RESERVED 3 /* 0x03-0xFF are reserved */
519
520/* Values for Flags field above */
521
522#define ACPI_PMTT_TOP_LEVEL 0x0001
523#define ACPI_PMTT_PHYSICAL 0x0002
524#define ACPI_PMTT_MEMORY_TYPE 0x000C
525
526
527/*
528 * PMTT subtables, correspond to Type in acpi_pmtt_header
529 */
530
531
532/* 0: Socket Structure */
533
534typedef struct acpi_pmtt_socket
535{
536 ACPI_PMTT_HEADER Header;
537 UINT16 SocketId;
538 UINT16 Reserved;
539
540} ACPI_PMTT_SOCKET;
541
542
543/* 1: Memory Controller subtable */
544
545typedef struct acpi_pmtt_controller
546{
547 ACPI_PMTT_HEADER Header;
548 UINT32 ReadLatency;
549 UINT32 WriteLatency;
550 UINT32 ReadBandwidth;
551 UINT32 WriteBandwidth;
552 UINT16 AccessWidth;
553 UINT16 Alignment;
554 UINT16 Reserved;
555 UINT16 DomainCount;
556
557} ACPI_PMTT_CONTROLLER;
558
559/* 1a: Proximity Domain substructure */
560
561typedef struct acpi_pmtt_domain
562{
563 UINT32 ProximityDomain;
564
565} ACPI_PMTT_DOMAIN;
566
567
568/* 2: Physical Component Identifier (DIMM) */
569
570typedef struct acpi_pmtt_physical_component
571{
572 ACPI_PMTT_HEADER Header;
573 UINT16 ComponentId;
574 UINT16 Reserved;
575 UINT32 MemorySize;
576 UINT32 BiosHandle;
577
578} ACPI_PMTT_PHYSICAL_COMPONENT;
579
580
581/*******************************************************************************
582 *
583 * RASF - RAS Feature Table (ACPI 5.0)
584 * Version 1
585 *
586 ******************************************************************************/
587
588typedef struct acpi_table_rasf
589{
590 ACPI_TABLE_HEADER Header; /* Common ACPI table header */
591 UINT8 ChannelId[12];
592
593} ACPI_TABLE_RASF;
594
595/* RASF Platform Communication Channel Shared Memory Region */
596
597typedef struct acpi_rasf_shared_memory
598{
599 UINT32 Signature;
600 UINT16 Command;
601 UINT16 Status;
602 UINT64 RequestedAddress;
603 UINT64 RequestedLength;
604 UINT64 ActualAddress;
605 UINT64 ActualLength;
606 UINT16 Flags;
607 UINT8 Speed;
608
609} ACPI_RASF_SHARED_MEMORY;
610
611/* Masks for Flags and Speed fields above */
612
613#define ACPI_RASF_SCRUBBER_RUNNING 1
614#define ACPI_RASF_SPEED (7<<1)
615
616/* Channel Commands */
617
618enum AcpiRasfCommands
619{
620 ACPI_RASF_GET_RAS_CAPABILITIES = 1,
621 ACPI_RASF_GET_PATROL_PARAMETERS = 2,
622 ACPI_RASF_START_PATROL_SCRUBBER = 3,
623 ACPI_RASF_STOP_PATROL_SCRUBBER = 4
624};
625
626/* Channel Command flags */
627
628#define ACPI_RASF_GENERATE_SCI (1<<15)
629
630/* Status values */
631
632enum AcpiRasfStatus
633{
634 ACPI_RASF_SUCCESS = 0,
635 ACPI_RASF_NOT_VALID = 1,
636 ACPI_RASF_NOT_SUPPORTED = 2,
637 ACPI_RASF_BUSY = 3,
638 ACPI_RASF_FAILED = 4,
639 ACPI_RASF_ABORTED = 5,
640 ACPI_RASF_INVALID_DATA = 6
641};
642
643/* Status flags */
644
645#define ACPI_RASF_COMMAND_COMPLETE (1)
646#define ACPI_RASF_SCI_DOORBELL (1<<1)
647#define ACPI_RASF_ERROR (1<<2)
648#define ACPI_RASF_STATUS (0x1F<<3)
649
650
651/* Reset to default packing */
652
653#pragma pack()
654
655#endif /* __ACTBL3_H__ */
|