1 /****************************************************************************** 2 * 3 * Module Name: uteval - Object evaluation 4 * 5 *****************************************************************************/ 6 7 /****************************************************************************** 8 * 9 * 1. Copyright Notice 10 * 11 * Some or all of this work - Copyright (c) 1999 - 2012, Intel Corp. 12 * All rights reserved. 13 * 14 * 2. License 15 * 16 * 2.1. This is your license from Intel Corp. under its intellectual property 17 * rights. You may have additional license terms from the party that provided 18 * you this software, covering your right to use that party's intellectual 19 * property rights. 20 * 21 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a 22 * copy of the source code appearing in this file ("Covered Code") an 23 * irrevocable, perpetual, worldwide license under Intel's copyrights in the 24 * base code distributed originally by Intel ("Original Intel Code") to copy, 25 * make derivatives, distribute, use and display any portion of the Covered 26 * Code in any form, with the right to sublicense such rights; and 27 * 28 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent 29 * license (with the right to sublicense), under only those claims of Intel 30 * patents that are infringed by the Original Intel Code, to make, use, sell, 31 * offer to sell, and import the Covered Code and derivative works thereof 32 * solely to the minimum extent necessary to exercise the above copyright 33 * license, and in no event shall the patent license extend to any additions 34 * to or modifications of the Original Intel Code. No other license or right 35 * is granted directly or by implication, estoppel or otherwise; 36 * 37 * The above copyright and patent license is granted only if the following 38 * conditions are met: 39 * 40 * 3. Conditions 41 * 42 * 3.1. Redistribution of Source with Rights to Further Distribute Source. 43 * Redistribution of source code of any substantial portion of the Covered 44 * Code or modification with rights to further distribute source must include 45 * the above Copyright Notice, the above License, this list of Conditions, 46 * and the following Disclaimer and Export Compliance provision. In addition, 47 * Licensee must cause all Covered Code to which Licensee contributes to 48 * contain a file documenting the changes Licensee made to create that Covered 49 * Code and the date of any change. Licensee must include in that file the 50 * documentation of any changes made by any predecessor Licensee. Licensee 51 * must include a prominent statement that the modification is derived, 52 * directly or indirectly, from Original Intel Code. 53 * 54 * 3.2. Redistribution of Source with no Rights to Further Distribute Source. 55 * Redistribution of source code of any substantial portion of the Covered 56 * Code or modification without rights to further distribute source must 57 * include the following Disclaimer and Export Compliance provision in the 58 * documentation and/or other materials provided with distribution. In 59 * addition, Licensee may not authorize further sublicense of source of any 60 * portion of the Covered Code, and must include terms to the effect that the 61 * license from Licensee to its licensee is limited to the intellectual 62 * property embodied in the software Licensee provides to its licensee, and 63 * not to intellectual property embodied in modifications its licensee may 64 * make. 65 * 66 * 3.3. Redistribution of Executable. Redistribution in executable form of any 67 * substantial portion of the Covered Code or modification must reproduce the 68 * above Copyright Notice, and the following Disclaimer and Export Compliance 69 * provision in the documentation and/or other materials provided with the 70 * distribution. 71 * 72 * 3.4. Intel retains all right, title, and interest in and to the Original 73 * Intel Code. 74 * 75 * 3.5. Neither the name Intel nor any other trademark owned or controlled by 76 * Intel shall be used in advertising or otherwise to promote the sale, use or 77 * other dealings in products derived from or relating to the Covered Code 78 * without prior written authorization from Intel. 79 * 80 * 4. Disclaimer and Export Compliance 81 * 82 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED 83 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE 84 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE, 85 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY 86 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY 87 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A 88 * PARTICULAR PURPOSE. 89 * 90 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES 91 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR 92 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT, 93 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY 94 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL 95 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS 96 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY 97 * LIMITED REMEDY. 98 * 99 * 4.3. Licensee shall not export, either directly or indirectly, any of this 100 * software or system incorporating such software without first obtaining any 101 * required license or other approval from the U. S. Department of Commerce or 102 * any other agency or department of the United States Government. In the 103 * event Licensee exports any such software from the United States or 104 * re-exports any such software from a foreign destination, Licensee shall 105 * ensure that the distribution and export/re-export of the software is in 106 * compliance with all laws, regulations, orders, or other restrictions of the 107 * U.S. Export Administration Regulations. Licensee agrees that neither it nor 108 * any of its subsidiaries will export/re-export any technical data, process, 109 * software, or service, directly or indirectly, to any country for which the 110 * United States government or any agency thereof requires an export license, 111 * other governmental approval, or letter of assurance, without first obtaining 112 * such license, approval or letter. 113 * 114 *****************************************************************************/ 115 116 #define __UTEVAL_C__ 117 118 #include "acpi.h" 119 #include "accommon.h" 120 #include "acnamesp.h" 121 122 123 #define _COMPONENT ACPI_UTILITIES 124 ACPI_MODULE_NAME ("uteval") 125 126 127 /******************************************************************************* 128 * 129 * FUNCTION: AcpiUtEvaluateObject 130 * 131 * PARAMETERS: PrefixNode - Starting node 132 * Path - Path to object from starting node 133 * ExpectedReturnTypes - Bitmap of allowed return types 134 * ReturnDesc - Where a return value is stored 135 * 136 * RETURN: Status 137 * 138 * DESCRIPTION: Evaluates a namespace object and verifies the type of the 139 * return object. Common code that simplifies accessing objects 140 * that have required return objects of fixed types. 141 * 142 * NOTE: Internal function, no parameter validation 143 * 144 ******************************************************************************/ 145 146 ACPI_STATUS 147 AcpiUtEvaluateObject ( 148 ACPI_NAMESPACE_NODE *PrefixNode, 149 char *Path, 150 UINT32 ExpectedReturnBtypes, 151 ACPI_OPERAND_OBJECT **ReturnDesc) 152 { 153 ACPI_EVALUATE_INFO *Info; 154 ACPI_STATUS Status; 155 UINT32 ReturnBtype; 156 157 158 ACPI_FUNCTION_TRACE (UtEvaluateObject); 159 160 161 /* Allocate the evaluation information block */ 162 163 Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO)); 164 if (!Info) 165 { 166 return_ACPI_STATUS (AE_NO_MEMORY); 167 } 168 169 Info->PrefixNode = PrefixNode; 170 Info->Pathname = Path; 171 172 /* Evaluate the object/method */ 173 174 Status = AcpiNsEvaluate (Info); 175 if (ACPI_FAILURE (Status)) 176 { 177 if (Status == AE_NOT_FOUND) 178 { 179 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s.%s] was not found\n", 180 AcpiUtGetNodeName (PrefixNode), Path)); 181 } 182 else 183 { 184 ACPI_ERROR_METHOD ("Method execution failed", 185 PrefixNode, Path, Status); 186 } 187 188 goto Cleanup; 189 } 190 191 /* Did we get a return object? */ 192 193 if (!Info->ReturnObject) 194 { 195 if (ExpectedReturnBtypes) 196 { 197 ACPI_ERROR_METHOD ("No object was returned from", 198 PrefixNode, Path, AE_NOT_EXIST); 199 200 Status = AE_NOT_EXIST; 201 } 202 203 goto Cleanup; 204 } 205 206 /* Map the return object type to the bitmapped type */ 207 208 switch ((Info->ReturnObject)->Common.Type) 209 { 210 case ACPI_TYPE_INTEGER: 211 ReturnBtype = ACPI_BTYPE_INTEGER; 212 break; 213 214 case ACPI_TYPE_BUFFER: 215 ReturnBtype = ACPI_BTYPE_BUFFER; 216 break; 217 218 case ACPI_TYPE_STRING: 219 ReturnBtype = ACPI_BTYPE_STRING; 220 break; 221 222 case ACPI_TYPE_PACKAGE: 223 ReturnBtype = ACPI_BTYPE_PACKAGE; 224 break; 225 226 default: 227 ReturnBtype = 0; 228 break; 229 } 230 231 if ((AcpiGbl_EnableInterpreterSlack) && 232 (!ExpectedReturnBtypes)) 233 { 234 /* 235 * We received a return object, but one was not expected. This can 236 * happen frequently if the "implicit return" feature is enabled. 237 * Just delete the return object and return AE_OK. 238 */ 239 AcpiUtRemoveReference (Info->ReturnObject); 240 goto Cleanup; 241 } 242 243 /* Is the return object one of the expected types? */ 244 245 if (!(ExpectedReturnBtypes & ReturnBtype)) 246 { 247 ACPI_ERROR_METHOD ("Return object type is incorrect", 248 PrefixNode, Path, AE_TYPE); 249 250 ACPI_ERROR ((AE_INFO, 251 "Type returned from %s was incorrect: %s, expected Btypes: 0x%X", 252 Path, AcpiUtGetObjectTypeName (Info->ReturnObject), 253 ExpectedReturnBtypes)); 254 255 /* On error exit, we must delete the return object */ 256 257 AcpiUtRemoveReference (Info->ReturnObject); 258 Status = AE_TYPE; 259 goto Cleanup; 260 } 261 262 /* Object type is OK, return it */ 263 264 *ReturnDesc = Info->ReturnObject; 265 266 Cleanup: 267 ACPI_FREE (Info); 268 return_ACPI_STATUS (Status); 269 } 270 271 272 /******************************************************************************* 273 * 274 * FUNCTION: AcpiUtEvaluateNumericObject 275 * 276 * PARAMETERS: ObjectName - Object name to be evaluated 277 * DeviceNode - Node for the device 278 * Value - Where the value is returned 279 * 280 * RETURN: Status 281 * 282 * DESCRIPTION: Evaluates a numeric namespace object for a selected device 283 * and stores result in *Value. 284 * 285 * NOTE: Internal function, no parameter validation 286 * 287 ******************************************************************************/ 288 289 ACPI_STATUS 290 AcpiUtEvaluateNumericObject ( 291 char *ObjectName, 292 ACPI_NAMESPACE_NODE *DeviceNode, 293 UINT64 *Value) 294 { 295 ACPI_OPERAND_OBJECT *ObjDesc; 296 ACPI_STATUS Status; 297 298 299 ACPI_FUNCTION_TRACE (UtEvaluateNumericObject); 300 301 302 Status = AcpiUtEvaluateObject (DeviceNode, ObjectName, 303 ACPI_BTYPE_INTEGER, &ObjDesc); 304 if (ACPI_FAILURE (Status)) 305 { 306 return_ACPI_STATUS (Status); 307 } 308 309 /* Get the returned Integer */ 310 311 *Value = ObjDesc->Integer.Value; 312 313 /* On exit, we must delete the return object */ 314 315 AcpiUtRemoveReference (ObjDesc); 316 return_ACPI_STATUS (Status); 317 } 318 319 320 /******************************************************************************* 321 * 322 * FUNCTION: AcpiUtExecute_STA 323 * 324 * PARAMETERS: DeviceNode - Node for the device 325 * Flags - Where the status flags are returned 326 * 327 * RETURN: Status 328 * 329 * DESCRIPTION: Executes _STA for selected device and stores results in 330 * *Flags. 331 * 332 * NOTE: Internal function, no parameter validation 333 * 334 ******************************************************************************/ 335 336 ACPI_STATUS 337 AcpiUtExecute_STA ( 338 ACPI_NAMESPACE_NODE *DeviceNode, 339 UINT32 *Flags) 340 { 341 ACPI_OPERAND_OBJECT *ObjDesc; 342 ACPI_STATUS Status; 343 344 345 ACPI_FUNCTION_TRACE (UtExecute_STA); 346 347 348 Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__STA, 349 ACPI_BTYPE_INTEGER, &ObjDesc); 350 if (ACPI_FAILURE (Status)) 351 { 352 if (AE_NOT_FOUND == Status) 353 { 354 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, 355 "_STA on %4.4s was not found, assuming device is present\n", 356 AcpiUtGetNodeName (DeviceNode))); 357 358 *Flags = ACPI_UINT32_MAX; 359 Status = AE_OK; 360 } 361 362 return_ACPI_STATUS (Status); 363 } 364 365 /* Extract the status flags */ 366 367 *Flags = (UINT32) ObjDesc->Integer.Value; 368 369 /* On exit, we must delete the return object */ 370 371 AcpiUtRemoveReference (ObjDesc); 372 return_ACPI_STATUS (Status); 373 } 374 375 376 /******************************************************************************* 377 * 378 * FUNCTION: AcpiUtExecutePowerMethods 379 * 380 * PARAMETERS: DeviceNode - Node for the device 381 * MethodNames - Array of power method names 382 * MethodCount - Number of methods to execute 383 * OutValues - Where the power method values are returned 384 * 385 * RETURN: Status, OutValues 386 * 387 * DESCRIPTION: Executes the specified power methods for the device and returns 388 * the result(s). 389 * 390 * NOTE: Internal function, no parameter validation 391 * 392 ******************************************************************************/ 393 394 ACPI_STATUS 395 AcpiUtExecutePowerMethods ( 396 ACPI_NAMESPACE_NODE *DeviceNode, 397 const char **MethodNames, 398 UINT8 MethodCount, 399 UINT8 *OutValues) 400 { 401 ACPI_OPERAND_OBJECT *ObjDesc; 402 ACPI_STATUS Status; 403 ACPI_STATUS FinalStatus = AE_NOT_FOUND; 404 UINT32 i; 405 406 407 ACPI_FUNCTION_TRACE (UtExecutePowerMethods); 408 409 410 for (i = 0; i < MethodCount; i++) 411 { 412 /* 413 * Execute the power method (_SxD or _SxW). The only allowable 414 * return type is an Integer. 415 */ 416 Status = AcpiUtEvaluateObject (DeviceNode, 417 ACPI_CAST_PTR (char, MethodNames[i]), 418 ACPI_BTYPE_INTEGER, &ObjDesc); 419 if (ACPI_SUCCESS (Status)) 420 { 421 OutValues[i] = (UINT8) ObjDesc->Integer.Value; 422 423 /* Delete the return object */ 424 425 AcpiUtRemoveReference (ObjDesc); 426 FinalStatus = AE_OK; /* At least one value is valid */ 427 continue; 428 } 429 430 OutValues[i] = ACPI_UINT8_MAX; 431 if (Status == AE_NOT_FOUND) 432 { 433 continue; /* Ignore if not found */ 434 } 435 436 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Failed %s on Device %4.4s, %s\n", 437 ACPI_CAST_PTR (char, MethodNames[i]), 438 AcpiUtGetNodeName (DeviceNode), AcpiFormatException (Status))); 439 } 440 441 return_ACPI_STATUS (FinalStatus); 442 } 443