1 /******************************************************************************
3 * Module Name: uteval - Object evaluation
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2008, 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.
44 #include <acpi/acpi.h>
45 #include <acpi/acnamesp.h>
46 #include <acpi/acinterp.h>
48 #define _COMPONENT ACPI_UTILITIES
49 ACPI_MODULE_NAME("uteval")
51 /* Local prototypes */
53 acpi_ut_copy_id_string(char *destination
, char *source
, acpi_size max_length
);
56 acpi_ut_translate_one_cid(union acpi_operand_object
*obj_desc
,
57 struct acpi_compatible_id
*one_cid
);
60 * Strings supported by the _OSI predefined (internal) method.
62 static char *acpi_interfaces_supported
[] = {
63 /* Operating System Vendor Strings */
65 "Windows 2000", /* Windows 2000 */
66 "Windows 2001", /* Windows XP */
67 "Windows 2001 SP1", /* Windows XP SP1 */
68 "Windows 2001 SP2", /* Windows XP SP2 */
69 "Windows 2001.1", /* Windows Server 2003 */
70 "Windows 2001.1 SP1", /* Windows Server 2003 SP1 - Added 03/2006 */
71 "Windows 2006", /* Windows Vista - Added 03/2006 */
73 /* Feature Group Strings */
75 "Extended Address Space Descriptor"
77 * All "optional" feature group strings (features that are implemented
78 * by the host) should be implemented in the host version of
79 * acpi_os_validate_interface and should not be added here.
83 /*******************************************************************************
85 * FUNCTION: acpi_ut_osi_implementation
87 * PARAMETERS: walk_state - Current walk state
91 * DESCRIPTION: Implementation of the _OSI predefined control method
93 ******************************************************************************/
95 acpi_status
acpi_ut_osi_implementation(struct acpi_walk_state
*walk_state
)
98 union acpi_operand_object
*string_desc
;
99 union acpi_operand_object
*return_desc
;
102 ACPI_FUNCTION_TRACE(ut_osi_implementation
);
104 /* Validate the string input argument */
106 string_desc
= walk_state
->arguments
[0].object
;
107 if (!string_desc
|| (string_desc
->common
.type
!= ACPI_TYPE_STRING
)) {
108 return_ACPI_STATUS(AE_TYPE
);
111 /* Create a return object */
113 return_desc
= acpi_ut_create_internal_object(ACPI_TYPE_INTEGER
);
115 return_ACPI_STATUS(AE_NO_MEMORY
);
118 /* Default return value is SUPPORTED */
120 return_desc
->integer
.value
= ACPI_UINT32_MAX
;
121 walk_state
->return_desc
= return_desc
;
123 /* Compare input string to static table of supported interfaces */
125 for (i
= 0; i
< ACPI_ARRAY_LENGTH(acpi_interfaces_supported
); i
++) {
127 (string_desc
->string
.pointer
,
128 acpi_interfaces_supported
[i
])) {
130 /* The interface is supported */
132 return_ACPI_STATUS(AE_CTRL_TERMINATE
);
137 * Did not match the string in the static table, call the host OSL to
138 * check for a match with one of the optional strings (such as
139 * "Module Device", "3.0 Thermal Model", etc.)
141 status
= acpi_os_validate_interface(string_desc
->string
.pointer
);
142 if (ACPI_SUCCESS(status
)) {
144 /* The interface is supported */
146 return_ACPI_STATUS(AE_CTRL_TERMINATE
);
149 /* The interface is not supported */
151 return_desc
->integer
.value
= 0;
152 return_ACPI_STATUS(AE_CTRL_TERMINATE
);
155 /*******************************************************************************
157 * FUNCTION: acpi_osi_invalidate
159 * PARAMETERS: interface_string
163 * DESCRIPTION: invalidate string in pre-defiend _OSI string list
165 ******************************************************************************/
167 acpi_status
acpi_osi_invalidate(char *interface
)
171 for (i
= 0; i
< ACPI_ARRAY_LENGTH(acpi_interfaces_supported
); i
++) {
172 if (!ACPI_STRCMP(interface
, acpi_interfaces_supported
[i
])) {
173 *acpi_interfaces_supported
[i
] = '\0';
180 /*******************************************************************************
182 * FUNCTION: acpi_ut_evaluate_object
184 * PARAMETERS: prefix_node - Starting node
185 * Path - Path to object from starting node
186 * expected_return_types - Bitmap of allowed return types
187 * return_desc - Where a return value is stored
191 * DESCRIPTION: Evaluates a namespace object and verifies the type of the
192 * return object. Common code that simplifies accessing objects
193 * that have required return objects of fixed types.
195 * NOTE: Internal function, no parameter validation
197 ******************************************************************************/
200 acpi_ut_evaluate_object(struct acpi_namespace_node
*prefix_node
,
202 u32 expected_return_btypes
,
203 union acpi_operand_object
**return_desc
)
205 struct acpi_evaluate_info
*info
;
209 ACPI_FUNCTION_TRACE(ut_evaluate_object
);
211 /* Allocate the evaluation information block */
213 info
= ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_evaluate_info
));
215 return_ACPI_STATUS(AE_NO_MEMORY
);
218 info
->prefix_node
= prefix_node
;
219 info
->pathname
= path
;
220 info
->parameter_type
= ACPI_PARAM_ARGS
;
222 /* Evaluate the object/method */
224 status
= acpi_ns_evaluate(info
);
225 if (ACPI_FAILURE(status
)) {
226 if (status
== AE_NOT_FOUND
) {
227 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
228 "[%4.4s.%s] was not found\n",
229 acpi_ut_get_node_name(prefix_node
),
232 ACPI_ERROR_METHOD("Method execution failed",
233 prefix_node
, path
, status
);
239 /* Did we get a return object? */
241 if (!info
->return_object
) {
242 if (expected_return_btypes
) {
243 ACPI_ERROR_METHOD("No object was returned from",
244 prefix_node
, path
, AE_NOT_EXIST
);
246 status
= AE_NOT_EXIST
;
252 /* Map the return object type to the bitmapped type */
254 switch (ACPI_GET_OBJECT_TYPE(info
->return_object
)) {
255 case ACPI_TYPE_INTEGER
:
256 return_btype
= ACPI_BTYPE_INTEGER
;
259 case ACPI_TYPE_BUFFER
:
260 return_btype
= ACPI_BTYPE_BUFFER
;
263 case ACPI_TYPE_STRING
:
264 return_btype
= ACPI_BTYPE_STRING
;
267 case ACPI_TYPE_PACKAGE
:
268 return_btype
= ACPI_BTYPE_PACKAGE
;
276 if ((acpi_gbl_enable_interpreter_slack
) && (!expected_return_btypes
)) {
278 * We received a return object, but one was not expected. This can
279 * happen frequently if the "implicit return" feature is enabled.
280 * Just delete the return object and return AE_OK.
282 acpi_ut_remove_reference(info
->return_object
);
286 /* Is the return object one of the expected types? */
288 if (!(expected_return_btypes
& return_btype
)) {
289 ACPI_ERROR_METHOD("Return object type is incorrect",
290 prefix_node
, path
, AE_TYPE
);
293 "Type returned from %s was incorrect: %s, expected Btypes: %X",
295 acpi_ut_get_object_type_name(info
->return_object
),
296 expected_return_btypes
));
298 /* On error exit, we must delete the return object */
300 acpi_ut_remove_reference(info
->return_object
);
305 /* Object type is OK, return it */
307 *return_desc
= info
->return_object
;
311 return_ACPI_STATUS(status
);
314 /*******************************************************************************
316 * FUNCTION: acpi_ut_evaluate_numeric_object
318 * PARAMETERS: object_name - Object name to be evaluated
319 * device_node - Node for the device
320 * Address - Where the value is returned
324 * DESCRIPTION: Evaluates a numeric namespace object for a selected device
325 * and stores result in *Address.
327 * NOTE: Internal function, no parameter validation
329 ******************************************************************************/
332 acpi_ut_evaluate_numeric_object(char *object_name
,
333 struct acpi_namespace_node
*device_node
,
334 acpi_integer
* address
)
336 union acpi_operand_object
*obj_desc
;
339 ACPI_FUNCTION_TRACE(ut_evaluate_numeric_object
);
341 status
= acpi_ut_evaluate_object(device_node
, object_name
,
342 ACPI_BTYPE_INTEGER
, &obj_desc
);
343 if (ACPI_FAILURE(status
)) {
344 return_ACPI_STATUS(status
);
347 /* Get the returned Integer */
349 *address
= obj_desc
->integer
.value
;
351 /* On exit, we must delete the return object */
353 acpi_ut_remove_reference(obj_desc
);
354 return_ACPI_STATUS(status
);
357 /*******************************************************************************
359 * FUNCTION: acpi_ut_copy_id_string
361 * PARAMETERS: Destination - Where to copy the string
362 * Source - Source string
363 * max_length - Length of the destination buffer
367 * DESCRIPTION: Copies an ID string for the _HID, _CID, and _UID methods.
368 * Performs removal of a leading asterisk if present -- workaround
369 * for a known issue on a bunch of machines.
371 ******************************************************************************/
374 acpi_ut_copy_id_string(char *destination
, char *source
, acpi_size max_length
)
378 * Workaround for ID strings that have a leading asterisk. This construct
379 * is not allowed by the ACPI specification (ID strings must be
380 * alphanumeric), but enough existing machines have this embedded in their
381 * ID strings that the following code is useful.
383 if (*source
== '*') {
387 /* Do the actual copy */
389 ACPI_STRNCPY(destination
, source
, max_length
);
392 /*******************************************************************************
394 * FUNCTION: acpi_ut_execute_HID
396 * PARAMETERS: device_node - Node for the device
397 * Hid - Where the HID is returned
401 * DESCRIPTION: Executes the _HID control method that returns the hardware
404 * NOTE: Internal function, no parameter validation
406 ******************************************************************************/
409 acpi_ut_execute_HID(struct acpi_namespace_node
*device_node
,
410 struct acpica_device_id
*hid
)
412 union acpi_operand_object
*obj_desc
;
415 ACPI_FUNCTION_TRACE(ut_execute_HID
);
417 status
= acpi_ut_evaluate_object(device_node
, METHOD_NAME__HID
,
418 ACPI_BTYPE_INTEGER
| ACPI_BTYPE_STRING
,
420 if (ACPI_FAILURE(status
)) {
421 return_ACPI_STATUS(status
);
424 if (ACPI_GET_OBJECT_TYPE(obj_desc
) == ACPI_TYPE_INTEGER
) {
426 /* Convert the Numeric HID to string */
428 acpi_ex_eisa_id_to_string((u32
) obj_desc
->integer
.value
,
431 /* Copy the String HID from the returned object */
433 acpi_ut_copy_id_string(hid
->value
, obj_desc
->string
.pointer
,
437 /* On exit, we must delete the return object */
439 acpi_ut_remove_reference(obj_desc
);
440 return_ACPI_STATUS(status
);
443 /*******************************************************************************
445 * FUNCTION: acpi_ut_translate_one_cid
447 * PARAMETERS: obj_desc - _CID object, must be integer or string
448 * one_cid - Where the CID string is returned
452 * DESCRIPTION: Return a numeric or string _CID value as a string.
455 * NOTE: Assumes a maximum _CID string length of
456 * ACPI_MAX_CID_LENGTH.
458 ******************************************************************************/
461 acpi_ut_translate_one_cid(union acpi_operand_object
*obj_desc
,
462 struct acpi_compatible_id
*one_cid
)
465 switch (ACPI_GET_OBJECT_TYPE(obj_desc
)) {
466 case ACPI_TYPE_INTEGER
:
468 /* Convert the Numeric CID to string */
470 acpi_ex_eisa_id_to_string((u32
) obj_desc
->integer
.value
,
474 case ACPI_TYPE_STRING
:
476 if (obj_desc
->string
.length
> ACPI_MAX_CID_LENGTH
) {
477 return (AE_AML_STRING_LIMIT
);
480 /* Copy the String CID from the returned object */
482 acpi_ut_copy_id_string(one_cid
->value
, obj_desc
->string
.pointer
,
483 ACPI_MAX_CID_LENGTH
);
492 /*******************************************************************************
494 * FUNCTION: acpi_ut_execute_CID
496 * PARAMETERS: device_node - Node for the device
497 * return_cid_list - Where the CID list is returned
501 * DESCRIPTION: Executes the _CID control method that returns one or more
502 * compatible hardware IDs for the device.
504 * NOTE: Internal function, no parameter validation
506 ******************************************************************************/
509 acpi_ut_execute_CID(struct acpi_namespace_node
* device_node
,
510 struct acpi_compatible_id_list
** return_cid_list
)
512 union acpi_operand_object
*obj_desc
;
516 struct acpi_compatible_id_list
*cid_list
;
519 ACPI_FUNCTION_TRACE(ut_execute_CID
);
521 /* Evaluate the _CID method for this device */
523 status
= acpi_ut_evaluate_object(device_node
, METHOD_NAME__CID
,
524 ACPI_BTYPE_INTEGER
| ACPI_BTYPE_STRING
525 | ACPI_BTYPE_PACKAGE
, &obj_desc
);
526 if (ACPI_FAILURE(status
)) {
527 return_ACPI_STATUS(status
);
530 /* Get the number of _CIDs returned */
533 if (ACPI_GET_OBJECT_TYPE(obj_desc
) == ACPI_TYPE_PACKAGE
) {
534 count
= obj_desc
->package
.count
;
537 /* Allocate a worst-case buffer for the _CIDs */
539 size
= (((count
- 1) * sizeof(struct acpi_compatible_id
)) +
540 sizeof(struct acpi_compatible_id_list
));
542 cid_list
= ACPI_ALLOCATE_ZEROED((acpi_size
) size
);
544 return_ACPI_STATUS(AE_NO_MEMORY
);
549 cid_list
->count
= count
;
550 cid_list
->size
= size
;
553 * A _CID can return either a single compatible ID or a package of
554 * compatible IDs. Each compatible ID can be one of the following:
555 * 1) Integer (32 bit compressed EISA ID) or
556 * 2) String (PCI ID format, e.g. "PCI\VEN_vvvv&DEV_dddd&SUBSYS_ssssssss")
559 /* The _CID object can be either a single CID or a package (list) of CIDs */
561 if (ACPI_GET_OBJECT_TYPE(obj_desc
) == ACPI_TYPE_PACKAGE
) {
563 /* Translate each package element */
565 for (i
= 0; i
< count
; i
++) {
567 acpi_ut_translate_one_cid(obj_desc
->package
.
570 if (ACPI_FAILURE(status
)) {
575 /* Only one CID, translate to a string */
577 status
= acpi_ut_translate_one_cid(obj_desc
, cid_list
->id
);
580 /* Cleanup on error */
582 if (ACPI_FAILURE(status
)) {
585 *return_cid_list
= cid_list
;
588 /* On exit, we must delete the _CID return object */
590 acpi_ut_remove_reference(obj_desc
);
591 return_ACPI_STATUS(status
);
594 /*******************************************************************************
596 * FUNCTION: acpi_ut_execute_UID
598 * PARAMETERS: device_node - Node for the device
599 * Uid - Where the UID is returned
603 * DESCRIPTION: Executes the _UID control method that returns the hardware
606 * NOTE: Internal function, no parameter validation
608 ******************************************************************************/
611 acpi_ut_execute_UID(struct acpi_namespace_node
*device_node
,
612 struct acpica_device_id
*uid
)
614 union acpi_operand_object
*obj_desc
;
617 ACPI_FUNCTION_TRACE(ut_execute_UID
);
619 status
= acpi_ut_evaluate_object(device_node
, METHOD_NAME__UID
,
620 ACPI_BTYPE_INTEGER
| ACPI_BTYPE_STRING
,
622 if (ACPI_FAILURE(status
)) {
623 return_ACPI_STATUS(status
);
626 if (ACPI_GET_OBJECT_TYPE(obj_desc
) == ACPI_TYPE_INTEGER
) {
628 /* Convert the Numeric UID to string */
630 acpi_ex_unsigned_integer_to_string(obj_desc
->integer
.value
,
633 /* Copy the String UID from the returned object */
635 acpi_ut_copy_id_string(uid
->value
, obj_desc
->string
.pointer
,
639 /* On exit, we must delete the return object */
641 acpi_ut_remove_reference(obj_desc
);
642 return_ACPI_STATUS(status
);
645 /*******************************************************************************
647 * FUNCTION: acpi_ut_execute_STA
649 * PARAMETERS: device_node - Node for the device
650 * Flags - Where the status flags are returned
654 * DESCRIPTION: Executes _STA for selected device and stores results in
657 * NOTE: Internal function, no parameter validation
659 ******************************************************************************/
662 acpi_ut_execute_STA(struct acpi_namespace_node
*device_node
, u32
* flags
)
664 union acpi_operand_object
*obj_desc
;
667 ACPI_FUNCTION_TRACE(ut_execute_STA
);
669 status
= acpi_ut_evaluate_object(device_node
, METHOD_NAME__STA
,
670 ACPI_BTYPE_INTEGER
, &obj_desc
);
671 if (ACPI_FAILURE(status
)) {
672 if (AE_NOT_FOUND
== status
) {
673 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
674 "_STA on %4.4s was not found, assuming device is present\n",
675 acpi_ut_get_node_name(device_node
)));
677 *flags
= ACPI_UINT32_MAX
;
681 return_ACPI_STATUS(status
);
684 /* Extract the status flags */
686 *flags
= (u32
) obj_desc
->integer
.value
;
688 /* On exit, we must delete the return object */
690 acpi_ut_remove_reference(obj_desc
);
691 return_ACPI_STATUS(status
);
694 /*******************************************************************************
696 * FUNCTION: acpi_ut_execute_Sxds
698 * PARAMETERS: device_node - Node for the device
699 * Flags - Where the status flags are returned
703 * DESCRIPTION: Executes _STA for selected device and stores results in
706 * NOTE: Internal function, no parameter validation
708 ******************************************************************************/
711 acpi_ut_execute_sxds(struct acpi_namespace_node
*device_node
, u8
* highest
)
713 union acpi_operand_object
*obj_desc
;
717 ACPI_FUNCTION_TRACE(ut_execute_sxds
);
719 for (i
= 0; i
< 4; i
++) {
721 status
= acpi_ut_evaluate_object(device_node
,
723 acpi_gbl_highest_dstate_names
725 ACPI_BTYPE_INTEGER
, &obj_desc
);
726 if (ACPI_FAILURE(status
)) {
727 if (status
!= AE_NOT_FOUND
) {
728 ACPI_DEBUG_PRINT((ACPI_DB_EXEC
,
729 "%s on Device %4.4s, %s\n",
731 acpi_gbl_highest_dstate_names
733 acpi_ut_get_node_name
735 acpi_format_exception
738 return_ACPI_STATUS(status
);
741 /* Extract the Dstate value */
743 highest
[i
] = (u8
) obj_desc
->integer
.value
;
745 /* Delete the return object */
747 acpi_ut_remove_reference(obj_desc
);
751 return_ACPI_STATUS(AE_OK
);