blob: 209a401801e3aba9ad3715247c9efe0cc58ca59c [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/******************************************************************************
2 *
3 * Module Name: tbutils - Table manipulation utilities
4 *
5 *****************************************************************************/
6
7/*
Bob Moore4a90c7e2006-01-13 16:22:00 -05008 * Copyright (C) 2000 - 2006, R. Byron Moore
Linus Torvalds1da177e2005-04-16 15:20:36 -07009 * 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
Linus Torvalds1da177e2005-04-16 15:20:36 -070044#include <acpi/acpi.h>
45#include <acpi/actables.h>
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define _COMPONENT ACPI_TABLES
Len Brown4be44fc2005-08-05 00:44:28 -040048ACPI_MODULE_NAME("tbutils")
Linus Torvalds1da177e2005-04-16 15:20:36 -070049
Robert Moore44f6c012005-04-18 22:49:35 -040050/* Local prototypes */
Robert Moore44f6c012005-04-18 22:49:35 -040051#ifdef ACPI_OBSOLETE_FUNCTIONS
Linus Torvalds1da177e2005-04-16 15:20:36 -070052acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -040053acpi_tb_handle_to_object(u16 table_id, struct acpi_table_desc **table_desc);
Robert Moore44f6c012005-04-18 22:49:35 -040054#endif
Linus Torvalds1da177e2005-04-16 15:20:36 -070055
Linus Torvalds1da177e2005-04-16 15:20:36 -070056/*******************************************************************************
57 *
Robert Moore0c9938c2005-07-29 15:15:00 -070058 * FUNCTION: acpi_tb_is_table_installed
59 *
60 * PARAMETERS: new_table_desc - Descriptor for new table being installed
61 *
62 * RETURN: Status - AE_ALREADY_EXISTS if the table is already installed
63 *
64 * DESCRIPTION: Determine if an ACPI table is already installed
65 *
66 * MUTEX: Table data structures should be locked
67 *
68 ******************************************************************************/
69
Len Brown4be44fc2005-08-05 00:44:28 -040070acpi_status acpi_tb_is_table_installed(struct acpi_table_desc *new_table_desc)
Robert Moore0c9938c2005-07-29 15:15:00 -070071{
Len Brown4be44fc2005-08-05 00:44:28 -040072 struct acpi_table_desc *table_desc;
Robert Moore0c9938c2005-07-29 15:15:00 -070073
Bob Mooreb229cf92006-04-21 17:15:00 -040074 ACPI_FUNCTION_TRACE(tb_is_table_installed);
Robert Moore0c9938c2005-07-29 15:15:00 -070075
76 /* Get the list descriptor and first table descriptor */
77
78 table_desc = acpi_gbl_table_lists[new_table_desc->type].next;
79
80 /* Examine all installed tables of this type */
81
82 while (table_desc) {
Bob Moorea18ecf42005-08-15 03:42:00 -080083 /*
84 * If the table lengths match, perform a full bytewise compare. This
85 * means that we will allow tables with duplicate oem_table_id(s), as
86 * long as the tables are different in some way.
87 *
88 * Checking if the table has been loaded into the namespace means that
89 * we don't check for duplicate tables during the initial installation
90 * of tables within the RSDT/XSDT.
91 */
Robert Moore0c9938c2005-07-29 15:15:00 -070092 if ((table_desc->loaded_into_namespace) &&
Bob Moorea18ecf42005-08-15 03:42:00 -080093 (table_desc->pointer->length ==
94 new_table_desc->pointer->length)
95 &&
96 (!ACPI_MEMCMP
Bob Moore08978312005-10-21 00:00:00 -040097 (table_desc->pointer, new_table_desc->pointer,
98 new_table_desc->pointer->length))) {
Bob Moore52fc0b02006-10-02 00:00:00 -040099
Bob Moorea18ecf42005-08-15 03:42:00 -0800100 /* Match: this table is already installed */
Robert Moore0c9938c2005-07-29 15:15:00 -0700101
Len Brown4be44fc2005-08-05 00:44:28 -0400102 ACPI_DEBUG_PRINT((ACPI_DB_TABLES,
Bob Mooreb229cf92006-04-21 17:15:00 -0400103 "Table [%4.4s] already installed: Rev %X OemTableId [%8.8s]\n",
Len Brown4be44fc2005-08-05 00:44:28 -0400104 new_table_desc->pointer->signature,
105 new_table_desc->pointer->revision,
106 new_table_desc->pointer->
107 oem_table_id));
Robert Moore0c9938c2005-07-29 15:15:00 -0700108
Len Brown4be44fc2005-08-05 00:44:28 -0400109 new_table_desc->owner_id = table_desc->owner_id;
Robert Moore0c9938c2005-07-29 15:15:00 -0700110 new_table_desc->installed_desc = table_desc;
111
Len Brown4be44fc2005-08-05 00:44:28 -0400112 return_ACPI_STATUS(AE_ALREADY_EXISTS);
Robert Moore0c9938c2005-07-29 15:15:00 -0700113 }
114
115 /* Get next table on the list */
116
117 table_desc = table_desc->next;
118 }
119
Len Brown4be44fc2005-08-05 00:44:28 -0400120 return_ACPI_STATUS(AE_OK);
Robert Moore0c9938c2005-07-29 15:15:00 -0700121}
122
Robert Moore0c9938c2005-07-29 15:15:00 -0700123/*******************************************************************************
124 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 * FUNCTION: acpi_tb_validate_table_header
126 *
127 * PARAMETERS: table_header - Logical pointer to the table
128 *
129 * RETURN: Status
130 *
131 * DESCRIPTION: Check an ACPI table header for validity
132 *
133 * NOTE: Table pointers are validated as follows:
134 * 1) Table pointer must point to valid physical memory
135 * 2) Signature must be 4 ASCII chars, even if we don't recognize the
136 * name
137 * 3) Table must be readable for length specified in the header
138 * 4) Table checksum must be valid (with the exception of the FACS
139 * which has no checksum because it contains variable fields)
140 *
141 ******************************************************************************/
142
143acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400144acpi_tb_validate_table_header(struct acpi_table_header *table_header)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700145{
Len Brown4be44fc2005-08-05 00:44:28 -0400146 acpi_name signature;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147
Bob Moore4a90c7e2006-01-13 16:22:00 -0500148 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149
150 /* Verify that this is a valid address */
151
Len Brown4be44fc2005-08-05 00:44:28 -0400152 if (!acpi_os_readable(table_header, sizeof(struct acpi_table_header))) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500153 ACPI_ERROR((AE_INFO,
154 "Cannot read table header at %p", table_header));
Robert Moore44f6c012005-04-18 22:49:35 -0400155
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 return (AE_BAD_ADDRESS);
157 }
158
159 /* Ensure that the signature is 4 ASCII characters */
160
Len Brown4be44fc2005-08-05 00:44:28 -0400161 ACPI_MOVE_32_TO_32(&signature, table_header->signature);
162 if (!acpi_ut_valid_acpi_name(signature)) {
Bob Moore4c90ece2006-06-08 16:29:00 -0400163 ACPI_ERROR((AE_INFO, "Invalid table signature 0x%8.8X",
164 signature));
Robert Moore44f6c012005-04-18 22:49:35 -0400165
Len Brown4be44fc2005-08-05 00:44:28 -0400166 ACPI_DUMP_BUFFER(table_header,
167 sizeof(struct acpi_table_header));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700168 return (AE_BAD_SIGNATURE);
169 }
170
171 /* Validate the table length */
172
Len Brown4be44fc2005-08-05 00:44:28 -0400173 if (table_header->length < sizeof(struct acpi_table_header)) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500174 ACPI_ERROR((AE_INFO,
Bob Moore4c90ece2006-06-08 16:29:00 -0400175 "Invalid length 0x%X in table with signature %4.4s",
176 (u32) table_header->length,
177 ACPI_CAST_PTR(char, &signature)));
Robert Moore44f6c012005-04-18 22:49:35 -0400178
Len Brown4be44fc2005-08-05 00:44:28 -0400179 ACPI_DUMP_BUFFER(table_header,
180 sizeof(struct acpi_table_header));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181 return (AE_BAD_HEADER);
182 }
183
184 return (AE_OK);
185}
186
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187/*******************************************************************************
188 *
Bob Moore793c2382006-03-31 00:00:00 -0500189 * FUNCTION: acpi_tb_sum_table
Linus Torvalds1da177e2005-04-16 15:20:36 -0700190 *
Bob Moore793c2382006-03-31 00:00:00 -0500191 * PARAMETERS: Buffer - Buffer to sum
192 * Length - Size of the buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700193 *
Bob Moore793c2382006-03-31 00:00:00 -0500194 * RETURN: 8 bit sum of buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 *
Bob Moore793c2382006-03-31 00:00:00 -0500196 * DESCRIPTION: Computes an 8 bit sum of the buffer(length) and returns it.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 *
198 ******************************************************************************/
199
Bob Moore793c2382006-03-31 00:00:00 -0500200u8 acpi_tb_sum_table(void *buffer, u32 length)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700201{
Bob Moore793c2382006-03-31 00:00:00 -0500202 acpi_native_uint i;
203 u8 sum = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204
Bob Moore793c2382006-03-31 00:00:00 -0500205 if (!buffer || !length) {
206 return (0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700207 }
Bob Moore793c2382006-03-31 00:00:00 -0500208
209 for (i = 0; i < length; i++) {
210 sum = (u8) (sum + ((u8 *) buffer)[i]);
211 }
212 return (sum);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700213}
214
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215/*******************************************************************************
216 *
Robert Moore0c9938c2005-07-29 15:15:00 -0700217 * FUNCTION: acpi_tb_generate_checksum
Linus Torvalds1da177e2005-04-16 15:20:36 -0700218 *
Bob Moore793c2382006-03-31 00:00:00 -0500219 * PARAMETERS: Table - Pointer to a valid ACPI table (with a
220 * standard ACPI header)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700221 *
Robert Moore44f6c012005-04-18 22:49:35 -0400222 * RETURN: 8 bit checksum of buffer
Linus Torvalds1da177e2005-04-16 15:20:36 -0700223 *
Bob Moore793c2382006-03-31 00:00:00 -0500224 * DESCRIPTION: Computes an 8 bit checksum of the table.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700225 *
226 ******************************************************************************/
227
Bob Moore793c2382006-03-31 00:00:00 -0500228u8 acpi_tb_generate_checksum(struct acpi_table_header * table)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700229{
Bob Moore793c2382006-03-31 00:00:00 -0500230 u8 checksum;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700231
Bob Moore793c2382006-03-31 00:00:00 -0500232 /* Sum the entire table as-is */
Bob Moore52fc0b02006-10-02 00:00:00 -0400233
Bob Moore793c2382006-03-31 00:00:00 -0500234 checksum = acpi_tb_sum_table(table, table->length);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700235
Bob Moore793c2382006-03-31 00:00:00 -0500236 /* Subtract off the existing checksum value in the table */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700237
Bob Moore793c2382006-03-31 00:00:00 -0500238 checksum = (u8) (checksum - table->checksum);
239
240 /* Compute the final checksum */
241
242 checksum = (u8) (0 - checksum);
243 return (checksum);
244}
245
246/*******************************************************************************
247 *
248 * FUNCTION: acpi_tb_set_checksum
249 *
250 * PARAMETERS: Table - Pointer to a valid ACPI table (with a
251 * standard ACPI header)
252 *
253 * RETURN: None. Sets the table checksum field
254 *
255 * DESCRIPTION: Computes an 8 bit checksum of the table and inserts the
256 * checksum into the table header.
257 *
258 ******************************************************************************/
259
260void acpi_tb_set_checksum(struct acpi_table_header *table)
261{
262
263 table->checksum = acpi_tb_generate_checksum(table);
264}
265
266/*******************************************************************************
267 *
268 * FUNCTION: acpi_tb_verify_table_checksum
269 *
270 * PARAMETERS: *table_header - ACPI table to verify
271 *
272 * RETURN: 8 bit checksum of table
273 *
274 * DESCRIPTION: Generates an 8 bit checksum of table and returns and compares
275 * it to the existing checksum value.
276 *
277 ******************************************************************************/
278
279acpi_status
280acpi_tb_verify_table_checksum(struct acpi_table_header *table_header)
281{
282 u8 checksum;
283
Bob Mooreb229cf92006-04-21 17:15:00 -0400284 ACPI_FUNCTION_TRACE(tb_verify_table_checksum);
Bob Moore793c2382006-03-31 00:00:00 -0500285
286 /* Compute the checksum on the table */
287
288 checksum = acpi_tb_generate_checksum(table_header);
289
290 /* Checksum ok? */
291
292 if (checksum == table_header->checksum) {
293 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700294 }
Bob Moore793c2382006-03-31 00:00:00 -0500295
296 ACPI_WARNING((AE_INFO,
297 "Incorrect checksum in table [%4.4s] - is %2.2X, should be %2.2X",
298 table_header->signature, table_header->checksum,
299 checksum));
300
301 return_ACPI_STATUS(AE_BAD_CHECKSUM);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700302}
303
Robert Moore44f6c012005-04-18 22:49:35 -0400304#ifdef ACPI_OBSOLETE_FUNCTIONS
305/*******************************************************************************
306 *
307 * FUNCTION: acpi_tb_handle_to_object
308 *
309 * PARAMETERS: table_id - Id for which the function is searching
310 * table_desc - Pointer to return the matching table
311 * descriptor.
312 *
313 * RETURN: Search the tables to find one with a matching table_id and
314 * return a pointer to that table descriptor.
315 *
316 ******************************************************************************/
317
318acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400319acpi_tb_handle_to_object(u16 table_id,
Bob Moore793c2382006-03-31 00:00:00 -0500320 struct acpi_table_desc **return_table_desc)
Robert Moore44f6c012005-04-18 22:49:35 -0400321{
Len Brown4be44fc2005-08-05 00:44:28 -0400322 u32 i;
323 struct acpi_table_desc *table_desc;
Robert Moore44f6c012005-04-18 22:49:35 -0400324
Bob Mooreb229cf92006-04-21 17:15:00 -0400325 ACPI_FUNCTION_NAME(tb_handle_to_object);
Robert Moore44f6c012005-04-18 22:49:35 -0400326
327 for (i = 0; i < ACPI_TABLE_MAX; i++) {
328 table_desc = acpi_gbl_table_lists[i].next;
329 while (table_desc) {
330 if (table_desc->table_id == table_id) {
331 *return_table_desc = table_desc;
332 return (AE_OK);
333 }
334
335 table_desc = table_desc->next;
336 }
337 }
338
Bob Mooreb229cf92006-04-21 17:15:00 -0400339 ACPI_ERROR((AE_INFO, "TableId=%X does not exist", table_id));
Robert Moore44f6c012005-04-18 22:49:35 -0400340 return (AE_BAD_PARAMETER);
341}
342#endif