sys/contrib/dev/acpica-unix-20050309/events/evevent.c

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