sys/contrib/dev/acpica/evevent.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evevent - Fixed Event handling and dispatch
   4  *              $Revision: 1.125 $
   5  *
   6  *****************************************************************************/
   7
   8 /******************************************************************************
   9  *
  10  * 1. Copyright Notice
  11  *
  12  * Some or all of this work - Copyright (c) 1999 - 2007, 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     /*
 157      * Initialize the Fixed and General Purpose Events. This is done prior to
 158      * enabling SCIs to prevent interrupts from occurring before the handlers are
 159      * installed.
 160      */
 161     Status = AcpiEvFixedEventInitialize ();
 162     if (ACPI_FAILURE (Status))
 163     {
 164         ACPI_EXCEPTION ((AE_INFO, Status,
 165             "Unable to initialize fixed events"));
 166         return_ACPI_STATUS (Status);
 167     }
 168
 169     Status = AcpiEvGpeInitialize ();
 170     if (ACPI_FAILURE (Status))
 171     {
 172         ACPI_EXCEPTION ((AE_INFO, Status,
 173             "Unable to initialize general purpose events"));
 174         return_ACPI_STATUS (Status);
 175     }
 176
 177     return_ACPI_STATUS (Status);
 178 }
 179
 180
 181 /*******************************************************************************
 182  *
 183  * FUNCTION:    AcpiEvInstallFadtGpes
 184  *
 185  * PARAMETERS:  None
 186  *
 187  * RETURN:      Status
 188  *
 189  * DESCRIPTION: Completes initialization of the FADT-defined GPE blocks
 190  *              (0 and 1). This causes the _PRW methods to be run, so the HW
 191  *              must be fully initialized at this point, including global lock
 192  *              support.
 193  *
 194  ******************************************************************************/
 195
 196 ACPI_STATUS
 197 AcpiEvInstallFadtGpes (
 198     void)
 199 {
 200     ACPI_STATUS             Status;
 201
 202
 203     ACPI_FUNCTION_TRACE (EvInstallFadtGpes);
 204
 205
 206     /* Namespace must be locked */
 207
 208     Status = AcpiUtAcquireMutex (ACPI_MTX_NAMESPACE);
 209     if (ACPI_FAILURE (Status))
 210     {
 211         return (Status);
 212     }
 213
 214     /* FADT GPE Block 0 */
 215
 216     (void) AcpiEvInitializeGpeBlock (
 217                 AcpiGbl_FadtGpeDevice, AcpiGbl_GpeFadtBlocks[0]);
 218
 219     /* FADT GPE Block 1 */
 220
 221     (void) AcpiEvInitializeGpeBlock (
 222                 AcpiGbl_FadtGpeDevice, AcpiGbl_GpeFadtBlocks[1]);
 223
 224     (void) AcpiUtReleaseMutex (ACPI_MTX_NAMESPACE);
 225     return_ACPI_STATUS (AE_OK);
 226 }
 227
 228
 229 /*******************************************************************************
 230  *
 231  * FUNCTION:    AcpiEvInstallXruptHandlers
 232  *
 233  * PARAMETERS:  None
 234  *
 235  * RETURN:      Status
 236  *
 237  * DESCRIPTION: Install interrupt handlers for the SCI and Global Lock
 238  *
 239  ******************************************************************************/
 240
 241 ACPI_STATUS
 242 AcpiEvInstallXruptHandlers (
 243     void)
 244 {
 245     ACPI_STATUS             Status;
 246
 247
 248     ACPI_FUNCTION_TRACE (EvInstallXruptHandlers);
 249
 250
 251     /* Install the SCI handler */
 252
 253     Status = AcpiEvInstallSciHandler ();
 254     if (ACPI_FAILURE (Status))
 255     {
 256         ACPI_EXCEPTION ((AE_INFO, Status,
 257             "Unable to install System Control Interrupt handler"));
 258         return_ACPI_STATUS (Status);
 259     }
 260
 261     /* Install the handler for the Global Lock */
 262
 263     Status = AcpiEvInitGlobalLockHandler ();
 264     if (ACPI_FAILURE (Status))
 265     {
 266         ACPI_EXCEPTION ((AE_INFO, Status,
 267             "Unable to initialize Global Lock handler"));
 268         return_ACPI_STATUS (Status);
 269     }
 270
 271     AcpiGbl_EventsInitialized = TRUE;
 272     return_ACPI_STATUS (Status);
 273 }
 274
 275
 276 /*******************************************************************************
 277  *
 278  * FUNCTION:    AcpiEvFixedEventInitialize
 279  *
 280  * PARAMETERS:  None
 281  *
 282  * RETURN:      Status
 283  *
 284  * DESCRIPTION: Install the fixed event handlers and enable the fixed events.
 285  *
 286  ******************************************************************************/
 287
 288 static ACPI_STATUS
 289 AcpiEvFixedEventInitialize (
 290     void)
 291 {
 292     ACPI_NATIVE_UINT        i;
 293     ACPI_STATUS             Status;
 294
 295
 296     /*
 297      * Initialize the structure that keeps track of fixed event handlers
 298      * and enable the fixed events.
 299      */
 300     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
 301     {
 302         AcpiGbl_FixedEventHandlers[i].Handler = NULL;
 303         AcpiGbl_FixedEventHandlers[i].Context = NULL;
 304
 305         /* Enable the fixed event */
 306
 307         if (AcpiGbl_FixedEventInfo[i].EnableRegisterId != 0xFF)
 308         {
 309             Status = AcpiSetRegister (
 310                         AcpiGbl_FixedEventInfo[i].EnableRegisterId, 0);
 311             if (ACPI_FAILURE (Status))
 312             {
 313                 return (Status);
 314             }
 315         }
 316     }
 317
 318     return (AE_OK);
 319 }
 320
 321
 322 /*******************************************************************************
 323  *
 324  * FUNCTION:    AcpiEvFixedEventDetect
 325  *
 326  * PARAMETERS:  None
 327  *
 328  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
 329  *
 330  * DESCRIPTION: Checks the PM status register for active fixed events
 331  *
 332  ******************************************************************************/
 333
 334 UINT32
 335 AcpiEvFixedEventDetect (
 336     void)
 337 {
 338     UINT32                  IntStatus = ACPI_INTERRUPT_NOT_HANDLED;
 339     UINT32                  FixedStatus;
 340     UINT32                  FixedEnable;
 341     ACPI_NATIVE_UINT        i;
 342
 343
 344     ACPI_FUNCTION_NAME (EvFixedEventDetect);
 345
 346
 347     /*
 348      * Read the fixed feature status and enable registers, as all the cases
 349      * depend on their values.  Ignore errors here.
 350      */
 351     (void) AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_STATUS,
 352                 &FixedStatus);
 353     (void) AcpiHwRegisterRead (ACPI_MTX_DO_NOT_LOCK, ACPI_REGISTER_PM1_ENABLE,
 354                 &FixedEnable);
 355
 356     ACPI_DEBUG_PRINT ((ACPI_DB_INTERRUPTS,
 357         "Fixed Event Block: Enable %08X Status %08X\n",
 358         FixedEnable, FixedStatus));
 359
 360     /*
 361      * Check for all possible Fixed Events and dispatch those that are active
 362      */
 363     for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
 364     {
 365         /* Both the status and enable bits must be on for this event */
 366
 367         if ((FixedStatus & AcpiGbl_FixedEventInfo[i].StatusBitMask) &&
 368             (FixedEnable & AcpiGbl_FixedEventInfo[i].EnableBitMask))
 369         {
 370             /* Found an active (signalled) event */
 371
 372             IntStatus |= AcpiEvFixedEventDispatch ((UINT32) i);
 373         }
 374     }
 375
 376     return (IntStatus);
 377 }
 378
 379
 380 /*******************************************************************************
 381  *
 382  * FUNCTION:    AcpiEvFixedEventDispatch
 383  *
 384  * PARAMETERS:  Event               - Event type
 385  *
 386  * RETURN:      INTERRUPT_HANDLED or INTERRUPT_NOT_HANDLED
 387  *
 388  * DESCRIPTION: Clears the status bit for the requested event, calls the
 389  *              handler that previously registered for the event.
 390  *
 391  ******************************************************************************/
 392
 393 static UINT32
 394 AcpiEvFixedEventDispatch (
 395     UINT32                  Event)
 396 {
 397
 398
 399     ACPI_FUNCTION_ENTRY ();
 400
 401
 402     /* Clear the status bit */
 403
 404     (void) AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].StatusRegisterId, 1);
 405
 406     /*
 407      * Make sure we've got a handler.  If not, report an error.
 408      * The event is disabled to prevent further interrupts.
 409      */
 410     if (NULL == AcpiGbl_FixedEventHandlers[Event].Handler)
 411     {
 412         (void) AcpiSetRegister (AcpiGbl_FixedEventInfo[Event].EnableRegisterId, 0);
 413
 414         ACPI_ERROR ((AE_INFO,
 415             "No installed handler for fixed event [%08X]",
 416             Event));
 417
 418         return (ACPI_INTERRUPT_NOT_HANDLED);
 419     }
 420
 421     /* Invoke the Fixed Event handler */
 422
 423     return ((AcpiGbl_FixedEventHandlers[Event].Handler)(
 424                                 AcpiGbl_FixedEventHandlers[Event].Context));
 425 }
 426
 427