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