d92543f3bbfdcaaeac47252729af30ba428eb371
[sfrench/cifs-2.6.git] / include / acpi / actbl.h
1 /******************************************************************************
2  *
3  * Name: actbl.h - Basic ACPI Table Definitions
4  *
5  *****************************************************************************/
6
7 /*
8  * Copyright (C) 2000 - 2017, Intel Corp.
9  * All rights reserved.
10  *
11  * Redistribution and use in source and binary forms, with or without
12  * modification, are permitted provided that the following conditions
13  * are met:
14  * 1. Redistributions of source code must retain the above copyright
15  *    notice, this list of conditions, and the following disclaimer,
16  *    without modification.
17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18  *    substantially similar to the "NO WARRANTY" disclaimer below
19  *    ("Disclaimer") and any redistribution must be conditioned upon
20  *    including a substantially similar Disclaimer requirement for further
21  *    binary redistribution.
22  * 3. Neither the names of the above-listed copyright holders nor the names
23  *    of any contributors may be used to endorse or promote products derived
24  *    from this software without specific prior written permission.
25  *
26  * Alternatively, this software may be distributed under the terms of the
27  * GNU General Public License ("GPL") version 2 as published by the Free
28  * Software Foundation.
29  *
30  * NO WARRANTY
31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41  * POSSIBILITY OF SUCH DAMAGES.
42  */
43
44 #ifndef __ACTBL_H__
45 #define __ACTBL_H__
46
47 /*******************************************************************************
48  *
49  * Fundamental ACPI tables
50  *
51  * This file contains definitions for the ACPI tables that are directly consumed
52  * by ACPICA. All other tables are consumed by the OS-dependent ACPI-related
53  * device drivers and other OS support code.
54  *
55  * The RSDP and FACS do not use the common ACPI table header. All other ACPI
56  * tables use the header.
57  *
58  ******************************************************************************/
59
60 /*
61  * Values for description table header signatures for tables defined in this
62  * file. Useful because they make it more difficult to inadvertently type in
63  * the wrong signature.
64  */
65 #define ACPI_SIG_DSDT           "DSDT"  /* Differentiated System Description Table */
66 #define ACPI_SIG_FADT           "FACP"  /* Fixed ACPI Description Table */
67 #define ACPI_SIG_FACS           "FACS"  /* Firmware ACPI Control Structure */
68 #define ACPI_SIG_OSDT           "OSDT"  /* Override System Description Table */
69 #define ACPI_SIG_PSDT           "PSDT"  /* Persistent System Description Table */
70 #define ACPI_SIG_RSDP           "RSD PTR "      /* Root System Description Pointer */
71 #define ACPI_SIG_RSDT           "RSDT"  /* Root System Description Table */
72 #define ACPI_SIG_XSDT           "XSDT"  /* Extended  System Description Table */
73 #define ACPI_SIG_SSDT           "SSDT"  /* Secondary System Description Table */
74 #define ACPI_RSDP_NAME          "RSDP"  /* Short name for RSDP, not signature */
75
76 /*
77  * All tables and structures must be byte-packed to match the ACPI
78  * specification, since 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  * Master ACPI Table Header. This common header is used by all ACPI tables
97  * except the RSDP and FACS.
98  *
99  ******************************************************************************/
100
101 struct acpi_table_header {
102         char signature[ACPI_NAME_SIZE]; /* ASCII table signature */
103         u32 length;             /* Length of table in bytes, including this header */
104         u8 revision;            /* ACPI Specification minor version number */
105         u8 checksum;            /* To make sum of entire table == 0 */
106         char oem_id[ACPI_OEM_ID_SIZE];  /* ASCII OEM identification */
107         char oem_table_id[ACPI_OEM_TABLE_ID_SIZE];      /* ASCII OEM table identification */
108         u32 oem_revision;       /* OEM revision number */
109         char asl_compiler_id[ACPI_NAME_SIZE];   /* ASCII ASL compiler vendor ID */
110         u32 asl_compiler_revision;      /* ASL compiler version */
111 };
112
113 /*******************************************************************************
114  *
115  * GAS - Generic Address Structure (ACPI 2.0+)
116  *
117  * Note: Since this structure is used in the ACPI tables, it is byte aligned.
118  * If misaligned access is not supported by the hardware, accesses to the
119  * 64-bit Address field must be performed with care.
120  *
121  ******************************************************************************/
122
123 struct acpi_generic_address {
124         u8 space_id;            /* Address space where struct or register exists */
125         u8 bit_width;           /* Size in bits of given register */
126         u8 bit_offset;          /* Bit offset within the register */
127         u8 access_width;        /* Minimum Access size (ACPI 3.0) */
128         u64 address;            /* 64-bit address of struct or register */
129 };
130
131 /*******************************************************************************
132  *
133  * RSDP - Root System Description Pointer (Signature is "RSD PTR ")
134  *        Version 2
135  *
136  ******************************************************************************/
137
138 struct acpi_table_rsdp {
139         char signature[8];      /* ACPI signature, contains "RSD PTR " */
140         u8 checksum;            /* ACPI 1.0 checksum */
141         char oem_id[ACPI_OEM_ID_SIZE];  /* OEM identification */
142         u8 revision;            /* Must be (0) for ACPI 1.0 or (2) for ACPI 2.0+ */
143         u32 rsdt_physical_address;      /* 32-bit physical address of the RSDT */
144         u32 length;             /* Table length in bytes, including header (ACPI 2.0+) */
145         u64 xsdt_physical_address;      /* 64-bit physical address of the XSDT (ACPI 2.0+) */
146         u8 extended_checksum;   /* Checksum of entire table (ACPI 2.0+) */
147         u8 reserved[3];         /* Reserved, must be zero */
148 };
149
150 /* Standalone struct for the ACPI 1.0 RSDP */
151
152 struct acpi_rsdp_common {
153         char signature[8];
154         u8 checksum;
155         char oem_id[ACPI_OEM_ID_SIZE];
156         u8 revision;
157         u32 rsdt_physical_address;
158 };
159
160 /* Standalone struct for the extended part of the RSDP (ACPI 2.0+) */
161
162 struct acpi_rsdp_extension {
163         u32 length;
164         u64 xsdt_physical_address;
165         u8 extended_checksum;
166         u8 reserved[3];
167 };
168
169 /*******************************************************************************
170  *
171  * RSDT/XSDT - Root System Description Tables
172  *             Version 1 (both)
173  *
174  ******************************************************************************/
175
176 struct acpi_table_rsdt {
177         struct acpi_table_header header;        /* Common ACPI table header */
178         u32 table_offset_entry[1];      /* Array of pointers to ACPI tables */
179 };
180
181 struct acpi_table_xsdt {
182         struct acpi_table_header header;        /* Common ACPI table header */
183         u64 table_offset_entry[1];      /* Array of pointers to ACPI tables */
184 };
185
186 #define ACPI_RSDT_ENTRY_SIZE        (sizeof (u32))
187 #define ACPI_XSDT_ENTRY_SIZE        (sizeof (u64))
188
189 /*******************************************************************************
190  *
191  * FACS - Firmware ACPI Control Structure (FACS)
192  *
193  ******************************************************************************/
194
195 struct acpi_table_facs {
196         char signature[4];      /* ASCII table signature */
197         u32 length;             /* Length of structure, in bytes */
198         u32 hardware_signature; /* Hardware configuration signature */
199         u32 firmware_waking_vector;     /* 32-bit physical address of the Firmware Waking Vector */
200         u32 global_lock;        /* Global Lock for shared hardware resources */
201         u32 flags;
202         u64 xfirmware_waking_vector;    /* 64-bit version of the Firmware Waking Vector (ACPI 2.0+) */
203         u8 version;             /* Version of this table (ACPI 2.0+) */
204         u8 reserved[3];         /* Reserved, must be zero */
205         u32 ospm_flags;         /* Flags to be set by OSPM (ACPI 4.0) */
206         u8 reserved1[24];       /* Reserved, must be zero */
207 };
208
209 /* Masks for global_lock flag field above */
210
211 #define ACPI_GLOCK_PENDING          (1) /* 00: Pending global lock ownership */
212 #define ACPI_GLOCK_OWNED            (1<<1)      /* 01: Global lock is owned */
213
214 /* Masks for Flags field above  */
215
216 #define ACPI_FACS_S4_BIOS_PRESENT   (1) /* 00: S4BIOS support is present */
217 #define ACPI_FACS_64BIT_WAKE        (1<<1)      /* 01: 64-bit wake vector supported (ACPI 4.0) */
218
219 /* Masks for ospm_flags field above */
220
221 #define ACPI_FACS_64BIT_ENVIRONMENT (1) /* 00: 64-bit wake environment is required (ACPI 4.0) */
222
223 /*******************************************************************************
224  *
225  * FADT - Fixed ACPI Description Table (Signature "FACP")
226  *        Version 6
227  *
228  ******************************************************************************/
229
230 /* Fields common to all versions of the FADT */
231
232 struct acpi_table_fadt {
233         struct acpi_table_header header;        /* Common ACPI table header */
234         u32 facs;               /* 32-bit physical address of FACS */
235         u32 dsdt;               /* 32-bit physical address of DSDT */
236         u8 model;               /* System Interrupt Model (ACPI 1.0) - not used in ACPI 2.0+ */
237         u8 preferred_profile;   /* Conveys preferred power management profile to OSPM. */
238         u16 sci_interrupt;      /* System vector of SCI interrupt */
239         u32 smi_command;        /* 32-bit Port address of SMI command port */
240         u8 acpi_enable;         /* Value to write to SMI_CMD to enable ACPI */
241         u8 acpi_disable;        /* Value to write to SMI_CMD to disable ACPI */
242         u8 s4_bios_request;     /* Value to write to SMI_CMD to enter S4BIOS state */
243         u8 pstate_control;      /* Processor performance state control */
244         u32 pm1a_event_block;   /* 32-bit port address of Power Mgt 1a Event Reg Blk */
245         u32 pm1b_event_block;   /* 32-bit port address of Power Mgt 1b Event Reg Blk */
246         u32 pm1a_control_block; /* 32-bit port address of Power Mgt 1a Control Reg Blk */
247         u32 pm1b_control_block; /* 32-bit port address of Power Mgt 1b Control Reg Blk */
248         u32 pm2_control_block;  /* 32-bit port address of Power Mgt 2 Control Reg Blk */
249         u32 pm_timer_block;     /* 32-bit port address of Power Mgt Timer Ctrl Reg Blk */
250         u32 gpe0_block;         /* 32-bit port address of General Purpose Event 0 Reg Blk */
251         u32 gpe1_block;         /* 32-bit port address of General Purpose Event 1 Reg Blk */
252         u8 pm1_event_length;    /* Byte Length of ports at pm1x_event_block */
253         u8 pm1_control_length;  /* Byte Length of ports at pm1x_control_block */
254         u8 pm2_control_length;  /* Byte Length of ports at pm2_control_block */
255         u8 pm_timer_length;     /* Byte Length of ports at pm_timer_block */
256         u8 gpe0_block_length;   /* Byte Length of ports at gpe0_block */
257         u8 gpe1_block_length;   /* Byte Length of ports at gpe1_block */
258         u8 gpe1_base;           /* Offset in GPE number space where GPE1 events start */
259         u8 cst_control;         /* Support for the _CST object and C-States change notification */
260         u16 c2_latency;         /* Worst case HW latency to enter/exit C2 state */
261         u16 c3_latency;         /* Worst case HW latency to enter/exit C3 state */
262         u16 flush_size;         /* Processor memory cache line width, in bytes */
263         u16 flush_stride;       /* Number of flush strides that need to be read */
264         u8 duty_offset;         /* Processor duty cycle index in processor P_CNT reg */
265         u8 duty_width;          /* Processor duty cycle value bit width in P_CNT register */
266         u8 day_alarm;           /* Index to day-of-month alarm in RTC CMOS RAM */
267         u8 month_alarm;         /* Index to month-of-year alarm in RTC CMOS RAM */
268         u8 century;             /* Index to century in RTC CMOS RAM */
269         u16 boot_flags;         /* IA-PC Boot Architecture Flags (see below for individual flags) */
270         u8 reserved;            /* Reserved, must be zero */
271         u32 flags;              /* Miscellaneous flag bits (see below for individual flags) */
272         struct acpi_generic_address reset_register;     /* 64-bit address of the Reset register */
273         u8 reset_value;         /* Value to write to the reset_register port to reset the system */
274         u16 arm_boot_flags;     /* ARM-Specific Boot Flags (see below for individual flags) (ACPI 5.1) */
275         u8 minor_revision;      /* FADT Minor Revision (ACPI 5.1) */
276         u64 Xfacs;              /* 64-bit physical address of FACS */
277         u64 Xdsdt;              /* 64-bit physical address of DSDT */
278         struct acpi_generic_address xpm1a_event_block;  /* 64-bit Extended Power Mgt 1a Event Reg Blk address */
279         struct acpi_generic_address xpm1b_event_block;  /* 64-bit Extended Power Mgt 1b Event Reg Blk address */
280         struct acpi_generic_address xpm1a_control_block;        /* 64-bit Extended Power Mgt 1a Control Reg Blk address */
281         struct acpi_generic_address xpm1b_control_block;        /* 64-bit Extended Power Mgt 1b Control Reg Blk address */
282         struct acpi_generic_address xpm2_control_block; /* 64-bit Extended Power Mgt 2 Control Reg Blk address */
283         struct acpi_generic_address xpm_timer_block;    /* 64-bit Extended Power Mgt Timer Ctrl Reg Blk address */
284         struct acpi_generic_address xgpe0_block;        /* 64-bit Extended General Purpose Event 0 Reg Blk address */
285         struct acpi_generic_address xgpe1_block;        /* 64-bit Extended General Purpose Event 1 Reg Blk address */
286         struct acpi_generic_address sleep_control;      /* 64-bit Sleep Control register (ACPI 5.0) */
287         struct acpi_generic_address sleep_status;       /* 64-bit Sleep Status register (ACPI 5.0) */
288         u64 hypervisor_id;      /* Hypervisor Vendor ID (ACPI 6.0) */
289 };
290
291 /* Masks for FADT IA-PC Boot Architecture Flags (boot_flags) [Vx]=Introduced in this FADT revision */
292
293 #define ACPI_FADT_LEGACY_DEVICES    (1)         /* 00: [V2] System has LPC or ISA bus devices */
294 #define ACPI_FADT_8042              (1<<1)      /* 01: [V3] System has an 8042 controller on port 60/64 */
295 #define ACPI_FADT_NO_VGA            (1<<2)      /* 02: [V4] It is not safe to probe for VGA hardware */
296 #define ACPI_FADT_NO_MSI            (1<<3)      /* 03: [V4] Message Signaled Interrupts (MSI) must not be enabled */
297 #define ACPI_FADT_NO_ASPM           (1<<4)      /* 04: [V4] PCIe ASPM control must not be enabled */
298 #define ACPI_FADT_NO_CMOS_RTC       (1<<5)      /* 05: [V5] No CMOS real-time clock present */
299
300 #define FADT2_REVISION_ID               3
301
302 /* Masks for FADT ARM Boot Architecture Flags (arm_boot_flags) ACPI 5.1 */
303
304 #define ACPI_FADT_PSCI_COMPLIANT    (1) /* 00: [V5+] PSCI 0.2+ is implemented */
305 #define ACPI_FADT_PSCI_USE_HVC      (1<<1)      /* 01: [V5+] HVC must be used instead of SMC as the PSCI conduit */
306
307 /* Masks for FADT flags */
308
309 #define ACPI_FADT_WBINVD            (1) /* 00: [V1] The WBINVD instruction works properly */
310 #define ACPI_FADT_WBINVD_FLUSH      (1<<1)      /* 01: [V1] WBINVD flushes but does not invalidate caches */
311 #define ACPI_FADT_C1_SUPPORTED      (1<<2)      /* 02: [V1] All processors support C1 state */
312 #define ACPI_FADT_C2_MP_SUPPORTED   (1<<3)      /* 03: [V1] C2 state works on MP system */
313 #define ACPI_FADT_POWER_BUTTON      (1<<4)      /* 04: [V1] Power button is handled as a control method device */
314 #define ACPI_FADT_SLEEP_BUTTON      (1<<5)      /* 05: [V1] Sleep button is handled as a control method device */
315 #define ACPI_FADT_FIXED_RTC         (1<<6)      /* 06: [V1] RTC wakeup status is not in fixed register space */
316 #define ACPI_FADT_S4_RTC_WAKE       (1<<7)      /* 07: [V1] RTC alarm can wake system from S4 */
317 #define ACPI_FADT_32BIT_TIMER       (1<<8)      /* 08: [V1] ACPI timer width is 32-bit (0=24-bit) */
318 #define ACPI_FADT_DOCKING_SUPPORTED (1<<9)      /* 09: [V1] Docking supported */
319 #define ACPI_FADT_RESET_REGISTER    (1<<10)     /* 10: [V2] System reset via the FADT RESET_REG supported */
320 #define ACPI_FADT_SEALED_CASE       (1<<11)     /* 11: [V3] No internal expansion capabilities and case is sealed */
321 #define ACPI_FADT_HEADLESS          (1<<12)     /* 12: [V3] No local video capabilities or local input devices */
322 #define ACPI_FADT_SLEEP_TYPE        (1<<13)     /* 13: [V3] Must execute native instruction after writing  SLP_TYPx register */
323 #define ACPI_FADT_PCI_EXPRESS_WAKE  (1<<14)     /* 14: [V4] System supports PCIEXP_WAKE (STS/EN) bits (ACPI 3.0) */
324 #define ACPI_FADT_PLATFORM_CLOCK    (1<<15)     /* 15: [V4] OSPM should use platform-provided timer (ACPI 3.0) */
325 #define ACPI_FADT_S4_RTC_VALID      (1<<16)     /* 16: [V4] Contents of RTC_STS valid after S4 wake (ACPI 3.0) */
326 #define ACPI_FADT_REMOTE_POWER_ON   (1<<17)     /* 17: [V4] System is compatible with remote power on (ACPI 3.0) */
327 #define ACPI_FADT_APIC_CLUSTER      (1<<18)     /* 18: [V4] All local APICs must use cluster model (ACPI 3.0) */
328 #define ACPI_FADT_APIC_PHYSICAL     (1<<19)     /* 19: [V4] All local xAPICs must use physical dest mode (ACPI 3.0) */
329 #define ACPI_FADT_HW_REDUCED        (1<<20)     /* 20: [V5] ACPI hardware is not implemented (ACPI 5.0) */
330 #define ACPI_FADT_LOW_POWER_S0      (1<<21)     /* 21: [V5] S0 power savings are equal or better than S3 (ACPI 5.0) */
331
332 /* Values for preferred_profile (Preferred Power Management Profiles) */
333
334 enum acpi_preferred_pm_profiles {
335         PM_UNSPECIFIED = 0,
336         PM_DESKTOP = 1,
337         PM_MOBILE = 2,
338         PM_WORKSTATION = 3,
339         PM_ENTERPRISE_SERVER = 4,
340         PM_SOHO_SERVER = 5,
341         PM_APPLIANCE_PC = 6,
342         PM_PERFORMANCE_SERVER = 7,
343         PM_TABLET = 8
344 };
345
346 /* Values for sleep_status and sleep_control registers (V5+ FADT) */
347
348 #define ACPI_X_WAKE_STATUS          0x80
349 #define ACPI_X_SLEEP_TYPE_MASK      0x1C
350 #define ACPI_X_SLEEP_TYPE_POSITION  0x02
351 #define ACPI_X_SLEEP_ENABLE         0x20
352
353 /* Reset to default packing */
354
355 #pragma pack()
356
357 /*
358  * Internal table-related structures
359  */
360 union acpi_name_union {
361         u32 integer;
362         char ascii[4];
363 };
364
365 /* Internal ACPI Table Descriptor. One per ACPI table. */
366
367 struct acpi_table_desc {
368         acpi_physical_address address;
369         struct acpi_table_header *pointer;
370         u32 length;             /* Length fixed at 32 bits (fixed in table header) */
371         union acpi_name_union signature;
372         acpi_owner_id owner_id;
373         u8 flags;
374         u16 validation_count;
375 };
376
377 /* Masks for Flags field above */
378
379 #define ACPI_TABLE_ORIGIN_EXTERNAL_VIRTUAL  (0) /* Virtual address, external maintained */
380 #define ACPI_TABLE_ORIGIN_INTERNAL_PHYSICAL (1) /* Physical address, internally mapped */
381 #define ACPI_TABLE_ORIGIN_INTERNAL_VIRTUAL  (2) /* Virtual address, internallly allocated */
382 #define ACPI_TABLE_ORIGIN_MASK              (3)
383 #define ACPI_TABLE_IS_LOADED                (8)
384
385 /*
386  * Get the remaining ACPI tables
387  */
388 #include <acpi/actbl1.h>
389 #include <acpi/actbl2.h>
390 #include <acpi/actbl3.h>
391
392 /* Macros used to generate offsets to specific table fields */
393
394 #define ACPI_FADT_OFFSET(f)             (u16) ACPI_OFFSET (struct acpi_table_fadt, f)
395
396 /*
397  * Sizes of the various flavors of FADT. We need to look closely
398  * at the FADT length because the version number essentially tells
399  * us nothing because of many BIOS bugs where the version does not
400  * match the expected length. In other words, the length of the
401  * FADT is the bottom line as to what the version really is.
402  *
403  * For reference, the values below are as follows:
404  *     FADT V1 size: 0x074
405  *     FADT V2 size: 0x084
406  *     FADT V3 size: 0x0F4
407  *     FADT V4 size: 0x0F4
408  *     FADT V5 size: 0x10C
409  *     FADT V6 size: 0x114
410  */
411 #define ACPI_FADT_V1_SIZE       (u32) (ACPI_FADT_OFFSET (flags) + 4)
412 #define ACPI_FADT_V2_SIZE       (u32) (ACPI_FADT_OFFSET (minor_revision) + 1)
413 #define ACPI_FADT_V3_SIZE       (u32) (ACPI_FADT_OFFSET (sleep_control))
414 #define ACPI_FADT_V5_SIZE       (u32) (ACPI_FADT_OFFSET (hypervisor_id))
415 #define ACPI_FADT_V6_SIZE       (u32) (sizeof (struct acpi_table_fadt))
416
417 #define ACPI_FADT_CONFORMANCE   "ACPI 6.1 (FADT version 6)"
418
419 #endif                          /* __ACTBL_H__ */