sys/contrib/dev/acpica/nsxfname.c

   1 /******************************************************************************
   2  *
   3  * Module Name: nsxfname - Public interfaces to the ACPI subsystem
   4  *                         ACPI Namespace oriented interfaces
   5  *              $Revision: 94 $
   6  *
   7  *****************************************************************************/
   8
   9 /******************************************************************************
  10  *
  11  * 1. Copyright Notice
  12  *
  13  * Some or all of this work - Copyright (c) 1999 - 2003, Intel Corp.
  14  * All rights reserved.
  15  *
  16  * 2. License
  17  *
  18  * 2.1. This is your license from Intel Corp. under its intellectual property
  19  * rights.  You may have additional license terms from the party that provided
  20  * you this software, covering your right to use that party's intellectual
  21  * property rights.
  22  *
  23  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  24  * copy of the source code appearing in this file ("Covered Code") an
  25  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  26  * base code distributed originally by Intel ("Original Intel Code") to copy,
  27  * make derivatives, distribute, use and display any portion of the Covered
  28  * Code in any form, with the right to sublicense such rights; and
  29  *
  30  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  31  * license (with the right to sublicense), under only those claims of Intel
  32  * patents that are infringed by the Original Intel Code, to make, use, sell,
  33  * offer to sell, and import the Covered Code and derivative works thereof
  34  * solely to the minimum extent necessary to exercise the above copyright
  35  * license, and in no event shall the patent license extend to any additions
  36  * to or modifications of the Original Intel Code.  No other license or right
  37  * is granted directly or by implication, estoppel or otherwise;
  38  *
  39  * The above copyright and patent license is granted only if the following
  40  * conditions are met:
  41  *
  42  * 3. Conditions
  43  *
  44  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  45  * Redistribution of source code of any substantial portion of the Covered
  46  * Code or modification with rights to further distribute source must include
  47  * the above Copyright Notice, the above License, this list of Conditions,
  48  * and the following Disclaimer and Export Compliance provision.  In addition,
  49  * Licensee must cause all Covered Code to which Licensee contributes to
  50  * contain a file documenting the changes Licensee made to create that Covered
  51  * Code and the date of any change.  Licensee must include in that file the
  52  * documentation of any changes made by any predecessor Licensee.  Licensee
  53  * must include a prominent statement that the modification is derived,
  54  * directly or indirectly, from Original Intel Code.
  55  *
  56  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  57  * Redistribution of source code of any substantial portion of the Covered
  58  * Code or modification without rights to further distribute source must
  59  * include the following Disclaimer and Export Compliance provision in the
  60  * documentation and/or other materials provided with distribution.  In
  61  * addition, Licensee may not authorize further sublicense of source of any
  62  * portion of the Covered Code, and must include terms to the effect that the
  63  * license from Licensee to its licensee is limited to the intellectual
  64  * property embodied in the software Licensee provides to its licensee, and
  65  * not to intellectual property embodied in modifications its licensee may
  66  * make.
  67  *
  68  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  69  * substantial portion of the Covered Code or modification must reproduce the
  70  * above Copyright Notice, and the following Disclaimer and Export Compliance
  71  * provision in the documentation and/or other materials provided with the
  72  * distribution.
  73  *
  74  * 3.4. Intel retains all right, title, and interest in and to the Original
  75  * Intel Code.
  76  *
  77  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  78  * Intel shall be used in advertising or otherwise to promote the sale, use or
  79  * other dealings in products derived from or relating to the Covered Code
  80  * without prior written authorization from Intel.
  81  *
  82  * 4. Disclaimer and Export Compliance
  83  *
  84  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  85  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  86  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  87  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  88  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  89  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  90  * PARTICULAR PURPOSE.
  91  *
  92  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  93  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  94  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  95  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  96  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  97  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  98  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  99  * LIMITED REMEDY.
 100  *
 101  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 102  * software or system incorporating such software without first obtaining any
 103  * required license or other approval from the U. S. Department of Commerce or
 104  * any other agency or department of the United States Government.  In the
 105  * event Licensee exports any such software from the United States or
 106  * re-exports any such software from a foreign destination, Licensee shall
 107  * ensure that the distribution and export/re-export of the software is in
 108  * compliance with all laws, regulations, orders, or other restrictions of the
 109  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 110  * any of its subsidiaries will export/re-export any technical data, process,
 111  * software, or service, directly or indirectly, to any country for which the
 112  * United States government or any agency thereof requires an export license,
 113  * other governmental approval, or letter of assurance, without first obtaining
 114  * such license, approval or letter.
 115  *
 116  *****************************************************************************/
 117 /* $DragonFly: src/sys/contrib/dev/acpica/Attic/nsxfname.c,v 1.1 2003/09/24 03:32:16 drhodus Exp $                                                               */
 118
 119 #define __NSXFNAME_C__
 120
 121 #include "acpi.h"
 122 #include "acnamesp.h"
 123
 124
 125 #define _COMPONENT          ACPI_NAMESPACE
 126         ACPI_MODULE_NAME    ("nsxfname")
 127
 128
 129 /****************************************************************************
 130  *
 131  * FUNCTION:    AcpiGetHandle
 132  *
 133  * PARAMETERS:  Parent          - Object to search under (search scope).
 134  *              PathName        - Pointer to an asciiz string containing the
 135  *                                  name
 136  *              RetHandle       - Where the return handle is placed
 137  *
 138  * RETURN:      Status
 139  *
 140  * DESCRIPTION: This routine will search for a caller specified name in the
 141  *              name space.  The caller can restrict the search region by
 142  *              specifying a non NULL parent.  The parent value is itself a
 143  *              namespace handle.
 144  *
 145  ******************************************************************************/
 146
 147 ACPI_STATUS
 148 AcpiGetHandle (
 149     ACPI_HANDLE             Parent,
 150     ACPI_STRING             Pathname,
 151     ACPI_HANDLE             *RetHandle)
 152 {
 153     ACPI_STATUS             Status;
 154     ACPI_NAMESPACE_NODE     *Node = NULL;
 155     ACPI_NAMESPACE_NODE     *PrefixNode = NULL;
 156
 157
 158     ACPI_FUNCTION_ENTRY ();
 159
 160
 161     /* Parameter Validation */
 162
 163     if (!RetHandle || !Pathname)
 164     {
 165         return (AE_BAD_PARAMETER);
 166     }
 167
 168     /* Convert a parent handle to a prefix node */
 169
 170     if (Parent)
 171     {
 172         Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 173         if (ACPI_FAILURE (Status))
 174         {
 175             return (Status);
 176         }
 177
 178         PrefixNode = AcpiNsMapHandleToNode (Parent);
 179         if (!PrefixNode)
 180         {
 181             (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 182             return (AE_BAD_PARAMETER);
 183         }
 184
 185         Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 186         if (ACPI_FAILURE (Status))
 187         {
 188             return (Status);
 189         }
 190     }
 191
 192     /* Special case for root, since we can't search for it */
 193
 194     if (ACPI_STRCMP (Pathname, ACPI_NS_ROOT_PATH) == 0)
 195     {
 196         *RetHandle = AcpiNsConvertEntryToHandle (AcpiGbl_RootNode);
 197         return (AE_OK);
 198     }
 199
 200     /*
 201      *  Find the Node and convert to a handle
 202      */
 203     Status = AcpiNsGetNodeByPath (Pathname, PrefixNode, ACPI_NS_NO_UPSEARCH, &Node);
 204
 205     *RetHandle = NULL;
 206     if (ACPI_SUCCESS (Status))
 207     {
 208         *RetHandle = AcpiNsConvertEntryToHandle (Node);
 209     }
 210
 211     return (Status);
 212 }
 213
 214
 215 /****************************************************************************
 216  *
 217  * FUNCTION:    AcpiGetName
 218  *
 219  * PARAMETERS:  Handle          - Handle to be converted to a pathname
 220  *              NameType        - Full pathname or single segment
 221  *              Buffer          - Buffer for returned path
 222  *
 223  * RETURN:      Pointer to a string containing the fully qualified Name.
 224  *
 225  * DESCRIPTION: This routine returns the fully qualified name associated with
 226  *              the Handle parameter.  This and the AcpiPathnameToHandle are
 227  *              complementary functions.
 228  *
 229  ******************************************************************************/
 230
 231 ACPI_STATUS
 232 AcpiGetName (
 233     ACPI_HANDLE             Handle,
 234     UINT32                  NameType,
 235     ACPI_BUFFER             *Buffer)
 236 {
 237     ACPI_STATUS             Status;
 238     ACPI_NAMESPACE_NODE     *Node;
 239
 240
 241     /* Parameter validation */
 242
 243     if (NameType > ACPI_NAME_TYPE_MAX)
 244     {
 245         return (AE_BAD_PARAMETER);
 246     }
 247
 248     Status = AcpiUtValidateBuffer (Buffer);
 249     if (ACPI_FAILURE (Status))
 250     {
 251         return (Status);
 252     }
 253
 254     if (NameType == ACPI_FULL_PATHNAME)
 255     {
 256         /* Get the full pathname (From the namespace root) */
 257
 258         Status = AcpiNsHandleToPathname (Handle, Buffer);
 259         return (Status);
 260     }
 261
 262     /*
 263      * Wants the single segment ACPI name.
 264      * Validate handle and convert to a namespace Node
 265      */
 266     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 267     if (ACPI_FAILURE (Status))
 268     {
 269         return (Status);
 270     }
 271
 272     Node = AcpiNsMapHandleToNode (Handle);
 273     if (!Node)
 274     {
 275         Status = AE_BAD_PARAMETER;
 276         goto UnlockAndExit;
 277     }
 278
 279     /* Validate/Allocate/Clear caller buffer */
 280
 281     Status = AcpiUtInitializeBuffer (Buffer, ACPI_PATH_SEGMENT_LENGTH);
 282     if (ACPI_FAILURE (Status))
 283     {
 284         goto UnlockAndExit;
 285     }
 286
 287     /* Just copy the ACPI name from the Node and zero terminate it */
 288
 289     ACPI_STRNCPY (Buffer->Pointer, Node->Name.Ascii,
 290                 ACPI_NAME_SIZE);
 291     ((char *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0;
 292     Status = AE_OK;
 293
 294
 295 UnlockAndExit:
 296
 297     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 298     return (Status);
 299 }
 300
 301
 302 /****************************************************************************
 303  *
 304  * FUNCTION:    AcpiGetObjectInfo
 305  *
 306  * PARAMETERS:  Handle          - Object Handle
 307  *              Info            - Where the info is returned
 308  *
 309  * RETURN:      Status
 310  *
 311  * DESCRIPTION: Returns information about an object as gleaned from the
 312  *              namespace node and possibly by running several standard
 313  *              control methods (Such as in the case of a device.)
 314  *
 315  ******************************************************************************/
 316
 317 ACPI_STATUS
 318 AcpiGetObjectInfo (
 319     ACPI_HANDLE             Handle,
 320     ACPI_DEVICE_INFO        *Info)
 321 {
 322     ACPI_DEVICE_ID          Hid;
 323     ACPI_DEVICE_ID          Uid;
 324     ACPI_STATUS             Status;
 325     UINT32                  DeviceStatus = 0;
 326     ACPI_INTEGER            Address = 0;
 327     ACPI_NAMESPACE_NODE     *Node;
 328
 329
 330     /* Parameter validation */
 331
 332     if (!Handle || !Info)
 333     {
 334         return (AE_BAD_PARAMETER);
 335     }
 336
 337     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 338     if (ACPI_FAILURE (Status))
 339     {
 340         return (Status);
 341     }
 342
 343     Node = AcpiNsMapHandleToNode (Handle);
 344     if (!Node)
 345     {
 346         (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 347         return (AE_BAD_PARAMETER);
 348     }
 349
 350     Info->Type = Node->Type;
 351     Info->Name = Node->Name.Integer;
 352
 353     Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 354     if (ACPI_FAILURE (Status))
 355     {
 356         return (Status);
 357     }
 358
 359     /*
 360      * If not a device, we are all done.
 361      */
 362     if (Info->Type != ACPI_TYPE_DEVICE)
 363     {
 364         return (AE_OK);
 365     }
 366
 367
 368     /*
 369      * Get extra info for ACPI devices only.  Run the
 370      * _HID, _UID, _STA, and _ADR methods.  Note: none
 371      * of these methods are required, so they may or may
 372      * not be present.  The Info->Valid bits are used
 373      * to indicate which methods ran successfully.
 374      */
 375     Info->Valid = 0;
 376
 377     /* Execute the _HID method and save the result */
 378
 379     Status = AcpiUtExecute_HID (Node, &Hid);
 380     if (ACPI_SUCCESS (Status))
 381     {
 382         ACPI_STRNCPY (Info->HardwareId, Hid.Buffer, sizeof(Info->HardwareId));
 383         Info->Valid |= ACPI_VALID_HID;
 384     }
 385
 386     /* Execute the _UID method and save the result */
 387
 388     Status = AcpiUtExecute_UID (Node, &Uid);
 389     if (ACPI_SUCCESS (Status))
 390     {
 391         ACPI_STRCPY (Info->UniqueId, Uid.Buffer);
 392         Info->Valid |= ACPI_VALID_UID;
 393     }
 394
 395     /*
 396      * Execute the _STA method and save the result
 397      * _STA is not always present
 398      */
 399     Status = AcpiUtExecute_STA (Node, &DeviceStatus);
 400     if (ACPI_SUCCESS (Status))
 401     {
 402         Info->CurrentStatus = DeviceStatus;
 403         Info->Valid |= ACPI_VALID_STA;
 404     }
 405
 406     /*
 407      * Execute the _ADR method and save result if successful
 408      * _ADR is not always present
 409      */
 410     Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR,
 411                                             Node, &Address);
 412
 413     if (ACPI_SUCCESS (Status))
 414     {
 415         Info->Address = Address;
 416         Info->Valid |= ACPI_VALID_ADR;
 417     }
 418
 419     return (AE_OK);
 420 }
 421