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