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