1
/******************************************************************************
3
* Module Name: nsutils - Utilities for accessing ACPI namespace, accessing
4
* parents and siblings and Scope manipulation
6
*****************************************************************************/
9
* Copyright (C) 2000 - 2011, Intel Corp.
10
* All rights reserved.
12
* Redistribution and use in source and binary forms, with or without
13
* modification, are permitted provided that the following conditions
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.
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.
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.
45
#include <acpi/acpi.h>
51
#define _COMPONENT ACPI_NAMESPACE
52
ACPI_MODULE_NAME("nsutils")
54
/* Local prototypes */
55
static u8 acpi_ns_valid_path_separator(char sep);
57
#ifdef ACPI_OBSOLETE_FUNCTIONS
58
acpi_name acpi_ns_find_parent_name(struct acpi_namespace_node *node_to_search);
61
/*******************************************************************************
63
* FUNCTION: acpi_ns_print_node_pathname
65
* PARAMETERS: Node - Object
66
* Message - Prefix message
68
* DESCRIPTION: Print an object's full namespace pathname
69
* Manages allocation/freeing of a pathname buffer
71
******************************************************************************/
74
acpi_ns_print_node_pathname(struct acpi_namespace_node *node,
77
struct acpi_buffer buffer;
81
acpi_os_printf("[NULL NAME]");
85
/* Convert handle to full pathname and print it (with supplied message) */
87
buffer.length = ACPI_ALLOCATE_LOCAL_BUFFER;
89
status = acpi_ns_handle_to_pathname(node, &buffer);
90
if (ACPI_SUCCESS(status)) {
92
acpi_os_printf("%s ", message);
95
acpi_os_printf("[%s] (Node %p)", (char *)buffer.pointer, node);
96
ACPI_FREE(buffer.pointer);
100
/*******************************************************************************
102
* FUNCTION: acpi_ns_valid_root_prefix
104
* PARAMETERS: Prefix - Character to be checked
106
* RETURN: TRUE if a valid prefix
108
* DESCRIPTION: Check if a character is a valid ACPI Root prefix
110
******************************************************************************/
112
u8 acpi_ns_valid_root_prefix(char prefix)
115
return ((u8) (prefix == '\\'));
118
/*******************************************************************************
120
* FUNCTION: acpi_ns_valid_path_separator
122
* PARAMETERS: Sep - Character to be checked
124
* RETURN: TRUE if a valid path separator
126
* DESCRIPTION: Check if a character is a valid ACPI path separator
128
******************************************************************************/
130
static u8 acpi_ns_valid_path_separator(char sep)
133
return ((u8) (sep == '.'));
136
/*******************************************************************************
138
* FUNCTION: acpi_ns_get_type
140
* PARAMETERS: Node - Parent Node to be examined
142
* RETURN: Type field from Node whose handle is passed
144
* DESCRIPTION: Return the type of a Namespace node
146
******************************************************************************/
148
acpi_object_type acpi_ns_get_type(struct acpi_namespace_node * node)
150
ACPI_FUNCTION_TRACE(ns_get_type);
153
ACPI_WARNING((AE_INFO, "Null Node parameter"));
154
return_UINT32(ACPI_TYPE_ANY);
157
return_UINT32((acpi_object_type) node->type);
160
/*******************************************************************************
162
* FUNCTION: acpi_ns_local
164
* PARAMETERS: Type - A namespace object type
166
* RETURN: LOCAL if names must be found locally in objects of the
167
* passed type, 0 if enclosing scopes should be searched
169
* DESCRIPTION: Returns scope rule for the given object type.
171
******************************************************************************/
173
u32 acpi_ns_local(acpi_object_type type)
175
ACPI_FUNCTION_TRACE(ns_local);
177
if (!acpi_ut_valid_object_type(type)) {
179
/* Type code out of range */
181
ACPI_WARNING((AE_INFO, "Invalid Object Type 0x%X", type));
182
return_UINT32(ACPI_NS_NORMAL);
185
return_UINT32((u32) acpi_gbl_ns_properties[type] & ACPI_NS_LOCAL);
188
/*******************************************************************************
190
* FUNCTION: acpi_ns_get_internal_name_length
192
* PARAMETERS: Info - Info struct initialized with the
193
* external name pointer.
197
* DESCRIPTION: Calculate the length of the internal (AML) namestring
198
* corresponding to the external (ASL) namestring.
200
******************************************************************************/
202
void acpi_ns_get_internal_name_length(struct acpi_namestring_info *info)
204
const char *next_external_char;
207
ACPI_FUNCTION_ENTRY();
209
next_external_char = info->external_name;
210
info->num_carats = 0;
211
info->num_segments = 0;
212
info->fully_qualified = FALSE;
215
* For the internal name, the required length is 4 bytes per segment, plus
216
* 1 each for root_prefix, multi_name_prefix_op, segment count, trailing null
217
* (which is not really needed, but no there's harm in putting it there)
219
* strlen() + 1 covers the first name_seg, which has no path separator
221
if (acpi_ns_valid_root_prefix(*next_external_char)) {
222
info->fully_qualified = TRUE;
223
next_external_char++;
225
/* Skip redundant root_prefix, like \\_SB.PCI0.SBRG.EC0 */
227
while (acpi_ns_valid_root_prefix(*next_external_char)) {
228
next_external_char++;
231
/* Handle Carat prefixes */
233
while (*next_external_char == '^') {
235
next_external_char++;
240
* Determine the number of ACPI name "segments" by counting the number of
241
* path separators within the string. Start with one segment since the
242
* segment count is [(# separators) + 1], and zero separators is ok.
244
if (*next_external_char) {
245
info->num_segments = 1;
246
for (i = 0; next_external_char[i]; i++) {
247
if (acpi_ns_valid_path_separator(next_external_char[i])) {
248
info->num_segments++;
253
info->length = (ACPI_NAME_SIZE * info->num_segments) +
254
4 + info->num_carats;
256
info->next_external_char = next_external_char;
259
/*******************************************************************************
261
* FUNCTION: acpi_ns_build_internal_name
263
* PARAMETERS: Info - Info struct fully initialized
267
* DESCRIPTION: Construct the internal (AML) namestring
268
* corresponding to the external (ASL) namestring.
270
******************************************************************************/
272
acpi_status acpi_ns_build_internal_name(struct acpi_namestring_info *info)
274
u32 num_segments = info->num_segments;
275
char *internal_name = info->internal_name;
276
const char *external_name = info->next_external_char;
280
ACPI_FUNCTION_TRACE(ns_build_internal_name);
282
/* Setup the correct prefixes, counts, and pointers */
284
if (info->fully_qualified) {
285
internal_name[0] = '\\';
287
if (num_segments <= 1) {
288
result = &internal_name[1];
289
} else if (num_segments == 2) {
290
internal_name[1] = AML_DUAL_NAME_PREFIX;
291
result = &internal_name[2];
293
internal_name[1] = AML_MULTI_NAME_PREFIX_OP;
294
internal_name[2] = (char)num_segments;
295
result = &internal_name[3];
299
* Not fully qualified.
300
* Handle Carats first, then append the name segments
303
if (info->num_carats) {
304
for (i = 0; i < info->num_carats; i++) {
305
internal_name[i] = '^';
309
if (num_segments <= 1) {
310
result = &internal_name[i];
311
} else if (num_segments == 2) {
312
internal_name[i] = AML_DUAL_NAME_PREFIX;
313
result = &internal_name[(acpi_size) i + 1];
315
internal_name[i] = AML_MULTI_NAME_PREFIX_OP;
316
internal_name[(acpi_size) i + 1] = (char)num_segments;
317
result = &internal_name[(acpi_size) i + 2];
321
/* Build the name (minus path separators) */
323
for (; num_segments; num_segments--) {
324
for (i = 0; i < ACPI_NAME_SIZE; i++) {
325
if (acpi_ns_valid_path_separator(*external_name) ||
326
(*external_name == 0)) {
328
/* Pad the segment with underscore(s) if segment is short */
332
/* Convert the character to uppercase and save it */
335
(char)ACPI_TOUPPER((int)*external_name);
340
/* Now we must have a path separator, or the pathname is bad */
342
if (!acpi_ns_valid_path_separator(*external_name) &&
343
(*external_name != 0)) {
344
return_ACPI_STATUS(AE_BAD_PARAMETER);
347
/* Move on the next segment */
350
result += ACPI_NAME_SIZE;
353
/* Terminate the string */
357
if (info->fully_qualified) {
358
ACPI_DEBUG_PRINT((ACPI_DB_EXEC,
359
"Returning [%p] (abs) \"\\%s\"\n",
360
internal_name, internal_name));
362
ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "Returning [%p] (rel) \"%s\"\n",
363
internal_name, internal_name));
366
return_ACPI_STATUS(AE_OK);
369
/*******************************************************************************
371
* FUNCTION: acpi_ns_internalize_name
373
* PARAMETERS: *external_name - External representation of name
374
* **Converted Name - Where to return the resulting
375
* internal represention of the name
379
* DESCRIPTION: Convert an external representation (e.g. "\_PR_.CPU0")
380
* to internal form (e.g. 5c 2f 02 5f 50 52 5f 43 50 55 30)
382
*******************************************************************************/
385
acpi_ns_internalize_name(const char *external_name, char **converted_name)
388
struct acpi_namestring_info info;
391
ACPI_FUNCTION_TRACE(ns_internalize_name);
393
if ((!external_name) || (*external_name == 0) || (!converted_name)) {
394
return_ACPI_STATUS(AE_BAD_PARAMETER);
397
/* Get the length of the new internal name */
399
info.external_name = external_name;
400
acpi_ns_get_internal_name_length(&info);
402
/* We need a segment to store the internal name */
404
internal_name = ACPI_ALLOCATE_ZEROED(info.length);
405
if (!internal_name) {
406
return_ACPI_STATUS(AE_NO_MEMORY);
411
info.internal_name = internal_name;
412
status = acpi_ns_build_internal_name(&info);
413
if (ACPI_FAILURE(status)) {
414
ACPI_FREE(internal_name);
415
return_ACPI_STATUS(status);
418
*converted_name = internal_name;
419
return_ACPI_STATUS(AE_OK);
422
/*******************************************************************************
424
* FUNCTION: acpi_ns_externalize_name
426
* PARAMETERS: internal_name_length - Lenth of the internal name below
427
* internal_name - Internal representation of name
428
* converted_name_length - Where the length is returned
429
* converted_name - Where the resulting external name
434
* DESCRIPTION: Convert internal name (e.g. 5c 2f 02 5f 50 52 5f 43 50 55 30)
435
* to its external (printable) form (e.g. "\_PR_.CPU0")
437
******************************************************************************/
440
acpi_ns_externalize_name(u32 internal_name_length,
441
const char *internal_name,
442
u32 * converted_name_length, char **converted_name)
445
u32 num_segments = 0;
447
u32 prefix_length = 0;
451
ACPI_FUNCTION_TRACE(ns_externalize_name);
453
if (!internal_name_length || !internal_name || !converted_name) {
454
return_ACPI_STATUS(AE_BAD_PARAMETER);
457
/* Check for a prefix (one '\' | one or more '^') */
459
switch (internal_name[0]) {
465
for (i = 0; i < internal_name_length; i++) {
466
if (internal_name[i] == '^') {
467
prefix_length = i + 1;
473
if (i == internal_name_length) {
484
* Check for object names. Note that there could be 0-255 of these
487
if (prefix_length < internal_name_length) {
488
switch (internal_name[prefix_length]) {
489
case AML_MULTI_NAME_PREFIX_OP:
491
/* <count> 4-byte names */
493
names_index = prefix_length + 2;
495
internal_name[(acpi_size) prefix_length + 1];
498
case AML_DUAL_NAME_PREFIX:
500
/* Two 4-byte names */
502
names_index = prefix_length + 1;
516
/* one 4-byte name */
518
names_index = prefix_length;
525
* Calculate the length of converted_name, which equals the length
526
* of the prefix, length of all object names, length of any required
527
* punctuation ('.') between object names, plus the NULL terminator.
529
required_length = prefix_length + (4 * num_segments) +
530
((num_segments > 0) ? (num_segments - 1) : 0) + 1;
533
* Check to see if we're still in bounds. If not, there's a problem
534
* with internal_name (invalid format).
536
if (required_length > internal_name_length) {
537
ACPI_ERROR((AE_INFO, "Invalid internal name"));
538
return_ACPI_STATUS(AE_BAD_PATHNAME);
541
/* Build the converted_name */
543
*converted_name = ACPI_ALLOCATE_ZEROED(required_length);
544
if (!(*converted_name)) {
545
return_ACPI_STATUS(AE_NO_MEMORY);
550
for (i = 0; i < prefix_length; i++) {
551
(*converted_name)[j++] = internal_name[i];
554
if (num_segments > 0) {
555
for (i = 0; i < num_segments; i++) {
557
(*converted_name)[j++] = '.';
560
(*converted_name)[j++] = internal_name[names_index++];
561
(*converted_name)[j++] = internal_name[names_index++];
562
(*converted_name)[j++] = internal_name[names_index++];
563
(*converted_name)[j++] = internal_name[names_index++];
567
if (converted_name_length) {
568
*converted_name_length = (u32) required_length;
571
return_ACPI_STATUS(AE_OK);
574
/*******************************************************************************
576
* FUNCTION: acpi_ns_validate_handle
578
* PARAMETERS: Handle - Handle to be validated and typecast to a
581
* RETURN: A pointer to a namespace node
583
* DESCRIPTION: Convert a namespace handle to a namespace node. Handles special
584
* cases for the root node.
586
* NOTE: Real integer handles would allow for more verification
587
* and keep all pointers within this subsystem - however this introduces
588
* more overhead and has not been necessary to this point. Drivers
589
* holding handles are typically notified before a node becomes invalid
590
* due to a table unload.
592
******************************************************************************/
594
struct acpi_namespace_node *acpi_ns_validate_handle(acpi_handle handle)
597
ACPI_FUNCTION_ENTRY();
599
/* Parameter validation */
601
if ((!handle) || (handle == ACPI_ROOT_OBJECT)) {
602
return (acpi_gbl_root_node);
605
/* We can at least attempt to verify the handle */
607
if (ACPI_GET_DESCRIPTOR_TYPE(handle) != ACPI_DESC_TYPE_NAMED) {
611
return (ACPI_CAST_PTR(struct acpi_namespace_node, handle));
614
/*******************************************************************************
616
* FUNCTION: acpi_ns_terminate
622
* DESCRIPTION: free memory allocated for namespace and ACPI table storage.
624
******************************************************************************/
626
void acpi_ns_terminate(void)
628
union acpi_operand_object *obj_desc;
630
ACPI_FUNCTION_TRACE(ns_terminate);
633
* 1) Free the entire namespace -- all nodes and objects
635
* Delete all object descriptors attached to namepsace nodes
637
acpi_ns_delete_namespace_subtree(acpi_gbl_root_node);
639
/* Detach any objects attached to the root */
641
obj_desc = acpi_ns_get_attached_object(acpi_gbl_root_node);
643
acpi_ns_detach_object(acpi_gbl_root_node);
646
ACPI_DEBUG_PRINT((ACPI_DB_INFO, "Namespace freed\n"));
650
/*******************************************************************************
652
* FUNCTION: acpi_ns_opens_scope
654
* PARAMETERS: Type - A valid namespace type
656
* RETURN: NEWSCOPE if the passed type "opens a name scope" according
657
* to the ACPI specification, else 0
659
******************************************************************************/
661
u32 acpi_ns_opens_scope(acpi_object_type type)
663
ACPI_FUNCTION_TRACE_STR(ns_opens_scope, acpi_ut_get_type_name(type));
665
if (!acpi_ut_valid_object_type(type)) {
667
/* type code out of range */
669
ACPI_WARNING((AE_INFO, "Invalid Object Type 0x%X", type));
670
return_UINT32(ACPI_NS_NORMAL);
673
return_UINT32(((u32) acpi_gbl_ns_properties[type]) & ACPI_NS_NEWSCOPE);
676
/*******************************************************************************
678
* FUNCTION: acpi_ns_get_node
680
* PARAMETERS: *Pathname - Name to be found, in external (ASL) format. The
681
* \ (backslash) and ^ (carat) prefixes, and the
682
* . (period) to separate segments are supported.
683
* prefix_node - Root of subtree to be searched, or NS_ALL for the
684
* root of the name space. If Name is fully
685
* qualified (first s8 is '\'), the passed value
686
* of Scope will not be accessed.
687
* Flags - Used to indicate whether to perform upsearch or
689
* return_node - Where the Node is returned
691
* DESCRIPTION: Look up a name relative to a given scope and return the
692
* corresponding Node. NOTE: Scope can be null.
694
* MUTEX: Locks namespace
696
******************************************************************************/
699
acpi_ns_get_node(struct acpi_namespace_node *prefix_node,
700
const char *pathname,
701
u32 flags, struct acpi_namespace_node **return_node)
703
union acpi_generic_state scope_info;
707
ACPI_FUNCTION_TRACE_PTR(ns_get_node, ACPI_CAST_PTR(char, pathname));
710
*return_node = prefix_node;
712
*return_node = acpi_gbl_root_node;
714
return_ACPI_STATUS(AE_OK);
717
/* Convert path to internal representation */
719
status = acpi_ns_internalize_name(pathname, &internal_path);
720
if (ACPI_FAILURE(status)) {
721
return_ACPI_STATUS(status);
724
/* Must lock namespace during lookup */
726
status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
727
if (ACPI_FAILURE(status)) {
731
/* Setup lookup scope (search starting point) */
733
scope_info.scope.node = prefix_node;
735
/* Lookup the name in the namespace */
737
status = acpi_ns_lookup(&scope_info, internal_path, ACPI_TYPE_ANY,
739
(flags | ACPI_NS_DONT_OPEN_SCOPE), NULL,
741
if (ACPI_FAILURE(status)) {
742
ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%s, %s\n",
743
pathname, acpi_format_exception(status)));
746
(void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
749
ACPI_FREE(internal_path);
750
return_ACPI_STATUS(status);