xref: /freebsd/sys/dev/acpica/Osd/OsdSchedule.c (revision 76b28ad6ab6dc8d4a62cb7de7f143595be535813)
1 /*-
2  * Copyright (c) 2000 Michael Smith
3  * Copyright (c) 2000 BSDi
4  * Copyright (c) 2007-2012 Jung-uk Kim <jkim@FreeBSD.org>
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  *
16  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
17  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
20  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
21  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
22  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
23  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
24  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
25  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
26  * SUCH DAMAGE.
27  */
28 
29 /*
30  * 6.3 : Scheduling services
31  */
32 
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
35 
36 #include "opt_acpi.h"
37 #include <sys/param.h>
38 #include <sys/systm.h>
39 #include <sys/bus.h>
40 #include <sys/interrupt.h>
41 #include <sys/kernel.h>
42 #include <sys/kthread.h>
43 #include <sys/malloc.h>
44 #include <sys/proc.h>
45 #include <sys/taskqueue.h>
46 
47 #include <contrib/dev/acpica/include/acpi.h>
48 #include <contrib/dev/acpica/include/accommon.h>
49 
50 #include <dev/acpica/acpivar.h>
51 
52 #define _COMPONENT	ACPI_OS_SERVICES
53 ACPI_MODULE_NAME("SCHEDULE")
54 
55 /*
56  * Allow the user to tune the maximum number of tasks we may enqueue.
57  */
58 static int acpi_max_tasks = ACPI_MAX_TASKS;
59 TUNABLE_INT("debug.acpi.max_tasks", &acpi_max_tasks);
60 SYSCTL_INT(_debug_acpi, OID_AUTO, max_tasks, CTLFLAG_RDTUN, &acpi_max_tasks,
61     0, "Maximum acpi tasks");
62 
63 /*
64  * Allow the user to tune the number of task threads we start.  It seems
65  * some systems have problems with increased parallelism.
66  */
67 static int acpi_max_threads = ACPI_MAX_THREADS;
68 TUNABLE_INT("debug.acpi.max_threads", &acpi_max_threads);
69 SYSCTL_INT(_debug_acpi, OID_AUTO, max_threads, CTLFLAG_RDTUN, &acpi_max_threads,
70     0, "Maximum acpi threads");
71 
72 static MALLOC_DEFINE(M_ACPITASK, "acpitask", "ACPI deferred task");
73 
74 struct acpi_task_ctx {
75     struct task			at_task;
76     ACPI_OSD_EXEC_CALLBACK	at_function;
77     void 			*at_context;
78     int				at_flag;
79 #define	ACPI_TASK_FREE		0
80 #define	ACPI_TASK_USED		1
81 #define	ACPI_TASK_ENQUEUED	2
82 };
83 
84 struct taskqueue		*acpi_taskq;
85 static struct acpi_task_ctx	*acpi_tasks;
86 static int			acpi_task_count;
87 static int			acpi_taskq_started;
88 
89 /*
90  * Preallocate some memory for tasks early enough.
91  * malloc(9) cannot be used with spin lock held.
92  */
93 static void
94 acpi_task_init(void *arg)
95 {
96 
97     acpi_tasks = malloc(sizeof(*acpi_tasks) * acpi_max_tasks, M_ACPITASK,
98 	M_WAITOK | M_ZERO);
99 }
100 
101 SYSINIT(acpi_tasks, SI_SUB_DRIVERS, SI_ORDER_FIRST, acpi_task_init, NULL);
102 
103 /*
104  * Initialize ACPI task queue.
105  */
106 static void
107 acpi_taskq_init(void *arg)
108 {
109     int i;
110 
111     acpi_taskq = taskqueue_create_fast("acpi_task", M_NOWAIT,
112 	&taskqueue_thread_enqueue, &acpi_taskq);
113     taskqueue_start_threads(&acpi_taskq, acpi_max_threads, PWAIT, "acpi_task");
114     if (acpi_task_count > 0) {
115 	if (bootverbose)
116 	    printf("AcpiOsExecute: enqueue %d pending tasks\n",
117 		acpi_task_count);
118 	for (i = 0; i < acpi_max_tasks; i++)
119 	    if (atomic_cmpset_int(&acpi_tasks[i].at_flag, ACPI_TASK_USED,
120 		ACPI_TASK_USED | ACPI_TASK_ENQUEUED))
121 		taskqueue_enqueue(acpi_taskq, &acpi_tasks[i].at_task);
122     }
123     acpi_taskq_started = 1;
124 }
125 
126 SYSINIT(acpi_taskq, SI_SUB_CONFIGURE, SI_ORDER_SECOND, acpi_taskq_init, NULL);
127 
128 /*
129  * Bounce through this wrapper function since ACPI-CA doesn't understand
130  * the pending argument for its callbacks.
131  */
132 static void
133 acpi_task_execute(void *context, int pending)
134 {
135     struct acpi_task_ctx *at;
136 
137     at = (struct acpi_task_ctx *)context;
138     at->at_function(at->at_context);
139     atomic_clear_int(&at->at_flag, ACPI_TASK_USED | ACPI_TASK_ENQUEUED);
140     acpi_task_count--;
141 }
142 
143 static ACPI_STATUS
144 acpi_task_enqueue(int priority, ACPI_OSD_EXEC_CALLBACK Function, void *Context)
145 {
146     struct acpi_task_ctx *at;
147     int i;
148 
149     for (at = NULL, i = 0; i < acpi_max_tasks; i++)
150 	if (atomic_cmpset_int(&acpi_tasks[i].at_flag, ACPI_TASK_FREE,
151 	    ACPI_TASK_USED)) {
152 	    at = &acpi_tasks[i];
153 	    acpi_task_count++;
154 	    break;
155 	}
156     if (at == NULL) {
157 	printf("AcpiOsExecute: failed to enqueue task, consider increasing "
158 	    "the debug.acpi.max_tasks tunable\n");
159 	return (AE_NO_MEMORY);
160     }
161 
162     TASK_INIT(&at->at_task, priority, acpi_task_execute, at);
163     at->at_function = Function;
164     at->at_context = Context;
165 
166     /*
167      * If the task queue is ready, enqueue it now.
168      */
169     if (acpi_taskq_started) {
170 	atomic_set_int(&at->at_flag, ACPI_TASK_ENQUEUED);
171 	taskqueue_enqueue(acpi_taskq, &at->at_task);
172 	return (AE_OK);
173     }
174     if (bootverbose)
175 	printf("AcpiOsExecute: task queue not started\n");
176 
177     return (AE_OK);
178 }
179 
180 /*
181  * This function may be called in interrupt context, i.e. when a GPE fires.
182  * We allocate and queue a task for one of our taskqueue threads to process.
183  */
184 ACPI_STATUS
185 AcpiOsExecute(ACPI_EXECUTE_TYPE Type, ACPI_OSD_EXEC_CALLBACK Function,
186     void *Context)
187 {
188     ACPI_STATUS status;
189     int pri;
190 
191     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
192 
193     if (Function == NULL)
194 	return_ACPI_STATUS(AE_BAD_PARAMETER);
195 
196     switch (Type) {
197     case OSL_GPE_HANDLER:
198     case OSL_NOTIFY_HANDLER:
199 	/*
200 	 * Run GPEs and Notifies at the same priority.  This allows
201 	 * Notifies that are generated by running a GPE's method (e.g., _L00)
202 	 * to not be pre-empted by a later GPE that arrives during the
203 	 * Notify handler execution.
204 	 */
205 	pri = 10;
206 	break;
207     case OSL_GLOBAL_LOCK_HANDLER:
208     case OSL_EC_POLL_HANDLER:
209     case OSL_EC_BURST_HANDLER:
210 	pri = 5;
211 	break;
212     case OSL_DEBUGGER_THREAD:
213 	pri = 0;
214 	break;
215     default:
216 	return_ACPI_STATUS(AE_BAD_PARAMETER);
217     }
218 
219     status = acpi_task_enqueue(pri, Function, Context);
220     return_ACPI_STATUS(status);
221 }
222 
223 void
224 AcpiOsWaitEventsComplete(void)
225 {
226 	int i;
227 
228 	ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
229 
230 	for (i = 0; i < acpi_max_tasks; i++)
231 		if ((atomic_load_acq_int(&acpi_tasks[i].at_flag) &
232 		    ACPI_TASK_ENQUEUED) != 0)
233 			taskqueue_drain(acpi_taskq, &acpi_tasks[i].at_task);
234 	return_VOID;
235 }
236 
237 void
238 AcpiOsSleep(UINT64 Milliseconds)
239 {
240     int		timo;
241 
242     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
243 
244     timo = Milliseconds * hz / 1000;
245 
246     /*
247      * If requested sleep time is less than our hz resolution, use
248      * DELAY instead for better granularity.
249      */
250     if (timo > 0)
251 	pause("acpislp", timo);
252     else
253 	DELAY(Milliseconds * 1000);
254 
255     return_VOID;
256 }
257 
258 /*
259  * Return the current time in 100 nanosecond units
260  */
261 UINT64
262 AcpiOsGetTimer(void)
263 {
264     struct bintime bt;
265     UINT64 t;
266 
267     /* XXX During early boot there is no (decent) timer available yet. */
268     KASSERT(cold == 0, ("acpi: timer op not yet supported during boot"));
269 
270     binuptime(&bt);
271     t = (uint64_t)bt.sec * 10000000;
272     t += ((uint64_t)10000000 * (uint32_t)(bt.frac >> 32)) >> 32;
273 
274     return (t);
275 }
276 
277 void
278 AcpiOsStall(UINT32 Microseconds)
279 {
280     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
281 
282     DELAY(Microseconds);
283     return_VOID;
284 }
285 
286 ACPI_THREAD_ID
287 AcpiOsGetThreadId(void)
288 {
289 
290     /* XXX do not add ACPI_FUNCTION_TRACE here, results in recursive call. */
291 
292     /* Returning 0 is not allowed. */
293     return (curthread->td_tid);
294 }
295