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 - 2012, 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 */
137static 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, 0, 0}
157
158    /*
159     * All "optional" feature group strings (features that are implemented
160     * by the host) should be dynamically added by the host via
161     * AcpiInstallInterface and should not be manually added here.
162     *
163     * Examples of optional feature group strings:
164     *
165     * "Module Device"
166     * "Processor Device"
167     * "3.0 Thermal Model"
168     * "3.0 _SCP Extensions"
169     * "Processor Aggregator Device"
170     */
171};
172
173
174/*******************************************************************************
175 *
176 * FUNCTION:    AcpiUtInitializeInterfaces
177 *
178 * PARAMETERS:  None
179 *
180 * RETURN:      Status
181 *
182 * DESCRIPTION: Initialize the global _OSI supported interfaces list
183 *
184 ******************************************************************************/
185
186ACPI_STATUS
187AcpiUtInitializeInterfaces (
188    void)
189{
190    UINT32                  i;
191
192
193    (void) AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
194    AcpiGbl_SupportedInterfaces = AcpiDefaultSupportedInterfaces;
195
196    /* Link the static list of supported interfaces */
197
198    for (i = 0; i < (ACPI_ARRAY_LENGTH (AcpiDefaultSupportedInterfaces) - 1); i++)
199    {
200        AcpiDefaultSupportedInterfaces[i].Next =
201            &AcpiDefaultSupportedInterfaces[(ACPI_SIZE) i + 1];
202    }
203
204    AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
205    return (AE_OK);
206}
207
208
209/*******************************************************************************
210 *
211 * FUNCTION:    AcpiUtInterfaceTerminate
212 *
213 * PARAMETERS:  None
214 *
215 * RETURN:      None
216 *
217 * DESCRIPTION: Delete all interfaces in the global list. Sets
218 *              AcpiGbl_SupportedInterfaces to NULL.
219 *
220 ******************************************************************************/
221
222void
223AcpiUtInterfaceTerminate (
224    void)
225{
226    ACPI_INTERFACE_INFO     *NextInterface;
227
228
229    (void) AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
230    NextInterface = AcpiGbl_SupportedInterfaces;
231
232    while (NextInterface)
233    {
234        AcpiGbl_SupportedInterfaces = NextInterface->Next;
235
236        /* Only interfaces added at runtime can be freed */
237
238        if (NextInterface->Flags & ACPI_OSI_DYNAMIC)
239        {
240            ACPI_FREE (NextInterface->Name);
241            ACPI_FREE (NextInterface);
242        }
243
244        NextInterface = AcpiGbl_SupportedInterfaces;
245    }
246
247    AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
248}
249
250
251/*******************************************************************************
252 *
253 * FUNCTION:    AcpiUtInstallInterface
254 *
255 * PARAMETERS:  InterfaceName       - The interface to install
256 *
257 * RETURN:      Status
258 *
259 * DESCRIPTION: Install the interface into the global interface list.
260 *              Caller MUST hold AcpiGbl_OsiMutex
261 *
262 ******************************************************************************/
263
264ACPI_STATUS
265AcpiUtInstallInterface (
266    ACPI_STRING             InterfaceName)
267{
268    ACPI_INTERFACE_INFO     *InterfaceInfo;
269
270
271    /* Allocate info block and space for the name string */
272
273    InterfaceInfo = ACPI_ALLOCATE_ZEROED (sizeof (ACPI_INTERFACE_INFO));
274    if (!InterfaceInfo)
275    {
276        return (AE_NO_MEMORY);
277    }
278
279    InterfaceInfo->Name = ACPI_ALLOCATE_ZEROED (ACPI_STRLEN (InterfaceName) + 1);
280    if (!InterfaceInfo->Name)
281    {
282        ACPI_FREE (InterfaceInfo);
283        return (AE_NO_MEMORY);
284    }
285
286    /* Initialize new info and insert at the head of the global list */
287
288    ACPI_STRCPY (InterfaceInfo->Name, InterfaceName);
289    InterfaceInfo->Flags = ACPI_OSI_DYNAMIC;
290    InterfaceInfo->Next = AcpiGbl_SupportedInterfaces;
291
292    AcpiGbl_SupportedInterfaces = InterfaceInfo;
293    return (AE_OK);
294}
295
296
297/*******************************************************************************
298 *
299 * FUNCTION:    AcpiUtRemoveInterface
300 *
301 * PARAMETERS:  InterfaceName       - The interface to remove
302 *
303 * RETURN:      Status
304 *
305 * DESCRIPTION: Remove the interface from the global interface list.
306 *              Caller MUST hold AcpiGbl_OsiMutex
307 *
308 ******************************************************************************/
309
310ACPI_STATUS
311AcpiUtRemoveInterface (
312    ACPI_STRING             InterfaceName)
313{
314    ACPI_INTERFACE_INFO     *PreviousInterface;
315    ACPI_INTERFACE_INFO     *NextInterface;
316
317
318    PreviousInterface = NextInterface = AcpiGbl_SupportedInterfaces;
319    while (NextInterface)
320    {
321        if (!ACPI_STRCMP (InterfaceName, NextInterface->Name))
322        {
323            /* Found: name is in either the static list or was added at runtime */
324
325            if (NextInterface->Flags & ACPI_OSI_DYNAMIC)
326            {
327                /* Interface was added dynamically, remove and free it */
328
329                if (PreviousInterface == NextInterface)
330                {
331                    AcpiGbl_SupportedInterfaces = NextInterface->Next;
332                }
333                else
334                {
335                    PreviousInterface->Next = NextInterface->Next;
336                }
337
338                ACPI_FREE (NextInterface->Name);
339                ACPI_FREE (NextInterface);
340            }
341            else
342            {
343                /*
344                 * Interface is in static list. If marked invalid, then it
345                 * does not actually exist. Else, mark it invalid.
346                 */
347                if (NextInterface->Flags & ACPI_OSI_INVALID)
348                {
349                    return (AE_NOT_EXIST);
350                }
351
352                NextInterface->Flags |= ACPI_OSI_INVALID;
353            }
354
355            return (AE_OK);
356        }
357
358        PreviousInterface = NextInterface;
359        NextInterface = NextInterface->Next;
360    }
361
362    /* Interface was not found */
363
364    return (AE_NOT_EXIST);
365}
366
367
368/*******************************************************************************
369 *
370 * FUNCTION:    AcpiUtGetInterface
371 *
372 * PARAMETERS:  InterfaceName       - The interface to find
373 *
374 * RETURN:      ACPI_INTERFACE_INFO if found. NULL if not found.
375 *
376 * DESCRIPTION: Search for the specified interface name in the global list.
377 *              Caller MUST hold AcpiGbl_OsiMutex
378 *
379 ******************************************************************************/
380
381ACPI_INTERFACE_INFO *
382AcpiUtGetInterface (
383    ACPI_STRING             InterfaceName)
384{
385    ACPI_INTERFACE_INFO     *NextInterface;
386
387
388    NextInterface = AcpiGbl_SupportedInterfaces;
389    while (NextInterface)
390    {
391        if (!ACPI_STRCMP (InterfaceName, NextInterface->Name))
392        {
393            return (NextInterface);
394        }
395
396        NextInterface = NextInterface->Next;
397    }
398
399    return (NULL);
400}
401
402
403/*******************************************************************************
404 *
405 * FUNCTION:    AcpiUtOsiImplementation
406 *
407 * PARAMETERS:  WalkState           - Current walk state
408 *
409 * RETURN:      Status
410 *
411 * DESCRIPTION: Implementation of the _OSI predefined control method. When
412 *              an invocation of _OSI is encountered in the system AML,
413 *              control is transferred to this function.
414 *
415 ******************************************************************************/
416
417ACPI_STATUS
418AcpiUtOsiImplementation (
419    ACPI_WALK_STATE         *WalkState)
420{
421    ACPI_OPERAND_OBJECT     *StringDesc;
422    ACPI_OPERAND_OBJECT     *ReturnDesc;
423    ACPI_INTERFACE_INFO     *InterfaceInfo;
424    ACPI_INTERFACE_HANDLER  InterfaceHandler;
425    UINT32                  ReturnValue;
426
427
428    ACPI_FUNCTION_TRACE (UtOsiImplementation);
429
430
431    /* Validate the string input argument (from the AML caller) */
432
433    StringDesc = WalkState->Arguments[0].Object;
434    if (!StringDesc ||
435        (StringDesc->Common.Type != ACPI_TYPE_STRING))
436    {
437        return_ACPI_STATUS (AE_TYPE);
438    }
439
440    /* Create a return object */
441
442    ReturnDesc = AcpiUtCreateInternalObject (ACPI_TYPE_INTEGER);
443    if (!ReturnDesc)
444    {
445        return_ACPI_STATUS (AE_NO_MEMORY);
446    }
447
448    /* Default return value is 0, NOT SUPPORTED */
449
450    ReturnValue = 0;
451    (void) AcpiOsAcquireMutex (AcpiGbl_OsiMutex, ACPI_WAIT_FOREVER);
452
453    /* Lookup the interface in the global _OSI list */
454
455    InterfaceInfo = AcpiUtGetInterface (StringDesc->String.Pointer);
456    if (InterfaceInfo &&
457        !(InterfaceInfo->Flags & ACPI_OSI_INVALID))
458    {
459        /*
460         * The interface is supported.
461         * Update the OsiData if necessary. We keep track of the latest
462         * version of Windows that has been requested by the BIOS.
463         */
464        if (InterfaceInfo->Value > AcpiGbl_OsiData)
465        {
466            AcpiGbl_OsiData = InterfaceInfo->Value;
467        }
468
469        ReturnValue = ACPI_UINT32_MAX;
470    }
471
472    AcpiOsReleaseMutex (AcpiGbl_OsiMutex);
473
474    /*
475     * Invoke an optional _OSI interface handler. The host OS may wish
476     * to do some interface-specific handling. For example, warn about
477     * certain interfaces or override the true/false support value.
478     */
479    InterfaceHandler = AcpiGbl_InterfaceHandler;
480    if (InterfaceHandler)
481    {
482        ReturnValue = InterfaceHandler (
483            StringDesc->String.Pointer, ReturnValue);
484    }
485
486    ACPI_DEBUG_PRINT_RAW ((ACPI_DB_INFO,
487        "ACPI: BIOS _OSI(\"%s\") is %ssupported\n",
488        StringDesc->String.Pointer, ReturnValue == 0 ? "not " : ""));
489
490    /* Complete the return object */
491
492    ReturnDesc->Integer.Value = ReturnValue;
493    WalkState->ReturnDesc = ReturnDesc;
494    return_ACPI_STATUS (AE_OK);
495}
496