acpica/events/evmisc.c

0001 /******************************************************************************
0002  *
0003  * Module Name: evmisc - Miscellaneous event manager support functions
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 #include "acpi.h"
0153 #include "accommon.h"
0154 #include "acevents.h"
0155 #include "acnamesp.h"
0156
0157 #define _COMPONENT          ACPI_EVENTS
0158         ACPI_MODULE_NAME    ("evmisc")
0159
0160
0161 /* Local prototypes */
0162
0163 static void ACPI_SYSTEM_XFACE
0164 AcpiEvNotifyDispatch (
0165     void                    *Context);
0166
0167
0168 /*******************************************************************************
0169  *
0170  * FUNCTION:    AcpiEvIsNotifyObject
0171  *
0172  * PARAMETERS:  Node            - Node to check
0173  *
0174  * RETURN:      TRUE if notifies allowed on this object
0175  *
0176  * DESCRIPTION: Check type of node for a object that supports notifies.
0177  *
0178  *              TBD: This could be replaced by a flag bit in the node.
0179  *
0180  ******************************************************************************/
0181
0182 BOOLEAN
0183 AcpiEvIsNotifyObject (
0184     ACPI_NAMESPACE_NODE     *Node)
0185 {
0186
0187     switch (Node->Type)
0188     {
0189     case ACPI_TYPE_DEVICE:
0190     case ACPI_TYPE_PROCESSOR:
0191     case ACPI_TYPE_THERMAL:
0192         /*
0193          * These are the ONLY objects that can receive ACPI notifications
0194          */
0195         return (TRUE);
0196
0197     default:
0198
0199         return (FALSE);
0200     }
0201 }
0202
0203
0204 /*******************************************************************************
0205  *
0206  * FUNCTION:    AcpiEvQueueNotifyRequest
0207  *
0208  * PARAMETERS:  Node            - NS node for the notified object
0209  *              NotifyValue     - Value from the Notify() request
0210  *
0211  * RETURN:      Status
0212  *
0213  * DESCRIPTION: Dispatch a device notification event to a previously
0214  *              installed handler.
0215  *
0216  ******************************************************************************/
0217
0218 ACPI_STATUS
0219 AcpiEvQueueNotifyRequest (
0220     ACPI_NAMESPACE_NODE     *Node,
0221     UINT32                  NotifyValue)
0222 {
0223     ACPI_OPERAND_OBJECT     *ObjDesc;
0224     ACPI_OPERAND_OBJECT     *HandlerListHead = NULL;
0225     ACPI_GENERIC_STATE      *Info;
0226     UINT8                   HandlerListId = 0;
0227     ACPI_STATUS             Status = AE_OK;
0228
0229
0230     ACPI_FUNCTION_NAME (EvQueueNotifyRequest);
0231
0232
0233     /* Are Notifies allowed on this object? */
0234
0235     if (!AcpiEvIsNotifyObject (Node))
0236     {
0237         return (AE_TYPE);
0238     }
0239
0240     /* Get the correct notify list type (System or Device) */
0241
0242     if (NotifyValue <= ACPI_MAX_SYS_NOTIFY)
0243     {
0244         HandlerListId = ACPI_SYSTEM_HANDLER_LIST;
0245     }
0246     else
0247     {
0248         HandlerListId = ACPI_DEVICE_HANDLER_LIST;
0249     }
0250
0251     /* Get the notify object attached to the namespace Node */
0252
0253     ObjDesc = AcpiNsGetAttachedObject (Node);
0254     if (ObjDesc)
0255     {
0256         /* We have an attached object, Get the correct handler list */
0257
0258         HandlerListHead = ObjDesc->CommonNotify.NotifyList[HandlerListId];
0259     }
0260
0261     /*
0262      * If there is no notify handler (Global or Local)
0263      * for this object, just ignore the notify
0264      */
0265     if (!AcpiGbl_GlobalNotify[HandlerListId].Handler && !HandlerListHead)
0266     {
0267         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
0268             "No notify handler for Notify, ignoring (%4.4s, %X) node %p\n",
0269             AcpiUtGetNodeName (Node), NotifyValue, Node));
0270
0271         return (AE_OK);
0272     }
0273
0274     /* Setup notify info and schedule the notify dispatcher */
0275
0276     Info = AcpiUtCreateGenericState ();
0277     if (!Info)
0278     {
0279         return (AE_NO_MEMORY);
0280     }
0281
0282     Info->Common.DescriptorType = ACPI_DESC_TYPE_STATE_NOTIFY;
0283
0284     Info->Notify.Node = Node;
0285     Info->Notify.Value = (UINT16) NotifyValue;
0286     Info->Notify.HandlerListId = HandlerListId;
0287     Info->Notify.HandlerListHead = HandlerListHead;
0288     Info->Notify.Global = &AcpiGbl_GlobalNotify[HandlerListId];
0289
0290     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
0291         "Dispatching Notify on [%4.4s] (%s) Value 0x%2.2X (%s) Node %p\n",
0292         AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Node->Type),
0293         NotifyValue, AcpiUtGetNotifyName (NotifyValue, ACPI_TYPE_ANY), Node));
0294
0295     Status = AcpiOsExecute (OSL_NOTIFY_HANDLER,
0296         AcpiEvNotifyDispatch, Info);
0297     if (ACPI_FAILURE (Status))
0298     {
0299         AcpiUtDeleteGenericState (Info);
0300     }
0301
0302     return (Status);
0303 }
0304
0305
0306 /*******************************************************************************
0307  *
0308  * FUNCTION:    AcpiEvNotifyDispatch
0309  *
0310  * PARAMETERS:  Context         - To be passed to the notify handler
0311  *
0312  * RETURN:      None.
0313  *
0314  * DESCRIPTION: Dispatch a device notification event to a previously
0315  *              installed handler.
0316  *
0317  ******************************************************************************/
0318
0319 static void ACPI_SYSTEM_XFACE
0320 AcpiEvNotifyDispatch (
0321     void                    *Context)
0322 {
0323     ACPI_GENERIC_STATE      *Info = (ACPI_GENERIC_STATE *) Context;
0324     ACPI_OPERAND_OBJECT     *HandlerObj;
0325
0326
0327     ACPI_FUNCTION_ENTRY ();
0328
0329
0330     /* Invoke a global notify handler if installed */
0331
0332     if (Info->Notify.Global->Handler)
0333     {
0334         Info->Notify.Global->Handler (Info->Notify.Node,
0335             Info->Notify.Value,
0336             Info->Notify.Global->Context);
0337     }
0338
0339     /* Now invoke the local notify handler(s) if any are installed */
0340
0341     HandlerObj = Info->Notify.HandlerListHead;
0342     while (HandlerObj)
0343     {
0344         HandlerObj->Notify.Handler (Info->Notify.Node,
0345             Info->Notify.Value,
0346             HandlerObj->Notify.Context);
0347
0348         HandlerObj = HandlerObj->Notify.Next[Info->Notify.HandlerListId];
0349     }
0350
0351     /* All done with the info object */
0352
0353     AcpiUtDeleteGenericState (Info);
0354 }
0355
0356
0357 #if (!ACPI_REDUCED_HARDWARE)
0358 /******************************************************************************
0359  *
0360  * FUNCTION:    AcpiEvTerminate
0361  *
0362  * PARAMETERS:  none
0363  *
0364  * RETURN:      none
0365  *
0366  * DESCRIPTION: Disable events and free memory allocated for table storage.
0367  *
0368  ******************************************************************************/
0369
0370 void
0371 AcpiEvTerminate (
0372     void)
0373 {
0374     UINT32                  i;
0375     ACPI_STATUS             Status;
0376
0377
0378     ACPI_FUNCTION_TRACE (EvTerminate);
0379
0380
0381     if (AcpiGbl_EventsInitialized)
0382     {
0383         /*
0384          * Disable all event-related functionality. In all cases, on error,
0385          * print a message but obviously we don't abort.
0386          */
0387
0388         /* Disable all fixed events */
0389
0390         for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
0391         {
0392             Status = AcpiDisableEvent (i, 0);
0393             if (ACPI_FAILURE (Status))
0394             {
0395                 ACPI_ERROR ((AE_INFO,
0396                     "Could not disable fixed event %u", (UINT32) i));
0397             }
0398         }
0399
0400         /* Disable all GPEs in all GPE blocks */
0401
0402         Status = AcpiEvWalkGpeList (AcpiHwDisableGpeBlock, NULL);
0403         if (ACPI_FAILURE (Status))
0404         {
0405             ACPI_EXCEPTION ((AE_INFO, Status,
0406                 "Could not disable GPEs in GPE block"));
0407         }
0408
0409         Status = AcpiEvRemoveGlobalLockHandler ();
0410         if (ACPI_FAILURE (Status))
0411         {
0412             ACPI_EXCEPTION ((AE_INFO, Status,
0413                 "Could not remove Global Lock handler"));
0414         }
0415
0416         AcpiGbl_EventsInitialized = FALSE;
0417     }
0418
0419     /* Remove SCI handlers */
0420
0421     Status = AcpiEvRemoveAllSciHandlers ();
0422     if (ACPI_FAILURE (Status))
0423     {
0424         ACPI_ERROR ((AE_INFO,
0425             "Could not remove SCI handler"));
0426     }
0427
0428     /* Deallocate all handler objects installed within GPE info structs */
0429
0430     Status = AcpiEvWalkGpeList (AcpiEvDeleteGpeHandlers, NULL);
0431     if (ACPI_FAILURE (Status))
0432     {
0433         ACPI_EXCEPTION ((AE_INFO, Status,
0434             "Could not delete GPE handlers"));
0435     }
0436
0437
0438     /* Return to original mode if necessary */
0439
0440     if (AcpiGbl_OriginalMode == ACPI_SYS_MODE_LEGACY)
0441     {
0442         Status = AcpiDisable ();
0443         if (ACPI_FAILURE (Status))
0444         {
0445             ACPI_WARNING ((AE_INFO, "AcpiDisable failed"));
0446         }
0447     }
0448     return_VOID;
0449 }
0450
0451 #endif /* !ACPI_REDUCED_HARDWARE */