sys/contrib/dev/acpica-unix/utilities/utosi.c

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