Loading...
1/******************************************************************************
2 *
3 * Module Name: evmisc - Miscellaneous event manager support functions
4 *
5 *****************************************************************************/
6
7/*
8 * Copyright (C) 2000 - 2012, Intel Corp.
9 * All rights reserved.
10 *
11 * Redistribution and use in source and binary forms, with or without
12 * modification, are permitted provided that the following conditions
13 * are met:
14 * 1. Redistributions of source code must retain the above copyright
15 * notice, this list of conditions, and the following disclaimer,
16 * without modification.
17 * 2. Redistributions in binary form must reproduce at minimum a disclaimer
18 * substantially similar to the "NO WARRANTY" disclaimer below
19 * ("Disclaimer") and any redistribution must be conditioned upon
20 * including a substantially similar Disclaimer requirement for further
21 * binary redistribution.
22 * 3. Neither the names of the above-listed copyright holders nor the names
23 * of any contributors may be used to endorse or promote products derived
24 * from this software without specific prior written permission.
25 *
26 * Alternatively, this software may be distributed under the terms of the
27 * GNU General Public License ("GPL") version 2 as published by the Free
28 * Software Foundation.
29 *
30 * NO WARRANTY
31 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
32 * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
33 * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTIBILITY AND FITNESS FOR
34 * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
35 * HOLDERS OR CONTRIBUTORS BE LIABLE FOR SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
36 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
37 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
38 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
39 * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
40 * IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
41 * POSSIBILITY OF SUCH DAMAGES.
42 */
43
44#include <acpi/acpi.h>
45#include "accommon.h"
46#include "acevents.h"
47#include "acnamesp.h"
48
49#define _COMPONENT ACPI_EVENTS
50ACPI_MODULE_NAME("evmisc")
51
52/* Local prototypes */
53static void ACPI_SYSTEM_XFACE acpi_ev_notify_dispatch(void *context);
54
55/*******************************************************************************
56 *
57 * FUNCTION: acpi_ev_is_notify_object
58 *
59 * PARAMETERS: Node - Node to check
60 *
61 * RETURN: TRUE if notifies allowed on this object
62 *
63 * DESCRIPTION: Check type of node for a object that supports notifies.
64 *
65 * TBD: This could be replaced by a flag bit in the node.
66 *
67 ******************************************************************************/
68
69u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node)
70{
71 switch (node->type) {
72 case ACPI_TYPE_DEVICE:
73 case ACPI_TYPE_PROCESSOR:
74 case ACPI_TYPE_THERMAL:
75 /*
76 * These are the ONLY objects that can receive ACPI notifications
77 */
78 return (TRUE);
79
80 default:
81 return (FALSE);
82 }
83}
84
85/*******************************************************************************
86 *
87 * FUNCTION: acpi_ev_queue_notify_request
88 *
89 * PARAMETERS: Node - NS node for the notified object
90 * notify_value - Value from the Notify() request
91 *
92 * RETURN: Status
93 *
94 * DESCRIPTION: Dispatch a device notification event to a previously
95 * installed handler.
96 *
97 ******************************************************************************/
98
99acpi_status
100acpi_ev_queue_notify_request(struct acpi_namespace_node * node,
101 u32 notify_value)
102{
103 union acpi_operand_object *obj_desc;
104 union acpi_operand_object *handler_obj = NULL;
105 union acpi_generic_state *notify_info;
106 acpi_status status = AE_OK;
107
108 ACPI_FUNCTION_NAME(ev_queue_notify_request);
109
110 /*
111 * For value 0x03 (Ejection Request), may need to run a device method.
112 * For value 0x02 (Device Wake), if _PRW exists, may need to run
113 * the _PS0 method.
114 * For value 0x80 (Status Change) on the power button or sleep button,
115 * initiate soft-off or sleep operation.
116 *
117 * For all cases, simply dispatch the notify to the handler.
118 */
119 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
120 "Dispatching Notify on [%4.4s] (%s) Value 0x%2.2X (%s) Node %p\n",
121 acpi_ut_get_node_name(node),
122 acpi_ut_get_type_name(node->type), notify_value,
123 acpi_ut_get_notify_name(notify_value), node));
124
125 /* Get the notify object attached to the NS Node */
126
127 obj_desc = acpi_ns_get_attached_object(node);
128 if (obj_desc) {
129
130 /* We have the notify object, Get the correct handler */
131
132 switch (node->type) {
133
134 /* Notify is allowed only on these types */
135
136 case ACPI_TYPE_DEVICE:
137 case ACPI_TYPE_THERMAL:
138 case ACPI_TYPE_PROCESSOR:
139
140 if (notify_value <= ACPI_MAX_SYS_NOTIFY) {
141 handler_obj =
142 obj_desc->common_notify.system_notify;
143 } else {
144 handler_obj =
145 obj_desc->common_notify.device_notify;
146 }
147 break;
148
149 default:
150
151 /* All other types are not supported */
152
153 return (AE_TYPE);
154 }
155 }
156
157 /*
158 * If there is a handler to run, schedule the dispatcher.
159 * Check for:
160 * 1) Global system notify handler
161 * 2) Global device notify handler
162 * 3) Per-device notify handler
163 */
164 if ((acpi_gbl_system_notify.handler &&
165 (notify_value <= ACPI_MAX_SYS_NOTIFY)) ||
166 (acpi_gbl_device_notify.handler &&
167 (notify_value > ACPI_MAX_SYS_NOTIFY)) || handler_obj) {
168 notify_info = acpi_ut_create_generic_state();
169 if (!notify_info) {
170 return (AE_NO_MEMORY);
171 }
172
173 if (!handler_obj) {
174 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
175 "Executing system notify handler for Notify (%4.4s, %X) "
176 "node %p\n",
177 acpi_ut_get_node_name(node),
178 notify_value, node));
179 }
180
181 notify_info->common.descriptor_type =
182 ACPI_DESC_TYPE_STATE_NOTIFY;
183 notify_info->notify.node = node;
184 notify_info->notify.value = (u16) notify_value;
185 notify_info->notify.handler_obj = handler_obj;
186
187 status =
188 acpi_os_execute(OSL_NOTIFY_HANDLER, acpi_ev_notify_dispatch,
189 notify_info);
190 if (ACPI_FAILURE(status)) {
191 acpi_ut_delete_generic_state(notify_info);
192 }
193 } else {
194 /* There is no notify handler (per-device or system) for this device */
195
196 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
197 "No notify handler for Notify (%4.4s, %X) node %p\n",
198 acpi_ut_get_node_name(node), notify_value,
199 node));
200 }
201
202 return (status);
203}
204
205/*******************************************************************************
206 *
207 * FUNCTION: acpi_ev_notify_dispatch
208 *
209 * PARAMETERS: Context - To be passed to the notify handler
210 *
211 * RETURN: None.
212 *
213 * DESCRIPTION: Dispatch a device notification event to a previously
214 * installed handler.
215 *
216 ******************************************************************************/
217
218static void ACPI_SYSTEM_XFACE acpi_ev_notify_dispatch(void *context)
219{
220 union acpi_generic_state *notify_info =
221 (union acpi_generic_state *)context;
222 acpi_notify_handler global_handler = NULL;
223 void *global_context = NULL;
224 union acpi_operand_object *handler_obj;
225
226 ACPI_FUNCTION_ENTRY();
227
228 /*
229 * We will invoke a global notify handler if installed. This is done
230 * _before_ we invoke the per-device handler attached to the device.
231 */
232 if (notify_info->notify.value <= ACPI_MAX_SYS_NOTIFY) {
233
234 /* Global system notification handler */
235
236 if (acpi_gbl_system_notify.handler) {
237 global_handler = acpi_gbl_system_notify.handler;
238 global_context = acpi_gbl_system_notify.context;
239 }
240 } else {
241 /* Global driver notification handler */
242
243 if (acpi_gbl_device_notify.handler) {
244 global_handler = acpi_gbl_device_notify.handler;
245 global_context = acpi_gbl_device_notify.context;
246 }
247 }
248
249 /* Invoke the system handler first, if present */
250
251 if (global_handler) {
252 global_handler(notify_info->notify.node,
253 notify_info->notify.value, global_context);
254 }
255
256 /* Now invoke the per-device handler, if present */
257
258 handler_obj = notify_info->notify.handler_obj;
259 if (handler_obj) {
260 struct acpi_object_notify_handler *notifier;
261
262 notifier = &handler_obj->notify;
263 while (notifier) {
264 notifier->handler(notify_info->notify.node,
265 notify_info->notify.value,
266 notifier->context);
267 notifier = notifier->next;
268 }
269 }
270
271 /* All done with the info object */
272
273 acpi_ut_delete_generic_state(notify_info);
274}
275
276#if (!ACPI_REDUCED_HARDWARE)
277/******************************************************************************
278 *
279 * FUNCTION: acpi_ev_terminate
280 *
281 * PARAMETERS: none
282 *
283 * RETURN: none
284 *
285 * DESCRIPTION: Disable events and free memory allocated for table storage.
286 *
287 ******************************************************************************/
288
289void acpi_ev_terminate(void)
290{
291 u32 i;
292 acpi_status status;
293
294 ACPI_FUNCTION_TRACE(ev_terminate);
295
296 if (acpi_gbl_events_initialized) {
297 /*
298 * Disable all event-related functionality. In all cases, on error,
299 * print a message but obviously we don't abort.
300 */
301
302 /* Disable all fixed events */
303
304 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
305 status = acpi_disable_event(i, 0);
306 if (ACPI_FAILURE(status)) {
307 ACPI_ERROR((AE_INFO,
308 "Could not disable fixed event %u",
309 (u32) i));
310 }
311 }
312
313 /* Disable all GPEs in all GPE blocks */
314
315 status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block, NULL);
316
317 /* Remove SCI handler */
318
319 status = acpi_ev_remove_sci_handler();
320 if (ACPI_FAILURE(status)) {
321 ACPI_ERROR((AE_INFO, "Could not remove SCI handler"));
322 }
323
324 status = acpi_ev_remove_global_lock_handler();
325 if (ACPI_FAILURE(status)) {
326 ACPI_ERROR((AE_INFO,
327 "Could not remove Global Lock handler"));
328 }
329 }
330
331 /* Deallocate all handler objects installed within GPE info structs */
332
333 status = acpi_ev_walk_gpe_list(acpi_ev_delete_gpe_handlers, NULL);
334
335 /* Return to original mode if necessary */
336
337 if (acpi_gbl_original_mode == ACPI_SYS_MODE_LEGACY) {
338 status = acpi_disable();
339 if (ACPI_FAILURE(status)) {
340 ACPI_WARNING((AE_INFO, "AcpiDisable failed"));
341 }
342 }
343 return_VOID;
344}
345
346#endif /* !ACPI_REDUCED_HARDWARE */
1// SPDX-License-Identifier: BSD-3-Clause OR GPL-2.0
2/******************************************************************************
3 *
4 * Module Name: evmisc - Miscellaneous event manager support functions
5 *
6 * Copyright (C) 2000 - 2023, Intel Corp.
7 *
8 *****************************************************************************/
9
10#include <acpi/acpi.h>
11#include "accommon.h"
12#include "acevents.h"
13#include "acnamesp.h"
14
15#define _COMPONENT ACPI_EVENTS
16ACPI_MODULE_NAME("evmisc")
17
18/* Local prototypes */
19static void ACPI_SYSTEM_XFACE acpi_ev_notify_dispatch(void *context);
20
21/*******************************************************************************
22 *
23 * FUNCTION: acpi_ev_is_notify_object
24 *
25 * PARAMETERS: node - Node to check
26 *
27 * RETURN: TRUE if notifies allowed on this object
28 *
29 * DESCRIPTION: Check type of node for a object that supports notifies.
30 *
31 * TBD: This could be replaced by a flag bit in the node.
32 *
33 ******************************************************************************/
34
35u8 acpi_ev_is_notify_object(struct acpi_namespace_node *node)
36{
37
38 switch (node->type) {
39 case ACPI_TYPE_DEVICE:
40 case ACPI_TYPE_PROCESSOR:
41 case ACPI_TYPE_THERMAL:
42 /*
43 * These are the ONLY objects that can receive ACPI notifications
44 */
45 return (TRUE);
46
47 default:
48
49 return (FALSE);
50 }
51}
52
53/*******************************************************************************
54 *
55 * FUNCTION: acpi_ev_queue_notify_request
56 *
57 * PARAMETERS: node - NS node for the notified object
58 * notify_value - Value from the Notify() request
59 *
60 * RETURN: Status
61 *
62 * DESCRIPTION: Dispatch a device notification event to a previously
63 * installed handler.
64 *
65 ******************************************************************************/
66
67acpi_status
68acpi_ev_queue_notify_request(struct acpi_namespace_node *node, u32 notify_value)
69{
70 union acpi_operand_object *obj_desc;
71 union acpi_operand_object *handler_list_head = NULL;
72 union acpi_generic_state *info;
73 u8 handler_list_id = 0;
74 acpi_status status = AE_OK;
75
76 ACPI_FUNCTION_NAME(ev_queue_notify_request);
77
78 /* Are Notifies allowed on this object? */
79
80 if (!acpi_ev_is_notify_object(node)) {
81 return (AE_TYPE);
82 }
83
84 /* Get the correct notify list type (System or Device) */
85
86 if (notify_value <= ACPI_MAX_SYS_NOTIFY) {
87 handler_list_id = ACPI_SYSTEM_HANDLER_LIST;
88 } else {
89 handler_list_id = ACPI_DEVICE_HANDLER_LIST;
90 }
91
92 /* Get the notify object attached to the namespace Node */
93
94 obj_desc = acpi_ns_get_attached_object(node);
95 if (obj_desc) {
96
97 /* We have an attached object, Get the correct handler list */
98
99 handler_list_head =
100 obj_desc->common_notify.notify_list[handler_list_id];
101 }
102
103 /*
104 * If there is no notify handler (Global or Local)
105 * for this object, just ignore the notify
106 */
107 if (!acpi_gbl_global_notify[handler_list_id].handler
108 && !handler_list_head) {
109 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
110 "No notify handler for Notify, ignoring (%4.4s, %X) node %p\n",
111 acpi_ut_get_node_name(node), notify_value,
112 node));
113
114 return (AE_OK);
115 }
116
117 /* Setup notify info and schedule the notify dispatcher */
118
119 info = acpi_ut_create_generic_state();
120 if (!info) {
121 return (AE_NO_MEMORY);
122 }
123
124 info->common.descriptor_type = ACPI_DESC_TYPE_STATE_NOTIFY;
125
126 info->notify.node = node;
127 info->notify.value = (u16)notify_value;
128 info->notify.handler_list_id = handler_list_id;
129 info->notify.handler_list_head = handler_list_head;
130 info->notify.global = &acpi_gbl_global_notify[handler_list_id];
131
132 ACPI_DEBUG_PRINT((ACPI_DB_INFO,
133 "Dispatching Notify on [%4.4s] (%s) Value 0x%2.2X (%s) Node %p\n",
134 acpi_ut_get_node_name(node),
135 acpi_ut_get_type_name(node->type), notify_value,
136 acpi_ut_get_notify_name(notify_value, ACPI_TYPE_ANY),
137 node));
138
139 status = acpi_os_execute(OSL_NOTIFY_HANDLER,
140 acpi_ev_notify_dispatch, info);
141 if (ACPI_FAILURE(status)) {
142 acpi_ut_delete_generic_state(info);
143 }
144
145 return (status);
146}
147
148/*******************************************************************************
149 *
150 * FUNCTION: acpi_ev_notify_dispatch
151 *
152 * PARAMETERS: context - To be passed to the notify handler
153 *
154 * RETURN: None.
155 *
156 * DESCRIPTION: Dispatch a device notification event to a previously
157 * installed handler.
158 *
159 ******************************************************************************/
160
161static void ACPI_SYSTEM_XFACE acpi_ev_notify_dispatch(void *context)
162{
163 union acpi_generic_state *info = (union acpi_generic_state *)context;
164 union acpi_operand_object *handler_obj;
165
166 ACPI_FUNCTION_ENTRY();
167
168 /* Invoke a global notify handler if installed */
169
170 if (info->notify.global->handler) {
171 info->notify.global->handler(info->notify.node,
172 info->notify.value,
173 info->notify.global->context);
174 }
175
176 /* Now invoke the local notify handler(s) if any are installed */
177
178 handler_obj = info->notify.handler_list_head;
179 while (handler_obj) {
180 handler_obj->notify.handler(info->notify.node,
181 info->notify.value,
182 handler_obj->notify.context);
183
184 handler_obj =
185 handler_obj->notify.next[info->notify.handler_list_id];
186 }
187
188 /* All done with the info object */
189
190 acpi_ut_delete_generic_state(info);
191}
192
193#if (!ACPI_REDUCED_HARDWARE)
194/******************************************************************************
195 *
196 * FUNCTION: acpi_ev_terminate
197 *
198 * PARAMETERS: none
199 *
200 * RETURN: none
201 *
202 * DESCRIPTION: Disable events and free memory allocated for table storage.
203 *
204 ******************************************************************************/
205
206void acpi_ev_terminate(void)
207{
208 u32 i;
209 acpi_status status;
210
211 ACPI_FUNCTION_TRACE(ev_terminate);
212
213 if (acpi_gbl_events_initialized) {
214 /*
215 * Disable all event-related functionality. In all cases, on error,
216 * print a message but obviously we don't abort.
217 */
218
219 /* Disable all fixed events */
220
221 for (i = 0; i < ACPI_NUM_FIXED_EVENTS; i++) {
222 status = acpi_disable_event(i, 0);
223 if (ACPI_FAILURE(status)) {
224 ACPI_ERROR((AE_INFO,
225 "Could not disable fixed event %u",
226 (u32) i));
227 }
228 }
229
230 /* Disable all GPEs in all GPE blocks */
231
232 status = acpi_ev_walk_gpe_list(acpi_hw_disable_gpe_block, NULL);
233 if (ACPI_FAILURE(status)) {
234 ACPI_EXCEPTION((AE_INFO, status,
235 "Could not disable GPEs in GPE block"));
236 }
237
238 status = acpi_ev_remove_global_lock_handler();
239 if (ACPI_FAILURE(status)) {
240 ACPI_EXCEPTION((AE_INFO, status,
241 "Could not remove Global Lock handler"));
242 }
243
244 acpi_gbl_events_initialized = FALSE;
245 }
246
247 /* Remove SCI handlers */
248
249 status = acpi_ev_remove_all_sci_handlers();
250 if (ACPI_FAILURE(status)) {
251 ACPI_ERROR((AE_INFO, "Could not remove SCI handler"));
252 }
253
254 /* Deallocate all handler objects installed within GPE info structs */
255
256 status = acpi_ev_walk_gpe_list(acpi_ev_delete_gpe_handlers, NULL);
257 if (ACPI_FAILURE(status)) {
258 ACPI_EXCEPTION((AE_INFO, status,
259 "Could not delete GPE handlers"));
260 }
261
262 /* Return to original mode if necessary */
263
264 if (acpi_gbl_original_mode == ACPI_SYS_MODE_LEGACY) {
265 status = acpi_disable();
266 if (ACPI_FAILURE(status)) {
267 ACPI_WARNING((AE_INFO, "AcpiDisable failed"));
268 }
269 }
270 return_VOID;
271}
272
273#endif /* !ACPI_REDUCED_HARDWARE */