nsxfname.c revision 91116
167754Smsmith/****************************************************************************** 267754Smsmith * 367754Smsmith * Module Name: nsxfname - Public interfaces to the ACPI subsystem 467754Smsmith * ACPI Namespace oriented interfaces 591116Smsmith * $Revision: 89 $ 667754Smsmith * 767754Smsmith *****************************************************************************/ 867754Smsmith 967754Smsmith/****************************************************************************** 1067754Smsmith * 1167754Smsmith * 1. Copyright Notice 1267754Smsmith * 1391116Smsmith * Some or all of this work - Copyright (c) 1999 - 2002, Intel Corp. 1470243Smsmith * All rights reserved. 1567754Smsmith * 1667754Smsmith * 2. License 1767754Smsmith * 1867754Smsmith * 2.1. This is your license from Intel Corp. under its intellectual property 1967754Smsmith * rights. You may have additional license terms from the party that provided 2067754Smsmith * you this software, covering your right to use that party's intellectual 2167754Smsmith * property rights. 2267754Smsmith * 2367754Smsmith * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 2467754Smsmith * copy of the source code appearing in this file ("Covered Code") an 2567754Smsmith * irrevocable, perpetual, worldwide license under Intel's copyrights in the 2667754Smsmith * base code distributed originally by Intel ("Original Intel Code") to copy, 2767754Smsmith * make derivatives, distribute, use and display any portion of the Covered 2867754Smsmith * Code in any form, with the right to sublicense such rights; and 2967754Smsmith * 3067754Smsmith * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 3167754Smsmith * license (with the right to sublicense), under only those claims of Intel 3267754Smsmith * patents that are infringed by the Original Intel Code, to make, use, sell, 3367754Smsmith * offer to sell, and import the Covered Code and derivative works thereof 3467754Smsmith * solely to the minimum extent necessary to exercise the above copyright 3567754Smsmith * license, and in no event shall the patent license extend to any additions 3667754Smsmith * to or modifications of the Original Intel Code. No other license or right 3767754Smsmith * is granted directly or by implication, estoppel or otherwise; 3867754Smsmith * 3967754Smsmith * The above copyright and patent license is granted only if the following 4067754Smsmith * conditions are met: 4167754Smsmith * 4267754Smsmith * 3. Conditions 4367754Smsmith * 4467754Smsmith * 3.1. Redistribution of Source with Rights to Further Distribute Source. 4567754Smsmith * Redistribution of source code of any substantial portion of the Covered 4667754Smsmith * Code or modification with rights to further distribute source must include 4767754Smsmith * the above Copyright Notice, the above License, this list of Conditions, 4867754Smsmith * and the following Disclaimer and Export Compliance provision. In addition, 4967754Smsmith * Licensee must cause all Covered Code to which Licensee contributes to 5067754Smsmith * contain a file documenting the changes Licensee made to create that Covered 5167754Smsmith * Code and the date of any change. Licensee must include in that file the 5267754Smsmith * documentation of any changes made by any predecessor Licensee. Licensee 5367754Smsmith * must include a prominent statement that the modification is derived, 5467754Smsmith * directly or indirectly, from Original Intel Code. 5567754Smsmith * 5667754Smsmith * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 5767754Smsmith * Redistribution of source code of any substantial portion of the Covered 5867754Smsmith * Code or modification without rights to further distribute source must 5967754Smsmith * include the following Disclaimer and Export Compliance provision in the 6067754Smsmith * documentation and/or other materials provided with distribution. In 6167754Smsmith * addition, Licensee may not authorize further sublicense of source of any 6267754Smsmith * portion of the Covered Code, and must include terms to the effect that the 6367754Smsmith * license from Licensee to its licensee is limited to the intellectual 6467754Smsmith * property embodied in the software Licensee provides to its licensee, and 6567754Smsmith * not to intellectual property embodied in modifications its licensee may 6667754Smsmith * make. 6767754Smsmith * 6867754Smsmith * 3.3. Redistribution of Executable. Redistribution in executable form of any 6967754Smsmith * substantial portion of the Covered Code or modification must reproduce the 7067754Smsmith * above Copyright Notice, and the following Disclaimer and Export Compliance 7167754Smsmith * provision in the documentation and/or other materials provided with the 7267754Smsmith * distribution. 7367754Smsmith * 7467754Smsmith * 3.4. Intel retains all right, title, and interest in and to the Original 7567754Smsmith * Intel Code. 7667754Smsmith * 7767754Smsmith * 3.5. Neither the name Intel nor any other trademark owned or controlled by 7867754Smsmith * Intel shall be used in advertising or otherwise to promote the sale, use or 7967754Smsmith * other dealings in products derived from or relating to the Covered Code 8067754Smsmith * without prior written authorization from Intel. 8167754Smsmith * 8267754Smsmith * 4. Disclaimer and Export Compliance 8367754Smsmith * 8467754Smsmith * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 8567754Smsmith * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 8667754Smsmith * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 8767754Smsmith * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 8867754Smsmith * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 8967754Smsmith * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 9067754Smsmith * PARTICULAR PURPOSE. 9167754Smsmith * 9267754Smsmith * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 9367754Smsmith * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 9467754Smsmith * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 9567754Smsmith * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 9667754Smsmith * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 9767754Smsmith * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 9867754Smsmith * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 9967754Smsmith * LIMITED REMEDY. 10067754Smsmith * 10167754Smsmith * 4.3. Licensee shall not export, either directly or indirectly, any of this 10267754Smsmith * software or system incorporating such software without first obtaining any 10367754Smsmith * required license or other approval from the U. S. Department of Commerce or 10467754Smsmith * any other agency or department of the United States Government. In the 10567754Smsmith * event Licensee exports any such software from the United States or 10667754Smsmith * re-exports any such software from a foreign destination, Licensee shall 10767754Smsmith * ensure that the distribution and export/re-export of the software is in 10867754Smsmith * compliance with all laws, regulations, orders, or other restrictions of the 10967754Smsmith * U.S. Export Administration Regulations. Licensee agrees that neither it nor 11067754Smsmith * any of its subsidiaries will export/re-export any technical data, process, 11167754Smsmith * software, or service, directly or indirectly, to any country for which the 11267754Smsmith * United States government or any agency thereof requires an export license, 11367754Smsmith * other governmental approval, or letter of assurance, without first obtaining 11467754Smsmith * such license, approval or letter. 11567754Smsmith * 11667754Smsmith *****************************************************************************/ 11767754Smsmith 11867754Smsmith#define __NSXFNAME_C__ 11967754Smsmith 12067754Smsmith#include "acpi.h" 12167754Smsmith#include "acinterp.h" 12267754Smsmith#include "acnamesp.h" 12367754Smsmith#include "amlcode.h" 12467754Smsmith#include "acparser.h" 12567754Smsmith#include "acdispat.h" 12667754Smsmith#include "acevents.h" 12767754Smsmith 12867754Smsmith 12977424Smsmith#define _COMPONENT ACPI_NAMESPACE 13091116Smsmith ACPI_MODULE_NAME ("nsxfname") 13167754Smsmith 13267754Smsmith 13367754Smsmith/**************************************************************************** 13467754Smsmith * 13567754Smsmith * FUNCTION: AcpiGetHandle 13667754Smsmith * 13767754Smsmith * PARAMETERS: Parent - Object to search under (search scope). 13867754Smsmith * PathName - Pointer to an asciiz string containing the 13967754Smsmith * name 14067754Smsmith * RetHandle - Where the return handle is placed 14167754Smsmith * 14267754Smsmith * RETURN: Status 14367754Smsmith * 14467754Smsmith * DESCRIPTION: This routine will search for a caller specified name in the 14567754Smsmith * name space. The caller can restrict the search region by 14667754Smsmith * specifying a non NULL parent. The parent value is itself a 14767754Smsmith * namespace handle. 14867754Smsmith * 14967754Smsmith ******************************************************************************/ 15067754Smsmith 15167754SmsmithACPI_STATUS 15267754SmsmithAcpiGetHandle ( 15367754Smsmith ACPI_HANDLE Parent, 15467754Smsmith ACPI_STRING Pathname, 15567754Smsmith ACPI_HANDLE *RetHandle) 15667754Smsmith{ 15767754Smsmith ACPI_STATUS Status; 15869450Smsmith ACPI_NAMESPACE_NODE *Node = NULL; 15967754Smsmith ACPI_NAMESPACE_NODE *PrefixNode = NULL; 16067754Smsmith 16167754Smsmith 16291116Smsmith ACPI_FUNCTION_ENTRY (); 16383174Smsmith 16483174Smsmith 16577424Smsmith /* Parameter Validation */ 16677424Smsmith 16767754Smsmith if (!RetHandle || !Pathname) 16867754Smsmith { 16967754Smsmith return (AE_BAD_PARAMETER); 17067754Smsmith } 17167754Smsmith 17269746Smsmith /* Convert a parent handle to a prefix node */ 17369746Smsmith 17467754Smsmith if (Parent) 17567754Smsmith { 17691116Smsmith Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 17791116Smsmith if (ACPI_FAILURE (Status)) 17891116Smsmith { 17991116Smsmith return (Status); 18091116Smsmith } 18167754Smsmith 18285756Smsmith PrefixNode = AcpiNsMapHandleToNode (Parent); 18369450Smsmith if (!PrefixNode) 18467754Smsmith { 18591116Smsmith (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 18667754Smsmith return (AE_BAD_PARAMETER); 18767754Smsmith } 18867754Smsmith 18991116Smsmith Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 19091116Smsmith if (ACPI_FAILURE (Status)) 19191116Smsmith { 19291116Smsmith return (Status); 19391116Smsmith } 19467754Smsmith } 19567754Smsmith 19667754Smsmith /* Special case for root, since we can't search for it */ 19767754Smsmith 19891116Smsmith if (ACPI_STRCMP (Pathname, ACPI_NS_ROOT_PATH) == 0) 19967754Smsmith { 20067754Smsmith *RetHandle = AcpiNsConvertEntryToHandle (AcpiGbl_RootNode); 20167754Smsmith return (AE_OK); 20267754Smsmith } 20367754Smsmith 20467754Smsmith /* 20569746Smsmith * Find the Node and convert to a handle 20667754Smsmith */ 20791116Smsmith Status = AcpiNsGetNodeByPath (Pathname, PrefixNode, ACPI_NS_NO_UPSEARCH, &Node); 20867754Smsmith 20967754Smsmith *RetHandle = NULL; 21069746Smsmith if (ACPI_SUCCESS (Status)) 21167754Smsmith { 21267754Smsmith *RetHandle = AcpiNsConvertEntryToHandle (Node); 21367754Smsmith } 21467754Smsmith 21567754Smsmith return (Status); 21667754Smsmith} 21767754Smsmith 21867754Smsmith 21967754Smsmith/**************************************************************************** 22067754Smsmith * 22183174Smsmith * FUNCTION: AcpiGetName 22267754Smsmith * 22367754Smsmith * PARAMETERS: Handle - Handle to be converted to a pathname 22467754Smsmith * NameType - Full pathname or single segment 22591116Smsmith * Buffer - Buffer for returned path 22667754Smsmith * 22767754Smsmith * RETURN: Pointer to a string containing the fully qualified Name. 22867754Smsmith * 22967754Smsmith * DESCRIPTION: This routine returns the fully qualified name associated with 23067754Smsmith * the Handle parameter. This and the AcpiPathnameToHandle are 23167754Smsmith * complementary functions. 23267754Smsmith * 23367754Smsmith ******************************************************************************/ 23467754Smsmith 23567754SmsmithACPI_STATUS 23667754SmsmithAcpiGetName ( 23767754Smsmith ACPI_HANDLE Handle, 23867754Smsmith UINT32 NameType, 23991116Smsmith ACPI_BUFFER *Buffer) 24067754Smsmith{ 24167754Smsmith ACPI_STATUS Status; 24267754Smsmith ACPI_NAMESPACE_NODE *Node; 24367754Smsmith 24467754Smsmith 24591116Smsmith /* Parameter validation */ 24667754Smsmith 24791116Smsmith if (NameType > ACPI_NAME_TYPE_MAX) 24867754Smsmith { 24967754Smsmith return (AE_BAD_PARAMETER); 25067754Smsmith } 25167754Smsmith 25291116Smsmith Status = AcpiUtValidateBuffer (Buffer); 25391116Smsmith if (ACPI_FAILURE (Status)) 25467754Smsmith { 25591116Smsmith return (Status); 25667754Smsmith } 25767754Smsmith 25867754Smsmith if (NameType == ACPI_FULL_PATHNAME) 25967754Smsmith { 26067754Smsmith /* Get the full pathname (From the namespace root) */ 26167754Smsmith 26291116Smsmith Status = AcpiNsHandleToPathname (Handle, Buffer); 26367754Smsmith return (Status); 26467754Smsmith } 26567754Smsmith 26667754Smsmith /* 26767754Smsmith * Wants the single segment ACPI name. 26891116Smsmith * Validate handle and convert to a namespace Node 26967754Smsmith */ 27091116Smsmith Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 27191116Smsmith if (ACPI_FAILURE (Status)) 27291116Smsmith { 27391116Smsmith return (Status); 27491116Smsmith } 27591116Smsmith 27685756Smsmith Node = AcpiNsMapHandleToNode (Handle); 27767754Smsmith if (!Node) 27867754Smsmith { 27967754Smsmith Status = AE_BAD_PARAMETER; 28067754Smsmith goto UnlockAndExit; 28167754Smsmith } 28267754Smsmith 28391116Smsmith /* Validate/Allocate/Clear caller buffer */ 28467754Smsmith 28591116Smsmith Status = AcpiUtInitializeBuffer (Buffer, PATH_SEGMENT_LENGTH); 28691116Smsmith if (ACPI_FAILURE (Status)) 28767754Smsmith { 28867754Smsmith goto UnlockAndExit; 28967754Smsmith } 29067754Smsmith 29167754Smsmith /* Just copy the ACPI name from the Node and zero terminate it */ 29267754Smsmith 29391116Smsmith ACPI_STRNCPY (Buffer->Pointer, (NATIVE_CHAR *) &Node->Name, 29467754Smsmith ACPI_NAME_SIZE); 29591116Smsmith ((NATIVE_CHAR *) Buffer->Pointer) [ACPI_NAME_SIZE] = 0; 29667754Smsmith Status = AE_OK; 29767754Smsmith 29867754Smsmith 29967754SmsmithUnlockAndExit: 30067754Smsmith 30191116Smsmith (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 30267754Smsmith return (Status); 30367754Smsmith} 30467754Smsmith 30567754Smsmith 30667754Smsmith/**************************************************************************** 30767754Smsmith * 30867754Smsmith * FUNCTION: AcpiGetObjectInfo 30967754Smsmith * 31067754Smsmith * PARAMETERS: Handle - Object Handle 31167754Smsmith * Info - Where the info is returned 31267754Smsmith * 31367754Smsmith * RETURN: Status 31467754Smsmith * 31567754Smsmith * DESCRIPTION: Returns information about an object as gleaned from the 31667754Smsmith * namespace node and possibly by running several standard 31767754Smsmith * control methods (Such as in the case of a device.) 31867754Smsmith * 31967754Smsmith ******************************************************************************/ 32067754Smsmith 32167754SmsmithACPI_STATUS 32267754SmsmithAcpiGetObjectInfo ( 32367754Smsmith ACPI_HANDLE Handle, 32467754Smsmith ACPI_DEVICE_INFO *Info) 32567754Smsmith{ 32677424Smsmith ACPI_DEVICE_ID Hid; 32777424Smsmith ACPI_DEVICE_ID Uid; 32867754Smsmith ACPI_STATUS Status; 32967754Smsmith UINT32 DeviceStatus = 0; 33067754Smsmith ACPI_INTEGER Address = 0; 33167754Smsmith ACPI_NAMESPACE_NODE *Node; 33267754Smsmith 33367754Smsmith 33467754Smsmith /* Parameter validation */ 33567754Smsmith 33667754Smsmith if (!Handle || !Info) 33767754Smsmith { 33867754Smsmith return (AE_BAD_PARAMETER); 33967754Smsmith } 34067754Smsmith 34191116Smsmith Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE); 34291116Smsmith if (ACPI_FAILURE (Status)) 34391116Smsmith { 34491116Smsmith return (Status); 34591116Smsmith } 34667754Smsmith 34785756Smsmith Node = AcpiNsMapHandleToNode (Handle); 34867754Smsmith if (!Node) 34967754Smsmith { 35091116Smsmith (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 35167754Smsmith return (AE_BAD_PARAMETER); 35267754Smsmith } 35367754Smsmith 35467754Smsmith Info->Type = Node->Type; 35567754Smsmith Info->Name = Node->Name; 35667754Smsmith 35791116Smsmith Status = AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE); 35891116Smsmith if (ACPI_FAILURE (Status)) 35991116Smsmith { 36091116Smsmith return (Status); 36191116Smsmith } 36267754Smsmith 36367754Smsmith /* 36467754Smsmith * If not a device, we are all done. 36567754Smsmith */ 36667754Smsmith if (Info->Type != ACPI_TYPE_DEVICE) 36767754Smsmith { 36867754Smsmith return (AE_OK); 36967754Smsmith } 37067754Smsmith 37167754Smsmith 37267754Smsmith /* 37367754Smsmith * Get extra info for ACPI devices only. Run the 37467754Smsmith * _HID, _UID, _STA, and _ADR methods. Note: none 37567754Smsmith * of these methods are required, so they may or may 37667754Smsmith * not be present. The Info->Valid bits are used 37767754Smsmith * to indicate which methods ran successfully. 37867754Smsmith */ 37967754Smsmith Info->Valid = 0; 38067754Smsmith 38167754Smsmith /* Execute the _HID method and save the result */ 38267754Smsmith 38377424Smsmith Status = AcpiUtExecute_HID (Node, &Hid); 38467754Smsmith if (ACPI_SUCCESS (Status)) 38567754Smsmith { 38691116Smsmith ACPI_STRNCPY (Info->HardwareId, Hid.Buffer, sizeof(Info->HardwareId)); 38767754Smsmith Info->Valid |= ACPI_VALID_HID; 38867754Smsmith } 38967754Smsmith 39067754Smsmith /* Execute the _UID method and save the result */ 39167754Smsmith 39277424Smsmith Status = AcpiUtExecute_UID (Node, &Uid); 39367754Smsmith if (ACPI_SUCCESS (Status)) 39467754Smsmith { 39591116Smsmith ACPI_STRCPY (Info->UniqueId, Uid.Buffer); 39667754Smsmith Info->Valid |= ACPI_VALID_UID; 39767754Smsmith } 39867754Smsmith 39967754Smsmith /* 40067754Smsmith * Execute the _STA method and save the result 40167754Smsmith * _STA is not always present 40267754Smsmith */ 40377424Smsmith Status = AcpiUtExecute_STA (Node, &DeviceStatus); 40467754Smsmith if (ACPI_SUCCESS (Status)) 40567754Smsmith { 40667754Smsmith Info->CurrentStatus = DeviceStatus; 40767754Smsmith Info->Valid |= ACPI_VALID_STA; 40867754Smsmith } 40967754Smsmith 41067754Smsmith /* 41167754Smsmith * Execute the _ADR method and save result if successful 41267754Smsmith * _ADR is not always present 41367754Smsmith */ 41477424Smsmith Status = AcpiUtEvaluateNumericObject (METHOD_NAME__ADR, 41567754Smsmith Node, &Address); 41667754Smsmith 41767754Smsmith if (ACPI_SUCCESS (Status)) 41867754Smsmith { 41967754Smsmith Info->Address = Address; 42067754Smsmith Info->Valid |= ACPI_VALID_ADR; 42167754Smsmith } 42267754Smsmith 42367754Smsmith return (AE_OK); 42467754Smsmith} 42567754Smsmith 426