drivers/acpi/acpica/nsxfobj.c

   1 /*******************************************************************************
   2  *
   3  * Module Name: nsxfobj - Public interfaces to the ACPI subsystem
   4  *                         ACPI Object oriented interfaces
   5  *
   6  ******************************************************************************/
   7
   8 /*
   9  * Copyright (C) 2000 - 2008, Intel Corp.
  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 "accommon.h"
  47 #include "acnamesp.h"
  48
  49 #define _COMPONENT          ACPI_NAMESPACE
  50 ACPI_MODULE_NAME("nsxfobj")
  51
  52 /*******************************************************************************
  53  *
  54  * FUNCTION:    acpi_get_id
  55  *
  56  * PARAMETERS:  Handle          - Handle of object whose id is desired
  57  *              ret_id          - Where the id will be placed
  58  *
  59  * RETURN:      Status
  60  *
  61  * DESCRIPTION: This routine returns the owner id associated with a handle
  62  *
  63  ******************************************************************************/
  64 acpi_status acpi_get_id(acpi_handle handle, acpi_owner_id * ret_id)
  65 {
  66         struct acpi_namespace_node *node;
  67         acpi_status status;
  68
  69         /* Parameter Validation */
  70
  71         if (!ret_id) {
  72                 return (AE_BAD_PARAMETER);
  73         }
  74
  75         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  76         if (ACPI_FAILURE(status)) {
  77                 return (status);
  78         }
  79
  80         /* Convert and validate the handle */
  81
  82         node = acpi_ns_map_handle_to_node(handle);
  83         if (!node) {
  84                 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  85                 return (AE_BAD_PARAMETER);
  86         }
  87
  88         *ret_id = node->owner_id;
  89
  90         status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  91         return (status);
  92 }
  93
  94 ACPI_EXPORT_SYMBOL(acpi_get_id)
  95
  96 /*******************************************************************************
  97  *
  98  * FUNCTION:    acpi_get_type
  99  *
 100  * PARAMETERS:  Handle          - Handle of object whose type is desired
 101  *              ret_type        - Where the type will be placed
 102  *
 103  * RETURN:      Status
 104  *
 105  * DESCRIPTION: This routine returns the type associatd with a particular handle
 106  *
 107  ******************************************************************************/
 108 acpi_status acpi_get_type(acpi_handle handle, acpi_object_type * ret_type)
 109 {
 110         struct acpi_namespace_node *node;
 111         acpi_status status;
 112
 113         /* Parameter Validation */
 114
 115         if (!ret_type) {
 116                 return (AE_BAD_PARAMETER);
 117         }
 118
 119         /*
 120          * Special case for the predefined Root Node
 121          * (return type ANY)
 122          */
 123         if (handle == ACPI_ROOT_OBJECT) {
 124                 *ret_type = ACPI_TYPE_ANY;
 125                 return (AE_OK);
 126         }
 127
 128         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 129         if (ACPI_FAILURE(status)) {
 130                 return (status);
 131         }
 132
 133         /* Convert and validate the handle */
 134
 135         node = acpi_ns_map_handle_to_node(handle);
 136         if (!node) {
 137                 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 138                 return (AE_BAD_PARAMETER);
 139         }
 140
 141         *ret_type = node->type;
 142
 143         status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 144         return (status);
 145 }
 146
 147 ACPI_EXPORT_SYMBOL(acpi_get_type)
 148
 149 /*******************************************************************************
 150  *
 151  * FUNCTION:    acpi_get_parent
 152  *
 153  * PARAMETERS:  Handle          - Handle of object whose parent is desired
 154  *              ret_handle      - Where the parent handle will be placed
 155  *
 156  * RETURN:      Status
 157  *
 158  * DESCRIPTION: Returns a handle to the parent of the object represented by
 159  *              Handle.
 160  *
 161  ******************************************************************************/
 162 acpi_status acpi_get_parent(acpi_handle handle, acpi_handle * ret_handle)
 163 {
 164         struct acpi_namespace_node *node;
 165         acpi_status status;
 166
 167         if (!ret_handle) {
 168                 return (AE_BAD_PARAMETER);
 169         }
 170
 171         /* Special case for the predefined Root Node (no parent) */
 172
 173         if (handle == ACPI_ROOT_OBJECT) {
 174                 return (AE_NULL_ENTRY);
 175         }
 176
 177         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 178         if (ACPI_FAILURE(status)) {
 179                 return (status);
 180         }
 181
 182         /* Convert and validate the handle */
 183
 184         node = acpi_ns_map_handle_to_node(handle);
 185         if (!node) {
 186                 status = AE_BAD_PARAMETER;
 187                 goto unlock_and_exit;
 188         }
 189
 190         /* Get the parent entry */
 191
 192         *ret_handle =
 193             acpi_ns_convert_entry_to_handle(acpi_ns_get_parent_node(node));
 194
 195         /* Return exception if parent is null */
 196
 197         if (!acpi_ns_get_parent_node(node)) {
 198                 status = AE_NULL_ENTRY;
 199         }
 200
 201       unlock_and_exit:
 202
 203         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 204         return (status);
 205 }
 206
 207 ACPI_EXPORT_SYMBOL(acpi_get_parent)
 208
 209 /*******************************************************************************
 210  *
 211  * FUNCTION:    acpi_get_next_object
 212  *
 213  * PARAMETERS:  Type            - Type of object to be searched for
 214  *              Parent          - Parent object whose children we are getting
 215  *              last_child      - Previous child that was found.
 216  *                                The NEXT child will be returned
 217  *              ret_handle      - Where handle to the next object is placed
 218  *
 219  * RETURN:      Status
 220  *
 221  * DESCRIPTION: Return the next peer object within the namespace.  If Handle is
 222  *              valid, Scope is ignored.  Otherwise, the first object within
 223  *              Scope is returned.
 224  *
 225  ******************************************************************************/
 226 acpi_status
 227 acpi_get_next_object(acpi_object_type type,
 228                      acpi_handle parent,
 229                      acpi_handle child, acpi_handle * ret_handle)
 230 {
 231         acpi_status status;
 232         struct acpi_namespace_node *node;
 233         struct acpi_namespace_node *parent_node = NULL;
 234         struct acpi_namespace_node *child_node = NULL;
 235
 236         /* Parameter validation */
 237
 238         if (type > ACPI_TYPE_EXTERNAL_MAX) {
 239                 return (AE_BAD_PARAMETER);
 240         }
 241
 242         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 243         if (ACPI_FAILURE(status)) {
 244                 return (status);
 245         }
 246
 247         /* If null handle, use the parent */
 248
 249         if (!child) {
 250
 251                 /* Start search at the beginning of the specified scope */
 252
 253                 parent_node = acpi_ns_map_handle_to_node(parent);
 254                 if (!parent_node) {
 255                         status = AE_BAD_PARAMETER;
 256                         goto unlock_and_exit;
 257                 }
 258         } else {
 259                 /* Non-null handle, ignore the parent */
 260                 /* Convert and validate the handle */
 261
 262                 child_node = acpi_ns_map_handle_to_node(child);
 263                 if (!child_node) {
 264                         status = AE_BAD_PARAMETER;
 265                         goto unlock_and_exit;
 266                 }
 267         }
 268
 269         /* Internal function does the real work */
 270
 271         node = acpi_ns_get_next_node(type, parent_node, child_node);
 272         if (!node) {
 273                 status = AE_NOT_FOUND;
 274                 goto unlock_and_exit;
 275         }
 276
 277         if (ret_handle) {
 278                 *ret_handle = acpi_ns_convert_entry_to_handle(node);
 279         }
 280
 281       unlock_and_exit:
 282
 283         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 284         return (status);
 285 }
 286
 287 ACPI_EXPORT_SYMBOL(acpi_get_next_object)