xref: /freebsd/sys/dev/acpica/Osd/OsdSchedule.c (revision 9a14aa017b21c292740c00ee098195cd46642730)
1 /*-
2  * Copyright (c) 2000 Michael Smith
3  * Copyright (c) 2000 BSDi
4  * Copyright (c) 2007-2009 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 
61 /*
62  * Allow the user to tune the number of task threads we start.  It seems
63  * some systems have problems with increased parallelism.
64  */
65 static int acpi_max_threads = ACPI_MAX_THREADS;
66 TUNABLE_INT("debug.acpi.max_threads", &acpi_max_threads);
67 
68 static MALLOC_DEFINE(M_ACPITASK, "acpitask", "ACPI deferred task");
69 
70 struct acpi_task_ctx {
71     struct task			at_task;
72     ACPI_OSD_EXEC_CALLBACK	at_function;
73     void 			*at_context;
74     int				at_flag;
75 #define	ACPI_TASK_FREE		0
76 #define	ACPI_TASK_USED		1
77 #define	ACPI_TASK_ENQUEUED	2
78 };
79 
80 struct taskqueue		*acpi_taskq;
81 static struct acpi_task_ctx	*acpi_tasks;
82 static int			acpi_task_count;
83 static int			acpi_taskq_started;
84 
85 /*
86  * Preallocate some memory for tasks early enough.
87  * malloc(9) cannot be used with spin lock held.
88  */
89 static void
90 acpi_task_init(void *arg)
91 {
92 
93     acpi_tasks = malloc(sizeof(*acpi_tasks) * acpi_max_tasks, M_ACPITASK,
94 	M_WAITOK | M_ZERO);
95 }
96 
97 SYSINIT(acpi_tasks, SI_SUB_DRIVERS, SI_ORDER_FIRST, acpi_task_init, NULL);
98 
99 /*
100  * Initialize ACPI task queue.
101  */
102 static void
103 acpi_taskq_init(void *arg)
104 {
105     int i;
106 
107     acpi_taskq = taskqueue_create_fast("acpi_task", M_NOWAIT,
108 	&taskqueue_thread_enqueue, &acpi_taskq);
109     taskqueue_start_threads(&acpi_taskq, acpi_max_threads, PWAIT, "acpi_task");
110     if (acpi_task_count > 0) {
111 	if (bootverbose)
112 	    printf("AcpiOsExecute: enqueue %d pending tasks\n",
113 		acpi_task_count);
114 	for (i = 0; i < acpi_max_tasks; i++)
115 	    if (atomic_cmpset_int(&acpi_tasks[i].at_flag, ACPI_TASK_USED,
116 		ACPI_TASK_USED | ACPI_TASK_ENQUEUED))
117 		taskqueue_enqueue(acpi_taskq, &acpi_tasks[i].at_task);
118     }
119     acpi_taskq_started = 1;
120 }
121 
122 SYSINIT(acpi_taskq, SI_SUB_CONFIGURE, SI_ORDER_SECOND, acpi_taskq_init, NULL);
123 
124 /*
125  * Bounce through this wrapper function since ACPI-CA doesn't understand
126  * the pending argument for its callbacks.
127  */
128 static void
129 acpi_task_execute(void *context, int pending)
130 {
131     struct acpi_task_ctx *at;
132 
133     at = (struct acpi_task_ctx *)context;
134     at->at_function(at->at_context);
135     atomic_clear_int(&at->at_flag, ACPI_TASK_USED | ACPI_TASK_ENQUEUED);
136     acpi_task_count--;
137 }
138 
139 static ACPI_STATUS
140 acpi_task_enqueue(int priority, ACPI_OSD_EXEC_CALLBACK Function, void *Context)
141 {
142     struct acpi_task_ctx *at;
143     int i;
144 
145     for (at = NULL, i = 0; i < acpi_max_tasks; i++)
146 	if (atomic_cmpset_int(&acpi_tasks[i].at_flag, ACPI_TASK_FREE,
147 	    ACPI_TASK_USED)) {
148 	    at = &acpi_tasks[i];
149 	    acpi_task_count++;
150 	    break;
151 	}
152     if (at == NULL) {
153 	printf("AcpiOsExecute: failed to enqueue task, consider increasing "
154 	    "the debug.acpi.max_tasks tunable\n");
155 	return (AE_NO_MEMORY);
156     }
157 
158     TASK_INIT(&at->at_task, priority, acpi_task_execute, at);
159     at->at_function = Function;
160     at->at_context = Context;
161 
162     /*
163      * If the task queue is ready, enqueue it now.
164      */
165     if (acpi_taskq_started) {
166 	atomic_set_int(&at->at_flag, ACPI_TASK_ENQUEUED);
167 	taskqueue_enqueue(acpi_taskq, &at->at_task);
168 	return (AE_OK);
169     }
170     if (bootverbose)
171 	printf("AcpiOsExecute: task queue not started\n");
172 
173     return (AE_OK);
174 }
175 
176 /*
177  * This function may be called in interrupt context, i.e. when a GPE fires.
178  * We allocate and queue a task for one of our taskqueue threads to process.
179  */
180 ACPI_STATUS
181 AcpiOsExecute(ACPI_EXECUTE_TYPE Type, ACPI_OSD_EXEC_CALLBACK Function,
182     void *Context)
183 {
184     int pri;
185 
186     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
187 
188     if (Function == NULL)
189 	return_ACPI_STATUS (AE_BAD_PARAMETER);
190 
191     switch (Type) {
192     case OSL_GPE_HANDLER:
193     case OSL_NOTIFY_HANDLER:
194 	/*
195 	 * Run GPEs and Notifies at the same priority.  This allows
196 	 * Notifies that are generated by running a GPE's method (e.g., _L00)
197 	 * to not be pre-empted by a later GPE that arrives during the
198 	 * Notify handler execution.
199 	 */
200 	pri = 10;
201 	break;
202     case OSL_GLOBAL_LOCK_HANDLER:
203     case OSL_EC_POLL_HANDLER:
204     case OSL_EC_BURST_HANDLER:
205 	pri = 5;
206 	break;
207     case OSL_DEBUGGER_THREAD:
208 	pri = 0;
209 	break;
210     default:
211 	return_ACPI_STATUS (AE_BAD_PARAMETER);
212     }
213 
214     return_ACPI_STATUS (acpi_task_enqueue(pri, Function, Context));
215 }
216 
217 void
218 AcpiOsSleep(UINT64 Milliseconds)
219 {
220     int		timo;
221 
222     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
223 
224     timo = Milliseconds * hz / 1000;
225 
226     /*
227      * If requested sleep time is less than our hz resolution, use
228      * DELAY instead for better granularity.
229      */
230     if (timo > 0)
231 	pause("acpislp", timo);
232     else
233 	DELAY(Milliseconds * 1000);
234 
235     return_VOID;
236 }
237 
238 /*
239  * Return the current time in 100 nanosecond units
240  */
241 UINT64
242 AcpiOsGetTimer(void)
243 {
244     struct bintime bt;
245     UINT64 t;
246 
247     /* XXX During early boot there is no (decent) timer available yet. */
248     KASSERT(cold == 0, ("acpi: timer op not yet supported during boot"));
249 
250     binuptime(&bt);
251     t = ((UINT64)10000000 * (uint32_t)(bt.frac >> 32)) >> 32;
252     t += bt.sec * 10000000;
253 
254     return (t);
255 }
256 
257 void
258 AcpiOsStall(UINT32 Microseconds)
259 {
260     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
261 
262     DELAY(Microseconds);
263     return_VOID;
264 }
265 
266 ACPI_THREAD_ID
267 AcpiOsGetThreadId(void)
268 {
269 
270     /* XXX do not add ACPI_FUNCTION_TRACE here, results in recursive call. */
271 
272     /* Returning 0 is not allowed. */
273     return (curthread->td_tid);
274 }
275