git.oblomov.eu Git - linux-2.6/blob - drivers/acpi/namespace/nsxfname.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsxfname - Public interfaces to the ACPI subsystem
   4  *                         ACPI Namespace oriented interfaces
   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
  48 #define _COMPONENT          ACPI_NAMESPACE
  49 ACPI_MODULE_NAME("nsxfname")
  50
  51 /******************************************************************************
  52  *
  53  * FUNCTION:    acpi_get_handle
  54  *
  55  * PARAMETERS:  Parent          - Object to search under (search scope).
  56  *              Pathname        - Pointer to an asciiz string containing the
  57  *                                name
  58  *              ret_handle      - Where the return handle is returned
  59  *
  60  * RETURN:      Status
  61  *
  62  * DESCRIPTION: This routine will search for a caller specified name in the
  63  *              name space.  The caller can restrict the search region by
  64  *              specifying a non NULL parent.  The parent value is itself a
  65  *              namespace handle.
  66  *
  67  ******************************************************************************/
  68 acpi_status
  69 acpi_get_handle(acpi_handle parent,
  70                 acpi_string pathname, acpi_handle * ret_handle)
  71 {
  72         acpi_status status;
  73         struct acpi_namespace_node *node = NULL;
  74         struct acpi_namespace_node *prefix_node = NULL;
  75
  76         ACPI_FUNCTION_ENTRY();
  77
  78         /* Parameter Validation */
  79
  80         if (!ret_handle || !pathname) {
  81                 return (AE_BAD_PARAMETER);
  82         }
  83
  84         /* Convert a parent handle to a prefix node */
  85
  86         if (parent) {
  87                 status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
  88                 if (ACPI_FAILURE(status)) {
  89                         return (status);
  90                 }
  91
  92                 prefix_node = acpi_ns_map_handle_to_node(parent);
  93                 if (!prefix_node) {
  94                         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  95                         return (AE_BAD_PARAMETER);
  96                 }
  97
  98                 status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
  99                 if (ACPI_FAILURE(status)) {
 100                         return (status);
 101                 }
 102         }
 103
 104         /* Special case for root, since we can't search for it */
 105
 106         if (ACPI_STRCMP(pathname, ACPI_NS_ROOT_PATH) == 0) {
 107                 *ret_handle =
 108                     acpi_ns_convert_entry_to_handle(acpi_gbl_root_node);
 109                 return (AE_OK);
 110         }
 111
 112         /*
 113          *  Find the Node and convert to a handle
 114          */
 115         status =
 116             acpi_ns_get_node_by_path(pathname, prefix_node, ACPI_NS_NO_UPSEARCH,
 117                                      &node);
 118
 119         *ret_handle = NULL;
 120         if (ACPI_SUCCESS(status)) {
 121                 *ret_handle = acpi_ns_convert_entry_to_handle(node);
 122         }
 123
 124         return (status);
 125 }
 126
 127 ACPI_EXPORT_SYMBOL(acpi_get_handle)
 128
 129 /******************************************************************************
 130  *
 131  * FUNCTION:    acpi_get_name
 132  *
 133  * PARAMETERS:  Handle          - Handle to be converted to a pathname
 134  *              name_type       - Full pathname or single segment
 135  *              Buffer          - Buffer for returned path
 136  *
 137  * RETURN:      Pointer to a string containing the fully qualified Name.
 138  *
 139  * DESCRIPTION: This routine returns the fully qualified name associated with
 140  *              the Handle parameter.  This and the acpi_pathname_to_handle are
 141  *              complementary functions.
 142  *
 143  ******************************************************************************/
 144 acpi_status
 145 acpi_get_name(acpi_handle handle, u32 name_type, struct acpi_buffer * buffer)
 146 {
 147         acpi_status status;
 148         struct acpi_namespace_node *node;
 149
 150         /* Parameter validation */
 151
 152         if (name_type > ACPI_NAME_TYPE_MAX) {
 153                 return (AE_BAD_PARAMETER);
 154         }
 155
 156         status = acpi_ut_validate_buffer(buffer);
 157         if (ACPI_FAILURE(status)) {
 158                 return (status);
 159         }
 160
 161         if (name_type == ACPI_FULL_PATHNAME) {
 162
 163                 /* Get the full pathname (From the namespace root) */
 164
 165                 status = acpi_ns_handle_to_pathname(handle, buffer);
 166                 return (status);
 167         }
 168
 169         /*
 170          * Wants the single segment ACPI name.
 171          * Validate handle and convert to a namespace Node
 172          */
 173         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 174         if (ACPI_FAILURE(status)) {
 175                 return (status);
 176         }
 177
 178         node = acpi_ns_map_handle_to_node(handle);
 179         if (!node) {
 180                 status = AE_BAD_PARAMETER;
 181                 goto unlock_and_exit;
 182         }
 183
 184         /* Validate/Allocate/Clear caller buffer */
 185
 186         status = acpi_ut_initialize_buffer(buffer, ACPI_PATH_SEGMENT_LENGTH);
 187         if (ACPI_FAILURE(status)) {
 188                 goto unlock_and_exit;
 189         }
 190
 191         /* Just copy the ACPI name from the Node and zero terminate it */
 192
 193         ACPI_STRNCPY(buffer->pointer, acpi_ut_get_node_name(node),
 194                      ACPI_NAME_SIZE);
 195         ((char *)buffer->pointer)[ACPI_NAME_SIZE] = 0;
 196         status = AE_OK;
 197
 198       unlock_and_exit:
 199
 200         (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 201         return (status);
 202 }
 203
 204 ACPI_EXPORT_SYMBOL(acpi_get_name)
 205
 206 /******************************************************************************
 207  *
 208  * FUNCTION:    acpi_get_object_info
 209  *
 210  * PARAMETERS:  Handle          - Object Handle
 211  *              Buffer          - Where the info is returned
 212  *
 213  * RETURN:      Status
 214  *
 215  * DESCRIPTION: Returns information about an object as gleaned from the
 216  *              namespace node and possibly by running several standard
 217  *              control methods (Such as in the case of a device.)
 218  *
 219  ******************************************************************************/
 220 acpi_status
 221 acpi_get_object_info(acpi_handle handle, struct acpi_buffer * buffer)
 222 {
 223         acpi_status status;
 224         struct acpi_namespace_node *node;
 225         struct acpi_device_info *info;
 226         struct acpi_device_info *return_info;
 227         struct acpi_compatible_id_list *cid_list = NULL;
 228         acpi_size size;
 229
 230         /* Parameter validation */
 231
 232         if (!handle || !buffer) {
 233                 return (AE_BAD_PARAMETER);
 234         }
 235
 236         status = acpi_ut_validate_buffer(buffer);
 237         if (ACPI_FAILURE(status)) {
 238                 return (status);
 239         }
 240
 241         info = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_device_info));
 242         if (!info) {
 243                 return (AE_NO_MEMORY);
 244         }
 245
 246         status = acpi_ut_acquire_mutex(ACPI_MTX_NAMESPACE);
 247         if (ACPI_FAILURE(status)) {
 248                 goto cleanup;
 249         }
 250
 251         node = acpi_ns_map_handle_to_node(handle);
 252         if (!node) {
 253                 (void)acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 254                 goto cleanup;
 255         }
 256
 257         /* Init return structure */
 258
 259         size = sizeof(struct acpi_device_info);
 260
 261         info->type = node->type;
 262         info->name = node->name.integer;
 263         info->valid = 0;
 264
 265         status = acpi_ut_release_mutex(ACPI_MTX_NAMESPACE);
 266         if (ACPI_FAILURE(status)) {
 267                 goto cleanup;
 268         }
 269
 270         /* If not a device, we are all done */
 271
 272         if (info->type == ACPI_TYPE_DEVICE) {
 273                 /*
 274                  * Get extra info for ACPI Devices objects only:
 275                  * Run the Device _HID, _UID, _CID, _STA, _ADR and _sx_d methods.
 276                  *
 277                  * Note: none of these methods are required, so they may or may
 278                  * not be present for this device.  The Info->Valid bitfield is used
 279                  * to indicate which methods were found and ran successfully.
 280                  */
 281
 282                 /* Execute the Device._HID method */
 283
 284                 status = acpi_ut_execute_HID(node, &info->hardware_id);
 285                 if (ACPI_SUCCESS(status)) {
 286                         info->valid |= ACPI_VALID_HID;
 287                 }
 288
 289                 /* Execute the Device._UID method */
 290
 291                 status = acpi_ut_execute_UID(node, &info->unique_id);
 292                 if (ACPI_SUCCESS(status)) {
 293                         info->valid |= ACPI_VALID_UID;
 294                 }
 295
 296                 /* Execute the Device._CID method */
 297
 298                 status = acpi_ut_execute_CID(node, &cid_list);
 299                 if (ACPI_SUCCESS(status)) {
 300                         size += cid_list->size;
 301                         info->valid |= ACPI_VALID_CID;
 302                 }
 303
 304                 /* Execute the Device._STA method */
 305
 306                 status = acpi_ut_execute_STA(node, &info->current_status);
 307                 if (ACPI_SUCCESS(status)) {
 308                         info->valid |= ACPI_VALID_STA;
 309                 }
 310
 311                 /* Execute the Device._ADR method */
 312
 313                 status = acpi_ut_evaluate_numeric_object(METHOD_NAME__ADR, node,
 314                                                          &info->address);
 315                 if (ACPI_SUCCESS(status)) {
 316                         info->valid |= ACPI_VALID_ADR;
 317                 }
 318
 319                 /* Execute the Device._sx_d methods */
 320
 321                 status = acpi_ut_execute_sxds(node, info->highest_dstates);
 322                 if (ACPI_SUCCESS(status)) {
 323                         info->valid |= ACPI_VALID_SXDS;
 324                 }
 325         }
 326
 327         /* Validate/Allocate/Clear caller buffer */
 328
 329         status = acpi_ut_initialize_buffer(buffer, size);
 330         if (ACPI_FAILURE(status)) {
 331                 goto cleanup;
 332         }
 333
 334         /* Populate the return buffer */
 335
 336         return_info = buffer->pointer;
 337         ACPI_MEMCPY(return_info, info, sizeof(struct acpi_device_info));
 338
 339         if (cid_list) {
 340                 ACPI_MEMCPY(&return_info->compatibility_id, cid_list,
 341                             cid_list->size);
 342         }
 343
 344       cleanup:
 345         ACPI_FREE(info);
 346         if (cid_list) {
 347                 ACPI_FREE(cid_list);
 348         }
 349         return (status);
 350 }
 351
 352 ACPI_EXPORT_SYMBOL(acpi_get_object_info)