sys/contrib/dev/acpica/evevent.c

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