blob: 4623d7e215d3e03e77a6a11c6ce1f91798c9af80 [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*******************************************************************************
2 *
3 * Module Name: utmisc - common utility procedures
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/acnamesp.h>
46
Linus Torvalds1da177e2005-04-16 15:20:36 -070047#define _COMPONENT ACPI_UTILITIES
Len Brown4be44fc2005-08-05 00:44:28 -040048ACPI_MODULE_NAME("utmisc")
Robert Moore44f6c012005-04-18 22:49:35 -040049
50/*******************************************************************************
51 *
Bob Moore793c2382006-03-31 00:00:00 -050052 * FUNCTION: acpi_ut_is_aml_table
53 *
54 * PARAMETERS: Table - An ACPI table
55 *
56 * RETURN: TRUE if table contains executable AML; FALSE otherwise
57 *
58 * DESCRIPTION: Check ACPI Signature for a table that contains AML code.
59 * Currently, these are DSDT,SSDT,PSDT. All other table types are
60 * data tables that do not contain AML code.
61 *
62 ******************************************************************************/
63u8 acpi_ut_is_aml_table(struct acpi_table_header *table)
64{
65
66 /* Ignore tables that contain AML */
67
68 if (ACPI_COMPARE_NAME(table->signature, DSDT_SIG) ||
69 ACPI_COMPARE_NAME(table->signature, PSDT_SIG) ||
70 ACPI_COMPARE_NAME(table->signature, SSDT_SIG)) {
71 return (TRUE);
72 }
73
74 return (FALSE);
75}
76
77/*******************************************************************************
78 *
Robert Mooref9f46012005-07-08 00:00:00 -040079 * FUNCTION: acpi_ut_allocate_owner_id
80 *
81 * PARAMETERS: owner_id - Where the new owner ID is returned
82 *
Robert Moore0c9938c2005-07-29 15:15:00 -070083 * RETURN: Status
84 *
85 * DESCRIPTION: Allocate a table or method owner ID. The owner ID is used to
86 * track objects created by the table or method, to be deleted
87 * when the method exits or the table is unloaded.
Robert Mooref9f46012005-07-08 00:00:00 -040088 *
89 ******************************************************************************/
Bob Moore793c2382006-03-31 00:00:00 -050090
Len Brown4be44fc2005-08-05 00:44:28 -040091acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id)
Robert Mooref9f46012005-07-08 00:00:00 -040092{
Len Brown4be44fc2005-08-05 00:44:28 -040093 acpi_native_uint i;
Bob Moorec51a4de2005-11-17 13:07:00 -050094 acpi_native_uint j;
Bob Moore28f55eb2005-12-02 18:27:00 -050095 acpi_native_uint k;
Len Brown4be44fc2005-08-05 00:44:28 -040096 acpi_status status;
Robert Mooref9f46012005-07-08 00:00:00 -040097
Len Brown4be44fc2005-08-05 00:44:28 -040098 ACPI_FUNCTION_TRACE("ut_allocate_owner_id");
Robert Mooref9f46012005-07-08 00:00:00 -040099
Robert Mooreaff8c272005-09-02 17:24:17 -0400100 /* Guard against multiple allocations of ID to the same location */
101
102 if (*owner_id) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500103 ACPI_ERROR((AE_INFO, "Owner ID [%2.2X] already exists",
104 *owner_id));
Robert Mooreaff8c272005-09-02 17:24:17 -0400105 return_ACPI_STATUS(AE_ALREADY_EXISTS);
106 }
107
Robert Moore0c9938c2005-07-29 15:15:00 -0700108 /* Mutex for the global ID mask */
109
Len Brown4be44fc2005-08-05 00:44:28 -0400110 status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
111 if (ACPI_FAILURE(status)) {
112 return_ACPI_STATUS(status);
Robert Mooref9f46012005-07-08 00:00:00 -0400113 }
114
Bob Moorec51a4de2005-11-17 13:07:00 -0500115 /*
116 * Find a free owner ID, cycle through all possible IDs on repeated
Bob Moore28f55eb2005-12-02 18:27:00 -0500117 * allocations. (ACPI_NUM_OWNERID_MASKS + 1) because first index may have
118 * to be scanned twice.
Bob Moorec51a4de2005-11-17 13:07:00 -0500119 */
Bob Moore28f55eb2005-12-02 18:27:00 -0500120 for (i = 0, j = acpi_gbl_last_owner_id_index;
121 i < (ACPI_NUM_OWNERID_MASKS + 1); i++, j++) {
122 if (j >= ACPI_NUM_OWNERID_MASKS) {
123 j = 0; /* Wraparound to start of mask array */
Bob Moorec51a4de2005-11-17 13:07:00 -0500124 }
Robert Mooref9f46012005-07-08 00:00:00 -0400125
Bob Moore28f55eb2005-12-02 18:27:00 -0500126 for (k = acpi_gbl_next_owner_id_offset; k < 32; k++) {
127 if (acpi_gbl_owner_id_mask[j] == ACPI_UINT32_MAX) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400128
Bob Moore28f55eb2005-12-02 18:27:00 -0500129 /* There are no free IDs in this mask */
Bob Moorec51a4de2005-11-17 13:07:00 -0500130
Bob Moore28f55eb2005-12-02 18:27:00 -0500131 break;
132 }
Bob Moorea18ecf42005-08-15 03:42:00 -0800133
Bob Moore28f55eb2005-12-02 18:27:00 -0500134 if (!(acpi_gbl_owner_id_mask[j] & (1 << k))) {
135 /*
136 * Found a free ID. The actual ID is the bit index plus one,
137 * making zero an invalid Owner ID. Save this as the last ID
138 * allocated and update the global ID mask.
139 */
140 acpi_gbl_owner_id_mask[j] |= (1 << k);
141
142 acpi_gbl_last_owner_id_index = (u8) j;
143 acpi_gbl_next_owner_id_offset = (u8) (k + 1);
144
145 /*
146 * Construct encoded ID from the index and bit position
147 *
148 * Note: Last [j].k (bit 255) is never used and is marked
149 * permanently allocated (prevents +1 overflow)
150 */
151 *owner_id =
152 (acpi_owner_id) ((k + 1) + ACPI_MUL_32(j));
153
154 ACPI_DEBUG_PRINT((ACPI_DB_VALUES,
155 "Allocated owner_id: %2.2X\n",
156 (unsigned int)*owner_id));
157 goto exit;
158 }
Robert Mooref9f46012005-07-08 00:00:00 -0400159 }
Bob Moore28f55eb2005-12-02 18:27:00 -0500160
161 acpi_gbl_next_owner_id_offset = 0;
Robert Mooref9f46012005-07-08 00:00:00 -0400162 }
163
164 /*
Bob Moorec51a4de2005-11-17 13:07:00 -0500165 * All owner_ids have been allocated. This typically should
Robert Mooref9f46012005-07-08 00:00:00 -0400166 * not happen since the IDs are reused after deallocation. The IDs are
167 * allocated upon table load (one per table) and method execution, and
168 * they are released when a table is unloaded or a method completes
169 * execution.
Bob Moorec51a4de2005-11-17 13:07:00 -0500170 *
171 * If this error happens, there may be very deep nesting of invoked control
172 * methods, or there may be a bug where the IDs are not released.
Robert Mooref9f46012005-07-08 00:00:00 -0400173 */
174 status = AE_OWNER_ID_LIMIT;
Bob Mooreb8e4d892006-01-27 16:43:00 -0500175 ACPI_ERROR((AE_INFO,
176 "Could not allocate new owner_id (255 max), AE_OWNER_ID_LIMIT"));
Robert Mooref9f46012005-07-08 00:00:00 -0400177
Len Brown4be44fc2005-08-05 00:44:28 -0400178 exit:
179 (void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
180 return_ACPI_STATUS(status);
Robert Mooref9f46012005-07-08 00:00:00 -0400181}
182
Robert Mooref9f46012005-07-08 00:00:00 -0400183/*******************************************************************************
184 *
185 * FUNCTION: acpi_ut_release_owner_id
186 *
Robert Moore0c9938c2005-07-29 15:15:00 -0700187 * PARAMETERS: owner_id_ptr - Pointer to a previously allocated owner_iD
Robert Mooref9f46012005-07-08 00:00:00 -0400188 *
Robert Moore0c9938c2005-07-29 15:15:00 -0700189 * RETURN: None. No error is returned because we are either exiting a
190 * control method or unloading a table. Either way, we would
191 * ignore any error anyway.
192 *
Bob Moore28f55eb2005-12-02 18:27:00 -0500193 * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 255
Robert Mooref9f46012005-07-08 00:00:00 -0400194 *
195 ******************************************************************************/
196
Len Brown4be44fc2005-08-05 00:44:28 -0400197void acpi_ut_release_owner_id(acpi_owner_id * owner_id_ptr)
Robert Mooref9f46012005-07-08 00:00:00 -0400198{
Len Brown4be44fc2005-08-05 00:44:28 -0400199 acpi_owner_id owner_id = *owner_id_ptr;
200 acpi_status status;
Bob Moore28f55eb2005-12-02 18:27:00 -0500201 acpi_native_uint index;
202 u32 bit;
Robert Mooref9f46012005-07-08 00:00:00 -0400203
Bob Moorea18ecf42005-08-15 03:42:00 -0800204 ACPI_FUNCTION_TRACE_U32("ut_release_owner_id", owner_id);
Robert Mooref9f46012005-07-08 00:00:00 -0400205
Robert Moore0c9938c2005-07-29 15:15:00 -0700206 /* Always clear the input owner_id (zero is an invalid ID) */
207
208 *owner_id_ptr = 0;
209
210 /* Zero is not a valid owner_iD */
211
Bob Mooredefba1d2005-12-16 17:05:00 -0500212 if (owner_id == 0) {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500213 ACPI_ERROR((AE_INFO, "Invalid owner_id: %2.2X", owner_id));
Robert Moore0c9938c2005-07-29 15:15:00 -0700214 return_VOID;
Robert Mooref9f46012005-07-08 00:00:00 -0400215 }
216
Robert Moore0c9938c2005-07-29 15:15:00 -0700217 /* Mutex for the global ID mask */
218
Len Brown4be44fc2005-08-05 00:44:28 -0400219 status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES);
220 if (ACPI_FAILURE(status)) {
Robert Moore0c9938c2005-07-29 15:15:00 -0700221 return_VOID;
222 }
223
Robert Mooreaff8c272005-09-02 17:24:17 -0400224 /* Normalize the ID to zero */
225
226 owner_id--;
Robert Moore0c9938c2005-07-29 15:15:00 -0700227
Bob Moore28f55eb2005-12-02 18:27:00 -0500228 /* Decode ID to index/offset pair */
229
230 index = ACPI_DIV_32(owner_id);
231 bit = 1 << ACPI_MOD_32(owner_id);
232
Robert Moore0c9938c2005-07-29 15:15:00 -0700233 /* Free the owner ID only if it is valid */
Robert Mooref9f46012005-07-08 00:00:00 -0400234
Bob Moore28f55eb2005-12-02 18:27:00 -0500235 if (acpi_gbl_owner_id_mask[index] & bit) {
236 acpi_gbl_owner_id_mask[index] ^= bit;
237 } else {
Bob Mooreb8e4d892006-01-27 16:43:00 -0500238 ACPI_ERROR((AE_INFO,
239 "Release of non-allocated owner_id: %2.2X",
240 owner_id + 1));
Robert Mooref9f46012005-07-08 00:00:00 -0400241 }
Robert Mooref9f46012005-07-08 00:00:00 -0400242
Len Brown4be44fc2005-08-05 00:44:28 -0400243 (void)acpi_ut_release_mutex(ACPI_MTX_CACHES);
Robert Moore0c9938c2005-07-29 15:15:00 -0700244 return_VOID;
Robert Mooref9f46012005-07-08 00:00:00 -0400245}
246
Robert Mooref9f46012005-07-08 00:00:00 -0400247/*******************************************************************************
248 *
Robert Moore44f6c012005-04-18 22:49:35 -0400249 * FUNCTION: acpi_ut_strupr (strupr)
250 *
251 * PARAMETERS: src_string - The source string to convert
252 *
Robert Moore0c9938c2005-07-29 15:15:00 -0700253 * RETURN: None
Robert Moore44f6c012005-04-18 22:49:35 -0400254 *
255 * DESCRIPTION: Convert string to uppercase
256 *
257 * NOTE: This is not a POSIX function, so it appears here, not in utclib.c
258 *
259 ******************************************************************************/
260
Len Brown4be44fc2005-08-05 00:44:28 -0400261void acpi_ut_strupr(char *src_string)
Robert Moore44f6c012005-04-18 22:49:35 -0400262{
Len Brown4be44fc2005-08-05 00:44:28 -0400263 char *string;
Robert Moore44f6c012005-04-18 22:49:35 -0400264
Len Brown4be44fc2005-08-05 00:44:28 -0400265 ACPI_FUNCTION_ENTRY();
Robert Moore44f6c012005-04-18 22:49:35 -0400266
Robert Moore73459f72005-06-24 00:00:00 -0400267 if (!src_string) {
Robert Moore0c9938c2005-07-29 15:15:00 -0700268 return;
Robert Moore73459f72005-06-24 00:00:00 -0400269 }
270
Robert Moore44f6c012005-04-18 22:49:35 -0400271 /* Walk entire string, uppercasing the letters */
272
273 for (string = src_string; *string; string++) {
Len Brown4be44fc2005-08-05 00:44:28 -0400274 *string = (char)ACPI_TOUPPER(*string);
Robert Moore44f6c012005-04-18 22:49:35 -0400275 }
276
Robert Moore0c9938c2005-07-29 15:15:00 -0700277 return;
Robert Moore44f6c012005-04-18 22:49:35 -0400278}
279
Linus Torvalds1da177e2005-04-16 15:20:36 -0700280/*******************************************************************************
281 *
282 * FUNCTION: acpi_ut_print_string
283 *
284 * PARAMETERS: String - Null terminated ASCII string
Robert Moore44f6c012005-04-18 22:49:35 -0400285 * max_length - Maximum output length
Linus Torvalds1da177e2005-04-16 15:20:36 -0700286 *
287 * RETURN: None
288 *
289 * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape
290 * sequences.
291 *
292 ******************************************************************************/
293
Len Brown4be44fc2005-08-05 00:44:28 -0400294void acpi_ut_print_string(char *string, u8 max_length)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700295{
Len Brown4be44fc2005-08-05 00:44:28 -0400296 u32 i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700297
298 if (!string) {
Len Brown4be44fc2005-08-05 00:44:28 -0400299 acpi_os_printf("<\"NULL STRING PTR\">");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300 return;
301 }
302
Len Brown4be44fc2005-08-05 00:44:28 -0400303 acpi_os_printf("\"");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700304 for (i = 0; string[i] && (i < max_length); i++) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400305
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 /* Escape sequences */
307
308 switch (string[i]) {
309 case 0x07:
Len Brown4be44fc2005-08-05 00:44:28 -0400310 acpi_os_printf("\\a"); /* BELL */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700311 break;
312
313 case 0x08:
Len Brown4be44fc2005-08-05 00:44:28 -0400314 acpi_os_printf("\\b"); /* BACKSPACE */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700315 break;
316
317 case 0x0C:
Len Brown4be44fc2005-08-05 00:44:28 -0400318 acpi_os_printf("\\f"); /* FORMFEED */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 break;
320
321 case 0x0A:
Len Brown4be44fc2005-08-05 00:44:28 -0400322 acpi_os_printf("\\n"); /* LINEFEED */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 break;
324
325 case 0x0D:
Len Brown4be44fc2005-08-05 00:44:28 -0400326 acpi_os_printf("\\r"); /* CARRIAGE RETURN */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 break;
328
329 case 0x09:
Len Brown4be44fc2005-08-05 00:44:28 -0400330 acpi_os_printf("\\t"); /* HORIZONTAL TAB */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700331 break;
332
333 case 0x0B:
Len Brown4be44fc2005-08-05 00:44:28 -0400334 acpi_os_printf("\\v"); /* VERTICAL TAB */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700335 break;
336
Len Brown4be44fc2005-08-05 00:44:28 -0400337 case '\'': /* Single Quote */
338 case '\"': /* Double Quote */
339 case '\\': /* Backslash */
340 acpi_os_printf("\\%c", (int)string[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700341 break;
342
343 default:
344
345 /* Check for printable character or hex escape */
346
Len Brown4be44fc2005-08-05 00:44:28 -0400347 if (ACPI_IS_PRINT(string[i])) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700348 /* This is a normal character */
349
Len Brown4be44fc2005-08-05 00:44:28 -0400350 acpi_os_printf("%c", (int)string[i]);
351 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700352 /* All others will be Hex escapes */
353
Len Brown4be44fc2005-08-05 00:44:28 -0400354 acpi_os_printf("\\x%2.2X", (s32) string[i]);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700355 }
356 break;
357 }
358 }
Len Brown4be44fc2005-08-05 00:44:28 -0400359 acpi_os_printf("\"");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700360
361 if (i == max_length && string[i]) {
Len Brown4be44fc2005-08-05 00:44:28 -0400362 acpi_os_printf("...");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700363 }
364}
365
Linus Torvalds1da177e2005-04-16 15:20:36 -0700366/*******************************************************************************
367 *
368 * FUNCTION: acpi_ut_dword_byte_swap
369 *
370 * PARAMETERS: Value - Value to be converted
371 *
Robert Moore44f6c012005-04-18 22:49:35 -0400372 * RETURN: u32 integer with bytes swapped
373 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700374 * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes)
375 *
376 ******************************************************************************/
377
Len Brown4be44fc2005-08-05 00:44:28 -0400378u32 acpi_ut_dword_byte_swap(u32 value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700379{
380 union {
Len Brown4be44fc2005-08-05 00:44:28 -0400381 u32 value;
382 u8 bytes[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700383 } out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700384 union {
Len Brown4be44fc2005-08-05 00:44:28 -0400385 u32 value;
386 u8 bytes[4];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700387 } in;
388
Len Brown4be44fc2005-08-05 00:44:28 -0400389 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700390
391 in.value = value;
392
393 out.bytes[0] = in.bytes[3];
394 out.bytes[1] = in.bytes[2];
395 out.bytes[2] = in.bytes[1];
396 out.bytes[3] = in.bytes[0];
397
398 return (out.value);
399}
400
Linus Torvalds1da177e2005-04-16 15:20:36 -0700401/*******************************************************************************
402 *
403 * FUNCTION: acpi_ut_set_integer_width
404 *
405 * PARAMETERS: Revision From DSDT header
406 *
407 * RETURN: None
408 *
409 * DESCRIPTION: Set the global integer bit width based upon the revision
410 * of the DSDT. For Revision 1 and 0, Integers are 32 bits.
411 * For Revision 2 and above, Integers are 64 bits. Yes, this
412 * makes a difference.
413 *
414 ******************************************************************************/
415
Len Brown4be44fc2005-08-05 00:44:28 -0400416void acpi_ut_set_integer_width(u8 revision)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700417{
418
419 if (revision <= 1) {
420 acpi_gbl_integer_bit_width = 32;
421 acpi_gbl_integer_nybble_width = 8;
422 acpi_gbl_integer_byte_width = 4;
Len Brown4be44fc2005-08-05 00:44:28 -0400423 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700424 acpi_gbl_integer_bit_width = 64;
425 acpi_gbl_integer_nybble_width = 16;
426 acpi_gbl_integer_byte_width = 8;
427 }
428}
429
Linus Torvalds1da177e2005-04-16 15:20:36 -0700430#ifdef ACPI_DEBUG_OUTPUT
431/*******************************************************************************
432 *
433 * FUNCTION: acpi_ut_display_init_pathname
434 *
Robert Moore44f6c012005-04-18 22:49:35 -0400435 * PARAMETERS: Type - Object type of the node
436 * obj_handle - Handle whose pathname will be displayed
Linus Torvalds1da177e2005-04-16 15:20:36 -0700437 * Path - Additional path string to be appended.
438 * (NULL if no extra path)
439 *
440 * RETURN: acpi_status
441 *
442 * DESCRIPTION: Display full pathname of an object, DEBUG ONLY
443 *
444 ******************************************************************************/
445
446void
Len Brown4be44fc2005-08-05 00:44:28 -0400447acpi_ut_display_init_pathname(u8 type,
448 struct acpi_namespace_node *obj_handle,
449 char *path)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700450{
Len Brown4be44fc2005-08-05 00:44:28 -0400451 acpi_status status;
452 struct acpi_buffer buffer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
Len Brown4be44fc2005-08-05 00:44:28 -0400454 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700455
456 /* Only print the path if the appropriate debug level is enabled */
457
458 if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) {
459 return;
460 }
461
462 /* Get the full pathname to the node */
463
464 buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
Len Brown4be44fc2005-08-05 00:44:28 -0400465 status = acpi_ns_handle_to_pathname(obj_handle, &buffer);
466 if (ACPI_FAILURE(status)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 return;
468 }
469
470 /* Print what we're doing */
471
472 switch (type) {
473 case ACPI_TYPE_METHOD:
Len Brown4be44fc2005-08-05 00:44:28 -0400474 acpi_os_printf("Executing ");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700475 break;
476
477 default:
Len Brown4be44fc2005-08-05 00:44:28 -0400478 acpi_os_printf("Initializing ");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700479 break;
480 }
481
482 /* Print the object type and pathname */
483
Len Brown4be44fc2005-08-05 00:44:28 -0400484 acpi_os_printf("%-12s %s",
485 acpi_ut_get_type_name(type), (char *)buffer.pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486
487 /* Extra path is used to append names like _STA, _INI, etc. */
488
489 if (path) {
Len Brown4be44fc2005-08-05 00:44:28 -0400490 acpi_os_printf(".%s", path);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700491 }
Len Brown4be44fc2005-08-05 00:44:28 -0400492 acpi_os_printf("\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700493
Bob Moore83135242006-10-03 00:00:00 -0400494 ACPI_FREE(buffer.pointer);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700495}
496#endif
497
Linus Torvalds1da177e2005-04-16 15:20:36 -0700498/*******************************************************************************
499 *
Bob Moore793c2382006-03-31 00:00:00 -0500500 * FUNCTION: acpi_ut_valid_acpi_char
501 *
502 * PARAMETERS: Char - The character to be examined
503 *
504 * RETURN: TRUE if the character is valid, FALSE otherwise
505 *
506 * DESCRIPTION: Check for a valid ACPI character. Must be one of:
507 * 1) Upper case alpha
508 * 2) numeric
509 * 3) underscore
510 *
511 * We allow a '!' as the last character because of the ASF! table
512 *
513 ******************************************************************************/
514
515u8 acpi_ut_valid_acpi_char(char character, acpi_native_uint position)
516{
517
518 if (!((character >= 'A' && character <= 'Z') ||
519 (character >= '0' && character <= '9') || (character == '_'))) {
520
521 /* Allow a '!' in the last position */
522
523 if (character == '!' && position == 3) {
524 return (TRUE);
525 }
526
527 return (FALSE);
528 }
529
530 return (TRUE);
531}
532
533/*******************************************************************************
534 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700535 * FUNCTION: acpi_ut_valid_acpi_name
536 *
Robert Moore44f6c012005-04-18 22:49:35 -0400537 * PARAMETERS: Name - The name to be examined
Linus Torvalds1da177e2005-04-16 15:20:36 -0700538 *
Robert Moore44f6c012005-04-18 22:49:35 -0400539 * RETURN: TRUE if the name is valid, FALSE otherwise
Linus Torvalds1da177e2005-04-16 15:20:36 -0700540 *
541 * DESCRIPTION: Check for a valid ACPI name. Each character must be one of:
542 * 1) Upper case alpha
543 * 2) numeric
544 * 3) underscore
545 *
546 ******************************************************************************/
547
Len Brown4be44fc2005-08-05 00:44:28 -0400548u8 acpi_ut_valid_acpi_name(u32 name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700549{
Len Brown4be44fc2005-08-05 00:44:28 -0400550 acpi_native_uint i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
Len Brown4be44fc2005-08-05 00:44:28 -0400552 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700553
554 for (i = 0; i < ACPI_NAME_SIZE; i++) {
Bob Moore793c2382006-03-31 00:00:00 -0500555 if (!acpi_ut_valid_acpi_char
556 ((ACPI_CAST_PTR(char, &name))[i], i)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557 return (FALSE);
558 }
559 }
560
561 return (TRUE);
562}
563
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564/*******************************************************************************
565 *
Bob Moore793c2382006-03-31 00:00:00 -0500566 * FUNCTION: acpi_ut_repair_name
Linus Torvalds1da177e2005-04-16 15:20:36 -0700567 *
Bob Moore793c2382006-03-31 00:00:00 -0500568 * PARAMETERS: Name - The ACPI name to be repaired
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569 *
Bob Moore793c2382006-03-31 00:00:00 -0500570 * RETURN: Repaired version of the name
Linus Torvalds1da177e2005-04-16 15:20:36 -0700571 *
Bob Moore793c2382006-03-31 00:00:00 -0500572 * DESCRIPTION: Repair an ACPI name: Change invalid characters to '*' and
573 * return the new name.
Linus Torvalds1da177e2005-04-16 15:20:36 -0700574 *
575 ******************************************************************************/
576
Bob Moore793c2382006-03-31 00:00:00 -0500577acpi_name acpi_ut_repair_name(acpi_name name)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
Bob Moore793c2382006-03-31 00:00:00 -0500579 char *name_ptr = ACPI_CAST_PTR(char, &name);
580 char new_name[ACPI_NAME_SIZE];
581 acpi_native_uint i;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700582
Bob Moore793c2382006-03-31 00:00:00 -0500583 for (i = 0; i < ACPI_NAME_SIZE; i++) {
584 new_name[i] = name_ptr[i];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700585
Bob Moore793c2382006-03-31 00:00:00 -0500586 /*
587 * Replace a bad character with something printable, yet technically
588 * still invalid. This prevents any collisions with existing "good"
589 * names in the namespace.
590 */
591 if (!acpi_ut_valid_acpi_char(name_ptr[i], i)) {
592 new_name[i] = '*';
593 }
594 }
595
596 return (*ACPI_CAST_PTR(u32, new_name));
Linus Torvalds1da177e2005-04-16 15:20:36 -0700597}
598
Linus Torvalds1da177e2005-04-16 15:20:36 -0700599/*******************************************************************************
600 *
601 * FUNCTION: acpi_ut_strtoul64
602 *
603 * PARAMETERS: String - Null terminated string
604 * Base - Radix of the string: 10, 16, or ACPI_ANY_BASE
605 * ret_integer - Where the converted integer is returned
606 *
607 * RETURN: Status and Converted value
608 *
609 * DESCRIPTION: Convert a string into an unsigned value.
610 * NOTE: Does not support Octal strings, not needed.
611 *
612 ******************************************************************************/
613
614acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400615acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700616{
Len Brown4be44fc2005-08-05 00:44:28 -0400617 u32 this_digit = 0;
618 acpi_integer return_value = 0;
619 acpi_integer quotient;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700620
Len Brown4be44fc2005-08-05 00:44:28 -0400621 ACPI_FUNCTION_TRACE("ut_stroul64");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700622
623 if ((!string) || !(*string)) {
624 goto error_exit;
625 }
626
627 switch (base) {
628 case ACPI_ANY_BASE:
629 case 10:
630 case 16:
631 break;
632
633 default:
634 /* Invalid Base */
Len Brown4be44fc2005-08-05 00:44:28 -0400635 return_ACPI_STATUS(AE_BAD_PARAMETER);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 }
637
638 /* Skip over any white space in the buffer */
639
Len Brown4be44fc2005-08-05 00:44:28 -0400640 while (ACPI_IS_SPACE(*string) || *string == '\t') {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700641 string++;
642 }
643
644 /*
645 * If the input parameter Base is zero, then we need to
646 * determine if it is decimal or hexadecimal:
647 */
648 if (base == 0) {
Len Brown4be44fc2005-08-05 00:44:28 -0400649 if ((*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650 base = 16;
651 string += 2;
Len Brown4be44fc2005-08-05 00:44:28 -0400652 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700653 base = 10;
654 }
655 }
656
657 /*
658 * For hexadecimal base, skip over the leading
659 * 0 or 0x, if they are present.
660 */
661 if ((base == 16) &&
Len Brown4be44fc2005-08-05 00:44:28 -0400662 (*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700663 string += 2;
664 }
665
666 /* Any string left? */
667
668 if (!(*string)) {
669 goto error_exit;
670 }
671
672 /* Main loop: convert the string to a 64-bit integer */
673
674 while (*string) {
Len Brown4be44fc2005-08-05 00:44:28 -0400675 if (ACPI_IS_DIGIT(*string)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400676
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 /* Convert ASCII 0-9 to Decimal value */
678
Len Brown4be44fc2005-08-05 00:44:28 -0400679 this_digit = ((u8) * string) - '0';
680 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 if (base == 10) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400682
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 /* Digit is out of range */
684
685 goto error_exit;
686 }
687
Len Brown4be44fc2005-08-05 00:44:28 -0400688 this_digit = (u8) ACPI_TOUPPER(*string);
689 if (ACPI_IS_XDIGIT((char)this_digit)) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400690
Linus Torvalds1da177e2005-04-16 15:20:36 -0700691 /* Convert ASCII Hex char to value */
692
693 this_digit = this_digit - 'A' + 10;
Len Brown4be44fc2005-08-05 00:44:28 -0400694 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 /*
696 * We allow non-hex chars, just stop now, same as end-of-string.
697 * See ACPI spec, string-to-integer conversion.
698 */
699 break;
700 }
701 }
702
703 /* Divide the digit into the correct position */
704
Len Brown4be44fc2005-08-05 00:44:28 -0400705 (void)
706 acpi_ut_short_divide((ACPI_INTEGER_MAX -
707 (acpi_integer) this_digit), base,
708 &quotient, NULL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700709 if (return_value > quotient) {
710 goto error_exit;
711 }
712
713 return_value *= base;
714 return_value += this_digit;
715 string++;
716 }
717
718 /* All done, normal exit */
719
720 *ret_integer = return_value;
Len Brown4be44fc2005-08-05 00:44:28 -0400721 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722
Len Brown4be44fc2005-08-05 00:44:28 -0400723 error_exit:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 /* Base was set/validated above */
725
726 if (base == 10) {
Len Brown4be44fc2005-08-05 00:44:28 -0400727 return_ACPI_STATUS(AE_BAD_DECIMAL_CONSTANT);
728 } else {
729 return_ACPI_STATUS(AE_BAD_HEX_CONSTANT);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700730 }
731}
732
Linus Torvalds1da177e2005-04-16 15:20:36 -0700733/*******************************************************************************
734 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700735 * FUNCTION: acpi_ut_create_update_state_and_push
736 *
Robert Moore44f6c012005-04-18 22:49:35 -0400737 * PARAMETERS: Object - Object to be added to the new state
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 * Action - Increment/Decrement
739 * state_list - List the state will be added to
740 *
Robert Moore44f6c012005-04-18 22:49:35 -0400741 * RETURN: Status
Linus Torvalds1da177e2005-04-16 15:20:36 -0700742 *
743 * DESCRIPTION: Create a new state and push it
744 *
745 ******************************************************************************/
746
747acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400748acpi_ut_create_update_state_and_push(union acpi_operand_object *object,
749 u16 action,
750 union acpi_generic_state **state_list)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751{
Len Brown4be44fc2005-08-05 00:44:28 -0400752 union acpi_generic_state *state;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700753
Len Brown4be44fc2005-08-05 00:44:28 -0400754 ACPI_FUNCTION_ENTRY();
Linus Torvalds1da177e2005-04-16 15:20:36 -0700755
756 /* Ignore null objects; these are expected */
757
758 if (!object) {
759 return (AE_OK);
760 }
761
Len Brown4be44fc2005-08-05 00:44:28 -0400762 state = acpi_ut_create_update_state(object, action);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 if (!state) {
764 return (AE_NO_MEMORY);
765 }
766
Len Brown4be44fc2005-08-05 00:44:28 -0400767 acpi_ut_push_generic_state(state_list, state);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700768 return (AE_OK);
769}
770
Linus Torvalds1da177e2005-04-16 15:20:36 -0700771/*******************************************************************************
772 *
Linus Torvalds1da177e2005-04-16 15:20:36 -0700773 * FUNCTION: acpi_ut_walk_package_tree
774 *
Robert Moore44f6c012005-04-18 22:49:35 -0400775 * PARAMETERS: source_object - The package to walk
776 * target_object - Target object (if package is being copied)
777 * walk_callback - Called once for each package element
778 * Context - Passed to the callback function
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 *
780 * RETURN: Status
781 *
782 * DESCRIPTION: Walk through a package
783 *
784 ******************************************************************************/
785
786acpi_status
Len Brown4be44fc2005-08-05 00:44:28 -0400787acpi_ut_walk_package_tree(union acpi_operand_object * source_object,
788 void *target_object,
789 acpi_pkg_callback walk_callback, void *context)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700790{
Len Brown4be44fc2005-08-05 00:44:28 -0400791 acpi_status status = AE_OK;
792 union acpi_generic_state *state_list = NULL;
793 union acpi_generic_state *state;
794 u32 this_index;
795 union acpi_operand_object *this_source_obj;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796
Len Brown4be44fc2005-08-05 00:44:28 -0400797 ACPI_FUNCTION_TRACE("ut_walk_package_tree");
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798
Len Brown4be44fc2005-08-05 00:44:28 -0400799 state = acpi_ut_create_pkg_state(source_object, target_object, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700800 if (!state) {
Len Brown4be44fc2005-08-05 00:44:28 -0400801 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700802 }
803
804 while (state) {
Bob Moore52fc0b02006-10-02 00:00:00 -0400805
Linus Torvalds1da177e2005-04-16 15:20:36 -0700806 /* Get one element of the package */
807
Len Brown4be44fc2005-08-05 00:44:28 -0400808 this_index = state->pkg.index;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700809 this_source_obj = (union acpi_operand_object *)
Len Brown4be44fc2005-08-05 00:44:28 -0400810 state->pkg.source_object->package.elements[this_index];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700811
812 /*
813 * Check for:
814 * 1) An uninitialized package element. It is completely
815 * legal to declare a package and leave it uninitialized
816 * 2) Not an internal object - can be a namespace node instead
817 * 3) Any type other than a package. Packages are handled in else
818 * case below.
819 */
820 if ((!this_source_obj) ||
Len Brown4be44fc2005-08-05 00:44:28 -0400821 (ACPI_GET_DESCRIPTOR_TYPE(this_source_obj) !=
822 ACPI_DESC_TYPE_OPERAND)
823 || (ACPI_GET_OBJECT_TYPE(this_source_obj) !=
824 ACPI_TYPE_PACKAGE)) {
825 status =
826 walk_callback(ACPI_COPY_TYPE_SIMPLE,
827 this_source_obj, state, context);
828 if (ACPI_FAILURE(status)) {
829 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830 }
831
832 state->pkg.index++;
Len Brown4be44fc2005-08-05 00:44:28 -0400833 while (state->pkg.index >=
834 state->pkg.source_object->package.count) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835 /*
836 * We've handled all of the objects at this level, This means
837 * that we have just completed a package. That package may
838 * have contained one or more packages itself.
839 *
840 * Delete this state and pop the previous state (package).
841 */
Len Brown4be44fc2005-08-05 00:44:28 -0400842 acpi_ut_delete_generic_state(state);
843 state = acpi_ut_pop_generic_state(&state_list);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700844
845 /* Finished when there are no more states */
846
847 if (!state) {
848 /*
849 * We have handled all of the objects in the top level
850 * package just add the length of the package objects
851 * and exit
852 */
Len Brown4be44fc2005-08-05 00:44:28 -0400853 return_ACPI_STATUS(AE_OK);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700854 }
855
856 /*
857 * Go back up a level and move the index past the just
858 * completed package object.
859 */
860 state->pkg.index++;
861 }
Len Brown4be44fc2005-08-05 00:44:28 -0400862 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700863 /* This is a subobject of type package */
864
Len Brown4be44fc2005-08-05 00:44:28 -0400865 status =
866 walk_callback(ACPI_COPY_TYPE_PACKAGE,
867 this_source_obj, state, context);
868 if (ACPI_FAILURE(status)) {
869 return_ACPI_STATUS(status);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700870 }
871
872 /*
873 * Push the current state and create a new one
874 * The callback above returned a new target package object.
875 */
Len Brown4be44fc2005-08-05 00:44:28 -0400876 acpi_ut_push_generic_state(&state_list, state);
877 state = acpi_ut_create_pkg_state(this_source_obj,
878 state->pkg.
879 this_target_obj, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700880 if (!state) {
Len Brown4be44fc2005-08-05 00:44:28 -0400881 return_ACPI_STATUS(AE_NO_MEMORY);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700882 }
883 }
884 }
885
886 /* We should never get here */
887
Len Brown4be44fc2005-08-05 00:44:28 -0400888 return_ACPI_STATUS(AE_AML_INTERNAL);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700889}
890
Linus Torvalds1da177e2005-04-16 15:20:36 -0700891/*******************************************************************************
892 *
Bob Mooreb8e4d892006-01-27 16:43:00 -0500893 * FUNCTION: acpi_ut_error, acpi_ut_warning, acpi_ut_info
894 *
895 * PARAMETERS: module_name - Caller's module name (for error output)
896 * line_number - Caller's line number (for error output)
897 * Format - Printf format string + additional args
898 *
899 * RETURN: None
900 *
901 * DESCRIPTION: Print message with module/line/version info
902 *
903 ******************************************************************************/
904
905void ACPI_INTERNAL_VAR_XFACE
906acpi_ut_error(char *module_name, u32 line_number, char *format, ...)
907{
908 va_list args;
909
910 acpi_os_printf("ACPI Error (%s-%04d): ", module_name, line_number);
911
912 va_start(args, format);
913 acpi_os_vprintf(format, args);
914 acpi_os_printf(" [%X]\n", ACPI_CA_VERSION);
915}
916
917void ACPI_INTERNAL_VAR_XFACE
918acpi_ut_exception(char *module_name,
919 u32 line_number, acpi_status status, char *format, ...)
920{
921 va_list args;
922
923 acpi_os_printf("ACPI Exception (%s-%04d): %s, ", module_name,
924 line_number, acpi_format_exception(status));
925
926 va_start(args, format);
927 acpi_os_vprintf(format, args);
928 acpi_os_printf(" [%X]\n", ACPI_CA_VERSION);
929}
930
931void ACPI_INTERNAL_VAR_XFACE
932acpi_ut_warning(char *module_name, u32 line_number, char *format, ...)
933{
934 va_list args;
935
936 acpi_os_printf("ACPI Warning (%s-%04d): ", module_name, line_number);
937
938 va_start(args, format);
939 acpi_os_vprintf(format, args);
940 acpi_os_printf(" [%X]\n", ACPI_CA_VERSION);
941}
942
943void ACPI_INTERNAL_VAR_XFACE
944acpi_ut_info(char *module_name, u32 line_number, char *format, ...)
945{
946 va_list args;
947
948 acpi_os_printf("ACPI (%s-%04d): ", module_name, line_number);
949
950 va_start(args, format);
951 acpi_os_vprintf(format, args);
952 acpi_os_printf(" [%X]\n", ACPI_CA_VERSION);
953}