1 /******************************************************************************
3 * Module Name: nspredef - Validation of ACPI predefined methods and objects
5 *****************************************************************************/
8 * Copyright (C) 2000 - 2013, 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 #define ACPI_CREATE_PREDEFINED_TABLE
46 #include <acpi/acpi.h>
51 #define _COMPONENT ACPI_NAMESPACE
52 ACPI_MODULE_NAME("nspredef")
54 /*******************************************************************************
56 * This module validates predefined ACPI objects that appear in the namespace,
57 * at the time they are evaluated (via acpi_evaluate_object). The purpose of this
58 * validation is to detect problems with BIOS-exposed predefined ACPI objects
59 * before the results are returned to the ACPI-related drivers.
61 * There are several areas that are validated:
63 * 1) The number of input arguments as defined by the method/object in the
64 * ASL is validated against the ACPI specification.
65 * 2) The type of the return object (if any) is validated against the ACPI
67 * 3) For returned package objects, the count of package elements is
68 * validated, as well as the type of each package element. Nested
69 * packages are supported.
71 * For any problems found, a warning message is issued.
73 ******************************************************************************/
74 /* Local prototypes */
76 acpi_ns_check_reference(struct acpi_predefined_data *data,
77 union acpi_operand_object *return_object);
79 static u32 acpi_ns_get_bitmapped_type(union acpi_operand_object *return_object);
81 /*******************************************************************************
83 * FUNCTION: acpi_ns_check_predefined_names
85 * PARAMETERS: node - Namespace node for the method/object
86 * user_param_count - Number of parameters actually passed
87 * return_status - Status from the object evaluation
88 * return_object_ptr - Pointer to the object returned from the
89 * evaluation of a method or object
93 * DESCRIPTION: Check an ACPI name for a match in the predefined name list.
95 ******************************************************************************/
98 acpi_ns_check_predefined_names(struct acpi_namespace_node *node,
100 acpi_status return_status,
101 union acpi_operand_object **return_object_ptr)
103 acpi_status status = AE_OK;
104 const union acpi_predefined_info *predefined;
106 struct acpi_predefined_data *data;
108 /* Match the name for this method/object against the predefined list */
110 predefined = acpi_ut_match_predefined_method(node->name.ascii);
112 /* Get the full pathname to the object, for use in warning messages */
114 pathname = acpi_ns_get_external_pathname(node);
116 return (AE_OK); /* Could not get pathname, ignore */
120 * Check that the parameter count for this method matches the ASL
121 * definition. For predefined names, ensure that both the caller and
122 * the method itself are in accordance with the ACPI specification.
124 acpi_ns_check_parameter_count(pathname, node, user_param_count,
127 /* If not a predefined name, we cannot validate the return object */
134 * If the method failed or did not actually return an object, we cannot
135 * validate the return object
137 if ((return_status != AE_OK) && (return_status != AE_CTRL_RETURN_VALUE)) {
142 * Return value validation and possible repair.
144 * 1) Don't perform return value validation/repair if this feature
145 * has been disabled via a global option.
147 * 2) We have a return value, but if one wasn't expected, just exit,
148 * this is not a problem. For example, if the "Implicit Return"
149 * feature is enabled, methods will always return a value.
151 * 3) If the return value can be of any type, then we cannot perform
152 * any validation, just exit.
154 if (acpi_gbl_disable_auto_repair ||
155 (!predefined->info.expected_btypes) ||
156 (predefined->info.expected_btypes == ACPI_RTYPE_ALL)) {
160 /* Create the parameter data block for object validation */
162 data = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_predefined_data));
166 data->predefined = predefined;
168 data->node_flags = node->flags;
169 data->pathname = pathname;
172 * Check that the type of the main return object is what is expected
173 * for this predefined name
175 status = acpi_ns_check_object_type(data, return_object_ptr,
176 predefined->info.expected_btypes,
177 ACPI_NOT_PACKAGE_ELEMENT);
178 if (ACPI_FAILURE(status)) {
183 * For returned Package objects, check the type of all sub-objects.
184 * Note: Package may have been newly created by call above.
186 if ((*return_object_ptr)->common.type == ACPI_TYPE_PACKAGE) {
187 data->parent_package = *return_object_ptr;
188 status = acpi_ns_check_package(data, return_object_ptr);
189 if (ACPI_FAILURE(status)) {
195 * The return object was OK, or it was successfully repaired above.
196 * Now make some additional checks such as verifying that package
197 * objects are sorted correctly (if required) or buffer objects have
198 * the correct data width (bytes vs. dwords). These repairs are
199 * performed on a per-name basis, i.e., the code is specific to
200 * particular predefined names.
202 status = acpi_ns_complex_repairs(data, node, status, return_object_ptr);
206 * If the object validation failed or if we successfully repaired one
207 * or more objects, mark the parent node to suppress further warning
208 * messages during the next evaluation of the same method/object.
210 if (ACPI_FAILURE(status) || (data->flags & ACPI_OBJECT_REPAIRED)) {
211 node->flags |= ANOBJ_EVALUATED;
220 /*******************************************************************************
222 * FUNCTION: acpi_ns_check_parameter_count
224 * PARAMETERS: pathname - Full pathname to the node (for error msgs)
225 * node - Namespace node for the method/object
226 * user_param_count - Number of args passed in by the caller
227 * predefined - Pointer to entry in predefined name table
231 * DESCRIPTION: Check that the declared (in ASL/AML) parameter count for a
232 * predefined name is what is expected (i.e., what is defined in
233 * the ACPI specification for this predefined name.)
235 ******************************************************************************/
238 acpi_ns_check_parameter_count(char *pathname,
239 struct acpi_namespace_node *node,
240 u32 user_param_count,
241 const union acpi_predefined_info *predefined)
244 u32 required_params_current;
245 u32 required_params_old;
247 /* Methods have 0-7 parameters. All other types have zero. */
250 if (node->type == ACPI_TYPE_METHOD) {
251 param_count = node->object->method.param_count;
256 * Check the parameter count for non-predefined methods/objects.
258 * Warning if too few or too many arguments have been passed by the
259 * caller. An incorrect number of arguments may not cause the method
260 * to fail. However, the method will fail if there are too few
261 * arguments and the method attempts to use one of the missing ones.
263 if (user_param_count < param_count) {
264 ACPI_WARN_PREDEFINED((AE_INFO, pathname,
266 "Insufficient arguments - needs %u, found %u",
267 param_count, user_param_count));
268 } else if (user_param_count > param_count) {
269 ACPI_WARN_PREDEFINED((AE_INFO, pathname,
271 "Excess arguments - needs %u, found %u",
272 param_count, user_param_count));
278 * Validate the user-supplied parameter count.
279 * Allow two different legal argument counts (_SCP, etc.)
281 required_params_current =
282 predefined->info.argument_list & METHOD_ARG_MASK;
283 required_params_old =
284 predefined->info.argument_list >> METHOD_ARG_BIT_WIDTH;
286 if (user_param_count != ACPI_UINT32_MAX) {
287 if ((user_param_count != required_params_current) &&
288 (user_param_count != required_params_old)) {
289 ACPI_WARN_PREDEFINED((AE_INFO, pathname,
291 "Parameter count mismatch - "
292 "caller passed %u, ACPI requires %u",
294 required_params_current));
299 * Check that the ASL-defined parameter count is what is expected for
300 * this predefined name (parameter count as defined by the ACPI
303 if ((param_count != required_params_current) &&
304 (param_count != required_params_old)) {
305 ACPI_WARN_PREDEFINED((AE_INFO, pathname, node->flags,
306 "Parameter count mismatch - ASL declared %u, ACPI requires %u",
307 param_count, required_params_current));
311 /*******************************************************************************
313 * FUNCTION: acpi_ns_check_object_type
315 * PARAMETERS: data - Pointer to validation data structure
316 * return_object_ptr - Pointer to the object returned from the
317 * evaluation of a method or object
318 * expected_btypes - Bitmap of expected return type(s)
319 * package_index - Index of object within parent package (if
320 * applicable - ACPI_NOT_PACKAGE_ELEMENT
325 * DESCRIPTION: Check the type of the return object against the expected object
326 * type(s). Use of Btype allows multiple expected object types.
328 ******************************************************************************/
331 acpi_ns_check_object_type(struct acpi_predefined_data *data,
332 union acpi_operand_object **return_object_ptr,
333 u32 expected_btypes, u32 package_index)
335 union acpi_operand_object *return_object = *return_object_ptr;
336 acpi_status status = AE_OK;
337 char type_buffer[48]; /* Room for 5 types */
339 /* A Namespace node should not get here, but make sure */
342 ACPI_GET_DESCRIPTOR_TYPE(return_object) == ACPI_DESC_TYPE_NAMED) {
343 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
344 "Invalid return type - Found a Namespace node [%4.4s] type %s",
345 return_object->node.name.ascii,
346 acpi_ut_get_type_name(return_object->node.
348 return (AE_AML_OPERAND_TYPE);
352 * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type.
353 * The bitmapped type allows multiple possible return types.
355 * Note, the cases below must handle all of the possible types returned
356 * from all of the predefined names (including elements of returned
359 data->return_btype = acpi_ns_get_bitmapped_type(return_object);
360 if (data->return_btype == ACPI_RTYPE_ANY) {
362 /* Not one of the supported objects, must be incorrect */
363 goto type_error_exit;
366 /* For reference objects, check that the reference type is correct */
368 if ((data->return_btype & expected_btypes) == ACPI_RTYPE_REFERENCE) {
369 status = acpi_ns_check_reference(data, return_object);
373 /* Attempt simple repair of the returned object if necessary */
375 status = acpi_ns_simple_repair(data, expected_btypes,
376 package_index, return_object_ptr);
381 /* Create a string with all expected types for this predefined object */
383 acpi_ut_get_expected_return_types(type_buffer, expected_btypes);
385 if (package_index == ACPI_NOT_PACKAGE_ELEMENT) {
386 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
387 "Return type mismatch - found %s, expected %s",
388 acpi_ut_get_object_type_name
389 (return_object), type_buffer));
391 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
392 "Return Package type mismatch at index %u - "
393 "found %s, expected %s", package_index,
394 acpi_ut_get_object_type_name
395 (return_object), type_buffer));
398 return (AE_AML_OPERAND_TYPE);
401 /*******************************************************************************
403 * FUNCTION: acpi_ns_check_reference
405 * PARAMETERS: data - Pointer to validation data structure
406 * return_object - Object returned from the evaluation of a
411 * DESCRIPTION: Check a returned reference object for the correct reference
412 * type. The only reference type that can be returned from a
413 * predefined method is a named reference. All others are invalid.
415 ******************************************************************************/
418 acpi_ns_check_reference(struct acpi_predefined_data *data,
419 union acpi_operand_object *return_object)
423 * Check the reference object for the correct reference type (opcode).
424 * The only type of reference that can be converted to an union acpi_object is
425 * a reference to a named object (reference class: NAME)
427 if (return_object->reference.class == ACPI_REFCLASS_NAME) {
431 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
432 "Return type mismatch - unexpected reference object type [%s] %2.2X",
433 acpi_ut_get_reference_name(return_object),
434 return_object->reference.class));
436 return (AE_AML_OPERAND_TYPE);
439 /*******************************************************************************
441 * FUNCTION: acpi_ns_get_bitmapped_type
443 * PARAMETERS: return_object - Object returned from method/obj evaluation
445 * RETURN: Object return type. ACPI_RTYPE_ANY indicates that the object
446 * type is not supported. ACPI_RTYPE_NONE indicates that no
447 * object was returned (return_object is NULL).
449 * DESCRIPTION: Convert object type into a bitmapped object return type.
451 ******************************************************************************/
453 static u32 acpi_ns_get_bitmapped_type(union acpi_operand_object *return_object)
457 if (!return_object) {
458 return (ACPI_RTYPE_NONE);
461 /* Map acpi_object_type to internal bitmapped type */
463 switch (return_object->common.type) {
464 case ACPI_TYPE_INTEGER:
465 return_btype = ACPI_RTYPE_INTEGER;
468 case ACPI_TYPE_BUFFER:
469 return_btype = ACPI_RTYPE_BUFFER;
472 case ACPI_TYPE_STRING:
473 return_btype = ACPI_RTYPE_STRING;
476 case ACPI_TYPE_PACKAGE:
477 return_btype = ACPI_RTYPE_PACKAGE;
480 case ACPI_TYPE_LOCAL_REFERENCE:
481 return_btype = ACPI_RTYPE_REFERENCE;
485 /* Not one of the supported objects, must be incorrect */
487 return_btype = ACPI_RTYPE_ANY;
491 return (return_btype);