sys/contrib/dev/acpica-unix-20040527/utilities/utinit.c

   1 /******************************************************************************
   2  *
   3  * Module Name: utinit - Common ACPI subsystem initialization
   4  *              $Revision: 118 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2004, Intel Corp.
  13  * All rights reserved.
  14  *
  15  * 2. License
  16  *
  17  * 2.1. This is your license from Intel Corp. under its intellectual property
  18  * rights.  You may have additional license terms from the party that provided
  19  * you this software, covering your right to use that party's intellectual
  20  * property rights.
  21  *
  22  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  23  * copy of the source code appearing in this file ("Covered Code") an
  24  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  25  * base code distributed originally by Intel ("Original Intel Code") to copy,
  26  * make derivatives, distribute, use and display any portion of the Covered
  27  * Code in any form, with the right to sublicense such rights; and
  28  *
  29  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  30  * license (with the right to sublicense), under only those claims of Intel
  31  * patents that are infringed by the Original Intel Code, to make, use, sell,
  32  * offer to sell, and import the Covered Code and derivative works thereof
  33  * solely to the minimum extent necessary to exercise the above copyright
  34  * license, and in no event shall the patent license extend to any additions
  35  * to or modifications of the Original Intel Code.  No other license or right
  36  * is granted directly or by implication, estoppel or otherwise;
  37  *
  38  * The above copyright and patent license is granted only if the following
  39  * conditions are met:
  40  *
  41  * 3. Conditions
  42  *
  43  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  44  * Redistribution of source code of any substantial portion of the Covered
  45  * Code or modification with rights to further distribute source must include
  46  * the above Copyright Notice, the above License, this list of Conditions,
  47  * and the following Disclaimer and Export Compliance provision.  In addition,
  48  * Licensee must cause all Covered Code to which Licensee contributes to
  49  * contain a file documenting the changes Licensee made to create that Covered
  50  * Code and the date of any change.  Licensee must include in that file the
  51  * documentation of any changes made by any predecessor Licensee.  Licensee
  52  * must include a prominent statement that the modification is derived,
  53  * directly or indirectly, from Original Intel Code.
  54  *
  55  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  56  * Redistribution of source code of any substantial portion of the Covered
  57  * Code or modification without rights to further distribute source must
  58  * include the following Disclaimer and Export Compliance provision in the
  59  * documentation and/or other materials provided with distribution.  In
  60  * addition, Licensee may not authorize further sublicense of source of any
  61  * portion of the Covered Code, and must include terms to the effect that the
  62  * license from Licensee to its licensee is limited to the intellectual
  63  * property embodied in the software Licensee provides to its licensee, and
  64  * not to intellectual property embodied in modifications its licensee may
  65  * make.
  66  *
  67  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  68  * substantial portion of the Covered Code or modification must reproduce the
  69  * above Copyright Notice, and the following Disclaimer and Export Compliance
  70  * provision in the documentation and/or other materials provided with the
  71  * distribution.
  72  *
  73  * 3.4. Intel retains all right, title, and interest in and to the Original
  74  * Intel Code.
  75  *
  76  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  77  * Intel shall be used in advertising or otherwise to promote the sale, use or
  78  * other dealings in products derived from or relating to the Covered Code
  79  * without prior written authorization from Intel.
  80  *
  81  * 4. Disclaimer and Export Compliance
  82  *
  83  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  84  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  85  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  86  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  87  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  88  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  89  * PARTICULAR PURPOSE.
  90  *
  91  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  92  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  93  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  94  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  95  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  96  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  97  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  98  * LIMITED REMEDY.
  99  *
 100  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 101  * software or system incorporating such software without first obtaining any
 102  * required license or other approval from the U. S. Department of Commerce or
 103  * any other agency or department of the United States Government.  In the
 104  * event Licensee exports any such software from the United States or
 105  * re-exports any such software from a foreign destination, Licensee shall
 106  * ensure that the distribution and export/re-export of the software is in
 107  * compliance with all laws, regulations, orders, or other restrictions of the
 108  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 109  * any of its subsidiaries will export/re-export any technical data, process,
 110  * software, or service, directly or indirectly, to any country for which the
 111  * United States government or any agency thereof requires an export license,
 112  * other governmental approval, or letter of assurance, without first obtaining
 113  * such license, approval or letter.
 114  *
 115  *****************************************************************************/
 116
 117
 118 #define __UTINIT_C__
 119
 120 #include "acpi.h"
 121 #include "acnamesp.h"
 122 #include "acevents.h"
 123
 124 #define _COMPONENT          ACPI_UTILITIES
 125         ACPI_MODULE_NAME    ("utinit")
 126
 127
 128 /*******************************************************************************
 129  *
 130  * FUNCTION:    AcpiUtFadtRegisterError
 131  *
 132  * PARAMETERS:  *RegisterName           - Pointer to string identifying register
 133  *              Value                   - Actual register contents value
 134  *              AcpiTestSpecSection     - TDS section containing assertion
 135  *              AcpiAssertion           - Assertion number being tested
 136  *
 137  * RETURN:      AE_BAD_VALUE
 138  *
 139  * DESCRIPTION: Display failure message and link failure to TDS assertion
 140  *
 141  ******************************************************************************/
 142
 143 static void
 144 AcpiUtFadtRegisterError (
 145     char                    *RegisterName,
 146     UINT32                  Value,
 147     ACPI_SIZE               Offset)
 148 {
 149
 150     ACPI_REPORT_WARNING (
 151         ("Invalid FADT value %s=%X at offset %X FADT=%p\n",
 152         RegisterName, Value, (UINT32) Offset, AcpiGbl_FADT));
 153 }
 154
 155
 156 /******************************************************************************
 157  *
 158  * FUNCTION:    AcpiUtValidateFadt
 159  *
 160  * PARAMETERS:  None
 161  *
 162  * RETURN:      Status
 163  *
 164  * DESCRIPTION: Validate various ACPI registers in the FADT
 165  *
 166  ******************************************************************************/
 167
 168 ACPI_STATUS
 169 AcpiUtValidateFadt (
 170     void)
 171 {
 172
 173     /*
 174      * Verify Fixed ACPI Description Table fields,
 175      * but don't abort on any problems, just display error
 176      */
 177     if (AcpiGbl_FADT->Pm1EvtLen < 4)
 178     {
 179         AcpiUtFadtRegisterError ("PM1_EVT_LEN",
 180                         (UINT32) AcpiGbl_FADT->Pm1EvtLen,
 181                         ACPI_FADT_OFFSET (Pm1EvtLen));
 182     }
 183
 184     if (!AcpiGbl_FADT->Pm1CntLen)
 185     {
 186         AcpiUtFadtRegisterError ("PM1_CNT_LEN", 0,
 187                         ACPI_FADT_OFFSET (Pm1CntLen));
 188     }
 189
 190     if (!ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPm1aEvtBlk.Address))
 191     {
 192         AcpiUtFadtRegisterError ("X_PM1a_EVT_BLK", 0,
 193                         ACPI_FADT_OFFSET (XPm1aEvtBlk.Address));
 194     }
 195
 196     if (!ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPm1aCntBlk.Address))
 197     {
 198         AcpiUtFadtRegisterError ("X_PM1a_CNT_BLK", 0,
 199                         ACPI_FADT_OFFSET (XPm1aCntBlk.Address));
 200     }
 201
 202     if (!ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPmTmrBlk.Address))
 203     {
 204         AcpiUtFadtRegisterError ("X_PM_TMR_BLK", 0,
 205                         ACPI_FADT_OFFSET (XPmTmrBlk.Address));
 206     }
 207
 208     if ((ACPI_VALID_ADDRESS (AcpiGbl_FADT->XPm2CntBlk.Address) &&
 209         !AcpiGbl_FADT->Pm2CntLen))
 210     {
 211         AcpiUtFadtRegisterError ("PM2_CNT_LEN",
 212                         (UINT32) AcpiGbl_FADT->Pm2CntLen,
 213                         ACPI_FADT_OFFSET (Pm2CntLen));
 214     }
 215
 216     if (AcpiGbl_FADT->PmTmLen < 4)
 217     {
 218         AcpiUtFadtRegisterError ("PM_TM_LEN",
 219                         (UINT32) AcpiGbl_FADT->PmTmLen,
 220                         ACPI_FADT_OFFSET (PmTmLen));
 221     }
 222
 223     /* Length of GPE blocks must be a multiple of 2 */
 224
 225     if (ACPI_VALID_ADDRESS (AcpiGbl_FADT->XGpe0Blk.Address) &&
 226         (AcpiGbl_FADT->Gpe0BlkLen & 1))
 227     {
 228         AcpiUtFadtRegisterError ("(x)GPE0_BLK_LEN",
 229                         (UINT32) AcpiGbl_FADT->Gpe0BlkLen,
 230                         ACPI_FADT_OFFSET (Gpe0BlkLen));
 231     }
 232
 233     if (ACPI_VALID_ADDRESS (AcpiGbl_FADT->XGpe1Blk.Address) &&
 234         (AcpiGbl_FADT->Gpe1BlkLen & 1))
 235     {
 236         AcpiUtFadtRegisterError ("(x)GPE1_BLK_LEN",
 237                         (UINT32) AcpiGbl_FADT->Gpe1BlkLen,
 238                         ACPI_FADT_OFFSET (Gpe1BlkLen));
 239     }
 240
 241     return (AE_OK);
 242 }
 243
 244
 245 /******************************************************************************
 246  *
 247  * FUNCTION:    AcpiUtTerminate
 248  *
 249  * PARAMETERS:  none
 250  *
 251  * RETURN:      none
 252  *
 253  * DESCRIPTION: free global memory
 254  *
 255  ******************************************************************************/
 256
 257 void
 258 AcpiUtTerminate (void)
 259 {
 260     ACPI_GPE_BLOCK_INFO     *GpeBlock;
 261     ACPI_GPE_BLOCK_INFO     *NextGpeBlock;
 262     ACPI_GPE_XRUPT_INFO     *GpeXruptInfo;
 263     ACPI_GPE_XRUPT_INFO     *NextGpeXruptInfo;
 264
 265
 266     ACPI_FUNCTION_TRACE ("UtTerminate");
 267
 268
 269     /* Free global tables, etc. */
 270
 271
 272     /* Free global GPE blocks and related info structures */
 273
 274     GpeXruptInfo = AcpiGbl_GpeXruptListHead;
 275     while (GpeXruptInfo)
 276     {
 277         GpeBlock = GpeXruptInfo->GpeBlockListHead;
 278         while (GpeBlock)
 279         {
 280             NextGpeBlock = GpeBlock->Next;
 281             ACPI_MEM_FREE (GpeBlock->EventInfo);
 282             ACPI_MEM_FREE (GpeBlock->RegisterInfo);
 283             ACPI_MEM_FREE (GpeBlock);
 284
 285             GpeBlock = NextGpeBlock;
 286         }
 287         NextGpeXruptInfo = GpeXruptInfo->Next;
 288         ACPI_MEM_FREE (GpeXruptInfo);
 289         GpeXruptInfo = NextGpeXruptInfo;
 290     }
 291
 292     return_VOID;
 293 }
 294
 295
 296 /*******************************************************************************
 297  *
 298  * FUNCTION:    AcpiUtSubsystemShutdown
 299  *
 300  * PARAMETERS:  none
 301  *
 302  * RETURN:      none
 303  *
 304  * DESCRIPTION: Shutdown the various subsystems.  Don't delete the mutex
 305  *              objects here -- because the AML debugger may be still running.
 306  *
 307  ******************************************************************************/
 308
 309 void
 310 AcpiUtSubsystemShutdown (void)
 311 {
 312
 313     ACPI_FUNCTION_TRACE ("UtSubsystemShutdown");
 314
 315     /* Just exit if subsystem is already shutdown */
 316
 317     if (AcpiGbl_Shutdown)
 318     {
 319         ACPI_DEBUG_PRINT ((ACPI_DB_ERROR, "ACPI Subsystem is already terminated\n"));
 320         return_VOID;
 321     }
 322
 323     /* Subsystem appears active, go ahead and shut it down */
 324
 325     AcpiGbl_Shutdown = TRUE;
 326     ACPI_DEBUG_PRINT ((ACPI_DB_INFO, "Shutting down ACPI Subsystem...\n"));
 327
 328     /* Close the AcpiEvent Handling */
 329
 330     AcpiEvTerminate ();
 331
 332     /* Close the Namespace */
 333
 334     AcpiNsTerminate ();
 335
 336     /* Close the globals */
 337
 338     AcpiUtTerminate ();
 339
 340     /* Purge the local caches */
 341
 342     (void) AcpiPurgeCachedObjects ();
 343
 344     /* Debug only - display leftover memory allocation, if any */
 345
 346 #ifdef ACPI_DBG_TRACK_ALLOCATIONS
 347     AcpiUtDumpAllocations (ACPI_UINT32_MAX, NULL);
 348 #endif
 349
 350     return_VOID;
 351 }
 352
 353