acpica/events/evxfevnt.c

0001 /******************************************************************************
0002  *
0003  * Module Name: evxfevnt - External Interfaces, ACPI event disable/enable
0004  *
0005  *****************************************************************************/
0006
0007 /******************************************************************************
0008  *
0009  * 1. Copyright Notice
0010  *
0011  * Some or all of this work - Copyright (c) 1999 - 2024, Intel Corp.
0012  * All rights reserved.
0013  *
0014  * 2. License
0015  *
0016  * 2.1. This is your license from Intel Corp. under its intellectual property
0017  * rights. You may have additional license terms from the party that provided
0018  * you this software, covering your right to use that party's intellectual
0019  * property rights.
0020  *
0021  * 2.2. Intel grants, free of charge, to any person ("Licensee") obtaining a
0022  * copy of the source code appearing in this file ("Covered Code") an
0023  * irrevocable, perpetual, worldwide license under Intel's copyrights in the
0024  * base code distributed originally by Intel ("Original Intel Code") to copy,
0025  * make derivatives, distribute, use and display any portion of the Covered
0026  * Code in any form, with the right to sublicense such rights; and
0027  *
0028  * 2.3. Intel grants Licensee a non-exclusive and non-transferable patent
0029  * license (with the right to sublicense), under only those claims of Intel
0030  * patents that are infringed by the Original Intel Code, to make, use, sell,
0031  * offer to sell, and import the Covered Code and derivative works thereof
0032  * solely to the minimum extent necessary to exercise the above copyright
0033  * license, and in no event shall the patent license extend to any additions
0034  * to or modifications of the Original Intel Code. No other license or right
0035  * is granted directly or by implication, estoppel or otherwise;
0036  *
0037  * The above copyright and patent license is granted only if the following
0038  * conditions are met:
0039  *
0040  * 3. Conditions
0041  *
0042  * 3.1. Redistribution of Source with Rights to Further Distribute Source.
0043  * Redistribution of source code of any substantial portion of the Covered
0044  * Code or modification with rights to further distribute source must include
0045  * the above Copyright Notice, the above License, this list of Conditions,
0046  * and the following Disclaimer and Export Compliance provision. In addition,
0047  * Licensee must cause all Covered Code to which Licensee contributes to
0048  * contain a file documenting the changes Licensee made to create that Covered
0049  * Code and the date of any change. Licensee must include in that file the
0050  * documentation of any changes made by any predecessor Licensee. Licensee
0051  * must include a prominent statement that the modification is derived,
0052  * directly or indirectly, from Original Intel Code.
0053  *
0054  * 3.2. Redistribution of Source with no Rights to Further Distribute Source.
0055  * Redistribution of source code of any substantial portion of the Covered
0056  * Code or modification without rights to further distribute source must
0057  * include the following Disclaimer and Export Compliance provision in the
0058  * documentation and/or other materials provided with distribution. In
0059  * addition, Licensee may not authorize further sublicense of source of any
0060  * portion of the Covered Code, and must include terms to the effect that the
0061  * license from Licensee to its licensee is limited to the intellectual
0062  * property embodied in the software Licensee provides to its licensee, and
0063  * not to intellectual property embodied in modifications its licensee may
0064  * make.
0065  *
0066  * 3.3. Redistribution of Executable. Redistribution in executable form of any
0067  * substantial portion of the Covered Code or modification must reproduce the
0068  * above Copyright Notice, and the following Disclaimer and Export Compliance
0069  * provision in the documentation and/or other materials provided with the
0070  * distribution.
0071  *
0072  * 3.4. Intel retains all right, title, and interest in and to the Original
0073  * Intel Code.
0074  *
0075  * 3.5. Neither the name Intel nor any other trademark owned or controlled by
0076  * Intel shall be used in advertising or otherwise to promote the sale, use or
0077  * other dealings in products derived from or relating to the Covered Code
0078  * without prior written authorization from Intel.
0079  *
0080  * 4. Disclaimer and Export Compliance
0081  *
0082  * 4.1. INTEL MAKES NO WARRANTY OF ANY KIND REGARDING ANY SOFTWARE PROVIDED
0083  * HERE. ANY SOFTWARE ORIGINATING FROM INTEL OR DERIVED FROM INTEL SOFTWARE
0084  * IS PROVIDED "AS IS," AND INTEL WILL NOT PROVIDE ANY SUPPORT, ASSISTANCE,
0085  * INSTALLATION, TRAINING OR OTHER SERVICES. INTEL WILL NOT PROVIDE ANY
0086  * UPDATES, ENHANCEMENTS OR EXTENSIONS. INTEL SPECIFICALLY DISCLAIMS ANY
0087  * IMPLIED WARRANTIES OF MERCHANTABILITY, NONINFRINGEMENT AND FITNESS FOR A
0088  * PARTICULAR PURPOSE.
0089  *
0090  * 4.2. IN NO EVENT SHALL INTEL HAVE ANY LIABILITY TO LICENSEE, ITS LICENSEES
0091  * OR ANY OTHER THIRD PARTY, FOR ANY LOST PROFITS, LOST DATA, LOSS OF USE OR
0092  * COSTS OF PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES, OR FOR ANY INDIRECT,
0093  * SPECIAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THIS AGREEMENT, UNDER ANY
0094  * CAUSE OF ACTION OR THEORY OF LIABILITY, AND IRRESPECTIVE OF WHETHER INTEL
0095  * HAS ADVANCE NOTICE OF THE POSSIBILITY OF SUCH DAMAGES. THESE LIMITATIONS
0096  * SHALL APPLY NOTWITHSTANDING THE FAILURE OF THE ESSENTIAL PURPOSE OF ANY
0097  * LIMITED REMEDY.
0098  *
0099  * 4.3. Licensee shall not export, either directly or indirectly, any of this
0100  * software or system incorporating such software without first obtaining any
0101  * required license or other approval from the U. S. Department of Commerce or
0102  * any other agency or department of the United States Government. In the
0103  * event Licensee exports any such software from the United States or
0104  * re-exports any such software from a foreign destination, Licensee shall
0105  * ensure that the distribution and export/re-export of the software is in
0106  * compliance with all laws, regulations, orders, or other restrictions of the
0107  * U.S. Export Administration Regulations. Licensee agrees that neither it nor
0108  * any of its subsidiaries will export/re-export any technical data, process,
0109  * software, or service, directly or indirectly, to any country for which the
0110  * United States government or any agency thereof requires an export license,
0111  * other governmental approval, or letter of assurance, without first obtaining
0112  * such license, approval or letter.
0113  *
0114  *****************************************************************************
0115  *
0116  * Alternatively, you may choose to be licensed under the terms of the
0117  * following license:
0118  *
0119  * Redistribution and use in source and binary forms, with or without
0120  * modification, are permitted provided that the following conditions
0121  * are met:
0122  * 1. Redistributions of source code must retain the above copyright
0123  *    notice, this list of conditions, and the following disclaimer,
0124  *    without modification.
0125  * 2. Redistributions in binary form must reproduce at minimum a disclaimer
0126  *    substantially similar to the "NO WARRANTY" disclaimer below
0127  *    ("Disclaimer") and any redistribution must be conditioned upon
0128  *    including a substantially similar Disclaimer requirement for further
0129  *    binary redistribution.
0130  * 3. Neither the names of the above-listed copyright holders nor the names
0131  *    of any contributors may be used to endorse or promote products derived
0132  *    from this software without specific prior written permission.
0133  *
0134  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
0135  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
0136  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
0137  * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
0138  * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
0139  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
0140  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
0141  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
0142  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
0143  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
0144  * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
0145  *
0146  * Alternatively, you may choose to be licensed under the terms of the
0147  * GNU General Public License ("GPL") version 2 as published by the Free
0148  * Software Foundation.
0149  *
0150  *****************************************************************************/
0151
0152 #define EXPORT_ACPI_INTERFACES
0153
0154 #include "acpi.h"
0155 #include "accommon.h"
0156 #include "actables.h"
0157
0158 #define _COMPONENT          ACPI_EVENTS
0159         ACPI_MODULE_NAME    ("evxfevnt")
0160
0161
0162 #if (!ACPI_REDUCED_HARDWARE) /* Entire module */
0163 /*******************************************************************************
0164  *
0165  * FUNCTION:    AcpiEnable
0166  *
0167  * PARAMETERS:  None
0168  *
0169  * RETURN:      Status
0170  *
0171  * DESCRIPTION: Transfers the system into ACPI mode.
0172  *
0173  ******************************************************************************/
0174
0175 ACPI_STATUS
0176 AcpiEnable (
0177     void)
0178 {
0179     ACPI_STATUS             Status = AE_OK;
0180
0181
0182     ACPI_FUNCTION_TRACE (AcpiEnable);
0183
0184
0185     /* ACPI tables must be present */
0186
0187     if (AcpiGbl_FadtIndex == ACPI_INVALID_TABLE_INDEX)
0188     {
0189         return_ACPI_STATUS (AE_NO_ACPI_TABLES);
0190     }
0191
0192     /* If the Hardware Reduced flag is set, machine is always in acpi mode */
0193
0194     if (AcpiGbl_ReducedHardware)
0195     {
0196         return_ACPI_STATUS (AE_OK);
0197     }
0198
0199     /* Check current mode */
0200
0201     if (AcpiHwGetMode() == ACPI_SYS_MODE_ACPI)
0202     {
0203         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
0204             "System is already in ACPI mode\n"));
0205     }
0206     else
0207     {
0208         /* Transition to ACPI mode */
0209
0210         Status = AcpiHwSetMode (ACPI_SYS_MODE_ACPI);
0211         if (ACPI_FAILURE (Status))
0212         {
0213             ACPI_ERROR ((AE_INFO, "Could not transition to ACPI mode"));
0214             return_ACPI_STATUS (Status);
0215         }
0216
0217         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
0218             "Transition to ACPI mode successful\n"));
0219     }
0220
0221     return_ACPI_STATUS (Status);
0222 }
0223
0224 ACPI_EXPORT_SYMBOL (AcpiEnable)
0225
0226
0227 /*******************************************************************************
0228  *
0229  * FUNCTION:    AcpiDisable
0230  *
0231  * PARAMETERS:  None
0232  *
0233  * RETURN:      Status
0234  *
0235  * DESCRIPTION: Transfers the system into LEGACY (non-ACPI) mode.
0236  *
0237  ******************************************************************************/
0238
0239 ACPI_STATUS
0240 AcpiDisable (
0241     void)
0242 {
0243     ACPI_STATUS             Status = AE_OK;
0244
0245
0246     ACPI_FUNCTION_TRACE (AcpiDisable);
0247
0248
0249     /* If the Hardware Reduced flag is set, machine is always in acpi mode */
0250
0251     if (AcpiGbl_ReducedHardware)
0252     {
0253         return_ACPI_STATUS (AE_OK);
0254     }
0255
0256     if (AcpiHwGetMode() == ACPI_SYS_MODE_LEGACY)
0257     {
0258         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
0259             "System is already in legacy (non-ACPI) mode\n"));
0260     }
0261     else
0262     {
0263         /* Transition to LEGACY mode */
0264
0265         Status = AcpiHwSetMode (ACPI_SYS_MODE_LEGACY);
0266
0267         if (ACPI_FAILURE (Status))
0268         {
0269             ACPI_ERROR ((AE_INFO,
0270                 "Could not exit ACPI mode to legacy mode"));
0271             return_ACPI_STATUS (Status);
0272         }
0273
0274         ACPI_DEBUG_PRINT ((ACPI_DB_INIT,
0275             "ACPI mode disabled\n"));
0276     }
0277
0278     return_ACPI_STATUS (Status);
0279 }
0280
0281 ACPI_EXPORT_SYMBOL (AcpiDisable)
0282
0283
0284 /*******************************************************************************
0285  *
0286  * FUNCTION:    AcpiEnableEvent
0287  *
0288  * PARAMETERS:  Event           - The fixed eventto be enabled
0289  *              Flags           - Reserved
0290  *
0291  * RETURN:      Status
0292  *
0293  * DESCRIPTION: Enable an ACPI event (fixed)
0294  *
0295  ******************************************************************************/
0296
0297 ACPI_STATUS
0298 AcpiEnableEvent (
0299     UINT32                  Event,
0300     UINT32                  Flags)
0301 {
0302     ACPI_STATUS             Status = AE_OK;
0303     UINT32                  Value;
0304
0305
0306     ACPI_FUNCTION_TRACE (AcpiEnableEvent);
0307
0308
0309     /* If Hardware Reduced flag is set, there are no fixed events */
0310
0311     if (AcpiGbl_ReducedHardware)
0312     {
0313         return_ACPI_STATUS (AE_OK);
0314     }
0315
0316     /* Decode the Fixed Event */
0317
0318     if (Event > ACPI_EVENT_MAX)
0319     {
0320         return_ACPI_STATUS (AE_BAD_PARAMETER);
0321     }
0322
0323     /*
0324      * Enable the requested fixed event (by writing a one to the enable
0325      * register bit)
0326      */
0327     Status = AcpiWriteBitRegister (
0328         AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
0329         ACPI_ENABLE_EVENT);
0330     if (ACPI_FAILURE (Status))
0331     {
0332         return_ACPI_STATUS (Status);
0333     }
0334
0335     /* Make sure that the hardware responded */
0336
0337     Status = AcpiReadBitRegister (
0338         AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &Value);
0339     if (ACPI_FAILURE (Status))
0340     {
0341         return_ACPI_STATUS (Status);
0342     }
0343
0344     if (Value != 1)
0345     {
0346         ACPI_ERROR ((AE_INFO,
0347             "Could not enable %s event", AcpiUtGetEventName (Event)));
0348         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
0349     }
0350
0351     return_ACPI_STATUS (Status);
0352 }
0353
0354 ACPI_EXPORT_SYMBOL (AcpiEnableEvent)
0355
0356
0357 /*******************************************************************************
0358  *
0359  * FUNCTION:    AcpiDisableEvent
0360  *
0361  * PARAMETERS:  Event           - The fixed event to be disabled
0362  *              Flags           - Reserved
0363  *
0364  * RETURN:      Status
0365  *
0366  * DESCRIPTION: Disable an ACPI event (fixed)
0367  *
0368  ******************************************************************************/
0369
0370 ACPI_STATUS
0371 AcpiDisableEvent (
0372     UINT32                  Event,
0373     UINT32                  Flags)
0374 {
0375     ACPI_STATUS             Status = AE_OK;
0376     UINT32                  Value;
0377
0378
0379     ACPI_FUNCTION_TRACE (AcpiDisableEvent);
0380
0381
0382     /* If Hardware Reduced flag is set, there are no fixed events */
0383
0384     if (AcpiGbl_ReducedHardware)
0385     {
0386         return_ACPI_STATUS (AE_OK);
0387     }
0388
0389     /* Decode the Fixed Event */
0390
0391     if (Event > ACPI_EVENT_MAX)
0392     {
0393         return_ACPI_STATUS (AE_BAD_PARAMETER);
0394     }
0395
0396     /*
0397      * Disable the requested fixed event (by writing a zero to the enable
0398      * register bit)
0399      */
0400     Status = AcpiWriteBitRegister (
0401         AcpiGbl_FixedEventInfo[Event].EnableRegisterId,
0402         ACPI_DISABLE_EVENT);
0403     if (ACPI_FAILURE (Status))
0404     {
0405         return_ACPI_STATUS (Status);
0406     }
0407
0408     Status = AcpiReadBitRegister (
0409         AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &Value);
0410     if (ACPI_FAILURE (Status))
0411     {
0412         return_ACPI_STATUS (Status);
0413     }
0414
0415     if (Value != 0)
0416     {
0417         ACPI_ERROR ((AE_INFO,
0418             "Could not disable %s events", AcpiUtGetEventName (Event)));
0419         return_ACPI_STATUS (AE_NO_HARDWARE_RESPONSE);
0420     }
0421
0422     return_ACPI_STATUS (Status);
0423 }
0424
0425 ACPI_EXPORT_SYMBOL (AcpiDisableEvent)
0426
0427
0428 /*******************************************************************************
0429  *
0430  * FUNCTION:    AcpiClearEvent
0431  *
0432  * PARAMETERS:  Event           - The fixed event to be cleared
0433  *
0434  * RETURN:      Status
0435  *
0436  * DESCRIPTION: Clear an ACPI event (fixed)
0437  *
0438  ******************************************************************************/
0439
0440 ACPI_STATUS
0441 AcpiClearEvent (
0442     UINT32                  Event)
0443 {
0444     ACPI_STATUS             Status = AE_OK;
0445
0446
0447     ACPI_FUNCTION_TRACE (AcpiClearEvent);
0448
0449
0450     /* If Hardware Reduced flag is set, there are no fixed events */
0451
0452     if (AcpiGbl_ReducedHardware)
0453     {
0454         return_ACPI_STATUS (AE_OK);
0455     }
0456
0457     /* Decode the Fixed Event */
0458
0459     if (Event > ACPI_EVENT_MAX)
0460     {
0461         return_ACPI_STATUS (AE_BAD_PARAMETER);
0462     }
0463
0464     /*
0465      * Clear the requested fixed event (By writing a one to the status
0466      * register bit)
0467      */
0468     Status = AcpiWriteBitRegister (
0469         AcpiGbl_FixedEventInfo[Event].StatusRegisterId,
0470         ACPI_CLEAR_STATUS);
0471
0472     return_ACPI_STATUS (Status);
0473 }
0474
0475 ACPI_EXPORT_SYMBOL (AcpiClearEvent)
0476
0477
0478 /*******************************************************************************
0479  *
0480  * FUNCTION:    AcpiGetEventStatus
0481  *
0482  * PARAMETERS:  Event           - The fixed event
0483  *              EventStatus     - Where the current status of the event will
0484  *                                be returned
0485  *
0486  * RETURN:      Status
0487  *
0488  * DESCRIPTION: Obtains and returns the current status of the event
0489  *
0490  ******************************************************************************/
0491
0492 ACPI_STATUS
0493 AcpiGetEventStatus (
0494     UINT32                  Event,
0495     ACPI_EVENT_STATUS       *EventStatus)
0496 {
0497     ACPI_STATUS             Status;
0498     ACPI_EVENT_STATUS       LocalEventStatus = 0;
0499     UINT32                  InByte;
0500
0501
0502     ACPI_FUNCTION_TRACE (AcpiGetEventStatus);
0503
0504
0505     if (!EventStatus)
0506     {
0507         return_ACPI_STATUS (AE_BAD_PARAMETER);
0508     }
0509
0510     /* Decode the Fixed Event */
0511
0512     if (Event > ACPI_EVENT_MAX)
0513     {
0514         return_ACPI_STATUS (AE_BAD_PARAMETER);
0515     }
0516
0517     /* Fixed event currently can be dispatched? */
0518
0519     if (AcpiGbl_FixedEventHandlers[Event].Handler)
0520     {
0521         LocalEventStatus |= ACPI_EVENT_FLAG_HAS_HANDLER;
0522     }
0523
0524     /* Fixed event currently enabled? */
0525
0526     Status = AcpiReadBitRegister (
0527         AcpiGbl_FixedEventInfo[Event].EnableRegisterId, &InByte);
0528     if (ACPI_FAILURE (Status))
0529     {
0530         return_ACPI_STATUS (Status);
0531     }
0532
0533     if (InByte)
0534     {
0535         LocalEventStatus |=
0536             (ACPI_EVENT_FLAG_ENABLED | ACPI_EVENT_FLAG_ENABLE_SET);
0537     }
0538
0539     /* Fixed event currently active? */
0540
0541     Status = AcpiReadBitRegister (
0542         AcpiGbl_FixedEventInfo[Event].StatusRegisterId, &InByte);
0543     if (ACPI_FAILURE (Status))
0544     {
0545         return_ACPI_STATUS (Status);
0546     }
0547
0548     if (InByte)
0549     {
0550         LocalEventStatus |= ACPI_EVENT_FLAG_STATUS_SET;
0551     }
0552
0553     (*EventStatus) = LocalEventStatus;
0554     return_ACPI_STATUS (AE_OK);
0555 }
0556
0557 ACPI_EXPORT_SYMBOL (AcpiGetEventStatus)
0558
0559 #endif /* !ACPI_REDUCED_HARDWARE */