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