Loading...
1/******************************************************************************
2 *
3 * Module Name: nsrepair2 - Repair for objects returned by specific
4 * predefined methods
5 *
6 *****************************************************************************/
7
8/*
9 * Copyright (C) 2000 - 2011, Intel Corp.
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
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.
26 *
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.
30 *
31 * NO WARRANTY
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.
43 */
44
45#include <acpi/acpi.h>
46#include "accommon.h"
47#include "acnamesp.h"
48
49#define _COMPONENT ACPI_NAMESPACE
50ACPI_MODULE_NAME("nsrepair2")
51
52/*
53 * Information structure and handler for ACPI predefined names that can
54 * be repaired on a per-name basis.
55 */
56typedef
57acpi_status(*acpi_repair_function) (struct acpi_predefined_data *data,
58 union acpi_operand_object **return_object_ptr);
59
60typedef struct acpi_repair_info {
61 char name[ACPI_NAME_SIZE];
62 acpi_repair_function repair_function;
63
64} acpi_repair_info;
65
66/* Local prototypes */
67
68static const struct acpi_repair_info *acpi_ns_match_repairable_name(struct
69 acpi_namespace_node
70 *node);
71
72static acpi_status
73acpi_ns_repair_ALR(struct acpi_predefined_data *data,
74 union acpi_operand_object **return_object_ptr);
75
76static acpi_status
77acpi_ns_repair_CID(struct acpi_predefined_data *data,
78 union acpi_operand_object **return_object_ptr);
79
80static acpi_status
81acpi_ns_repair_FDE(struct acpi_predefined_data *data,
82 union acpi_operand_object **return_object_ptr);
83
84static acpi_status
85acpi_ns_repair_HID(struct acpi_predefined_data *data,
86 union acpi_operand_object **return_object_ptr);
87
88static acpi_status
89acpi_ns_repair_PSS(struct acpi_predefined_data *data,
90 union acpi_operand_object **return_object_ptr);
91
92static acpi_status
93acpi_ns_repair_TSS(struct acpi_predefined_data *data,
94 union acpi_operand_object **return_object_ptr);
95
96static acpi_status
97acpi_ns_check_sorted_list(struct acpi_predefined_data *data,
98 union acpi_operand_object *return_object,
99 u32 expected_count,
100 u32 sort_index,
101 u8 sort_direction, char *sort_key_name);
102
103static void
104acpi_ns_sort_list(union acpi_operand_object **elements,
105 u32 count, u32 index, u8 sort_direction);
106
107/* Values for sort_direction above */
108
109#define ACPI_SORT_ASCENDING 0
110#define ACPI_SORT_DESCENDING 1
111
112/*
113 * This table contains the names of the predefined methods for which we can
114 * perform more complex repairs.
115 *
116 * As necessary:
117 *
118 * _ALR: Sort the list ascending by ambient_illuminance
119 * _CID: Strings: uppercase all, remove any leading asterisk
120 * _FDE: Convert Buffer of BYTEs to a Buffer of DWORDs
121 * _GTM: Convert Buffer of BYTEs to a Buffer of DWORDs
122 * _HID: Strings: uppercase all, remove any leading asterisk
123 * _PSS: Sort the list descending by Power
124 * _TSS: Sort the list descending by Power
125 *
126 * Names that must be packages, but cannot be sorted:
127 *
128 * _BCL: Values are tied to the Package index where they appear, and cannot
129 * be moved or sorted. These index values are used for _BQC and _BCM.
130 * However, we can fix the case where a buffer is returned, by converting
131 * it to a Package of integers.
132 */
133static const struct acpi_repair_info acpi_ns_repairable_names[] = {
134 {"_ALR", acpi_ns_repair_ALR},
135 {"_CID", acpi_ns_repair_CID},
136 {"_FDE", acpi_ns_repair_FDE},
137 {"_GTM", acpi_ns_repair_FDE}, /* _GTM has same repair as _FDE */
138 {"_HID", acpi_ns_repair_HID},
139 {"_PSS", acpi_ns_repair_PSS},
140 {"_TSS", acpi_ns_repair_TSS},
141 {{0, 0, 0, 0}, NULL} /* Table terminator */
142};
143
144#define ACPI_FDE_FIELD_COUNT 5
145#define ACPI_FDE_BYTE_BUFFER_SIZE 5
146#define ACPI_FDE_DWORD_BUFFER_SIZE (ACPI_FDE_FIELD_COUNT * sizeof (u32))
147
148/******************************************************************************
149 *
150 * FUNCTION: acpi_ns_complex_repairs
151 *
152 * PARAMETERS: Data - Pointer to validation data structure
153 * Node - Namespace node for the method/object
154 * validate_status - Original status of earlier validation
155 * return_object_ptr - Pointer to the object returned from the
156 * evaluation of a method or object
157 *
158 * RETURN: Status. AE_OK if repair was successful. If name is not
159 * matched, validate_status is returned.
160 *
161 * DESCRIPTION: Attempt to repair/convert a return object of a type that was
162 * not expected.
163 *
164 *****************************************************************************/
165
166acpi_status
167acpi_ns_complex_repairs(struct acpi_predefined_data *data,
168 struct acpi_namespace_node *node,
169 acpi_status validate_status,
170 union acpi_operand_object **return_object_ptr)
171{
172 const struct acpi_repair_info *predefined;
173 acpi_status status;
174
175 /* Check if this name is in the list of repairable names */
176
177 predefined = acpi_ns_match_repairable_name(node);
178 if (!predefined) {
179 return (validate_status);
180 }
181
182 status = predefined->repair_function(data, return_object_ptr);
183 return (status);
184}
185
186/******************************************************************************
187 *
188 * FUNCTION: acpi_ns_match_repairable_name
189 *
190 * PARAMETERS: Node - Namespace node for the method/object
191 *
192 * RETURN: Pointer to entry in repair table. NULL indicates not found.
193 *
194 * DESCRIPTION: Check an object name against the repairable object list.
195 *
196 *****************************************************************************/
197
198static const struct acpi_repair_info *acpi_ns_match_repairable_name(struct
199 acpi_namespace_node
200 *node)
201{
202 const struct acpi_repair_info *this_name;
203
204 /* Search info table for a repairable predefined method/object name */
205
206 this_name = acpi_ns_repairable_names;
207 while (this_name->repair_function) {
208 if (ACPI_COMPARE_NAME(node->name.ascii, this_name->name)) {
209 return (this_name);
210 }
211 this_name++;
212 }
213
214 return (NULL); /* Not found */
215}
216
217/******************************************************************************
218 *
219 * FUNCTION: acpi_ns_repair_ALR
220 *
221 * PARAMETERS: Data - Pointer to validation data structure
222 * return_object_ptr - Pointer to the object returned from the
223 * evaluation of a method or object
224 *
225 * RETURN: Status. AE_OK if object is OK or was repaired successfully
226 *
227 * DESCRIPTION: Repair for the _ALR object. If necessary, sort the object list
228 * ascending by the ambient illuminance values.
229 *
230 *****************************************************************************/
231
232static acpi_status
233acpi_ns_repair_ALR(struct acpi_predefined_data *data,
234 union acpi_operand_object **return_object_ptr)
235{
236 union acpi_operand_object *return_object = *return_object_ptr;
237 acpi_status status;
238
239 status = acpi_ns_check_sorted_list(data, return_object, 2, 1,
240 ACPI_SORT_ASCENDING,
241 "AmbientIlluminance");
242
243 return (status);
244}
245
246/******************************************************************************
247 *
248 * FUNCTION: acpi_ns_repair_FDE
249 *
250 * PARAMETERS: Data - Pointer to validation data structure
251 * return_object_ptr - Pointer to the object returned from the
252 * evaluation of a method or object
253 *
254 * RETURN: Status. AE_OK if object is OK or was repaired successfully
255 *
256 * DESCRIPTION: Repair for the _FDE and _GTM objects. The expected return
257 * value is a Buffer of 5 DWORDs. This function repairs a common
258 * problem where the return value is a Buffer of BYTEs, not
259 * DWORDs.
260 *
261 *****************************************************************************/
262
263static acpi_status
264acpi_ns_repair_FDE(struct acpi_predefined_data *data,
265 union acpi_operand_object **return_object_ptr)
266{
267 union acpi_operand_object *return_object = *return_object_ptr;
268 union acpi_operand_object *buffer_object;
269 u8 *byte_buffer;
270 u32 *dword_buffer;
271 u32 i;
272
273 ACPI_FUNCTION_NAME(ns_repair_FDE);
274
275 switch (return_object->common.type) {
276 case ACPI_TYPE_BUFFER:
277
278 /* This is the expected type. Length should be (at least) 5 DWORDs */
279
280 if (return_object->buffer.length >= ACPI_FDE_DWORD_BUFFER_SIZE) {
281 return (AE_OK);
282 }
283
284 /* We can only repair if we have exactly 5 BYTEs */
285
286 if (return_object->buffer.length != ACPI_FDE_BYTE_BUFFER_SIZE) {
287 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname,
288 data->node_flags,
289 "Incorrect return buffer length %u, expected %u",
290 return_object->buffer.length,
291 ACPI_FDE_DWORD_BUFFER_SIZE));
292
293 return (AE_AML_OPERAND_TYPE);
294 }
295
296 /* Create the new (larger) buffer object */
297
298 buffer_object =
299 acpi_ut_create_buffer_object(ACPI_FDE_DWORD_BUFFER_SIZE);
300 if (!buffer_object) {
301 return (AE_NO_MEMORY);
302 }
303
304 /* Expand each byte to a DWORD */
305
306 byte_buffer = return_object->buffer.pointer;
307 dword_buffer =
308 ACPI_CAST_PTR(u32, buffer_object->buffer.pointer);
309
310 for (i = 0; i < ACPI_FDE_FIELD_COUNT; i++) {
311 *dword_buffer = (u32) *byte_buffer;
312 dword_buffer++;
313 byte_buffer++;
314 }
315
316 ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
317 "%s Expanded Byte Buffer to expected DWord Buffer\n",
318 data->pathname));
319 break;
320
321 default:
322 return (AE_AML_OPERAND_TYPE);
323 }
324
325 /* Delete the original return object, return the new buffer object */
326
327 acpi_ut_remove_reference(return_object);
328 *return_object_ptr = buffer_object;
329
330 data->flags |= ACPI_OBJECT_REPAIRED;
331 return (AE_OK);
332}
333
334/******************************************************************************
335 *
336 * FUNCTION: acpi_ns_repair_CID
337 *
338 * PARAMETERS: Data - Pointer to validation data structure
339 * return_object_ptr - Pointer to the object returned from the
340 * evaluation of a method or object
341 *
342 * RETURN: Status. AE_OK if object is OK or was repaired successfully
343 *
344 * DESCRIPTION: Repair for the _CID object. If a string, ensure that all
345 * letters are uppercase and that there is no leading asterisk.
346 * If a Package, ensure same for all string elements.
347 *
348 *****************************************************************************/
349
350static acpi_status
351acpi_ns_repair_CID(struct acpi_predefined_data *data,
352 union acpi_operand_object **return_object_ptr)
353{
354 acpi_status status;
355 union acpi_operand_object *return_object = *return_object_ptr;
356 union acpi_operand_object **element_ptr;
357 union acpi_operand_object *original_element;
358 u16 original_ref_count;
359 u32 i;
360
361 /* Check for _CID as a simple string */
362
363 if (return_object->common.type == ACPI_TYPE_STRING) {
364 status = acpi_ns_repair_HID(data, return_object_ptr);
365 return (status);
366 }
367
368 /* Exit if not a Package */
369
370 if (return_object->common.type != ACPI_TYPE_PACKAGE) {
371 return (AE_OK);
372 }
373
374 /* Examine each element of the _CID package */
375
376 element_ptr = return_object->package.elements;
377 for (i = 0; i < return_object->package.count; i++) {
378 original_element = *element_ptr;
379 original_ref_count = original_element->common.reference_count;
380
381 status = acpi_ns_repair_HID(data, element_ptr);
382 if (ACPI_FAILURE(status)) {
383 return (status);
384 }
385
386 /* Take care with reference counts */
387
388 if (original_element != *element_ptr) {
389
390 /* Element was replaced */
391
392 (*element_ptr)->common.reference_count =
393 original_ref_count;
394
395 acpi_ut_remove_reference(original_element);
396 }
397
398 element_ptr++;
399 }
400
401 return (AE_OK);
402}
403
404/******************************************************************************
405 *
406 * FUNCTION: acpi_ns_repair_HID
407 *
408 * PARAMETERS: Data - Pointer to validation data structure
409 * return_object_ptr - Pointer to the object returned from the
410 * evaluation of a method or object
411 *
412 * RETURN: Status. AE_OK if object is OK or was repaired successfully
413 *
414 * DESCRIPTION: Repair for the _HID object. If a string, ensure that all
415 * letters are uppercase and that there is no leading asterisk.
416 *
417 *****************************************************************************/
418
419static acpi_status
420acpi_ns_repair_HID(struct acpi_predefined_data *data,
421 union acpi_operand_object **return_object_ptr)
422{
423 union acpi_operand_object *return_object = *return_object_ptr;
424 union acpi_operand_object *new_string;
425 char *source;
426 char *dest;
427
428 ACPI_FUNCTION_NAME(ns_repair_HID);
429
430 /* We only care about string _HID objects (not integers) */
431
432 if (return_object->common.type != ACPI_TYPE_STRING) {
433 return (AE_OK);
434 }
435
436 if (return_object->string.length == 0) {
437 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname, data->node_flags,
438 "Invalid zero-length _HID or _CID string"));
439
440 /* Return AE_OK anyway, let driver handle it */
441
442 data->flags |= ACPI_OBJECT_REPAIRED;
443 return (AE_OK);
444 }
445
446 /* It is simplest to always create a new string object */
447
448 new_string = acpi_ut_create_string_object(return_object->string.length);
449 if (!new_string) {
450 return (AE_NO_MEMORY);
451 }
452
453 /*
454 * Remove a leading asterisk if present. For some unknown reason, there
455 * are many machines in the field that contains IDs like this.
456 *
457 * Examples: "*PNP0C03", "*ACPI0003"
458 */
459 source = return_object->string.pointer;
460 if (*source == '*') {
461 source++;
462 new_string->string.length--;
463
464 ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
465 "%s: Removed invalid leading asterisk\n",
466 data->pathname));
467 }
468
469 /*
470 * Copy and uppercase the string. From the ACPI specification:
471 *
472 * A valid PNP ID must be of the form "AAA####" where A is an uppercase
473 * letter and # is a hex digit. A valid ACPI ID must be of the form
474 * "ACPI####" where # is a hex digit.
475 */
476 for (dest = new_string->string.pointer; *source; dest++, source++) {
477 *dest = (char)ACPI_TOUPPER(*source);
478 }
479
480 acpi_ut_remove_reference(return_object);
481 *return_object_ptr = new_string;
482 return (AE_OK);
483}
484
485/******************************************************************************
486 *
487 * FUNCTION: acpi_ns_repair_TSS
488 *
489 * PARAMETERS: Data - Pointer to validation data structure
490 * return_object_ptr - Pointer to the object returned from the
491 * evaluation of a method or object
492 *
493 * RETURN: Status. AE_OK if object is OK or was repaired successfully
494 *
495 * DESCRIPTION: Repair for the _TSS object. If necessary, sort the object list
496 * descending by the power dissipation values.
497 *
498 *****************************************************************************/
499
500static acpi_status
501acpi_ns_repair_TSS(struct acpi_predefined_data *data,
502 union acpi_operand_object **return_object_ptr)
503{
504 union acpi_operand_object *return_object = *return_object_ptr;
505 acpi_status status;
506 struct acpi_namespace_node *node;
507
508 /*
509 * We can only sort the _TSS return package if there is no _PSS in the
510 * same scope. This is because if _PSS is present, the ACPI specification
511 * dictates that the _TSS Power Dissipation field is to be ignored, and
512 * therefore some BIOSs leave garbage values in the _TSS Power field(s).
513 * In this case, it is best to just return the _TSS package as-is.
514 * (May, 2011)
515 */
516 status =
517 acpi_ns_get_node(data->node, "^_PSS", ACPI_NS_NO_UPSEARCH, &node);
518 if (ACPI_SUCCESS(status)) {
519 return (AE_OK);
520 }
521
522 status = acpi_ns_check_sorted_list(data, return_object, 5, 1,
523 ACPI_SORT_DESCENDING,
524 "PowerDissipation");
525
526 return (status);
527}
528
529/******************************************************************************
530 *
531 * FUNCTION: acpi_ns_repair_PSS
532 *
533 * PARAMETERS: Data - Pointer to validation data structure
534 * return_object_ptr - Pointer to the object returned from the
535 * evaluation of a method or object
536 *
537 * RETURN: Status. AE_OK if object is OK or was repaired successfully
538 *
539 * DESCRIPTION: Repair for the _PSS object. If necessary, sort the object list
540 * by the CPU frequencies. Check that the power dissipation values
541 * are all proportional to CPU frequency (i.e., sorting by
542 * frequency should be the same as sorting by power.)
543 *
544 *****************************************************************************/
545
546static acpi_status
547acpi_ns_repair_PSS(struct acpi_predefined_data *data,
548 union acpi_operand_object **return_object_ptr)
549{
550 union acpi_operand_object *return_object = *return_object_ptr;
551 union acpi_operand_object **outer_elements;
552 u32 outer_element_count;
553 union acpi_operand_object **elements;
554 union acpi_operand_object *obj_desc;
555 u32 previous_value;
556 acpi_status status;
557 u32 i;
558
559 /*
560 * Entries (sub-packages) in the _PSS Package must be sorted by power
561 * dissipation, in descending order. If it appears that the list is
562 * incorrectly sorted, sort it. We sort by cpu_frequency, since this
563 * should be proportional to the power.
564 */
565 status = acpi_ns_check_sorted_list(data, return_object, 6, 0,
566 ACPI_SORT_DESCENDING,
567 "CpuFrequency");
568 if (ACPI_FAILURE(status)) {
569 return (status);
570 }
571
572 /*
573 * We now know the list is correctly sorted by CPU frequency. Check if
574 * the power dissipation values are proportional.
575 */
576 previous_value = ACPI_UINT32_MAX;
577 outer_elements = return_object->package.elements;
578 outer_element_count = return_object->package.count;
579
580 for (i = 0; i < outer_element_count; i++) {
581 elements = (*outer_elements)->package.elements;
582 obj_desc = elements[1]; /* Index1 = power_dissipation */
583
584 if ((u32) obj_desc->integer.value > previous_value) {
585 ACPI_WARN_PREDEFINED((AE_INFO, data->pathname,
586 data->node_flags,
587 "SubPackage[%u,%u] - suspicious power dissipation values",
588 i - 1, i));
589 }
590
591 previous_value = (u32) obj_desc->integer.value;
592 outer_elements++;
593 }
594
595 return (AE_OK);
596}
597
598/******************************************************************************
599 *
600 * FUNCTION: acpi_ns_check_sorted_list
601 *
602 * PARAMETERS: Data - Pointer to validation data structure
603 * return_object - Pointer to the top-level returned object
604 * expected_count - Minimum length of each sub-package
605 * sort_index - Sub-package entry to sort on
606 * sort_direction - Ascending or descending
607 * sort_key_name - Name of the sort_index field
608 *
609 * RETURN: Status. AE_OK if the list is valid and is sorted correctly or
610 * has been repaired by sorting the list.
611 *
612 * DESCRIPTION: Check if the package list is valid and sorted correctly by the
613 * sort_index. If not, then sort the list.
614 *
615 *****************************************************************************/
616
617static acpi_status
618acpi_ns_check_sorted_list(struct acpi_predefined_data *data,
619 union acpi_operand_object *return_object,
620 u32 expected_count,
621 u32 sort_index,
622 u8 sort_direction, char *sort_key_name)
623{
624 u32 outer_element_count;
625 union acpi_operand_object **outer_elements;
626 union acpi_operand_object **elements;
627 union acpi_operand_object *obj_desc;
628 u32 i;
629 u32 previous_value;
630
631 ACPI_FUNCTION_NAME(ns_check_sorted_list);
632
633 /* The top-level object must be a package */
634
635 if (return_object->common.type != ACPI_TYPE_PACKAGE) {
636 return (AE_AML_OPERAND_TYPE);
637 }
638
639 /*
640 * NOTE: assumes list of sub-packages contains no NULL elements.
641 * Any NULL elements should have been removed by earlier call
642 * to acpi_ns_remove_null_elements.
643 */
644 outer_elements = return_object->package.elements;
645 outer_element_count = return_object->package.count;
646 if (!outer_element_count) {
647 return (AE_AML_PACKAGE_LIMIT);
648 }
649
650 previous_value = 0;
651 if (sort_direction == ACPI_SORT_DESCENDING) {
652 previous_value = ACPI_UINT32_MAX;
653 }
654
655 /* Examine each subpackage */
656
657 for (i = 0; i < outer_element_count; i++) {
658
659 /* Each element of the top-level package must also be a package */
660
661 if ((*outer_elements)->common.type != ACPI_TYPE_PACKAGE) {
662 return (AE_AML_OPERAND_TYPE);
663 }
664
665 /* Each sub-package must have the minimum length */
666
667 if ((*outer_elements)->package.count < expected_count) {
668 return (AE_AML_PACKAGE_LIMIT);
669 }
670
671 elements = (*outer_elements)->package.elements;
672 obj_desc = elements[sort_index];
673
674 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
675 return (AE_AML_OPERAND_TYPE);
676 }
677
678 /*
679 * The list must be sorted in the specified order. If we detect a
680 * discrepancy, sort the entire list.
681 */
682 if (((sort_direction == ACPI_SORT_ASCENDING) &&
683 (obj_desc->integer.value < previous_value)) ||
684 ((sort_direction == ACPI_SORT_DESCENDING) &&
685 (obj_desc->integer.value > previous_value))) {
686 acpi_ns_sort_list(return_object->package.elements,
687 outer_element_count, sort_index,
688 sort_direction);
689
690 data->flags |= ACPI_OBJECT_REPAIRED;
691
692 ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
693 "%s: Repaired unsorted list - now sorted by %s\n",
694 data->pathname, sort_key_name));
695 return (AE_OK);
696 }
697
698 previous_value = (u32) obj_desc->integer.value;
699 outer_elements++;
700 }
701
702 return (AE_OK);
703}
704
705/******************************************************************************
706 *
707 * FUNCTION: acpi_ns_sort_list
708 *
709 * PARAMETERS: Elements - Package object element list
710 * Count - Element count for above
711 * Index - Sort by which package element
712 * sort_direction - Ascending or Descending sort
713 *
714 * RETURN: None
715 *
716 * DESCRIPTION: Sort the objects that are in a package element list.
717 *
718 * NOTE: Assumes that all NULL elements have been removed from the package,
719 * and that all elements have been verified to be of type Integer.
720 *
721 *****************************************************************************/
722
723static void
724acpi_ns_sort_list(union acpi_operand_object **elements,
725 u32 count, u32 index, u8 sort_direction)
726{
727 union acpi_operand_object *obj_desc1;
728 union acpi_operand_object *obj_desc2;
729 union acpi_operand_object *temp_obj;
730 u32 i;
731 u32 j;
732
733 /* Simple bubble sort */
734
735 for (i = 1; i < count; i++) {
736 for (j = (count - 1); j >= i; j--) {
737 obj_desc1 = elements[j - 1]->package.elements[index];
738 obj_desc2 = elements[j]->package.elements[index];
739
740 if (((sort_direction == ACPI_SORT_ASCENDING) &&
741 (obj_desc1->integer.value >
742 obj_desc2->integer.value))
743 || ((sort_direction == ACPI_SORT_DESCENDING)
744 && (obj_desc1->integer.value <
745 obj_desc2->integer.value))) {
746 temp_obj = elements[j - 1];
747 elements[j - 1] = elements[j];
748 elements[j] = temp_obj;
749 }
750 }
751 }
752}
1/******************************************************************************
2 *
3 * Module Name: nsrepair2 - Repair for objects returned by specific
4 * predefined methods
5 *
6 *****************************************************************************/
7
8/*
9 * Copyright (C) 2000 - 2016, Intel Corp.
10 * All rights reserved.
11 *
12 * Redistribution and use in source and binary forms, with or without
13 * modification, are permitted provided that the following conditions
14 * are met:
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.
26 *
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.
30 *
31 * NO WARRANTY
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.
43 */
44
45#include <acpi/acpi.h>
46#include "accommon.h"
47#include "acnamesp.h"
48
49#define _COMPONENT ACPI_NAMESPACE
50ACPI_MODULE_NAME("nsrepair2")
51
52/*
53 * Information structure and handler for ACPI predefined names that can
54 * be repaired on a per-name basis.
55 */
56typedef
57acpi_status (*acpi_repair_function) (struct acpi_evaluate_info * info,
58 union acpi_operand_object **
59 return_object_ptr);
60
61typedef struct acpi_repair_info {
62 char name[ACPI_NAME_SIZE];
63 acpi_repair_function repair_function;
64
65} acpi_repair_info;
66
67/* Local prototypes */
68
69static const struct acpi_repair_info *acpi_ns_match_complex_repair(struct
70 acpi_namespace_node
71 *node);
72
73static acpi_status
74acpi_ns_repair_ALR(struct acpi_evaluate_info *info,
75 union acpi_operand_object **return_object_ptr);
76
77static acpi_status
78acpi_ns_repair_CID(struct acpi_evaluate_info *info,
79 union acpi_operand_object **return_object_ptr);
80
81static acpi_status
82acpi_ns_repair_CST(struct acpi_evaluate_info *info,
83 union acpi_operand_object **return_object_ptr);
84
85static acpi_status
86acpi_ns_repair_FDE(struct acpi_evaluate_info *info,
87 union acpi_operand_object **return_object_ptr);
88
89static acpi_status
90acpi_ns_repair_HID(struct acpi_evaluate_info *info,
91 union acpi_operand_object **return_object_ptr);
92
93static acpi_status
94acpi_ns_repair_PRT(struct acpi_evaluate_info *info,
95 union acpi_operand_object **return_object_ptr);
96
97static acpi_status
98acpi_ns_repair_PSS(struct acpi_evaluate_info *info,
99 union acpi_operand_object **return_object_ptr);
100
101static acpi_status
102acpi_ns_repair_TSS(struct acpi_evaluate_info *info,
103 union acpi_operand_object **return_object_ptr);
104
105static acpi_status
106acpi_ns_check_sorted_list(struct acpi_evaluate_info *info,
107 union acpi_operand_object *return_object,
108 u32 start_index,
109 u32 expected_count,
110 u32 sort_index,
111 u8 sort_direction, char *sort_key_name);
112
113/* Values for sort_direction above */
114
115#define ACPI_SORT_ASCENDING 0
116#define ACPI_SORT_DESCENDING 1
117
118static void
119acpi_ns_remove_element(union acpi_operand_object *obj_desc, u32 index);
120
121static void
122acpi_ns_sort_list(union acpi_operand_object **elements,
123 u32 count, u32 index, u8 sort_direction);
124
125/*
126 * This table contains the names of the predefined methods for which we can
127 * perform more complex repairs.
128 *
129 * As necessary:
130 *
131 * _ALR: Sort the list ascending by ambient_illuminance
132 * _CID: Strings: uppercase all, remove any leading asterisk
133 * _CST: Sort the list ascending by C state type
134 * _FDE: Convert Buffer of BYTEs to a Buffer of DWORDs
135 * _GTM: Convert Buffer of BYTEs to a Buffer of DWORDs
136 * _HID: Strings: uppercase all, remove any leading asterisk
137 * _PRT: Fix reversed source_name and source_index
138 * _PSS: Sort the list descending by Power
139 * _TSS: Sort the list descending by Power
140 *
141 * Names that must be packages, but cannot be sorted:
142 *
143 * _BCL: Values are tied to the Package index where they appear, and cannot
144 * be moved or sorted. These index values are used for _BQC and _BCM.
145 * However, we can fix the case where a buffer is returned, by converting
146 * it to a Package of integers.
147 */
148static const struct acpi_repair_info acpi_ns_repairable_names[] = {
149 {"_ALR", acpi_ns_repair_ALR},
150 {"_CID", acpi_ns_repair_CID},
151 {"_CST", acpi_ns_repair_CST},
152 {"_FDE", acpi_ns_repair_FDE},
153 {"_GTM", acpi_ns_repair_FDE}, /* _GTM has same repair as _FDE */
154 {"_HID", acpi_ns_repair_HID},
155 {"_PRT", acpi_ns_repair_PRT},
156 {"_PSS", acpi_ns_repair_PSS},
157 {"_TSS", acpi_ns_repair_TSS},
158 {{0, 0, 0, 0}, NULL} /* Table terminator */
159};
160
161#define ACPI_FDE_FIELD_COUNT 5
162#define ACPI_FDE_BYTE_BUFFER_SIZE 5
163#define ACPI_FDE_DWORD_BUFFER_SIZE (ACPI_FDE_FIELD_COUNT * sizeof (u32))
164
165/******************************************************************************
166 *
167 * FUNCTION: acpi_ns_complex_repairs
168 *
169 * PARAMETERS: info - Method execution information block
170 * node - Namespace node for the method/object
171 * validate_status - Original status of earlier validation
172 * return_object_ptr - Pointer to the object returned from the
173 * evaluation of a method or object
174 *
175 * RETURN: Status. AE_OK if repair was successful. If name is not
176 * matched, validate_status is returned.
177 *
178 * DESCRIPTION: Attempt to repair/convert a return object of a type that was
179 * not expected.
180 *
181 *****************************************************************************/
182
183acpi_status
184acpi_ns_complex_repairs(struct acpi_evaluate_info *info,
185 struct acpi_namespace_node *node,
186 acpi_status validate_status,
187 union acpi_operand_object **return_object_ptr)
188{
189 const struct acpi_repair_info *predefined;
190 acpi_status status;
191
192 /* Check if this name is in the list of repairable names */
193
194 predefined = acpi_ns_match_complex_repair(node);
195 if (!predefined) {
196 return (validate_status);
197 }
198
199 status = predefined->repair_function(info, return_object_ptr);
200 return (status);
201}
202
203/******************************************************************************
204 *
205 * FUNCTION: acpi_ns_match_complex_repair
206 *
207 * PARAMETERS: node - Namespace node for the method/object
208 *
209 * RETURN: Pointer to entry in repair table. NULL indicates not found.
210 *
211 * DESCRIPTION: Check an object name against the repairable object list.
212 *
213 *****************************************************************************/
214
215static const struct acpi_repair_info *acpi_ns_match_complex_repair(struct
216 acpi_namespace_node
217 *node)
218{
219 const struct acpi_repair_info *this_name;
220
221 /* Search info table for a repairable predefined method/object name */
222
223 this_name = acpi_ns_repairable_names;
224 while (this_name->repair_function) {
225 if (ACPI_COMPARE_NAME(node->name.ascii, this_name->name)) {
226 return (this_name);
227 }
228
229 this_name++;
230 }
231
232 return (NULL); /* Not found */
233}
234
235/******************************************************************************
236 *
237 * FUNCTION: acpi_ns_repair_ALR
238 *
239 * PARAMETERS: info - Method execution information block
240 * return_object_ptr - Pointer to the object returned from the
241 * evaluation of a method or object
242 *
243 * RETURN: Status. AE_OK if object is OK or was repaired successfully
244 *
245 * DESCRIPTION: Repair for the _ALR object. If necessary, sort the object list
246 * ascending by the ambient illuminance values.
247 *
248 *****************************************************************************/
249
250static acpi_status
251acpi_ns_repair_ALR(struct acpi_evaluate_info *info,
252 union acpi_operand_object **return_object_ptr)
253{
254 union acpi_operand_object *return_object = *return_object_ptr;
255 acpi_status status;
256
257 status = acpi_ns_check_sorted_list(info, return_object, 0, 2, 1,
258 ACPI_SORT_ASCENDING,
259 "AmbientIlluminance");
260
261 return (status);
262}
263
264/******************************************************************************
265 *
266 * FUNCTION: acpi_ns_repair_FDE
267 *
268 * PARAMETERS: info - Method execution information block
269 * return_object_ptr - Pointer to the object returned from the
270 * evaluation of a method or object
271 *
272 * RETURN: Status. AE_OK if object is OK or was repaired successfully
273 *
274 * DESCRIPTION: Repair for the _FDE and _GTM objects. The expected return
275 * value is a Buffer of 5 DWORDs. This function repairs a common
276 * problem where the return value is a Buffer of BYTEs, not
277 * DWORDs.
278 *
279 *****************************************************************************/
280
281static acpi_status
282acpi_ns_repair_FDE(struct acpi_evaluate_info *info,
283 union acpi_operand_object **return_object_ptr)
284{
285 union acpi_operand_object *return_object = *return_object_ptr;
286 union acpi_operand_object *buffer_object;
287 u8 *byte_buffer;
288 u32 *dword_buffer;
289 u32 i;
290
291 ACPI_FUNCTION_NAME(ns_repair_FDE);
292
293 switch (return_object->common.type) {
294 case ACPI_TYPE_BUFFER:
295
296 /* This is the expected type. Length should be (at least) 5 DWORDs */
297
298 if (return_object->buffer.length >= ACPI_FDE_DWORD_BUFFER_SIZE) {
299 return (AE_OK);
300 }
301
302 /* We can only repair if we have exactly 5 BYTEs */
303
304 if (return_object->buffer.length != ACPI_FDE_BYTE_BUFFER_SIZE) {
305 ACPI_WARN_PREDEFINED((AE_INFO,
306 info->full_pathname,
307 info->node_flags,
308 "Incorrect return buffer length %u, expected %u",
309 return_object->buffer.length,
310 ACPI_FDE_DWORD_BUFFER_SIZE));
311
312 return (AE_AML_OPERAND_TYPE);
313 }
314
315 /* Create the new (larger) buffer object */
316
317 buffer_object =
318 acpi_ut_create_buffer_object(ACPI_FDE_DWORD_BUFFER_SIZE);
319 if (!buffer_object) {
320 return (AE_NO_MEMORY);
321 }
322
323 /* Expand each byte to a DWORD */
324
325 byte_buffer = return_object->buffer.pointer;
326 dword_buffer = ACPI_CAST_PTR(u32,
327 buffer_object->buffer.pointer);
328
329 for (i = 0; i < ACPI_FDE_FIELD_COUNT; i++) {
330 *dword_buffer = (u32) *byte_buffer;
331 dword_buffer++;
332 byte_buffer++;
333 }
334
335 ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
336 "%s Expanded Byte Buffer to expected DWord Buffer\n",
337 info->full_pathname));
338 break;
339
340 default:
341
342 return (AE_AML_OPERAND_TYPE);
343 }
344
345 /* Delete the original return object, return the new buffer object */
346
347 acpi_ut_remove_reference(return_object);
348 *return_object_ptr = buffer_object;
349
350 info->return_flags |= ACPI_OBJECT_REPAIRED;
351 return (AE_OK);
352}
353
354/******************************************************************************
355 *
356 * FUNCTION: acpi_ns_repair_CID
357 *
358 * PARAMETERS: info - Method execution information block
359 * return_object_ptr - Pointer to the object returned from the
360 * evaluation of a method or object
361 *
362 * RETURN: Status. AE_OK if object is OK or was repaired successfully
363 *
364 * DESCRIPTION: Repair for the _CID object. If a string, ensure that all
365 * letters are uppercase and that there is no leading asterisk.
366 * If a Package, ensure same for all string elements.
367 *
368 *****************************************************************************/
369
370static acpi_status
371acpi_ns_repair_CID(struct acpi_evaluate_info *info,
372 union acpi_operand_object **return_object_ptr)
373{
374 acpi_status status;
375 union acpi_operand_object *return_object = *return_object_ptr;
376 union acpi_operand_object **element_ptr;
377 union acpi_operand_object *original_element;
378 u16 original_ref_count;
379 u32 i;
380
381 /* Check for _CID as a simple string */
382
383 if (return_object->common.type == ACPI_TYPE_STRING) {
384 status = acpi_ns_repair_HID(info, return_object_ptr);
385 return (status);
386 }
387
388 /* Exit if not a Package */
389
390 if (return_object->common.type != ACPI_TYPE_PACKAGE) {
391 return (AE_OK);
392 }
393
394 /* Examine each element of the _CID package */
395
396 element_ptr = return_object->package.elements;
397 for (i = 0; i < return_object->package.count; i++) {
398 original_element = *element_ptr;
399 original_ref_count = original_element->common.reference_count;
400
401 status = acpi_ns_repair_HID(info, element_ptr);
402 if (ACPI_FAILURE(status)) {
403 return (status);
404 }
405
406 /* Take care with reference counts */
407
408 if (original_element != *element_ptr) {
409
410 /* Element was replaced */
411
412 (*element_ptr)->common.reference_count =
413 original_ref_count;
414
415 acpi_ut_remove_reference(original_element);
416 }
417
418 element_ptr++;
419 }
420
421 return (AE_OK);
422}
423
424/******************************************************************************
425 *
426 * FUNCTION: acpi_ns_repair_CST
427 *
428 * PARAMETERS: info - Method execution information block
429 * return_object_ptr - Pointer to the object returned from the
430 * evaluation of a method or object
431 *
432 * RETURN: Status. AE_OK if object is OK or was repaired successfully
433 *
434 * DESCRIPTION: Repair for the _CST object:
435 * 1. Sort the list ascending by C state type
436 * 2. Ensure type cannot be zero
437 * 3. A subpackage count of zero means _CST is meaningless
438 * 4. Count must match the number of C state subpackages
439 *
440 *****************************************************************************/
441
442static acpi_status
443acpi_ns_repair_CST(struct acpi_evaluate_info *info,
444 union acpi_operand_object **return_object_ptr)
445{
446 union acpi_operand_object *return_object = *return_object_ptr;
447 union acpi_operand_object **outer_elements;
448 u32 outer_element_count;
449 union acpi_operand_object *obj_desc;
450 acpi_status status;
451 u8 removing;
452 u32 i;
453
454 ACPI_FUNCTION_NAME(ns_repair_CST);
455
456 /*
457 * Check if the C-state type values are proportional.
458 */
459 outer_element_count = return_object->package.count - 1;
460 i = 0;
461 while (i < outer_element_count) {
462 outer_elements = &return_object->package.elements[i + 1];
463 removing = FALSE;
464
465 if ((*outer_elements)->package.count == 0) {
466 ACPI_WARN_PREDEFINED((AE_INFO,
467 info->full_pathname,
468 info->node_flags,
469 "SubPackage[%u] - removing entry due to zero count",
470 i));
471 removing = TRUE;
472 goto remove_element;
473 }
474
475 obj_desc = (*outer_elements)->package.elements[1]; /* Index1 = Type */
476 if ((u32)obj_desc->integer.value == 0) {
477 ACPI_WARN_PREDEFINED((AE_INFO,
478 info->full_pathname,
479 info->node_flags,
480 "SubPackage[%u] - removing entry due to invalid Type(0)",
481 i));
482 removing = TRUE;
483 }
484
485remove_element:
486 if (removing) {
487 acpi_ns_remove_element(return_object, i + 1);
488 outer_element_count--;
489 } else {
490 i++;
491 }
492 }
493
494 /* Update top-level package count, Type "Integer" checked elsewhere */
495
496 obj_desc = return_object->package.elements[0];
497 obj_desc->integer.value = outer_element_count;
498
499 /*
500 * Entries (subpackages) in the _CST Package must be sorted by the
501 * C-state type, in ascending order.
502 */
503 status = acpi_ns_check_sorted_list(info, return_object, 1, 4, 1,
504 ACPI_SORT_ASCENDING, "C-State Type");
505 if (ACPI_FAILURE(status)) {
506 return (status);
507 }
508
509 return (AE_OK);
510}
511
512/******************************************************************************
513 *
514 * FUNCTION: acpi_ns_repair_HID
515 *
516 * PARAMETERS: info - Method execution information block
517 * return_object_ptr - Pointer to the object returned from the
518 * evaluation of a method or object
519 *
520 * RETURN: Status. AE_OK if object is OK or was repaired successfully
521 *
522 * DESCRIPTION: Repair for the _HID object. If a string, ensure that all
523 * letters are uppercase and that there is no leading asterisk.
524 *
525 *****************************************************************************/
526
527static acpi_status
528acpi_ns_repair_HID(struct acpi_evaluate_info *info,
529 union acpi_operand_object **return_object_ptr)
530{
531 union acpi_operand_object *return_object = *return_object_ptr;
532 union acpi_operand_object *new_string;
533 char *source;
534 char *dest;
535
536 ACPI_FUNCTION_NAME(ns_repair_HID);
537
538 /* We only care about string _HID objects (not integers) */
539
540 if (return_object->common.type != ACPI_TYPE_STRING) {
541 return (AE_OK);
542 }
543
544 if (return_object->string.length == 0) {
545 ACPI_WARN_PREDEFINED((AE_INFO,
546 info->full_pathname, info->node_flags,
547 "Invalid zero-length _HID or _CID string"));
548
549 /* Return AE_OK anyway, let driver handle it */
550
551 info->return_flags |= ACPI_OBJECT_REPAIRED;
552 return (AE_OK);
553 }
554
555 /* It is simplest to always create a new string object */
556
557 new_string = acpi_ut_create_string_object(return_object->string.length);
558 if (!new_string) {
559 return (AE_NO_MEMORY);
560 }
561
562 /*
563 * Remove a leading asterisk if present. For some unknown reason, there
564 * are many machines in the field that contains IDs like this.
565 *
566 * Examples: "*PNP0C03", "*ACPI0003"
567 */
568 source = return_object->string.pointer;
569 if (*source == '*') {
570 source++;
571 new_string->string.length--;
572
573 ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
574 "%s: Removed invalid leading asterisk\n",
575 info->full_pathname));
576 }
577
578 /*
579 * Copy and uppercase the string. From the ACPI 5.0 specification:
580 *
581 * A valid PNP ID must be of the form "AAA####" where A is an uppercase
582 * letter and # is a hex digit. A valid ACPI ID must be of the form
583 * "NNNN####" where N is an uppercase letter or decimal digit, and
584 * # is a hex digit.
585 */
586 for (dest = new_string->string.pointer; *source; dest++, source++) {
587 *dest = (char)toupper((int)*source);
588 }
589
590 acpi_ut_remove_reference(return_object);
591 *return_object_ptr = new_string;
592 return (AE_OK);
593}
594
595/******************************************************************************
596 *
597 * FUNCTION: acpi_ns_repair_PRT
598 *
599 * PARAMETERS: info - Method execution information block
600 * return_object_ptr - Pointer to the object returned from the
601 * evaluation of a method or object
602 *
603 * RETURN: Status. AE_OK if object is OK or was repaired successfully
604 *
605 * DESCRIPTION: Repair for the _PRT object. If necessary, fix reversed
606 * source_name and source_index field, a common BIOS bug.
607 *
608 *****************************************************************************/
609
610static acpi_status
611acpi_ns_repair_PRT(struct acpi_evaluate_info *info,
612 union acpi_operand_object **return_object_ptr)
613{
614 union acpi_operand_object *package_object = *return_object_ptr;
615 union acpi_operand_object **top_object_list;
616 union acpi_operand_object **sub_object_list;
617 union acpi_operand_object *obj_desc;
618 union acpi_operand_object *sub_package;
619 u32 element_count;
620 u32 index;
621
622 /* Each element in the _PRT package is a subpackage */
623
624 top_object_list = package_object->package.elements;
625 element_count = package_object->package.count;
626
627 /* Examine each subpackage */
628
629 for (index = 0; index < element_count; index++, top_object_list++) {
630 sub_package = *top_object_list;
631 sub_object_list = sub_package->package.elements;
632
633 /* Check for minimum required element count */
634
635 if (sub_package->package.count < 4) {
636 continue;
637 }
638
639 /*
640 * If the BIOS has erroneously reversed the _PRT source_name (index 2)
641 * and the source_index (index 3), fix it. _PRT is important enough to
642 * workaround this BIOS error. This also provides compatibility with
643 * other ACPI implementations.
644 */
645 obj_desc = sub_object_list[3];
646 if (!obj_desc || (obj_desc->common.type != ACPI_TYPE_INTEGER)) {
647 sub_object_list[3] = sub_object_list[2];
648 sub_object_list[2] = obj_desc;
649 info->return_flags |= ACPI_OBJECT_REPAIRED;
650
651 ACPI_WARN_PREDEFINED((AE_INFO,
652 info->full_pathname,
653 info->node_flags,
654 "PRT[%X]: Fixed reversed SourceName and SourceIndex",
655 index));
656 }
657 }
658
659 return (AE_OK);
660}
661
662/******************************************************************************
663 *
664 * FUNCTION: acpi_ns_repair_PSS
665 *
666 * PARAMETERS: info - Method execution information block
667 * return_object_ptr - Pointer to the object returned from the
668 * evaluation of a method or object
669 *
670 * RETURN: Status. AE_OK if object is OK or was repaired successfully
671 *
672 * DESCRIPTION: Repair for the _PSS object. If necessary, sort the object list
673 * by the CPU frequencies. Check that the power dissipation values
674 * are all proportional to CPU frequency (i.e., sorting by
675 * frequency should be the same as sorting by power.)
676 *
677 *****************************************************************************/
678
679static acpi_status
680acpi_ns_repair_PSS(struct acpi_evaluate_info *info,
681 union acpi_operand_object **return_object_ptr)
682{
683 union acpi_operand_object *return_object = *return_object_ptr;
684 union acpi_operand_object **outer_elements;
685 u32 outer_element_count;
686 union acpi_operand_object **elements;
687 union acpi_operand_object *obj_desc;
688 u32 previous_value;
689 acpi_status status;
690 u32 i;
691
692 /*
693 * Entries (subpackages) in the _PSS Package must be sorted by power
694 * dissipation, in descending order. If it appears that the list is
695 * incorrectly sorted, sort it. We sort by cpu_frequency, since this
696 * should be proportional to the power.
697 */
698 status = acpi_ns_check_sorted_list(info, return_object, 0, 6, 0,
699 ACPI_SORT_DESCENDING,
700 "CpuFrequency");
701 if (ACPI_FAILURE(status)) {
702 return (status);
703 }
704
705 /*
706 * We now know the list is correctly sorted by CPU frequency. Check if
707 * the power dissipation values are proportional.
708 */
709 previous_value = ACPI_UINT32_MAX;
710 outer_elements = return_object->package.elements;
711 outer_element_count = return_object->package.count;
712
713 for (i = 0; i < outer_element_count; i++) {
714 elements = (*outer_elements)->package.elements;
715 obj_desc = elements[1]; /* Index1 = power_dissipation */
716
717 if ((u32)obj_desc->integer.value > previous_value) {
718 ACPI_WARN_PREDEFINED((AE_INFO,
719 info->full_pathname,
720 info->node_flags,
721 "SubPackage[%u,%u] - suspicious power dissipation values",
722 i - 1, i));
723 }
724
725 previous_value = (u32) obj_desc->integer.value;
726 outer_elements++;
727 }
728
729 return (AE_OK);
730}
731
732/******************************************************************************
733 *
734 * FUNCTION: acpi_ns_repair_TSS
735 *
736 * PARAMETERS: info - Method execution information block
737 * return_object_ptr - Pointer to the object returned from the
738 * evaluation of a method or object
739 *
740 * RETURN: Status. AE_OK if object is OK or was repaired successfully
741 *
742 * DESCRIPTION: Repair for the _TSS object. If necessary, sort the object list
743 * descending by the power dissipation values.
744 *
745 *****************************************************************************/
746
747static acpi_status
748acpi_ns_repair_TSS(struct acpi_evaluate_info *info,
749 union acpi_operand_object **return_object_ptr)
750{
751 union acpi_operand_object *return_object = *return_object_ptr;
752 acpi_status status;
753 struct acpi_namespace_node *node;
754
755 /*
756 * We can only sort the _TSS return package if there is no _PSS in the
757 * same scope. This is because if _PSS is present, the ACPI specification
758 * dictates that the _TSS Power Dissipation field is to be ignored, and
759 * therefore some BIOSs leave garbage values in the _TSS Power field(s).
760 * In this case, it is best to just return the _TSS package as-is.
761 * (May, 2011)
762 */
763 status = acpi_ns_get_node(info->node, "^_PSS",
764 ACPI_NS_NO_UPSEARCH, &node);
765 if (ACPI_SUCCESS(status)) {
766 return (AE_OK);
767 }
768
769 status = acpi_ns_check_sorted_list(info, return_object, 0, 5, 1,
770 ACPI_SORT_DESCENDING,
771 "PowerDissipation");
772
773 return (status);
774}
775
776/******************************************************************************
777 *
778 * FUNCTION: acpi_ns_check_sorted_list
779 *
780 * PARAMETERS: info - Method execution information block
781 * return_object - Pointer to the top-level returned object
782 * start_index - Index of the first subpackage
783 * expected_count - Minimum length of each subpackage
784 * sort_index - Subpackage entry to sort on
785 * sort_direction - Ascending or descending
786 * sort_key_name - Name of the sort_index field
787 *
788 * RETURN: Status. AE_OK if the list is valid and is sorted correctly or
789 * has been repaired by sorting the list.
790 *
791 * DESCRIPTION: Check if the package list is valid and sorted correctly by the
792 * sort_index. If not, then sort the list.
793 *
794 *****************************************************************************/
795
796static acpi_status
797acpi_ns_check_sorted_list(struct acpi_evaluate_info *info,
798 union acpi_operand_object *return_object,
799 u32 start_index,
800 u32 expected_count,
801 u32 sort_index,
802 u8 sort_direction, char *sort_key_name)
803{
804 u32 outer_element_count;
805 union acpi_operand_object **outer_elements;
806 union acpi_operand_object **elements;
807 union acpi_operand_object *obj_desc;
808 u32 i;
809 u32 previous_value;
810
811 ACPI_FUNCTION_NAME(ns_check_sorted_list);
812
813 /* The top-level object must be a package */
814
815 if (return_object->common.type != ACPI_TYPE_PACKAGE) {
816 return (AE_AML_OPERAND_TYPE);
817 }
818
819 /*
820 * NOTE: assumes list of subpackages contains no NULL elements.
821 * Any NULL elements should have been removed by earlier call
822 * to acpi_ns_remove_null_elements.
823 */
824 outer_element_count = return_object->package.count;
825 if (!outer_element_count || start_index >= outer_element_count) {
826 return (AE_AML_PACKAGE_LIMIT);
827 }
828
829 outer_elements = &return_object->package.elements[start_index];
830 outer_element_count -= start_index;
831
832 previous_value = 0;
833 if (sort_direction == ACPI_SORT_DESCENDING) {
834 previous_value = ACPI_UINT32_MAX;
835 }
836
837 /* Examine each subpackage */
838
839 for (i = 0; i < outer_element_count; i++) {
840
841 /* Each element of the top-level package must also be a package */
842
843 if ((*outer_elements)->common.type != ACPI_TYPE_PACKAGE) {
844 return (AE_AML_OPERAND_TYPE);
845 }
846
847 /* Each subpackage must have the minimum length */
848
849 if ((*outer_elements)->package.count < expected_count) {
850 return (AE_AML_PACKAGE_LIMIT);
851 }
852
853 elements = (*outer_elements)->package.elements;
854 obj_desc = elements[sort_index];
855
856 if (obj_desc->common.type != ACPI_TYPE_INTEGER) {
857 return (AE_AML_OPERAND_TYPE);
858 }
859
860 /*
861 * The list must be sorted in the specified order. If we detect a
862 * discrepancy, sort the entire list.
863 */
864 if (((sort_direction == ACPI_SORT_ASCENDING) &&
865 (obj_desc->integer.value < previous_value)) ||
866 ((sort_direction == ACPI_SORT_DESCENDING) &&
867 (obj_desc->integer.value > previous_value))) {
868 acpi_ns_sort_list(&return_object->package.
869 elements[start_index],
870 outer_element_count, sort_index,
871 sort_direction);
872
873 info->return_flags |= ACPI_OBJECT_REPAIRED;
874
875 ACPI_DEBUG_PRINT((ACPI_DB_REPAIR,
876 "%s: Repaired unsorted list - now sorted by %s\n",
877 info->full_pathname, sort_key_name));
878 return (AE_OK);
879 }
880
881 previous_value = (u32) obj_desc->integer.value;
882 outer_elements++;
883 }
884
885 return (AE_OK);
886}
887
888/******************************************************************************
889 *
890 * FUNCTION: acpi_ns_sort_list
891 *
892 * PARAMETERS: elements - Package object element list
893 * count - Element count for above
894 * index - Sort by which package element
895 * sort_direction - Ascending or Descending sort
896 *
897 * RETURN: None
898 *
899 * DESCRIPTION: Sort the objects that are in a package element list.
900 *
901 * NOTE: Assumes that all NULL elements have been removed from the package,
902 * and that all elements have been verified to be of type Integer.
903 *
904 *****************************************************************************/
905
906static void
907acpi_ns_sort_list(union acpi_operand_object **elements,
908 u32 count, u32 index, u8 sort_direction)
909{
910 union acpi_operand_object *obj_desc1;
911 union acpi_operand_object *obj_desc2;
912 union acpi_operand_object *temp_obj;
913 u32 i;
914 u32 j;
915
916 /* Simple bubble sort */
917
918 for (i = 1; i < count; i++) {
919 for (j = (count - 1); j >= i; j--) {
920 obj_desc1 = elements[j - 1]->package.elements[index];
921 obj_desc2 = elements[j]->package.elements[index];
922
923 if (((sort_direction == ACPI_SORT_ASCENDING) &&
924 (obj_desc1->integer.value >
925 obj_desc2->integer.value))
926 || ((sort_direction == ACPI_SORT_DESCENDING)
927 && (obj_desc1->integer.value <
928 obj_desc2->integer.value))) {
929 temp_obj = elements[j - 1];
930 elements[j - 1] = elements[j];
931 elements[j] = temp_obj;
932 }
933 }
934 }
935}
936
937/******************************************************************************
938 *
939 * FUNCTION: acpi_ns_remove_element
940 *
941 * PARAMETERS: obj_desc - Package object element list
942 * index - Index of element to remove
943 *
944 * RETURN: None
945 *
946 * DESCRIPTION: Remove the requested element of a package and delete it.
947 *
948 *****************************************************************************/
949
950static void
951acpi_ns_remove_element(union acpi_operand_object *obj_desc, u32 index)
952{
953 union acpi_operand_object **source;
954 union acpi_operand_object **dest;
955 u32 count;
956 u32 new_count;
957 u32 i;
958
959 ACPI_FUNCTION_NAME(ns_remove_element);
960
961 count = obj_desc->package.count;
962 new_count = count - 1;
963
964 source = obj_desc->package.elements;
965 dest = source;
966
967 /* Examine all elements of the package object, remove matched index */
968
969 for (i = 0; i < count; i++) {
970 if (i == index) {
971 acpi_ut_remove_reference(*source); /* Remove one ref for being in pkg */
972 acpi_ut_remove_reference(*source);
973 } else {
974 *dest = *source;
975 dest++;
976 }
977
978 source++;
979 }
980
981 /* NULL terminate list and update the package count */
982
983 *dest = NULL;
984 obj_desc->package.count = new_count;
985}