xref: /openbmc/linux/include/acpi/actbl1.h (revision 275876e2)
1 /******************************************************************************
2  *
3  * Name: actbl1.h - Additional ACPI table definitions
4  *
5  *****************************************************************************/
6 
7 /*
8  * Copyright (C) 2000 - 2014, 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 
75 /*
76  * All tables must be byte-packed to match the ACPI specification, since
77  * the tables are provided by the system BIOS.
78  */
79 #pragma pack(1)
80 
81 /*
82  * Note: C bitfields are not used for this reason:
83  *
84  * "Bitfields are great and easy to read, but unfortunately the C language
85  * does not specify the layout of bitfields in memory, which means they are
86  * essentially useless for dealing with packed data in on-disk formats or
87  * binary wire protocols." (Or ACPI tables and buffers.) "If you ask me,
88  * this decision was a design error in C. Ritchie could have picked an order
89  * and stuck with it." Norman Ramsey.
90  * See http://stackoverflow.com/a/1053662/41661
91  */
92 
93 /*******************************************************************************
94  *
95  * Common subtable headers
96  *
97  ******************************************************************************/
98 
99 /* Generic subtable header (used in MADT, SRAT, etc.) */
100 
101 struct acpi_subtable_header {
102 	u8 type;
103 	u8 length;
104 };
105 
106 /* Subtable header for WHEA tables (EINJ, ERST, WDAT) */
107 
108 struct acpi_whea_header {
109 	u8 action;
110 	u8 instruction;
111 	u8 flags;
112 	u8 reserved;
113 	struct acpi_generic_address register_region;
114 	u64 value;		/* Value used with Read/Write register */
115 	u64 mask;		/* Bitmask required for this register instruction */
116 };
117 
118 /*******************************************************************************
119  *
120  * BERT - Boot Error Record Table (ACPI 4.0)
121  *        Version 1
122  *
123  ******************************************************************************/
124 
125 struct acpi_table_bert {
126 	struct acpi_table_header header;	/* Common ACPI table header */
127 	u32 region_length;	/* Length of the boot error region */
128 	u64 address;		/* Physical address of the error region */
129 };
130 
131 /* Boot Error Region (not a subtable, pointed to by Address field above) */
132 
133 struct acpi_bert_region {
134 	u32 block_status;	/* Type of error information */
135 	u32 raw_data_offset;	/* Offset to raw error data */
136 	u32 raw_data_length;	/* Length of raw error data */
137 	u32 data_length;	/* Length of generic error data */
138 	u32 error_severity;	/* Severity code */
139 };
140 
141 /* Values for block_status flags above */
142 
143 #define ACPI_BERT_UNCORRECTABLE             (1)
144 #define ACPI_BERT_CORRECTABLE               (1<<1)
145 #define ACPI_BERT_MULTIPLE_UNCORRECTABLE    (1<<2)
146 #define ACPI_BERT_MULTIPLE_CORRECTABLE      (1<<3)
147 #define ACPI_BERT_ERROR_ENTRY_COUNT         (0xFF<<4)	/* 8 bits, error count */
148 
149 /* Values for error_severity above */
150 
151 enum acpi_bert_error_severity {
152 	ACPI_BERT_ERROR_CORRECTABLE = 0,
153 	ACPI_BERT_ERROR_FATAL = 1,
154 	ACPI_BERT_ERROR_CORRECTED = 2,
155 	ACPI_BERT_ERROR_NONE = 3,
156 	ACPI_BERT_ERROR_RESERVED = 4	/* 4 and greater are reserved */
157 };
158 
159 /*
160  * Note: The generic error data that follows the error_severity field above
161  * uses the struct acpi_hest_generic_data defined under the HEST table below
162  */
163 
164 /*******************************************************************************
165  *
166  * CPEP - Corrected Platform Error Polling table (ACPI 4.0)
167  *        Version 1
168  *
169  ******************************************************************************/
170 
171 struct acpi_table_cpep {
172 	struct acpi_table_header header;	/* Common ACPI table header */
173 	u64 reserved;
174 };
175 
176 /* Subtable */
177 
178 struct acpi_cpep_polling {
179 	struct acpi_subtable_header header;
180 	u8 id;			/* Processor ID */
181 	u8 eid;			/* Processor EID */
182 	u32 interval;		/* Polling interval (msec) */
183 };
184 
185 /*******************************************************************************
186  *
187  * ECDT - Embedded Controller Boot Resources Table
188  *        Version 1
189  *
190  ******************************************************************************/
191 
192 struct acpi_table_ecdt {
193 	struct acpi_table_header header;	/* Common ACPI table header */
194 	struct acpi_generic_address control;	/* Address of EC command/status register */
195 	struct acpi_generic_address data;	/* Address of EC data register */
196 	u32 uid;		/* Unique ID - must be same as the EC _UID method */
197 	u8 gpe;			/* The GPE for the EC */
198 	u8 id[1];		/* Full namepath of the EC in the ACPI namespace */
199 };
200 
201 /*******************************************************************************
202  *
203  * EINJ - Error Injection Table (ACPI 4.0)
204  *        Version 1
205  *
206  ******************************************************************************/
207 
208 struct acpi_table_einj {
209 	struct acpi_table_header header;	/* Common ACPI table header */
210 	u32 header_length;
211 	u8 flags;
212 	u8 reserved[3];
213 	u32 entries;
214 };
215 
216 /* EINJ Injection Instruction Entries (actions) */
217 
218 struct acpi_einj_entry {
219 	struct acpi_whea_header whea_header;	/* Common header for WHEA tables */
220 };
221 
222 /* Masks for Flags field above */
223 
224 #define ACPI_EINJ_PRESERVE          (1)
225 
226 /* Values for Action field above */
227 
228 enum acpi_einj_actions {
229 	ACPI_EINJ_BEGIN_OPERATION = 0,
230 	ACPI_EINJ_GET_TRIGGER_TABLE = 1,
231 	ACPI_EINJ_SET_ERROR_TYPE = 2,
232 	ACPI_EINJ_GET_ERROR_TYPE = 3,
233 	ACPI_EINJ_END_OPERATION = 4,
234 	ACPI_EINJ_EXECUTE_OPERATION = 5,
235 	ACPI_EINJ_CHECK_BUSY_STATUS = 6,
236 	ACPI_EINJ_GET_COMMAND_STATUS = 7,
237 	ACPI_EINJ_SET_ERROR_TYPE_WITH_ADDRESS = 8,
238 	ACPI_EINJ_ACTION_RESERVED = 9,	/* 9 and greater are reserved */
239 	ACPI_EINJ_TRIGGER_ERROR = 0xFF	/* Except for this value */
240 };
241 
242 /* Values for Instruction field above */
243 
244 enum acpi_einj_instructions {
245 	ACPI_EINJ_READ_REGISTER = 0,
246 	ACPI_EINJ_READ_REGISTER_VALUE = 1,
247 	ACPI_EINJ_WRITE_REGISTER = 2,
248 	ACPI_EINJ_WRITE_REGISTER_VALUE = 3,
249 	ACPI_EINJ_NOOP = 4,
250 	ACPI_EINJ_FLUSH_CACHELINE = 5,
251 	ACPI_EINJ_INSTRUCTION_RESERVED = 6	/* 6 and greater are reserved */
252 };
253 
254 struct acpi_einj_error_type_with_addr {
255 	u32 error_type;
256 	u32 vendor_struct_offset;
257 	u32 flags;
258 	u32 apic_id;
259 	u64 address;
260 	u64 range;
261 	u32 pcie_id;
262 };
263 
264 struct acpi_einj_vendor {
265 	u32 length;
266 	u32 pcie_id;
267 	u16 vendor_id;
268 	u16 device_id;
269 	u8 revision_id;
270 	u8 reserved[3];
271 };
272 
273 /* EINJ Trigger Error Action Table */
274 
275 struct acpi_einj_trigger {
276 	u32 header_size;
277 	u32 revision;
278 	u32 table_size;
279 	u32 entry_count;
280 };
281 
282 /* Command status return values */
283 
284 enum acpi_einj_command_status {
285 	ACPI_EINJ_SUCCESS = 0,
286 	ACPI_EINJ_FAILURE = 1,
287 	ACPI_EINJ_INVALID_ACCESS = 2,
288 	ACPI_EINJ_STATUS_RESERVED = 3	/* 3 and greater are reserved */
289 };
290 
291 /* Error types returned from ACPI_EINJ_GET_ERROR_TYPE (bitfield) */
292 
293 #define ACPI_EINJ_PROCESSOR_CORRECTABLE     (1)
294 #define ACPI_EINJ_PROCESSOR_UNCORRECTABLE   (1<<1)
295 #define ACPI_EINJ_PROCESSOR_FATAL           (1<<2)
296 #define ACPI_EINJ_MEMORY_CORRECTABLE        (1<<3)
297 #define ACPI_EINJ_MEMORY_UNCORRECTABLE      (1<<4)
298 #define ACPI_EINJ_MEMORY_FATAL              (1<<5)
299 #define ACPI_EINJ_PCIX_CORRECTABLE          (1<<6)
300 #define ACPI_EINJ_PCIX_UNCORRECTABLE        (1<<7)
301 #define ACPI_EINJ_PCIX_FATAL                (1<<8)
302 #define ACPI_EINJ_PLATFORM_CORRECTABLE      (1<<9)
303 #define ACPI_EINJ_PLATFORM_UNCORRECTABLE    (1<<10)
304 #define ACPI_EINJ_PLATFORM_FATAL            (1<<11)
305 #define ACPI_EINJ_VENDOR_DEFINED            (1<<31)
306 
307 /*******************************************************************************
308  *
309  * ERST - Error Record Serialization Table (ACPI 4.0)
310  *        Version 1
311  *
312  ******************************************************************************/
313 
314 struct acpi_table_erst {
315 	struct acpi_table_header header;	/* Common ACPI table header */
316 	u32 header_length;
317 	u32 reserved;
318 	u32 entries;
319 };
320 
321 /* ERST Serialization Entries (actions) */
322 
323 struct acpi_erst_entry {
324 	struct acpi_whea_header whea_header;	/* Common header for WHEA tables */
325 };
326 
327 /* Masks for Flags field above */
328 
329 #define ACPI_ERST_PRESERVE          (1)
330 
331 /* Values for Action field above */
332 
333 enum acpi_erst_actions {
334 	ACPI_ERST_BEGIN_WRITE = 0,
335 	ACPI_ERST_BEGIN_READ = 1,
336 	ACPI_ERST_BEGIN_CLEAR = 2,
337 	ACPI_ERST_END = 3,
338 	ACPI_ERST_SET_RECORD_OFFSET = 4,
339 	ACPI_ERST_EXECUTE_OPERATION = 5,
340 	ACPI_ERST_CHECK_BUSY_STATUS = 6,
341 	ACPI_ERST_GET_COMMAND_STATUS = 7,
342 	ACPI_ERST_GET_RECORD_ID = 8,
343 	ACPI_ERST_SET_RECORD_ID = 9,
344 	ACPI_ERST_GET_RECORD_COUNT = 10,
345 	ACPI_ERST_BEGIN_DUMMY_WRIITE = 11,
346 	ACPI_ERST_NOT_USED = 12,
347 	ACPI_ERST_GET_ERROR_RANGE = 13,
348 	ACPI_ERST_GET_ERROR_LENGTH = 14,
349 	ACPI_ERST_GET_ERROR_ATTRIBUTES = 15,
350 	ACPI_ERST_ACTION_RESERVED = 16	/* 16 and greater are reserved */
351 };
352 
353 /* Values for Instruction field above */
354 
355 enum acpi_erst_instructions {
356 	ACPI_ERST_READ_REGISTER = 0,
357 	ACPI_ERST_READ_REGISTER_VALUE = 1,
358 	ACPI_ERST_WRITE_REGISTER = 2,
359 	ACPI_ERST_WRITE_REGISTER_VALUE = 3,
360 	ACPI_ERST_NOOP = 4,
361 	ACPI_ERST_LOAD_VAR1 = 5,
362 	ACPI_ERST_LOAD_VAR2 = 6,
363 	ACPI_ERST_STORE_VAR1 = 7,
364 	ACPI_ERST_ADD = 8,
365 	ACPI_ERST_SUBTRACT = 9,
366 	ACPI_ERST_ADD_VALUE = 10,
367 	ACPI_ERST_SUBTRACT_VALUE = 11,
368 	ACPI_ERST_STALL = 12,
369 	ACPI_ERST_STALL_WHILE_TRUE = 13,
370 	ACPI_ERST_SKIP_NEXT_IF_TRUE = 14,
371 	ACPI_ERST_GOTO = 15,
372 	ACPI_ERST_SET_SRC_ADDRESS_BASE = 16,
373 	ACPI_ERST_SET_DST_ADDRESS_BASE = 17,
374 	ACPI_ERST_MOVE_DATA = 18,
375 	ACPI_ERST_INSTRUCTION_RESERVED = 19	/* 19 and greater are reserved */
376 };
377 
378 /* Command status return values */
379 
380 enum acpi_erst_command_status {
381 	ACPI_ERST_SUCESS = 0,
382 	ACPI_ERST_NO_SPACE = 1,
383 	ACPI_ERST_NOT_AVAILABLE = 2,
384 	ACPI_ERST_FAILURE = 3,
385 	ACPI_ERST_RECORD_EMPTY = 4,
386 	ACPI_ERST_NOT_FOUND = 5,
387 	ACPI_ERST_STATUS_RESERVED = 6	/* 6 and greater are reserved */
388 };
389 
390 /* Error Record Serialization Information */
391 
392 struct acpi_erst_info {
393 	u16 signature;		/* Should be "ER" */
394 	u8 data[48];
395 };
396 
397 /*******************************************************************************
398  *
399  * HEST - Hardware Error Source Table (ACPI 4.0)
400  *        Version 1
401  *
402  ******************************************************************************/
403 
404 struct acpi_table_hest {
405 	struct acpi_table_header header;	/* Common ACPI table header */
406 	u32 error_source_count;
407 };
408 
409 /* HEST subtable header */
410 
411 struct acpi_hest_header {
412 	u16 type;
413 	u16 source_id;
414 };
415 
416 /* Values for Type field above for subtables */
417 
418 enum acpi_hest_types {
419 	ACPI_HEST_TYPE_IA32_CHECK = 0,
420 	ACPI_HEST_TYPE_IA32_CORRECTED_CHECK = 1,
421 	ACPI_HEST_TYPE_IA32_NMI = 2,
422 	ACPI_HEST_TYPE_NOT_USED3 = 3,
423 	ACPI_HEST_TYPE_NOT_USED4 = 4,
424 	ACPI_HEST_TYPE_NOT_USED5 = 5,
425 	ACPI_HEST_TYPE_AER_ROOT_PORT = 6,
426 	ACPI_HEST_TYPE_AER_ENDPOINT = 7,
427 	ACPI_HEST_TYPE_AER_BRIDGE = 8,
428 	ACPI_HEST_TYPE_GENERIC_ERROR = 9,
429 	ACPI_HEST_TYPE_RESERVED = 10	/* 10 and greater are reserved */
430 };
431 
432 /*
433  * HEST substructures contained in subtables
434  */
435 
436 /*
437  * IA32 Error Bank(s) - Follows the struct acpi_hest_ia_machine_check and
438  * struct acpi_hest_ia_corrected structures.
439  */
440 struct acpi_hest_ia_error_bank {
441 	u8 bank_number;
442 	u8 clear_status_on_init;
443 	u8 status_format;
444 	u8 reserved;
445 	u32 control_register;
446 	u64 control_data;
447 	u32 status_register;
448 	u32 address_register;
449 	u32 misc_register;
450 };
451 
452 /* Common HEST sub-structure for PCI/AER structures below (6,7,8) */
453 
454 struct acpi_hest_aer_common {
455 	u16 reserved1;
456 	u8 flags;
457 	u8 enabled;
458 	u32 records_to_preallocate;
459 	u32 max_sections_per_record;
460 	u32 bus;		/* Bus and Segment numbers */
461 	u16 device;
462 	u16 function;
463 	u16 device_control;
464 	u16 reserved2;
465 	u32 uncorrectable_mask;
466 	u32 uncorrectable_severity;
467 	u32 correctable_mask;
468 	u32 advanced_capabilities;
469 };
470 
471 /* Masks for HEST Flags fields */
472 
473 #define ACPI_HEST_FIRMWARE_FIRST        (1)
474 #define ACPI_HEST_GLOBAL                (1<<1)
475 
476 /*
477  * Macros to access the bus/segment numbers in Bus field above:
478  *  Bus number is encoded in bits 7:0
479  *  Segment number is encoded in bits 23:8
480  */
481 #define ACPI_HEST_BUS(bus)              ((bus) & 0xFF)
482 #define ACPI_HEST_SEGMENT(bus)          (((bus) >> 8) & 0xFFFF)
483 
484 /* Hardware Error Notification */
485 
486 struct acpi_hest_notify {
487 	u8 type;
488 	u8 length;
489 	u16 config_write_enable;
490 	u32 poll_interval;
491 	u32 vector;
492 	u32 polling_threshold_value;
493 	u32 polling_threshold_window;
494 	u32 error_threshold_value;
495 	u32 error_threshold_window;
496 };
497 
498 /* Values for Notify Type field above */
499 
500 enum acpi_hest_notify_types {
501 	ACPI_HEST_NOTIFY_POLLED = 0,
502 	ACPI_HEST_NOTIFY_EXTERNAL = 1,
503 	ACPI_HEST_NOTIFY_LOCAL = 2,
504 	ACPI_HEST_NOTIFY_SCI = 3,
505 	ACPI_HEST_NOTIFY_NMI = 4,
506 	ACPI_HEST_NOTIFY_CMCI = 5,	/* ACPI 5.0 */
507 	ACPI_HEST_NOTIFY_MCE = 6,	/* ACPI 5.0 */
508 	ACPI_HEST_NOTIFY_RESERVED = 7	/* 7 and greater are reserved */
509 };
510 
511 /* Values for config_write_enable bitfield above */
512 
513 #define ACPI_HEST_TYPE                  (1)
514 #define ACPI_HEST_POLL_INTERVAL         (1<<1)
515 #define ACPI_HEST_POLL_THRESHOLD_VALUE  (1<<2)
516 #define ACPI_HEST_POLL_THRESHOLD_WINDOW (1<<3)
517 #define ACPI_HEST_ERR_THRESHOLD_VALUE   (1<<4)
518 #define ACPI_HEST_ERR_THRESHOLD_WINDOW  (1<<5)
519 
520 /*
521  * HEST subtables
522  */
523 
524 /* 0: IA32 Machine Check Exception */
525 
526 struct acpi_hest_ia_machine_check {
527 	struct acpi_hest_header header;
528 	u16 reserved1;
529 	u8 flags;
530 	u8 enabled;
531 	u32 records_to_preallocate;
532 	u32 max_sections_per_record;
533 	u64 global_capability_data;
534 	u64 global_control_data;
535 	u8 num_hardware_banks;
536 	u8 reserved3[7];
537 };
538 
539 /* 1: IA32 Corrected Machine Check */
540 
541 struct acpi_hest_ia_corrected {
542 	struct acpi_hest_header header;
543 	u16 reserved1;
544 	u8 flags;
545 	u8 enabled;
546 	u32 records_to_preallocate;
547 	u32 max_sections_per_record;
548 	struct acpi_hest_notify notify;
549 	u8 num_hardware_banks;
550 	u8 reserved2[3];
551 };
552 
553 /* 2: IA32 Non-Maskable Interrupt */
554 
555 struct acpi_hest_ia_nmi {
556 	struct acpi_hest_header header;
557 	u32 reserved;
558 	u32 records_to_preallocate;
559 	u32 max_sections_per_record;
560 	u32 max_raw_data_length;
561 };
562 
563 /* 3,4,5: Not used */
564 
565 /* 6: PCI Express Root Port AER */
566 
567 struct acpi_hest_aer_root {
568 	struct acpi_hest_header header;
569 	struct acpi_hest_aer_common aer;
570 	u32 root_error_command;
571 };
572 
573 /* 7: PCI Express AER (AER Endpoint) */
574 
575 struct acpi_hest_aer {
576 	struct acpi_hest_header header;
577 	struct acpi_hest_aer_common aer;
578 };
579 
580 /* 8: PCI Express/PCI-X Bridge AER */
581 
582 struct acpi_hest_aer_bridge {
583 	struct acpi_hest_header header;
584 	struct acpi_hest_aer_common aer;
585 	u32 uncorrectable_mask2;
586 	u32 uncorrectable_severity2;
587 	u32 advanced_capabilities2;
588 };
589 
590 /* 9: Generic Hardware Error Source */
591 
592 struct acpi_hest_generic {
593 	struct acpi_hest_header header;
594 	u16 related_source_id;
595 	u8 reserved;
596 	u8 enabled;
597 	u32 records_to_preallocate;
598 	u32 max_sections_per_record;
599 	u32 max_raw_data_length;
600 	struct acpi_generic_address error_status_address;
601 	struct acpi_hest_notify notify;
602 	u32 error_block_length;
603 };
604 
605 /* Generic Error Status block */
606 
607 struct acpi_hest_generic_status {
608 	u32 block_status;
609 	u32 raw_data_offset;
610 	u32 raw_data_length;
611 	u32 data_length;
612 	u32 error_severity;
613 };
614 
615 /* Values for block_status flags above */
616 
617 #define ACPI_HEST_UNCORRECTABLE             (1)
618 #define ACPI_HEST_CORRECTABLE               (1<<1)
619 #define ACPI_HEST_MULTIPLE_UNCORRECTABLE    (1<<2)
620 #define ACPI_HEST_MULTIPLE_CORRECTABLE      (1<<3)
621 #define ACPI_HEST_ERROR_ENTRY_COUNT         (0xFF<<4)	/* 8 bits, error count */
622 
623 /* Generic Error Data entry */
624 
625 struct acpi_hest_generic_data {
626 	u8 section_type[16];
627 	u32 error_severity;
628 	u16 revision;
629 	u8 validation_bits;
630 	u8 flags;
631 	u32 error_data_length;
632 	u8 fru_id[16];
633 	u8 fru_text[20];
634 };
635 
636 /*******************************************************************************
637  *
638  * MADT - Multiple APIC Description Table
639  *        Version 3
640  *
641  ******************************************************************************/
642 
643 struct acpi_table_madt {
644 	struct acpi_table_header header;	/* Common ACPI table header */
645 	u32 address;		/* Physical address of local APIC */
646 	u32 flags;
647 };
648 
649 /* Masks for Flags field above */
650 
651 #define ACPI_MADT_PCAT_COMPAT       (1)	/* 00: System also has dual 8259s */
652 
653 /* Values for PCATCompat flag */
654 
655 #define ACPI_MADT_DUAL_PIC          0
656 #define ACPI_MADT_MULTIPLE_APIC     1
657 
658 /* Values for MADT subtable type in struct acpi_subtable_header */
659 
660 enum acpi_madt_type {
661 	ACPI_MADT_TYPE_LOCAL_APIC = 0,
662 	ACPI_MADT_TYPE_IO_APIC = 1,
663 	ACPI_MADT_TYPE_INTERRUPT_OVERRIDE = 2,
664 	ACPI_MADT_TYPE_NMI_SOURCE = 3,
665 	ACPI_MADT_TYPE_LOCAL_APIC_NMI = 4,
666 	ACPI_MADT_TYPE_LOCAL_APIC_OVERRIDE = 5,
667 	ACPI_MADT_TYPE_IO_SAPIC = 6,
668 	ACPI_MADT_TYPE_LOCAL_SAPIC = 7,
669 	ACPI_MADT_TYPE_INTERRUPT_SOURCE = 8,
670 	ACPI_MADT_TYPE_LOCAL_X2APIC = 9,
671 	ACPI_MADT_TYPE_LOCAL_X2APIC_NMI = 10,
672 	ACPI_MADT_TYPE_GENERIC_INTERRUPT = 11,
673 	ACPI_MADT_TYPE_GENERIC_DISTRIBUTOR = 12,
674 	ACPI_MADT_TYPE_GENERIC_MSI_FRAME = 13,
675 	ACPI_MADT_TYPE_GENERIC_REDISTRIBUTOR = 14,
676 	ACPI_MADT_TYPE_RESERVED = 15	/* 15 and greater are reserved */
677 };
678 
679 /*
680  * MADT Subtables, correspond to Type in struct acpi_subtable_header
681  */
682 
683 /* 0: Processor Local APIC */
684 
685 struct acpi_madt_local_apic {
686 	struct acpi_subtable_header header;
687 	u8 processor_id;	/* ACPI processor id */
688 	u8 id;			/* Processor's local APIC id */
689 	u32 lapic_flags;
690 };
691 
692 /* 1: IO APIC */
693 
694 struct acpi_madt_io_apic {
695 	struct acpi_subtable_header header;
696 	u8 id;			/* I/O APIC ID */
697 	u8 reserved;		/* reserved - must be zero */
698 	u32 address;		/* APIC physical address */
699 	u32 global_irq_base;	/* Global system interrupt where INTI lines start */
700 };
701 
702 /* 2: Interrupt Override */
703 
704 struct acpi_madt_interrupt_override {
705 	struct acpi_subtable_header header;
706 	u8 bus;			/* 0 - ISA */
707 	u8 source_irq;		/* Interrupt source (IRQ) */
708 	u32 global_irq;		/* Global system interrupt */
709 	u16 inti_flags;
710 };
711 
712 /* 3: NMI Source */
713 
714 struct acpi_madt_nmi_source {
715 	struct acpi_subtable_header header;
716 	u16 inti_flags;
717 	u32 global_irq;		/* Global system interrupt */
718 };
719 
720 /* 4: Local APIC NMI */
721 
722 struct acpi_madt_local_apic_nmi {
723 	struct acpi_subtable_header header;
724 	u8 processor_id;	/* ACPI processor id */
725 	u16 inti_flags;
726 	u8 lint;		/* LINTn to which NMI is connected */
727 };
728 
729 /* 5: Address Override */
730 
731 struct acpi_madt_local_apic_override {
732 	struct acpi_subtable_header header;
733 	u16 reserved;		/* Reserved, must be zero */
734 	u64 address;		/* APIC physical address */
735 };
736 
737 /* 6: I/O Sapic */
738 
739 struct acpi_madt_io_sapic {
740 	struct acpi_subtable_header header;
741 	u8 id;			/* I/O SAPIC ID */
742 	u8 reserved;		/* Reserved, must be zero */
743 	u32 global_irq_base;	/* Global interrupt for SAPIC start */
744 	u64 address;		/* SAPIC physical address */
745 };
746 
747 /* 7: Local Sapic */
748 
749 struct acpi_madt_local_sapic {
750 	struct acpi_subtable_header header;
751 	u8 processor_id;	/* ACPI processor id */
752 	u8 id;			/* SAPIC ID */
753 	u8 eid;			/* SAPIC EID */
754 	u8 reserved[3];		/* Reserved, must be zero */
755 	u32 lapic_flags;
756 	u32 uid;		/* Numeric UID - ACPI 3.0 */
757 	char uid_string[1];	/* String UID  - ACPI 3.0 */
758 };
759 
760 /* 8: Platform Interrupt Source */
761 
762 struct acpi_madt_interrupt_source {
763 	struct acpi_subtable_header header;
764 	u16 inti_flags;
765 	u8 type;		/* 1=PMI, 2=INIT, 3=corrected */
766 	u8 id;			/* Processor ID */
767 	u8 eid;			/* Processor EID */
768 	u8 io_sapic_vector;	/* Vector value for PMI interrupts */
769 	u32 global_irq;		/* Global system interrupt */
770 	u32 flags;		/* Interrupt Source Flags */
771 };
772 
773 /* Masks for Flags field above */
774 
775 #define ACPI_MADT_CPEI_OVERRIDE     (1)
776 
777 /* 9: Processor Local X2APIC (ACPI 4.0) */
778 
779 struct acpi_madt_local_x2apic {
780 	struct acpi_subtable_header header;
781 	u16 reserved;		/* reserved - must be zero */
782 	u32 local_apic_id;	/* Processor x2APIC ID  */
783 	u32 lapic_flags;
784 	u32 uid;		/* ACPI processor UID */
785 };
786 
787 /* 10: Local X2APIC NMI (ACPI 4.0) */
788 
789 struct acpi_madt_local_x2apic_nmi {
790 	struct acpi_subtable_header header;
791 	u16 inti_flags;
792 	u32 uid;		/* ACPI processor UID */
793 	u8 lint;		/* LINTn to which NMI is connected */
794 	u8 reserved[3];		/* reserved - must be zero */
795 };
796 
797 /* 11: Generic Interrupt (ACPI 5.0) */
798 
799 struct acpi_madt_generic_interrupt {
800 	struct acpi_subtable_header header;
801 	u16 reserved;		/* reserved - must be zero */
802 	u32 cpu_interface_number;
803 	u32 uid;
804 	u32 flags;
805 	u32 parking_version;
806 	u32 performance_interrupt;
807 	u64 parked_address;
808 	u64 base_address;
809 	u64 gicv_base_address;
810 	u64 gich_base_address;
811 	u32 vgic_interrupt;
812 	u64 gicr_base_address;
813 	u64 arm_mpidr;
814 };
815 
816 /* Masks for Flags field above */
817 
818 /* ACPI_MADT_ENABLED                    (1)      Processor is usable if set */
819 #define ACPI_MADT_PERFORMANCE_IRQ_MODE  (1<<1)	/* 01: Performance Interrupt Mode */
820 #define ACPI_MADT_VGIC_IRQ_MODE         (1<<2)	/* 02: VGIC Maintenance Interrupt mode */
821 
822 /* 12: Generic Distributor (ACPI 5.0) */
823 
824 struct acpi_madt_generic_distributor {
825 	struct acpi_subtable_header header;
826 	u16 reserved;		/* reserved - must be zero */
827 	u32 gic_id;
828 	u64 base_address;
829 	u32 global_irq_base;
830 	u32 reserved2;		/* reserved - must be zero */
831 };
832 
833 /* 13: Generic MSI Frame (ACPI 5.1) */
834 
835 struct acpi_madt_generic_msi_frame {
836 	struct acpi_subtable_header header;
837 	u16 reserved;		/* reserved - must be zero */
838 	u32 msi_frame_id;
839 	u64 base_address;
840 	u32 flags;
841 	u16 spi_count;
842 	u16 spi_base;
843 };
844 
845 /* Masks for Flags field above */
846 
847 #define ACPI_MADT_OVERRIDE_SPI_VALUES   (1)
848 
849 /* 14: Generic Redistributor (ACPI 5.1) */
850 
851 struct acpi_madt_generic_redistributor {
852 	struct acpi_subtable_header header;
853 	u16 reserved;		/* reserved - must be zero */
854 	u64 base_address;
855 	u32 length;
856 };
857 
858 /*
859  * Common flags fields for MADT subtables
860  */
861 
862 /* MADT Local APIC flags */
863 
864 #define ACPI_MADT_ENABLED           (1)	/* 00: Processor is usable if set */
865 
866 /* MADT MPS INTI flags (inti_flags) */
867 
868 #define ACPI_MADT_POLARITY_MASK     (3)	/* 00-01: Polarity of APIC I/O input signals */
869 #define ACPI_MADT_TRIGGER_MASK      (3<<2)	/* 02-03: Trigger mode of APIC input signals */
870 
871 /* Values for MPS INTI flags */
872 
873 #define ACPI_MADT_POLARITY_CONFORMS       0
874 #define ACPI_MADT_POLARITY_ACTIVE_HIGH    1
875 #define ACPI_MADT_POLARITY_RESERVED       2
876 #define ACPI_MADT_POLARITY_ACTIVE_LOW     3
877 
878 #define ACPI_MADT_TRIGGER_CONFORMS        (0)
879 #define ACPI_MADT_TRIGGER_EDGE            (1<<2)
880 #define ACPI_MADT_TRIGGER_RESERVED        (2<<2)
881 #define ACPI_MADT_TRIGGER_LEVEL           (3<<2)
882 
883 /*******************************************************************************
884  *
885  * MSCT - Maximum System Characteristics Table (ACPI 4.0)
886  *        Version 1
887  *
888  ******************************************************************************/
889 
890 struct acpi_table_msct {
891 	struct acpi_table_header header;	/* Common ACPI table header */
892 	u32 proximity_offset;	/* Location of proximity info struct(s) */
893 	u32 max_proximity_domains;	/* Max number of proximity domains */
894 	u32 max_clock_domains;	/* Max number of clock domains */
895 	u64 max_address;	/* Max physical address in system */
896 };
897 
898 /* subtable - Maximum Proximity Domain Information. Version 1 */
899 
900 struct acpi_msct_proximity {
901 	u8 revision;
902 	u8 length;
903 	u32 range_start;	/* Start of domain range */
904 	u32 range_end;		/* End of domain range */
905 	u32 processor_capacity;
906 	u64 memory_capacity;	/* In bytes */
907 };
908 
909 /*******************************************************************************
910  *
911  * SBST - Smart Battery Specification Table
912  *        Version 1
913  *
914  ******************************************************************************/
915 
916 struct acpi_table_sbst {
917 	struct acpi_table_header header;	/* Common ACPI table header */
918 	u32 warning_level;
919 	u32 low_level;
920 	u32 critical_level;
921 };
922 
923 /*******************************************************************************
924  *
925  * SLIT - System Locality Distance Information Table
926  *        Version 1
927  *
928  ******************************************************************************/
929 
930 struct acpi_table_slit {
931 	struct acpi_table_header header;	/* Common ACPI table header */
932 	u64 locality_count;
933 	u8 entry[1];		/* Real size = localities^2 */
934 };
935 
936 /*******************************************************************************
937  *
938  * SRAT - System Resource Affinity Table
939  *        Version 3
940  *
941  ******************************************************************************/
942 
943 struct acpi_table_srat {
944 	struct acpi_table_header header;	/* Common ACPI table header */
945 	u32 table_revision;	/* Must be value '1' */
946 	u64 reserved;		/* Reserved, must be zero */
947 };
948 
949 /* Values for subtable type in struct acpi_subtable_header */
950 
951 enum acpi_srat_type {
952 	ACPI_SRAT_TYPE_CPU_AFFINITY = 0,
953 	ACPI_SRAT_TYPE_MEMORY_AFFINITY = 1,
954 	ACPI_SRAT_TYPE_X2APIC_CPU_AFFINITY = 2,
955 	ACPI_SRAT_TYPE_RESERVED = 3	/* 3 and greater are reserved */
956 };
957 
958 /*
959  * SRAT Subtables, correspond to Type in struct acpi_subtable_header
960  */
961 
962 /* 0: Processor Local APIC/SAPIC Affinity */
963 
964 struct acpi_srat_cpu_affinity {
965 	struct acpi_subtable_header header;
966 	u8 proximity_domain_lo;
967 	u8 apic_id;
968 	u32 flags;
969 	u8 local_sapic_eid;
970 	u8 proximity_domain_hi[3];
971 	u32 reserved;		/* Reserved, must be zero */
972 };
973 
974 /* Flags */
975 
976 #define ACPI_SRAT_CPU_USE_AFFINITY  (1)	/* 00: Use affinity structure */
977 
978 /* 1: Memory Affinity */
979 
980 struct acpi_srat_mem_affinity {
981 	struct acpi_subtable_header header;
982 	u32 proximity_domain;
983 	u16 reserved;		/* Reserved, must be zero */
984 	u64 base_address;
985 	u64 length;
986        u32 reserved1;
987 	u32 flags;
988        u64 reserved2;	       /* Reserved, must be zero */
989 };
990 
991 /* Flags */
992 
993 #define ACPI_SRAT_MEM_ENABLED       (1)	/* 00: Use affinity structure */
994 #define ACPI_SRAT_MEM_HOT_PLUGGABLE (1<<1)	/* 01: Memory region is hot pluggable */
995 #define ACPI_SRAT_MEM_NON_VOLATILE  (1<<2)	/* 02: Memory region is non-volatile */
996 
997 /* 2: Processor Local X2_APIC Affinity (ACPI 4.0) */
998 
999 struct acpi_srat_x2apic_cpu_affinity {
1000 	struct acpi_subtable_header header;
1001 	u16 reserved;		/* Reserved, must be zero */
1002 	u32 proximity_domain;
1003 	u32 apic_id;
1004 	u32 flags;
1005 	u32 clock_domain;
1006 	u32 reserved2;
1007 };
1008 
1009 /* Flags for struct acpi_srat_cpu_affinity and struct acpi_srat_x2apic_cpu_affinity */
1010 
1011 #define ACPI_SRAT_CPU_ENABLED       (1)	/* 00: Use affinity structure */
1012 
1013 /* Reset to default packing */
1014 
1015 #pragma pack()
1016 
1017 #endif				/* __ACTBL1_H__ */
1018