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