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