xref: /haiku/src/add-ons/kernel/bus_managers/acpi/acpica/components/utilities/utosi.c (revision 37fedaf8494b34aad811abcc49e79aa32943f880)
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 - 2013, 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  * Strings supported by the _OSI predefined control method (which is
127  * implemented internally within this module.)
128  *
129  * March 2009: Removed "Linux" as this host no longer wants to respond true
130  * for this string. Basically, the only safe OS strings are windows-related
131  * and in many or most cases represent the only test path within the
132  * BIOS-provided ASL code.
133  *
134  * The last element of each entry is used to track the newest version of
135  * Windows that the BIOS has requested.
136  */
137 static ACPI_INTERFACE_INFO    AcpiDefaultSupportedInterfaces[] =
138 {
139     /* Operating System Vendor Strings */
140 
141     {"Windows 2000",        NULL, 0, ACPI_OSI_WIN_2000},         /* Windows 2000 */
142     {"Windows 2001",        NULL, 0, ACPI_OSI_WIN_XP},           /* Windows XP */
143     {"Windows 2001 SP1",    NULL, 0, ACPI_OSI_WIN_XP_SP1},       /* Windows XP SP1 */
144     {"Windows 2001.1",      NULL, 0, ACPI_OSI_WINSRV_2003},      /* Windows Server 2003 */
145     {"Windows 2001 SP2",    NULL, 0, ACPI_OSI_WIN_XP_SP2},       /* Windows XP SP2 */
146     {"Windows 2001.1 SP1",  NULL, 0, ACPI_OSI_WINSRV_2003_SP1},  /* Windows Server 2003 SP1 - Added 03/2006 */
147     {"Windows 2006",        NULL, 0, ACPI_OSI_WIN_VISTA},        /* Windows Vista - Added 03/2006 */
148     {"Windows 2006.1",      NULL, 0, ACPI_OSI_WINSRV_2008},      /* Windows Server 2008 - Added 09/2009 */
149     {"Windows 2006 SP1",    NULL, 0, ACPI_OSI_WIN_VISTA_SP1},    /* Windows Vista SP1 - Added 09/2009 */
150     {"Windows 2006 SP2",    NULL, 0, ACPI_OSI_WIN_VISTA_SP2},    /* Windows Vista SP2 - Added 09/2010 */
151     {"Windows 2009",        NULL, 0, ACPI_OSI_WIN_7},            /* Windows 7 and Server 2008 R2 - Added 09/2009 */
152     {"Windows 2012",        NULL, 0, ACPI_OSI_WIN_8},            /* Windows 8 and Server 2012 - Added 08/2012 */
153 
154     /* Feature Group Strings */
155 
156     {"Extended Address Space Descriptor", NULL, ACPI_OSI_FEATURE, 0},
157 
158     /*
159      * All "optional" feature group strings (features that are implemented
160      * by the host) should be dynamically modified to VALID by the host via
161      * AcpiInstallInterface or AcpiUpdateInterfaces. Such optional feature
162      * group strings are set as INVALID by default here.
163      */
164 
165     {"Module Device",               NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
166     {"Processor Device",            NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
167     {"3.0 Thermal Model",           NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
168     {"3.0 _SCP Extensions",         NULL, ACPI_OSI_OPTIONAL_FEATURE, 0},
169     {"Processor Aggregator Device", NULL, ACPI_OSI_OPTIONAL_FEATURE, 0}
170 };
171 
172 
173 /*******************************************************************************
174  *
175  * FUNCTION:    AcpiUtInitializeInterfaces
176  *
177  * PARAMETERS:  None
178  *
179  * RETURN:      Status
180  *
181  * DESCRIPTION: Initialize the global _OSI supported interfaces list
182  *
183  ******************************************************************************/
184 
185 ACPI_STATUS
186 AcpiUtInitializeInterfaces (
187     void)
188 {
189     ACPI_STATUS             Status;
190     UINT32                  i;
191 
192 
193     Status = AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
194     if (ACPI_FAILURE (Status))
195     {
196         return (Status);
197     }
198 
199     AcpiGbl_SupportedInterfaces = AcpiDefaultSupportedInterfaces;
200 
201     /* Link the static list of supported interfaces */
202 
203     for (i = 0; i < (ACPI_ARRAY_LENGTH (AcpiDefaultSupportedInterfaces) - 1); i++)
204     {
205         AcpiDefaultSupportedInterfaces[i].Next =
206             &AcpiDefaultSupportedInterfaces[(ACPI_SIZE) i + 1];
207     }
208 
209     AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
210     return (AE_OK);
211 }
212 
213 
214 /*******************************************************************************
215  *
216  * FUNCTION:    AcpiUtInterfaceTerminate
217  *
218  * PARAMETERS:  None
219  *
220  * RETURN:      Status
221  *
222  * DESCRIPTION: Delete all interfaces in the global list. Sets
223  *              AcpiGbl_SupportedInterfaces to NULL.
224  *
225  ******************************************************************************/
226 
227 ACPI_STATUS
228 AcpiUtInterfaceTerminate (
229     void)
230 {
231     ACPI_STATUS             Status;
232     ACPI_INTERFACE_INFO     *NextInterface;
233 
234 
235     Status = AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
236     if (ACPI_FAILURE (Status))
237     {
238         return (Status);
239     }
240 
241     NextInterface = AcpiGbl_SupportedInterfaces;
242     while (NextInterface)
243     {
244         AcpiGbl_SupportedInterfaces = NextInterface->Next;
245 
246         if (NextInterface->Flags & ACPI_OSI_DYNAMIC)
247         {
248             /* Only interfaces added at runtime can be freed */
249 
250             ACPI_FREE (NextInterface->Name);
251             ACPI_FREE (NextInterface);
252         }
253         else
254         {
255             /* Interface is in static list. Reset it to invalid or valid. */
256 
257             if (NextInterface->Flags & ACPI_OSI_DEFAULT_INVALID)
258             {
259                 NextInterface->Flags |= ACPI_OSI_INVALID;
260             }
261             else
262             {
263                 NextInterface->Flags &= ~ACPI_OSI_INVALID;
264             }
265         }
266 
267         NextInterface = AcpiGbl_SupportedInterfaces;
268     }
269 
270     AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
271     return (AE_OK);
272 }
273 
274 
275 /*******************************************************************************
276  *
277  * FUNCTION:    AcpiUtInstallInterface
278  *
279  * PARAMETERS:  InterfaceName       - The interface to install
280  *
281  * RETURN:      Status
282  *
283  * DESCRIPTION: Install the interface into the global interface list.
284  *              Caller MUST hold AcpiGbl_OsiMutex
285  *
286  ******************************************************************************/
287 
288 ACPI_STATUS
289 AcpiUtInstallInterface (
290     ACPI_STRING             InterfaceName)
291 {
292     ACPI_INTERFACE_INFO     *InterfaceInfo;
293 
294 
295     /* Allocate info block and space for the name string */
296 
297     InterfaceInfo = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_INTERFACE_INFO));
298     if (!InterfaceInfo)
299     {
300         return (AE_NO_MEMORY);
301     }
302 
303     InterfaceInfo->Name = ACPI_ALLOCATE_ZEROED (ACPI_STRLEN (InterfaceName) + 1);
304     if (!InterfaceInfo->Name)
305     {
306         ACPI_FREE (InterfaceInfo);
307         return (AE_NO_MEMORY);
308     }
309 
310     /* Initialize new info and insert at the head of the global list */
311 
312     ACPI_STRCPY (InterfaceInfo->Name, InterfaceName);
313     InterfaceInfo->Flags = ACPI_OSI_DYNAMIC;
314     InterfaceInfo->Next = AcpiGbl_SupportedInterfaces;
315 
316     AcpiGbl_SupportedInterfaces = InterfaceInfo;
317     return (AE_OK);
318 }
319 
320 
321 /*******************************************************************************
322  *
323  * FUNCTION:    AcpiUtRemoveInterface
324  *
325  * PARAMETERS:  InterfaceName       - The interface to remove
326  *
327  * RETURN:      Status
328  *
329  * DESCRIPTION: Remove the interface from the global interface list.
330  *              Caller MUST hold AcpiGbl_OsiMutex
331  *
332  ******************************************************************************/
333 
334 ACPI_STATUS
335 AcpiUtRemoveInterface (
336     ACPI_STRING             InterfaceName)
337 {
338     ACPI_INTERFACE_INFO     *PreviousInterface;
339     ACPI_INTERFACE_INFO     *NextInterface;
340 
341 
342     PreviousInterface = NextInterface = AcpiGbl_SupportedInterfaces;
343     while (NextInterface)
344     {
345         if (!ACPI_STRCMP (InterfaceName, NextInterface->Name))
346         {
347             /* Found: name is in either the static list or was added at runtime */
348 
349             if (NextInterface->Flags & ACPI_OSI_DYNAMIC)
350             {
351                 /* Interface was added dynamically, remove and free it */
352 
353                 if (PreviousInterface == NextInterface)
354                 {
355                     AcpiGbl_SupportedInterfaces = NextInterface->Next;
356                 }
357                 else
358                 {
359                     PreviousInterface->Next = NextInterface->Next;
360                 }
361 
362                 ACPI_FREE (NextInterface->Name);
363                 ACPI_FREE (NextInterface);
364             }
365             else
366             {
367                 /*
368                  * Interface is in static list. If marked invalid, then it
369                  * does not actually exist. Else, mark it invalid.
370                  */
371                 if (NextInterface->Flags & ACPI_OSI_INVALID)
372                 {
373                     return (AE_NOT_EXIST);
374                 }
375 
376                 NextInterface->Flags |= ACPI_OSI_INVALID;
377             }
378 
379             return (AE_OK);
380         }
381 
382         PreviousInterface = NextInterface;
383         NextInterface = NextInterface->Next;
384     }
385 
386     /* Interface was not found */
387 
388     return (AE_NOT_EXIST);
389 }
390 
391 
392 /*******************************************************************************
393  *
394  * FUNCTION:    AcpiUtUpdateInterfaces
395  *
396  * PARAMETERS:  Action              - Actions to be performed during the
397  *                                    update
398  *
399  * RETURN:      Status
400  *
401  * DESCRIPTION: Update _OSI interface strings, disabling or enabling OS vendor
402  *              strings or/and feature group strings.
403  *              Caller MUST hold AcpiGbl_OsiMutex
404  *
405  ******************************************************************************/
406 
407 ACPI_STATUS
408 AcpiUtUpdateInterfaces (
409     UINT8                   Action)
410 {
411     ACPI_INTERFACE_INFO     *NextInterface;
412 
413 
414     NextInterface = AcpiGbl_SupportedInterfaces;
415     while (NextInterface)
416     {
417         if (((NextInterface->Flags & ACPI_OSI_FEATURE) &&
418              (Action & ACPI_FEATURE_STRINGS)) ||
419             (!(NextInterface->Flags & ACPI_OSI_FEATURE) &&
420              (Action & ACPI_VENDOR_STRINGS)))
421         {
422             if (Action & ACPI_DISABLE_INTERFACES)
423             {
424                 /* Mark the interfaces as invalid */
425 
426                 NextInterface->Flags |= ACPI_OSI_INVALID;
427             }
428             else
429             {
430                 /* Mark the interfaces as valid */
431 
432                 NextInterface->Flags &= ~ACPI_OSI_INVALID;
433             }
434         }
435 
436         NextInterface = NextInterface->Next;
437     }
438 
439     return (AE_OK);
440 }
441 
442 
443 /*******************************************************************************
444  *
445  * FUNCTION:    AcpiUtGetInterface
446  *
447  * PARAMETERS:  InterfaceName       - The interface to find
448  *
449  * RETURN:      ACPI_INTERFACE_INFO if found. NULL if not found.
450  *
451  * DESCRIPTION: Search for the specified interface name in the global list.
452  *              Caller MUST hold AcpiGbl_OsiMutex
453  *
454  ******************************************************************************/
455 
456 ACPI_INTERFACE_INFO *
457 AcpiUtGetInterface (
458     ACPI_STRING             InterfaceName)
459 {
460     ACPI_INTERFACE_INFO     *NextInterface;
461 
462 
463     NextInterface = AcpiGbl_SupportedInterfaces;
464     while (NextInterface)
465     {
466         if (!ACPI_STRCMP (InterfaceName, NextInterface->Name))
467         {
468             return (NextInterface);
469         }
470 
471         NextInterface = NextInterface->Next;
472     }
473 
474     return (NULL);
475 }
476 
477 
478 /*******************************************************************************
479  *
480  * FUNCTION:    AcpiUtOsiImplementation
481  *
482  * PARAMETERS:  WalkState           - Current walk state
483  *
484  * RETURN:      Status
485  *
486  * DESCRIPTION: Implementation of the _OSI predefined control method. When
487  *              an invocation of _OSI is encountered in the system AML,
488  *              control is transferred to this function.
489  *
490  ******************************************************************************/
491 
492 ACPI_STATUS
493 AcpiUtOsiImplementation (
494     ACPI_WALK_STATE         *WalkState)
495 {
496     ACPI_OPERAND_OBJECT     *StringDesc;
497     ACPI_OPERAND_OBJECT     *ReturnDesc;
498     ACPI_INTERFACE_INFO     *InterfaceInfo;
499     ACPI_INTERFACE_HANDLER  InterfaceHandler;
500     ACPI_STATUS             Status;
501     UINT32                  ReturnValue;
502 
503 
504     ACPI_FUNCTION_TRACE (UtOsiImplementation);
505 
506 
507     /* Validate the string input argument (from the AML caller) */
508 
509     StringDesc = WalkState->Arguments[0].Object;
510     if (!StringDesc ||
511         (StringDesc->Common.Type != ACPI_TYPE_STRING))
512     {
513         return_ACPI_STATUS (AE_TYPE);
514     }
515 
516     /* Create a return object */
517 
518     ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
519     if (!ReturnDesc)
520     {
521         return_ACPI_STATUS (AE_NO_MEMORY);
522     }
523 
524     /* Default return value is 0, NOT SUPPORTED */
525 
526     ReturnValue = 0;
527     Status = AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
528     if (ACPI_FAILURE (Status))
529     {
530         AcpiUtRemoveReference (ReturnDesc);
531         return_ACPI_STATUS (Status);
532     }
533 
534     /* Lookup the interface in the global _OSI list */
535 
536     InterfaceInfo = AcpiUtGetInterface (StringDesc->String.Pointer);
537     if (InterfaceInfo &&
538         !(InterfaceInfo->Flags & ACPI_OSI_INVALID))
539     {
540         /*
541          * The interface is supported.
542          * Update the OsiData if necessary. We keep track of the latest
543          * version of Windows that has been requested by the BIOS.
544          */
545         if (InterfaceInfo->Value > AcpiGbl_OsiData)
546         {
547             AcpiGbl_OsiData = InterfaceInfo->Value;
548         }
549 
550         ReturnValue = ACPI_UINT32_MAX;
551     }
552 
553     AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
554 
555     /*
556      * Invoke an optional _OSI interface handler. The host OS may wish
557      * to do some interface-specific handling. For example, warn about
558      * certain interfaces or override the true/false support value.
559      */
560     InterfaceHandler = AcpiGbl_InterfaceHandler;
561     if (InterfaceHandler)
562     {
563         ReturnValue = InterfaceHandler (
564             StringDesc->String.Pointer, ReturnValue);
565     }
566 
567     ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INFO,
568         "ACPI: BIOS _OSI(\"%s\") is %ssupported\n",
569         StringDesc->String.Pointer, ReturnValue == 0 ? "not " : ""));
570 
571     /* Complete the return object */
572 
573     ReturnDesc->Integer.Value = ReturnValue;
574     WalkState->ReturnDesc = ReturnDesc;
575     return_ACPI_STATUS (AE_OK);
576 }
577