nsxfname.c revision 69450
167754Smsmith/****************************************************************************** 267754Smsmith * 367754Smsmith * Module Name: nsxfname - Public interfaces to the ACPI subsystem 467754Smsmith * ACPI Namespace oriented interfaces 569450Smsmith * $Revision: 72 $ 667754Smsmith * 767754Smsmith *****************************************************************************/ 867754Smsmith 967754Smsmith/****************************************************************************** 1067754Smsmith * 1167754Smsmith * 1. Copyright Notice 1267754Smsmith * 1367754Smsmith * Some or all of this work - Copyright (c) 1999, Intel Corp. All rights 1467754Smsmith * 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 12967754Smsmith#define _COMPONENT NAMESPACE 13067754Smsmith 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 16267754Smsmith if (!RetHandle || !Pathname) 16367754Smsmith { 16467754Smsmith return (AE_BAD_PARAMETER); 16567754Smsmith } 16667754Smsmith 16767754Smsmith if (Parent) 16867754Smsmith { 16967754Smsmith AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE); 17067754Smsmith 17169450Smsmith PrefixNode = AcpiNsConvertHandleToEntry (Parent); 17269450Smsmith if (!PrefixNode) 17367754Smsmith { 17467754Smsmith AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 17567754Smsmith return (AE_BAD_PARAMETER); 17667754Smsmith } 17767754Smsmith 17867754Smsmith AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 17967754Smsmith } 18067754Smsmith 18167754Smsmith /* Special case for root, since we can't search for it */ 18267754Smsmith /* TBD: [Investigate] Check for both forward and backslash?? */ 18367754Smsmith 18467754Smsmith if (STRCMP (Pathname, NS_ROOT_PATH) == 0) 18567754Smsmith { 18667754Smsmith *RetHandle = AcpiNsConvertEntryToHandle (AcpiGbl_RootNode); 18767754Smsmith return (AE_OK); 18867754Smsmith } 18967754Smsmith 19067754Smsmith /* 19167754Smsmith * Find the Node and convert to the user format 19267754Smsmith */ 19369450Smsmith Status = AcpiNsGetNode (Pathname, Node, &Node); 19467754Smsmith 19567754Smsmith *RetHandle = NULL; 19667754Smsmith if(ACPI_SUCCESS(Status)) 19767754Smsmith { 19867754Smsmith *RetHandle = AcpiNsConvertEntryToHandle (Node); 19967754Smsmith } 20067754Smsmith 20167754Smsmith return (Status); 20267754Smsmith} 20367754Smsmith 20467754Smsmith 20567754Smsmith/**************************************************************************** 20667754Smsmith * 20767754Smsmith * FUNCTION: AcpiGetPathname 20867754Smsmith * 20967754Smsmith * PARAMETERS: Handle - Handle to be converted to a pathname 21067754Smsmith * NameType - Full pathname or single segment 21167754Smsmith * RetPathPtr - Buffer for returned path 21267754Smsmith * 21367754Smsmith * RETURN: Pointer to a string containing the fully qualified Name. 21467754Smsmith * 21567754Smsmith * DESCRIPTION: This routine returns the fully qualified name associated with 21667754Smsmith * the Handle parameter. This and the AcpiPathnameToHandle are 21767754Smsmith * complementary functions. 21867754Smsmith * 21967754Smsmith ******************************************************************************/ 22067754Smsmith 22167754SmsmithACPI_STATUS 22267754SmsmithAcpiGetName ( 22367754Smsmith ACPI_HANDLE Handle, 22467754Smsmith UINT32 NameType, 22567754Smsmith ACPI_BUFFER *RetPathPtr) 22667754Smsmith{ 22767754Smsmith ACPI_STATUS Status; 22867754Smsmith ACPI_NAMESPACE_NODE *Node; 22967754Smsmith 23067754Smsmith 23167754Smsmith /* Buffer pointer must be valid always */ 23267754Smsmith 23367754Smsmith if (!RetPathPtr || (NameType > ACPI_NAME_TYPE_MAX)) 23467754Smsmith { 23567754Smsmith return (AE_BAD_PARAMETER); 23667754Smsmith } 23767754Smsmith 23867754Smsmith /* Allow length to be zero and ignore the pointer */ 23967754Smsmith 24067754Smsmith if ((RetPathPtr->Length) && 24167754Smsmith (!RetPathPtr->Pointer)) 24267754Smsmith { 24367754Smsmith return (AE_BAD_PARAMETER); 24467754Smsmith } 24567754Smsmith 24667754Smsmith if (NameType == ACPI_FULL_PATHNAME) 24767754Smsmith { 24867754Smsmith /* Get the full pathname (From the namespace root) */ 24967754Smsmith 25067754Smsmith Status = AcpiNsHandleToPathname (Handle, &RetPathPtr->Length, 25167754Smsmith RetPathPtr->Pointer); 25267754Smsmith return (Status); 25367754Smsmith } 25467754Smsmith 25567754Smsmith /* 25667754Smsmith * Wants the single segment ACPI name. 25767754Smsmith * Validate handle and convert to an Node 25867754Smsmith */ 25967754Smsmith 26067754Smsmith AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE); 26167754Smsmith Node = AcpiNsConvertHandleToEntry (Handle); 26267754Smsmith if (!Node) 26367754Smsmith { 26467754Smsmith Status = AE_BAD_PARAMETER; 26567754Smsmith goto UnlockAndExit; 26667754Smsmith } 26767754Smsmith 26867754Smsmith /* Check if name will fit in buffer */ 26967754Smsmith 27067754Smsmith if (RetPathPtr->Length < PATH_SEGMENT_LENGTH) 27167754Smsmith { 27267754Smsmith RetPathPtr->Length = PATH_SEGMENT_LENGTH; 27367754Smsmith Status = AE_BUFFER_OVERFLOW; 27467754Smsmith goto UnlockAndExit; 27567754Smsmith } 27667754Smsmith 27767754Smsmith /* Just copy the ACPI name from the Node and zero terminate it */ 27867754Smsmith 27967754Smsmith STRNCPY (RetPathPtr->Pointer, (NATIVE_CHAR *) &Node->Name, 28067754Smsmith ACPI_NAME_SIZE); 28167754Smsmith ((NATIVE_CHAR *) RetPathPtr->Pointer) [ACPI_NAME_SIZE] = 0; 28267754Smsmith Status = AE_OK; 28367754Smsmith 28467754Smsmith 28567754SmsmithUnlockAndExit: 28667754Smsmith 28767754Smsmith AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 28867754Smsmith return (Status); 28967754Smsmith} 29067754Smsmith 29167754Smsmith 29267754Smsmith/**************************************************************************** 29367754Smsmith * 29467754Smsmith * FUNCTION: AcpiGetObjectInfo 29567754Smsmith * 29667754Smsmith * PARAMETERS: Handle - Object Handle 29767754Smsmith * Info - Where the info is returned 29867754Smsmith * 29967754Smsmith * RETURN: Status 30067754Smsmith * 30167754Smsmith * DESCRIPTION: Returns information about an object as gleaned from the 30267754Smsmith * namespace node and possibly by running several standard 30367754Smsmith * control methods (Such as in the case of a device.) 30467754Smsmith * 30567754Smsmith ******************************************************************************/ 30667754Smsmith 30767754SmsmithACPI_STATUS 30867754SmsmithAcpiGetObjectInfo ( 30967754Smsmith ACPI_HANDLE Handle, 31067754Smsmith ACPI_DEVICE_INFO *Info) 31167754Smsmith{ 31267754Smsmith DEVICE_ID Hid; 31367754Smsmith DEVICE_ID Uid; 31467754Smsmith ACPI_STATUS Status; 31567754Smsmith UINT32 DeviceStatus = 0; 31667754Smsmith ACPI_INTEGER Address = 0; 31767754Smsmith ACPI_NAMESPACE_NODE *Node; 31867754Smsmith 31967754Smsmith 32067754Smsmith /* Parameter validation */ 32167754Smsmith 32267754Smsmith if (!Handle || !Info) 32367754Smsmith { 32467754Smsmith return (AE_BAD_PARAMETER); 32567754Smsmith } 32667754Smsmith 32767754Smsmith AcpiCmAcquireMutex (ACPI_MTX_NAMESPACE); 32867754Smsmith 32967754Smsmith Node = AcpiNsConvertHandleToEntry (Handle); 33067754Smsmith if (!Node) 33167754Smsmith { 33267754Smsmith AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 33367754Smsmith return (AE_BAD_PARAMETER); 33467754Smsmith } 33567754Smsmith 33667754Smsmith Info->Type = Node->Type; 33767754Smsmith Info->Name = Node->Name; 33867754Smsmith 33967754Smsmith AcpiCmReleaseMutex (ACPI_MTX_NAMESPACE); 34067754Smsmith 34167754Smsmith /* 34267754Smsmith * If not a device, we are all done. 34367754Smsmith */ 34467754Smsmith if (Info->Type != ACPI_TYPE_DEVICE) 34567754Smsmith { 34667754Smsmith return (AE_OK); 34767754Smsmith } 34867754Smsmith 34967754Smsmith 35067754Smsmith /* 35167754Smsmith * Get extra info for ACPI devices only. Run the 35267754Smsmith * _HID, _UID, _STA, and _ADR methods. Note: none 35367754Smsmith * of these methods are required, so they may or may 35467754Smsmith * not be present. The Info->Valid bits are used 35567754Smsmith * to indicate which methods ran successfully. 35667754Smsmith */ 35767754Smsmith 35867754Smsmith Info->Valid = 0; 35967754Smsmith 36067754Smsmith /* Execute the _HID method and save the result */ 36167754Smsmith 36267754Smsmith Status = AcpiCmExecute_HID (Node, &Hid); 36367754Smsmith if (ACPI_SUCCESS (Status)) 36467754Smsmith { 36567754Smsmith STRNCPY (Info->HardwareId, Hid.Buffer, sizeof(Info->HardwareId)); 36667754Smsmith 36767754Smsmith Info->Valid |= ACPI_VALID_HID; 36867754Smsmith } 36967754Smsmith 37067754Smsmith /* Execute the _UID method and save the result */ 37167754Smsmith 37267754Smsmith Status = AcpiCmExecute_UID (Node, &Uid); 37367754Smsmith if (ACPI_SUCCESS (Status)) 37467754Smsmith { 37567754Smsmith STRCPY (Info->UniqueId, Uid.Buffer); 37667754Smsmith 37767754Smsmith Info->Valid |= ACPI_VALID_UID; 37867754Smsmith } 37967754Smsmith 38067754Smsmith /* 38167754Smsmith * Execute the _STA method and save the result 38267754Smsmith * _STA is not always present 38367754Smsmith */ 38467754Smsmith 38567754Smsmith Status = AcpiCmExecute_STA (Node, &DeviceStatus); 38667754Smsmith if (ACPI_SUCCESS (Status)) 38767754Smsmith { 38867754Smsmith Info->CurrentStatus = DeviceStatus; 38967754Smsmith Info->Valid |= ACPI_VALID_STA; 39067754Smsmith } 39167754Smsmith 39267754Smsmith /* 39367754Smsmith * Execute the _ADR method and save result if successful 39467754Smsmith * _ADR is not always present 39567754Smsmith */ 39667754Smsmith 39767754Smsmith Status = AcpiCmEvaluateNumericObject (METHOD_NAME__ADR, 39867754Smsmith Node, &Address); 39967754Smsmith 40067754Smsmith if (ACPI_SUCCESS (Status)) 40167754Smsmith { 40267754Smsmith Info->Address = Address; 40367754Smsmith Info->Valid |= ACPI_VALID_ADR; 40467754Smsmith } 40567754Smsmith 40667754Smsmith return (AE_OK); 40767754Smsmith} 40867754Smsmith 409