drivers/acpi/namespace/nsnames.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: nsnames - Name manipulation and search
   4  *
   5  ******************************************************************************/
   6
   7 /*
   8  * Copyright (C) 2000 - 2008, Intel Corp.
   9  * All rights reserved.
  10  *
  11  * Redistribution and use in source and binary forms, with or without
  12  * modification, are permitted provided that the following conditions
  13  * are met:
  14  * 1. Redistributions of source code must retain the above copyright
  15  *    notice, this list of conditions, and the following disclaimer,
  16  *    without modification.
  17  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
  18  *    substantially similar to the "NO WARRANTY" disclaimer below
  19  *    ("Disclaimer") and any redistribution must be conditioned upon
  20  *    including a substantially similar Disclaimer requirement for further
  21  *    binary redistribution.
  22  * 3. Neither the names of the above-listed copyright holders nor the names
  23  *    of any contributors may be used to endorse or promote products derived
  24  *    from this software without specific prior written permission.
  25  *
  26  * Alternatively, this software may be distributed under the terms of the
  27  * GNU General Public License ("GPL") version 2 as published by the Free
  28  * Software Foundation.
  29  *
  30  * NO WARRANTY
  31  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
  32  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
  33  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
  34  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
  35  * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  36  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  37  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  38  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
  39  * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
  40  * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  41  * POSSIBILITY OF SUCH DAMAGES.
  42  */
  43
  44 #include <acpi/acpi.h>
  45 #include <acpi/amlcode.h>
  46 #include <acpi/acnamesp.h>
  47
  48 #define _COMPONENT          ACPI_NAMESPACE
  49 ACPI_MODULE_NAME("nsnames")
  50
  51 /*******************************************************************************
  52  *
  53  * FUNCTION:    acpi_ns_build_external_path
  54  *
  55  * PARAMETERS:  Node            - NS node whose pathname is needed
  56  *              Size            - Size of the pathname
  57  *              *name_buffer    - Where to return the pathname
  58  *
  59  * RETURN:      Places the pathname into the name_buffer, in external format
  60  *              (name segments separated by path separators)
  61  *
  62  * DESCRIPTION: Generate a full pathaname
  63  *
  64  ******************************************************************************/
  65 void
  66 acpi_ns_build_external_path(struct acpi_namespace_node *node,
  67                             acpi_size size, char *name_buffer)
  68 {
  69         acpi_size index;
  70         struct acpi_namespace_node *parent_node;
  71
  72         ACPI_FUNCTION_ENTRY();
  73
  74         /* Special case for root */
  75
  76         index = size - 1;
  77         if (index < ACPI_NAME_SIZE) {
  78                 name_buffer[0] = AML_ROOT_PREFIX;
  79                 name_buffer[1] = 0;
  80                 return;
  81         }
  82
  83         /* Store terminator byte, then build name backwards */
  84
  85         parent_node = node;
  86         name_buffer[index] = 0;
  87
  88         while ((index > ACPI_NAME_SIZE) && (parent_node != acpi_gbl_root_node)) {
  89                 index -= ACPI_NAME_SIZE;
  90
  91                 /* Put the name into the buffer */
  92
  93                 ACPI_MOVE_32_TO_32((name_buffer + index), &parent_node->name);
  94                 parent_node = acpi_ns_get_parent_node(parent_node);
  95
  96                 /* Prefix name with the path separator */
  97
  98                 index--;
  99                 name_buffer[index] = ACPI_PATH_SEPARATOR;
 100         }
 101
 102         /* Overwrite final separator with the root prefix character */
 103
 104         name_buffer[index] = AML_ROOT_PREFIX;
 105
 106         if (index != 0) {
 107                 ACPI_ERROR((AE_INFO,
 108                             "Could not construct pathname; index=%X, size=%X, Path=%s",
 109                             (u32) index, (u32) size, &name_buffer[size]));
 110         }
 111
 112         return;
 113 }
 114
 115 #ifdef ACPI_DEBUG_OUTPUT
 116 /*******************************************************************************
 117  *
 118  * FUNCTION:    acpi_ns_get_external_pathname
 119  *
 120  * PARAMETERS:  Node            - Namespace node whose pathname is needed
 121  *
 122  * RETURN:      Pointer to storage containing the fully qualified name of
 123  *              the node, In external format (name segments separated by path
 124  *              separators.)
 125  *
 126  * DESCRIPTION: Used for debug printing in acpi_ns_search_table().
 127  *
 128  ******************************************************************************/
 129
 130 char *acpi_ns_get_external_pathname(struct acpi_namespace_node *node)
 131 {
 132         char *name_buffer;
 133         acpi_size size;
 134
 135         ACPI_FUNCTION_TRACE_PTR(ns_get_external_pathname, node);
 136
 137         /* Calculate required buffer size based on depth below root */
 138
 139         size = acpi_ns_get_pathname_length(node);
 140         if (!size) {
 141                 ACPI_ERROR((AE_INFO, "Invalid node failure"));
 142                 return_PTR(NULL);
 143         }
 144
 145         /* Allocate a buffer to be returned to caller */
 146
 147         name_buffer = ACPI_ALLOCATE_ZEROED(size);
 148         if (!name_buffer) {
 149                 ACPI_ERROR((AE_INFO, "Allocation failure"));
 150                 return_PTR(NULL);
 151         }
 152
 153         /* Build the path in the allocated buffer */
 154
 155         acpi_ns_build_external_path(node, size, name_buffer);
 156         return_PTR(name_buffer);
 157 }
 158 #endif
 159
 160 /*******************************************************************************
 161  *
 162  * FUNCTION:    acpi_ns_get_pathname_length
 163  *
 164  * PARAMETERS:  Node        - Namespace node
 165  *
 166  * RETURN:      Length of path, including prefix
 167  *
 168  * DESCRIPTION: Get the length of the pathname string for this node
 169  *
 170  ******************************************************************************/
 171
 172 acpi_size acpi_ns_get_pathname_length(struct acpi_namespace_node *node)
 173 {
 174         acpi_size size;
 175         struct acpi_namespace_node *next_node;
 176
 177         ACPI_FUNCTION_ENTRY();
 178
 179         /*
 180          * Compute length of pathname as 5 * number of name segments.
 181          * Go back up the parent tree to the root
 182          */
 183         size = 0;
 184         next_node = node;
 185
 186         while (next_node && (next_node != acpi_gbl_root_node)) {
 187                 if (ACPI_GET_DESCRIPTOR_TYPE(next_node) != ACPI_DESC_TYPE_NAMED) {
 188                         ACPI_ERROR((AE_INFO,
 189                                     "Invalid NS Node (%p) while traversing path",
 190                                     next_node));
 191                         return 0;
 192                 }
 193                 size += ACPI_PATH_SEGMENT_LENGTH;
 194                 next_node = acpi_ns_get_parent_node(next_node);
 195         }
 196
 197         if (!size) {
 198                 size = 1;       /* Root node case */
 199         }
 200
 201         return (size + 1);      /* +1 for null string terminator */
 202 }
 203
 204 /*******************************************************************************
 205  *
 206  * FUNCTION:    acpi_ns_handle_to_pathname
 207  *
 208  * PARAMETERS:  target_handle           - Handle of named object whose name is
 209  *                                        to be found
 210  *              Buffer                  - Where the pathname is returned
 211  *
 212  * RETURN:      Status, Buffer is filled with pathname if status is AE_OK
 213  *
 214  * DESCRIPTION: Build and return a full namespace pathname
 215  *
 216  ******************************************************************************/
 217
 218 acpi_status
 219 acpi_ns_handle_to_pathname(acpi_handle target_handle,
 220                            struct acpi_buffer * buffer)
 221 {
 222         acpi_status status;
 223         struct acpi_namespace_node *node;
 224         acpi_size required_size;
 225
 226         ACPI_FUNCTION_TRACE_PTR(ns_handle_to_pathname, target_handle);
 227
 228         node = acpi_ns_map_handle_to_node(target_handle);
 229         if (!node) {
 230                 return_ACPI_STATUS(AE_BAD_PARAMETER);
 231         }
 232
 233         /* Determine size required for the caller buffer */
 234
 235         required_size = acpi_ns_get_pathname_length(node);
 236         if (!required_size) {
 237                 ACPI_ERROR((AE_INFO, "Invalid node failure"));
 238                 return_ACPI_STATUS(AE_ERROR);
 239         }
 240
 241         /* Validate/Allocate/Clear caller buffer */
 242
 243         status = acpi_ut_initialize_buffer(buffer, required_size);
 244         if (ACPI_FAILURE(status)) {
 245                 return_ACPI_STATUS(status);
 246         }
 247
 248         /* Build the path in the caller buffer */
 249
 250         acpi_ns_build_external_path(node, required_size, buffer->pointer);
 251
 252         ACPI_DEBUG_PRINT((ACPI_DB_EXEC, "%s [%X]\n",
 253                           (char *)buffer->pointer, (u32) required_size));
 254         return_ACPI_STATUS(AE_OK);
 255 }