1 /******************************************************************************
3 * Module Name: uteval - Object evaluation
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2014, Intel Corp.
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
46 #include <contrib/dev/acpica/include/acpi.h>
47 #include <contrib/dev/acpica/include/accommon.h>
48 #include <contrib/dev/acpica/include/acnamesp.h>
51 #define _COMPONENT ACPI_UTILITIES
52 ACPI_MODULE_NAME ("uteval")
55 /*******************************************************************************
57 * FUNCTION: AcpiUtEvaluateObject
59 * PARAMETERS: PrefixNode - Starting node
60 * Path - Path to object from starting node
61 * ExpectedReturnTypes - Bitmap of allowed return types
62 * ReturnDesc - Where a return value is stored
66 * DESCRIPTION: Evaluates a namespace object and verifies the type of the
67 * return object. Common code that simplifies accessing objects
68 * that have required return objects of fixed types.
70 * NOTE: Internal function, no parameter validation
72 ******************************************************************************/
75 AcpiUtEvaluateObject (
76 ACPI_NAMESPACE_NODE *PrefixNode,
78 UINT32 ExpectedReturnBtypes,
79 ACPI_OPERAND_OBJECT **ReturnDesc)
81 ACPI_EVALUATE_INFO *Info;
86 ACPI_FUNCTION_TRACE (UtEvaluateObject);
89 /* Allocate the evaluation information block */
91 Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
94 return_ACPI_STATUS (AE_NO_MEMORY);
97 Info->PrefixNode = PrefixNode;
98 Info->RelativePathname = Path;
100 /* Evaluate the object/method */
102 Status = AcpiNsEvaluate (Info);
103 if (ACPI_FAILURE (Status))
105 if (Status == AE_NOT_FOUND)
107 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s.%s] was not found\n",
108 AcpiUtGetNodeName (PrefixNode), Path));
112 ACPI_ERROR_METHOD ("Method execution failed",
113 PrefixNode, Path, Status);
119 /* Did we get a return object? */
121 if (!Info->ReturnObject)
123 if (ExpectedReturnBtypes)
125 ACPI_ERROR_METHOD ("No object was returned from",
126 PrefixNode, Path, AE_NOT_EXIST);
128 Status = AE_NOT_EXIST;
134 /* Map the return object type to the bitmapped type */
136 switch ((Info->ReturnObject)->Common.Type)
138 case ACPI_TYPE_INTEGER:
140 ReturnBtype = ACPI_BTYPE_INTEGER;
143 case ACPI_TYPE_BUFFER:
145 ReturnBtype = ACPI_BTYPE_BUFFER;
148 case ACPI_TYPE_STRING:
150 ReturnBtype = ACPI_BTYPE_STRING;
153 case ACPI_TYPE_PACKAGE:
155 ReturnBtype = ACPI_BTYPE_PACKAGE;
164 if ((AcpiGbl_EnableInterpreterSlack) &&
165 (!ExpectedReturnBtypes))
168 * We received a return object, but one was not expected. This can
169 * happen frequently if the "implicit return" feature is enabled.
170 * Just delete the return object and return AE_OK.
172 AcpiUtRemoveReference (Info->ReturnObject);
176 /* Is the return object one of the expected types? */
178 if (!(ExpectedReturnBtypes & ReturnBtype))
180 ACPI_ERROR_METHOD ("Return object type is incorrect",
181 PrefixNode, Path, AE_TYPE);
183 ACPI_ERROR ((AE_INFO,
184 "Type returned from %s was incorrect: %s, expected Btypes: 0x%X",
185 Path, AcpiUtGetObjectTypeName (Info->ReturnObject),
186 ExpectedReturnBtypes));
188 /* On error exit, we must delete the return object */
190 AcpiUtRemoveReference (Info->ReturnObject);
195 /* Object type is OK, return it */
197 *ReturnDesc = Info->ReturnObject;
201 return_ACPI_STATUS (Status);
205 /*******************************************************************************
207 * FUNCTION: AcpiUtEvaluateNumericObject
209 * PARAMETERS: ObjectName - Object name to be evaluated
210 * DeviceNode - Node for the device
211 * Value - Where the value is returned
215 * DESCRIPTION: Evaluates a numeric namespace object for a selected device
216 * and stores result in *Value.
218 * NOTE: Internal function, no parameter validation
220 ******************************************************************************/
223 AcpiUtEvaluateNumericObject (
225 ACPI_NAMESPACE_NODE *DeviceNode,
228 ACPI_OPERAND_OBJECT *ObjDesc;
232 ACPI_FUNCTION_TRACE (UtEvaluateNumericObject);
235 Status = AcpiUtEvaluateObject (DeviceNode, ObjectName,
236 ACPI_BTYPE_INTEGER, &ObjDesc);
237 if (ACPI_FAILURE (Status))
239 return_ACPI_STATUS (Status);
242 /* Get the returned Integer */
244 *Value = ObjDesc->Integer.Value;
246 /* On exit, we must delete the return object */
248 AcpiUtRemoveReference (ObjDesc);
249 return_ACPI_STATUS (Status);
253 /*******************************************************************************
255 * FUNCTION: AcpiUtExecute_STA
257 * PARAMETERS: DeviceNode - Node for the device
258 * Flags - Where the status flags are returned
262 * DESCRIPTION: Executes _STA for selected device and stores results in
263 * *Flags. If _STA does not exist, then the device is assumed
264 * to be present/functional/enabled (as per the ACPI spec).
266 * NOTE: Internal function, no parameter validation
268 ******************************************************************************/
272 ACPI_NAMESPACE_NODE *DeviceNode,
275 ACPI_OPERAND_OBJECT *ObjDesc;
279 ACPI_FUNCTION_TRACE (UtExecute_STA);
282 Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__STA,
283 ACPI_BTYPE_INTEGER, &ObjDesc);
284 if (ACPI_FAILURE (Status))
286 if (AE_NOT_FOUND == Status)
289 * if _STA does not exist, then (as per the ACPI specification),
290 * the returned flags will indicate that the device is present,
291 * functional, and enabled.
293 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
294 "_STA on %4.4s was not found, assuming device is present\n",
295 AcpiUtGetNodeName (DeviceNode)));
297 *Flags = ACPI_UINT32_MAX;
301 return_ACPI_STATUS (Status);
304 /* Extract the status flags */
306 *Flags = (UINT32) ObjDesc->Integer.Value;
308 /* On exit, we must delete the return object */
310 AcpiUtRemoveReference (ObjDesc);
311 return_ACPI_STATUS (Status);
315 /*******************************************************************************
317 * FUNCTION: AcpiUtExecutePowerMethods
319 * PARAMETERS: DeviceNode - Node for the device
320 * MethodNames - Array of power method names
321 * MethodCount - Number of methods to execute
322 * OutValues - Where the power method values are returned
324 * RETURN: Status, OutValues
326 * DESCRIPTION: Executes the specified power methods for the device and returns
329 * NOTE: Internal function, no parameter validation
331 ******************************************************************************/
334 AcpiUtExecutePowerMethods (
335 ACPI_NAMESPACE_NODE *DeviceNode,
336 const char **MethodNames,
340 ACPI_OPERAND_OBJECT *ObjDesc;
342 ACPI_STATUS FinalStatus = AE_NOT_FOUND;
346 ACPI_FUNCTION_TRACE (UtExecutePowerMethods);
349 for (i = 0; i < MethodCount; i++)
352 * Execute the power method (_SxD or _SxW). The only allowable
353 * return type is an Integer.
355 Status = AcpiUtEvaluateObject (DeviceNode,
356 ACPI_CAST_PTR (char, MethodNames[i]),
357 ACPI_BTYPE_INTEGER, &ObjDesc);
358 if (ACPI_SUCCESS (Status))
360 OutValues[i] = (UINT8) ObjDesc->Integer.Value;
362 /* Delete the return object */
364 AcpiUtRemoveReference (ObjDesc);
365 FinalStatus = AE_OK; /* At least one value is valid */
369 OutValues[i] = ACPI_UINT8_MAX;
370 if (Status == AE_NOT_FOUND)
372 continue; /* Ignore if not found */
375 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Failed %s on Device %4.4s, %s\n",
376 ACPI_CAST_PTR (char, MethodNames[i]),
377 AcpiUtGetNodeName (DeviceNode), AcpiFormatException (Status)));
380 return_ACPI_STATUS (FinalStatus);