1 /******************************************************************************
3 * Module Name: nsrepair2 - Repair for objects returned by specific
6 *****************************************************************************/
9 * Copyright (C) 2000 - 2009, Intel Corp.
10 * All rights reserved.
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
15 * 1. Redistributions of source code must retain the above copyright
16 * notice, this list of conditions, and the following disclaimer,
17 * without modification.
18 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
19 * substantially similar to the "NO WARRANTY" disclaimer below
20 * ("Disclaimer") and any redistribution must be conditioned upon
21 * including a substantially similar Disclaimer requirement for further
22 * binary redistribution.
23 * 3. Neither the names of the above-listed copyright holders nor the names
24 * of any contributors may be used to endorse or promote products derived
25 * from this software without specific prior written permission.
27 * Alternatively, this software may be distributed under the terms of the
28 * GNU General Public License ("GPL") version 2 as published by the Free
29 * Software Foundation.
32 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
33 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
34 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
35 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
36 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
37 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
38 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
39 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
40 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
41 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
42 * POSSIBILITY OF SUCH DAMAGES.
45 #include <acpi/acpi.h>
49 #define _COMPONENT ACPI_NAMESPACE
50 ACPI_MODULE_NAME("nsrepair2")
53 * Information structure and handler for ACPI predefined names that can
54 * be repaired on a per-name basis.
57 acpi_status(*acpi_repair_function) (struct acpi_predefined_data *data,
58 union acpi_operand_object **return_object_ptr);
60 typedef struct acpi_repair_info {
61 char name[ACPI_NAME_SIZE];
62 acpi_repair_function repair_function;
66 /* Local prototypes */
68 static const struct acpi_repair_info *acpi_ns_match_repairable_name(struct
73 acpi_ns_repair_ALR(struct acpi_predefined_data *data,
74 union acpi_operand_object **return_object_ptr);
77 acpi_ns_repair_FDE(struct acpi_predefined_data *data,
78 union acpi_operand_object **return_object_ptr);
81 acpi_ns_repair_PSS(struct acpi_predefined_data *data,
82 union acpi_operand_object **return_object_ptr);
85 acpi_ns_repair_TSS(struct acpi_predefined_data *data,
86 union acpi_operand_object **return_object_ptr);
89 acpi_ns_check_sorted_list(struct acpi_predefined_data *data,
90 union acpi_operand_object *return_object,
93 u8 sort_direction, char *sort_key_name);
96 acpi_ns_remove_null_elements(union acpi_operand_object *package);
99 acpi_ns_sort_list(union acpi_operand_object **elements,
100 u32 count, u32 index, u8 sort_direction);
102 /* Values for sort_direction above */
104 #define ACPI_SORT_ASCENDING 0
105 #define ACPI_SORT_DESCENDING 1
108 * This table contains the names of the predefined methods for which we can
109 * perform more complex repairs.
113 * _ALR: Sort the list ascending by ambient_illuminance
114 * _FDE: Convert a Package or Buffer of BYTEs to a Buffer of DWORDs
115 * _GTM: Convert a Package or Buffer of BYTEs to a Buffer of DWORDs
116 * _PSS: Sort the list descending by Power
117 * _TSS: Sort the list descending by Power
119 static const struct acpi_repair_info acpi_ns_repairable_names[] = {
120 {"_ALR", acpi_ns_repair_ALR},
121 {"_FDE", acpi_ns_repair_FDE},
122 {"_GTM", acpi_ns_repair_FDE}, /* _GTM has same repair as _FDE */
123 {"_PSS", acpi_ns_repair_PSS},
124 {"_TSS", acpi_ns_repair_TSS},
125 {{0, 0, 0, 0}, NULL} /* Table terminator */
128 #define ACPI_FDE_FIELD_COUNT 5
129 #define ACPI_FDE_BYTE_BUFFER_SIZE 5
130 #define ACPI_FDE_DWORD_BUFFER_SIZE (ACPI_FDE_FIELD_COUNT * sizeof (u32))
132 /******************************************************************************
134 * FUNCTION: acpi_ns_complex_repairs
136 * PARAMETERS: Data - Pointer to validation data structure
137 * Node - Namespace node for the method/object
138 * validate_status - Original status of earlier validation
139 * return_object_ptr - Pointer to the object returned from the
140 * evaluation of a method or object
142 * RETURN: Status. AE_OK if repair was successful. If name is not
143 * matched, validate_status is returned.
145 * DESCRIPTION: Attempt to repair/convert a return object of a type that was
148 *****************************************************************************/
151 acpi_ns_complex_repairs(struct acpi_predefined_data *data,
152 struct acpi_namespace_node *node,
153 acpi_status validate_status,
154 union acpi_operand_object **return_object_ptr)
156 const struct acpi_repair_info *predefined;
159 /* Check if this name is in the list of repairable names */
161 predefined = acpi_ns_match_repairable_name(node);
163 return (validate_status);
166 status = predefined->repair_function(data, return_object_ptr);
170 /******************************************************************************
172 * FUNCTION: acpi_ns_match_repairable_name
174 * PARAMETERS: Node - Namespace node for the method/object
176 * RETURN: Pointer to entry in repair table. NULL indicates not found.
178 * DESCRIPTION: Check an object name against the repairable object list.
180 *****************************************************************************/
182 static const struct acpi_repair_info *acpi_ns_match_repairable_name(struct
186 const struct acpi_repair_info *this_name;
188 /* Search info table for a repairable predefined method/object name */
190 this_name = acpi_ns_repairable_names;
191 while (this_name->repair_function) {
192 if (ACPI_COMPARE_NAME(node->name.ascii, this_name->name)) {
198 return (NULL); /* Not found */
201 /******************************************************************************
203 * FUNCTION: acpi_ns_repair_ALR
205 * PARAMETERS: Data - Pointer to validation data structure
206 * return_object_ptr - Pointer to the object returned from the
207 * evaluation of a method or object
209 * RETURN: Status. AE_OK if object is OK or was repaired successfully
211 * DESCRIPTION: Repair for the _ALR object. If necessary, sort the object list
212 * ascending by the ambient illuminance values.
214 *****************************************************************************/
217 acpi_ns_repair_ALR(struct acpi_predefined_data *data,
218 union acpi_operand_object **return_object_ptr)
220 union acpi_operand_object *return_object = *return_object_ptr;
223 status = acpi_ns_check_sorted_list(data, return_object, 2, 1,
225 "AmbientIlluminance");
230 /******************************************************************************
232 * FUNCTION: acpi_ns_repair_FDE
234 * PARAMETERS: Data - Pointer to validation data structure
235 * return_object_ptr - Pointer to the object returned from the
236 * evaluation of a method or object
238 * RETURN: Status. AE_OK if object is OK or was repaired successfully
240 * DESCRIPTION: Repair for the _FDE and _GTM objects. The expected return
241 * value is a Buffer of 5 DWORDs. This function repairs two
243 * 1) The return value is a Buffer of BYTEs, not DWORDs
244 * 2) The return value is a Package of Integer objects
246 *****************************************************************************/
249 acpi_ns_repair_FDE(struct acpi_predefined_data *data,
250 union acpi_operand_object **return_object_ptr)
252 union acpi_operand_object *return_object = *return_object_ptr;
253 union acpi_operand_object **elements;
254 union acpi_operand_object *buffer_object;
260 switch (return_object->common.type) {
261 case ACPI_TYPE_BUFFER:
263 /* This is the expected type. Length should be (at least) 5 DWORDs */
265 if (return_object->buffer.length >= ACPI_FDE_DWORD_BUFFER_SIZE) {
269 /* We can only repair if we have exactly 5 BYTEs */
271 if (return_object->buffer.length != ACPI_FDE_BYTE_BUFFER_SIZE) {
272 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname,
274 "Incorrect return buffer length %u, expected %u",
275 return_object->buffer.length,
276 ACPI_FDE_DWORD_BUFFER_SIZE));
278 return (AE_AML_OPERAND_TYPE);
281 /* Create the new (larger) buffer object */
284 acpi_ut_create_buffer_object(ACPI_FDE_DWORD_BUFFER_SIZE);
285 if (!buffer_object) {
286 return (AE_NO_MEMORY);
289 /* Expand each byte to a DWORD */
291 byte_buffer = return_object->buffer.pointer;
293 ACPI_CAST_PTR(u32, buffer_object->buffer.pointer);
295 for (i = 0; i < ACPI_FDE_FIELD_COUNT; i++) {
296 *dword_buffer = (u32) *byte_buffer;
301 ACPI_INFO_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
302 "Expanded Byte Buffer to expected DWord Buffer"));
305 case ACPI_TYPE_PACKAGE:
307 /* All elements of the Package must be integers */
309 elements = return_object->package.elements;
311 ACPI_MIN(ACPI_FDE_FIELD_COUNT,
312 return_object->package.count);
314 for (i = 0; i < count; i++) {
316 ((*elements)->common.type != ACPI_TYPE_INTEGER)) {
317 return (AE_AML_OPERAND_TYPE);
322 /* Create the new buffer object to replace the Package */
325 acpi_ut_create_buffer_object(ACPI_FDE_DWORD_BUFFER_SIZE);
326 if (!buffer_object) {
327 return (AE_NO_MEMORY);
330 /* Copy the package elements (integers) to the buffer */
332 elements = return_object->package.elements;
334 ACPI_CAST_PTR(u32, buffer_object->buffer.pointer);
336 for (i = 0; i < count; i++) {
337 *dword_buffer = (u32) (*elements)->integer.value;
342 ACPI_INFO_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
343 "Converted Package to expected Buffer"));
347 return (AE_AML_OPERAND_TYPE);
350 /* Delete the original return object, return the new buffer object */
352 acpi_ut_remove_reference(return_object);
353 *return_object_ptr = buffer_object;
355 data->flags |= ACPI_OBJECT_REPAIRED;
359 /******************************************************************************
361 * FUNCTION: acpi_ns_repair_TSS
363 * PARAMETERS: Data - Pointer to validation data structure
364 * return_object_ptr - Pointer to the object returned from the
365 * evaluation of a method or object
367 * RETURN: Status. AE_OK if object is OK or was repaired successfully
369 * DESCRIPTION: Repair for the _TSS object. If necessary, sort the object list
370 * descending by the power dissipation values.
372 *****************************************************************************/
375 acpi_ns_repair_TSS(struct acpi_predefined_data *data,
376 union acpi_operand_object **return_object_ptr)
378 union acpi_operand_object *return_object = *return_object_ptr;
381 status = acpi_ns_check_sorted_list(data, return_object, 5, 1,
382 ACPI_SORT_DESCENDING,
388 /******************************************************************************
390 * FUNCTION: acpi_ns_repair_PSS
392 * PARAMETERS: Data - Pointer to validation data structure
393 * return_object_ptr - Pointer to the object returned from the
394 * evaluation of a method or object
396 * RETURN: Status. AE_OK if object is OK or was repaired successfully
398 * DESCRIPTION: Repair for the _PSS object. If necessary, sort the object list
399 * by the CPU frequencies. Check that the power dissipation values
400 * are all proportional to CPU frequency (i.e., sorting by
401 * frequency should be the same as sorting by power.)
403 *****************************************************************************/
406 acpi_ns_repair_PSS(struct acpi_predefined_data *data,
407 union acpi_operand_object **return_object_ptr)
409 union acpi_operand_object *return_object = *return_object_ptr;
410 union acpi_operand_object **outer_elements;
411 u32 outer_element_count;
412 union acpi_operand_object **elements;
413 union acpi_operand_object *obj_desc;
419 * Entries (sub-packages) in the _PSS Package must be sorted by power
420 * dissipation, in descending order. If it appears that the list is
421 * incorrectly sorted, sort it. We sort by cpu_frequency, since this
422 * should be proportional to the power.
424 status = acpi_ns_check_sorted_list(data, return_object, 6, 0,
425 ACPI_SORT_DESCENDING,
427 if (ACPI_FAILURE(status)) {
432 * We now know the list is correctly sorted by CPU frequency. Check if
433 * the power dissipation values are proportional.
435 previous_value = ACPI_UINT32_MAX;
436 outer_elements = return_object->package.elements;
437 outer_element_count = return_object->package.count;
439 for (i = 0; i < outer_element_count; i++) {
440 elements = (*outer_elements)->package.elements;
441 obj_desc = elements[1]; /* Index1 = power_dissipation */
443 if ((u32) obj_desc->integer.value > previous_value) {
444 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname,
446 "SubPackage[%u,%u] - suspicious power dissipation values",
450 previous_value = (u32) obj_desc->integer.value;
457 /******************************************************************************
459 * FUNCTION: acpi_ns_check_sorted_list
461 * PARAMETERS: Data - Pointer to validation data structure
462 * return_object - Pointer to the top-level returned object
463 * expected_count - Minimum length of each sub-package
464 * sort_index - Sub-package entry to sort on
465 * sort_direction - Ascending or descending
466 * sort_key_name - Name of the sort_index field
468 * RETURN: Status. AE_OK if the list is valid and is sorted correctly or
469 * has been repaired by sorting the list.
471 * DESCRIPTION: Check if the package list is valid and sorted correctly by the
472 * sort_index. If not, then sort the list.
474 *****************************************************************************/
477 acpi_ns_check_sorted_list(struct acpi_predefined_data *data,
478 union acpi_operand_object *return_object,
481 u8 sort_direction, char *sort_key_name)
483 u32 outer_element_count;
484 union acpi_operand_object **outer_elements;
485 union acpi_operand_object **elements;
486 union acpi_operand_object *obj_desc;
491 /* The top-level object must be a package */
493 if (return_object->common.type != ACPI_TYPE_PACKAGE) {
494 return (AE_AML_OPERAND_TYPE);
498 * Detect any NULL package elements and remove them from the
501 * TBD: We may want to do this for all predefined names that
502 * return a variable-length package of packages.
504 status = acpi_ns_remove_null_elements(return_object);
505 if (status == AE_NULL_ENTRY) {
506 ACPI_INFO_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
507 "NULL elements removed from package"));
509 /* Exit if package is now zero length */
511 if (!return_object->package.count) {
512 return (AE_NULL_ENTRY);
516 outer_elements = return_object->package.elements;
517 outer_element_count = return_object->package.count;
518 if (!outer_element_count) {
519 return (AE_AML_PACKAGE_LIMIT);
523 if (sort_direction == ACPI_SORT_DESCENDING) {
524 previous_value = ACPI_UINT32_MAX;
527 /* Examine each subpackage */
529 for (i = 0; i < outer_element_count; i++) {
531 /* Each element of the top-level package must also be a package */
533 if ((*outer_elements)->common.type != ACPI_TYPE_PACKAGE) {
534 return (AE_AML_OPERAND_TYPE);
537 /* Each sub-package must have the minimum length */
539 if ((*outer_elements)->package.count < expected_count) {
540 return (AE_AML_PACKAGE_LIMIT);
543 elements = (*outer_elements)->package.elements;
544 obj_desc = elements[sort_index];
546 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
547 return (AE_AML_OPERAND_TYPE);
551 * The list must be sorted in the specified order. If we detect a
552 * discrepancy, issue a warning and sort the entire list
554 if (((sort_direction == ACPI_SORT_ASCENDING) &&
555 (obj_desc->integer.value < previous_value)) ||
556 ((sort_direction == ACPI_SORT_DESCENDING) &&
557 (obj_desc->integer.value > previous_value))) {
559 acpi_ns_sort_list(return_object->package.elements,
560 outer_element_count, sort_index,
562 if (ACPI_FAILURE(status)) {
566 data->flags |= ACPI_OBJECT_REPAIRED;
568 ACPI_INFO_PREDEFINED((AE_INFO, data->pathname,
570 "Repaired unsorted list - now sorted by %s",
575 previous_value = (u32) obj_desc->integer.value;
582 /******************************************************************************
584 * FUNCTION: acpi_ns_remove_null_elements
586 * PARAMETERS: obj_desc - A Package object
588 * RETURN: Status. AE_NULL_ENTRY means that one or more elements were
591 * DESCRIPTION: Remove all NULL package elements and update the package count.
593 *****************************************************************************/
596 acpi_ns_remove_null_elements(union acpi_operand_object *obj_desc)
598 union acpi_operand_object **source;
599 union acpi_operand_object **dest;
600 acpi_status status = AE_OK;
605 count = obj_desc->package.count;
608 source = obj_desc->package.elements;
611 /* Examine all elements of the package object */
613 for (i = 0; i < count; i++) {
615 status = AE_NULL_ENTRY;
624 if (status == AE_NULL_ENTRY) {
626 /* NULL terminate list and update the package count */
629 obj_desc->package.count = new_count;
635 /******************************************************************************
637 * FUNCTION: acpi_ns_sort_list
639 * PARAMETERS: Elements - Package object element list
640 * Count - Element count for above
641 * Index - Sort by which package element
642 * sort_direction - Ascending or Descending sort
646 * DESCRIPTION: Sort the objects that are in a package element list.
648 * NOTE: Assumes that all NULL elements have been removed from the package.
650 *****************************************************************************/
653 acpi_ns_sort_list(union acpi_operand_object **elements,
654 u32 count, u32 index, u8 sort_direction)
656 union acpi_operand_object *obj_desc1;
657 union acpi_operand_object *obj_desc2;
658 union acpi_operand_object *temp_obj;
662 /* Simple bubble sort */
664 for (i = 1; i < count; i++) {
665 for (j = (count - 1); j >= i; j--) {
666 obj_desc1 = elements[j - 1]->package.elements[index];
667 obj_desc2 = elements[j]->package.elements[index];
669 if (((sort_direction == ACPI_SORT_ASCENDING) &&
670 (obj_desc1->integer.value >
671 obj_desc2->integer.value))
672 || ((sort_direction == ACPI_SORT_DESCENDING)
673 && (obj_desc1->integer.value <
674 obj_desc2->integer.value))) {
675 temp_obj = elements[j - 1];
676 elements[j - 1] = elements[j];
677 elements[j] = temp_obj;