drivers/bus/acpi/acpica/events/evmisc.c

   1 /******************************************************************************
   2  *
   3  * Module Name: evmisc - Miscellaneous event manager support functions
   4  *
   5  *****************************************************************************/
   6
   7 /******************************************************************************
   8  *
   9  * 1. Copyright Notice
  10  *
  11  * Some or all of this work - Copyright (c) 1999 - 2014, 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 #include "acpi.h"
 117 #include "accommon.h"
 118 #include "acevents.h"
 119 #include "acnamesp.h"
 120
 121 #define _COMPONENT          ACPI_EVENTS
 122         ACPI_MODULE_NAME    ("evmisc")
 123
 124
 125 /* Local prototypes */
 126
 127 static void ACPI_SYSTEM_XFACE
 128 AcpiEvNotifyDispatch (
 129     void                    *Context);
 130
 131
 132 /*******************************************************************************
 133  *
 134  * FUNCTION:    AcpiEvIsNotifyObject
 135  *
 136  * PARAMETERS:  Node            - Node to check
 137  *
 138  * RETURN:      TRUE if notifies allowed on this object
 139  *
 140  * DESCRIPTION: Check type of node for a object that supports notifies.
 141  *
 142  *              TBD: This could be replaced by a flag bit in the node.
 143  *
 144  ******************************************************************************/
 145
 146 BOOLEAN
 147 AcpiEvIsNotifyObject (
 148     ACPI_NAMESPACE_NODE     *Node)
 149 {
 150     switch (Node->Type)
 151     {
 152     case ACPI_TYPE_DEVICE:
 153     case ACPI_TYPE_PROCESSOR:
 154     case ACPI_TYPE_THERMAL:
 155         /*
 156          * These are the ONLY objects that can receive ACPI notifications
 157          */
 158         return (TRUE);
 159
 160     default:
 161
 162         return (FALSE);
 163     }
 164 }
 165
 166
 167 /*******************************************************************************
 168  *
 169  * FUNCTION:    AcpiEvQueueNotifyRequest
 170  *
 171  * PARAMETERS:  Node            - NS node for the notified object
 172  *              NotifyValue     - Value from the Notify() request
 173  *
 174  * RETURN:      Status
 175  *
 176  * DESCRIPTION: Dispatch a device notification event to a previously
 177  *              installed handler.
 178  *
 179  ******************************************************************************/
 180
 181 ACPI_STATUS
 182 AcpiEvQueueNotifyRequest (
 183     ACPI_NAMESPACE_NODE     *Node,
 184     UINT32                  NotifyValue)
 185 {
 186     ACPI_OPERAND_OBJECT     *ObjDesc;
 187     ACPI_OPERAND_OBJECT     *HandlerListHead = NULL;
 188     ACPI_GENERIC_STATE      *Info;
 189     UINT8                   HandlerListId = 0;
 190     ACPI_STATUS             Status = AE_OK;
 191
 192
 193     ACPI_FUNCTION_NAME (EvQueueNotifyRequest);
 194
 195
 196     /* Are Notifies allowed on this object? */
 197
 198     if (!AcpiEvIsNotifyObject (Node))
 199     {
 200         return (AE_TYPE);
 201     }
 202
 203     /* Get the correct notify list type (System or Device) */
 204
 205     if (NotifyValue <= ACPI_MAX_SYS_NOTIFY)
 206     {
 207         HandlerListId = ACPI_SYSTEM_HANDLER_LIST;
 208     }
 209     else
 210     {
 211         HandlerListId = ACPI_DEVICE_HANDLER_LIST;
 212     }
 213
 214     /* Get the notify object attached to the namespace Node */
 215
 216     ObjDesc = AcpiNsGetAttachedObject (Node);
 217     if (ObjDesc)
 218     {
 219         /* We have an attached object, Get the correct handler list */
 220
 221         HandlerListHead = ObjDesc->CommonNotify.NotifyList[HandlerListId];
 222     }
 223
 224     /*
 225      * If there is no notify handler (Global or Local)
 226      * for this object, just ignore the notify
 227      */
 228     if (!AcpiGbl_GlobalNotify[HandlerListId].Handler && !HandlerListHead)
 229     {
 230         ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 231             "No notify handler for Notify, ignoring (%4.4s, %X) node %p\n",
 232             AcpiUtGetNodeName (Node), NotifyValue, Node));
 233
 234         return (AE_OK);
 235     }
 236
 237     /* Setup notify info and schedule the notify dispatcher */
 238
 239     Info = AcpiUtCreateGenericState ();
 240     if (!Info)
 241     {
 242         return (AE_NO_MEMORY);
 243     }
 244
 245     Info->Common.DescriptorType = ACPI_DESC_TYPE_STATE_NOTIFY;
 246
 247     Info->Notify.Node = Node;
 248     Info->Notify.Value = (UINT16) NotifyValue;
 249     Info->Notify.HandlerListId = HandlerListId;
 250     Info->Notify.HandlerListHead = HandlerListHead;
 251     Info->Notify.Global = &AcpiGbl_GlobalNotify[HandlerListId];
 252
 253     ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
 254         "Dispatching Notify on [%4.4s] (%s) Value 0x%2.2X (%s) Node %p\n",
 255         AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Node->Type),
 256         NotifyValue, AcpiUtGetNotifyName (NotifyValue, ACPI_TYPE_ANY), Node));
 257
 258     Status = AcpiOsExecute (OSL_NOTIFY_HANDLER, AcpiEvNotifyDispatch,
 259         Info);
 260     if (ACPI_FAILURE (Status))
 261     {
 262         AcpiUtDeleteGenericState (Info);
 263     }
 264
 265     return (Status);
 266 }
 267
 268
 269 /*******************************************************************************
 270  *
 271  * FUNCTION:    AcpiEvNotifyDispatch
 272  *
 273  * PARAMETERS:  Context         - To be passed to the notify handler
 274  *
 275  * RETURN:      None.
 276  *
 277  * DESCRIPTION: Dispatch a device notification event to a previously
 278  *              installed handler.
 279  *
 280  ******************************************************************************/
 281
 282 static void ACPI_SYSTEM_XFACE
 283 AcpiEvNotifyDispatch (
 284     void                    *Context)
 285 {
 286     ACPI_GENERIC_STATE      *Info = (ACPI_GENERIC_STATE *) Context;
 287     ACPI_OPERAND_OBJECT     *HandlerObj;
 288
 289
 290     ACPI_FUNCTION_ENTRY ();
 291
 292
 293     /* Invoke a global notify handler if installed */
 294
 295     if (Info->Notify.Global->Handler)
 296     {
 297         Info->Notify.Global->Handler (Info->Notify.Node,
 298             Info->Notify.Value,
 299             Info->Notify.Global->Context);
 300     }
 301
 302     /* Now invoke the local notify handler(s) if any are installed */
 303
 304     HandlerObj = Info->Notify.HandlerListHead;
 305     while (HandlerObj)
 306     {
 307         HandlerObj->Notify.Handler (Info->Notify.Node,
 308             Info->Notify.Value,
 309             HandlerObj->Notify.Context);
 310
 311         HandlerObj = HandlerObj->Notify.Next[Info->Notify.HandlerListId];
 312     }
 313
 314     /* All done with the info object */
 315
 316     AcpiUtDeleteGenericState (Info);
 317 }
 318
 319
 320 #if (!ACPI_REDUCED_HARDWARE)
 321 /******************************************************************************
 322  *
 323  * FUNCTION:    AcpiEvTerminate
 324  *
 325  * PARAMETERS:  none
 326  *
 327  * RETURN:      none
 328  *
 329  * DESCRIPTION: Disable events and free memory allocated for table storage.
 330  *
 331  ******************************************************************************/
 332
 333 void
 334 AcpiEvTerminate (
 335     void)
 336 {
 337     UINT32                  i;
 338     ACPI_STATUS             Status;
 339
 340
 341     ACPI_FUNCTION_TRACE (EvTerminate);
 342
 343
 344     if (AcpiGbl_EventsInitialized)
 345     {
 346         /*
 347          * Disable all event-related functionality. In all cases, on error,
 348          * print a message but obviously we don't abort.
 349          */
 350
 351         /* Disable all fixed events */
 352
 353         for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
 354         {
 355             Status = AcpiDisableEvent (i, 0);
 356             if (ACPI_FAILURE (Status))
 357             {
 358                 ACPI_ERROR ((AE_INFO,
 359                     "Could not disable fixed event %u", (UINT32) i));
 360             }
 361         }
 362
 363         /* Disable all GPEs in all GPE blocks */
 364
 365         Status = AcpiEvWalkGpeList (AcpiHwDisableGpeBlock, NULL);
 366
 367         Status = AcpiEvRemoveGlobalLockHandler ();
 368         if (ACPI_FAILURE(Status))
 369         {
 370             ACPI_ERROR ((AE_INFO,
 371                 "Could not remove Global Lock handler"));
 372         }
 373
 374         AcpiGbl_EventsInitialized = FALSE;
 375     }
 376
 377     /* Remove SCI handlers */
 378
 379     Status = AcpiEvRemoveAllSciHandlers ();
 380     if (ACPI_FAILURE(Status))
 381     {
 382         ACPI_ERROR ((AE_INFO,
 383             "Could not remove SCI handler"));
 384     }
 385
 386     /* Deallocate all handler objects installed within GPE info structs */
 387
 388     Status = AcpiEvWalkGpeList (AcpiEvDeleteGpeHandlers, NULL);
 389
 390     /* Return to original mode if necessary */
 391
 392     if (AcpiGbl_OriginalMode == ACPI_SYS_MODE_LEGACY)
 393     {
 394         Status = AcpiDisable ();
 395         if (ACPI_FAILURE (Status))
 396         {
 397             ACPI_WARNING ((AE_INFO, "AcpiDisable failed"));
 398         }
 399     }
 400     return_VOID;
 401 }
 402
 403 #endif /* !ACPI_REDUCED_HARDWARE */