]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blame - drivers/acpi/tables/tbfadt.c
Merge branch 'sh/for-2.6.28' of git://git.kernel.org/pub/scm/linux/kernel/git/lethal...
[mirror_ubuntu-bionic-kernel.git] / drivers / acpi / tables / tbfadt.c
CommitLineData
95befdb3
BM
1/******************************************************************************
2 *
3 * Module Name: tbfadt - FADT table utilities
4 *
5 *****************************************************************************/
6
7/*
75a44ce0 8 * Copyright (C) 2000 - 2008, Intel Corp.
95befdb3
BM
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#include <acpi/acpi.h>
45#include <acpi/actables.h>
46
47#define _COMPONENT ACPI_TABLES
48ACPI_MODULE_NAME("tbfadt")
49
50/* Local prototypes */
51static void inline
ea5d8ebc 52acpi_tb_init_generic_address(struct acpi_generic_address *generic_address,
fcea94ba 53 u8 byte_width, u64 address);
95befdb3 54
71392844
BM
55static void acpi_tb_convert_fadt(void);
56
57static void acpi_tb_validate_fadt(void);
58
ea5d8ebc 59/* Table for conversion of FADT to common internal format and FADT validation */
95befdb3 60
ea5d8ebc
BM
61typedef struct acpi_fadt_info {
62 char *name;
95befdb3
BM
63 u8 target;
64 u8 source;
65 u8 length;
ea5d8ebc 66 u8 type;
95befdb3 67
ea5d8ebc 68} acpi_fadt_info;
95befdb3 69
ea5d8ebc
BM
70#define ACPI_FADT_REQUIRED 1
71#define ACPI_FADT_SEPARATE_LENGTH 2
72
73static struct acpi_fadt_info fadt_info_table[] = {
74 {"Pm1aEventBlock", ACPI_FADT_OFFSET(xpm1a_event_block),
95befdb3 75 ACPI_FADT_OFFSET(pm1a_event_block),
ea5d8ebc
BM
76 ACPI_FADT_OFFSET(pm1_event_length), ACPI_FADT_REQUIRED},
77
78 {"Pm1bEventBlock", ACPI_FADT_OFFSET(xpm1b_event_block),
95befdb3 79 ACPI_FADT_OFFSET(pm1b_event_block),
ea5d8ebc
BM
80 ACPI_FADT_OFFSET(pm1_event_length), 0},
81
82 {"Pm1aControlBlock", ACPI_FADT_OFFSET(xpm1a_control_block),
95befdb3 83 ACPI_FADT_OFFSET(pm1a_control_block),
ea5d8ebc
BM
84 ACPI_FADT_OFFSET(pm1_control_length), ACPI_FADT_REQUIRED},
85
86 {"Pm1bControlBlock", ACPI_FADT_OFFSET(xpm1b_control_block),
95befdb3 87 ACPI_FADT_OFFSET(pm1b_control_block),
ea5d8ebc
BM
88 ACPI_FADT_OFFSET(pm1_control_length), 0},
89
90 {"Pm2ControlBlock", ACPI_FADT_OFFSET(xpm2_control_block),
95befdb3 91 ACPI_FADT_OFFSET(pm2_control_block),
ea5d8ebc
BM
92 ACPI_FADT_OFFSET(pm2_control_length), ACPI_FADT_SEPARATE_LENGTH},
93
94 {"PmTimerBlock", ACPI_FADT_OFFSET(xpm_timer_block),
95 ACPI_FADT_OFFSET(pm_timer_block),
96 ACPI_FADT_OFFSET(pm_timer_length), ACPI_FADT_REQUIRED},
97
98 {"Gpe0Block", ACPI_FADT_OFFSET(xgpe0_block),
99 ACPI_FADT_OFFSET(gpe0_block),
100 ACPI_FADT_OFFSET(gpe0_block_length), ACPI_FADT_SEPARATE_LENGTH},
101
102 {"Gpe1Block", ACPI_FADT_OFFSET(xgpe1_block),
103 ACPI_FADT_OFFSET(gpe1_block),
104 ACPI_FADT_OFFSET(gpe1_block_length), ACPI_FADT_SEPARATE_LENGTH}
95befdb3
BM
105};
106
ea5d8ebc 107#define ACPI_FADT_INFO_ENTRIES (sizeof (fadt_info_table) / sizeof (struct acpi_fadt_info))
95befdb3
BM
108
109/*******************************************************************************
110 *
111 * FUNCTION: acpi_tb_init_generic_address
112 *
ea5d8ebc 113 * PARAMETERS: generic_address - GAS struct to be initialized
fcea94ba 114 * byte_width - Width of this register
95befdb3
BM
115 * Address - Address of the register
116 *
117 * RETURN: None
118 *
ea5d8ebc
BM
119 * DESCRIPTION: Initialize a Generic Address Structure (GAS)
120 * See the ACPI specification for a full description and
121 * definition of this structure.
95befdb3
BM
122 *
123 ******************************************************************************/
124
125static void inline
ea5d8ebc 126acpi_tb_init_generic_address(struct acpi_generic_address *generic_address,
fcea94ba 127 u8 byte_width, u64 address)
95befdb3
BM
128{
129
ea5d8ebc
BM
130 /*
131 * The 64-bit Address field is non-aligned in the byte packed
132 * GAS struct.
133 */
134 ACPI_MOVE_64_TO_64(&generic_address->address, &address);
135
136 /* All other fields are byte-wide */
137
138 generic_address->space_id = ACPI_ADR_SPACE_SYSTEM_IO;
fcea94ba 139 generic_address->bit_width = byte_width << 3;
ea5d8ebc
BM
140 generic_address->bit_offset = 0;
141 generic_address->access_width = 0;
95befdb3
BM
142}
143
144/*******************************************************************************
145 *
146 * FUNCTION: acpi_tb_parse_fadt
147 *
148 * PARAMETERS: table_index - Index for the FADT
149 * Flags - Flags
150 *
151 * RETURN: None
152 *
153 * DESCRIPTION: Initialize the FADT, DSDT and FACS tables
154 * (FADT contains the addresses of the DSDT and FACS)
155 *
156 ******************************************************************************/
157
67a119f9 158void acpi_tb_parse_fadt(u32 table_index, u8 flags)
95befdb3
BM
159{
160 u32 length;
161 struct acpi_table_header *table;
162
163 /*
ea5d8ebc
BM
164 * The FADT has multiple versions with different lengths,
165 * and it contains pointers to both the DSDT and FACS tables.
95befdb3
BM
166 *
167 * Get a local copy of the FADT and convert it to a common format
168 * Map entire FADT, assumed to be smaller than one page.
169 */
170 length = acpi_gbl_root_table_list.tables[table_index].length;
171
172 table =
173 acpi_os_map_memory(acpi_gbl_root_table_list.tables[table_index].
174 address, length);
175 if (!table) {
176 return;
177 }
178
179 /*
180 * Validate the FADT checksum before we copy the table. Ignore
181 * checksum error as we want to try to get the DSDT and FACS.
182 */
183 (void)acpi_tb_verify_checksum(table, length);
184
71392844
BM
185 /* Obtain a local copy of the FADT in common ACPI 2.0+ format */
186
187 acpi_tb_create_local_fadt(table, length);
188
189 /* All done with the real FADT, unmap it */
190
191 acpi_os_unmap_memory(table, length);
192
193 /* Obtain the DSDT and FACS tables via their addresses within the FADT */
194
195 acpi_tb_install_table((acpi_physical_address) acpi_gbl_FADT.Xdsdt,
196 flags, ACPI_SIG_DSDT, ACPI_TABLE_INDEX_DSDT);
197
198 acpi_tb_install_table((acpi_physical_address) acpi_gbl_FADT.Xfacs,
199 flags, ACPI_SIG_FACS, ACPI_TABLE_INDEX_FACS);
200}
201
202/*******************************************************************************
203 *
204 * FUNCTION: acpi_tb_create_local_fadt
205 *
206 * PARAMETERS: Table - Pointer to BIOS FADT
207 * Length - Length of the table
208 *
209 * RETURN: None
210 *
211 * DESCRIPTION: Get a local copy of the FADT and convert it to a common format.
212 * Performs validation on some important FADT fields.
213 *
55f8f3cc
BM
214 * NOTE: We create a local copy of the FADT regardless of the version.
215 *
71392844
BM
216 ******************************************************************************/
217
218void acpi_tb_create_local_fadt(struct acpi_table_header *table, u32 length)
219{
220
ea5d8ebc 221 /*
55f8f3cc
BM
222 * Check if the FADT is larger than the largest table that we expect
223 * (the ACPI 2.0/3.0 version). If so, truncate the table, and issue
224 * a warning.
ea5d8ebc
BM
225 */
226 if (length > sizeof(struct acpi_table_fadt)) {
227 ACPI_WARNING((AE_INFO,
b0b7eaaf
AS
228 "FADT (revision %u) is longer than ACPI 2.0 version, truncating length 0x%X to 0x%zX",
229 table->revision, (unsigned)length,
ea5d8ebc
BM
230 sizeof(struct acpi_table_fadt)));
231 }
95befdb3 232
55f8f3cc 233 /* Clear the entire local FADT */
95befdb3 234
ea5d8ebc 235 ACPI_MEMSET(&acpi_gbl_FADT, 0, sizeof(struct acpi_table_fadt));
71392844 236
55f8f3cc
BM
237 /* Copy the original FADT, up to sizeof (struct acpi_table_fadt) */
238
95befdb3
BM
239 ACPI_MEMCPY(&acpi_gbl_FADT, table,
240 ACPI_MIN(length, sizeof(struct acpi_table_fadt)));
95befdb3 241
ea5d8ebc
BM
242 /*
243 * 1) Convert the local copy of the FADT to the common internal format
244 * 2) Validate some of the important values within the FADT
245 */
95befdb3 246 acpi_tb_convert_fadt();
71392844 247 acpi_tb_validate_fadt();
95befdb3
BM
248}
249
250/*******************************************************************************
251 *
252 * FUNCTION: acpi_tb_convert_fadt
253 *
254 * PARAMETERS: None, uses acpi_gbl_FADT
255 *
256 * RETURN: None
257 *
258 * DESCRIPTION: Converts all versions of the FADT to a common internal format.
55f8f3cc 259 * Expand all 32-bit addresses to 64-bit.
95befdb3 260 *
e56b638b
BM
261 * NOTE: acpi_gbl_FADT must be of size (struct acpi_table_fadt),
262 * and must contain a copy of the actual FADT.
95befdb3
BM
263 *
264 * ACPICA will use the "X" fields of the FADT for all addresses.
265 *
266 * "X" fields are optional extensions to the original V1.0 fields. Even if
267 * they are present in the structure, they can be optionally not used by
268 * setting them to zero. Therefore, we must selectively expand V1.0 fields
269 * if the corresponding X field is zero.
270 *
271 * For ACPI 1.0 FADTs, all address fields are expanded to the corresponding
272 * "X" fields.
273 *
274 * For ACPI 2.0 FADTs, any "X" fields that are NULL are filled in by
275 * expanding the corresponding ACPI 1.0 field.
276 *
277 ******************************************************************************/
278
71392844 279static void acpi_tb_convert_fadt(void)
95befdb3
BM
280{
281 u8 pm1_register_length;
282 struct acpi_generic_address *target;
67a119f9 283 u32 i;
95befdb3 284
ea5d8ebc
BM
285 /* Update the local FADT table header length */
286
287 acpi_gbl_FADT.header.length = sizeof(struct acpi_table_fadt);
288
289 /* Expand the 32-bit FACS and DSDT addresses to 64-bit as necessary */
95befdb3
BM
290
291 if (!acpi_gbl_FADT.Xfacs) {
292 acpi_gbl_FADT.Xfacs = (u64) acpi_gbl_FADT.facs;
293 }
294
295 if (!acpi_gbl_FADT.Xdsdt) {
296 acpi_gbl_FADT.Xdsdt = (u64) acpi_gbl_FADT.dsdt;
297 }
298
299 /*
55f8f3cc
BM
300 * For ACPI 1.0 FADTs (revision 1 or 2), ensure that reserved fields which
301 * should be zero are indeed zero. This will workaround BIOSs that
302 * inadvertently place values in these fields.
303 *
304 * The ACPI 1.0 reserved fields that will be zeroed are the bytes located at
305 * offset 45, 55, 95, and the word located at offset 109, 110.
306 */
14a63ba8 307 if (acpi_gbl_FADT.header.revision < FADT2_REVISION_ID) {
55f8f3cc
BM
308 acpi_gbl_FADT.preferred_profile = 0;
309 acpi_gbl_FADT.pstate_control = 0;
310 acpi_gbl_FADT.cst_control = 0;
311 acpi_gbl_FADT.boot_flags = 0;
312 }
313
314 /*
315 * Expand the ACPI 1.0 32-bit V1.0 addresses to the ACPI 2.0 64-bit "X"
316 * generic address structures as necessary.
95befdb3 317 */
ea5d8ebc 318 for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++) {
95befdb3
BM
319 target =
320 ACPI_ADD_PTR(struct acpi_generic_address, &acpi_gbl_FADT,
ea5d8ebc 321 fadt_info_table[i].target);
95befdb3
BM
322
323 /* Expand only if the X target is null */
324
325 if (!target->address) {
326 acpi_tb_init_generic_address(target,
327 *ACPI_ADD_PTR(u8,
328 &acpi_gbl_FADT,
ea5d8ebc 329 fadt_info_table
95befdb3
BM
330 [i].length),
331 (u64) * ACPI_ADD_PTR(u32,
332 &acpi_gbl_FADT,
ea5d8ebc 333 fadt_info_table
95befdb3
BM
334 [i].
335 source));
336 }
337 }
338
339 /*
340 * Calculate separate GAS structs for the PM1 Enable registers.
341 * These addresses do not appear (directly) in the FADT, so it is
342 * useful to calculate them once, here.
343 *
344 * The PM event blocks are split into two register blocks, first is the
fcea94ba
JB
345 * PM Status Register block, followed immediately by the PM Enable
346 * Register block. Each is of length (xpm1x_event_block.bit_width/2).
347 *
348 * On various systems the v2 fields (and particularly the bit widths)
349 * cannot be relied upon, though. Hence resort to using the v1 length
350 * here (and warn about the inconsistency).
95befdb3 351 */
fcea94ba
JB
352 if (acpi_gbl_FADT.xpm1a_event_block.bit_width
353 != acpi_gbl_FADT.pm1_event_length * 8)
354 printk(KERN_WARNING "FADT: "
355 "X_PM1a_EVT_BLK.bit_width (%u) does not match"
356 " PM1_EVT_LEN (%u)\n",
357 acpi_gbl_FADT.xpm1a_event_block.bit_width,
358 acpi_gbl_FADT.pm1_event_length);
b1d77fae 359 pm1_register_length = (u8) ACPI_DIV_2(acpi_gbl_FADT.pm1_event_length);
95befdb3 360
ea5d8ebc 361 /* The PM1A register block is required */
95befdb3
BM
362
363 acpi_tb_init_generic_address(&acpi_gbl_xpm1a_enable,
364 pm1_register_length,
365 (acpi_gbl_FADT.xpm1a_event_block.address +
366 pm1_register_length));
45eded87 367 /* Don't forget to copy space_id of the GAS */
fd350943
LB
368 acpi_gbl_xpm1a_enable.space_id =
369 acpi_gbl_FADT.xpm1a_event_block.space_id;
95befdb3 370
ea5d8ebc 371 /* The PM1B register block is optional, ignore if not present */
95befdb3
BM
372
373 if (acpi_gbl_FADT.xpm1b_event_block.address) {
fcea94ba
JB
374 if (acpi_gbl_FADT.xpm1b_event_block.bit_width
375 != acpi_gbl_FADT.pm1_event_length * 8)
376 printk(KERN_WARNING "FADT: "
377 "X_PM1b_EVT_BLK.bit_width (%u) does not match"
378 " PM1_EVT_LEN (%u)\n",
379 acpi_gbl_FADT.xpm1b_event_block.bit_width,
380 acpi_gbl_FADT.pm1_event_length);
95befdb3
BM
381 acpi_tb_init_generic_address(&acpi_gbl_xpm1b_enable,
382 pm1_register_length,
383 (acpi_gbl_FADT.xpm1b_event_block.
384 address + pm1_register_length));
45eded87 385 /* Don't forget to copy space_id of the GAS */
fd350943 386 acpi_gbl_xpm1b_enable.space_id =
fcea94ba 387 acpi_gbl_FADT.xpm1b_event_block.space_id;
b1d77fae 388
95befdb3 389 }
95befdb3
BM
390}
391
392/******************************************************************************
393 *
394 * FUNCTION: acpi_tb_validate_fadt
395 *
ea5d8ebc 396 * PARAMETERS: Table - Pointer to the FADT to be validated
95befdb3 397 *
e56b638b 398 * RETURN: None
95befdb3 399 *
ea5d8ebc
BM
400 * DESCRIPTION: Validate various important fields within the FADT. If a problem
401 * is found, issue a message, but no status is returned.
402 * Used by both the table manager and the disassembler.
403 *
404 * Possible additional checks:
405 * (acpi_gbl_FADT.pm1_event_length >= 4)
406 * (acpi_gbl_FADT.pm1_control_length >= 2)
407 * (acpi_gbl_FADT.pm_timer_length >= 4)
408 * Gpe block lengths must be multiple of 2
95befdb3
BM
409 *
410 ******************************************************************************/
411
71392844 412static void acpi_tb_validate_fadt(void)
95befdb3 413{
ea5d8ebc
BM
414 u32 *address32;
415 struct acpi_generic_address *address64;
416 u8 length;
67a119f9 417 u32 i;
95befdb3 418
ea5d8ebc
BM
419 /* Examine all of the 64-bit extended address fields (X fields) */
420
421 for (i = 0; i < ACPI_FADT_INFO_ENTRIES; i++) {
422
423 /* Generate pointers to the 32-bit and 64-bit addresses and get the length */
424
425 address64 =
71392844 426 ACPI_ADD_PTR(struct acpi_generic_address, &acpi_gbl_FADT,
ea5d8ebc 427 fadt_info_table[i].target);
71392844
BM
428 address32 =
429 ACPI_ADD_PTR(u32, &acpi_gbl_FADT,
430 fadt_info_table[i].source);
431 length =
432 *ACPI_ADD_PTR(u8, &acpi_gbl_FADT,
433 fadt_info_table[i].length);
ea5d8ebc
BM
434
435 if (fadt_info_table[i].type & ACPI_FADT_REQUIRED) {
436 /*
437 * Field is required (Pm1a_event, Pm1a_control, pm_timer).
438 * Both the address and length must be non-zero.
439 */
440 if (!address64->address || !length) {
441 ACPI_ERROR((AE_INFO,
442 "Required field \"%s\" has zero address and/or length: %8.8X%8.8X/%X",
443 fadt_info_table[i].name,
444 ACPI_FORMAT_UINT64(address64->
445 address),
446 length));
447 }
448 } else if (fadt_info_table[i].type & ACPI_FADT_SEPARATE_LENGTH) {
449 /*
450 * Field is optional (PM2Control, GPE0, GPE1) AND has its own
451 * length field. If present, both the address and length must be valid.
452 */
453 if ((address64->address && !length)
454 || (!address64->address && length)) {
455 ACPI_WARNING((AE_INFO,
456 "Optional field \"%s\" has zero address or length: %8.8X%8.8X/%X",
457 fadt_info_table[i].name,
458 ACPI_FORMAT_UINT64(address64->
459 address),
460 length));
461 }
462 }
95befdb3 463
ea5d8ebc 464 /* If both 32- and 64-bit addresses are valid (non-zero), they must match */
95befdb3 465
ea5d8ebc
BM
466 if (address64->address && *address32 &&
467 (address64->address != (u64) * address32)) {
468 ACPI_ERROR((AE_INFO,
469 "32/64X address mismatch in \"%s\": [%8.8X] [%8.8X%8.8X], using 64X",
470 fadt_info_table[i].name, *address32,
471 ACPI_FORMAT_UINT64(address64->address)));
472 }
95befdb3
BM
473 }
474}