1 /******************************************************************************
3 * Module Name: nsrepair2 - Repair for objects returned by specific
6 *****************************************************************************/
8 /******************************************************************************
12 * Some or all of this work - Copyright (c) 1999 - 2010, Intel Corp.
13 * All rights reserved.
17 * 2.1. This is your license from Intel Corp. under its intellectual property
18 * rights. You may have additional license terms from the party that provided
19 * you this software, covering your right to use that party's intellectual
22 * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
23 * copy of the source code appearing in this file ("Covered Code") an
24 * irrevocable, perpetual, worldwide license under Intel's copyrights in the
25 * base code distributed originally by Intel ("Original Intel Code") to copy,
26 * make derivatives, distribute, use and display any portion of the Covered
27 * Code in any form, with the right to sublicense such rights; and
29 * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
30 * license (with the right to sublicense), under only those claims of Intel
31 * patents that are infringed by the Original Intel Code, to make, use, sell,
32 * offer to sell, and import the Covered Code and derivative works thereof
33 * solely to the minimum extent necessary to exercise the above copyright
34 * license, and in no event shall the patent license extend to any additions
35 * to or modifications of the Original Intel Code. No other license or right
36 * is granted directly or by implication, estoppel or otherwise;
38 * The above copyright and patent license is granted only if the following
43 * 3.1. Redistribution of Source with Rights to Further Distribute Source.
44 * Redistribution of source code of any substantial portion of the Covered
45 * Code or modification with rights to further distribute source must include
46 * the above Copyright Notice, the above License, this list of Conditions,
47 * and the following Disclaimer and Export Compliance provision. In addition,
48 * Licensee must cause all Covered Code to which Licensee contributes to
49 * contain a file documenting the changes Licensee made to create that Covered
50 * Code and the date of any change. Licensee must include in that file the
51 * documentation of any changes made by any predecessor Licensee. Licensee
52 * must include a prominent statement that the modification is derived,
53 * directly or indirectly, from Original Intel Code.
55 * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
56 * Redistribution of source code of any substantial portion of the Covered
57 * Code or modification without rights to further distribute source must
58 * include the following Disclaimer and Export Compliance provision in the
59 * documentation and/or other materials provided with distribution. In
60 * addition, Licensee may not authorize further sublicense of source of any
61 * portion of the Covered Code, and must include terms to the effect that the
62 * license from Licensee to its licensee is limited to the intellectual
63 * property embodied in the software Licensee provides to its licensee, and
64 * not to intellectual property embodied in modifications its licensee may
67 * 3.3. Redistribution of Executable. Redistribution in executable form of any
68 * substantial portion of the Covered Code or modification must reproduce the
69 * above Copyright Notice, and the following Disclaimer and Export Compliance
70 * provision in the documentation and/or other materials provided with the
73 * 3.4. Intel retains all right, title, and interest in and to the Original
76 * 3.5. Neither the name Intel nor any other trademark owned or controlled by
77 * Intel shall be used in advertising or otherwise to promote the sale, use or
78 * other dealings in products derived from or relating to the Covered Code
79 * without prior written authorization from Intel.
81 * 4. Disclaimer and Export Compliance
83 * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
84 * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
85 * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
86 * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
87 * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
88 * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
91 * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
92 * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
93 * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
94 * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
95 * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
96 * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
97 * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
100 * 4.3. Licensee shall not export, either directly or indirectly, any of this
101 * software or system incorporating such software without first obtaining any
102 * required license or other approval from the U. S. Department of Commerce or
103 * any other agency or department of the United States Government. In the
104 * event Licensee exports any such software from the United States or
105 * re-exports any such software from a foreign destination, Licensee shall
106 * ensure that the distribution and export/re-export of the software is in
107 * compliance with all laws, regulations, orders, or other restrictions of the
108 * U.S. Export Administration Regulations. Licensee agrees that neither it nor
109 * any of its subsidiaries will export/re-export any technical data, process,
110 * software, or service, directly or indirectly, to any country for which the
111 * United States government or any agency thereof requires an export license,
112 * other governmental approval, or letter of assurance, without first obtaining
113 * such license, approval or letter.
115 *****************************************************************************/
117 #define __NSREPAIR2_C__
119 #include <contrib/dev/acpica/include/acpi.h>
120 #include <contrib/dev/acpica/include/accommon.h>
121 #include <contrib/dev/acpica/include/acnamesp.h>
123 #define _COMPONENT ACPI_NAMESPACE
124 ACPI_MODULE_NAME ("nsrepair2")
128 * Information structure and handler for ACPI predefined names that can
129 * be repaired on a per-name basis.
132 ACPI_STATUS (*ACPI_REPAIR_FUNCTION) (
133 ACPI_PREDEFINED_DATA *Data,
134 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
136 typedef struct acpi_repair_info
138 char Name[ACPI_NAME_SIZE];
139 ACPI_REPAIR_FUNCTION RepairFunction;
144 /* Local prototypes */
146 static const ACPI_REPAIR_INFO *
147 AcpiNsMatchRepairableName (
148 ACPI_NAMESPACE_NODE *Node);
152 ACPI_PREDEFINED_DATA *Data,
153 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
157 ACPI_PREDEFINED_DATA *Data,
158 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
162 ACPI_PREDEFINED_DATA *Data,
163 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
167 ACPI_PREDEFINED_DATA *Data,
168 ACPI_OPERAND_OBJECT **ReturnObjectPtr);
171 AcpiNsCheckSortedList (
172 ACPI_PREDEFINED_DATA *Data,
173 ACPI_OPERAND_OBJECT *ReturnObject,
174 UINT32 ExpectedCount,
181 ACPI_OPERAND_OBJECT **Elements,
184 UINT8 SortDirection);
186 /* Values for SortDirection above */
188 #define ACPI_SORT_ASCENDING 0
189 #define ACPI_SORT_DESCENDING 1
193 * This table contains the names of the predefined methods for which we can
194 * perform more complex repairs.
198 * _ALR: Sort the list ascending by AmbientIlluminance
199 * _FDE: Convert Buffer of BYTEs to a Buffer of DWORDs
200 * _GTM: Convert Buffer of BYTEs to a Buffer of DWORDs
201 * _PSS: Sort the list descending by Power
202 * _TSS: Sort the list descending by Power
204 static const ACPI_REPAIR_INFO AcpiNsRepairableNames[] =
206 {"_ALR", AcpiNsRepair_ALR},
207 {"_FDE", AcpiNsRepair_FDE},
208 {"_GTM", AcpiNsRepair_FDE}, /* _GTM has same repair as _FDE */
209 {"_PSS", AcpiNsRepair_PSS},
210 {"_TSS", AcpiNsRepair_TSS},
211 {{0,0,0,0}, NULL} /* Table terminator */
215 #define ACPI_FDE_FIELD_COUNT 5
216 #define ACPI_FDE_BYTE_BUFFER_SIZE 5
217 #define ACPI_FDE_DWORD_BUFFER_SIZE (ACPI_FDE_FIELD_COUNT * sizeof (UINT32))
220 /******************************************************************************
222 * FUNCTION: AcpiNsComplexRepairs
224 * PARAMETERS: Data - Pointer to validation data structure
225 * Node - Namespace node for the method/object
226 * ValidateStatus - Original status of earlier validation
227 * ReturnObjectPtr - Pointer to the object returned from the
228 * evaluation of a method or object
230 * RETURN: Status. AE_OK if repair was successful. If name is not
231 * matched, ValidateStatus is returned.
233 * DESCRIPTION: Attempt to repair/convert a return object of a type that was
236 *****************************************************************************/
239 AcpiNsComplexRepairs (
240 ACPI_PREDEFINED_DATA *Data,
241 ACPI_NAMESPACE_NODE *Node,
242 ACPI_STATUS ValidateStatus,
243 ACPI_OPERAND_OBJECT **ReturnObjectPtr)
245 const ACPI_REPAIR_INFO *Predefined;
249 /* Check if this name is in the list of repairable names */
251 Predefined = AcpiNsMatchRepairableName (Node);
254 return (ValidateStatus);
257 Status = Predefined->RepairFunction (Data, ReturnObjectPtr);
262 /******************************************************************************
264 * FUNCTION: AcpiNsMatchRepairableName
266 * PARAMETERS: Node - Namespace node for the method/object
268 * RETURN: Pointer to entry in repair table. NULL indicates not found.
270 * DESCRIPTION: Check an object name against the repairable object list.
272 *****************************************************************************/
274 static const ACPI_REPAIR_INFO *
275 AcpiNsMatchRepairableName (
276 ACPI_NAMESPACE_NODE *Node)
278 const ACPI_REPAIR_INFO *ThisName;
281 /* Search info table for a repairable predefined method/object name */
283 ThisName = AcpiNsRepairableNames;
284 while (ThisName->RepairFunction)
286 if (ACPI_COMPARE_NAME (Node->Name.Ascii, ThisName->Name))
293 return (NULL); /* Not found */
297 /******************************************************************************
299 * FUNCTION: AcpiNsRepair_ALR
301 * PARAMETERS: Data - Pointer to validation data structure
302 * ReturnObjectPtr - Pointer to the object returned from the
303 * evaluation of a method or object
305 * RETURN: Status. AE_OK if object is OK or was repaired successfully
307 * DESCRIPTION: Repair for the _ALR object. If necessary, sort the object list
308 * ascending by the ambient illuminance values.
310 *****************************************************************************/
314 ACPI_PREDEFINED_DATA *Data,
315 ACPI_OPERAND_OBJECT **ReturnObjectPtr)
317 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
321 Status = AcpiNsCheckSortedList (Data, ReturnObject, 2, 1,
322 ACPI_SORT_ASCENDING, "AmbientIlluminance");
328 /******************************************************************************
330 * FUNCTION: AcpiNsRepair_FDE
332 * PARAMETERS: Data - Pointer to validation data structure
333 * ReturnObjectPtr - Pointer to the object returned from the
334 * evaluation of a method or object
336 * RETURN: Status. AE_OK if object is OK or was repaired successfully
338 * DESCRIPTION: Repair for the _FDE and _GTM objects. The expected return
339 * value is a Buffer of 5 DWORDs. This function repairs a common
340 * problem where the return value is a Buffer of BYTEs, not
343 *****************************************************************************/
347 ACPI_PREDEFINED_DATA *Data,
348 ACPI_OPERAND_OBJECT **ReturnObjectPtr)
350 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
351 ACPI_OPERAND_OBJECT *BufferObject;
357 ACPI_FUNCTION_NAME (NsRepair_FDE);
360 switch (ReturnObject->Common.Type)
362 case ACPI_TYPE_BUFFER:
364 /* This is the expected type. Length should be (at least) 5 DWORDs */
366 if (ReturnObject->Buffer.Length >= ACPI_FDE_DWORD_BUFFER_SIZE)
371 /* We can only repair if we have exactly 5 BYTEs */
373 if (ReturnObject->Buffer.Length != ACPI_FDE_BYTE_BUFFER_SIZE)
375 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
376 "Incorrect return buffer length %u, expected %u",
377 ReturnObject->Buffer.Length, ACPI_FDE_DWORD_BUFFER_SIZE));
379 return (AE_AML_OPERAND_TYPE);
382 /* Create the new (larger) buffer object */
384 BufferObject = AcpiUtCreateBufferObject (ACPI_FDE_DWORD_BUFFER_SIZE);
387 return (AE_NO_MEMORY);
390 /* Expand each byte to a DWORD */
392 ByteBuffer = ReturnObject->Buffer.Pointer;
393 DwordBuffer = ACPI_CAST_PTR (UINT32, BufferObject->Buffer.Pointer);
395 for (i = 0; i < ACPI_FDE_FIELD_COUNT; i++)
397 *DwordBuffer = (UINT32) *ByteBuffer;
402 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR,
403 "%s Expanded Byte Buffer to expected DWord Buffer\n",
408 return (AE_AML_OPERAND_TYPE);
411 /* Delete the original return object, return the new buffer object */
413 AcpiUtRemoveReference (ReturnObject);
414 *ReturnObjectPtr = BufferObject;
416 Data->Flags |= ACPI_OBJECT_REPAIRED;
421 /******************************************************************************
423 * FUNCTION: AcpiNsRepair_TSS
425 * PARAMETERS: Data - Pointer to validation data structure
426 * ReturnObjectPtr - Pointer to the object returned from the
427 * evaluation of a method or object
429 * RETURN: Status. AE_OK if object is OK or was repaired successfully
431 * DESCRIPTION: Repair for the _TSS object. If necessary, sort the object list
432 * descending by the power dissipation values.
434 *****************************************************************************/
438 ACPI_PREDEFINED_DATA *Data,
439 ACPI_OPERAND_OBJECT **ReturnObjectPtr)
441 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
445 Status = AcpiNsCheckSortedList (Data, ReturnObject, 5, 1,
446 ACPI_SORT_DESCENDING, "PowerDissipation");
452 /******************************************************************************
454 * FUNCTION: AcpiNsRepair_PSS
456 * PARAMETERS: Data - Pointer to validation data structure
457 * ReturnObjectPtr - Pointer to the object returned from the
458 * evaluation of a method or object
460 * RETURN: Status. AE_OK if object is OK or was repaired successfully
462 * DESCRIPTION: Repair for the _PSS object. If necessary, sort the object list
463 * by the CPU frequencies. Check that the power dissipation values
464 * are all proportional to CPU frequency (i.e., sorting by
465 * frequency should be the same as sorting by power.)
467 *****************************************************************************/
471 ACPI_PREDEFINED_DATA *Data,
472 ACPI_OPERAND_OBJECT **ReturnObjectPtr)
474 ACPI_OPERAND_OBJECT *ReturnObject = *ReturnObjectPtr;
475 ACPI_OPERAND_OBJECT **OuterElements;
476 UINT32 OuterElementCount;
477 ACPI_OPERAND_OBJECT **Elements;
478 ACPI_OPERAND_OBJECT *ObjDesc;
479 UINT32 PreviousValue;
485 * Entries (sub-packages) in the _PSS Package must be sorted by power
486 * dissipation, in descending order. If it appears that the list is
487 * incorrectly sorted, sort it. We sort by CpuFrequency, since this
488 * should be proportional to the power.
490 Status =AcpiNsCheckSortedList (Data, ReturnObject, 6, 0,
491 ACPI_SORT_DESCENDING, "CpuFrequency");
492 if (ACPI_FAILURE (Status))
498 * We now know the list is correctly sorted by CPU frequency. Check if
499 * the power dissipation values are proportional.
501 PreviousValue = ACPI_UINT32_MAX;
502 OuterElements = ReturnObject->Package.Elements;
503 OuterElementCount = ReturnObject->Package.Count;
505 for (i = 0; i < OuterElementCount; i++)
507 Elements = (*OuterElements)->Package.Elements;
508 ObjDesc = Elements[1]; /* Index1 = PowerDissipation */
510 if ((UINT32) ObjDesc->Integer.Value > PreviousValue)
512 ACPI_WARN_PREDEFINED ((AE_INFO, Data->Pathname, Data->NodeFlags,
513 "SubPackage[%u,%u] - suspicious power dissipation values",
517 PreviousValue = (UINT32) ObjDesc->Integer.Value;
525 /******************************************************************************
527 * FUNCTION: AcpiNsCheckSortedList
529 * PARAMETERS: Data - Pointer to validation data structure
530 * ReturnObject - Pointer to the top-level returned object
531 * ExpectedCount - Minimum length of each sub-package
532 * SortIndex - Sub-package entry to sort on
533 * SortDirection - Ascending or descending
534 * SortKeyName - Name of the SortIndex field
536 * RETURN: Status. AE_OK if the list is valid and is sorted correctly or
537 * has been repaired by sorting the list.
539 * DESCRIPTION: Check if the package list is valid and sorted correctly by the
540 * SortIndex. If not, then sort the list.
542 *****************************************************************************/
545 AcpiNsCheckSortedList (
546 ACPI_PREDEFINED_DATA *Data,
547 ACPI_OPERAND_OBJECT *ReturnObject,
548 UINT32 ExpectedCount,
553 UINT32 OuterElementCount;
554 ACPI_OPERAND_OBJECT **OuterElements;
555 ACPI_OPERAND_OBJECT **Elements;
556 ACPI_OPERAND_OBJECT *ObjDesc;
558 UINT32 PreviousValue;
561 ACPI_FUNCTION_NAME (NsCheckSortedList);
564 /* The top-level object must be a package */
566 if (ReturnObject->Common.Type != ACPI_TYPE_PACKAGE)
568 return (AE_AML_OPERAND_TYPE);
572 * NOTE: assumes list of sub-packages contains no NULL elements.
573 * Any NULL elements should have been removed by earlier call
574 * to AcpiNsRemoveNullElements.
576 OuterElements = ReturnObject->Package.Elements;
577 OuterElementCount = ReturnObject->Package.Count;
578 if (!OuterElementCount)
580 return (AE_AML_PACKAGE_LIMIT);
584 if (SortDirection == ACPI_SORT_DESCENDING)
586 PreviousValue = ACPI_UINT32_MAX;
589 /* Examine each subpackage */
591 for (i = 0; i < OuterElementCount; i++)
593 /* Each element of the top-level package must also be a package */
595 if ((*OuterElements)->Common.Type != ACPI_TYPE_PACKAGE)
597 return (AE_AML_OPERAND_TYPE);
600 /* Each sub-package must have the minimum length */
602 if ((*OuterElements)->Package.Count < ExpectedCount)
604 return (AE_AML_PACKAGE_LIMIT);
607 Elements = (*OuterElements)->Package.Elements;
608 ObjDesc = Elements[SortIndex];
610 if (ObjDesc->Common.Type != ACPI_TYPE_INTEGER)
612 return (AE_AML_OPERAND_TYPE);
616 * The list must be sorted in the specified order. If we detect a
617 * discrepancy, sort the entire list.
619 if (((SortDirection == ACPI_SORT_ASCENDING) &&
620 (ObjDesc->Integer.Value < PreviousValue)) ||
621 ((SortDirection == ACPI_SORT_DESCENDING) &&
622 (ObjDesc->Integer.Value > PreviousValue)))
624 AcpiNsSortList (ReturnObject->Package.Elements,
625 OuterElementCount, SortIndex, SortDirection);
627 Data->Flags |= ACPI_OBJECT_REPAIRED;
629 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR,
630 "%s: Repaired unsorted list - now sorted by %s\n",
631 Data->Pathname, SortKeyName));
635 PreviousValue = (UINT32) ObjDesc->Integer.Value;
643 /******************************************************************************
645 * FUNCTION: AcpiNsSortList
647 * PARAMETERS: Elements - Package object element list
648 * Count - Element count for above
649 * Index - Sort by which package element
650 * SortDirection - Ascending or Descending sort
654 * DESCRIPTION: Sort the objects that are in a package element list.
656 * NOTE: Assumes that all NULL elements have been removed from the package,
657 * and that all elements have been verified to be of type Integer.
659 *****************************************************************************/
663 ACPI_OPERAND_OBJECT **Elements,
668 ACPI_OPERAND_OBJECT *ObjDesc1;
669 ACPI_OPERAND_OBJECT *ObjDesc2;
670 ACPI_OPERAND_OBJECT *TempObj;
675 /* Simple bubble sort */
677 for (i = 1; i < Count; i++)
679 for (j = (Count - 1); j >= i; j--)
681 ObjDesc1 = Elements[j-1]->Package.Elements[Index];
682 ObjDesc2 = Elements[j]->Package.Elements[Index];
684 if (((SortDirection == ACPI_SORT_ASCENDING) &&
685 (ObjDesc1->Integer.Value > ObjDesc2->Integer.Value)) ||
687 ((SortDirection == ACPI_SORT_DESCENDING) &&
688 (ObjDesc1->Integer.Value < ObjDesc2->Integer.Value)))
690 TempObj = Elements[j-1];
691 Elements[j-1] = Elements[j];
692 Elements[j] = TempObj;