drivers/acpi/namespace/nsutils.c

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