sys/contrib/dev/acpica/evevent.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evevent - Fixed Event handling and dispatch
   4  *              $Revision: 1.117 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2005, 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 #include <contrib/dev/acpica/acpi.h>
 118 #include <contrib/dev/acpica/acevents.h>
 119
 120 #define _COMPONENT          ACPI_EVENTS
 121         ACPI_MODULE_NAME    ("evevent")
 122
 123 /* Local prototypes */
 124
 125 static ACPI_STATUS
 126 AcpiEvFixedEventInitialize (
 127     void);
 128
 129 static UINT32
 130 AcpiEvFixedEventDispatch (
 131     UINT32                  Event);
 132
 133
 134 /*******************************************************************************
 135  *
 136  * FUNCTION:    AcpiEvInitializeEvents
 137  *
 138  * PARAMETERS:  None
 139  *
 140  * RETURN:      Status
 141  *
 142  * DESCRIPTION: Initialize global data structures for ACPI events (Fixed, GPE)
 143  *
 144  ******************************************************************************/
 145
 146 ACPI_STATUS
 147 AcpiEvInitializeEvents (
 148     void)
 149 {
 150     ACPI_STATUS             Status;
 151
 152
 153     ACPI_FUNCTION_TRACE ("EvInitializeEvents");
 154
 155
 156     /* Make sure we have ACPI tables */
 157
 158     if (!AcpiGbl_DSDT)
 159     {
 160         ACPI_DEBUG_PRINT ((ACPI_DB_WARN, "No ACPI tables present!\n"));
 161         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
 162     }
 163
 164     /*
 165      * Initialize the Fixed and General Purpose Events. This is done prior to
 166      * enabling SCIs to prevent interrupts from occurring before the handlers are
 167      * installed.
 168      */
 169     Status = AcpiEvFixedEventInitialize ();
 170     if (ACPI_FAILURE (Status))
 171     {
 172         ACPI_REPORT_ERROR ((
 173                 "Unable to initialize fixed events, %s\n",
 174                 AcpiFormatException (Status)));
 175         return_ACPI_STATUS (Status);
 176     }
 177
 178     Status = AcpiEvGpeInitialize ();
 179     if (ACPI_FAILURE (Status))
 180     {
 181         ACPI_REPORT_ERROR ((
 182                 "Unable to initialize general purpose events, %s\n",
 183                 AcpiFormatException (Status)));
 184         return_ACPI_STATUS (Status);
 185     }
 186
 187     return_ACPI_STATUS (Status);
 188 }
 189
 190
 191 /*******************************************************************************
 192  *
 193  * FUNCTION:    AcpiEvInstallXruptHandlers
 194  *
 195  * PARAMETERS:  None
 196  *
 197  * RETURN:      Status
 198  *
 199  * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
 200  *
 201  ******************************************************************************/
 202
 203 ACPI_STATUS
 204 AcpiEvInstallXruptHandlers (
 205     void)
 206 {
 207     ACPI_STATUS             Status;
 208
 209
 210     ACPI_FUNCTION_TRACE ("EvInstallXruptHandlers");
 211
 212
 213     /* Install the SCI handler */
 214
 215     Status = AcpiEvInstallSciHandler ();
 216     if (ACPI_FAILURE (Status))
 217     {
 218         ACPI_REPORT_ERROR ((
 219                 "Unable to install System Control Interrupt Handler, %s\n",
 220                 AcpiFormatException (Status)));
 221         return_ACPI_STATUS (Status);
 222     }
 223
 224     /* Install the handler for the Global Lock */
 225
 226     Status = AcpiEvInitGlobalLockHandler ();
 227     if (ACPI_FAILURE (Status))
 228     {
 229         ACPI_REPORT_ERROR ((
 230                 "Unable to initialize Global Lock handler, %s\n",
 231                 AcpiFormatException (Status)));
 232         return_ACPI_STATUS (Status);
 233     }
 234
 235     AcpiGbl_EventsInitialized = TRUE;
 236     return_ACPI_STATUS (Status);
 237 }
 238
 239
 240 /*******************************************************************************
 241  *
 242  * FUNCTION:    AcpiEvFixedEventInitialize
 243  *
 244  * PARAMETERS:  None
 245  *
 246  * RETURN:      Status
 247  *
 248  * DESCRIPTION: Install the fixed event handlers and enable the fixed events.
 249  *
 250  ******************************************************************************/
 251
 252 static ACPI_STATUS
 253 AcpiEvFixedEventInitialize (
 254     void)
 255 {
 256     ACPI_NATIVE_UINT        i;
 257     ACPI_STATUS             Status;
 258
 259
 260     /*
 261      * Initialize the structure that keeps track of fixed event handlers
 262      * and enable the fixed events.
 263      */
 264     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
 265     {
 266         AcpiGbl_FixedEventHandlers[i].Handler = NULL;
 267         AcpiGbl_FixedEventHandlers[i].Context = NULL;
 268
 269         /* Enable the fixed event */
 270
 271         if (AcpiGbl_FixedEventInfo[i].EnableRegisterId != 0xFF)
 272         {
 273             Status = AcpiSetRegister (
 274                         AcpiGbl_FixedEventInfo[i].EnableRegisterId,
 275                         0, ACPI_MTX_LOCK);
 276             if (ACPI_FAILURE (Status))
 277             {
 278                 return (Status);
 279             }
 280         }
 281     }
 282
 283     return (AE_OK);
 284 }
 285
 286
 287 /*******************************************************************************
 288  *
 289  * FUNCTION:    AcpiEvFixedEventDetect
 290  *
 291  * PARAMETERS:  None
 292  *
 293  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
 294  *
 295  * DESCRIPTION: Checks the PM status register for active fixed events
 296  *
 297  ******************************************************************************/
 298
 299 UINT32
 300 AcpiEvFixedEventDetect (
 301     void)
 302 {
 303     UINT32                  IntStatus = ACPI_INTERRUPT_NOT_HANDLED;
 304     UINT32                  FixedStatus;
 305     UINT32                  FixedEnable;
 306     ACPI_NATIVE_UINT        i;
 307
 308
 309     ACPI_FUNCTION_NAME ("EvFixedEventDetect");
 310
 311
 312     /*
 313      * Read the fixed feature status and enable registers, as all the cases
 314      * depend on their values.  Ignore errors here.
 315      */
 316     (void) AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_STATUS,
 317                 &FixedStatus);
 318     (void) AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_ENABLE,
 319                 &FixedEnable);
 320
 321     ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
 322         "Fixed Event Block: Enable %08X Status %08X\n",
 323         FixedEnable, FixedStatus));
 324
 325     /*
 326      * Check for all possible Fixed Events and dispatch those that are active
 327      */
 328     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
 329     {
 330         /* Both the status and enable bits must be on for this event */
 331
 332         if ((FixedStatus & AcpiGbl_FixedEventInfo[i].StatusBitMask) &&
 333             (FixedEnable & AcpiGbl_FixedEventInfo[i].EnableBitMask))
 334         {
 335             /* Found an active (signalled) event */
 336
 337             IntStatus |= AcpiEvFixedEventDispatch ((UINT32) i);
 338         }
 339     }
 340
 341     return (IntStatus);
 342 }
 343
 344
 345 /*******************************************************************************
 346  *
 347  * FUNCTION:    AcpiEvFixedEventDispatch
 348  *
 349  * PARAMETERS:  Event               - Event type
 350  *
 351  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
 352  *
 353  * DESCRIPTION: Clears the status bit for the requested event, calls the
 354  *              handler that previously registered for the event.
 355  *
 356  ******************************************************************************/
 357
 358 static UINT32
 359 AcpiEvFixedEventDispatch (
 360     UINT32                  Event)
 361 {
 362
 363
 364     ACPI_FUNCTION_ENTRY ();
 365
 366
 367     /* Clear the status bit */
 368
 369     (void) AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
 370                 1, ACPI_MTX_DO_NOT_LOCK);
 371
 372     /*
 373      * Make sure we've got a handler.  If not, report an error.
 374      * The event is disabled to prevent further interrupts.
 375      */
 376     if (NULL == AcpiGbl_FixedEventHandlers[Event].Handler)
 377     {
 378         (void) AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
 379                 0, ACPI_MTX_DO_NOT_LOCK);
 380
 381         ACPI_REPORT_ERROR (
 382             ("No installed handler for fixed event [%08X]\n",
 383             Event));
 384
 385         return (ACPI_INTERRUPT_NOT_HANDLED);
 386     }
 387
 388     /* Invoke the Fixed Event handler */
 389
 390     return ((AcpiGbl_FixedEventHandlers[Event].Handler)(
 391                                 AcpiGbl_FixedEventHandlers[Event].Context));
 392 }
 393
 394