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__
120 #include "accommon.h"
121 #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 * Names that must be packages, but cannot be sorted:
206 * _BCL: Values are tied to the Package index where they appear, and cannot
207 * be moved or sorted. These index values are used for _BQC and _BCM.
208 * However, we can fix the case where a buffer is returned, by converting
209 * it to a Package of integers.
211 static const ACPI_REPAIR_INFO AcpiNsRepairableNames
[] =
213 {"_ALR", AcpiNsRepair_ALR
},
214 {"_FDE", AcpiNsRepair_FDE
},
215 {"_GTM", AcpiNsRepair_FDE
}, /* _GTM has same repair as _FDE */
216 {"_PSS", AcpiNsRepair_PSS
},
217 {"_TSS", AcpiNsRepair_TSS
},
218 {{0,0,0,0}, NULL
} /* Table terminator */
222 #define ACPI_FDE_FIELD_COUNT 5
223 #define ACPI_FDE_BYTE_BUFFER_SIZE 5
224 #define ACPI_FDE_DWORD_BUFFER_SIZE (ACPI_FDE_FIELD_COUNT * sizeof (UINT32))
227 /******************************************************************************
229 * FUNCTION: AcpiNsComplexRepairs
231 * PARAMETERS: Data - Pointer to validation data structure
232 * Node - Namespace node for the method/object
233 * ValidateStatus - Original status of earlier validation
234 * ReturnObjectPtr - Pointer to the object returned from the
235 * evaluation of a method or object
237 * RETURN: Status. AE_OK if repair was successful. If name is not
238 * matched, ValidateStatus is returned.
240 * DESCRIPTION: Attempt to repair/convert a return object of a type that was
243 *****************************************************************************/
246 AcpiNsComplexRepairs (
247 ACPI_PREDEFINED_DATA
*Data
,
248 ACPI_NAMESPACE_NODE
*Node
,
249 ACPI_STATUS ValidateStatus
,
250 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
252 const ACPI_REPAIR_INFO
*Predefined
;
256 /* Check if this name is in the list of repairable names */
258 Predefined
= AcpiNsMatchRepairableName (Node
);
261 return (ValidateStatus
);
264 Status
= Predefined
->RepairFunction (Data
, ReturnObjectPtr
);
269 /******************************************************************************
271 * FUNCTION: AcpiNsMatchRepairableName
273 * PARAMETERS: Node - Namespace node for the method/object
275 * RETURN: Pointer to entry in repair table. NULL indicates not found.
277 * DESCRIPTION: Check an object name against the repairable object list.
279 *****************************************************************************/
281 static const ACPI_REPAIR_INFO
*
282 AcpiNsMatchRepairableName (
283 ACPI_NAMESPACE_NODE
*Node
)
285 const ACPI_REPAIR_INFO
*ThisName
;
288 /* Search info table for a repairable predefined method/object name */
290 ThisName
= AcpiNsRepairableNames
;
291 while (ThisName
->RepairFunction
)
293 if (ACPI_COMPARE_NAME (Node
->Name
.Ascii
, ThisName
->Name
))
300 return (NULL
); /* Not found */
304 /******************************************************************************
306 * FUNCTION: AcpiNsRepair_ALR
308 * PARAMETERS: Data - Pointer to validation data structure
309 * ReturnObjectPtr - Pointer to the object returned from the
310 * evaluation of a method or object
312 * RETURN: Status. AE_OK if object is OK or was repaired successfully
314 * DESCRIPTION: Repair for the _ALR object. If necessary, sort the object list
315 * ascending by the ambient illuminance values.
317 *****************************************************************************/
321 ACPI_PREDEFINED_DATA
*Data
,
322 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
324 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
328 Status
= AcpiNsCheckSortedList (Data
, ReturnObject
, 2, 1,
329 ACPI_SORT_ASCENDING
, "AmbientIlluminance");
335 /******************************************************************************
337 * FUNCTION: AcpiNsRepair_FDE
339 * PARAMETERS: Data - Pointer to validation data structure
340 * ReturnObjectPtr - Pointer to the object returned from the
341 * evaluation of a method or object
343 * RETURN: Status. AE_OK if object is OK or was repaired successfully
345 * DESCRIPTION: Repair for the _FDE and _GTM objects. The expected return
346 * value is a Buffer of 5 DWORDs. This function repairs a common
347 * problem where the return value is a Buffer of BYTEs, not
350 *****************************************************************************/
354 ACPI_PREDEFINED_DATA
*Data
,
355 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
357 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
358 ACPI_OPERAND_OBJECT
*BufferObject
;
364 ACPI_FUNCTION_NAME (NsRepair_FDE
);
367 switch (ReturnObject
->Common
.Type
)
369 case ACPI_TYPE_BUFFER
:
371 /* This is the expected type. Length should be (at least) 5 DWORDs */
373 if (ReturnObject
->Buffer
.Length
>= ACPI_FDE_DWORD_BUFFER_SIZE
)
378 /* We can only repair if we have exactly 5 BYTEs */
380 if (ReturnObject
->Buffer
.Length
!= ACPI_FDE_BYTE_BUFFER_SIZE
)
382 ACPI_WARN_PREDEFINED ((AE_INFO
, Data
->Pathname
, Data
->NodeFlags
,
383 "Incorrect return buffer length %u, expected %u",
384 ReturnObject
->Buffer
.Length
, ACPI_FDE_DWORD_BUFFER_SIZE
));
386 return (AE_AML_OPERAND_TYPE
);
389 /* Create the new (larger) buffer object */
391 BufferObject
= AcpiUtCreateBufferObject (ACPI_FDE_DWORD_BUFFER_SIZE
);
394 return (AE_NO_MEMORY
);
397 /* Expand each byte to a DWORD */
399 ByteBuffer
= ReturnObject
->Buffer
.Pointer
;
400 DwordBuffer
= ACPI_CAST_PTR (UINT32
, BufferObject
->Buffer
.Pointer
);
402 for (i
= 0; i
< ACPI_FDE_FIELD_COUNT
; i
++)
404 *DwordBuffer
= (UINT32
) *ByteBuffer
;
409 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
410 "%s Expanded Byte Buffer to expected DWord Buffer\n",
415 return (AE_AML_OPERAND_TYPE
);
418 /* Delete the original return object, return the new buffer object */
420 AcpiUtRemoveReference (ReturnObject
);
421 *ReturnObjectPtr
= BufferObject
;
423 Data
->Flags
|= ACPI_OBJECT_REPAIRED
;
428 /******************************************************************************
430 * FUNCTION: AcpiNsRepair_TSS
432 * PARAMETERS: Data - Pointer to validation data structure
433 * ReturnObjectPtr - Pointer to the object returned from the
434 * evaluation of a method or object
436 * RETURN: Status. AE_OK if object is OK or was repaired successfully
438 * DESCRIPTION: Repair for the _TSS object. If necessary, sort the object list
439 * descending by the power dissipation values.
441 *****************************************************************************/
445 ACPI_PREDEFINED_DATA
*Data
,
446 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
448 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
452 Status
= AcpiNsCheckSortedList (Data
, ReturnObject
, 5, 1,
453 ACPI_SORT_DESCENDING
, "PowerDissipation");
459 /******************************************************************************
461 * FUNCTION: AcpiNsRepair_PSS
463 * PARAMETERS: Data - Pointer to validation data structure
464 * ReturnObjectPtr - Pointer to the object returned from the
465 * evaluation of a method or object
467 * RETURN: Status. AE_OK if object is OK or was repaired successfully
469 * DESCRIPTION: Repair for the _PSS object. If necessary, sort the object list
470 * by the CPU frequencies. Check that the power dissipation values
471 * are all proportional to CPU frequency (i.e., sorting by
472 * frequency should be the same as sorting by power.)
474 *****************************************************************************/
478 ACPI_PREDEFINED_DATA
*Data
,
479 ACPI_OPERAND_OBJECT
**ReturnObjectPtr
)
481 ACPI_OPERAND_OBJECT
*ReturnObject
= *ReturnObjectPtr
;
482 ACPI_OPERAND_OBJECT
**OuterElements
;
483 UINT32 OuterElementCount
;
484 ACPI_OPERAND_OBJECT
**Elements
;
485 ACPI_OPERAND_OBJECT
*ObjDesc
;
486 UINT32 PreviousValue
;
492 * Entries (sub-packages) in the _PSS Package must be sorted by power
493 * dissipation, in descending order. If it appears that the list is
494 * incorrectly sorted, sort it. We sort by CpuFrequency, since this
495 * should be proportional to the power.
497 Status
=AcpiNsCheckSortedList (Data
, ReturnObject
, 6, 0,
498 ACPI_SORT_DESCENDING
, "CpuFrequency");
499 if (ACPI_FAILURE (Status
))
505 * We now know the list is correctly sorted by CPU frequency. Check if
506 * the power dissipation values are proportional.
508 PreviousValue
= ACPI_UINT32_MAX
;
509 OuterElements
= ReturnObject
->Package
.Elements
;
510 OuterElementCount
= ReturnObject
->Package
.Count
;
512 for (i
= 0; i
< OuterElementCount
; i
++)
514 Elements
= (*OuterElements
)->Package
.Elements
;
515 ObjDesc
= Elements
[1]; /* Index1 = PowerDissipation */
517 if ((UINT32
) ObjDesc
->Integer
.Value
> PreviousValue
)
519 ACPI_WARN_PREDEFINED ((AE_INFO
, Data
->Pathname
, Data
->NodeFlags
,
520 "SubPackage[%u,%u] - suspicious power dissipation values",
524 PreviousValue
= (UINT32
) ObjDesc
->Integer
.Value
;
532 /******************************************************************************
534 * FUNCTION: AcpiNsCheckSortedList
536 * PARAMETERS: Data - Pointer to validation data structure
537 * ReturnObject - Pointer to the top-level returned object
538 * ExpectedCount - Minimum length of each sub-package
539 * SortIndex - Sub-package entry to sort on
540 * SortDirection - Ascending or descending
541 * SortKeyName - Name of the SortIndex field
543 * RETURN: Status. AE_OK if the list is valid and is sorted correctly or
544 * has been repaired by sorting the list.
546 * DESCRIPTION: Check if the package list is valid and sorted correctly by the
547 * SortIndex. If not, then sort the list.
549 *****************************************************************************/
552 AcpiNsCheckSortedList (
553 ACPI_PREDEFINED_DATA
*Data
,
554 ACPI_OPERAND_OBJECT
*ReturnObject
,
555 UINT32 ExpectedCount
,
560 UINT32 OuterElementCount
;
561 ACPI_OPERAND_OBJECT
**OuterElements
;
562 ACPI_OPERAND_OBJECT
**Elements
;
563 ACPI_OPERAND_OBJECT
*ObjDesc
;
565 UINT32 PreviousValue
;
568 ACPI_FUNCTION_NAME (NsCheckSortedList
);
571 /* The top-level object must be a package */
573 if (ReturnObject
->Common
.Type
!= ACPI_TYPE_PACKAGE
)
575 return (AE_AML_OPERAND_TYPE
);
579 * NOTE: assumes list of sub-packages contains no NULL elements.
580 * Any NULL elements should have been removed by earlier call
581 * to AcpiNsRemoveNullElements.
583 OuterElements
= ReturnObject
->Package
.Elements
;
584 OuterElementCount
= ReturnObject
->Package
.Count
;
585 if (!OuterElementCount
)
587 return (AE_AML_PACKAGE_LIMIT
);
591 if (SortDirection
== ACPI_SORT_DESCENDING
)
593 PreviousValue
= ACPI_UINT32_MAX
;
596 /* Examine each subpackage */
598 for (i
= 0; i
< OuterElementCount
; i
++)
600 /* Each element of the top-level package must also be a package */
602 if ((*OuterElements
)->Common
.Type
!= ACPI_TYPE_PACKAGE
)
604 return (AE_AML_OPERAND_TYPE
);
607 /* Each sub-package must have the minimum length */
609 if ((*OuterElements
)->Package
.Count
< ExpectedCount
)
611 return (AE_AML_PACKAGE_LIMIT
);
614 Elements
= (*OuterElements
)->Package
.Elements
;
615 ObjDesc
= Elements
[SortIndex
];
617 if (ObjDesc
->Common
.Type
!= ACPI_TYPE_INTEGER
)
619 return (AE_AML_OPERAND_TYPE
);
623 * The list must be sorted in the specified order. If we detect a
624 * discrepancy, sort the entire list.
626 if (((SortDirection
== ACPI_SORT_ASCENDING
) &&
627 (ObjDesc
->Integer
.Value
< PreviousValue
)) ||
628 ((SortDirection
== ACPI_SORT_DESCENDING
) &&
629 (ObjDesc
->Integer
.Value
> PreviousValue
)))
631 AcpiNsSortList (ReturnObject
->Package
.Elements
,
632 OuterElementCount
, SortIndex
, SortDirection
);
634 Data
->Flags
|= ACPI_OBJECT_REPAIRED
;
636 ACPI_DEBUG_PRINT ((ACPI_DB_REPAIR
,
637 "%s: Repaired unsorted list - now sorted by %s\n",
638 Data
->Pathname
, SortKeyName
));
642 PreviousValue
= (UINT32
) ObjDesc
->Integer
.Value
;
650 /******************************************************************************
652 * FUNCTION: AcpiNsSortList
654 * PARAMETERS: Elements - Package object element list
655 * Count - Element count for above
656 * Index - Sort by which package element
657 * SortDirection - Ascending or Descending sort
661 * DESCRIPTION: Sort the objects that are in a package element list.
663 * NOTE: Assumes that all NULL elements have been removed from the package,
664 * and that all elements have been verified to be of type Integer.
666 *****************************************************************************/
670 ACPI_OPERAND_OBJECT
**Elements
,
675 ACPI_OPERAND_OBJECT
*ObjDesc1
;
676 ACPI_OPERAND_OBJECT
*ObjDesc2
;
677 ACPI_OPERAND_OBJECT
*TempObj
;
682 /* Simple bubble sort */
684 for (i
= 1; i
< Count
; i
++)
686 for (j
= (Count
- 1); j
>= i
; j
--)
688 ObjDesc1
= Elements
[j
-1]->Package
.Elements
[Index
];
689 ObjDesc2
= Elements
[j
]->Package
.Elements
[Index
];
691 if (((SortDirection
== ACPI_SORT_ASCENDING
) &&
692 (ObjDesc1
->Integer
.Value
> ObjDesc2
->Integer
.Value
)) ||
694 ((SortDirection
== ACPI_SORT_DESCENDING
) &&
695 (ObjDesc1
->Integer
.Value
< ObjDesc2
->Integer
.Value
)))
697 TempObj
= Elements
[j
-1];
698 Elements
[j
-1] = Elements
[j
];
699 Elements
[j
] = TempObj
;