]> git.proxmox.com Git - mirror_ubuntu-artful-kernel.git/blob - include/acpi/actbl1.h
Merge branches 'for-4.11/upstream-fixes', 'for-4.12/accutouch', 'for-4.12/cp2112...
[mirror_ubuntu-artful-kernel.git] / include / acpi / actbl1.h
1 /******************************************************************************
2 *
3 * Name: actbl1.h - Additional ACPI table definitions
4 *
5 *****************************************************************************/
6
7 /*
8 * Copyright (C) 2000 - 2017, 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 __ACTBL1_H__
45 #define __ACTBL1_H__
46
47 /*******************************************************************************
48 *
49 * Additional ACPI Tables (1)
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_BERT "BERT" /* Boot Error Record Table */
64 #define ACPI_SIG_CPEP "CPEP" /* Corrected Platform Error Polling table */
65 #define ACPI_SIG_ECDT "ECDT" /* Embedded Controller Boot Resources Table */
66 #define ACPI_SIG_EINJ "EINJ" /* Error Injection table */
67 #define ACPI_SIG_ERST "ERST" /* Error Record Serialization Table */
68 #define ACPI_SIG_HEST "HEST" /* Hardware Error Source Table */
69 #define ACPI_SIG_MADT "APIC" /* Multiple APIC Description Table */
70 #define ACPI_SIG_MSCT "MSCT" /* Maximum System Characteristics Table */
71 #define ACPI_SIG_SBST "SBST" /* Smart Battery Specification Table */
72 #define ACPI_SIG_SLIT "SLIT" /* System Locality Distance Information Table */
73 #define ACPI_SIG_SRAT "SRAT" /* System Resource Affinity Table */
74 #define ACPI_SIG_NFIT "NFIT" /* NVDIMM Firmware Interface Table */
75
76 /*
77 * All tables must be byte-packed to match the ACPI specification, since
78 * the tables are provided by the system BIOS.
79 */
80 #pragma pack(1)
81
82 /*
83 * Note: C bitfields are not used for this reason:
84 *
85 * "Bitfields are great and easy to read, but unfortunately the C language
86 * does not specify the layout of bitfields in memory, which means they are
87 * essentially useless for dealing with packed data in on-disk formats or
88 * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
89 * this decision was a design error in C. Ritchie could have picked an order
90 * and stuck with it." Norman Ramsey.
91 * See http://stackoverflow.com/a/1053662/41661
92 */
93
94 /*******************************************************************************
95 *
96 * Common subtable headers
97 *
98 ******************************************************************************/
99
100 /* Generic subtable header (used in MADT, SRAT, etc.) */
101
102 struct acpi_subtable_header {
103 u8 type;
104 u8 length;
105 };
106
107 /* Subtable header for WHEA tables (EINJ, ERST, WDAT) */
108
109 struct acpi_whea_header {
110 u8 action;
111 u8 instruction;
112 u8 flags;
113 u8 reserved;
114 struct acpi_generic_address register_region;
115 u64 value; /* Value used with Read/Write register */
116 u64 mask; /* Bitmask required for this register instruction */
117 };
118
119 /*******************************************************************************
120 *
121 * BERT - Boot Error Record Table (ACPI 4.0)
122 * Version 1
123 *
124 ******************************************************************************/
125
126 struct acpi_table_bert {
127 struct acpi_table_header header; /* Common ACPI table header */
128 u32 region_length; /* Length of the boot error region */
129 u64 address; /* Physical address of the error region */
130 };
131
132 /* Boot Error Region (not a subtable, pointed to by Address field above) */
133
134 struct acpi_bert_region {
135 u32 block_status; /* Type of error information */
136 u32 raw_data_offset; /* Offset to raw error data */
137 u32 raw_data_length; /* Length of raw error data */
138 u32 data_length; /* Length of generic error data */
139 u32 error_severity; /* Severity code */
140 };
141
142 /* Values for block_status flags above */
143
144 #define ACPI_BERT_UNCORRECTABLE (1)
145 #define ACPI_BERT_CORRECTABLE (1<<1)
146 #define ACPI_BERT_MULTIPLE_UNCORRECTABLE (1<<2)
147 #define ACPI_BERT_MULTIPLE_CORRECTABLE (1<<3)
148 #define ACPI_BERT_ERROR_ENTRY_COUNT (0xFF<<4) /* 8 bits, error count */
149
150 /* Values for error_severity above */
151
152 enum acpi_bert_error_severity {
153 ACPI_BERT_ERROR_CORRECTABLE = 0,
154 ACPI_BERT_ERROR_FATAL = 1,
155 ACPI_BERT_ERROR_CORRECTED = 2,
156 ACPI_BERT_ERROR_NONE = 3,
157 ACPI_BERT_ERROR_RESERVED = 4 /* 4 and greater are reserved */
158 };
159
160 /*
161 * Note: The generic error data that follows the error_severity field above
162 * uses the struct acpi_hest_generic_data defined under the HEST table below
163 */
164
165 /*******************************************************************************
166 *
167 * CPEP - Corrected Platform Error Polling table (ACPI 4.0)
168 * Version 1
169 *
170 ******************************************************************************/
171
172 struct acpi_table_cpep {
173 struct acpi_table_header header; /* Common ACPI table header */
174 u64 reserved;
175 };
176
177 /* Subtable */
178
179 struct acpi_cpep_polling {
180 struct acpi_subtable_header header;
181 u8 id; /* Processor ID */
182 u8 eid; /* Processor EID */
183 u32 interval; /* Polling interval (msec) */
184 };
185
186 /*******************************************************************************
187 *
188 * ECDT - Embedded Controller Boot Resources Table
189 * Version 1
190 *
191 ******************************************************************************/
192
193 struct acpi_table_ecdt {
194 struct acpi_table_header header; /* Common ACPI table header */
195 struct acpi_generic_address control; /* Address of EC command/status register */
196 struct acpi_generic_address data; /* Address of EC data register */
197 u32 uid; /* Unique ID - must be same as the EC _UID method */
198 u8 gpe; /* The GPE for the EC */
199 u8 id[1]; /* Full namepath of the EC in the ACPI namespace */
200 };
201
202 /*******************************************************************************
203 *
204 * EINJ - Error Injection Table (ACPI 4.0)
205 * Version 1
206 *
207 ******************************************************************************/
208
209 struct acpi_table_einj {
210 struct acpi_table_header header; /* Common ACPI table header */
211 u32 header_length;
212 u8 flags;
213 u8 reserved[3];
214 u32 entries;
215 };
216
217 /* EINJ Injection Instruction Entries (actions) */
218
219 struct acpi_einj_entry {
220 struct acpi_whea_header whea_header; /* Common header for WHEA tables */
221 };
222
223 /* Masks for Flags field above */
224
225 #define ACPI_EINJ_PRESERVE (1)
226
227 /* Values for Action field above */
228
229 enum acpi_einj_actions {
230 ACPI_EINJ_BEGIN_OPERATION = 0,
231 ACPI_EINJ_GET_TRIGGER_TABLE = 1,
232 ACPI_EINJ_SET_ERROR_TYPE = 2,
233 ACPI_EINJ_GET_ERROR_TYPE = 3,
234 ACPI_EINJ_END_OPERATION = 4,
235 ACPI_EINJ_EXECUTE_OPERATION = 5,
236 ACPI_EINJ_CHECK_BUSY_STATUS = 6,
237 ACPI_EINJ_GET_COMMAND_STATUS = 7,
238 ACPI_EINJ_SET_ERROR_TYPE_WITH_ADDRESS = 8,
239 ACPI_EINJ_GET_EXECUTE_TIMINGS = 9,
240 ACPI_EINJ_ACTION_RESERVED = 10, /* 10 and greater are reserved */
241 ACPI_EINJ_TRIGGER_ERROR = 0xFF /* Except for this value */
242 };
243
244 /* Values for Instruction field above */
245
246 enum acpi_einj_instructions {
247 ACPI_EINJ_READ_REGISTER = 0,
248 ACPI_EINJ_READ_REGISTER_VALUE = 1,
249 ACPI_EINJ_WRITE_REGISTER = 2,
250 ACPI_EINJ_WRITE_REGISTER_VALUE = 3,
251 ACPI_EINJ_NOOP = 4,
252 ACPI_EINJ_FLUSH_CACHELINE = 5,
253 ACPI_EINJ_INSTRUCTION_RESERVED = 6 /* 6 and greater are reserved */
254 };
255
256 struct acpi_einj_error_type_with_addr {
257 u32 error_type;
258 u32 vendor_struct_offset;
259 u32 flags;
260 u32 apic_id;
261 u64 address;
262 u64 range;
263 u32 pcie_id;
264 };
265
266 struct acpi_einj_vendor {
267 u32 length;
268 u32 pcie_id;
269 u16 vendor_id;
270 u16 device_id;
271 u8 revision_id;
272 u8 reserved[3];
273 };
274
275 /* EINJ Trigger Error Action Table */
276
277 struct acpi_einj_trigger {
278 u32 header_size;
279 u32 revision;
280 u32 table_size;
281 u32 entry_count;
282 };
283
284 /* Command status return values */
285
286 enum acpi_einj_command_status {
287 ACPI_EINJ_SUCCESS = 0,
288 ACPI_EINJ_FAILURE = 1,
289 ACPI_EINJ_INVALID_ACCESS = 2,
290 ACPI_EINJ_STATUS_RESERVED = 3 /* 3 and greater are reserved */
291 };
292
293 /* Error types returned from ACPI_EINJ_GET_ERROR_TYPE (bitfield) */
294
295 #define ACPI_EINJ_PROCESSOR_CORRECTABLE (1)
296 #define ACPI_EINJ_PROCESSOR_UNCORRECTABLE (1<<1)
297 #define ACPI_EINJ_PROCESSOR_FATAL (1<<2)
298 #define ACPI_EINJ_MEMORY_CORRECTABLE (1<<3)
299 #define ACPI_EINJ_MEMORY_UNCORRECTABLE (1<<4)
300 #define ACPI_EINJ_MEMORY_FATAL (1<<5)
301 #define ACPI_EINJ_PCIX_CORRECTABLE (1<<6)
302 #define ACPI_EINJ_PCIX_UNCORRECTABLE (1<<7)
303 #define ACPI_EINJ_PCIX_FATAL (1<<8)
304 #define ACPI_EINJ_PLATFORM_CORRECTABLE (1<<9)
305 #define ACPI_EINJ_PLATFORM_UNCORRECTABLE (1<<10)
306 #define ACPI_EINJ_PLATFORM_FATAL (1<<11)
307 #define ACPI_EINJ_VENDOR_DEFINED (1<<31)
308
309 /*******************************************************************************
310 *
311 * ERST - Error Record Serialization Table (ACPI 4.0)
312 * Version 1
313 *
314 ******************************************************************************/
315
316 struct acpi_table_erst {
317 struct acpi_table_header header; /* Common ACPI table header */
318 u32 header_length;
319 u32 reserved;
320 u32 entries;
321 };
322
323 /* ERST Serialization Entries (actions) */
324
325 struct acpi_erst_entry {
326 struct acpi_whea_header whea_header; /* Common header for WHEA tables */
327 };
328
329 /* Masks for Flags field above */
330
331 #define ACPI_ERST_PRESERVE (1)
332
333 /* Values for Action field above */
334
335 enum acpi_erst_actions {
336 ACPI_ERST_BEGIN_WRITE = 0,
337 ACPI_ERST_BEGIN_READ = 1,
338 ACPI_ERST_BEGIN_CLEAR = 2,
339 ACPI_ERST_END = 3,
340 ACPI_ERST_SET_RECORD_OFFSET = 4,
341 ACPI_ERST_EXECUTE_OPERATION = 5,
342 ACPI_ERST_CHECK_BUSY_STATUS = 6,
343 ACPI_ERST_GET_COMMAND_STATUS = 7,
344 ACPI_ERST_GET_RECORD_ID = 8,
345 ACPI_ERST_SET_RECORD_ID = 9,
346 ACPI_ERST_GET_RECORD_COUNT = 10,
347 ACPI_ERST_BEGIN_DUMMY_WRIITE = 11,
348 ACPI_ERST_NOT_USED = 12,
349 ACPI_ERST_GET_ERROR_RANGE = 13,
350 ACPI_ERST_GET_ERROR_LENGTH = 14,
351 ACPI_ERST_GET_ERROR_ATTRIBUTES = 15,
352 ACPI_ERST_EXECUTE_TIMINGS = 16,
353 ACPI_ERST_ACTION_RESERVED = 17 /* 17 and greater are reserved */
354 };
355
356 /* Values for Instruction field above */
357
358 enum acpi_erst_instructions {
359 ACPI_ERST_READ_REGISTER = 0,
360 ACPI_ERST_READ_REGISTER_VALUE = 1,
361 ACPI_ERST_WRITE_REGISTER = 2,
362 ACPI_ERST_WRITE_REGISTER_VALUE = 3,
363 ACPI_ERST_NOOP = 4,
364 ACPI_ERST_LOAD_VAR1 = 5,
365 ACPI_ERST_LOAD_VAR2 = 6,
366 ACPI_ERST_STORE_VAR1 = 7,
367 ACPI_ERST_ADD = 8,
368 ACPI_ERST_SUBTRACT = 9,
369 ACPI_ERST_ADD_VALUE = 10,
370 ACPI_ERST_SUBTRACT_VALUE = 11,
371 ACPI_ERST_STALL = 12,
372 ACPI_ERST_STALL_WHILE_TRUE = 13,
373 ACPI_ERST_SKIP_NEXT_IF_TRUE = 14,
374 ACPI_ERST_GOTO = 15,
375 ACPI_ERST_SET_SRC_ADDRESS_BASE = 16,
376 ACPI_ERST_SET_DST_ADDRESS_BASE = 17,
377 ACPI_ERST_MOVE_DATA = 18,
378 ACPI_ERST_INSTRUCTION_RESERVED = 19 /* 19 and greater are reserved */
379 };
380
381 /* Command status return values */
382
383 enum acpi_erst_command_status {
384 ACPI_ERST_SUCESS = 0,
385 ACPI_ERST_NO_SPACE = 1,
386 ACPI_ERST_NOT_AVAILABLE = 2,
387 ACPI_ERST_FAILURE = 3,
388 ACPI_ERST_RECORD_EMPTY = 4,
389 ACPI_ERST_NOT_FOUND = 5,
390 ACPI_ERST_STATUS_RESERVED = 6 /* 6 and greater are reserved */
391 };
392
393 /* Error Record Serialization Information */
394
395 struct acpi_erst_info {
396 u16 signature; /* Should be "ER" */
397 u8 data[48];
398 };
399
400 /*******************************************************************************
401 *
402 * HEST - Hardware Error Source Table (ACPI 4.0)
403 * Version 1
404 *
405 ******************************************************************************/
406
407 struct acpi_table_hest {
408 struct acpi_table_header header; /* Common ACPI table header */
409 u32 error_source_count;
410 };
411
412 /* HEST subtable header */
413
414 struct acpi_hest_header {
415 u16 type;
416 u16 source_id;
417 };
418
419 /* Values for Type field above for subtables */
420
421 enum acpi_hest_types {
422 ACPI_HEST_TYPE_IA32_CHECK = 0,
423 ACPI_HEST_TYPE_IA32_CORRECTED_CHECK = 1,
424 ACPI_HEST_TYPE_IA32_NMI = 2,
425 ACPI_HEST_TYPE_NOT_USED3 = 3,
426 ACPI_HEST_TYPE_NOT_USED4 = 4,
427 ACPI_HEST_TYPE_NOT_USED5 = 5,
428 ACPI_HEST_TYPE_AER_ROOT_PORT = 6,
429 ACPI_HEST_TYPE_AER_ENDPOINT = 7,
430 ACPI_HEST_TYPE_AER_BRIDGE = 8,
431 ACPI_HEST_TYPE_GENERIC_ERROR = 9,
432 ACPI_HEST_TYPE_GENERIC_ERROR_V2 = 10,
433 ACPI_HEST_TYPE_RESERVED = 11 /* 11 and greater are reserved */
434 };
435
436 /*
437 * HEST substructures contained in subtables
438 */
439
440 /*
441 * IA32 Error Bank(s) - Follows the struct acpi_hest_ia_machine_check and
442 * struct acpi_hest_ia_corrected structures.
443 */
444 struct acpi_hest_ia_error_bank {
445 u8 bank_number;
446 u8 clear_status_on_init;
447 u8 status_format;
448 u8 reserved;
449 u32 control_register;
450 u64 control_data;
451 u32 status_register;
452 u32 address_register;
453 u32 misc_register;
454 };
455
456 /* Common HEST sub-structure for PCI/AER structures below (6,7,8) */
457
458 struct acpi_hest_aer_common {
459 u16 reserved1;
460 u8 flags;
461 u8 enabled;
462 u32 records_to_preallocate;
463 u32 max_sections_per_record;
464 u32 bus; /* Bus and Segment numbers */
465 u16 device;
466 u16 function;
467 u16 device_control;
468 u16 reserved2;
469 u32 uncorrectable_mask;
470 u32 uncorrectable_severity;
471 u32 correctable_mask;
472 u32 advanced_capabilities;
473 };
474
475 /* Masks for HEST Flags fields */
476
477 #define ACPI_HEST_FIRMWARE_FIRST (1)
478 #define ACPI_HEST_GLOBAL (1<<1)
479
480 /*
481 * Macros to access the bus/segment numbers in Bus field above:
482 * Bus number is encoded in bits 7:0
483 * Segment number is encoded in bits 23:8
484 */
485 #define ACPI_HEST_BUS(bus) ((bus) & 0xFF)
486 #define ACPI_HEST_SEGMENT(bus) (((bus) >> 8) & 0xFFFF)
487
488 /* Hardware Error Notification */
489
490 struct acpi_hest_notify {
491 u8 type;
492 u8 length;
493 u16 config_write_enable;
494 u32 poll_interval;
495 u32 vector;
496 u32 polling_threshold_value;
497 u32 polling_threshold_window;
498 u32 error_threshold_value;
499 u32 error_threshold_window;
500 };
501
502 /* Values for Notify Type field above */
503
504 enum acpi_hest_notify_types {
505 ACPI_HEST_NOTIFY_POLLED = 0,
506 ACPI_HEST_NOTIFY_EXTERNAL = 1,
507 ACPI_HEST_NOTIFY_LOCAL = 2,
508 ACPI_HEST_NOTIFY_SCI = 3,
509 ACPI_HEST_NOTIFY_NMI = 4,
510 ACPI_HEST_NOTIFY_CMCI = 5, /* ACPI 5.0 */
511 ACPI_HEST_NOTIFY_MCE = 6, /* ACPI 5.0 */
512 ACPI_HEST_NOTIFY_GPIO = 7, /* ACPI 6.0 */
513 ACPI_HEST_NOTIFY_SEA = 8, /* ACPI 6.1 */
514 ACPI_HEST_NOTIFY_SEI = 9, /* ACPI 6.1 */
515 ACPI_HEST_NOTIFY_GSIV = 10, /* ACPI 6.1 */
516 ACPI_HEST_NOTIFY_RESERVED = 11 /* 11 and greater are reserved */
517 };
518
519 /* Values for config_write_enable bitfield above */
520
521 #define ACPI_HEST_TYPE (1)
522 #define ACPI_HEST_POLL_INTERVAL (1<<1)
523 #define ACPI_HEST_POLL_THRESHOLD_VALUE (1<<2)
524 #define ACPI_HEST_POLL_THRESHOLD_WINDOW (1<<3)
525 #define ACPI_HEST_ERR_THRESHOLD_VALUE (1<<4)
526 #define ACPI_HEST_ERR_THRESHOLD_WINDOW (1<<5)
527
528 /*
529 * HEST subtables
530 */
531
532 /* 0: IA32 Machine Check Exception */
533
534 struct acpi_hest_ia_machine_check {
535 struct acpi_hest_header header;
536 u16 reserved1;
537 u8 flags;
538 u8 enabled;
539 u32 records_to_preallocate;
540 u32 max_sections_per_record;
541 u64 global_capability_data;
542 u64 global_control_data;
543 u8 num_hardware_banks;
544 u8 reserved3[7];
545 };
546
547 /* 1: IA32 Corrected Machine Check */
548
549 struct acpi_hest_ia_corrected {
550 struct acpi_hest_header header;
551 u16 reserved1;
552 u8 flags;
553 u8 enabled;
554 u32 records_to_preallocate;
555 u32 max_sections_per_record;
556 struct acpi_hest_notify notify;
557 u8 num_hardware_banks;
558 u8 reserved2[3];
559 };
560
561 /* 2: IA32 Non-Maskable Interrupt */
562
563 struct acpi_hest_ia_nmi {
564 struct acpi_hest_header header;
565 u32 reserved;
566 u32 records_to_preallocate;
567 u32 max_sections_per_record;
568 u32 max_raw_data_length;
569 };
570
571 /* 3,4,5: Not used */
572
573 /* 6: PCI Express Root Port AER */
574
575 struct acpi_hest_aer_root {
576 struct acpi_hest_header header;
577 struct acpi_hest_aer_common aer;
578 u32 root_error_command;
579 };
580
581 /* 7: PCI Express AER (AER Endpoint) */
582
583 struct acpi_hest_aer {
584 struct acpi_hest_header header;
585 struct acpi_hest_aer_common aer;
586 };
587
588 /* 8: PCI Express/PCI-X Bridge AER */
589
590 struct acpi_hest_aer_bridge {
591 struct acpi_hest_header header;
592 struct acpi_hest_aer_common aer;
593 u32 uncorrectable_mask2;
594 u32 uncorrectable_severity2;
595 u32 advanced_capabilities2;
596 };
597
598 /* 9: Generic Hardware Error Source */
599
600 struct acpi_hest_generic {
601 struct acpi_hest_header header;
602 u16 related_source_id;
603 u8 reserved;
604 u8 enabled;
605 u32 records_to_preallocate;
606 u32 max_sections_per_record;
607 u32 max_raw_data_length;
608 struct acpi_generic_address error_status_address;
609 struct acpi_hest_notify notify;
610 u32 error_block_length;
611 };
612
613 /* 10: Generic Hardware Error Source, version 2 */
614
615 struct acpi_hest_generic_v2 {
616 struct acpi_hest_header header;
617 u16 related_source_id;
618 u8 reserved;
619 u8 enabled;
620 u32 records_to_preallocate;
621 u32 max_sections_per_record;
622 u32 max_raw_data_length;
623 struct acpi_generic_address error_status_address;
624 struct acpi_hest_notify notify;
625 u32 error_block_length;
626 struct acpi_generic_address read_ack_register;
627 u64 read_ack_preserve;
628 u64 read_ack_write;
629 };
630
631 /* Generic Error Status block */
632
633 struct acpi_hest_generic_status {
634 u32 block_status;
635 u32 raw_data_offset;
636 u32 raw_data_length;
637 u32 data_length;
638 u32 error_severity;
639 };
640
641 /* Values for block_status flags above */
642
643 #define ACPI_HEST_UNCORRECTABLE (1)
644 #define ACPI_HEST_CORRECTABLE (1<<1)
645 #define ACPI_HEST_MULTIPLE_UNCORRECTABLE (1<<2)
646 #define ACPI_HEST_MULTIPLE_CORRECTABLE (1<<3)
647 #define ACPI_HEST_ERROR_ENTRY_COUNT (0xFF<<4) /* 8 bits, error count */
648
649 /* Generic Error Data entry */
650
651 struct acpi_hest_generic_data {
652 u8 section_type[16];
653 u32 error_severity;
654 u16 revision;
655 u8 validation_bits;
656 u8 flags;
657 u32 error_data_length;
658 u8 fru_id[16];
659 u8 fru_text[20];
660 };
661
662 /* Extension for revision 0x0300 */
663
664 struct acpi_hest_generic_data_v300 {
665 u8 section_type[16];
666 u32 error_severity;
667 u16 revision;
668 u8 validation_bits;
669 u8 flags;
670 u32 error_data_length;
671 u8 fru_id[16];
672 u8 fru_text[20];
673 u64 time_stamp;
674 };
675
676 /* Values for error_severity above */
677
678 #define ACPI_HEST_GEN_ERROR_RECOVERABLE 0
679 #define ACPI_HEST_GEN_ERROR_FATAL 1
680 #define ACPI_HEST_GEN_ERROR_CORRECTED 2
681 #define ACPI_HEST_GEN_ERROR_NONE 3
682
683 /* Flags for validation_bits above */
684
685 #define ACPI_HEST_GEN_VALID_FRU_ID (1)
686 #define ACPI_HEST_GEN_VALID_FRU_STRING (1<<1)
687 #define ACPI_HEST_GEN_VALID_TIMESTAMP (1<<2)
688
689 /*******************************************************************************
690 *
691 * MADT - Multiple APIC Description Table
692 * Version 3
693 *
694 ******************************************************************************/
695
696 struct acpi_table_madt {
697 struct acpi_table_header header; /* Common ACPI table header */
698 u32 address; /* Physical address of local APIC */
699 u32 flags;
700 };
701
702 /* Masks for Flags field above */
703
704 #define ACPI_MADT_PCAT_COMPAT (1) /* 00: System also has dual 8259s */
705
706 /* Values for PCATCompat flag */
707
708 #define ACPI_MADT_DUAL_PIC 0
709 #define ACPI_MADT_MULTIPLE_APIC 1
710
711 /* Values for MADT subtable type in struct acpi_subtable_header */
712
713 enum acpi_madt_type {
714 ACPI_MADT_TYPE_LOCAL_APIC = 0,
715 ACPI_MADT_TYPE_IO_APIC = 1,
716 ACPI_MADT_TYPE_INTERRUPT_OVERRIDE = 2,
717 ACPI_MADT_TYPE_NMI_SOURCE = 3,
718 ACPI_MADT_TYPE_LOCAL_APIC_NMI = 4,
719 ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE = 5,
720 ACPI_MADT_TYPE_IO_SAPIC = 6,
721 ACPI_MADT_TYPE_LOCAL_SAPIC = 7,
722 ACPI_MADT_TYPE_INTERRUPT_SOURCE = 8,
723 ACPI_MADT_TYPE_LOCAL_X2APIC = 9,
724 ACPI_MADT_TYPE_LOCAL_X2APIC_NMI = 10,
725 ACPI_MADT_TYPE_GENERIC_INTERRUPT = 11,
726 ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR = 12,
727 ACPI_MADT_TYPE_GENERIC_MSI_FRAME = 13,
728 ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR = 14,
729 ACPI_MADT_TYPE_GENERIC_TRANSLATOR = 15,
730 ACPI_MADT_TYPE_RESERVED = 16 /* 16 and greater are reserved */
731 };
732
733 /*
734 * MADT Subtables, correspond to Type in struct acpi_subtable_header
735 */
736
737 /* 0: Processor Local APIC */
738
739 struct acpi_madt_local_apic {
740 struct acpi_subtable_header header;
741 u8 processor_id; /* ACPI processor id */
742 u8 id; /* Processor's local APIC id */
743 u32 lapic_flags;
744 };
745
746 /* 1: IO APIC */
747
748 struct acpi_madt_io_apic {
749 struct acpi_subtable_header header;
750 u8 id; /* I/O APIC ID */
751 u8 reserved; /* reserved - must be zero */
752 u32 address; /* APIC physical address */
753 u32 global_irq_base; /* Global system interrupt where INTI lines start */
754 };
755
756 /* 2: Interrupt Override */
757
758 struct acpi_madt_interrupt_override {
759 struct acpi_subtable_header header;
760 u8 bus; /* 0 - ISA */
761 u8 source_irq; /* Interrupt source (IRQ) */
762 u32 global_irq; /* Global system interrupt */
763 u16 inti_flags;
764 };
765
766 /* 3: NMI Source */
767
768 struct acpi_madt_nmi_source {
769 struct acpi_subtable_header header;
770 u16 inti_flags;
771 u32 global_irq; /* Global system interrupt */
772 };
773
774 /* 4: Local APIC NMI */
775
776 struct acpi_madt_local_apic_nmi {
777 struct acpi_subtable_header header;
778 u8 processor_id; /* ACPI processor id */
779 u16 inti_flags;
780 u8 lint; /* LINTn to which NMI is connected */
781 };
782
783 /* 5: Address Override */
784
785 struct acpi_madt_local_apic_override {
786 struct acpi_subtable_header header;
787 u16 reserved; /* Reserved, must be zero */
788 u64 address; /* APIC physical address */
789 };
790
791 /* 6: I/O Sapic */
792
793 struct acpi_madt_io_sapic {
794 struct acpi_subtable_header header;
795 u8 id; /* I/O SAPIC ID */
796 u8 reserved; /* Reserved, must be zero */
797 u32 global_irq_base; /* Global interrupt for SAPIC start */
798 u64 address; /* SAPIC physical address */
799 };
800
801 /* 7: Local Sapic */
802
803 struct acpi_madt_local_sapic {
804 struct acpi_subtable_header header;
805 u8 processor_id; /* ACPI processor id */
806 u8 id; /* SAPIC ID */
807 u8 eid; /* SAPIC EID */
808 u8 reserved[3]; /* Reserved, must be zero */
809 u32 lapic_flags;
810 u32 uid; /* Numeric UID - ACPI 3.0 */
811 char uid_string[1]; /* String UID - ACPI 3.0 */
812 };
813
814 /* 8: Platform Interrupt Source */
815
816 struct acpi_madt_interrupt_source {
817 struct acpi_subtable_header header;
818 u16 inti_flags;
819 u8 type; /* 1=PMI, 2=INIT, 3=corrected */
820 u8 id; /* Processor ID */
821 u8 eid; /* Processor EID */
822 u8 io_sapic_vector; /* Vector value for PMI interrupts */
823 u32 global_irq; /* Global system interrupt */
824 u32 flags; /* Interrupt Source Flags */
825 };
826
827 /* Masks for Flags field above */
828
829 #define ACPI_MADT_CPEI_OVERRIDE (1)
830
831 /* 9: Processor Local X2APIC (ACPI 4.0) */
832
833 struct acpi_madt_local_x2apic {
834 struct acpi_subtable_header header;
835 u16 reserved; /* reserved - must be zero */
836 u32 local_apic_id; /* Processor x2APIC ID */
837 u32 lapic_flags;
838 u32 uid; /* ACPI processor UID */
839 };
840
841 /* 10: Local X2APIC NMI (ACPI 4.0) */
842
843 struct acpi_madt_local_x2apic_nmi {
844 struct acpi_subtable_header header;
845 u16 inti_flags;
846 u32 uid; /* ACPI processor UID */
847 u8 lint; /* LINTn to which NMI is connected */
848 u8 reserved[3]; /* reserved - must be zero */
849 };
850
851 /* 11: Generic Interrupt (ACPI 5.0 + ACPI 6.0 changes) */
852
853 struct acpi_madt_generic_interrupt {
854 struct acpi_subtable_header header;
855 u16 reserved; /* reserved - must be zero */
856 u32 cpu_interface_number;
857 u32 uid;
858 u32 flags;
859 u32 parking_version;
860 u32 performance_interrupt;
861 u64 parked_address;
862 u64 base_address;
863 u64 gicv_base_address;
864 u64 gich_base_address;
865 u32 vgic_interrupt;
866 u64 gicr_base_address;
867 u64 arm_mpidr;
868 u8 efficiency_class;
869 u8 reserved2[3];
870 };
871
872 /* Masks for Flags field above */
873
874 /* ACPI_MADT_ENABLED (1) Processor is usable if set */
875 #define ACPI_MADT_PERFORMANCE_IRQ_MODE (1<<1) /* 01: Performance Interrupt Mode */
876 #define ACPI_MADT_VGIC_IRQ_MODE (1<<2) /* 02: VGIC Maintenance Interrupt mode */
877
878 /* 12: Generic Distributor (ACPI 5.0 + ACPI 6.0 changes) */
879
880 struct acpi_madt_generic_distributor {
881 struct acpi_subtable_header header;
882 u16 reserved; /* reserved - must be zero */
883 u32 gic_id;
884 u64 base_address;
885 u32 global_irq_base;
886 u8 version;
887 u8 reserved2[3]; /* reserved - must be zero */
888 };
889
890 /* Values for Version field above */
891
892 enum acpi_madt_gic_version {
893 ACPI_MADT_GIC_VERSION_NONE = 0,
894 ACPI_MADT_GIC_VERSION_V1 = 1,
895 ACPI_MADT_GIC_VERSION_V2 = 2,
896 ACPI_MADT_GIC_VERSION_V3 = 3,
897 ACPI_MADT_GIC_VERSION_V4 = 4,
898 ACPI_MADT_GIC_VERSION_RESERVED = 5 /* 5 and greater are reserved */
899 };
900
901 /* 13: Generic MSI Frame (ACPI 5.1) */
902
903 struct acpi_madt_generic_msi_frame {
904 struct acpi_subtable_header header;
905 u16 reserved; /* reserved - must be zero */
906 u32 msi_frame_id;
907 u64 base_address;
908 u32 flags;
909 u16 spi_count;
910 u16 spi_base;
911 };
912
913 /* Masks for Flags field above */
914
915 #define ACPI_MADT_OVERRIDE_SPI_VALUES (1)
916
917 /* 14: Generic Redistributor (ACPI 5.1) */
918
919 struct acpi_madt_generic_redistributor {
920 struct acpi_subtable_header header;
921 u16 reserved; /* reserved - must be zero */
922 u64 base_address;
923 u32 length;
924 };
925
926 /* 15: Generic Translator (ACPI 6.0) */
927
928 struct acpi_madt_generic_translator {
929 struct acpi_subtable_header header;
930 u16 reserved; /* reserved - must be zero */
931 u32 translation_id;
932 u64 base_address;
933 u32 reserved2;
934 };
935
936 /*
937 * Common flags fields for MADT subtables
938 */
939
940 /* MADT Local APIC flags */
941
942 #define ACPI_MADT_ENABLED (1) /* 00: Processor is usable if set */
943
944 /* MADT MPS INTI flags (inti_flags) */
945
946 #define ACPI_MADT_POLARITY_MASK (3) /* 00-01: Polarity of APIC I/O input signals */
947 #define ACPI_MADT_TRIGGER_MASK (3<<2) /* 02-03: Trigger mode of APIC input signals */
948
949 /* Values for MPS INTI flags */
950
951 #define ACPI_MADT_POLARITY_CONFORMS 0
952 #define ACPI_MADT_POLARITY_ACTIVE_HIGH 1
953 #define ACPI_MADT_POLARITY_RESERVED 2
954 #define ACPI_MADT_POLARITY_ACTIVE_LOW 3
955
956 #define ACPI_MADT_TRIGGER_CONFORMS (0)
957 #define ACPI_MADT_TRIGGER_EDGE (1<<2)
958 #define ACPI_MADT_TRIGGER_RESERVED (2<<2)
959 #define ACPI_MADT_TRIGGER_LEVEL (3<<2)
960
961 /*******************************************************************************
962 *
963 * MSCT - Maximum System Characteristics Table (ACPI 4.0)
964 * Version 1
965 *
966 ******************************************************************************/
967
968 struct acpi_table_msct {
969 struct acpi_table_header header; /* Common ACPI table header */
970 u32 proximity_offset; /* Location of proximity info struct(s) */
971 u32 max_proximity_domains; /* Max number of proximity domains */
972 u32 max_clock_domains; /* Max number of clock domains */
973 u64 max_address; /* Max physical address in system */
974 };
975
976 /* subtable - Maximum Proximity Domain Information. Version 1 */
977
978 struct acpi_msct_proximity {
979 u8 revision;
980 u8 length;
981 u32 range_start; /* Start of domain range */
982 u32 range_end; /* End of domain range */
983 u32 processor_capacity;
984 u64 memory_capacity; /* In bytes */
985 };
986
987 /*******************************************************************************
988 *
989 * NFIT - NVDIMM Interface Table (ACPI 6.0+)
990 * Version 1
991 *
992 ******************************************************************************/
993
994 struct acpi_table_nfit {
995 struct acpi_table_header header; /* Common ACPI table header */
996 u32 reserved; /* Reserved, must be zero */
997 };
998
999 /* Subtable header for NFIT */
1000
1001 struct acpi_nfit_header {
1002 u16 type;
1003 u16 length;
1004 };
1005
1006 /* Values for subtable type in struct acpi_nfit_header */
1007
1008 enum acpi_nfit_type {
1009 ACPI_NFIT_TYPE_SYSTEM_ADDRESS = 0,
1010 ACPI_NFIT_TYPE_MEMORY_MAP = 1,
1011 ACPI_NFIT_TYPE_INTERLEAVE = 2,
1012 ACPI_NFIT_TYPE_SMBIOS = 3,
1013 ACPI_NFIT_TYPE_CONTROL_REGION = 4,
1014 ACPI_NFIT_TYPE_DATA_REGION = 5,
1015 ACPI_NFIT_TYPE_FLUSH_ADDRESS = 6,
1016 ACPI_NFIT_TYPE_RESERVED = 7 /* 7 and greater are reserved */
1017 };
1018
1019 /*
1020 * NFIT Subtables
1021 */
1022
1023 /* 0: System Physical Address Range Structure */
1024
1025 struct acpi_nfit_system_address {
1026 struct acpi_nfit_header header;
1027 u16 range_index;
1028 u16 flags;
1029 u32 reserved; /* Reseved, must be zero */
1030 u32 proximity_domain;
1031 u8 range_guid[16];
1032 u64 address;
1033 u64 length;
1034 u64 memory_mapping;
1035 };
1036
1037 /* Flags */
1038
1039 #define ACPI_NFIT_ADD_ONLINE_ONLY (1) /* 00: Add/Online Operation Only */
1040 #define ACPI_NFIT_PROXIMITY_VALID (1<<1) /* 01: Proximity Domain Valid */
1041
1042 /* Range Type GUIDs appear in the include/acuuid.h file */
1043
1044 /* 1: Memory Device to System Address Range Map Structure */
1045
1046 struct acpi_nfit_memory_map {
1047 struct acpi_nfit_header header;
1048 u32 device_handle;
1049 u16 physical_id;
1050 u16 region_id;
1051 u16 range_index;
1052 u16 region_index;
1053 u64 region_size;
1054 u64 region_offset;
1055 u64 address;
1056 u16 interleave_index;
1057 u16 interleave_ways;
1058 u16 flags;
1059 u16 reserved; /* Reserved, must be zero */
1060 };
1061
1062 /* Flags */
1063
1064 #define ACPI_NFIT_MEM_SAVE_FAILED (1) /* 00: Last SAVE to Memory Device failed */
1065 #define ACPI_NFIT_MEM_RESTORE_FAILED (1<<1) /* 01: Last RESTORE from Memory Device failed */
1066 #define ACPI_NFIT_MEM_FLUSH_FAILED (1<<2) /* 02: Platform flush failed */
1067 #define ACPI_NFIT_MEM_NOT_ARMED (1<<3) /* 03: Memory Device is not armed */
1068 #define ACPI_NFIT_MEM_HEALTH_OBSERVED (1<<4) /* 04: Memory Device observed SMART/health events */
1069 #define ACPI_NFIT_MEM_HEALTH_ENABLED (1<<5) /* 05: SMART/health events enabled */
1070 #define ACPI_NFIT_MEM_MAP_FAILED (1<<6) /* 06: Mapping to SPA failed */
1071
1072 /* 2: Interleave Structure */
1073
1074 struct acpi_nfit_interleave {
1075 struct acpi_nfit_header header;
1076 u16 interleave_index;
1077 u16 reserved; /* Reserved, must be zero */
1078 u32 line_count;
1079 u32 line_size;
1080 u32 line_offset[1]; /* Variable length */
1081 };
1082
1083 /* 3: SMBIOS Management Information Structure */
1084
1085 struct acpi_nfit_smbios {
1086 struct acpi_nfit_header header;
1087 u32 reserved; /* Reserved, must be zero */
1088 u8 data[1]; /* Variable length */
1089 };
1090
1091 /* 4: NVDIMM Control Region Structure */
1092
1093 struct acpi_nfit_control_region {
1094 struct acpi_nfit_header header;
1095 u16 region_index;
1096 u16 vendor_id;
1097 u16 device_id;
1098 u16 revision_id;
1099 u16 subsystem_vendor_id;
1100 u16 subsystem_device_id;
1101 u16 subsystem_revision_id;
1102 u8 valid_fields;
1103 u8 manufacturing_location;
1104 u16 manufacturing_date;
1105 u8 reserved[2]; /* Reserved, must be zero */
1106 u32 serial_number;
1107 u16 code;
1108 u16 windows;
1109 u64 window_size;
1110 u64 command_offset;
1111 u64 command_size;
1112 u64 status_offset;
1113 u64 status_size;
1114 u16 flags;
1115 u8 reserved1[6]; /* Reserved, must be zero */
1116 };
1117
1118 /* Flags */
1119
1120 #define ACPI_NFIT_CONTROL_BUFFERED (1) /* Block Data Windows implementation is buffered */
1121
1122 /* valid_fields bits */
1123
1124 #define ACPI_NFIT_CONTROL_MFG_INFO_VALID (1) /* Manufacturing fields are valid */
1125
1126 /* 5: NVDIMM Block Data Window Region Structure */
1127
1128 struct acpi_nfit_data_region {
1129 struct acpi_nfit_header header;
1130 u16 region_index;
1131 u16 windows;
1132 u64 offset;
1133 u64 size;
1134 u64 capacity;
1135 u64 start_address;
1136 };
1137
1138 /* 6: Flush Hint Address Structure */
1139
1140 struct acpi_nfit_flush_address {
1141 struct acpi_nfit_header header;
1142 u32 device_handle;
1143 u16 hint_count;
1144 u8 reserved[6]; /* Reserved, must be zero */
1145 u64 hint_address[1]; /* Variable length */
1146 };
1147
1148 /*******************************************************************************
1149 *
1150 * SBST - Smart Battery Specification Table
1151 * Version 1
1152 *
1153 ******************************************************************************/
1154
1155 struct acpi_table_sbst {
1156 struct acpi_table_header header; /* Common ACPI table header */
1157 u32 warning_level;
1158 u32 low_level;
1159 u32 critical_level;
1160 };
1161
1162 /*******************************************************************************
1163 *
1164 * SLIT - System Locality Distance Information Table
1165 * Version 1
1166 *
1167 ******************************************************************************/
1168
1169 struct acpi_table_slit {
1170 struct acpi_table_header header; /* Common ACPI table header */
1171 u64 locality_count;
1172 u8 entry[1]; /* Real size = localities^2 */
1173 };
1174
1175 /*******************************************************************************
1176 *
1177 * SRAT - System Resource Affinity Table
1178 * Version 3
1179 *
1180 ******************************************************************************/
1181
1182 struct acpi_table_srat {
1183 struct acpi_table_header header; /* Common ACPI table header */
1184 u32 table_revision; /* Must be value '1' */
1185 u64 reserved; /* Reserved, must be zero */
1186 };
1187
1188 /* Values for subtable type in struct acpi_subtable_header */
1189
1190 enum acpi_srat_type {
1191 ACPI_SRAT_TYPE_CPU_AFFINITY = 0,
1192 ACPI_SRAT_TYPE_MEMORY_AFFINITY = 1,
1193 ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY = 2,
1194 ACPI_SRAT_TYPE_GICC_AFFINITY = 3,
1195 ACPI_SRAT_TYPE_RESERVED = 4 /* 4 and greater are reserved */
1196 };
1197
1198 /*
1199 * SRAT Subtables, correspond to Type in struct acpi_subtable_header
1200 */
1201
1202 /* 0: Processor Local APIC/SAPIC Affinity */
1203
1204 struct acpi_srat_cpu_affinity {
1205 struct acpi_subtable_header header;
1206 u8 proximity_domain_lo;
1207 u8 apic_id;
1208 u32 flags;
1209 u8 local_sapic_eid;
1210 u8 proximity_domain_hi[3];
1211 u32 clock_domain;
1212 };
1213
1214 /* Flags */
1215
1216 #define ACPI_SRAT_CPU_USE_AFFINITY (1) /* 00: Use affinity structure */
1217
1218 /* 1: Memory Affinity */
1219
1220 struct acpi_srat_mem_affinity {
1221 struct acpi_subtable_header header;
1222 u32 proximity_domain;
1223 u16 reserved; /* Reserved, must be zero */
1224 u64 base_address;
1225 u64 length;
1226 u32 reserved1;
1227 u32 flags;
1228 u64 reserved2; /* Reserved, must be zero */
1229 };
1230
1231 /* Flags */
1232
1233 #define ACPI_SRAT_MEM_ENABLED (1) /* 00: Use affinity structure */
1234 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1) /* 01: Memory region is hot pluggable */
1235 #define ACPI_SRAT_MEM_NON_VOLATILE (1<<2) /* 02: Memory region is non-volatile */
1236
1237 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
1238
1239 struct acpi_srat_x2apic_cpu_affinity {
1240 struct acpi_subtable_header header;
1241 u16 reserved; /* Reserved, must be zero */
1242 u32 proximity_domain;
1243 u32 apic_id;
1244 u32 flags;
1245 u32 clock_domain;
1246 u32 reserved2;
1247 };
1248
1249 /* Flags for struct acpi_srat_cpu_affinity and struct acpi_srat_x2apic_cpu_affinity */
1250
1251 #define ACPI_SRAT_CPU_ENABLED (1) /* 00: Use affinity structure */
1252
1253 /* 3: GICC Affinity (ACPI 5.1) */
1254
1255 struct acpi_srat_gicc_affinity {
1256 struct acpi_subtable_header header;
1257 u32 proximity_domain;
1258 u32 acpi_processor_uid;
1259 u32 flags;
1260 u32 clock_domain;
1261 };
1262
1263 /* Flags for struct acpi_srat_gicc_affinity */
1264
1265 #define ACPI_SRAT_GICC_ENABLED (1) /* 00: Use affinity structure */
1266
1267 /* Reset to default packing */
1268
1269 #pragma pack()
1270
1271 #endif /* __ACTBL1_H__ */