Commit | Line | Data |
---|---|---|
e8707b34 BM |
1 | /****************************************************************************** |
2 | * | |
3 | * Module Name: nspredef - Validation of ACPI predefined methods and objects | |
e8707b34 BM |
4 | * |
5 | *****************************************************************************/ | |
6 | ||
7 | /* | |
25f044e6 | 8 | * Copyright (C) 2000 - 2013, Intel Corp. |
e8707b34 BM |
9 | * All rights reserved. |
10 | * | |
11 | * Redistribution and use in source and binary forms, with or without | |
12 | * modification, are permitted provided that the following conditions | |
13 | * are met: | |
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. | |
25 | * | |
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. | |
29 | * | |
30 | * NO WARRANTY | |
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. | |
42 | */ | |
43 | ||
999e08f9 BM |
44 | #define ACPI_CREATE_PREDEFINED_TABLE |
45 | ||
e8707b34 | 46 | #include <acpi/acpi.h> |
e2f7a777 LB |
47 | #include "accommon.h" |
48 | #include "acnamesp.h" | |
49 | #include "acpredef.h" | |
e8707b34 BM |
50 | |
51 | #define _COMPONENT ACPI_NAMESPACE | |
52 | ACPI_MODULE_NAME("nspredef") | |
53 | ||
54 | /******************************************************************************* | |
55 | * | |
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. | |
60 | * | |
61 | * There are several areas that are validated: | |
62 | * | |
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 | |
66 | * specification. | |
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. | |
70 | * | |
71 | * For any problems found, a warning message is issued. | |
72 | * | |
73 | ******************************************************************************/ | |
74 | /* Local prototypes */ | |
e8707b34 | 75 | static acpi_status |
0444e8f6 | 76 | acpi_ns_check_reference(struct acpi_predefined_data *data, |
e8707b34 BM |
77 | union acpi_operand_object *return_object); |
78 | ||
d5a36100 BM |
79 | static u32 acpi_ns_get_bitmapped_type(union acpi_operand_object *return_object); |
80 | ||
e8707b34 BM |
81 | /******************************************************************************* |
82 | * | |
83 | * FUNCTION: acpi_ns_check_predefined_names | |
84 | * | |
ba494bee | 85 | * PARAMETERS: node - Namespace node for the method/object |
0444e8f6 BM |
86 | * user_param_count - Number of parameters actually passed |
87 | * return_status - Status from the object evaluation | |
a647b5c3 BM |
88 | * return_object_ptr - Pointer to the object returned from the |
89 | * evaluation of a method or object | |
e8707b34 BM |
90 | * |
91 | * RETURN: Status | |
92 | * | |
93 | * DESCRIPTION: Check an ACPI name for a match in the predefined name list. | |
94 | * | |
95 | ******************************************************************************/ | |
96 | ||
97 | acpi_status | |
98 | acpi_ns_check_predefined_names(struct acpi_namespace_node *node, | |
eeb4437e BM |
99 | u32 user_param_count, |
100 | acpi_status return_status, | |
a647b5c3 | 101 | union acpi_operand_object **return_object_ptr) |
e8707b34 BM |
102 | { |
103 | acpi_status status = AE_OK; | |
104 | const union acpi_predefined_info *predefined; | |
105 | char *pathname; | |
0444e8f6 | 106 | struct acpi_predefined_data *data; |
e8707b34 BM |
107 | |
108 | /* Match the name for this method/object against the predefined list */ | |
109 | ||
c34c82bc | 110 | predefined = acpi_ut_match_predefined_method(node->name.ascii); |
e8707b34 | 111 | |
0444e8f6 | 112 | /* Get the full pathname to the object, for use in warning messages */ |
e8707b34 BM |
113 | |
114 | pathname = acpi_ns_get_external_pathname(node); | |
115 | if (!pathname) { | |
9c0d7939 | 116 | return (AE_OK); /* Could not get pathname, ignore */ |
e8707b34 BM |
117 | } |
118 | ||
119 | /* | |
eeb4437e BM |
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. | |
123 | */ | |
124 | acpi_ns_check_parameter_count(pathname, node, user_param_count, | |
125 | predefined); | |
126 | ||
127 | /* If not a predefined name, we cannot validate the return object */ | |
128 | ||
129 | if (!predefined) { | |
0444e8f6 | 130 | goto cleanup; |
eeb4437e BM |
131 | } |
132 | ||
133 | /* | |
0444e8f6 BM |
134 | * If the method failed or did not actually return an object, we cannot |
135 | * validate the return object | |
e8707b34 | 136 | */ |
0444e8f6 BM |
137 | if ((return_status != AE_OK) && (return_status != AE_CTRL_RETURN_VALUE)) { |
138 | goto cleanup; | |
eeb4437e BM |
139 | } |
140 | ||
e8707b34 | 141 | /* |
d57b23ad | 142 | * Return value validation and possible repair. |
307a0424 | 143 | * |
d57b23ad BM |
144 | * 1) Don't perform return value validation/repair if this feature |
145 | * has been disabled via a global option. | |
146 | * | |
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. | |
150 | * | |
151 | * 3) If the return value can be of any type, then we cannot perform | |
152 | * any validation, just exit. | |
e8707b34 | 153 | */ |
d57b23ad BM |
154 | if (acpi_gbl_disable_auto_repair || |
155 | (!predefined->info.expected_btypes) || | |
307a0424 | 156 | (predefined->info.expected_btypes == ACPI_RTYPE_ALL)) { |
0444e8f6 BM |
157 | goto cleanup; |
158 | } | |
159 | ||
160 | /* Create the parameter data block for object validation */ | |
161 | ||
162 | data = ACPI_ALLOCATE_ZEROED(sizeof(struct acpi_predefined_data)); | |
163 | if (!data) { | |
164 | goto cleanup; | |
e8707b34 | 165 | } |
0444e8f6 | 166 | data->predefined = predefined; |
8f9c9127 | 167 | data->node = node; |
0444e8f6 BM |
168 | data->node_flags = node->flags; |
169 | data->pathname = pathname; | |
e8707b34 BM |
170 | |
171 | /* | |
465da9eb BM |
172 | * Check that the type of the main return object is what is expected |
173 | * for this predefined name | |
e8707b34 | 174 | */ |
0444e8f6 | 175 | status = acpi_ns_check_object_type(data, return_object_ptr, |
e8707b34 | 176 | predefined->info.expected_btypes, |
0444e8f6 | 177 | ACPI_NOT_PACKAGE_ELEMENT); |
465da9eb BM |
178 | if (ACPI_FAILURE(status)) { |
179 | goto exit; | |
180 | } | |
181 | ||
182 | /* | |
183 | * For returned Package objects, check the type of all sub-objects. | |
184 | * Note: Package may have been newly created by call above. | |
185 | */ | |
186 | if ((*return_object_ptr)->common.type == ACPI_TYPE_PACKAGE) { | |
091f4d71 | 187 | data->parent_package = *return_object_ptr; |
465da9eb BM |
188 | status = acpi_ns_check_package(data, return_object_ptr); |
189 | if (ACPI_FAILURE(status)) { | |
190 | goto exit; | |
34c39c75 | 191 | } |
e8707b34 BM |
192 | } |
193 | ||
ad5babee | 194 | /* |
465da9eb BM |
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. | |
ad5babee BM |
201 | */ |
202 | status = acpi_ns_complex_repairs(data, node, status, return_object_ptr); | |
203 | ||
465da9eb | 204 | exit: |
0444e8f6 BM |
205 | /* |
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. | |
209 | */ | |
210 | if (ACPI_FAILURE(status) || (data->flags & ACPI_OBJECT_REPAIRED)) { | |
211 | node->flags |= ANOBJ_EVALUATED; | |
212 | } | |
213 | ACPI_FREE(data); | |
214 | ||
215 | cleanup: | |
65259094 | 216 | ACPI_FREE(pathname); |
e8707b34 BM |
217 | return (status); |
218 | } | |
219 | ||
220 | /******************************************************************************* | |
221 | * | |
222 | * FUNCTION: acpi_ns_check_parameter_count | |
223 | * | |
ba494bee BM |
224 | * PARAMETERS: pathname - Full pathname to the node (for error msgs) |
225 | * node - Namespace node for the method/object | |
eeb4437e | 226 | * user_param_count - Number of args passed in by the caller |
ba494bee | 227 | * predefined - Pointer to entry in predefined name table |
e8707b34 BM |
228 | * |
229 | * RETURN: None | |
230 | * | |
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.) | |
234 | * | |
235 | ******************************************************************************/ | |
236 | ||
237 | void | |
238 | acpi_ns_check_parameter_count(char *pathname, | |
239 | struct acpi_namespace_node *node, | |
eeb4437e | 240 | u32 user_param_count, |
e8707b34 BM |
241 | const union acpi_predefined_info *predefined) |
242 | { | |
243 | u32 param_count; | |
244 | u32 required_params_current; | |
245 | u32 required_params_old; | |
246 | ||
eeb4437e BM |
247 | /* Methods have 0-7 parameters. All other types have zero. */ |
248 | ||
e8707b34 BM |
249 | param_count = 0; |
250 | if (node->type == ACPI_TYPE_METHOD) { | |
251 | param_count = node->object->method.param_count; | |
252 | } | |
253 | ||
eeb4437e BM |
254 | if (!predefined) { |
255 | /* | |
0444e8f6 BM |
256 | * Check the parameter count for non-predefined methods/objects. |
257 | * | |
eeb4437e BM |
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. | |
262 | */ | |
263 | if (user_param_count < param_count) { | |
0444e8f6 BM |
264 | ACPI_WARN_PREDEFINED((AE_INFO, pathname, |
265 | ACPI_WARN_ALWAYS, | |
266 | "Insufficient arguments - needs %u, found %u", | |
267 | param_count, user_param_count)); | |
eeb4437e | 268 | } else if (user_param_count > param_count) { |
0444e8f6 BM |
269 | ACPI_WARN_PREDEFINED((AE_INFO, pathname, |
270 | ACPI_WARN_ALWAYS, | |
271 | "Excess arguments - needs %u, found %u", | |
272 | param_count, user_param_count)); | |
eeb4437e BM |
273 | } |
274 | return; | |
275 | } | |
276 | ||
0444e8f6 BM |
277 | /* |
278 | * Validate the user-supplied parameter count. | |
279 | * Allow two different legal argument counts (_SCP, etc.) | |
280 | */ | |
c34c82bc BM |
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; | |
e8707b34 | 285 | |
eeb4437e | 286 | if (user_param_count != ACPI_UINT32_MAX) { |
eeb4437e BM |
287 | if ((user_param_count != required_params_current) && |
288 | (user_param_count != required_params_old)) { | |
0444e8f6 BM |
289 | ACPI_WARN_PREDEFINED((AE_INFO, pathname, |
290 | ACPI_WARN_ALWAYS, | |
291 | "Parameter count mismatch - " | |
292 | "caller passed %u, ACPI requires %u", | |
293 | user_param_count, | |
294 | required_params_current)); | |
eeb4437e BM |
295 | } |
296 | } | |
297 | ||
eeb4437e BM |
298 | /* |
299 | * Check that the ASL-defined parameter count is what is expected for | |
0444e8f6 BM |
300 | * this predefined name (parameter count as defined by the ACPI |
301 | * specification) | |
eeb4437e | 302 | */ |
e8707b34 BM |
303 | if ((param_count != required_params_current) && |
304 | (param_count != required_params_old)) { | |
0444e8f6 BM |
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)); | |
e8707b34 BM |
308 | } |
309 | } | |
310 | ||
e8707b34 BM |
311 | /******************************************************************************* |
312 | * | |
313 | * FUNCTION: acpi_ns_check_object_type | |
314 | * | |
ba494bee | 315 | * PARAMETERS: data - Pointer to validation data structure |
a647b5c3 BM |
316 | * return_object_ptr - Pointer to the object returned from the |
317 | * evaluation of a method or object | |
e8707b34 BM |
318 | * expected_btypes - Bitmap of expected return type(s) |
319 | * package_index - Index of object within parent package (if | |
0444e8f6 BM |
320 | * applicable - ACPI_NOT_PACKAGE_ELEMENT |
321 | * otherwise) | |
e8707b34 BM |
322 | * |
323 | * RETURN: Status | |
324 | * | |
325 | * DESCRIPTION: Check the type of the return object against the expected object | |
326 | * type(s). Use of Btype allows multiple expected object types. | |
327 | * | |
328 | ******************************************************************************/ | |
329 | ||
42f8fb75 | 330 | acpi_status |
0444e8f6 | 331 | acpi_ns_check_object_type(struct acpi_predefined_data *data, |
a647b5c3 | 332 | union acpi_operand_object **return_object_ptr, |
e8707b34 BM |
333 | u32 expected_btypes, u32 package_index) |
334 | { | |
a647b5c3 | 335 | union acpi_operand_object *return_object = *return_object_ptr; |
e8707b34 | 336 | acpi_status status = AE_OK; |
e8707b34 | 337 | char type_buffer[48]; /* Room for 5 types */ |
e8707b34 | 338 | |
e8707b34 BM |
339 | /* A Namespace node should not get here, but make sure */ |
340 | ||
d5a36100 BM |
341 | if (return_object && |
342 | ACPI_GET_DESCRIPTOR_TYPE(return_object) == ACPI_DESC_TYPE_NAMED) { | |
0444e8f6 BM |
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. | |
347 | type))); | |
e8707b34 BM |
348 | return (AE_AML_OPERAND_TYPE); |
349 | } | |
350 | ||
351 | /* | |
352 | * Convert the object type (ACPI_TYPE_xxx) to a bitmapped object type. | |
353 | * The bitmapped type allows multiple possible return types. | |
354 | * | |
355 | * Note, the cases below must handle all of the possible types returned | |
356 | * from all of the predefined names (including elements of returned | |
357 | * packages) | |
358 | */ | |
d5a36100 BM |
359 | data->return_btype = acpi_ns_get_bitmapped_type(return_object); |
360 | if (data->return_btype == ACPI_RTYPE_ANY) { | |
e8707b34 | 361 | |
e8707b34 | 362 | /* Not one of the supported objects, must be incorrect */ |
e8707b34 BM |
363 | goto type_error_exit; |
364 | } | |
365 | ||
d5a36100 | 366 | /* For reference objects, check that the reference type is correct */ |
2147d3f0 | 367 | |
d5a36100 BM |
368 | if ((data->return_btype & expected_btypes) == ACPI_RTYPE_REFERENCE) { |
369 | status = acpi_ns_check_reference(data, return_object); | |
2147d3f0 | 370 | return (status); |
e8707b34 BM |
371 | } |
372 | ||
d5a36100 | 373 | /* Attempt simple repair of the returned object if necessary */ |
e8707b34 | 374 | |
d5a36100 | 375 | status = acpi_ns_simple_repair(data, expected_btypes, |
2147d3f0 | 376 | package_index, return_object_ptr); |
d5a36100 | 377 | return (status); |
e8707b34 | 378 | |
e8707b34 BM |
379 | type_error_exit: |
380 | ||
381 | /* Create a string with all expected types for this predefined object */ | |
382 | ||
c34c82bc | 383 | acpi_ut_get_expected_return_types(type_buffer, expected_btypes); |
e8707b34 | 384 | |
0444e8f6 BM |
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)); | |
e8707b34 | 390 | } else { |
0444e8f6 BM |
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)); | |
e8707b34 BM |
396 | } |
397 | ||
398 | return (AE_AML_OPERAND_TYPE); | |
399 | } | |
400 | ||
401 | /******************************************************************************* | |
402 | * | |
403 | * FUNCTION: acpi_ns_check_reference | |
404 | * | |
ba494bee | 405 | * PARAMETERS: data - Pointer to validation data structure |
e8707b34 BM |
406 | * return_object - Object returned from the evaluation of a |
407 | * method or object | |
408 | * | |
409 | * RETURN: Status | |
410 | * | |
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. | |
414 | * | |
415 | ******************************************************************************/ | |
416 | ||
417 | static acpi_status | |
0444e8f6 | 418 | acpi_ns_check_reference(struct acpi_predefined_data *data, |
e8707b34 BM |
419 | union acpi_operand_object *return_object) |
420 | { | |
421 | ||
422 | /* | |
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) | |
426 | */ | |
427 | if (return_object->reference.class == ACPI_REFCLASS_NAME) { | |
428 | return (AE_OK); | |
429 | } | |
430 | ||
0444e8f6 BM |
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)); | |
e8707b34 BM |
435 | |
436 | return (AE_AML_OPERAND_TYPE); | |
437 | } | |
a647b5c3 | 438 | |
d5a36100 BM |
439 | /******************************************************************************* |
440 | * | |
441 | * FUNCTION: acpi_ns_get_bitmapped_type | |
442 | * | |
443 | * PARAMETERS: return_object - Object returned from method/obj evaluation | |
444 | * | |
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). | |
448 | * | |
449 | * DESCRIPTION: Convert object type into a bitmapped object return type. | |
450 | * | |
451 | ******************************************************************************/ | |
452 | ||
453 | static u32 acpi_ns_get_bitmapped_type(union acpi_operand_object *return_object) | |
454 | { | |
455 | u32 return_btype; | |
456 | ||
457 | if (!return_object) { | |
458 | return (ACPI_RTYPE_NONE); | |
459 | } | |
460 | ||
461 | /* Map acpi_object_type to internal bitmapped type */ | |
462 | ||
463 | switch (return_object->common.type) { | |
464 | case ACPI_TYPE_INTEGER: | |
465 | return_btype = ACPI_RTYPE_INTEGER; | |
466 | break; | |
467 | ||
468 | case ACPI_TYPE_BUFFER: | |
469 | return_btype = ACPI_RTYPE_BUFFER; | |
470 | break; | |
471 | ||
472 | case ACPI_TYPE_STRING: | |
473 | return_btype = ACPI_RTYPE_STRING; | |
474 | break; | |
475 | ||
476 | case ACPI_TYPE_PACKAGE: | |
477 | return_btype = ACPI_RTYPE_PACKAGE; | |
478 | break; | |
479 | ||
480 | case ACPI_TYPE_LOCAL_REFERENCE: | |
481 | return_btype = ACPI_RTYPE_REFERENCE; | |
482 | break; | |
483 | ||
484 | default: | |
485 | /* Not one of the supported objects, must be incorrect */ | |
486 | ||
487 | return_btype = ACPI_RTYPE_ANY; | |
488 | break; | |
489 | } | |
490 | ||
491 | return (return_btype); | |
492 | } |