c41f7fc11339b0b92329dfe81096c46004cbc095
[dragonfly.git] / sys / dev / acpica5 / Osd / OsdSynch.c
1 /*-
2  * Copyright (c) 2000 Michael Smith
3  * Copyright (c) 2000 BSDi
4  * All rights reserved.
5  *
6  * Redistribution and use in source and binary forms, with or without
7  * modification, are permitted provided that the following conditions
8  * are met:
9  * 1. Redistributions of source code must retain the above copyright
10  *    notice, this list of conditions and the following disclaimer.
11  * 2. Redistributions in binary form must reproduce the above copyright
12  *    notice, this list of conditions and the following disclaimer in the
13  *    documentation and/or other materials provided with the distribution.
14  *
15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
25  * SUCH DAMAGE.
26  *
27  * $FreeBSD: src/sys/dev/acpica/Osd/OsdSynch.c,v 1.21 2004/05/05 20:07:52 njl Exp $
28  * $DragonFly: src/sys/dev/acpica5/Osd/OsdSynch.c,v 1.11 2007/01/25 15:12:06 y0netan1 Exp $
29  */
30
31 /*
32  * 6.1 : Mutual Exclusion and Synchronisation
33  */
34
35 #include "acpi.h"
36 #include "accommon.h"
37
38 #include "opt_acpi.h"
39
40 #include <sys/kernel.h>
41 #include <sys/malloc.h>
42 #include <sys/sysctl.h>
43 #include <sys/lock.h>
44 #include <sys/thread.h>
45 #include <sys/thread2.h>
46 #include <sys/spinlock2.h>
47
48 #define _COMPONENT      ACPI_OS_SERVICES
49 ACPI_MODULE_NAME("SYNCH")
50
51 MALLOC_DEFINE(M_ACPISEM, "acpisem", "ACPI semaphore");
52
53 #define AS_LOCK(as)             spin_lock_wr(&(as)->as_spin)
54 #define AS_UNLOCK(as)           spin_unlock_wr(&(as)->as_spin)
55 #define AS_LOCK_DECL
56
57 /*
58  * Simple counting semaphore implemented using a mutex.  (Subsequently used
59  * in the OSI code to implement a mutex.  Go figure.)
60  */
61 struct acpi_semaphore {
62     struct      spinlock as_spin;
63     UINT32      as_units;
64     UINT32      as_maxunits;
65     UINT32      as_pendings;
66     UINT32      as_resetting;
67     UINT32      as_timeouts;
68 };
69
70 #ifndef ACPI_NO_SEMAPHORES
71 #ifndef ACPI_SEMAPHORES_MAX_PENDING
72 #define ACPI_SEMAPHORES_MAX_PENDING     4
73 #endif
74 static int      acpi_semaphore_debug = 0;
75 TUNABLE_INT("debug.acpi_semaphore_debug", &acpi_semaphore_debug);
76 SYSCTL_DECL(_debug_acpi);
77 SYSCTL_INT(_debug_acpi, OID_AUTO, semaphore_debug, CTLFLAG_RW,
78            &acpi_semaphore_debug, 0, "Enable ACPI semaphore debug messages");
79 #endif /* !ACPI_NO_SEMAPHORES */
80
81 ACPI_STATUS
82 AcpiOsCreateSemaphore(UINT32 MaxUnits, UINT32 InitialUnits,
83     ACPI_HANDLE *OutHandle)
84 {
85 #ifndef ACPI_NO_SEMAPHORES
86     struct acpi_semaphore       *as;
87
88     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
89
90     if (OutHandle == NULL)
91         return_ACPI_STATUS (AE_BAD_PARAMETER);
92     if (InitialUnits > MaxUnits)
93         return_ACPI_STATUS (AE_BAD_PARAMETER);
94
95     as = kmalloc(sizeof(*as), M_ACPISEM, M_INTWAIT | M_ZERO);
96
97     spin_init(&as->as_spin);
98     as->as_units = InitialUnits;
99     as->as_maxunits = MaxUnits;
100     as->as_pendings = as->as_resetting = as->as_timeouts = 0;
101
102     ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
103         "created semaphore %p max %d, initial %d\n", 
104         as, InitialUnits, MaxUnits));
105
106     *OutHandle = (ACPI_HANDLE)as;
107 #else
108     *OutHandle = (ACPI_HANDLE)OutHandle;
109 #endif /* !ACPI_NO_SEMAPHORES */
110
111     return_ACPI_STATUS (AE_OK);
112 }
113
114 ACPI_STATUS
115 AcpiOsDeleteSemaphore(ACPI_HANDLE Handle)
116 {
117 #ifndef ACPI_NO_SEMAPHORES
118     struct acpi_semaphore *as = (struct acpi_semaphore *)Handle;
119
120     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
121
122     ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "destroyed semaphore %p\n", as));
123     spin_uninit(&as->as_spin);
124     kfree(as, M_ACPISEM);
125 #endif /* !ACPI_NO_SEMAPHORES */
126
127     return_ACPI_STATUS (AE_OK);
128 }
129
130 ACPI_STATUS
131 AcpiOsWaitSemaphore(ACPI_HANDLE Handle, UINT32 Units, UINT16 Timeout)
132 {
133 #ifndef ACPI_NO_SEMAPHORES
134     ACPI_STATUS                 result;
135     struct acpi_semaphore       *as = (struct acpi_semaphore *)Handle;
136     int                         rv, tmo;
137     struct timeval              timeouttv, currenttv, timelefttv;
138     AS_LOCK_DECL;
139
140     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
141
142     if (as == NULL)
143         return_ACPI_STATUS (AE_BAD_PARAMETER);
144
145     if (cold)
146         return_ACPI_STATUS (AE_OK);
147
148 #if 0
149     if (as->as_units < Units && as->as_timeouts > 10) {
150         kprintf("%s: semaphore %p too many timeouts, resetting\n", __func__, as);
151         AS_LOCK(as);
152         as->as_units = as->as_maxunits;
153         if (as->as_pendings)
154             as->as_resetting = 1;
155         as->as_timeouts = 0;
156         wakeup(as);
157         AS_UNLOCK(as);
158         return_ACPI_STATUS (AE_TIME);
159     }
160
161     if (as->as_resetting)
162         return_ACPI_STATUS (AE_TIME);
163 #endif
164
165     /* a timeout of ACPI_WAIT_FOREVER means "forever" */
166     if (Timeout == ACPI_WAIT_FOREVER) {
167         tmo = 0;
168         timeouttv.tv_sec = ((0xffff/1000) + 1); /* cf. ACPI spec */
169         timeouttv.tv_usec = 0;
170     } else {
171         /* compute timeout using microseconds per tick */
172         tmo = (Timeout * 1000) / (1000000 / hz);
173         if (tmo <= 0)
174             tmo = 1;
175         timeouttv.tv_sec  = Timeout / 1000;
176         timeouttv.tv_usec = (Timeout % 1000) * 1000;
177     }
178
179     /* calculate timeout value in timeval */
180     getmicrouptime(&currenttv);
181     timevaladd(&timeouttv, &currenttv);
182
183     AS_LOCK(as);
184     ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
185         "get %d units from semaphore %p (has %d), timeout %d\n",
186         Units, as, as->as_units, Timeout));
187     for (;;) {
188         if (as->as_maxunits == ACPI_NO_UNIT_LIMIT) {
189             result = AE_OK;
190             break;
191         }
192         if (as->as_units >= Units) {
193             as->as_units -= Units;
194             result = AE_OK;
195             break;
196         }
197
198         /* limit number of pending treads */
199         if (as->as_pendings >= ACPI_SEMAPHORES_MAX_PENDING) {
200             result = AE_TIME;
201             break;
202         }
203
204         /* if timeout values of zero is specified, return immediately */
205         if (Timeout == 0) {
206             result = AE_TIME;
207             break;
208         }
209
210         ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
211             "semaphore blocked, calling ssleep(%p, %p, %d, \"acsem\", %d)\n",
212             as, &as->as_spin, PCATCH, tmo));
213
214         as->as_pendings++;
215
216         if (acpi_semaphore_debug) {
217             kprintf("%s: Sleep %d, pending %d, semaphore %p, thread %d\n",
218                 __func__, Timeout, as->as_pendings, as, AcpiOsGetThreadId());
219         }
220
221         rv = ssleep(as, &as->as_spin, PCATCH, "acsem", tmo);
222
223         as->as_pendings--;
224
225 #if 0
226         if (as->as_resetting) {
227             /* semaphore reset, return immediately */
228             if (as->as_pendings == 0) {
229                 as->as_resetting = 0;
230             }
231             result = AE_TIME;
232             break;
233         }
234 #endif
235
236         ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "ssleep(%d) returned %d\n", tmo, rv));
237         if (rv == EWOULDBLOCK) {
238             result = AE_TIME;
239             break;
240         }
241
242         /* check if we already awaited enough */
243         timelefttv = timeouttv;
244         getmicrouptime(&currenttv);
245         timevalsub(&timelefttv, &currenttv);
246         if (timelefttv.tv_sec < 0) {
247             ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "await semaphore %p timeout\n",
248                 as));
249             result = AE_TIME;
250             break;
251         }
252
253         /* adjust timeout for the next sleep */
254         tmo = (timelefttv.tv_sec * 1000000 + timelefttv.tv_usec) /
255             (1000000 / hz);
256         if (tmo <= 0)
257             tmo = 1;
258
259         if (acpi_semaphore_debug) {
260             kprintf("%s: Wakeup timeleft(%lu, %lu), tmo %u, sem %p, thread %d\n",
261                 __func__, timelefttv.tv_sec, timelefttv.tv_usec, tmo, as,
262                 AcpiOsGetThreadId());
263         }
264     }
265
266     if (acpi_semaphore_debug) {
267         if (result == AE_TIME && Timeout > 0) {
268             kprintf("%s: Timeout %d, pending %d, semaphore %p\n",
269                 __func__, Timeout, as->as_pendings, as);
270         }
271         if (result == AE_OK && (as->as_timeouts > 0 || as->as_pendings > 0)) {
272             kprintf("%s: Acquire %d, units %d, pending %d, sem %p, thread %d\n",
273                 __func__, Units, as->as_units, as->as_pendings, as,
274                 AcpiOsGetThreadId());
275         }
276     }
277
278     if (result == AE_TIME)
279         as->as_timeouts++;
280     else
281         as->as_timeouts = 0;
282
283     AS_UNLOCK(as);
284     return_ACPI_STATUS (result);
285 #else
286     return_ACPI_STATUS (AE_OK);
287 #endif /* !ACPI_NO_SEMAPHORES */
288 }
289
290 ACPI_STATUS
291 AcpiOsSignalSemaphore(ACPI_HANDLE Handle, UINT32 Units)
292 {
293 #ifndef ACPI_NO_SEMAPHORES
294     struct acpi_semaphore       *as = (struct acpi_semaphore *)Handle;
295     AS_LOCK_DECL;
296
297     ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
298
299     if (as == NULL)
300         return_ACPI_STATUS(AE_BAD_PARAMETER);
301
302     AS_LOCK(as);
303     ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
304         "return %d units to semaphore %p (has %d)\n",
305         Units, as, as->as_units));
306     if (as->as_maxunits != ACPI_NO_UNIT_LIMIT) {
307         as->as_units += Units;
308         if (as->as_units > as->as_maxunits)
309             as->as_units = as->as_maxunits;
310     }
311
312     if (acpi_semaphore_debug && (as->as_timeouts > 0 || as->as_pendings > 0)) {
313         kprintf("%s: Release %d, units %d, pending %d, semaphore %p, thread %d\n",
314             __func__, Units, as->as_units, as->as_pendings, as, AcpiOsGetThreadId());
315     }
316
317     wakeup(as);
318     AS_UNLOCK(as);
319 #endif /* !ACPI_NO_SEMAPHORES */
320
321     return_ACPI_STATUS (AE_OK);
322 }
323
324 struct acpi_spinlock {
325     struct spinlock lock;
326 #ifdef ACPI_DEBUG_LOCKS
327     thread_t    owner;
328     const char *func;
329     int line;
330 #endif
331 };
332
333 ACPI_STATUS
334 AcpiOsCreateLock(ACPI_SPINLOCK *OutHandle)
335 {
336     ACPI_SPINLOCK spin;
337
338     if (OutHandle == NULL)
339         return (AE_BAD_PARAMETER);
340     spin = kmalloc(sizeof(*spin), M_ACPISEM, M_INTWAIT|M_ZERO);
341     spin_init(&spin->lock);
342 #ifdef ACPI_DEBUG_LOCKS
343     spin->owner = NULL;
344     spin->func = "";
345     spin->line = 0;
346 #endif
347     *OutHandle = spin;
348     return (AE_OK);
349 }
350
351 void
352 AcpiOsDeleteLock (ACPI_SPINLOCK Spin)
353 {
354     if (Spin == NULL)
355         return;
356     spin_uninit(&Spin->lock);
357     kfree(Spin, M_ACPISEM);
358 }
359
360 /*
361  * OS-dependent locking primitives.  These routines should be able to be
362  * called from an interrupt-handler or cpu_idle thread.
363  *
364  * NB: some of ACPI-CA functions with locking flags, say AcpiSetRegister(),
365  * are changed to unconditionally call AcpiOsAcquireLock/AcpiOsReleaseLock.
366  */
367 ACPI_CPU_FLAGS
368 #ifdef ACPI_DEBUG_LOCKS
369 _AcpiOsAcquireLock (ACPI_SPINLOCK Spin, const char *func, int line)
370 #else
371 AcpiOsAcquireLock (ACPI_SPINLOCK Spin)
372 #endif
373 {
374     spin_lock_wr(&Spin->lock);
375
376 #ifdef ACPI_DEBUG_LOCKS
377     if (Spin->owner) {
378         kprintf("%p(%s:%d): acpi_spinlock %p already held by %p(%s:%d)\n",
379                 curthread, func, line, Spin, Spin->owner, Spin->func,
380                 Spin->line);
381         print_backtrace();
382     } else {
383         Spin->owner = curthread;
384         Spin->func = func;
385         Spin->line = line;
386     }
387 #endif
388     return(0);
389 }
390
391 void
392 AcpiOsReleaseLock (ACPI_SPINLOCK Spin, ACPI_CPU_FLAGS Flags)
393 {
394 #ifdef ACPI_DEBUG_LOCKS
395     if (Flags) {
396         if (Spin->owner != NULL) {
397             kprintf("%p: acpi_spinlock %p is unexectedly held by %p(%s:%d)\n",
398                     curthread, Spin, Spin->owner, Spin->func, Spin->line);
399             print_backtrace();
400         } else
401             return;
402     }
403     Spin->owner = NULL;
404     Spin->func = "";
405     Spin->line = 0;
406 #endif
407     spin_unlock_wr(&Spin->lock);
408 }
409
410 /* Section 5.2.9.1:  global lock acquire/release functions */
411 #define GL_ACQUIRED     (-1)
412 #define GL_BUSY         0
413 #define GL_BIT_PENDING  0x1
414 #define GL_BIT_OWNED    0x2
415 #define GL_BIT_MASK     (GL_BIT_PENDING | GL_BIT_OWNED)
416
417 /*
418  * Acquire the global lock.  If busy, set the pending bit.  The caller
419  * will wait for notification from the BIOS that the lock is available
420  * and then attempt to acquire it again.
421  */
422 int
423 acpi_acquire_global_lock(uint32_t *lock)
424 {
425         uint32_t new, old;
426
427         do {
428                 old = *lock;
429                 new = ((old & ~GL_BIT_MASK) | GL_BIT_OWNED) |
430                         ((old >> 1) & GL_BIT_PENDING);
431         } while (atomic_cmpset_int(lock, old, new) == 0);
432
433         return ((new < GL_BIT_MASK) ? GL_ACQUIRED : GL_BUSY);
434 }
435
436 /*
437  * Release the global lock, returning whether there is a waiter pending.
438  * If the BIOS set the pending bit, OSPM must notify the BIOS when it
439  * releases the lock.
440  */
441 int
442 acpi_release_global_lock(uint32_t *lock)
443 {
444         uint32_t new, old;
445
446         do {
447                 old = *lock;
448                 new = old & ~GL_BIT_MASK;
449         } while (atomic_cmpset_int(lock, old, new) == 0);
450
451         return (old & GL_BIT_PENDING);
452 }