xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/utosi.c (revision ca8ed5ea660fb6275799a3b7f138b201c41a667b)
1 /******************************************************************************
2  *
3  * Module Name: utosi - Support for the _OSI predefined control method
4  *
5  *****************************************************************************/
6 
7 /******************************************************************************
8  *
9  * 1. Copyright Notice
10  *
11  * Some or all of this work - Copyright (c) 1999 - 2014, Intel Corp.
12  * All rights reserved.
13  *
14  * 2. License
15  *
16  * 2.1. This is your license from Intel Corp. under its intellectual property
17  * rights. You may have additional license terms from the party that provided
18  * you this software, covering your right to use that party's intellectual
19  * property rights.
20  *
21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
22  * copy of the source code appearing in this file ("Covered Code") an
23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
24  * base code distributed originally by Intel ("Original Intel Code") to copy,
25  * make derivatives, distribute, use and display any portion of the Covered
26  * Code in any form, with the right to sublicense such rights; and
27  *
28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
29  * license (with the right to sublicense), under only those claims of Intel
30  * patents that are infringed by the Original Intel Code, to make, use, sell,
31  * offer to sell, and import the Covered Code and derivative works thereof
32  * solely to the minimum extent necessary to exercise the above copyright
33  * license, and in no event shall the patent license extend to any additions
34  * to or modifications of the Original Intel Code. No other license or right
35  * is granted directly or by implication, estoppel or otherwise;
36  *
37  * The above copyright and patent license is granted only if the following
38  * conditions are met:
39  *
40  * 3. Conditions
41  *
42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
43  * Redistribution of source code of any substantial portion of the Covered
44  * Code or modification with rights to further distribute source must include
45  * the above Copyright Notice, the above License, this list of Conditions,
46  * and the following Disclaimer and Export Compliance provision. In addition,
47  * Licensee must cause all Covered Code to which Licensee contributes to
48  * contain a file documenting the changes Licensee made to create that Covered
49  * Code and the date of any change. Licensee must include in that file the
50  * documentation of any changes made by any predecessor Licensee. Licensee
51  * must include a prominent statement that the modification is derived,
52  * directly or indirectly, from Original Intel Code.
53  *
54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
55  * Redistribution of source code of any substantial portion of the Covered
56  * Code or modification without rights to further distribute source must
57  * include the following Disclaimer and Export Compliance provision in the
58  * documentation and/or other materials provided with distribution. In
59  * addition, Licensee may not authorize further sublicense of source of any
60  * portion of the Covered Code, and must include terms to the effect that the
61  * license from Licensee to its licensee is limited to the intellectual
62  * property embodied in the software Licensee provides to its licensee, and
63  * not to intellectual property embodied in modifications its licensee may
64  * make.
65  *
66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
67  * substantial portion of the Covered Code or modification must reproduce the
68  * above Copyright Notice, and the following Disclaimer and Export Compliance
69  * provision in the documentation and/or other materials provided with the
70  * distribution.
71  *
72  * 3.4. Intel retains all right, title, and interest in and to the Original
73  * Intel Code.
74  *
75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
76  * Intel shall be used in advertising or otherwise to promote the sale, use or
77  * other dealings in products derived from or relating to the Covered Code
78  * without prior written authorization from Intel.
79  *
80  * 4. Disclaimer and Export Compliance
81  *
82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
83  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
85  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
86  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
88  * PARTICULAR PURPOSE.
89  *
90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
97  * LIMITED REMEDY.
98  *
99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
100  * software or system incorporating such software without first obtaining any
101  * required license or other approval from the U. S. Department of Commerce or
102  * any other agency or department of the United States Government. In the
103  * event Licensee exports any such software from the United States or
104  * re-exports any such software from a foreign destination, Licensee shall
105  * ensure that the distribution and export/re-export of the software is in
106  * compliance with all laws, regulations, orders, or other restrictions of the
107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
108  * any of its subsidiaries will export/re-export any technical data, process,
109  * software, or service, directly or indirectly, to any country for which the
110  * United States government or any agency thereof requires an export license,
111  * other governmental approval, or letter of assurance, without first obtaining
112  * such license, approval or letter.
113  *
114  *****************************************************************************/
115 
116 #define __UTOSI_C__
117 
118 #include "acpi.h"
119 #include "accommon.h"
120 
121 
122 #define _COMPONENT          ACPI_UTILITIES
123         ACPI_MODULE_NAME    ("utosi")
124 
125 
126 /******************************************************************************
127  *
128  * ACPICA policy for new _OSI strings:
129  *
130  * It is the stated policy of ACPICA that new _OSI strings will be integrated
131  * into this module as soon as possible after they are defined. It is strongly
132  * recommended that all ACPICA hosts mirror this policy and integrate any
133  * changes to this module as soon as possible. There are several historical
134  * reasons behind this policy:
135  *
136  * 1) New BIOSs tend to test only the case where the host responds TRUE to
137  *    the latest version of Windows, which would respond to the latest/newest
138  *    _OSI string. Not responding TRUE to the latest version of Windows will
139  *    risk executing untested code paths throughout the DSDT and SSDTs.
140  *
141  * 2) If a new _OSI string is recognized only after a significant delay, this
142  *    has the potential to cause problems on existing working machines because
143  *    of the possibility that a new and different path through the ASL code
144  *    will be executed.
145  *
146  * 3) New _OSI strings are tending to come out about once per year. A delay
147  *    in recognizing a new string for a significant amount of time risks the
148  *    release of another string which only compounds the initial problem.
149  *
150  *****************************************************************************/
151 
152 
153 /*
154  * Strings supported by the _OSI predefined control method (which is
155  * implemented internally within this module.)
156  *
157  * March 2009: Removed "Linux" as this host no longer wants to respond true
158  * for this string. Basically, the only safe OS strings are windows-related
159  * and in many or most cases represent the only test path within the
160  * BIOS-provided ASL code.
161  *
162  * The last element of each entry is used to track the newest version of
163  * Windows that the BIOS has requested.
164  */
165 static ACPI_INTERFACE_INFO    AcpiDefaultSupportedInterfaces[] =
166 {
167     /* Operating System Vendor Strings */
168 
169     {"Windows 2000",        NULL, 0, ACPI_OSI_WIN_2000},         /* Windows 2000 */
170     {"Windows 2001",        NULL, 0, ACPI_OSI_WIN_XP},           /* Windows XP */
171     {"Windows 2001 SP1",    NULL, 0, ACPI_OSI_WIN_XP_SP1},       /* Windows XP SP1 */
172     {"Windows 2001.1",      NULL, 0, ACPI_OSI_WINSRV_2003},      /* Windows Server 2003 */
173     {"Windows 2001 SP2",    NULL, 0, ACPI_OSI_WIN_XP_SP2},       /* Windows XP SP2 */
174     {"Windows 2001.1 SP1",  NULL, 0, ACPI_OSI_WINSRV_2003_SP1},  /* Windows Server 2003 SP1 - Added 03/2006 */
175     {"Windows 2006",        NULL, 0, ACPI_OSI_WIN_VISTA},        /* Windows Vista - Added 03/2006 */
176     {"Windows 2006.1",      NULL, 0, ACPI_OSI_WINSRV_2008},      /* Windows Server 2008 - Added 09/2009 */
177     {"Windows 2006 SP1",    NULL, 0, ACPI_OSI_WIN_VISTA_SP1},    /* Windows Vista SP1 - Added 09/2009 */
178     {"Windows 2006 SP2",    NULL, 0, ACPI_OSI_WIN_VISTA_SP2},    /* Windows Vista SP2 - Added 09/2010 */
179     {"Windows 2009",        NULL, 0, ACPI_OSI_WIN_7},            /* Windows 7 and Server 2008 R2 - Added 09/2009 */
180     {"Windows 2012",        NULL, 0, ACPI_OSI_WIN_8},            /* Windows 8 and Server 2012 - Added 08/2012 */
181     {"Windows 2013",        NULL, 0, ACPI_OSI_WIN_8},            /* Windows 8.1 and Server 2012 R2 - Added 01/2014 */
182 
183     /* Feature Group Strings */
184 
185     {"Extended Address Space Descriptor", NULL, ACPI_OSI_FEATURE, 0},
186 
187     /*
188      * All "optional" feature group strings (features that are implemented
189      * by the host) should be dynamically modified to VALID by the host via
190      * AcpiInstallInterface or AcpiUpdateInterfaces. Such optional feature
191      * group strings are set as INVALID by default here.
192      */
193 
194     {"Module Device",               NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
195     {"Processor Device",            NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
196     {"3.0 Thermal Model",           NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
197     {"3.0 _SCP Extensions",         NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
198     {"Processor Aggregator Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0}
199 };
200 
201 
202 /*******************************************************************************
203  *
204  * FUNCTION:    AcpiUtInitializeInterfaces
205  *
206  * PARAMETERS:  None
207  *
208  * RETURN:      Status
209  *
210  * DESCRIPTION: Initialize the global _OSI supported interfaces list
211  *
212  ******************************************************************************/
213 
214 ACPI_STATUS
215 AcpiUtInitializeInterfaces (
216     void)
217 {
218     ACPI_STATUS             Status;
219     UINT32                  i;
220 
221 
222     Status = AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
223     if (ACPI_FAILURE (Status))
224     {
225         return (Status);
226     }
227 
228     AcpiGbl_SupportedInterfaces = AcpiDefaultSupportedInterfaces;
229 
230     /* Link the static list of supported interfaces */
231 
232     for (i = 0; i < (ACPI_ARRAY_LENGTH (AcpiDefaultSupportedInterfaces) - 1); i++)
233     {
234         AcpiDefaultSupportedInterfaces[i].Next =
235             &AcpiDefaultSupportedInterfaces[(ACPI_SIZE) i + 1];
236     }
237 
238     AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
239     return (AE_OK);
240 }
241 
242 
243 /*******************************************************************************
244  *
245  * FUNCTION:    AcpiUtInterfaceTerminate
246  *
247  * PARAMETERS:  None
248  *
249  * RETURN:      Status
250  *
251  * DESCRIPTION: Delete all interfaces in the global list. Sets
252  *              AcpiGbl_SupportedInterfaces to NULL.
253  *
254  ******************************************************************************/
255 
256 ACPI_STATUS
257 AcpiUtInterfaceTerminate (
258     void)
259 {
260     ACPI_STATUS             Status;
261     ACPI_INTERFACE_INFO     *NextInterface;
262 
263 
264     Status = AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
265     if (ACPI_FAILURE (Status))
266     {
267         return (Status);
268     }
269 
270     NextInterface = AcpiGbl_SupportedInterfaces;
271     while (NextInterface)
272     {
273         AcpiGbl_SupportedInterfaces = NextInterface->Next;
274 
275         if (NextInterface->Flags & ACPI_OSI_DYNAMIC)
276         {
277             /* Only interfaces added at runtime can be freed */
278 
279             ACPI_FREE (NextInterface->Name);
280             ACPI_FREE (NextInterface);
281         }
282         else
283         {
284             /* Interface is in static list. Reset it to invalid or valid. */
285 
286             if (NextInterface->Flags & ACPI_OSI_DEFAULT_INVALID)
287             {
288                 NextInterface->Flags |= ACPI_OSI_INVALID;
289             }
290             else
291             {
292                 NextInterface->Flags &= ~ACPI_OSI_INVALID;
293             }
294         }
295 
296         NextInterface = AcpiGbl_SupportedInterfaces;
297     }
298 
299     AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
300     return (AE_OK);
301 }
302 
303 
304 /*******************************************************************************
305  *
306  * FUNCTION:    AcpiUtInstallInterface
307  *
308  * PARAMETERS:  InterfaceName       - The interface to install
309  *
310  * RETURN:      Status
311  *
312  * DESCRIPTION: Install the interface into the global interface list.
313  *              Caller MUST hold AcpiGbl_OsiMutex
314  *
315  ******************************************************************************/
316 
317 ACPI_STATUS
318 AcpiUtInstallInterface (
319     ACPI_STRING             InterfaceName)
320 {
321     ACPI_INTERFACE_INFO     *InterfaceInfo;
322 
323 
324     /* Allocate info block and space for the name string */
325 
326     InterfaceInfo = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_INTERFACE_INFO));
327     if (!InterfaceInfo)
328     {
329         return (AE_NO_MEMORY);
330     }
331 
332     InterfaceInfo->Name = ACPI_ALLOCATE_ZEROED (ACPI_STRLEN (InterfaceName) + 1);
333     if (!InterfaceInfo->Name)
334     {
335         ACPI_FREE (InterfaceInfo);
336         return (AE_NO_MEMORY);
337     }
338 
339     /* Initialize new info and insert at the head of the global list */
340 
341     ACPI_STRCPY (InterfaceInfo->Name, InterfaceName);
342     InterfaceInfo->Flags = ACPI_OSI_DYNAMIC;
343     InterfaceInfo->Next = AcpiGbl_SupportedInterfaces;
344 
345     AcpiGbl_SupportedInterfaces = InterfaceInfo;
346     return (AE_OK);
347 }
348 
349 
350 /*******************************************************************************
351  *
352  * FUNCTION:    AcpiUtRemoveInterface
353  *
354  * PARAMETERS:  InterfaceName       - The interface to remove
355  *
356  * RETURN:      Status
357  *
358  * DESCRIPTION: Remove the interface from the global interface list.
359  *              Caller MUST hold AcpiGbl_OsiMutex
360  *
361  ******************************************************************************/
362 
363 ACPI_STATUS
364 AcpiUtRemoveInterface (
365     ACPI_STRING             InterfaceName)
366 {
367     ACPI_INTERFACE_INFO     *PreviousInterface;
368     ACPI_INTERFACE_INFO     *NextInterface;
369 
370 
371     PreviousInterface = NextInterface = AcpiGbl_SupportedInterfaces;
372     while (NextInterface)
373     {
374         if (!ACPI_STRCMP (InterfaceName, NextInterface->Name))
375         {
376             /* Found: name is in either the static list or was added at runtime */
377 
378             if (NextInterface->Flags & ACPI_OSI_DYNAMIC)
379             {
380                 /* Interface was added dynamically, remove and free it */
381 
382                 if (PreviousInterface == NextInterface)
383                 {
384                     AcpiGbl_SupportedInterfaces = NextInterface->Next;
385                 }
386                 else
387                 {
388                     PreviousInterface->Next = NextInterface->Next;
389                 }
390 
391                 ACPI_FREE (NextInterface->Name);
392                 ACPI_FREE (NextInterface);
393             }
394             else
395             {
396                 /*
397                  * Interface is in static list. If marked invalid, then it
398                  * does not actually exist. Else, mark it invalid.
399                  */
400                 if (NextInterface->Flags & ACPI_OSI_INVALID)
401                 {
402                     return (AE_NOT_EXIST);
403                 }
404 
405                 NextInterface->Flags |= ACPI_OSI_INVALID;
406             }
407 
408             return (AE_OK);
409         }
410 
411         PreviousInterface = NextInterface;
412         NextInterface = NextInterface->Next;
413     }
414 
415     /* Interface was not found */
416 
417     return (AE_NOT_EXIST);
418 }
419 
420 
421 /*******************************************************************************
422  *
423  * FUNCTION:    AcpiUtUpdateInterfaces
424  *
425  * PARAMETERS:  Action              - Actions to be performed during the
426  *                                    update
427  *
428  * RETURN:      Status
429  *
430  * DESCRIPTION: Update _OSI interface strings, disabling or enabling OS vendor
431  *              strings or/and feature group strings.
432  *              Caller MUST hold AcpiGbl_OsiMutex
433  *
434  ******************************************************************************/
435 
436 ACPI_STATUS
437 AcpiUtUpdateInterfaces (
438     UINT8                   Action)
439 {
440     ACPI_INTERFACE_INFO     *NextInterface;
441 
442 
443     NextInterface = AcpiGbl_SupportedInterfaces;
444     while (NextInterface)
445     {
446         if (((NextInterface->Flags & ACPI_OSI_FEATURE) &&
447              (Action & ACPI_FEATURE_STRINGS)) ||
448             (!(NextInterface->Flags & ACPI_OSI_FEATURE) &&
449              (Action & ACPI_VENDOR_STRINGS)))
450         {
451             if (Action & ACPI_DISABLE_INTERFACES)
452             {
453                 /* Mark the interfaces as invalid */
454 
455                 NextInterface->Flags |= ACPI_OSI_INVALID;
456             }
457             else
458             {
459                 /* Mark the interfaces as valid */
460 
461                 NextInterface->Flags &= ~ACPI_OSI_INVALID;
462             }
463         }
464 
465         NextInterface = NextInterface->Next;
466     }
467 
468     return (AE_OK);
469 }
470 
471 
472 /*******************************************************************************
473  *
474  * FUNCTION:    AcpiUtGetInterface
475  *
476  * PARAMETERS:  InterfaceName       - The interface to find
477  *
478  * RETURN:      ACPI_INTERFACE_INFO if found. NULL if not found.
479  *
480  * DESCRIPTION: Search for the specified interface name in the global list.
481  *              Caller MUST hold AcpiGbl_OsiMutex
482  *
483  ******************************************************************************/
484 
485 ACPI_INTERFACE_INFO *
486 AcpiUtGetInterface (
487     ACPI_STRING             InterfaceName)
488 {
489     ACPI_INTERFACE_INFO     *NextInterface;
490 
491 
492     NextInterface = AcpiGbl_SupportedInterfaces;
493     while (NextInterface)
494     {
495         if (!ACPI_STRCMP (InterfaceName, NextInterface->Name))
496         {
497             return (NextInterface);
498         }
499 
500         NextInterface = NextInterface->Next;
501     }
502 
503     return (NULL);
504 }
505 
506 
507 /*******************************************************************************
508  *
509  * FUNCTION:    AcpiUtOsiImplementation
510  *
511  * PARAMETERS:  WalkState           - Current walk state
512  *
513  * RETURN:      Status
514  *
515  * DESCRIPTION: Implementation of the _OSI predefined control method. When
516  *              an invocation of _OSI is encountered in the system AML,
517  *              control is transferred to this function.
518  *
519  ******************************************************************************/
520 
521 ACPI_STATUS
522 AcpiUtOsiImplementation (
523     ACPI_WALK_STATE         *WalkState)
524 {
525     ACPI_OPERAND_OBJECT     *StringDesc;
526     ACPI_OPERAND_OBJECT     *ReturnDesc;
527     ACPI_INTERFACE_INFO     *InterfaceInfo;
528     ACPI_INTERFACE_HANDLER  InterfaceHandler;
529     ACPI_STATUS             Status;
530     UINT32                  ReturnValue;
531 
532 
533     ACPI_FUNCTION_TRACE (UtOsiImplementation);
534 
535 
536     /* Validate the string input argument (from the AML caller) */
537 
538     StringDesc = WalkState->Arguments[0].Object;
539     if (!StringDesc ||
540         (StringDesc->Common.Type != ACPI_TYPE_STRING))
541     {
542         return_ACPI_STATUS (AE_TYPE);
543     }
544 
545     /* Create a return object */
546 
547     ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
548     if (!ReturnDesc)
549     {
550         return_ACPI_STATUS (AE_NO_MEMORY);
551     }
552 
553     /* Default return value is 0, NOT SUPPORTED */
554 
555     ReturnValue = 0;
556     Status = AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
557     if (ACPI_FAILURE (Status))
558     {
559         AcpiUtRemoveReference (ReturnDesc);
560         return_ACPI_STATUS (Status);
561     }
562 
563     /* Lookup the interface in the global _OSI list */
564 
565     InterfaceInfo = AcpiUtGetInterface (StringDesc->String.Pointer);
566     if (InterfaceInfo &&
567         !(InterfaceInfo->Flags & ACPI_OSI_INVALID))
568     {
569         /*
570          * The interface is supported.
571          * Update the OsiData if necessary. We keep track of the latest
572          * version of Windows that has been requested by the BIOS.
573          */
574         if (InterfaceInfo->Value > AcpiGbl_OsiData)
575         {
576             AcpiGbl_OsiData = InterfaceInfo->Value;
577         }
578 
579         ReturnValue = ACPI_UINT32_MAX;
580     }
581 
582     AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
583 
584     /*
585      * Invoke an optional _OSI interface handler. The host OS may wish
586      * to do some interface-specific handling. For example, warn about
587      * certain interfaces or override the true/false support value.
588      */
589     InterfaceHandler = AcpiGbl_InterfaceHandler;
590     if (InterfaceHandler)
591     {
592         ReturnValue = InterfaceHandler (
593             StringDesc->String.Pointer, ReturnValue);
594     }
595 
596     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INFO,
597         "ACPI: BIOS _OSI(\"%s\") is %ssupported\n",
598         StringDesc->String.Pointer, ReturnValue == 0 ? "not " : ""));
599 
600     /* Complete the return object */
601 
602     ReturnDesc->Integer.Value = ReturnValue;
603     WalkState->ReturnDesc = ReturnDesc;
604     return_ACPI_STATUS (AE_OK);
605 }
606