2 * Copyright (c) 2000 Michael Smith
3 * Copyright (c) 2000 BSDi
4 * Copyright (c) 2007-2009 Jung-uk Kim <jkim@FreeBSD.org>
7 * Redistribution and use in source and binary forms, with or without
8 * modification, are permitted provided that the following conditions
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.
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
30 * 6.1 : Mutual Exclusion and Synchronisation
33 #include <sys/cdefs.h>
34 __FBSDID("$FreeBSD$");
36 #include <contrib/dev/acpica/include/acpi.h>
37 #include <contrib/dev/acpica/include/accommon.h>
39 #include <sys/condvar.h>
40 #include <sys/kernel.h>
42 #include <sys/malloc.h>
43 #include <sys/mutex.h>
45 #define _COMPONENT ACPI_OS_SERVICES
46 ACPI_MODULE_NAME("SYNCH")
48 static MALLOC_DEFINE(M_ACPISEM, "acpisem", "ACPI semaphore");
51 * Convert milliseconds to ticks.
54 timeout2hz(UINT16 Timeout)
58 tv.tv_sec = (time_t)(Timeout / 1000);
59 tv.tv_usec = (suseconds_t)(Timeout % 1000) * 1000;
78 AcpiOsCreateSemaphore(UINT32 MaxUnits, UINT32 InitialUnits,
79 ACPI_SEMAPHORE *OutHandle)
83 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
85 if (OutHandle == NULL || MaxUnits == 0 || InitialUnits > MaxUnits)
86 return_ACPI_STATUS (AE_BAD_PARAMETER);
88 if ((as = malloc(sizeof(*as), M_ACPISEM, M_NOWAIT | M_ZERO)) == NULL)
89 return_ACPI_STATUS (AE_NO_MEMORY);
91 snprintf(as->as_name, sizeof(as->as_name), "ACPI sema (%p)", as);
92 mtx_init(&as->as_lock, as->as_name, NULL, MTX_DEF);
93 cv_init(&as->as_cv, as->as_name);
94 as->as_maxunits = MaxUnits;
95 as->as_units = InitialUnits;
97 *OutHandle = (ACPI_SEMAPHORE)as;
99 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "created %s, max %u, initial %u\n",
100 as->as_name, MaxUnits, InitialUnits));
102 return_ACPI_STATUS (AE_OK);
106 AcpiOsDeleteSemaphore(ACPI_SEMAPHORE Handle)
108 struct acpi_sema *as = (struct acpi_sema *)Handle;
110 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
113 return_ACPI_STATUS (AE_BAD_PARAMETER);
115 mtx_lock(&as->as_lock);
117 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "delete %s\n", as->as_name));
119 if (as->as_waiters > 0) {
120 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
121 "reset %s, units %u, waiters %d\n",
122 as->as_name, as->as_units, as->as_waiters));
124 cv_broadcast(&as->as_cv);
125 while (as->as_waiters > 0) {
126 if (mtx_sleep(&as->as_reset, &as->as_lock,
127 PCATCH, "acsrst", hz) == EINTR) {
128 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
129 "failed to reset %s, waiters %d\n",
130 as->as_name, as->as_waiters));
131 mtx_unlock(&as->as_lock);
132 return_ACPI_STATUS (AE_ERROR);
134 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
135 "wait %s, units %u, waiters %d\n",
136 as->as_name, as->as_units, as->as_waiters));
140 mtx_unlock(&as->as_lock);
142 mtx_destroy(&as->as_lock);
143 cv_destroy(&as->as_cv);
146 return_ACPI_STATUS (AE_OK);
149 #define ACPISEM_AVAIL(s, u) ((s)->as_units >= (u))
152 AcpiOsWaitSemaphore(ACPI_SEMAPHORE Handle, UINT32 Units, UINT16 Timeout)
154 struct acpi_sema *as = (struct acpi_sema *)Handle;
155 int error, prevtick, slptick, tmo;
156 ACPI_STATUS status = AE_OK;
158 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
160 if (as == NULL || Units == 0)
161 return_ACPI_STATUS (AE_BAD_PARAMETER);
163 mtx_lock(&as->as_lock);
165 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
166 "get %u unit(s) from %s, units %u, waiters %d, timeout %u\n",
167 Units, as->as_name, as->as_units, as->as_waiters, Timeout));
169 if (as->as_maxunits != ACPI_NO_UNIT_LIMIT && as->as_maxunits < Units) {
170 mtx_unlock(&as->as_lock);
171 return_ACPI_STATUS (AE_LIMIT);
175 case ACPI_DO_NOT_WAIT:
176 if (!ACPISEM_AVAIL(as, Units))
179 case ACPI_WAIT_FOREVER:
180 while (!ACPISEM_AVAIL(as, Units)) {
182 error = cv_wait_sig(&as->as_cv, &as->as_lock);
184 if (error == EINTR || as->as_reset) {
193 * Just spin polling the semaphore once a
196 while (!ACPISEM_AVAIL(as, Units)) {
202 mtx_unlock(&as->as_lock);
204 mtx_lock(&as->as_lock);
208 tmo = timeout2hz(Timeout);
209 while (!ACPISEM_AVAIL(as, Units)) {
212 error = cv_timedwait_sig(&as->as_cv, &as->as_lock, tmo);
214 if (error == EINTR || as->as_reset) {
218 if (ACPISEM_AVAIL(as, Units))
220 slptick = ticks - prevtick;
221 if (slptick >= tmo || slptick < 0) {
229 as->as_units -= Units;
231 mtx_unlock(&as->as_lock);
233 return_ACPI_STATUS (status);
237 AcpiOsSignalSemaphore(ACPI_SEMAPHORE Handle, UINT32 Units)
239 struct acpi_sema *as = (struct acpi_sema *)Handle;
242 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
244 if (as == NULL || Units == 0)
245 return_ACPI_STATUS (AE_BAD_PARAMETER);
247 mtx_lock(&as->as_lock);
249 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
250 "return %u units to %s, units %u, waiters %d\n",
251 Units, as->as_name, as->as_units, as->as_waiters));
253 if (as->as_maxunits != ACPI_NO_UNIT_LIMIT &&
254 (as->as_maxunits < Units ||
255 as->as_maxunits - Units < as->as_units)) {
256 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
257 "exceeded max units %u\n", as->as_maxunits));
258 mtx_unlock(&as->as_lock);
259 return_ACPI_STATUS (AE_LIMIT);
262 as->as_units += Units;
263 if (as->as_waiters > 0 && ACPISEM_AVAIL(as, Units))
264 for (i = 0; i < Units; i++)
265 cv_signal(&as->as_cv);
267 mtx_unlock(&as->as_lock);
269 return_ACPI_STATUS (AE_OK);
280 struct thread *am_owner;
287 AcpiOsCreateMutex(ACPI_MUTEX *OutHandle)
289 struct acpi_mutex *am;
291 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
293 if (OutHandle == NULL)
294 return_ACPI_STATUS (AE_BAD_PARAMETER);
296 if ((am = malloc(sizeof(*am), M_ACPISEM, M_NOWAIT | M_ZERO)) == NULL)
297 return_ACPI_STATUS (AE_NO_MEMORY);
299 snprintf(am->am_name, sizeof(am->am_name), "ACPI mutex (%p)", am);
300 mtx_init(&am->am_lock, am->am_name, NULL, MTX_DEF);
302 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "created %s\n", am->am_name));
304 *OutHandle = (ACPI_MUTEX)am;
306 return_ACPI_STATUS (AE_OK);
309 #define ACPIMTX_AVAIL(m) ((m)->am_owner == NULL)
310 #define ACPIMTX_OWNED(m) ((m)->am_owner == curthread)
313 AcpiOsDeleteMutex(ACPI_MUTEX Handle)
315 struct acpi_mutex *am = (struct acpi_mutex *)Handle;
317 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
320 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "cannot delete null mutex\n"));
324 mtx_lock(&am->am_lock);
326 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "delete %s\n", am->am_name));
328 if (am->am_waiters > 0) {
329 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
330 "reset %s, owner %p\n", am->am_name, am->am_owner));
333 while (am->am_waiters > 0) {
334 if (mtx_sleep(&am->am_reset, &am->am_lock,
335 PCATCH, "acmrst", hz) == EINTR) {
336 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
337 "failed to reset %s, waiters %d\n",
338 am->am_name, am->am_waiters));
339 mtx_unlock(&am->am_lock);
342 if (ACPIMTX_AVAIL(am))
343 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
344 "wait %s, waiters %d\n",
345 am->am_name, am->am_waiters));
347 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
348 "wait %s, owner %p, waiters %d\n",
349 am->am_name, am->am_owner, am->am_waiters));
353 mtx_unlock(&am->am_lock);
355 mtx_destroy(&am->am_lock);
360 AcpiOsAcquireMutex(ACPI_MUTEX Handle, UINT16 Timeout)
362 struct acpi_mutex *am = (struct acpi_mutex *)Handle;
363 int error, prevtick, slptick, tmo;
364 ACPI_STATUS status = AE_OK;
366 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
369 return_ACPI_STATUS (AE_BAD_PARAMETER);
371 mtx_lock(&am->am_lock);
373 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "acquire %s\n", am->am_name));
375 if (ACPIMTX_OWNED(am)) {
377 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
378 "acquire nested %s, depth %d\n",
379 am->am_name, am->am_nested));
380 mtx_unlock(&am->am_lock);
381 return_ACPI_STATUS (AE_OK);
385 case ACPI_DO_NOT_WAIT:
386 if (!ACPIMTX_AVAIL(am))
389 case ACPI_WAIT_FOREVER:
390 while (!ACPIMTX_AVAIL(am)) {
392 error = mtx_sleep(am, &am->am_lock, PCATCH, "acmtx", 0);
394 if (error == EINTR || am->am_reset) {
403 * Just spin polling the mutex once a
406 while (!ACPIMTX_AVAIL(am)) {
412 mtx_unlock(&am->am_lock);
414 mtx_lock(&am->am_lock);
418 tmo = timeout2hz(Timeout);
419 while (!ACPIMTX_AVAIL(am)) {
422 error = mtx_sleep(am, &am->am_lock, PCATCH,
425 if (error == EINTR || am->am_reset) {
429 if (ACPIMTX_AVAIL(am))
431 slptick = ticks - prevtick;
432 if (slptick >= tmo || slptick < 0) {
440 am->am_owner = curthread;
442 mtx_unlock(&am->am_lock);
444 return_ACPI_STATUS (status);
448 AcpiOsReleaseMutex(ACPI_MUTEX Handle)
450 struct acpi_mutex *am = (struct acpi_mutex *)Handle;
452 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
455 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
456 "cannot release null mutex\n"));
460 mtx_lock(&am->am_lock);
462 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "release %s\n", am->am_name));
464 if (ACPIMTX_OWNED(am)) {
465 if (am->am_nested > 0) {
466 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
467 "release nested %s, depth %d\n",
468 am->am_name, am->am_nested));
473 if (ACPIMTX_AVAIL(am))
474 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
475 "release already available %s\n", am->am_name));
477 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
478 "release unowned %s from %p, depth %d\n",
479 am->am_name, am->am_owner, am->am_nested));
481 if (am->am_waiters > 0 && ACPIMTX_AVAIL(am))
484 mtx_unlock(&am->am_lock);
493 struct acpi_spinlock {
500 AcpiOsCreateLock(ACPI_SPINLOCK *OutHandle)
502 struct acpi_spinlock *al;
504 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
506 if (OutHandle == NULL)
507 return_ACPI_STATUS (AE_BAD_PARAMETER);
509 if ((al = malloc(sizeof(*al), M_ACPISEM, M_NOWAIT | M_ZERO)) == NULL)
510 return_ACPI_STATUS (AE_NO_MEMORY);
513 if (OutHandle == &AcpiGbl_GpeLock)
514 snprintf(al->al_name, sizeof(al->al_name), "ACPI lock (GPE)");
515 else if (OutHandle == &AcpiGbl_HardwareLock)
516 snprintf(al->al_name, sizeof(al->al_name), "ACPI lock (HW)");
519 snprintf(al->al_name, sizeof(al->al_name), "ACPI lock (%p)", al);
520 mtx_init(&al->al_lock, al->al_name, NULL, MTX_SPIN);
522 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "created %s\n", al->al_name));
524 *OutHandle = (ACPI_SPINLOCK)al;
526 return_ACPI_STATUS (AE_OK);
530 AcpiOsDeleteLock(ACPI_SPINLOCK Handle)
532 struct acpi_spinlock *al = (struct acpi_spinlock *)Handle;
534 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
537 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
538 "cannot delete null spinlock\n"));
542 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "delete %s\n", al->al_name));
544 mtx_destroy(&al->al_lock);
549 AcpiOsAcquireLock(ACPI_SPINLOCK Handle)
551 struct acpi_spinlock *al = (struct acpi_spinlock *)Handle;
553 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
556 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
557 "cannot acquire null spinlock\n"));
561 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "acquire %s\n", al->al_name));
563 if (mtx_owned(&al->al_lock)) {
565 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
566 "acquire nested %s, depth %d\n",
567 al->al_name, al->al_nested));
569 mtx_lock_spin(&al->al_lock);
575 AcpiOsReleaseLock(ACPI_SPINLOCK Handle, ACPI_CPU_FLAGS Flags)
577 struct acpi_spinlock *al = (struct acpi_spinlock *)Handle;
579 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
582 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
583 "cannot release null spinlock\n"));
587 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "release %s\n", al->al_name));
589 if (mtx_owned(&al->al_lock)) {
590 if (al->al_nested > 0) {
591 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
592 "release nested %s, depth %d\n",
593 al->al_name, al->al_nested));
596 mtx_unlock_spin(&al->al_lock);
598 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
599 "cannot release unowned %s\n", al->al_name));
602 /* Section 5.2.10.1: global lock acquire/release functions */
603 #define GL_BIT_PENDING 0x01
604 #define GL_BIT_OWNED 0x02
607 * Acquire the global lock. If busy, set the pending bit. The caller
608 * will wait for notification from the BIOS that the lock is available
609 * and then attempt to acquire it again.
612 acpi_acquire_global_lock(uint32_t *lock)
618 new = (old & ~GL_BIT_PENDING) | GL_BIT_OWNED;
619 if ((old & GL_BIT_OWNED) != 0)
620 new |= GL_BIT_PENDING;
621 } while (atomic_cmpset_acq_int(lock, old, new) == 0);
623 return ((new & GL_BIT_PENDING) == 0);
627 * Release the global lock, returning whether there is a waiter pending.
628 * If the BIOS set the pending bit, OSPM must notify the BIOS when it
632 acpi_release_global_lock(uint32_t *lock)
638 new = old & ~(GL_BIT_PENDING | GL_BIT_OWNED);
639 } while (atomic_cmpset_rel_int(lock, old, new) == 0);
641 return ((old & GL_BIT_PENDING) != 0);