sys/contrib/dev/acpica-unix/os_specific/service_layers/oswintbl.c

   1 /******************************************************************************
   2  *
   3  * Module Name: oswintbl - Windows OSL for obtaining ACPI tables
   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
 117 #include "acpi.h"
 118
 119 #ifdef WIN32
 120 #pragma warning(disable:4115)   /* warning C4115: (caused by rpcasync.h) */
 121 #include <windows.h>
 122
 123 #elif WIN64
 124 #include <windowsx.h>
 125 #endif
 126
 127 #define _COMPONENT          ACPI_OS_SERVICES
 128         ACPI_MODULE_NAME    ("oswintbl")
 129
 130
 131 static char             KeyBuffer[64];
 132 static char             ErrorBuffer[64];
 133
 134
 135 /* Little front-end to win FormatMessage */
 136
 137 char *
 138 OsFormatException (
 139     LONG                Status)
 140 {
 141
 142     ErrorBuffer[0] = 0;
 143     FormatMessage (FORMAT_MESSAGE_FROM_SYSTEM, NULL, Status, 0,
 144         ErrorBuffer, 64, NULL);
 145
 146     return (ErrorBuffer);
 147 }
 148
 149
 150 /******************************************************************************
 151  *
 152  * FUNCTION:    OsGetTable
 153  *
 154  * PARAMETERS:  Signature       - ACPI Signature for desired table. must be
 155  *                                  a null terminated string.
 156  *
 157  * RETURN:      Pointer to the table. NULL if failure.
 158  *
 159  * DESCRIPTION: Get an ACPI table from the Windows registry.
 160  *
 161  *****************************************************************************/
 162
 163 ACPI_TABLE_HEADER *
 164 OsGetTable (
 165     char                *Signature)
 166 {
 167     HKEY                Handle = NULL;
 168     ULONG               i;
 169     LONG                Status;
 170     ULONG               Type;
 171     ULONG               NameSize;
 172     ULONG               DataSize;
 173     HKEY                SubKey;
 174     ACPI_TABLE_HEADER   *ReturnTable;
 175
 176
 177     /* Get a handle to the table key */
 178
 179     while (1)
 180     {
 181         ACPI_STRCPY (KeyBuffer, "HARDWARE\\ACPI\\");
 182         ACPI_STRCAT (KeyBuffer, Signature);
 183
 184         Status = RegOpenKeyEx (HKEY_LOCAL_MACHINE, KeyBuffer,
 185                     0L, KEY_READ, &Handle);
 186
 187         if (Status != ERROR_SUCCESS)
 188         {
 189             /*
 190              * Somewhere along the way, MS changed the registry entry for
 191              * the FADT from
 192              * HARDWARE/ACPI/FACP  to
 193              * HARDWARE/ACPI/FADT.
 194              *
 195              * This code allows for both.
 196              */
 197             if (ACPI_COMPARE_NAME (Signature, "FACP"))
 198             {
 199                 Signature = "FADT";
 200             }
 201             else
 202             {
 203                 AcpiOsPrintf (
 204                     "Could not find %s in registry at %s: %s (Status=0x%X)\n",
 205                     Signature, KeyBuffer, OsFormatException (Status), Status);
 206                 return (NULL);
 207             }
 208         }
 209         else
 210         {
 211             break;
 212         }
 213     }
 214
 215     /* Actual data for table is down a couple levels */
 216
 217     for (i = 0; ;)
 218     {
 219         Status = RegEnumKey (Handle, i, KeyBuffer, sizeof (KeyBuffer));
 220         i += 1;
 221         if (Status == ERROR_NO_MORE_ITEMS)
 222         {
 223             break;
 224         }
 225
 226         Status = RegOpenKey (Handle, KeyBuffer, &SubKey);
 227         if (Status != ERROR_SUCCESS)
 228         {
 229             AcpiOsPrintf ("Could not open %s entry: %s\n",
 230                 Signature, OsFormatException (Status));
 231             return (NULL);
 232         }
 233
 234         RegCloseKey (Handle);
 235         Handle = SubKey;
 236         i = 0;
 237     }
 238
 239     /* Find the (binary) table entry */
 240
 241     for (i = 0; ;)
 242     {
 243         NameSize = sizeof (KeyBuffer);
 244         Status = RegEnumValue (Handle, i, KeyBuffer, &NameSize,
 245                     NULL, &Type, NULL, 0);
 246         if (Status != ERROR_SUCCESS)
 247         {
 248             AcpiOsPrintf ("Could not get %s registry entry: %s\n",
 249                 Signature, OsFormatException (Status));
 250             return (NULL);
 251         }
 252
 253         if (Type == REG_BINARY)
 254         {
 255             break;
 256         }
 257         i += 1;
 258     }
 259
 260     /* Get the size of the table */
 261
 262     Status = RegQueryValueEx (Handle, KeyBuffer, NULL, NULL, NULL, &DataSize);
 263     if (Status != ERROR_SUCCESS)
 264     {
 265         AcpiOsPrintf ("Could not read the %s table size: %s\n",
 266             Signature, OsFormatException (Status));
 267         return (NULL);
 268     }
 269
 270     /* Allocate a new buffer for the table */
 271
 272     ReturnTable = AcpiOsAllocate (DataSize);
 273     if (!ReturnTable)
 274     {
 275         goto Cleanup;
 276     }
 277
 278     /* Get the actual table from the registry */
 279
 280     Status = RegQueryValueEx (Handle, KeyBuffer, NULL, NULL,
 281                 (UCHAR *) ReturnTable, &DataSize);
 282     if (Status != ERROR_SUCCESS)
 283     {
 284         AcpiOsPrintf ("Could not read %s data: %s\n",
 285             Signature, OsFormatException (Status));
 286         AcpiOsFree (ReturnTable);
 287         return (NULL);
 288     }
 289
 290 Cleanup:
 291     RegCloseKey (Handle);
 292     return (ReturnTable);
 293 }
 294