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