]>
Commit | Line | Data |
---|---|---|
1da177e4 LT |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: nsutils - Utilities for accessing ACPI namespace, accessing | |
4 | * parents and siblings and Scope manipulation | |
5 | * | |
6 | *****************************************************************************/ | |
7 | ||
8 | /* | |
4a90c7e8 | 9 | * Copyright (C) 2000 - 2006, R. Byron Moore |
1da177e4 LT |
10 | * All rights reserved. |
11 | * | |
12 | * Redistribution and use in source and binary forms, with or without | |
13 | * modification, are permitted provided that the following conditions | |
14 | * are met: | |
15 | * 1. Redistributions of source code must retain the above copyright | |
16 | * notice, this list of conditions, and the following disclaimer, | |
17 | * without modification. | |
18 | * 2. Redistributions in binary form must reproduce at minimum a disclaimer | |
19 | * substantially similar to the "NO WARRANTY" disclaimer below | |
20 | * ("Disclaimer") and any redistribution must be conditioned upon | |
21 | * including a substantially similar Disclaimer requirement for further | |
22 | * binary redistribution. | |
23 | * 3. Neither the names of the above-listed copyright holders nor the names | |
24 | * of any contributors may be used to endorse or promote products derived | |
25 | * from this software without specific prior written permission. | |
26 | * | |
27 | * Alternatively, this software may be distributed under the terms of the | |
28 | * GNU General Public License ("GPL") version 2 as published by the Free | |
29 | * Software Foundation. | |
30 | * | |
31 | * NO WARRANTY | |
32 | * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS | |
33 | * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT | |
34 | * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR | |
35 | * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT | |
36 | * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | |
37 | * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | |
38 | * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
39 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
40 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING | |
41 | * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE | |
42 | * POSSIBILITY OF SUCH DAMAGES. | |
43 | */ | |
44 | ||
1da177e4 LT |
45 | #include <acpi/acpi.h> |
46 | #include <acpi/acnamesp.h> | |
47 | #include <acpi/amlcode.h> | |
48 | #include <acpi/actables.h> | |
49 | ||
50 | #define _COMPONENT ACPI_NAMESPACE | |
4be44fcd | 51 | ACPI_MODULE_NAME("nsutils") |
1da177e4 | 52 | |
44f6c012 | 53 | /* Local prototypes */ |
4be44fcd | 54 | static u8 acpi_ns_valid_path_separator(char sep); |
44f6c012 RM |
55 | |
56 | #ifdef ACPI_OBSOLETE_FUNCTIONS | |
4be44fcd | 57 | acpi_name acpi_ns_find_parent_name(struct acpi_namespace_node *node_to_search); |
44f6c012 RM |
58 | #endif |
59 | ||
1da177e4 LT |
60 | /******************************************************************************* |
61 | * | |
62 | * FUNCTION: acpi_ns_report_error | |
63 | * | |
64 | * PARAMETERS: module_name - Caller's module name (for error output) | |
65 | * line_number - Caller's line number (for error output) | |
44f6c012 RM |
66 | * internal_name - Name or path of the namespace node |
67 | * lookup_status - Exception code from NS lookup | |
1da177e4 LT |
68 | * |
69 | * RETURN: None | |
70 | * | |
71 | * DESCRIPTION: Print warning message with full pathname | |
72 | * | |
73 | ******************************************************************************/ | |
74 | ||
75 | void | |
4be44fcd LB |
76 | acpi_ns_report_error(char *module_name, |
77 | u32 line_number, | |
4be44fcd | 78 | char *internal_name, acpi_status lookup_status) |
1da177e4 | 79 | { |
4be44fcd LB |
80 | acpi_status status; |
81 | char *name = NULL; | |
1da177e4 | 82 | |
4a90c7e8 | 83 | acpi_ut_report_error(module_name, line_number); |
1da177e4 LT |
84 | |
85 | if (lookup_status == AE_BAD_CHARACTER) { | |
86 | /* There is a non-ascii character in the name */ | |
87 | ||
4be44fcd LB |
88 | acpi_os_printf("[0x%4.4X] (NON-ASCII)\n", |
89 | *(ACPI_CAST_PTR(u32, internal_name))); | |
90 | } else { | |
1da177e4 LT |
91 | /* Convert path to external format */ |
92 | ||
4be44fcd LB |
93 | status = acpi_ns_externalize_name(ACPI_UINT32_MAX, |
94 | internal_name, NULL, &name); | |
1da177e4 LT |
95 | |
96 | /* Print target name */ | |
97 | ||
4be44fcd LB |
98 | if (ACPI_SUCCESS(status)) { |
99 | acpi_os_printf("[%s]", name); | |
100 | } else { | |
101 | acpi_os_printf("[COULD NOT EXTERNALIZE NAME]"); | |
1da177e4 LT |
102 | } |
103 | ||
104 | if (name) { | |
4be44fcd | 105 | ACPI_MEM_FREE(name); |
1da177e4 LT |
106 | } |
107 | } | |
108 | ||
4a90c7e8 | 109 | acpi_os_printf("Namespace lookup failure, %s\n", |
4be44fcd | 110 | acpi_format_exception(lookup_status)); |
1da177e4 LT |
111 | } |
112 | ||
1da177e4 LT |
113 | /******************************************************************************* |
114 | * | |
115 | * FUNCTION: acpi_ns_report_method_error | |
116 | * | |
117 | * PARAMETERS: module_name - Caller's module name (for error output) | |
118 | * line_number - Caller's line number (for error output) | |
1da177e4 | 119 | * Message - Error message to use on failure |
44f6c012 | 120 | * prefix_node - Prefix relative to the path |
4a90c7e8 | 121 | * Path - Path to the node (optional) |
44f6c012 | 122 | * method_status - Execution status |
1da177e4 LT |
123 | * |
124 | * RETURN: None | |
125 | * | |
126 | * DESCRIPTION: Print warning message with full pathname | |
127 | * | |
128 | ******************************************************************************/ | |
129 | ||
130 | void | |
4be44fcd LB |
131 | acpi_ns_report_method_error(char *module_name, |
132 | u32 line_number, | |
4be44fcd LB |
133 | char *message, |
134 | struct acpi_namespace_node *prefix_node, | |
135 | char *path, acpi_status method_status) | |
1da177e4 | 136 | { |
4be44fcd LB |
137 | acpi_status status; |
138 | struct acpi_namespace_node *node = prefix_node; | |
1da177e4 | 139 | |
4a90c7e8 BM |
140 | acpi_ut_report_error(module_name, line_number); |
141 | ||
1da177e4 | 142 | if (path) { |
4be44fcd LB |
143 | status = acpi_ns_get_node_by_path(path, prefix_node, |
144 | ACPI_NS_NO_UPSEARCH, &node); | |
145 | if (ACPI_FAILURE(status)) { | |
4a90c7e8 | 146 | acpi_os_printf("[Could not get node by pathname]"); |
1da177e4 LT |
147 | } |
148 | } | |
149 | ||
4be44fcd LB |
150 | acpi_ns_print_node_pathname(node, message); |
151 | acpi_os_printf(", %s\n", acpi_format_exception(method_status)); | |
1da177e4 LT |
152 | } |
153 | ||
1da177e4 LT |
154 | /******************************************************************************* |
155 | * | |
156 | * FUNCTION: acpi_ns_print_node_pathname | |
157 | * | |
44f6c012 RM |
158 | * PARAMETERS: Node - Object |
159 | * Message - Prefix message | |
1da177e4 LT |
160 | * |
161 | * DESCRIPTION: Print an object's full namespace pathname | |
162 | * Manages allocation/freeing of a pathname buffer | |
163 | * | |
164 | ******************************************************************************/ | |
165 | ||
166 | void | |
4be44fcd | 167 | acpi_ns_print_node_pathname(struct acpi_namespace_node *node, char *message) |
1da177e4 | 168 | { |
4be44fcd LB |
169 | struct acpi_buffer buffer; |
170 | acpi_status status; | |
1da177e4 LT |
171 | |
172 | if (!node) { | |
4be44fcd | 173 | acpi_os_printf("[NULL NAME]"); |
1da177e4 LT |
174 | return; |
175 | } | |
176 | ||
177 | /* Convert handle to full pathname and print it (with supplied message) */ | |
178 | ||
179 | buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER; | |
180 | ||
4be44fcd LB |
181 | status = acpi_ns_handle_to_pathname(node, &buffer); |
182 | if (ACPI_SUCCESS(status)) { | |
44f6c012 | 183 | if (message) { |
4be44fcd | 184 | acpi_os_printf("%s ", message); |
1da177e4 LT |
185 | } |
186 | ||
4be44fcd LB |
187 | acpi_os_printf("[%s] (Node %p)", (char *)buffer.pointer, node); |
188 | ACPI_MEM_FREE(buffer.pointer); | |
1da177e4 LT |
189 | } |
190 | } | |
191 | ||
1da177e4 LT |
192 | /******************************************************************************* |
193 | * | |
194 | * FUNCTION: acpi_ns_valid_root_prefix | |
195 | * | |
196 | * PARAMETERS: Prefix - Character to be checked | |
197 | * | |
198 | * RETURN: TRUE if a valid prefix | |
199 | * | |
200 | * DESCRIPTION: Check if a character is a valid ACPI Root prefix | |
201 | * | |
202 | ******************************************************************************/ | |
203 | ||
4be44fcd | 204 | u8 acpi_ns_valid_root_prefix(char prefix) |
1da177e4 LT |
205 | { |
206 | ||
207 | return ((u8) (prefix == '\\')); | |
208 | } | |
209 | ||
1da177e4 LT |
210 | /******************************************************************************* |
211 | * | |
212 | * FUNCTION: acpi_ns_valid_path_separator | |
213 | * | |
44f6c012 | 214 | * PARAMETERS: Sep - Character to be checked |
1da177e4 LT |
215 | * |
216 | * RETURN: TRUE if a valid path separator | |
217 | * | |
218 | * DESCRIPTION: Check if a character is a valid ACPI path separator | |
219 | * | |
220 | ******************************************************************************/ | |
221 | ||
4be44fcd | 222 | static u8 acpi_ns_valid_path_separator(char sep) |
1da177e4 LT |
223 | { |
224 | ||
225 | return ((u8) (sep == '.')); | |
226 | } | |
227 | ||
1da177e4 LT |
228 | /******************************************************************************* |
229 | * | |
230 | * FUNCTION: acpi_ns_get_type | |
231 | * | |
44f6c012 | 232 | * PARAMETERS: Node - Parent Node to be examined |
1da177e4 LT |
233 | * |
234 | * RETURN: Type field from Node whose handle is passed | |
235 | * | |
44f6c012 RM |
236 | * DESCRIPTION: Return the type of a Namespace node |
237 | * | |
1da177e4 LT |
238 | ******************************************************************************/ |
239 | ||
4be44fcd | 240 | acpi_object_type acpi_ns_get_type(struct acpi_namespace_node * node) |
1da177e4 | 241 | { |
4be44fcd | 242 | ACPI_FUNCTION_TRACE("ns_get_type"); |
1da177e4 LT |
243 | |
244 | if (!node) { | |
4a90c7e8 | 245 | ACPI_REPORT_WARNING(("Null Node parameter\n")); |
50eca3eb | 246 | return_UINT32(ACPI_TYPE_ANY); |
1da177e4 LT |
247 | } |
248 | ||
50eca3eb | 249 | return_UINT32((acpi_object_type) node->type); |
1da177e4 LT |
250 | } |
251 | ||
1da177e4 LT |
252 | /******************************************************************************* |
253 | * | |
254 | * FUNCTION: acpi_ns_local | |
255 | * | |
44f6c012 | 256 | * PARAMETERS: Type - A namespace object type |
1da177e4 LT |
257 | * |
258 | * RETURN: LOCAL if names must be found locally in objects of the | |
259 | * passed type, 0 if enclosing scopes should be searched | |
260 | * | |
44f6c012 RM |
261 | * DESCRIPTION: Returns scope rule for the given object type. |
262 | * | |
1da177e4 LT |
263 | ******************************************************************************/ |
264 | ||
4be44fcd | 265 | u32 acpi_ns_local(acpi_object_type type) |
1da177e4 | 266 | { |
4be44fcd | 267 | ACPI_FUNCTION_TRACE("ns_local"); |
1da177e4 | 268 | |
4be44fcd | 269 | if (!acpi_ut_valid_object_type(type)) { |
1da177e4 LT |
270 | /* Type code out of range */ |
271 | ||
4a90c7e8 | 272 | ACPI_REPORT_WARNING(("Invalid Object Type %X\n", type)); |
50eca3eb | 273 | return_UINT32(ACPI_NS_NORMAL); |
1da177e4 LT |
274 | } |
275 | ||
50eca3eb | 276 | return_UINT32((u32) acpi_gbl_ns_properties[type] & ACPI_NS_LOCAL); |
1da177e4 LT |
277 | } |
278 | ||
1da177e4 LT |
279 | /******************************************************************************* |
280 | * | |
281 | * FUNCTION: acpi_ns_get_internal_name_length | |
282 | * | |
283 | * PARAMETERS: Info - Info struct initialized with the | |
284 | * external name pointer. | |
285 | * | |
44f6c012 | 286 | * RETURN: None |
1da177e4 LT |
287 | * |
288 | * DESCRIPTION: Calculate the length of the internal (AML) namestring | |
289 | * corresponding to the external (ASL) namestring. | |
290 | * | |
291 | ******************************************************************************/ | |
292 | ||
4be44fcd | 293 | void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info) |
1da177e4 | 294 | { |
4be44fcd LB |
295 | char *next_external_char; |
296 | u32 i; | |
1da177e4 | 297 | |
4be44fcd | 298 | ACPI_FUNCTION_ENTRY(); |
1da177e4 LT |
299 | |
300 | next_external_char = info->external_name; | |
301 | info->num_carats = 0; | |
302 | info->num_segments = 0; | |
303 | info->fully_qualified = FALSE; | |
304 | ||
305 | /* | |
306 | * For the internal name, the required length is 4 bytes per segment, plus | |
307 | * 1 each for root_prefix, multi_name_prefix_op, segment count, trailing null | |
308 | * (which is not really needed, but no there's harm in putting it there) | |
309 | * | |
310 | * strlen() + 1 covers the first name_seg, which has no path separator | |
311 | */ | |
4be44fcd | 312 | if (acpi_ns_valid_root_prefix(next_external_char[0])) { |
1da177e4 LT |
313 | info->fully_qualified = TRUE; |
314 | next_external_char++; | |
4be44fcd | 315 | } else { |
1da177e4 LT |
316 | /* |
317 | * Handle Carat prefixes | |
318 | */ | |
319 | while (*next_external_char == '^') { | |
320 | info->num_carats++; | |
321 | next_external_char++; | |
322 | } | |
323 | } | |
324 | ||
325 | /* | |
326 | * Determine the number of ACPI name "segments" by counting the number of | |
327 | * path separators within the string. Start with one segment since the | |
328 | * segment count is [(# separators) + 1], and zero separators is ok. | |
329 | */ | |
330 | if (*next_external_char) { | |
331 | info->num_segments = 1; | |
332 | for (i = 0; next_external_char[i]; i++) { | |
4be44fcd | 333 | if (acpi_ns_valid_path_separator(next_external_char[i])) { |
1da177e4 LT |
334 | info->num_segments++; |
335 | } | |
336 | } | |
337 | } | |
338 | ||
339 | info->length = (ACPI_NAME_SIZE * info->num_segments) + | |
4be44fcd | 340 | 4 + info->num_carats; |
1da177e4 LT |
341 | |
342 | info->next_external_char = next_external_char; | |
343 | } | |
344 | ||
1da177e4 LT |
345 | /******************************************************************************* |
346 | * | |
347 | * FUNCTION: acpi_ns_build_internal_name | |
348 | * | |
349 | * PARAMETERS: Info - Info struct fully initialized | |
350 | * | |
351 | * RETURN: Status | |
352 | * | |
353 | * DESCRIPTION: Construct the internal (AML) namestring | |
354 | * corresponding to the external (ASL) namestring. | |
355 | * | |
356 | ******************************************************************************/ | |
357 | ||
4be44fcd | 358 | acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info) |
1da177e4 | 359 | { |
4be44fcd LB |
360 | u32 num_segments = info->num_segments; |
361 | char *internal_name = info->internal_name; | |
362 | char *external_name = info->next_external_char; | |
363 | char *result = NULL; | |
364 | acpi_native_uint i; | |
1da177e4 | 365 | |
4be44fcd | 366 | ACPI_FUNCTION_TRACE("ns_build_internal_name"); |
1da177e4 LT |
367 | |
368 | /* Setup the correct prefixes, counts, and pointers */ | |
369 | ||
370 | if (info->fully_qualified) { | |
371 | internal_name[0] = '\\'; | |
372 | ||
373 | if (num_segments <= 1) { | |
374 | result = &internal_name[1]; | |
4be44fcd | 375 | } else if (num_segments == 2) { |
1da177e4 LT |
376 | internal_name[1] = AML_DUAL_NAME_PREFIX; |
377 | result = &internal_name[2]; | |
4be44fcd | 378 | } else { |
1da177e4 | 379 | internal_name[1] = AML_MULTI_NAME_PREFIX_OP; |
4be44fcd | 380 | internal_name[2] = (char)num_segments; |
1da177e4 LT |
381 | result = &internal_name[3]; |
382 | } | |
4be44fcd | 383 | } else { |
1da177e4 LT |
384 | /* |
385 | * Not fully qualified. | |
386 | * Handle Carats first, then append the name segments | |
387 | */ | |
388 | i = 0; | |
389 | if (info->num_carats) { | |
390 | for (i = 0; i < info->num_carats; i++) { | |
391 | internal_name[i] = '^'; | |
392 | } | |
393 | } | |
394 | ||
395 | if (num_segments <= 1) { | |
396 | result = &internal_name[i]; | |
4be44fcd | 397 | } else if (num_segments == 2) { |
1da177e4 | 398 | internal_name[i] = AML_DUAL_NAME_PREFIX; |
4be44fcd LB |
399 | result = &internal_name[(acpi_native_uint) (i + 1)]; |
400 | } else { | |
1da177e4 | 401 | internal_name[i] = AML_MULTI_NAME_PREFIX_OP; |
4be44fcd LB |
402 | internal_name[(acpi_native_uint) (i + 1)] = |
403 | (char)num_segments; | |
404 | result = &internal_name[(acpi_native_uint) (i + 2)]; | |
1da177e4 LT |
405 | } |
406 | } | |
407 | ||
408 | /* Build the name (minus path separators) */ | |
409 | ||
410 | for (; num_segments; num_segments--) { | |
411 | for (i = 0; i < ACPI_NAME_SIZE; i++) { | |
4be44fcd LB |
412 | if (acpi_ns_valid_path_separator(*external_name) || |
413 | (*external_name == 0)) { | |
1da177e4 LT |
414 | /* Pad the segment with underscore(s) if segment is short */ |
415 | ||
416 | result[i] = '_'; | |
4be44fcd | 417 | } else { |
1da177e4 LT |
418 | /* Convert the character to uppercase and save it */ |
419 | ||
4be44fcd LB |
420 | result[i] = |
421 | (char)ACPI_TOUPPER((int)*external_name); | |
1da177e4 LT |
422 | external_name++; |
423 | } | |
424 | } | |
425 | ||
426 | /* Now we must have a path separator, or the pathname is bad */ | |
427 | ||
4be44fcd LB |
428 | if (!acpi_ns_valid_path_separator(*external_name) && |
429 | (*external_name != 0)) { | |
430 | return_ACPI_STATUS(AE_BAD_PARAMETER); | |
1da177e4 LT |
431 | } |
432 | ||
433 | /* Move on the next segment */ | |
434 | ||
435 | external_name++; | |
436 | result += ACPI_NAME_SIZE; | |
437 | } | |
438 | ||
439 | /* Terminate the string */ | |
440 | ||
441 | *result = 0; | |
442 | ||
443 | if (info->fully_qualified) { | |
4be44fcd LB |
444 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, |
445 | "Returning [%p] (abs) \"\\%s\"\n", | |
446 | internal_name, internal_name)); | |
447 | } else { | |
448 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Returning [%p] (rel) \"%s\"\n", | |
449 | internal_name, internal_name)); | |
1da177e4 LT |
450 | } |
451 | ||
4be44fcd | 452 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
453 | } |
454 | ||
1da177e4 LT |
455 | /******************************************************************************* |
456 | * | |
457 | * FUNCTION: acpi_ns_internalize_name | |
458 | * | |
459 | * PARAMETERS: *external_name - External representation of name | |
460 | * **Converted Name - Where to return the resulting | |
461 | * internal represention of the name | |
462 | * | |
463 | * RETURN: Status | |
464 | * | |
465 | * DESCRIPTION: Convert an external representation (e.g. "\_PR_.CPU0") | |
466 | * to internal form (e.g. 5c 2f 02 5f 50 52 5f 43 50 55 30) | |
467 | * | |
468 | *******************************************************************************/ | |
469 | ||
4be44fcd | 470 | acpi_status acpi_ns_internalize_name(char *external_name, char **converted_name) |
1da177e4 | 471 | { |
4be44fcd LB |
472 | char *internal_name; |
473 | struct acpi_namestring_info info; | |
474 | acpi_status status; | |
1da177e4 | 475 | |
4be44fcd | 476 | ACPI_FUNCTION_TRACE("ns_internalize_name"); |
1da177e4 | 477 | |
4be44fcd LB |
478 | if ((!external_name) || (*external_name == 0) || (!converted_name)) { |
479 | return_ACPI_STATUS(AE_BAD_PARAMETER); | |
1da177e4 LT |
480 | } |
481 | ||
482 | /* Get the length of the new internal name */ | |
483 | ||
484 | info.external_name = external_name; | |
4be44fcd | 485 | acpi_ns_get_internal_name_length(&info); |
1da177e4 LT |
486 | |
487 | /* We need a segment to store the internal name */ | |
488 | ||
4be44fcd | 489 | internal_name = ACPI_MEM_CALLOCATE(info.length); |
1da177e4 | 490 | if (!internal_name) { |
4be44fcd | 491 | return_ACPI_STATUS(AE_NO_MEMORY); |
1da177e4 LT |
492 | } |
493 | ||
494 | /* Build the name */ | |
495 | ||
496 | info.internal_name = internal_name; | |
4be44fcd LB |
497 | status = acpi_ns_build_internal_name(&info); |
498 | if (ACPI_FAILURE(status)) { | |
499 | ACPI_MEM_FREE(internal_name); | |
500 | return_ACPI_STATUS(status); | |
1da177e4 LT |
501 | } |
502 | ||
503 | *converted_name = internal_name; | |
4be44fcd | 504 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
505 | } |
506 | ||
1da177e4 LT |
507 | /******************************************************************************* |
508 | * | |
509 | * FUNCTION: acpi_ns_externalize_name | |
510 | * | |
44f6c012 RM |
511 | * PARAMETERS: internal_name_length - Lenth of the internal name below |
512 | * internal_name - Internal representation of name | |
513 | * converted_name_length - Where the length is returned | |
514 | * converted_name - Where the resulting external name | |
515 | * is returned | |
1da177e4 LT |
516 | * |
517 | * RETURN: Status | |
518 | * | |
519 | * DESCRIPTION: Convert internal name (e.g. 5c 2f 02 5f 50 52 5f 43 50 55 30) | |
44f6c012 | 520 | * to its external (printable) form (e.g. "\_PR_.CPU0") |
1da177e4 LT |
521 | * |
522 | ******************************************************************************/ | |
523 | ||
524 | acpi_status | |
4be44fcd LB |
525 | acpi_ns_externalize_name(u32 internal_name_length, |
526 | char *internal_name, | |
527 | u32 * converted_name_length, char **converted_name) | |
1da177e4 | 528 | { |
4be44fcd LB |
529 | acpi_native_uint names_index = 0; |
530 | acpi_native_uint num_segments = 0; | |
531 | acpi_native_uint required_length; | |
532 | acpi_native_uint prefix_length = 0; | |
533 | acpi_native_uint i = 0; | |
534 | acpi_native_uint j = 0; | |
1da177e4 | 535 | |
4be44fcd | 536 | ACPI_FUNCTION_TRACE("ns_externalize_name"); |
1da177e4 | 537 | |
4be44fcd LB |
538 | if (!internal_name_length || !internal_name || !converted_name) { |
539 | return_ACPI_STATUS(AE_BAD_PARAMETER); | |
1da177e4 LT |
540 | } |
541 | ||
542 | /* | |
543 | * Check for a prefix (one '\' | one or more '^'). | |
544 | */ | |
545 | switch (internal_name[0]) { | |
546 | case '\\': | |
547 | prefix_length = 1; | |
548 | break; | |
549 | ||
550 | case '^': | |
551 | for (i = 0; i < internal_name_length; i++) { | |
552 | if (internal_name[i] == '^') { | |
553 | prefix_length = i + 1; | |
4be44fcd | 554 | } else { |
1da177e4 LT |
555 | break; |
556 | } | |
557 | } | |
558 | ||
559 | if (i == internal_name_length) { | |
560 | prefix_length = i; | |
561 | } | |
562 | ||
563 | break; | |
564 | ||
565 | default: | |
566 | break; | |
567 | } | |
568 | ||
569 | /* | |
570 | * Check for object names. Note that there could be 0-255 of these | |
571 | * 4-byte elements. | |
572 | */ | |
573 | if (prefix_length < internal_name_length) { | |
574 | switch (internal_name[prefix_length]) { | |
575 | case AML_MULTI_NAME_PREFIX_OP: | |
576 | ||
577 | /* <count> 4-byte names */ | |
578 | ||
579 | names_index = prefix_length + 2; | |
580 | num_segments = (acpi_native_uint) (u8) | |
4be44fcd LB |
581 | internal_name[(acpi_native_uint) |
582 | (prefix_length + 1)]; | |
1da177e4 LT |
583 | break; |
584 | ||
585 | case AML_DUAL_NAME_PREFIX: | |
586 | ||
587 | /* Two 4-byte names */ | |
588 | ||
589 | names_index = prefix_length + 1; | |
590 | num_segments = 2; | |
591 | break; | |
592 | ||
593 | case 0: | |
594 | ||
595 | /* null_name */ | |
596 | ||
597 | names_index = 0; | |
598 | num_segments = 0; | |
599 | break; | |
600 | ||
601 | default: | |
602 | ||
603 | /* one 4-byte name */ | |
604 | ||
605 | names_index = prefix_length; | |
606 | num_segments = 1; | |
607 | break; | |
608 | } | |
609 | } | |
610 | ||
611 | /* | |
612 | * Calculate the length of converted_name, which equals the length | |
613 | * of the prefix, length of all object names, length of any required | |
614 | * punctuation ('.') between object names, plus the NULL terminator. | |
615 | */ | |
616 | required_length = prefix_length + (4 * num_segments) + | |
4be44fcd | 617 | ((num_segments > 0) ? (num_segments - 1) : 0) + 1; |
1da177e4 LT |
618 | |
619 | /* | |
620 | * Check to see if we're still in bounds. If not, there's a problem | |
621 | * with internal_name (invalid format). | |
622 | */ | |
623 | if (required_length > internal_name_length) { | |
4a90c7e8 | 624 | ACPI_REPORT_ERROR(("Invalid internal name\n")); |
4be44fcd | 625 | return_ACPI_STATUS(AE_BAD_PATHNAME); |
1da177e4 LT |
626 | } |
627 | ||
628 | /* | |
629 | * Build converted_name | |
630 | */ | |
4be44fcd | 631 | *converted_name = ACPI_MEM_CALLOCATE(required_length); |
1da177e4 | 632 | if (!(*converted_name)) { |
4be44fcd | 633 | return_ACPI_STATUS(AE_NO_MEMORY); |
1da177e4 LT |
634 | } |
635 | ||
636 | j = 0; | |
637 | ||
638 | for (i = 0; i < prefix_length; i++) { | |
639 | (*converted_name)[j++] = internal_name[i]; | |
640 | } | |
641 | ||
642 | if (num_segments > 0) { | |
643 | for (i = 0; i < num_segments; i++) { | |
644 | if (i > 0) { | |
645 | (*converted_name)[j++] = '.'; | |
646 | } | |
647 | ||
648 | (*converted_name)[j++] = internal_name[names_index++]; | |
649 | (*converted_name)[j++] = internal_name[names_index++]; | |
650 | (*converted_name)[j++] = internal_name[names_index++]; | |
651 | (*converted_name)[j++] = internal_name[names_index++]; | |
652 | } | |
653 | } | |
654 | ||
655 | if (converted_name_length) { | |
656 | *converted_name_length = (u32) required_length; | |
657 | } | |
658 | ||
4be44fcd | 659 | return_ACPI_STATUS(AE_OK); |
1da177e4 LT |
660 | } |
661 | ||
1da177e4 LT |
662 | /******************************************************************************* |
663 | * | |
664 | * FUNCTION: acpi_ns_map_handle_to_node | |
665 | * | |
666 | * PARAMETERS: Handle - Handle to be converted to an Node | |
667 | * | |
668 | * RETURN: A Name table entry pointer | |
669 | * | |
670 | * DESCRIPTION: Convert a namespace handle to a real Node | |
671 | * | |
44f6c012 RM |
672 | * Note: Real integer handles would allow for more verification |
673 | * and keep all pointers within this subsystem - however this introduces | |
674 | * more (and perhaps unnecessary) overhead. | |
1da177e4 LT |
675 | * |
676 | ******************************************************************************/ | |
677 | ||
4be44fcd | 678 | struct acpi_namespace_node *acpi_ns_map_handle_to_node(acpi_handle handle) |
1da177e4 LT |
679 | { |
680 | ||
4be44fcd | 681 | ACPI_FUNCTION_ENTRY(); |
1da177e4 LT |
682 | |
683 | /* | |
684 | * Simple implementation. | |
685 | */ | |
686 | if (!handle) { | |
687 | return (NULL); | |
688 | } | |
689 | ||
690 | if (handle == ACPI_ROOT_OBJECT) { | |
691 | return (acpi_gbl_root_node); | |
692 | } | |
693 | ||
694 | /* We can at least attempt to verify the handle */ | |
695 | ||
4be44fcd | 696 | if (ACPI_GET_DESCRIPTOR_TYPE(handle) != ACPI_DESC_TYPE_NAMED) { |
1da177e4 LT |
697 | return (NULL); |
698 | } | |
699 | ||
4be44fcd | 700 | return ((struct acpi_namespace_node *)handle); |
1da177e4 LT |
701 | } |
702 | ||
1da177e4 LT |
703 | /******************************************************************************* |
704 | * | |
705 | * FUNCTION: acpi_ns_convert_entry_to_handle | |
706 | * | |
707 | * PARAMETERS: Node - Node to be converted to a Handle | |
708 | * | |
709 | * RETURN: A user handle | |
710 | * | |
711 | * DESCRIPTION: Convert a real Node to a namespace handle | |
712 | * | |
713 | ******************************************************************************/ | |
714 | ||
4be44fcd | 715 | acpi_handle acpi_ns_convert_entry_to_handle(struct acpi_namespace_node *node) |
1da177e4 LT |
716 | { |
717 | ||
1da177e4 LT |
718 | /* |
719 | * Simple implementation for now; | |
720 | */ | |
721 | return ((acpi_handle) node); | |
722 | ||
44f6c012 | 723 | /* Example future implementation --------------------- |
1da177e4 LT |
724 | |
725 | if (!Node) | |
726 | { | |
727 | return (NULL); | |
728 | } | |
729 | ||
730 | if (Node == acpi_gbl_root_node) | |
731 | { | |
732 | return (ACPI_ROOT_OBJECT); | |
733 | } | |
734 | ||
1da177e4 LT |
735 | return ((acpi_handle) Node); |
736 | ------------------------------------------------------*/ | |
737 | } | |
738 | ||
1da177e4 LT |
739 | /******************************************************************************* |
740 | * | |
741 | * FUNCTION: acpi_ns_terminate | |
742 | * | |
743 | * PARAMETERS: none | |
744 | * | |
745 | * RETURN: none | |
746 | * | |
44f6c012 | 747 | * DESCRIPTION: free memory allocated for namespace and ACPI table storage. |
1da177e4 LT |
748 | * |
749 | ******************************************************************************/ | |
750 | ||
4be44fcd | 751 | void acpi_ns_terminate(void) |
1da177e4 | 752 | { |
4be44fcd | 753 | union acpi_operand_object *obj_desc; |
1da177e4 | 754 | |
4be44fcd | 755 | ACPI_FUNCTION_TRACE("ns_terminate"); |
1da177e4 LT |
756 | |
757 | /* | |
758 | * 1) Free the entire namespace -- all nodes and objects | |
759 | * | |
760 | * Delete all object descriptors attached to namepsace nodes | |
761 | */ | |
4be44fcd | 762 | acpi_ns_delete_namespace_subtree(acpi_gbl_root_node); |
1da177e4 LT |
763 | |
764 | /* Detach any objects attached to the root */ | |
765 | ||
4be44fcd | 766 | obj_desc = acpi_ns_get_attached_object(acpi_gbl_root_node); |
1da177e4 | 767 | if (obj_desc) { |
4be44fcd | 768 | acpi_ns_detach_object(acpi_gbl_root_node); |
1da177e4 LT |
769 | } |
770 | ||
4be44fcd | 771 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Namespace freed\n")); |
1da177e4 LT |
772 | |
773 | /* | |
774 | * 2) Now we can delete the ACPI tables | |
775 | */ | |
4be44fcd LB |
776 | acpi_tb_delete_all_tables(); |
777 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "ACPI Tables freed\n")); | |
1da177e4 LT |
778 | |
779 | return_VOID; | |
780 | } | |
781 | ||
1da177e4 LT |
782 | /******************************************************************************* |
783 | * | |
784 | * FUNCTION: acpi_ns_opens_scope | |
785 | * | |
786 | * PARAMETERS: Type - A valid namespace type | |
787 | * | |
788 | * RETURN: NEWSCOPE if the passed type "opens a name scope" according | |
789 | * to the ACPI specification, else 0 | |
790 | * | |
791 | ******************************************************************************/ | |
792 | ||
4be44fcd | 793 | u32 acpi_ns_opens_scope(acpi_object_type type) |
1da177e4 | 794 | { |
4be44fcd | 795 | ACPI_FUNCTION_TRACE_STR("ns_opens_scope", acpi_ut_get_type_name(type)); |
1da177e4 | 796 | |
4be44fcd | 797 | if (!acpi_ut_valid_object_type(type)) { |
1da177e4 LT |
798 | /* type code out of range */ |
799 | ||
4a90c7e8 | 800 | ACPI_REPORT_WARNING(("Invalid Object Type %X\n", type)); |
50eca3eb | 801 | return_UINT32(ACPI_NS_NORMAL); |
1da177e4 LT |
802 | } |
803 | ||
50eca3eb | 804 | return_UINT32(((u32) acpi_gbl_ns_properties[type]) & ACPI_NS_NEWSCOPE); |
1da177e4 LT |
805 | } |
806 | ||
1da177e4 LT |
807 | /******************************************************************************* |
808 | * | |
809 | * FUNCTION: acpi_ns_get_node_by_path | |
810 | * | |
811 | * PARAMETERS: *Pathname - Name to be found, in external (ASL) format. The | |
812 | * \ (backslash) and ^ (carat) prefixes, and the | |
813 | * . (period) to separate segments are supported. | |
814 | * start_node - Root of subtree to be searched, or NS_ALL for the | |
815 | * root of the name space. If Name is fully | |
816 | * qualified (first s8 is '\'), the passed value | |
817 | * of Scope will not be accessed. | |
818 | * Flags - Used to indicate whether to perform upsearch or | |
819 | * not. | |
820 | * return_node - Where the Node is returned | |
821 | * | |
822 | * DESCRIPTION: Look up a name relative to a given scope and return the | |
823 | * corresponding Node. NOTE: Scope can be null. | |
824 | * | |
825 | * MUTEX: Locks namespace | |
826 | * | |
827 | ******************************************************************************/ | |
828 | ||
829 | acpi_status | |
4be44fcd LB |
830 | acpi_ns_get_node_by_path(char *pathname, |
831 | struct acpi_namespace_node *start_node, | |
832 | u32 flags, struct acpi_namespace_node **return_node) | |
1da177e4 | 833 | { |
4be44fcd LB |
834 | union acpi_generic_state scope_info; |
835 | acpi_status status; | |
836 | char *internal_path = NULL; | |
1da177e4 | 837 | |
4be44fcd | 838 | ACPI_FUNCTION_TRACE_PTR("ns_get_node_by_path", pathname); |
1da177e4 LT |
839 | |
840 | if (pathname) { | |
841 | /* Convert path to internal representation */ | |
842 | ||
4be44fcd LB |
843 | status = acpi_ns_internalize_name(pathname, &internal_path); |
844 | if (ACPI_FAILURE(status)) { | |
845 | return_ACPI_STATUS(status); | |
1da177e4 LT |
846 | } |
847 | } | |
848 | ||
849 | /* Must lock namespace during lookup */ | |
850 | ||
4be44fcd LB |
851 | status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE); |
852 | if (ACPI_FAILURE(status)) { | |
1da177e4 LT |
853 | goto cleanup; |
854 | } | |
855 | ||
856 | /* Setup lookup scope (search starting point) */ | |
857 | ||
858 | scope_info.scope.node = start_node; | |
859 | ||
860 | /* Lookup the name in the namespace */ | |
861 | ||
4be44fcd LB |
862 | status = acpi_ns_lookup(&scope_info, internal_path, |
863 | ACPI_TYPE_ANY, ACPI_IMODE_EXECUTE, | |
864 | (flags | ACPI_NS_DONT_OPEN_SCOPE), | |
865 | NULL, return_node); | |
866 | if (ACPI_FAILURE(status)) { | |
867 | ACPI_DEBUG_PRINT((ACPI_DB_INFO, "%s, %s\n", | |
868 | internal_path, | |
869 | acpi_format_exception(status))); | |
1da177e4 LT |
870 | } |
871 | ||
4be44fcd | 872 | (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE); |
1da177e4 | 873 | |
4be44fcd | 874 | cleanup: |
1da177e4 | 875 | if (internal_path) { |
4be44fcd | 876 | ACPI_MEM_FREE(internal_path); |
1da177e4 | 877 | } |
4be44fcd | 878 | return_ACPI_STATUS(status); |
1da177e4 LT |
879 | } |
880 | ||
1da177e4 LT |
881 | /******************************************************************************* |
882 | * | |
883 | * FUNCTION: acpi_ns_get_parent_node | |
884 | * | |
885 | * PARAMETERS: Node - Current table entry | |
886 | * | |
887 | * RETURN: Parent entry of the given entry | |
888 | * | |
889 | * DESCRIPTION: Obtain the parent entry for a given entry in the namespace. | |
890 | * | |
891 | ******************************************************************************/ | |
892 | ||
4be44fcd LB |
893 | struct acpi_namespace_node *acpi_ns_get_parent_node(struct acpi_namespace_node |
894 | *node) | |
1da177e4 | 895 | { |
4be44fcd | 896 | ACPI_FUNCTION_ENTRY(); |
1da177e4 LT |
897 | |
898 | if (!node) { | |
899 | return (NULL); | |
900 | } | |
901 | ||
902 | /* | |
903 | * Walk to the end of this peer list. The last entry is marked with a flag | |
904 | * and the peer pointer is really a pointer back to the parent. This saves | |
905 | * putting a parent back pointer in each and every named object! | |
906 | */ | |
907 | while (!(node->flags & ANOBJ_END_OF_PEER_LIST)) { | |
908 | node = node->peer; | |
909 | } | |
910 | ||
1da177e4 LT |
911 | return (node->peer); |
912 | } | |
913 | ||
1da177e4 LT |
914 | /******************************************************************************* |
915 | * | |
916 | * FUNCTION: acpi_ns_get_next_valid_node | |
917 | * | |
918 | * PARAMETERS: Node - Current table entry | |
919 | * | |
920 | * RETURN: Next valid Node in the linked node list. NULL if no more valid | |
921 | * nodes. | |
922 | * | |
923 | * DESCRIPTION: Find the next valid node within a name table. | |
924 | * Useful for implementing NULL-end-of-list loops. | |
925 | * | |
926 | ******************************************************************************/ | |
927 | ||
4be44fcd LB |
928 | struct acpi_namespace_node *acpi_ns_get_next_valid_node(struct |
929 | acpi_namespace_node | |
930 | *node) | |
1da177e4 LT |
931 | { |
932 | ||
933 | /* If we are at the end of this peer list, return NULL */ | |
934 | ||
935 | if (node->flags & ANOBJ_END_OF_PEER_LIST) { | |
936 | return NULL; | |
937 | } | |
938 | ||
939 | /* Otherwise just return the next peer */ | |
940 | ||
941 | return (node->peer); | |
942 | } | |
943 | ||
44f6c012 RM |
944 | #ifdef ACPI_OBSOLETE_FUNCTIONS |
945 | /******************************************************************************* | |
946 | * | |
947 | * FUNCTION: acpi_ns_find_parent_name | |
948 | * | |
949 | * PARAMETERS: *child_node - Named Obj whose name is to be found | |
950 | * | |
951 | * RETURN: The ACPI name | |
952 | * | |
953 | * DESCRIPTION: Search for the given obj in its parent scope and return the | |
954 | * name segment, or "????" if the parent name can't be found | |
955 | * (which "should not happen"). | |
956 | * | |
957 | ******************************************************************************/ | |
958 | ||
4be44fcd | 959 | acpi_name acpi_ns_find_parent_name(struct acpi_namespace_node * child_node) |
44f6c012 | 960 | { |
4be44fcd | 961 | struct acpi_namespace_node *parent_node; |
44f6c012 | 962 | |
4be44fcd | 963 | ACPI_FUNCTION_TRACE("ns_find_parent_name"); |
44f6c012 RM |
964 | |
965 | if (child_node) { | |
966 | /* Valid entry. Get the parent Node */ | |
967 | ||
4be44fcd | 968 | parent_node = acpi_ns_get_parent_node(child_node); |
44f6c012 | 969 | if (parent_node) { |
4be44fcd LB |
970 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, |
971 | "Parent of %p [%4.4s] is %p [%4.4s]\n", | |
972 | child_node, | |
973 | acpi_ut_get_node_name(child_node), | |
974 | parent_node, | |
975 | acpi_ut_get_node_name(parent_node))); | |
44f6c012 RM |
976 | |
977 | if (parent_node->name.integer) { | |
4be44fcd LB |
978 | return_VALUE((acpi_name) parent_node->name. |
979 | integer); | |
44f6c012 RM |
980 | } |
981 | } | |
982 | ||
4be44fcd LB |
983 | ACPI_DEBUG_PRINT((ACPI_DB_EXEC, |
984 | "Unable to find parent of %p (%4.4s)\n", | |
985 | child_node, | |
986 | acpi_ut_get_node_name(child_node))); | |
44f6c012 RM |
987 | } |
988 | ||
4be44fcd | 989 | return_VALUE(ACPI_UNKNOWN_NAME); |
44f6c012 RM |
990 | } |
991 | #endif |