sys/contrib/dev/acpica-unix/events/evxfevnt.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evxfevnt - External Interfaces, ACPI event disable/enable
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2011, Intel Corp.
  12  * All rights reserved.
  13  *
  14  * 2. License
  15  *
  16  * 2.1. This is your license from Intel Corp. under its intellectual property
  17  * rights.  You may have additional license terms from the party that provided
  18  * you this software, covering your right to use that party's intellectual
  19  * property rights.
  20  *
  21  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
  22  * copy of the source code appearing in this file ("Covered Code") an
  23  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
  24  * base code distributed originally by Intel ("Original Intel Code") to copy,
  25  * make derivatives, distribute, use and display any portion of the Covered
  26  * Code in any form, with the right to sublicense such rights; and
  27  *
  28  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
  29  * license (with the right to sublicense), under only those claims of Intel
  30  * patents that are infringed by the Original Intel Code, to make, use, sell,
  31  * offer to sell, and import the Covered Code and derivative works thereof
  32  * solely to the minimum extent necessary to exercise the above copyright
  33  * license, and in no event shall the patent license extend to any additions
  34  * to or modifications of the Original Intel Code.  No other license or right
  35  * is granted directly or by implication, estoppel or otherwise;
  36  *
  37  * The above copyright and patent license is granted only if the following
  38  * conditions are met:
  39  *
  40  * 3. Conditions
  41  *
  42  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
  43  * Redistribution of source code of any substantial portion of the Covered
  44  * Code or modification with rights to further distribute source must include
  45  * the above Copyright Notice, the above License, this list of Conditions,
  46  * and the following Disclaimer and Export Compliance provision.  In addition,
  47  * Licensee must cause all Covered Code to which Licensee contributes to
  48  * contain a file documenting the changes Licensee made to create that Covered
  49  * Code and the date of any change.  Licensee must include in that file the
  50  * documentation of any changes made by any predecessor Licensee.  Licensee
  51  * must include a prominent statement that the modification is derived,
  52  * directly or indirectly, from Original Intel Code.
  53  *
  54  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
  55  * Redistribution of source code of any substantial portion of the Covered
  56  * Code or modification without rights to further distribute source must
  57  * include the following Disclaimer and Export Compliance provision in the
  58  * documentation and/or other materials provided with distribution.  In
  59  * addition, Licensee may not authorize further sublicense of source of any
  60  * portion of the Covered Code, and must include terms to the effect that the
  61  * license from Licensee to its licensee is limited to the intellectual
  62  * property embodied in the software Licensee provides to its licensee, and
  63  * not to intellectual property embodied in modifications its licensee may
  64  * make.
  65  *
  66  * 3.3. Redistribution of Executable. Redistribution in executable form of any
  67  * substantial portion of the Covered Code or modification must reproduce the
  68  * above Copyright Notice, and the following Disclaimer and Export Compliance
  69  * provision in the documentation and/or other materials provided with the
  70  * distribution.
  71  *
  72  * 3.4. Intel retains all right, title, and interest in and to the Original
  73  * Intel Code.
  74  *
  75  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
  76  * Intel shall be used in advertising or otherwise to promote the sale, use or
  77  * other dealings in products derived from or relating to the Covered Code
  78  * without prior written authorization from Intel.
  79  *
  80  * 4. Disclaimer and Export Compliance
  81  *
  82  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
  83  * HERE.  ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
  84  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT,  ASSISTANCE,
  85  * INSTALLATION, TRAINING OR OTHER SERVICES.  INTEL WILL NOT PROVIDE ANY
  86  * UPDATES, ENHANCEMENTS OR EXTENSIONS.  INTEL SPECIFICALLY DISCLAIMS ANY
  87  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
  88  * PARTICULAR PURPOSE.
  89  *
  90  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
  91  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
  92  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
  93  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
  94  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
  95  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES.  THESE LIMITATIONS
  96  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
  97  * LIMITED REMEDY.
  98  *
  99  * 4.3. Licensee shall not export, either directly or indirectly, any of this
 100  * software or system incorporating such software without first obtaining any
 101  * required license or other approval from the U. S. Department of Commerce or
 102  * any other agency or department of the United States Government.  In the
 103  * event Licensee exports any such software from the United States or
 104  * re-exports any such software from a foreign destination, Licensee shall
 105  * ensure that the distribution and export/re-export of the software is in
 106  * compliance with all laws, regulations, orders, or other restrictions of the
 107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
 108  * any of its subsidiaries will export/re-export any technical data, process,
 109  * software, or service, directly or indirectly, to any country for which the
 110  * United States government or any agency thereof requires an export license,
 111  * other governmental approval, or letter of assurance, without first obtaining
 112  * such license, approval or letter.
 113  *
 114  *****************************************************************************/
 115
 116
 117 #define __EVXFEVNT_C__
 118
 119 #include "acpi.h"
 120 #include "accommon.h"
 121 #include "actables.h"
 122
 123 #define _COMPONENT          ACPI_EVENTS
 124         ACPI_MODULE_NAME    ("evxfevnt")
 125
 126
 127 /*******************************************************************************
 128  *
 129  * FUNCTION:    AcpiEnable
 130  *
 131  * PARAMETERS:  None
 132  *
 133  * RETURN:      Status
 134  *
 135  * DESCRIPTION: Transfers the system into ACPI mode.
 136  *
 137  ******************************************************************************/
 138
 139 ACPI_STATUS
 140 AcpiEnable (
 141     void)
 142 {
 143     ACPI_STATUS             Status = AE_OK;
 144
 145
 146     ACPI_FUNCTION_TRACE (AcpiEnable);
 147
 148
 149     /* ACPI tables must be present */
 150
 151     if (!AcpiTbTablesLoaded ())
 152     {
 153         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
 154     }
 155
 156     /* Check current mode */
 157
 158     if (AcpiHwGetMode() == ACPI_SYS_MODE_ACPI)
 159     {
 160         ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "System is already in ACPI mode\n"));
 161     }
 162     else
 163     {
 164         /* Transition to ACPI mode */
 165
 166         Status = AcpiHwSetMode (ACPI_SYS_MODE_ACPI);
 167         if (ACPI_FAILURE (Status))
 168         {
 169             ACPI_ERROR ((AE_INFO, "Could not transition to ACPI mode"));
 170             return_ACPI_STATUS (Status);
 171         }
 172
 173         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
 174             "Transition to ACPI mode successful\n"));
 175     }
 176
 177     return_ACPI_STATUS (Status);
 178 }
 179
 180 ACPI_EXPORT_SYMBOL (AcpiEnable)
 181
 182
 183 /*******************************************************************************
 184  *
 185  * FUNCTION:    AcpiDisable
 186  *
 187  * PARAMETERS:  None
 188  *
 189  * RETURN:      Status
 190  *
 191  * DESCRIPTION: Transfers the system into LEGACY (non-ACPI) mode.
 192  *
 193  ******************************************************************************/
 194
 195 ACPI_STATUS
 196 AcpiDisable (
 197     void)
 198 {
 199     ACPI_STATUS             Status = AE_OK;
 200
 201
 202     ACPI_FUNCTION_TRACE (AcpiDisable);
 203
 204
 205     if (AcpiHwGetMode() == ACPI_SYS_MODE_LEGACY)
 206     {
 207         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
 208             "System is already in legacy (non-ACPI) mode\n"));
 209     }
 210     else
 211     {
 212         /* Transition to LEGACY mode */
 213
 214         Status = AcpiHwSetMode (ACPI_SYS_MODE_LEGACY);
 215
 216         if (ACPI_FAILURE (Status))
 217         {
 218             ACPI_ERROR ((AE_INFO,
 219                 "Could not exit ACPI mode to legacy mode"));
 220             return_ACPI_STATUS (Status);
 221         }
 222
 223         ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "ACPI mode disabled\n"));
 224     }
 225
 226     return_ACPI_STATUS (Status);
 227 }
 228
 229 ACPI_EXPORT_SYMBOL (AcpiDisable)
 230
 231
 232 /*******************************************************************************
 233  *
 234  * FUNCTION:    AcpiEnableEvent
 235  *
 236  * PARAMETERS:  Event           - The fixed eventto be enabled
 237  *              Flags           - Reserved
 238  *
 239  * RETURN:      Status
 240  *
 241  * DESCRIPTION: Enable an ACPI event (fixed)
 242  *
 243  ******************************************************************************/
 244
 245 ACPI_STATUS
 246 AcpiEnableEvent (
 247     UINT32                  Event,
 248     UINT32                  Flags)
 249 {
 250     ACPI_STATUS             Status = AE_OK;
 251     UINT32                  Value;
 252
 253
 254     ACPI_FUNCTION_TRACE (AcpiEnableEvent);
 255
 256
 257     /* Decode the Fixed Event */
 258
 259     if (Event > ACPI_EVENT_MAX)
 260     {
 261         return_ACPI_STATUS (AE_BAD_PARAMETER);
 262     }
 263
 264     /*
 265      * Enable the requested fixed event (by writing a one to the enable
 266      * register bit)
 267      */
 268     Status = AcpiWriteBitRegister (
 269                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
 270                 ACPI_ENABLE_EVENT);
 271     if (ACPI_FAILURE (Status))
 272     {
 273         return_ACPI_STATUS (Status);
 274     }
 275
 276     /* Make sure that the hardware responded */
 277
 278     Status = AcpiReadBitRegister (
 279                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &Value);
 280     if (ACPI_FAILURE (Status))
 281     {
 282         return_ACPI_STATUS (Status);
 283     }
 284
 285     if (Value != 1)
 286     {
 287         ACPI_ERROR ((AE_INFO,
 288             "Could not enable %s event", AcpiUtGetEventName (Event)));
 289         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
 290     }
 291
 292     return_ACPI_STATUS (Status);
 293 }
 294
 295 ACPI_EXPORT_SYMBOL (AcpiEnableEvent)
 296
 297
 298 /*******************************************************************************
 299  *
 300  * FUNCTION:    AcpiDisableEvent
 301  *
 302  * PARAMETERS:  Event           - The fixed event to be disabled
 303  *              Flags           - Reserved
 304  *
 305  * RETURN:      Status
 306  *
 307  * DESCRIPTION: Disable an ACPI event (fixed)
 308  *
 309  ******************************************************************************/
 310
 311 ACPI_STATUS
 312 AcpiDisableEvent (
 313     UINT32                  Event,
 314     UINT32                  Flags)
 315 {
 316     ACPI_STATUS             Status = AE_OK;
 317     UINT32                  Value;
 318
 319
 320     ACPI_FUNCTION_TRACE (AcpiDisableEvent);
 321
 322
 323     /* Decode the Fixed Event */
 324
 325     if (Event > ACPI_EVENT_MAX)
 326     {
 327         return_ACPI_STATUS (AE_BAD_PARAMETER);
 328     }
 329
 330     /*
 331      * Disable the requested fixed event (by writing a zero to the enable
 332      * register bit)
 333      */
 334     Status = AcpiWriteBitRegister (
 335                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
 336                 ACPI_DISABLE_EVENT);
 337     if (ACPI_FAILURE (Status))
 338     {
 339         return_ACPI_STATUS (Status);
 340     }
 341
 342     Status = AcpiReadBitRegister (
 343                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &Value);
 344     if (ACPI_FAILURE (Status))
 345     {
 346         return_ACPI_STATUS (Status);
 347     }
 348
 349     if (Value != 0)
 350     {
 351         ACPI_ERROR ((AE_INFO,
 352             "Could not disable %s events", AcpiUtGetEventName (Event)));
 353         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
 354     }
 355
 356     return_ACPI_STATUS (Status);
 357 }
 358
 359 ACPI_EXPORT_SYMBOL (AcpiDisableEvent)
 360
 361
 362 /*******************************************************************************
 363  *
 364  * FUNCTION:    AcpiClearEvent
 365  *
 366  * PARAMETERS:  Event           - The fixed event to be cleared
 367  *
 368  * RETURN:      Status
 369  *
 370  * DESCRIPTION: Clear an ACPI event (fixed)
 371  *
 372  ******************************************************************************/
 373
 374 ACPI_STATUS
 375 AcpiClearEvent (
 376     UINT32                  Event)
 377 {
 378     ACPI_STATUS             Status = AE_OK;
 379
 380
 381     ACPI_FUNCTION_TRACE (AcpiClearEvent);
 382
 383
 384     /* Decode the Fixed Event */
 385
 386     if (Event > ACPI_EVENT_MAX)
 387     {
 388         return_ACPI_STATUS (AE_BAD_PARAMETER);
 389     }
 390
 391     /*
 392      * Clear the requested fixed event (By writing a one to the status
 393      * register bit)
 394      */
 395     Status = AcpiWriteBitRegister (
 396                 AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
 397                 ACPI_CLEAR_STATUS);
 398
 399     return_ACPI_STATUS (Status);
 400 }
 401
 402 ACPI_EXPORT_SYMBOL (AcpiClearEvent)
 403
 404
 405 /*******************************************************************************
 406  *
 407  * FUNCTION:    AcpiGetEventStatus
 408  *
 409  * PARAMETERS:  Event           - The fixed event
 410  *              EventStatus     - Where the current status of the event will
 411  *                                be returned
 412  *
 413  * RETURN:      Status
 414  *
 415  * DESCRIPTION: Obtains and returns the current status of the event
 416  *
 417  ******************************************************************************/
 418
 419 ACPI_STATUS
 420 AcpiGetEventStatus (
 421     UINT32                  Event,
 422     ACPI_EVENT_STATUS       *EventStatus)
 423 {
 424     ACPI_STATUS             Status = AE_OK;
 425
 426
 427     ACPI_FUNCTION_TRACE (AcpiGetEventStatus);
 428
 429
 430     if (!EventStatus)
 431     {
 432         return_ACPI_STATUS (AE_BAD_PARAMETER);
 433     }
 434
 435     /* Decode the Fixed Event */
 436
 437     if (Event > ACPI_EVENT_MAX)
 438     {
 439         return_ACPI_STATUS (AE_BAD_PARAMETER);
 440     }
 441
 442     /* Get the status of the requested fixed event */
 443
 444     Status = AcpiReadBitRegister (
 445                 AcpiGbl_FixedEventInfo[Event].StatusRegisterId, EventStatus);
 446
 447     return_ACPI_STATUS (Status);
 448 }
 449
 450 ACPI_EXPORT_SYMBOL (AcpiGetEventStatus)
 451
 452