Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /******************************************************************************* |
2 | * | |
3 | * Module Name: utmisc - common utility procedures | |
4 | * | |
5 | ******************************************************************************/ | |
6 | ||
7 | /* | |
4a90c7e8 | 8 | * Copyright (C) 2000 - 2006, R. Byron Moore |
1da177e4 LT |
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 | ||
be63c925 TR |
44 | #include <linux/module.h> |
45 | ||
1da177e4 LT |
46 | #include <acpi/acpi.h> |
47 | #include <acpi/acnamesp.h> | |
48 | ||
1da177e4 | 49 | #define _COMPONENT ACPI_UTILITIES |
4be44fcd | 50 | ACPI_MODULE_NAME("utmisc") |
44f6c012 | 51 | |
793c2388 BM |
52 | /******************************************************************************* |
53 | * | |
54 | * FUNCTION: acpi_ut_is_aml_table | |
55 | * | |
56 | * PARAMETERS: Table - An ACPI table | |
57 | * | |
58 | * RETURN: TRUE if table contains executable AML; FALSE otherwise | |
59 | * | |
60 | * DESCRIPTION: Check ACPI Signature for a table that contains AML code. | |
61 | * Currently, these are DSDT,SSDT,PSDT. All other table types are | |
62 | * data tables that do not contain AML code. | |
63 | * | |
64 | ******************************************************************************/ | |
65 | u8 acpi_ut_is_aml_table(struct acpi_table_header *table) | |
66 | { | |
67 | ||
68 | /* Ignore tables that contain AML */ | |
69 | ||
70 | if (ACPI_COMPARE_NAME(table->signature, DSDT_SIG) || | |
71 | ACPI_COMPARE_NAME(table->signature, PSDT_SIG) || | |
72 | ACPI_COMPARE_NAME(table->signature, SSDT_SIG)) { | |
73 | return (TRUE); | |
74 | } | |
75 | ||
76 | return (FALSE); | |
77 | } | |
78 | ||
f9f4601f RM |
79 | /******************************************************************************* |
80 | * | |
81 | * FUNCTION: acpi_ut_allocate_owner_id | |
82 | * | |
83 | * PARAMETERS: owner_id - Where the new owner ID is returned | |
84 | * | |
0c9938cc RM |
85 | * RETURN: Status |
86 | * | |
87 | * DESCRIPTION: Allocate a table or method owner ID. The owner ID is used to | |
88 | * track objects created by the table or method, to be deleted | |
89 | * when the method exits or the table is unloaded. | |
f9f4601f RM |
90 | * |
91 | ******************************************************************************/ | |
793c2388 | 92 | |
4be44fcd | 93 | acpi_status acpi_ut_allocate_owner_id(acpi_owner_id * owner_id) |
f9f4601f | 94 | { |
4be44fcd | 95 | acpi_native_uint i; |
c51a4de8 | 96 | acpi_native_uint j; |
28f55ebc | 97 | acpi_native_uint k; |
4be44fcd | 98 | acpi_status status; |
f9f4601f | 99 | |
b229cf92 | 100 | ACPI_FUNCTION_TRACE(ut_allocate_owner_id); |
f9f4601f | 101 | |
aff8c277 RM |
102 | /* Guard against multiple allocations of ID to the same location */ |
103 | ||
104 | if (*owner_id) { | |
b8e4d893 BM |
105 | ACPI_ERROR((AE_INFO, "Owner ID [%2.2X] already exists", |
106 | *owner_id)); | |
aff8c277 RM |
107 | return_ACPI_STATUS(AE_ALREADY_EXISTS); |
108 | } | |
109 | ||
0c9938cc RM |
110 | /* Mutex for the global ID mask */ |
111 | ||
4be44fcd LB |
112 | status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES); |
113 | if (ACPI_FAILURE(status)) { | |
114 | return_ACPI_STATUS(status); | |
f9f4601f RM |
115 | } |
116 | ||
c51a4de8 BM |
117 | /* |
118 | * Find a free owner ID, cycle through all possible IDs on repeated | |
28f55ebc BM |
119 | * allocations. (ACPI_NUM_OWNERID_MASKS + 1) because first index may have |
120 | * to be scanned twice. | |
c51a4de8 | 121 | */ |
28f55ebc BM |
122 | for (i = 0, j = acpi_gbl_last_owner_id_index; |
123 | i < (ACPI_NUM_OWNERID_MASKS + 1); i++, j++) { | |
124 | if (j >= ACPI_NUM_OWNERID_MASKS) { | |
125 | j = 0; /* Wraparound to start of mask array */ | |
c51a4de8 BM |
126 | } |
127 | ||
28f55ebc BM |
128 | for (k = acpi_gbl_next_owner_id_offset; k < 32; k++) { |
129 | if (acpi_gbl_owner_id_mask[j] == ACPI_UINT32_MAX) { | |
52fc0b02 | 130 | |
28f55ebc BM |
131 | /* There are no free IDs in this mask */ |
132 | ||
133 | break; | |
134 | } | |
135 | ||
136 | if (!(acpi_gbl_owner_id_mask[j] & (1 << k))) { | |
137 | /* | |
138 | * Found a free ID. The actual ID is the bit index plus one, | |
139 | * making zero an invalid Owner ID. Save this as the last ID | |
140 | * allocated and update the global ID mask. | |
141 | */ | |
142 | acpi_gbl_owner_id_mask[j] |= (1 << k); | |
143 | ||
144 | acpi_gbl_last_owner_id_index = (u8) j; | |
145 | acpi_gbl_next_owner_id_offset = (u8) (k + 1); | |
146 | ||
147 | /* | |
148 | * Construct encoded ID from the index and bit position | |
149 | * | |
150 | * Note: Last [j].k (bit 255) is never used and is marked | |
151 | * permanently allocated (prevents +1 overflow) | |
152 | */ | |
153 | *owner_id = | |
154 | (acpi_owner_id) ((k + 1) + ACPI_MUL_32(j)); | |
155 | ||
156 | ACPI_DEBUG_PRINT((ACPI_DB_VALUES, | |
b229cf92 | 157 | "Allocated OwnerId: %2.2X\n", |
28f55ebc BM |
158 | (unsigned int)*owner_id)); |
159 | goto exit; | |
160 | } | |
f9f4601f | 161 | } |
28f55ebc BM |
162 | |
163 | acpi_gbl_next_owner_id_offset = 0; | |
f9f4601f RM |
164 | } |
165 | ||
166 | /* | |
c51a4de8 | 167 | * All owner_ids have been allocated. This typically should |
f9f4601f RM |
168 | * not happen since the IDs are reused after deallocation. The IDs are |
169 | * allocated upon table load (one per table) and method execution, and | |
170 | * they are released when a table is unloaded or a method completes | |
171 | * execution. | |
c51a4de8 BM |
172 | * |
173 | * If this error happens, there may be very deep nesting of invoked control | |
174 | * methods, or there may be a bug where the IDs are not released. | |
f9f4601f RM |
175 | */ |
176 | status = AE_OWNER_ID_LIMIT; | |
b8e4d893 | 177 | ACPI_ERROR((AE_INFO, |
b229cf92 | 178 | "Could not allocate new OwnerId (255 max), AE_OWNER_ID_LIMIT")); |
f9f4601f | 179 | |
4be44fcd LB |
180 | exit: |
181 | (void)acpi_ut_release_mutex(ACPI_MTX_CACHES); | |
182 | return_ACPI_STATUS(status); | |
f9f4601f RM |
183 | } |
184 | ||
f9f4601f RM |
185 | /******************************************************************************* |
186 | * | |
187 | * FUNCTION: acpi_ut_release_owner_id | |
188 | * | |
0c9938cc | 189 | * PARAMETERS: owner_id_ptr - Pointer to a previously allocated owner_iD |
f9f4601f | 190 | * |
0c9938cc RM |
191 | * RETURN: None. No error is returned because we are either exiting a |
192 | * control method or unloading a table. Either way, we would | |
193 | * ignore any error anyway. | |
194 | * | |
28f55ebc | 195 | * DESCRIPTION: Release a table or method owner ID. Valid IDs are 1 - 255 |
f9f4601f RM |
196 | * |
197 | ******************************************************************************/ | |
198 | ||
4be44fcd | 199 | void acpi_ut_release_owner_id(acpi_owner_id * owner_id_ptr) |
f9f4601f | 200 | { |
4be44fcd LB |
201 | acpi_owner_id owner_id = *owner_id_ptr; |
202 | acpi_status status; | |
28f55ebc BM |
203 | acpi_native_uint index; |
204 | u32 bit; | |
f9f4601f | 205 | |
b229cf92 | 206 | ACPI_FUNCTION_TRACE_U32(ut_release_owner_id, owner_id); |
f9f4601f | 207 | |
0c9938cc RM |
208 | /* Always clear the input owner_id (zero is an invalid ID) */ |
209 | ||
210 | *owner_id_ptr = 0; | |
211 | ||
212 | /* Zero is not a valid owner_iD */ | |
213 | ||
defba1d8 | 214 | if (owner_id == 0) { |
b229cf92 | 215 | ACPI_ERROR((AE_INFO, "Invalid OwnerId: %2.2X", owner_id)); |
0c9938cc RM |
216 | return_VOID; |
217 | } | |
218 | ||
219 | /* Mutex for the global ID mask */ | |
220 | ||
4be44fcd LB |
221 | status = acpi_ut_acquire_mutex(ACPI_MTX_CACHES); |
222 | if (ACPI_FAILURE(status)) { | |
0c9938cc | 223 | return_VOID; |
f9f4601f RM |
224 | } |
225 | ||
aff8c277 RM |
226 | /* Normalize the ID to zero */ |
227 | ||
228 | owner_id--; | |
0c9938cc | 229 | |
28f55ebc BM |
230 | /* Decode ID to index/offset pair */ |
231 | ||
232 | index = ACPI_DIV_32(owner_id); | |
233 | bit = 1 << ACPI_MOD_32(owner_id); | |
234 | ||
0c9938cc | 235 | /* Free the owner ID only if it is valid */ |
f9f4601f | 236 | |
28f55ebc BM |
237 | if (acpi_gbl_owner_id_mask[index] & bit) { |
238 | acpi_gbl_owner_id_mask[index] ^= bit; | |
239 | } else { | |
b8e4d893 | 240 | ACPI_ERROR((AE_INFO, |
b229cf92 | 241 | "Release of non-allocated OwnerId: %2.2X", |
b8e4d893 | 242 | owner_id + 1)); |
f9f4601f | 243 | } |
f9f4601f | 244 | |
4be44fcd | 245 | (void)acpi_ut_release_mutex(ACPI_MTX_CACHES); |
0c9938cc | 246 | return_VOID; |
f9f4601f RM |
247 | } |
248 | ||
44f6c012 RM |
249 | /******************************************************************************* |
250 | * | |
251 | * FUNCTION: acpi_ut_strupr (strupr) | |
252 | * | |
253 | * PARAMETERS: src_string - The source string to convert | |
254 | * | |
0c9938cc | 255 | * RETURN: None |
44f6c012 RM |
256 | * |
257 | * DESCRIPTION: Convert string to uppercase | |
258 | * | |
259 | * NOTE: This is not a POSIX function, so it appears here, not in utclib.c | |
260 | * | |
261 | ******************************************************************************/ | |
262 | ||
4be44fcd | 263 | void acpi_ut_strupr(char *src_string) |
44f6c012 | 264 | { |
4be44fcd | 265 | char *string; |
44f6c012 | 266 | |
4be44fcd | 267 | ACPI_FUNCTION_ENTRY(); |
44f6c012 | 268 | |
73459f73 | 269 | if (!src_string) { |
0c9938cc | 270 | return; |
73459f73 RM |
271 | } |
272 | ||
44f6c012 RM |
273 | /* Walk entire string, uppercasing the letters */ |
274 | ||
275 | for (string = src_string; *string; string++) { | |
4be44fcd | 276 | *string = (char)ACPI_TOUPPER(*string); |
44f6c012 RM |
277 | } |
278 | ||
0c9938cc | 279 | return; |
44f6c012 RM |
280 | } |
281 | ||
1da177e4 LT |
282 | /******************************************************************************* |
283 | * | |
284 | * FUNCTION: acpi_ut_print_string | |
285 | * | |
286 | * PARAMETERS: String - Null terminated ASCII string | |
44f6c012 | 287 | * max_length - Maximum output length |
1da177e4 LT |
288 | * |
289 | * RETURN: None | |
290 | * | |
291 | * DESCRIPTION: Dump an ASCII string with support for ACPI-defined escape | |
292 | * sequences. | |
293 | * | |
294 | ******************************************************************************/ | |
295 | ||
4be44fcd | 296 | void acpi_ut_print_string(char *string, u8 max_length) |
1da177e4 | 297 | { |
4be44fcd | 298 | u32 i; |
1da177e4 LT |
299 | |
300 | if (!string) { | |
4be44fcd | 301 | acpi_os_printf("<\"NULL STRING PTR\">"); |
1da177e4 LT |
302 | return; |
303 | } | |
304 | ||
4be44fcd | 305 | acpi_os_printf("\""); |
1da177e4 | 306 | for (i = 0; string[i] && (i < max_length); i++) { |
52fc0b02 | 307 | |
1da177e4 LT |
308 | /* Escape sequences */ |
309 | ||
310 | switch (string[i]) { | |
311 | case 0x07: | |
4be44fcd | 312 | acpi_os_printf("\\a"); /* BELL */ |
1da177e4 LT |
313 | break; |
314 | ||
315 | case 0x08: | |
4be44fcd | 316 | acpi_os_printf("\\b"); /* BACKSPACE */ |
1da177e4 LT |
317 | break; |
318 | ||
319 | case 0x0C: | |
4be44fcd | 320 | acpi_os_printf("\\f"); /* FORMFEED */ |
1da177e4 LT |
321 | break; |
322 | ||
323 | case 0x0A: | |
4be44fcd | 324 | acpi_os_printf("\\n"); /* LINEFEED */ |
1da177e4 LT |
325 | break; |
326 | ||
327 | case 0x0D: | |
4be44fcd | 328 | acpi_os_printf("\\r"); /* CARRIAGE RETURN */ |
1da177e4 LT |
329 | break; |
330 | ||
331 | case 0x09: | |
4be44fcd | 332 | acpi_os_printf("\\t"); /* HORIZONTAL TAB */ |
1da177e4 LT |
333 | break; |
334 | ||
335 | case 0x0B: | |
4be44fcd | 336 | acpi_os_printf("\\v"); /* VERTICAL TAB */ |
1da177e4 LT |
337 | break; |
338 | ||
4be44fcd LB |
339 | case '\'': /* Single Quote */ |
340 | case '\"': /* Double Quote */ | |
341 | case '\\': /* Backslash */ | |
342 | acpi_os_printf("\\%c", (int)string[i]); | |
1da177e4 LT |
343 | break; |
344 | ||
345 | default: | |
346 | ||
347 | /* Check for printable character or hex escape */ | |
348 | ||
4be44fcd | 349 | if (ACPI_IS_PRINT(string[i])) { |
1da177e4 LT |
350 | /* This is a normal character */ |
351 | ||
4be44fcd LB |
352 | acpi_os_printf("%c", (int)string[i]); |
353 | } else { | |
1da177e4 LT |
354 | /* All others will be Hex escapes */ |
355 | ||
4be44fcd | 356 | acpi_os_printf("\\x%2.2X", (s32) string[i]); |
1da177e4 LT |
357 | } |
358 | break; | |
359 | } | |
360 | } | |
4be44fcd | 361 | acpi_os_printf("\""); |
1da177e4 LT |
362 | |
363 | if (i == max_length && string[i]) { | |
4be44fcd | 364 | acpi_os_printf("..."); |
1da177e4 LT |
365 | } |
366 | } | |
367 | ||
1da177e4 LT |
368 | /******************************************************************************* |
369 | * | |
370 | * FUNCTION: acpi_ut_dword_byte_swap | |
371 | * | |
372 | * PARAMETERS: Value - Value to be converted | |
373 | * | |
44f6c012 RM |
374 | * RETURN: u32 integer with bytes swapped |
375 | * | |
1da177e4 LT |
376 | * DESCRIPTION: Convert a 32-bit value to big-endian (swap the bytes) |
377 | * | |
378 | ******************************************************************************/ | |
379 | ||
4be44fcd | 380 | u32 acpi_ut_dword_byte_swap(u32 value) |
1da177e4 LT |
381 | { |
382 | union { | |
4be44fcd LB |
383 | u32 value; |
384 | u8 bytes[4]; | |
1da177e4 | 385 | } out; |
1da177e4 | 386 | union { |
4be44fcd LB |
387 | u32 value; |
388 | u8 bytes[4]; | |
1da177e4 LT |
389 | } in; |
390 | ||
4be44fcd | 391 | ACPI_FUNCTION_ENTRY(); |
1da177e4 LT |
392 | |
393 | in.value = value; | |
394 | ||
395 | out.bytes[0] = in.bytes[3]; | |
396 | out.bytes[1] = in.bytes[2]; | |
397 | out.bytes[2] = in.bytes[1]; | |
398 | out.bytes[3] = in.bytes[0]; | |
399 | ||
400 | return (out.value); | |
401 | } | |
402 | ||
1da177e4 LT |
403 | /******************************************************************************* |
404 | * | |
405 | * FUNCTION: acpi_ut_set_integer_width | |
406 | * | |
407 | * PARAMETERS: Revision From DSDT header | |
408 | * | |
409 | * RETURN: None | |
410 | * | |
411 | * DESCRIPTION: Set the global integer bit width based upon the revision | |
412 | * of the DSDT. For Revision 1 and 0, Integers are 32 bits. | |
413 | * For Revision 2 and above, Integers are 64 bits. Yes, this | |
414 | * makes a difference. | |
415 | * | |
416 | ******************************************************************************/ | |
417 | ||
4be44fcd | 418 | void acpi_ut_set_integer_width(u8 revision) |
1da177e4 LT |
419 | { |
420 | ||
421 | if (revision <= 1) { | |
422 | acpi_gbl_integer_bit_width = 32; | |
423 | acpi_gbl_integer_nybble_width = 8; | |
424 | acpi_gbl_integer_byte_width = 4; | |
4be44fcd | 425 | } else { |
1da177e4 LT |
426 | acpi_gbl_integer_bit_width = 64; |
427 | acpi_gbl_integer_nybble_width = 16; | |
428 | acpi_gbl_integer_byte_width = 8; | |
429 | } | |
430 | } | |
431 | ||
1da177e4 LT |
432 | #ifdef ACPI_DEBUG_OUTPUT |
433 | /******************************************************************************* | |
434 | * | |
435 | * FUNCTION: acpi_ut_display_init_pathname | |
436 | * | |
44f6c012 RM |
437 | * PARAMETERS: Type - Object type of the node |
438 | * obj_handle - Handle whose pathname will be displayed | |
1da177e4 LT |
439 | * Path - Additional path string to be appended. |
440 | * (NULL if no extra path) | |
441 | * | |
442 | * RETURN: acpi_status | |
443 | * | |
444 | * DESCRIPTION: Display full pathname of an object, DEBUG ONLY | |
445 | * | |
446 | ******************************************************************************/ | |
447 | ||
448 | void | |
4be44fcd LB |
449 | acpi_ut_display_init_pathname(u8 type, |
450 | struct acpi_namespace_node *obj_handle, | |
451 | char *path) | |
1da177e4 | 452 | { |
4be44fcd LB |
453 | acpi_status status; |
454 | struct acpi_buffer buffer; | |
1da177e4 | 455 | |
4be44fcd | 456 | ACPI_FUNCTION_ENTRY(); |
1da177e4 LT |
457 | |
458 | /* Only print the path if the appropriate debug level is enabled */ | |
459 | ||
460 | if (!(acpi_dbg_level & ACPI_LV_INIT_NAMES)) { | |
461 | return; | |
462 | } | |
463 | ||
464 | /* Get the full pathname to the node */ | |
465 | ||
466 | buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER; | |
4be44fcd LB |
467 | status = acpi_ns_handle_to_pathname(obj_handle, &buffer); |
468 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
469 | return; |
470 | } | |
471 | ||
472 | /* Print what we're doing */ | |
473 | ||
474 | switch (type) { | |
475 | case ACPI_TYPE_METHOD: | |
4be44fcd | 476 | acpi_os_printf("Executing "); |
1da177e4 LT |
477 | break; |
478 | ||
479 | default: | |
4be44fcd | 480 | acpi_os_printf("Initializing "); |
1da177e4 LT |
481 | break; |
482 | } | |
483 | ||
484 | /* Print the object type and pathname */ | |
485 | ||
4be44fcd LB |
486 | acpi_os_printf("%-12s %s", |
487 | acpi_ut_get_type_name(type), (char *)buffer.pointer); | |
1da177e4 LT |
488 | |
489 | /* Extra path is used to append names like _STA, _INI, etc. */ | |
490 | ||
491 | if (path) { | |
4be44fcd | 492 | acpi_os_printf(".%s", path); |
1da177e4 | 493 | } |
4be44fcd | 494 | acpi_os_printf("\n"); |
1da177e4 | 495 | |
8313524a | 496 | ACPI_FREE(buffer.pointer); |
1da177e4 LT |
497 | } |
498 | #endif | |
499 | ||
793c2388 BM |
500 | /******************************************************************************* |
501 | * | |
502 | * FUNCTION: acpi_ut_valid_acpi_char | |
503 | * | |
504 | * PARAMETERS: Char - The character to be examined | |
505 | * | |
506 | * RETURN: TRUE if the character is valid, FALSE otherwise | |
507 | * | |
508 | * DESCRIPTION: Check for a valid ACPI character. Must be one of: | |
509 | * 1) Upper case alpha | |
510 | * 2) numeric | |
511 | * 3) underscore | |
512 | * | |
513 | * We allow a '!' as the last character because of the ASF! table | |
514 | * | |
515 | ******************************************************************************/ | |
516 | ||
517 | u8 acpi_ut_valid_acpi_char(char character, acpi_native_uint position) | |
518 | { | |
519 | ||
520 | if (!((character >= 'A' && character <= 'Z') || | |
521 | (character >= '0' && character <= '9') || (character == '_'))) { | |
522 | ||
523 | /* Allow a '!' in the last position */ | |
524 | ||
525 | if (character == '!' && position == 3) { | |
526 | return (TRUE); | |
527 | } | |
528 | ||
529 | return (FALSE); | |
530 | } | |
531 | ||
532 | return (TRUE); | |
533 | } | |
534 | ||
1da177e4 LT |
535 | /******************************************************************************* |
536 | * | |
537 | * FUNCTION: acpi_ut_valid_acpi_name | |
538 | * | |
44f6c012 | 539 | * PARAMETERS: Name - The name to be examined |
1da177e4 | 540 | * |
44f6c012 | 541 | * RETURN: TRUE if the name is valid, FALSE otherwise |
1da177e4 LT |
542 | * |
543 | * DESCRIPTION: Check for a valid ACPI name. Each character must be one of: | |
544 | * 1) Upper case alpha | |
545 | * 2) numeric | |
546 | * 3) underscore | |
547 | * | |
548 | ******************************************************************************/ | |
549 | ||
4be44fcd | 550 | u8 acpi_ut_valid_acpi_name(u32 name) |
1da177e4 | 551 | { |
4be44fcd | 552 | acpi_native_uint i; |
1da177e4 | 553 | |
4be44fcd | 554 | ACPI_FUNCTION_ENTRY(); |
1da177e4 LT |
555 | |
556 | for (i = 0; i < ACPI_NAME_SIZE; i++) { | |
793c2388 BM |
557 | if (!acpi_ut_valid_acpi_char |
558 | ((ACPI_CAST_PTR(char, &name))[i], i)) { | |
1da177e4 LT |
559 | return (FALSE); |
560 | } | |
561 | } | |
562 | ||
563 | return (TRUE); | |
564 | } | |
565 | ||
1da177e4 LT |
566 | /******************************************************************************* |
567 | * | |
793c2388 | 568 | * FUNCTION: acpi_ut_repair_name |
1da177e4 | 569 | * |
793c2388 | 570 | * PARAMETERS: Name - The ACPI name to be repaired |
1da177e4 | 571 | * |
793c2388 | 572 | * RETURN: Repaired version of the name |
1da177e4 | 573 | * |
793c2388 BM |
574 | * DESCRIPTION: Repair an ACPI name: Change invalid characters to '*' and |
575 | * return the new name. | |
1da177e4 LT |
576 | * |
577 | ******************************************************************************/ | |
578 | ||
793c2388 | 579 | acpi_name acpi_ut_repair_name(acpi_name name) |
1da177e4 | 580 | { |
793c2388 BM |
581 | char *name_ptr = ACPI_CAST_PTR(char, &name); |
582 | char new_name[ACPI_NAME_SIZE]; | |
583 | acpi_native_uint i; | |
1da177e4 | 584 | |
793c2388 BM |
585 | for (i = 0; i < ACPI_NAME_SIZE; i++) { |
586 | new_name[i] = name_ptr[i]; | |
587 | ||
588 | /* | |
589 | * Replace a bad character with something printable, yet technically | |
590 | * still invalid. This prevents any collisions with existing "good" | |
591 | * names in the namespace. | |
592 | */ | |
593 | if (!acpi_ut_valid_acpi_char(name_ptr[i], i)) { | |
594 | new_name[i] = '*'; | |
595 | } | |
596 | } | |
1da177e4 | 597 | |
793c2388 | 598 | return (*ACPI_CAST_PTR(u32, new_name)); |
1da177e4 LT |
599 | } |
600 | ||
1da177e4 LT |
601 | /******************************************************************************* |
602 | * | |
603 | * FUNCTION: acpi_ut_strtoul64 | |
604 | * | |
605 | * PARAMETERS: String - Null terminated string | |
4119532c BM |
606 | * Base - Radix of the string: 16 or ACPI_ANY_BASE; |
607 | * ACPI_ANY_BASE means 'in behalf of to_integer' | |
1da177e4 LT |
608 | * ret_integer - Where the converted integer is returned |
609 | * | |
610 | * RETURN: Status and Converted value | |
611 | * | |
612 | * DESCRIPTION: Convert a string into an unsigned value. | |
613 | * NOTE: Does not support Octal strings, not needed. | |
614 | * | |
615 | ******************************************************************************/ | |
616 | ||
617 | acpi_status | |
4be44fcd | 618 | acpi_ut_strtoul64(char *string, u32 base, acpi_integer * ret_integer) |
1da177e4 | 619 | { |
4be44fcd LB |
620 | u32 this_digit = 0; |
621 | acpi_integer return_value = 0; | |
622 | acpi_integer quotient; | |
4119532c BM |
623 | acpi_integer dividend; |
624 | u32 to_integer_op = (base == ACPI_ANY_BASE); | |
625 | u32 mode32 = (acpi_gbl_integer_byte_width == 4); | |
626 | u8 valid_digits = 0; | |
627 | u8 sign_of0x = 0; | |
628 | u8 term = 0; | |
1da177e4 | 629 | |
b229cf92 | 630 | ACPI_FUNCTION_TRACE(ut_stroul64); |
1da177e4 | 631 | |
1da177e4 LT |
632 | switch (base) { |
633 | case ACPI_ANY_BASE: | |
1da177e4 LT |
634 | case 16: |
635 | break; | |
636 | ||
637 | default: | |
638 | /* Invalid Base */ | |
4be44fcd | 639 | return_ACPI_STATUS(AE_BAD_PARAMETER); |
1da177e4 LT |
640 | } |
641 | ||
4119532c BM |
642 | if (!string) { |
643 | goto error_exit; | |
644 | } | |
645 | ||
1da177e4 LT |
646 | /* Skip over any white space in the buffer */ |
647 | ||
4119532c | 648 | while ((*string) && (ACPI_IS_SPACE(*string) || *string == '\t')) { |
1da177e4 LT |
649 | string++; |
650 | } | |
651 | ||
4119532c BM |
652 | if (to_integer_op) { |
653 | /* | |
654 | * Base equal to ACPI_ANY_BASE means 'to_integer operation case'. | |
655 | * We need to determine if it is decimal or hexadecimal. | |
656 | */ | |
4be44fcd | 657 | if ((*string == '0') && (ACPI_TOLOWER(*(string + 1)) == 'x')) { |
4119532c | 658 | sign_of0x = 1; |
1da177e4 | 659 | base = 16; |
4119532c BM |
660 | |
661 | /* Skip over the leading '0x' */ | |
1da177e4 | 662 | string += 2; |
4be44fcd | 663 | } else { |
1da177e4 LT |
664 | base = 10; |
665 | } | |
666 | } | |
667 | ||
4119532c BM |
668 | /* Any string left? Check that '0x' is not followed by white space. */ |
669 | ||
670 | if (!(*string) || ACPI_IS_SPACE(*string) || *string == '\t') { | |
671 | if (to_integer_op) { | |
672 | goto error_exit; | |
673 | } else { | |
674 | goto all_done; | |
675 | } | |
1da177e4 LT |
676 | } |
677 | ||
4119532c | 678 | dividend = (mode32) ? ACPI_UINT32_MAX : ACPI_UINT64_MAX; |
1da177e4 | 679 | |
4119532c | 680 | /* At least one character in the string here */ |
1da177e4 LT |
681 | |
682 | /* Main loop: convert the string to a 64-bit integer */ | |
683 | ||
684 | while (*string) { | |
4be44fcd | 685 | if (ACPI_IS_DIGIT(*string)) { |
52fc0b02 | 686 | |
1da177e4 LT |
687 | /* Convert ASCII 0-9 to Decimal value */ |
688 | ||
4be44fcd | 689 | this_digit = ((u8) * string) - '0'; |
4119532c | 690 | } else if (base == 10) { |
1da177e4 | 691 | |
4119532c | 692 | /* Digit is out of range; possible in to_integer case only */ |
1da177e4 | 693 | |
4119532c BM |
694 | term = 1; |
695 | } else { | |
4be44fcd LB |
696 | this_digit = (u8) ACPI_TOUPPER(*string); |
697 | if (ACPI_IS_XDIGIT((char)this_digit)) { | |
52fc0b02 | 698 | |
1da177e4 LT |
699 | /* Convert ASCII Hex char to value */ |
700 | ||
701 | this_digit = this_digit - 'A' + 10; | |
4be44fcd | 702 | } else { |
4119532c BM |
703 | term = 1; |
704 | } | |
705 | } | |
706 | ||
707 | if (term) { | |
708 | if (to_integer_op) { | |
709 | goto error_exit; | |
710 | } else { | |
1da177e4 LT |
711 | break; |
712 | } | |
4119532c BM |
713 | } else if ((valid_digits == 0) && (this_digit == 0) |
714 | && !sign_of0x) { | |
715 | ||
716 | /* Skip zeros */ | |
717 | string++; | |
718 | continue; | |
719 | } | |
720 | ||
721 | valid_digits++; | |
722 | ||
723 | if (sign_of0x | |
724 | && ((valid_digits > 16) | |
725 | || ((valid_digits > 8) && mode32))) { | |
726 | /* | |
727 | * This is to_integer operation case. | |
728 | * No any restrictions for string-to-integer conversion, | |
729 | * see ACPI spec. | |
730 | */ | |
731 | goto error_exit; | |
1da177e4 LT |
732 | } |
733 | ||
734 | /* Divide the digit into the correct position */ | |
735 | ||
4be44fcd | 736 | (void) |
4119532c BM |
737 | acpi_ut_short_divide((dividend - (acpi_integer) this_digit), |
738 | base, "ient, NULL); | |
739 | ||
1da177e4 | 740 | if (return_value > quotient) { |
4119532c BM |
741 | if (to_integer_op) { |
742 | goto error_exit; | |
743 | } else { | |
744 | break; | |
745 | } | |
1da177e4 LT |
746 | } |
747 | ||
748 | return_value *= base; | |
749 | return_value += this_digit; | |
750 | string++; | |
751 | } | |
752 | ||
753 | /* All done, normal exit */ | |
754 | ||
4119532c BM |
755 | all_done: |
756 | ||
1da177e4 | 757 | *ret_integer = return_value; |
4be44fcd | 758 | return_ACPI_STATUS(AE_OK); |
1da177e4 | 759 | |
4be44fcd | 760 | error_exit: |
1da177e4 LT |
761 | /* Base was set/validated above */ |
762 | ||
763 | if (base == 10) { | |
4be44fcd LB |
764 | return_ACPI_STATUS(AE_BAD_DECIMAL_CONSTANT); |
765 | } else { | |
766 | return_ACPI_STATUS(AE_BAD_HEX_CONSTANT); | |
1da177e4 LT |
767 | } |
768 | } | |
769 | ||
1da177e4 LT |
770 | /******************************************************************************* |
771 | * | |
772 | * FUNCTION: acpi_ut_create_update_state_and_push | |
773 | * | |
44f6c012 | 774 | * PARAMETERS: Object - Object to be added to the new state |
1da177e4 LT |
775 | * Action - Increment/Decrement |
776 | * state_list - List the state will be added to | |
777 | * | |
44f6c012 | 778 | * RETURN: Status |
1da177e4 LT |
779 | * |
780 | * DESCRIPTION: Create a new state and push it | |
781 | * | |
782 | ******************************************************************************/ | |
783 | ||
784 | acpi_status | |
4be44fcd LB |
785 | acpi_ut_create_update_state_and_push(union acpi_operand_object *object, |
786 | u16 action, | |
787 | union acpi_generic_state **state_list) | |
1da177e4 | 788 | { |
4be44fcd | 789 | union acpi_generic_state *state; |
1da177e4 | 790 | |
4be44fcd | 791 | ACPI_FUNCTION_ENTRY(); |
1da177e4 LT |
792 | |
793 | /* Ignore null objects; these are expected */ | |
794 | ||
795 | if (!object) { | |
796 | return (AE_OK); | |
797 | } | |
798 | ||
4be44fcd | 799 | state = acpi_ut_create_update_state(object, action); |
1da177e4 LT |
800 | if (!state) { |
801 | return (AE_NO_MEMORY); | |
802 | } | |
803 | ||
4be44fcd | 804 | acpi_ut_push_generic_state(state_list, state); |
1da177e4 LT |
805 | return (AE_OK); |
806 | } | |
807 | ||
1da177e4 LT |
808 | /******************************************************************************* |
809 | * | |
810 | * FUNCTION: acpi_ut_walk_package_tree | |
811 | * | |
44f6c012 RM |
812 | * PARAMETERS: source_object - The package to walk |
813 | * target_object - Target object (if package is being copied) | |
814 | * walk_callback - Called once for each package element | |
815 | * Context - Passed to the callback function | |
1da177e4 LT |
816 | * |
817 | * RETURN: Status | |
818 | * | |
819 | * DESCRIPTION: Walk through a package | |
820 | * | |
821 | ******************************************************************************/ | |
822 | ||
823 | acpi_status | |
4be44fcd LB |
824 | acpi_ut_walk_package_tree(union acpi_operand_object * source_object, |
825 | void *target_object, | |
826 | acpi_pkg_callback walk_callback, void *context) | |
1da177e4 | 827 | { |
4be44fcd LB |
828 | acpi_status status = AE_OK; |
829 | union acpi_generic_state *state_list = NULL; | |
830 | union acpi_generic_state *state; | |
831 | u32 this_index; | |
832 | union acpi_operand_object *this_source_obj; | |
1da177e4 | 833 | |
b229cf92 | 834 | ACPI_FUNCTION_TRACE(ut_walk_package_tree); |
1da177e4 | 835 | |
4be44fcd | 836 | state = acpi_ut_create_pkg_state(source_object, target_object, 0); |
1da177e4 | 837 | if (!state) { |
4be44fcd | 838 | return_ACPI_STATUS(AE_NO_MEMORY); |
1da177e4 LT |
839 | } |
840 | ||
841 | while (state) { | |
52fc0b02 | 842 | |
1da177e4 LT |
843 | /* Get one element of the package */ |
844 | ||
4be44fcd | 845 | this_index = state->pkg.index; |
1da177e4 | 846 | this_source_obj = (union acpi_operand_object *) |
4be44fcd | 847 | state->pkg.source_object->package.elements[this_index]; |
1da177e4 LT |
848 | |
849 | /* | |
850 | * Check for: | |
851 | * 1) An uninitialized package element. It is completely | |
852 | * legal to declare a package and leave it uninitialized | |
853 | * 2) Not an internal object - can be a namespace node instead | |
854 | * 3) Any type other than a package. Packages are handled in else | |
855 | * case below. | |
856 | */ | |
857 | if ((!this_source_obj) || | |
4be44fcd LB |
858 | (ACPI_GET_DESCRIPTOR_TYPE(this_source_obj) != |
859 | ACPI_DESC_TYPE_OPERAND) | |
860 | || (ACPI_GET_OBJECT_TYPE(this_source_obj) != | |
861 | ACPI_TYPE_PACKAGE)) { | |
862 | status = | |
863 | walk_callback(ACPI_COPY_TYPE_SIMPLE, | |
864 | this_source_obj, state, context); | |
865 | if (ACPI_FAILURE(status)) { | |
866 | return_ACPI_STATUS(status); | |
1da177e4 LT |
867 | } |
868 | ||
869 | state->pkg.index++; | |
4be44fcd LB |
870 | while (state->pkg.index >= |
871 | state->pkg.source_object->package.count) { | |
1da177e4 LT |
872 | /* |
873 | * We've handled all of the objects at this level, This means | |
874 | * that we have just completed a package. That package may | |
875 | * have contained one or more packages itself. | |
876 | * | |
877 | * Delete this state and pop the previous state (package). | |
878 | */ | |
4be44fcd LB |
879 | acpi_ut_delete_generic_state(state); |
880 | state = acpi_ut_pop_generic_state(&state_list); | |
1da177e4 LT |
881 | |
882 | /* Finished when there are no more states */ | |
883 | ||
884 | if (!state) { | |
885 | /* | |
886 | * We have handled all of the objects in the top level | |
887 | * package just add the length of the package objects | |
888 | * and exit | |
889 | */ | |
4be44fcd | 890 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
891 | } |
892 | ||
893 | /* | |
894 | * Go back up a level and move the index past the just | |
895 | * completed package object. | |
896 | */ | |
897 | state->pkg.index++; | |
898 | } | |
4be44fcd | 899 | } else { |
1da177e4 LT |
900 | /* This is a subobject of type package */ |
901 | ||
4be44fcd LB |
902 | status = |
903 | walk_callback(ACPI_COPY_TYPE_PACKAGE, | |
904 | this_source_obj, state, context); | |
905 | if (ACPI_FAILURE(status)) { | |
906 | return_ACPI_STATUS(status); | |
1da177e4 LT |
907 | } |
908 | ||
909 | /* | |
910 | * Push the current state and create a new one | |
911 | * The callback above returned a new target package object. | |
912 | */ | |
4be44fcd LB |
913 | acpi_ut_push_generic_state(&state_list, state); |
914 | state = acpi_ut_create_pkg_state(this_source_obj, | |
915 | state->pkg. | |
916 | this_target_obj, 0); | |
1da177e4 | 917 | if (!state) { |
4be44fcd | 918 | return_ACPI_STATUS(AE_NO_MEMORY); |
1da177e4 LT |
919 | } |
920 | } | |
921 | } | |
922 | ||
923 | /* We should never get here */ | |
924 | ||
4be44fcd | 925 | return_ACPI_STATUS(AE_AML_INTERNAL); |
1da177e4 LT |
926 | } |
927 | ||
1da177e4 LT |
928 | /******************************************************************************* |
929 | * | |
b8e4d893 | 930 | * FUNCTION: acpi_ut_error, acpi_ut_warning, acpi_ut_info |
1da177e4 LT |
931 | * |
932 | * PARAMETERS: module_name - Caller's module name (for error output) | |
933 | * line_number - Caller's line number (for error output) | |
b8e4d893 | 934 | * Format - Printf format string + additional args |
1da177e4 LT |
935 | * |
936 | * RETURN: None | |
937 | * | |
b8e4d893 | 938 | * DESCRIPTION: Print message with module/line/version info |
1da177e4 LT |
939 | * |
940 | ******************************************************************************/ | |
941 | ||
b8e4d893 BM |
942 | void ACPI_INTERNAL_VAR_XFACE |
943 | acpi_ut_error(char *module_name, u32 line_number, char *format, ...) | |
1da177e4 | 944 | { |
b8e4d893 | 945 | va_list args; |
1da177e4 | 946 | |
4a90c7e8 | 947 | acpi_os_printf("ACPI Error (%s-%04d): ", module_name, line_number); |
b8e4d893 BM |
948 | |
949 | va_start(args, format); | |
950 | acpi_os_vprintf(format, args); | |
951 | acpi_os_printf(" [%X]\n", ACPI_CA_VERSION); | |
1da177e4 LT |
952 | } |
953 | ||
b8e4d893 BM |
954 | void ACPI_INTERNAL_VAR_XFACE |
955 | acpi_ut_exception(char *module_name, | |
956 | u32 line_number, acpi_status status, char *format, ...) | |
957 | { | |
958 | va_list args; | |
1da177e4 | 959 | |
b8e4d893 BM |
960 | acpi_os_printf("ACPI Exception (%s-%04d): %s, ", module_name, |
961 | line_number, acpi_format_exception(status)); | |
962 | ||
963 | va_start(args, format); | |
964 | acpi_os_vprintf(format, args); | |
965 | acpi_os_printf(" [%X]\n", ACPI_CA_VERSION); | |
966 | } | |
be63c925 | 967 | EXPORT_SYMBOL(acpi_ut_exception); |
b8e4d893 BM |
968 | |
969 | void ACPI_INTERNAL_VAR_XFACE | |
970 | acpi_ut_warning(char *module_name, u32 line_number, char *format, ...) | |
1da177e4 | 971 | { |
b8e4d893 | 972 | va_list args; |
1da177e4 | 973 | |
4a90c7e8 | 974 | acpi_os_printf("ACPI Warning (%s-%04d): ", module_name, line_number); |
b8e4d893 BM |
975 | |
976 | va_start(args, format); | |
977 | acpi_os_vprintf(format, args); | |
978 | acpi_os_printf(" [%X]\n", ACPI_CA_VERSION); | |
979 | } | |
cece9296 | 980 | |
b8e4d893 BM |
981 | void ACPI_INTERNAL_VAR_XFACE |
982 | acpi_ut_info(char *module_name, u32 line_number, char *format, ...) | |
983 | { | |
984 | va_list args; | |
985 | ||
986 | acpi_os_printf("ACPI (%s-%04d): ", module_name, line_number); | |
987 | ||
988 | va_start(args, format); | |
989 | acpi_os_vprintf(format, args); | |
990 | acpi_os_printf(" [%X]\n", ACPI_CA_VERSION); | |
1da177e4 | 991 | } |