reactos/drivers/bus/acpi/acpica/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 - 2015, 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 #define EXPORT_ACPI_INTERFACES
 117
 118 #include "acpi.h"
 119 #include "accommon.h"
 120 #include "actables.h"
 121
 122 #define _COMPONENT          ACPI_EVENTS
 123         ACPI_MODULE_NAME    ("evxfevnt")
 124
 125
 126 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
 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     /* If the Hardware Reduced flag is set, machine is always in acpi mode */
 157
 158     if (AcpiGbl_ReducedHardware)
 159     {
 160         return_ACPI_STATUS (AE_OK);
 161     }
 162
 163     /* Check current mode */
 164
 165     if (AcpiHwGetMode() == ACPI_SYS_MODE_ACPI)
 166     {
 167         ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "System is already in ACPI mode\n"));
 168     }
 169     else
 170     {
 171         /* Transition to ACPI mode */
 172
 173         Status = AcpiHwSetMode (ACPI_SYS_MODE_ACPI);
 174         if (ACPI_FAILURE (Status))
 175         {
 176             ACPI_ERROR ((AE_INFO, "Could not transition to ACPI mode"));
 177             return_ACPI_STATUS (Status);
 178         }
 179
 180         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
 181             "Transition to ACPI mode successful\n"));
 182     }
 183
 184     return_ACPI_STATUS (Status);
 185 }
 186
 187 ACPI_EXPORT_SYMBOL (AcpiEnable)
 188
 189
 190 /*******************************************************************************
 191  *
 192  * FUNCTION:    AcpiDisable
 193  *
 194  * PARAMETERS:  None
 195  *
 196  * RETURN:      Status
 197  *
 198  * DESCRIPTION: Transfers the system into LEGACY (non-ACPI) mode.
 199  *
 200  ******************************************************************************/
 201
 202 ACPI_STATUS
 203 AcpiDisable (
 204     void)
 205 {
 206     ACPI_STATUS             Status = AE_OK;
 207
 208
 209     ACPI_FUNCTION_TRACE (AcpiDisable);
 210
 211
 212     /* If the Hardware Reduced flag is set, machine is always in acpi mode */
 213
 214     if (AcpiGbl_ReducedHardware)
 215     {
 216         return_ACPI_STATUS (AE_OK);
 217     }
 218
 219     if (AcpiHwGetMode() == ACPI_SYS_MODE_LEGACY)
 220     {
 221         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
 222             "System is already in legacy (non-ACPI) mode\n"));
 223     }
 224     else
 225     {
 226         /* Transition to LEGACY mode */
 227
 228         Status = AcpiHwSetMode (ACPI_SYS_MODE_LEGACY);
 229
 230         if (ACPI_FAILURE (Status))
 231         {
 232             ACPI_ERROR ((AE_INFO,
 233                 "Could not exit ACPI mode to legacy mode"));
 234             return_ACPI_STATUS (Status);
 235         }
 236
 237         ACPI_DEBUG_PRINT ((ACPI_DB_INIT, "ACPI mode disabled\n"));
 238     }
 239
 240     return_ACPI_STATUS (Status);
 241 }
 242
 243 ACPI_EXPORT_SYMBOL (AcpiDisable)
 244
 245
 246 /*******************************************************************************
 247  *
 248  * FUNCTION:    AcpiEnableEvent
 249  *
 250  * PARAMETERS:  Event           - The fixed eventto be enabled
 251  *              Flags           - Reserved
 252  *
 253  * RETURN:      Status
 254  *
 255  * DESCRIPTION: Enable an ACPI event (fixed)
 256  *
 257  ******************************************************************************/
 258
 259 ACPI_STATUS
 260 AcpiEnableEvent (
 261     UINT32                  Event,
 262     UINT32                  Flags)
 263 {
 264     ACPI_STATUS             Status = AE_OK;
 265     UINT32                  Value;
 266
 267
 268     ACPI_FUNCTION_TRACE (AcpiEnableEvent);
 269
 270
 271     /* Decode the Fixed Event */
 272
 273     if (Event > ACPI_EVENT_MAX)
 274     {
 275         return_ACPI_STATUS (AE_BAD_PARAMETER);
 276     }
 277
 278     /*
 279      * Enable the requested fixed event (by writing a one to the enable
 280      * register bit)
 281      */
 282     Status = AcpiWriteBitRegister (
 283                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
 284                 ACPI_ENABLE_EVENT);
 285     if (ACPI_FAILURE (Status))
 286     {
 287         return_ACPI_STATUS (Status);
 288     }
 289
 290     /* Make sure that the hardware responded */
 291
 292     Status = AcpiReadBitRegister (
 293                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &Value);
 294     if (ACPI_FAILURE (Status))
 295     {
 296         return_ACPI_STATUS (Status);
 297     }
 298
 299     if (Value != 1)
 300     {
 301         ACPI_ERROR ((AE_INFO,
 302             "Could not enable %s event", AcpiUtGetEventName (Event)));
 303         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
 304     }
 305
 306     return_ACPI_STATUS (Status);
 307 }
 308
 309 ACPI_EXPORT_SYMBOL (AcpiEnableEvent)
 310
 311
 312 /*******************************************************************************
 313  *
 314  * FUNCTION:    AcpiDisableEvent
 315  *
 316  * PARAMETERS:  Event           - The fixed event to be disabled
 317  *              Flags           - Reserved
 318  *
 319  * RETURN:      Status
 320  *
 321  * DESCRIPTION: Disable an ACPI event (fixed)
 322  *
 323  ******************************************************************************/
 324
 325 ACPI_STATUS
 326 AcpiDisableEvent (
 327     UINT32                  Event,
 328     UINT32                  Flags)
 329 {
 330     ACPI_STATUS             Status = AE_OK;
 331     UINT32                  Value;
 332
 333
 334     ACPI_FUNCTION_TRACE (AcpiDisableEvent);
 335
 336
 337     /* Decode the Fixed Event */
 338
 339     if (Event > ACPI_EVENT_MAX)
 340     {
 341         return_ACPI_STATUS (AE_BAD_PARAMETER);
 342     }
 343
 344     /*
 345      * Disable the requested fixed event (by writing a zero to the enable
 346      * register bit)
 347      */
 348     Status = AcpiWriteBitRegister (
 349                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
 350                 ACPI_DISABLE_EVENT);
 351     if (ACPI_FAILURE (Status))
 352     {
 353         return_ACPI_STATUS (Status);
 354     }
 355
 356     Status = AcpiReadBitRegister (
 357                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &Value);
 358     if (ACPI_FAILURE (Status))
 359     {
 360         return_ACPI_STATUS (Status);
 361     }
 362
 363     if (Value != 0)
 364     {
 365         ACPI_ERROR ((AE_INFO,
 366             "Could not disable %s events", AcpiUtGetEventName (Event)));
 367         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
 368     }
 369
 370     return_ACPI_STATUS (Status);
 371 }
 372
 373 ACPI_EXPORT_SYMBOL (AcpiDisableEvent)
 374
 375
 376 /*******************************************************************************
 377  *
 378  * FUNCTION:    AcpiClearEvent
 379  *
 380  * PARAMETERS:  Event           - The fixed event to be cleared
 381  *
 382  * RETURN:      Status
 383  *
 384  * DESCRIPTION: Clear an ACPI event (fixed)
 385  *
 386  ******************************************************************************/
 387
 388 ACPI_STATUS
 389 AcpiClearEvent (
 390     UINT32                  Event)
 391 {
 392     ACPI_STATUS             Status = AE_OK;
 393
 394
 395     ACPI_FUNCTION_TRACE (AcpiClearEvent);
 396
 397
 398     /* Decode the Fixed Event */
 399
 400     if (Event > ACPI_EVENT_MAX)
 401     {
 402         return_ACPI_STATUS (AE_BAD_PARAMETER);
 403     }
 404
 405     /*
 406      * Clear the requested fixed event (By writing a one to the status
 407      * register bit)
 408      */
 409     Status = AcpiWriteBitRegister (
 410                 AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
 411                 ACPI_CLEAR_STATUS);
 412
 413     return_ACPI_STATUS (Status);
 414 }
 415
 416 ACPI_EXPORT_SYMBOL (AcpiClearEvent)
 417
 418
 419 /*******************************************************************************
 420  *
 421  * FUNCTION:    AcpiGetEventStatus
 422  *
 423  * PARAMETERS:  Event           - The fixed event
 424  *              EventStatus     - Where the current status of the event will
 425  *                                be returned
 426  *
 427  * RETURN:      Status
 428  *
 429  * DESCRIPTION: Obtains and returns the current status of the event
 430  *
 431  ******************************************************************************/
 432
 433 ACPI_STATUS
 434 AcpiGetEventStatus (
 435     UINT32                  Event,
 436     ACPI_EVENT_STATUS       *EventStatus)
 437 {
 438     ACPI_STATUS             Status;
 439     ACPI_EVENT_STATUS       LocalEventStatus = 0;
 440     UINT32                  InByte;
 441
 442
 443     ACPI_FUNCTION_TRACE (AcpiGetEventStatus);
 444
 445
 446     if (!EventStatus)
 447     {
 448         return_ACPI_STATUS (AE_BAD_PARAMETER);
 449     }
 450
 451     /* Decode the Fixed Event */
 452
 453     if (Event > ACPI_EVENT_MAX)
 454     {
 455         return_ACPI_STATUS (AE_BAD_PARAMETER);
 456     }
 457
 458     /* Fixed event currently can be dispatched? */
 459
 460     if (AcpiGbl_FixedEventHandlers[Event].Handler)
 461     {
 462         LocalEventStatus |= ACPI_EVENT_FLAG_HAS_HANDLER;
 463     }
 464
 465     /* Fixed event currently enabled? */
 466
 467     Status = AcpiReadBitRegister (
 468                 AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &InByte);
 469     if (ACPI_FAILURE (Status))
 470     {
 471         return_ACPI_STATUS (Status);
 472     }
 473
 474     if (InByte)
 475     {
 476         LocalEventStatus |=
 477             (ACPI_EVENT_FLAG_ENABLED | ACPI_EVENT_FLAG_ENABLE_SET);
 478     }
 479
 480     /* Fixed event currently active? */
 481
 482     Status = AcpiReadBitRegister (
 483                 AcpiGbl_FixedEventInfo[Event].StatusRegisterId, &InByte);
 484     if (ACPI_FAILURE (Status))
 485     {
 486         return_ACPI_STATUS (Status);
 487     }
 488
 489     if (InByte)
 490     {
 491         LocalEventStatus |= ACPI_EVENT_FLAG_STATUS_SET;
 492     }
 493
 494     (*EventStatus) = LocalEventStatus;
 495     return_ACPI_STATUS (AE_OK);
 496 }
 497
 498 ACPI_EXPORT_SYMBOL (AcpiGetEventStatus)
 499
 500 #endif /* !ACPI_REDUCED_HARDWARE */