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 - 2023, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acnamesp.h"
155
156
157 #define _COMPONENT ACPI_UTILITIES
158 ACPI_MODULE_NAME ("uteval")
159
160
161 /*******************************************************************************
162 *
163 * FUNCTION: AcpiUtEvaluateObject
164 *
165 * PARAMETERS: PrefixNode - Starting node
166 * Path - Path to object from starting node
167 * ExpectedReturnTypes - Bitmap of allowed return types
168 * ReturnDesc - Where a return value is stored
169 *
170 * RETURN: Status
171 *
172 * DESCRIPTION: Evaluates a namespace object and verifies the type of the
173 * return object. Common code that simplifies accessing objects
174 * that have required return objects of fixed types.
175 *
176 * NOTE: Internal function, no parameter validation
177 *
178 ******************************************************************************/
179
180 ACPI_STATUS
AcpiUtEvaluateObject(ACPI_NAMESPACE_NODE * PrefixNode,const char * Path,UINT32 ExpectedReturnBtypes,ACPI_OPERAND_OBJECT ** ReturnDesc)181 AcpiUtEvaluateObject (
182 ACPI_NAMESPACE_NODE *PrefixNode,
183 const char *Path,
184 UINT32 ExpectedReturnBtypes,
185 ACPI_OPERAND_OBJECT **ReturnDesc)
186 {
187 ACPI_EVALUATE_INFO *Info;
188 ACPI_STATUS Status;
189 UINT32 ReturnBtype;
190
191
192 ACPI_FUNCTION_TRACE (UtEvaluateObject);
193
194
195 /* Allocate the evaluation information block */
196
197 Info = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_EVALUATE_INFO));
198 if (!Info)
199 {
200 return_ACPI_STATUS (AE_NO_MEMORY);
201 }
202
203 Info->PrefixNode = PrefixNode;
204 Info->RelativePathname = Path;
205
206 /* Evaluate the object/method */
207
208 Status = AcpiNsEvaluate (Info);
209 if (ACPI_FAILURE (Status))
210 {
211 if (Status == AE_NOT_FOUND)
212 {
213 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "[%4.4s.%s] was not found\n",
214 AcpiUtGetNodeName (PrefixNode), Path));
215 }
216 else
217 {
218 ACPI_ERROR_METHOD ("Method execution failed",
219 PrefixNode, Path, Status);
220 }
221
222 goto Cleanup;
223 }
224
225 /* Did we get a return object? */
226
227 if (!Info->ReturnObject)
228 {
229 if (ExpectedReturnBtypes)
230 {
231 ACPI_ERROR_METHOD ("No object was returned from",
232 PrefixNode, Path, AE_NOT_EXIST);
233
234 Status = AE_NOT_EXIST;
235 }
236
237 goto Cleanup;
238 }
239
240 /* Map the return object type to the bitmapped type */
241
242 switch ((Info->ReturnObject)->Common.Type)
243 {
244 case ACPI_TYPE_INTEGER:
245
246 ReturnBtype = ACPI_BTYPE_INTEGER;
247 break;
248
249 case ACPI_TYPE_BUFFER:
250
251 ReturnBtype = ACPI_BTYPE_BUFFER;
252 break;
253
254 case ACPI_TYPE_STRING:
255
256 ReturnBtype = ACPI_BTYPE_STRING;
257 break;
258
259 case ACPI_TYPE_PACKAGE:
260
261 ReturnBtype = ACPI_BTYPE_PACKAGE;
262 break;
263
264 default:
265
266 ReturnBtype = 0;
267 break;
268 }
269
270 if ((AcpiGbl_EnableInterpreterSlack) &&
271 (!ExpectedReturnBtypes))
272 {
273 /*
274 * We received a return object, but one was not expected. This can
275 * happen frequently if the "implicit return" feature is enabled.
276 * Just delete the return object and return AE_OK.
277 */
278 AcpiUtRemoveReference (Info->ReturnObject);
279 goto Cleanup;
280 }
281
282 /* Is the return object one of the expected types? */
283
284 if (!(ExpectedReturnBtypes & ReturnBtype))
285 {
286 ACPI_ERROR_METHOD ("Return object type is incorrect",
287 PrefixNode, Path, AE_TYPE);
288
289 ACPI_ERROR ((AE_INFO,
290 "Type returned from %s was incorrect: %s, expected Btypes: 0x%X",
291 Path, AcpiUtGetObjectTypeName (Info->ReturnObject),
292 ExpectedReturnBtypes));
293
294 /* On error exit, we must delete the return object */
295
296 AcpiUtRemoveReference (Info->ReturnObject);
297 Status = AE_TYPE;
298 goto Cleanup;
299 }
300
301 /* Object type is OK, return it */
302
303 *ReturnDesc = Info->ReturnObject;
304
305 Cleanup:
306 ACPI_FREE (Info);
307 return_ACPI_STATUS (Status);
308 }
309
310
311 /*******************************************************************************
312 *
313 * FUNCTION: AcpiUtEvaluateNumericObject
314 *
315 * PARAMETERS: ObjectName - Object name to be evaluated
316 * DeviceNode - Node for the device
317 * Value - Where the value is returned
318 *
319 * RETURN: Status
320 *
321 * DESCRIPTION: Evaluates a numeric namespace object for a selected device
322 * and stores result in *Value.
323 *
324 * NOTE: Internal function, no parameter validation
325 *
326 ******************************************************************************/
327
328 ACPI_STATUS
AcpiUtEvaluateNumericObject(const char * ObjectName,ACPI_NAMESPACE_NODE * DeviceNode,UINT64 * Value)329 AcpiUtEvaluateNumericObject (
330 const char *ObjectName,
331 ACPI_NAMESPACE_NODE *DeviceNode,
332 UINT64 *Value)
333 {
334 ACPI_OPERAND_OBJECT *ObjDesc;
335 ACPI_STATUS Status;
336
337
338 ACPI_FUNCTION_TRACE (UtEvaluateNumericObject);
339
340
341 Status = AcpiUtEvaluateObject (DeviceNode, ObjectName,
342 ACPI_BTYPE_INTEGER, &ObjDesc);
343 if (ACPI_FAILURE (Status))
344 {
345 return_ACPI_STATUS (Status);
346 }
347
348 /* Get the returned Integer */
349
350 *Value = ObjDesc->Integer.Value;
351
352 /* On exit, we must delete the return object */
353
354 AcpiUtRemoveReference (ObjDesc);
355 return_ACPI_STATUS (Status);
356 }
357
358
359 /*******************************************************************************
360 *
361 * FUNCTION: AcpiUtExecute_STA
362 *
363 * PARAMETERS: DeviceNode - Node for the device
364 * Flags - Where the status flags are returned
365 *
366 * RETURN: Status
367 *
368 * DESCRIPTION: Executes _STA for selected device and stores results in
369 * *Flags. If _STA does not exist, then the device is assumed
370 * to be present/functional/enabled (as per the ACPI spec).
371 *
372 * NOTE: Internal function, no parameter validation
373 *
374 ******************************************************************************/
375
376 ACPI_STATUS
AcpiUtExecute_STA(ACPI_NAMESPACE_NODE * DeviceNode,UINT32 * Flags)377 AcpiUtExecute_STA (
378 ACPI_NAMESPACE_NODE *DeviceNode,
379 UINT32 *Flags)
380 {
381 ACPI_OPERAND_OBJECT *ObjDesc;
382 ACPI_STATUS Status;
383
384
385 ACPI_FUNCTION_TRACE (UtExecute_STA);
386
387
388 Status = AcpiUtEvaluateObject (DeviceNode, METHOD_NAME__STA,
389 ACPI_BTYPE_INTEGER, &ObjDesc);
390 if (ACPI_FAILURE (Status))
391 {
392 if (AE_NOT_FOUND == Status)
393 {
394 /*
395 * if _STA does not exist, then (as per the ACPI specification),
396 * the returned flags will indicate that the device is present,
397 * functional, and enabled.
398 */
399 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC,
400 "_STA on %4.4s was not found, assuming device is present\n",
401 AcpiUtGetNodeName (DeviceNode)));
402
403 *Flags = ACPI_UINT32_MAX;
404 Status = AE_OK;
405 }
406
407 return_ACPI_STATUS (Status);
408 }
409
410 /* Extract the status flags */
411
412 *Flags = (UINT32) ObjDesc->Integer.Value;
413
414 /* On exit, we must delete the return object */
415
416 AcpiUtRemoveReference (ObjDesc);
417 return_ACPI_STATUS (Status);
418 }
419
420
421 /*******************************************************************************
422 *
423 * FUNCTION: AcpiUtExecutePowerMethods
424 *
425 * PARAMETERS: DeviceNode - Node for the device
426 * MethodNames - Array of power method names
427 * MethodCount - Number of methods to execute
428 * OutValues - Where the power method values are returned
429 *
430 * RETURN: Status, OutValues
431 *
432 * DESCRIPTION: Executes the specified power methods for the device and returns
433 * the result(s).
434 *
435 * NOTE: Internal function, no parameter validation
436 *
437 ******************************************************************************/
438
439 ACPI_STATUS
AcpiUtExecutePowerMethods(ACPI_NAMESPACE_NODE * DeviceNode,const char ** MethodNames,UINT8 MethodCount,UINT8 * OutValues)440 AcpiUtExecutePowerMethods (
441 ACPI_NAMESPACE_NODE *DeviceNode,
442 const char **MethodNames,
443 UINT8 MethodCount,
444 UINT8 *OutValues)
445 {
446 ACPI_OPERAND_OBJECT *ObjDesc;
447 ACPI_STATUS Status;
448 ACPI_STATUS FinalStatus = AE_NOT_FOUND;
449 UINT32 i;
450
451
452 ACPI_FUNCTION_TRACE (UtExecutePowerMethods);
453
454
455 for (i = 0; i < MethodCount; i++)
456 {
457 /*
458 * Execute the power method (_SxD or _SxW). The only allowable
459 * return type is an Integer.
460 */
461 Status = AcpiUtEvaluateObject (DeviceNode,
462 ACPI_CAST_PTR (char, MethodNames[i]),
463 ACPI_BTYPE_INTEGER, &ObjDesc);
464 if (ACPI_SUCCESS (Status))
465 {
466 OutValues[i] = (UINT8) ObjDesc->Integer.Value;
467
468 /* Delete the return object */
469
470 AcpiUtRemoveReference (ObjDesc);
471 FinalStatus = AE_OK; /* At least one value is valid */
472 continue;
473 }
474
475 OutValues[i] = ACPI_UINT8_MAX;
476 if (Status == AE_NOT_FOUND)
477 {
478 continue; /* Ignore if not found */
479 }
480
481 ACPI_DEBUG_PRINT ((ACPI_DB_EXEC, "Failed %s on Device %4.4s, %s\n",
482 ACPI_CAST_PTR (char, MethodNames[i]),
483 AcpiUtGetNodeName (DeviceNode), AcpiFormatException (Status)));
484 }
485
486 return_ACPI_STATUS (FinalStatus);
487 }
488
