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 - 2018, 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 * Alternatively, you may choose to be licensed under the terms of the
117 * following license:
118 *
119 * Redistribution and use in source and binary forms, with or without
120 * modification, are permitted provided that the following conditions
121 * are met:
122 * 1. Redistributions of source code must retain the above copyright
123 * notice, this list of conditions, and the following disclaimer,
124 * without modification.
125 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
126 * substantially similar to the "NO WARRANTY" disclaimer below
127 * ("Disclaimer") and any redistribution must be conditioned upon
128 * including a substantially similar Disclaimer requirement for further
129 * binary redistribution.
130 * 3. Neither the names of the above-listed copyright holders nor the names
131 * of any contributors may be used to endorse or promote products derived
132 * from this software without specific prior written permission.
133 *
134 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
135 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
136 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
137 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
138 * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
139 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
140 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
141 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
142 * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
143 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
144 * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
145 *
146 * Alternatively, you may choose to be licensed under the terms of the
147 * GNU General Public License ("GPL") version 2 as published by the Free
148 * Software Foundation.
149 *
150 *****************************************************************************/
151
152 #include "acpi.h"
153 #include "accommon.h"
154 #include "acevents.h"
155 #include "acnamesp.h"
156
157 #define _COMPONENT ACPI_EVENTS
158 ACPI_MODULE_NAME ("evmisc")
159
160
161 /* Local prototypes */
162
163 static void ACPI_SYSTEM_XFACE
164 AcpiEvNotifyDispatch (
165 void *Context);
166
167
168 /*******************************************************************************
169 *
170 * FUNCTION: AcpiEvIsNotifyObject
171 *
172 * PARAMETERS: Node - Node to check
173 *
174 * RETURN: TRUE if notifies allowed on this object
175 *
176 * DESCRIPTION: Check type of node for a object that supports notifies.
177 *
178 * TBD: This could be replaced by a flag bit in the node.
179 *
180 ******************************************************************************/
181
182 BOOLEAN
AcpiEvIsNotifyObject(ACPI_NAMESPACE_NODE * Node)183 AcpiEvIsNotifyObject (
184 ACPI_NAMESPACE_NODE *Node)
185 {
186
187 switch (Node->Type)
188 {
189 case ACPI_TYPE_DEVICE:
190 case ACPI_TYPE_PROCESSOR:
191 case ACPI_TYPE_THERMAL:
192 /*
193 * These are the ONLY objects that can receive ACPI notifications
194 */
195 return (TRUE);
196
197 default:
198
199 return (FALSE);
200 }
201 }
202
203
204 /*******************************************************************************
205 *
206 * FUNCTION: AcpiEvQueueNotifyRequest
207 *
208 * PARAMETERS: Node - NS node for the notified object
209 * NotifyValue - Value from the Notify() request
210 *
211 * RETURN: Status
212 *
213 * DESCRIPTION: Dispatch a device notification event to a previously
214 * installed handler.
215 *
216 ******************************************************************************/
217
218 ACPI_STATUS
AcpiEvQueueNotifyRequest(ACPI_NAMESPACE_NODE * Node,UINT32 NotifyValue)219 AcpiEvQueueNotifyRequest (
220 ACPI_NAMESPACE_NODE *Node,
221 UINT32 NotifyValue)
222 {
223 ACPI_OPERAND_OBJECT *ObjDesc;
224 ACPI_OPERAND_OBJECT *HandlerListHead = NULL;
225 ACPI_GENERIC_STATE *Info;
226 UINT8 HandlerListId = 0;
227 ACPI_STATUS Status = AE_OK;
228
229
230 ACPI_FUNCTION_NAME (EvQueueNotifyRequest);
231
232
233 /* Are Notifies allowed on this object? */
234
235 if (!AcpiEvIsNotifyObject (Node))
236 {
237 return (AE_TYPE);
238 }
239
240 /* Get the correct notify list type (System or Device) */
241
242 if (NotifyValue <= ACPI_MAX_SYS_NOTIFY)
243 {
244 HandlerListId = ACPI_SYSTEM_HANDLER_LIST;
245 }
246 else
247 {
248 HandlerListId = ACPI_DEVICE_HANDLER_LIST;
249 }
250
251 /* Get the notify object attached to the namespace Node */
252
253 ObjDesc = AcpiNsGetAttachedObject (Node);
254 if (ObjDesc)
255 {
256 /* We have an attached object, Get the correct handler list */
257
258 HandlerListHead = ObjDesc->CommonNotify.NotifyList[HandlerListId];
259 }
260
261 /*
262 * If there is no notify handler (Global or Local)
263 * for this object, just ignore the notify
264 */
265 if (!AcpiGbl_GlobalNotify[HandlerListId].Handler && !HandlerListHead)
266 {
267 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
268 "No notify handler for Notify, ignoring (%4.4s, %X) node %p\n",
269 AcpiUtGetNodeName (Node), NotifyValue, Node));
270
271 return (AE_OK);
272 }
273
274 /* Setup notify info and schedule the notify dispatcher */
275
276 Info = AcpiUtCreateGenericState ();
277 if (!Info)
278 {
279 return (AE_NO_MEMORY);
280 }
281
282 Info->Common.DescriptorType = ACPI_DESC_TYPE_STATE_NOTIFY;
283
284 Info->Notify.Node = Node;
285 Info->Notify.Value = (UINT16) NotifyValue;
286 Info->Notify.HandlerListId = HandlerListId;
287 Info->Notify.HandlerListHead = HandlerListHead;
288 Info->Notify.Global = &AcpiGbl_GlobalNotify[HandlerListId];
289
290 ACPI_DEBUG_PRINT ((ACPI_DB_INFO,
291 "Dispatching Notify on [%4.4s] (%s) Value 0x%2.2X (%s) Node %p\n",
292 AcpiUtGetNodeName (Node), AcpiUtGetTypeName (Node->Type),
293 NotifyValue, AcpiUtGetNotifyName (NotifyValue, ACPI_TYPE_ANY), Node));
294
295 Status = AcpiOsExecute (OSL_NOTIFY_HANDLER,
296 AcpiEvNotifyDispatch, Info);
297 if (ACPI_FAILURE (Status))
298 {
299 AcpiUtDeleteGenericState (Info);
300 }
301
302 return (Status);
303 }
304
305
306 /*******************************************************************************
307 *
308 * FUNCTION: AcpiEvNotifyDispatch
309 *
310 * PARAMETERS: Context - To be passed to the notify handler
311 *
312 * RETURN: None.
313 *
314 * DESCRIPTION: Dispatch a device notification event to a previously
315 * installed handler.
316 *
317 ******************************************************************************/
318
319 static void ACPI_SYSTEM_XFACE
AcpiEvNotifyDispatch(void * Context)320 AcpiEvNotifyDispatch (
321 void *Context)
322 {
323 ACPI_GENERIC_STATE *Info = (ACPI_GENERIC_STATE *) Context;
324 ACPI_OPERAND_OBJECT *HandlerObj;
325
326
327 ACPI_FUNCTION_ENTRY ();
328
329
330 /* Invoke a global notify handler if installed */
331
332 if (Info->Notify.Global->Handler)
333 {
334 Info->Notify.Global->Handler (Info->Notify.Node,
335 Info->Notify.Value,
336 Info->Notify.Global->Context);
337 }
338
339 /* Now invoke the local notify handler(s) if any are installed */
340
341 HandlerObj = Info->Notify.HandlerListHead;
342 while (HandlerObj)
343 {
344 HandlerObj->Notify.Handler (Info->Notify.Node,
345 Info->Notify.Value,
346 HandlerObj->Notify.Context);
347
348 HandlerObj = HandlerObj->Notify.Next[Info->Notify.HandlerListId];
349 }
350
351 /* All done with the info object */
352
353 AcpiUtDeleteGenericState (Info);
354 }
355
356
357 #if (!ACPI_REDUCED_HARDWARE)
358 /******************************************************************************
359 *
360 * FUNCTION: AcpiEvTerminate
361 *
362 * PARAMETERS: none
363 *
364 * RETURN: none
365 *
366 * DESCRIPTION: Disable events and free memory allocated for table storage.
367 *
368 ******************************************************************************/
369
370 void
AcpiEvTerminate(void)371 AcpiEvTerminate (
372 void)
373 {
374 UINT32 i;
375 ACPI_STATUS Status;
376
377
378 ACPI_FUNCTION_TRACE (EvTerminate);
379
380
381 if (AcpiGbl_EventsInitialized)
382 {
383 /*
384 * Disable all event-related functionality. In all cases, on error,
385 * print a message but obviously we don't abort.
386 */
387
388 /* Disable all fixed events */
389
390 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++)
391 {
392 Status = AcpiDisableEvent (i, 0);
393 if (ACPI_FAILURE (Status))
394 {
395 ACPI_ERROR ((AE_INFO,
396 "Could not disable fixed event %u", (UINT32) i));
397 }
398 }
399
400 /* Disable all GPEs in all GPE blocks */
401
402 Status = AcpiEvWalkGpeList (AcpiHwDisableGpeBlock, NULL);
403
404 Status = AcpiEvRemoveGlobalLockHandler ();
405 if (ACPI_FAILURE(Status))
406 {
407 ACPI_ERROR ((AE_INFO,
408 "Could not remove Global Lock handler"));
409 }
410
411 AcpiGbl_EventsInitialized = FALSE;
412 }
413
414 /* Remove SCI handlers */
415
416 Status = AcpiEvRemoveAllSciHandlers ();
417 if (ACPI_FAILURE(Status))
418 {
419 ACPI_ERROR ((AE_INFO,
420 "Could not remove SCI handler"));
421 }
422
423 /* Deallocate all handler objects installed within GPE info structs */
424
425 Status = AcpiEvWalkGpeList (AcpiEvDeleteGpeHandlers, NULL);
426
427 /* Return to original mode if necessary */
428
429 if (AcpiGbl_OriginalMode == ACPI_SYS_MODE_LEGACY)
430 {
431 Status = AcpiDisable ();
432 if (ACPI_FAILURE (Status))
433 {
434 ACPI_WARNING ((AE_INFO, "AcpiDisable failed"));
435 }
436 }
437 return_VOID;
438 }
439
440 #endif /* !ACPI_REDUCED_HARDWARE */
441