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) {
191 tmo = timeout2hz(Timeout);
192 while (!ACPISEM_AVAIL(as, Units)) {
195 error = cv_timedwait_sig(&as->as_cv, &as->as_lock, tmo);
197 if (error == EINTR || as->as_reset) {
201 if (ACPISEM_AVAIL(as, Units))
203 slptick = ticks - prevtick;
204 if (slptick >= tmo || slptick < 0) {
211 if (ACPI_SUCCESS(status))
212 as->as_units -= Units;
214 mtx_unlock(&as->as_lock);
216 return_ACPI_STATUS (status);
220 AcpiOsSignalSemaphore(ACPI_SEMAPHORE Handle, UINT32 Units)
222 struct acpi_sema *as = (struct acpi_sema *)Handle;
225 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
227 if (as == NULL || Units == 0)
228 return_ACPI_STATUS (AE_BAD_PARAMETER);
230 mtx_lock(&as->as_lock);
232 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
233 "return %u units to %s, units %u, waiters %d\n",
234 Units, as->as_name, as->as_units, as->as_waiters));
236 if (as->as_maxunits != ACPI_NO_UNIT_LIMIT &&
237 (as->as_maxunits < Units ||
238 as->as_maxunits - Units < as->as_units)) {
239 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
240 "exceeded max units %u\n", as->as_maxunits));
241 mtx_unlock(&as->as_lock);
242 return_ACPI_STATUS (AE_LIMIT);
245 as->as_units += Units;
246 if (as->as_waiters > 0 && ACPISEM_AVAIL(as, Units))
247 for (i = 0; i < Units; i++)
248 cv_signal(&as->as_cv);
250 mtx_unlock(&as->as_lock);
252 return_ACPI_STATUS (AE_OK);
263 struct thread *am_owner;
270 AcpiOsCreateMutex(ACPI_MUTEX *OutHandle)
272 struct acpi_mutex *am;
274 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
276 if (OutHandle == NULL)
277 return_ACPI_STATUS (AE_BAD_PARAMETER);
279 if ((am = malloc(sizeof(*am), M_ACPISEM, M_NOWAIT | M_ZERO)) == NULL)
280 return_ACPI_STATUS (AE_NO_MEMORY);
282 snprintf(am->am_name, sizeof(am->am_name), "ACPI mutex (%p)", am);
283 mtx_init(&am->am_lock, am->am_name, NULL, MTX_DEF);
285 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "created %s\n", am->am_name));
287 *OutHandle = (ACPI_MUTEX)am;
289 return_ACPI_STATUS (AE_OK);
292 #define ACPIMTX_AVAIL(m) ((m)->am_owner == NULL)
293 #define ACPIMTX_OWNED(m) ((m)->am_owner == curthread)
296 AcpiOsDeleteMutex(ACPI_MUTEX Handle)
298 struct acpi_mutex *am = (struct acpi_mutex *)Handle;
300 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
303 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "cannot delete null mutex\n"));
307 mtx_lock(&am->am_lock);
309 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "delete %s\n", am->am_name));
311 if (am->am_waiters > 0) {
312 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
313 "reset %s, owner %p\n", am->am_name, am->am_owner));
316 while (am->am_waiters > 0) {
317 if (mtx_sleep(&am->am_reset, &am->am_lock,
318 PCATCH, "acmrst", hz) == EINTR) {
319 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
320 "failed to reset %s, waiters %d\n",
321 am->am_name, am->am_waiters));
322 mtx_unlock(&am->am_lock);
325 if (ACPIMTX_AVAIL(am))
326 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
327 "wait %s, waiters %d\n",
328 am->am_name, am->am_waiters));
330 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
331 "wait %s, owner %p, waiters %d\n",
332 am->am_name, am->am_owner, am->am_waiters));
336 mtx_unlock(&am->am_lock);
338 mtx_destroy(&am->am_lock);
343 AcpiOsAcquireMutex(ACPI_MUTEX Handle, UINT16 Timeout)
345 struct acpi_mutex *am = (struct acpi_mutex *)Handle;
346 int error, prevtick, slptick, tmo;
347 ACPI_STATUS status = AE_OK;
349 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
352 return_ACPI_STATUS (AE_BAD_PARAMETER);
354 mtx_lock(&am->am_lock);
356 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "acquire %s\n", am->am_name));
358 if (ACPIMTX_OWNED(am)) {
360 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
361 "acquire nested %s, depth %d\n",
362 am->am_name, am->am_nested));
363 mtx_unlock(&am->am_lock);
364 return_ACPI_STATUS (AE_OK);
368 case ACPI_DO_NOT_WAIT:
369 if (!ACPIMTX_AVAIL(am))
372 case ACPI_WAIT_FOREVER:
373 while (!ACPIMTX_AVAIL(am)) {
375 error = mtx_sleep(am, &am->am_lock, PCATCH, "acmtx", 0);
377 if (error == EINTR || am->am_reset) {
384 tmo = timeout2hz(Timeout);
385 while (!ACPIMTX_AVAIL(am)) {
388 error = mtx_sleep(am, &am->am_lock, PCATCH,
391 if (error == EINTR || am->am_reset) {
395 if (ACPIMTX_AVAIL(am))
397 slptick = ticks - prevtick;
398 if (slptick >= tmo || slptick < 0) {
405 if (ACPI_SUCCESS(status))
406 am->am_owner = curthread;
408 mtx_unlock(&am->am_lock);
410 return_ACPI_STATUS (status);
414 AcpiOsReleaseMutex(ACPI_MUTEX Handle)
416 struct acpi_mutex *am = (struct acpi_mutex *)Handle;
418 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
421 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
422 "cannot release null mutex\n"));
426 mtx_lock(&am->am_lock);
428 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "release %s\n", am->am_name));
430 if (ACPIMTX_OWNED(am)) {
431 if (am->am_nested > 0) {
432 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
433 "release nested %s, depth %d\n",
434 am->am_name, am->am_nested));
439 if (ACPIMTX_AVAIL(am))
440 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
441 "release already available %s\n", am->am_name));
443 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
444 "release unowned %s from %p, depth %d\n",
445 am->am_name, am->am_owner, am->am_nested));
447 if (am->am_waiters > 0 && ACPIMTX_AVAIL(am))
450 mtx_unlock(&am->am_lock);
459 struct acpi_spinlock {
466 AcpiOsCreateLock(ACPI_SPINLOCK *OutHandle)
468 struct acpi_spinlock *al;
470 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
472 if (OutHandle == NULL)
473 return_ACPI_STATUS (AE_BAD_PARAMETER);
475 if ((al = malloc(sizeof(*al), M_ACPISEM, M_NOWAIT | M_ZERO)) == NULL)
476 return_ACPI_STATUS (AE_NO_MEMORY);
479 if (OutHandle == &AcpiGbl_GpeLock)
480 snprintf(al->al_name, sizeof(al->al_name), "ACPI lock (GPE)");
481 else if (OutHandle == &AcpiGbl_HardwareLock)
482 snprintf(al->al_name, sizeof(al->al_name), "ACPI lock (HW)");
485 snprintf(al->al_name, sizeof(al->al_name), "ACPI lock (%p)", al);
486 mtx_init(&al->al_lock, al->al_name, NULL, MTX_SPIN);
488 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "created %s\n", al->al_name));
490 *OutHandle = (ACPI_SPINLOCK)al;
492 return_ACPI_STATUS (AE_OK);
496 AcpiOsDeleteLock(ACPI_SPINLOCK Handle)
498 struct acpi_spinlock *al = (struct acpi_spinlock *)Handle;
500 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
503 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
504 "cannot delete null spinlock\n"));
508 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "delete %s\n", al->al_name));
510 mtx_destroy(&al->al_lock);
515 AcpiOsAcquireLock(ACPI_SPINLOCK Handle)
517 struct acpi_spinlock *al = (struct acpi_spinlock *)Handle;
519 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
522 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
523 "cannot acquire null spinlock\n"));
527 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "acquire %s\n", al->al_name));
529 if (mtx_owned(&al->al_lock)) {
531 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
532 "acquire nested %s, depth %d\n",
533 al->al_name, al->al_nested));
535 mtx_lock_spin(&al->al_lock);
541 AcpiOsReleaseLock(ACPI_SPINLOCK Handle, ACPI_CPU_FLAGS Flags)
543 struct acpi_spinlock *al = (struct acpi_spinlock *)Handle;
545 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__);
548 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
549 "cannot release null spinlock\n"));
553 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "release %s\n", al->al_name));
555 if (mtx_owned(&al->al_lock)) {
556 if (al->al_nested > 0) {
557 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
558 "release nested %s, depth %d\n",
559 al->al_name, al->al_nested));
562 mtx_unlock_spin(&al->al_lock);
564 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX,
565 "cannot release unowned %s\n", al->al_name));
568 /* Section 5.2.10.1: global lock acquire/release functions */
571 * Acquire the global lock. If busy, set the pending bit. The caller
572 * will wait for notification from the BIOS that the lock is available
573 * and then attempt to acquire it again.
576 acpi_acquire_global_lock(volatile uint32_t *lock)
582 new = (old & ~ACPI_GLOCK_PENDING) | ACPI_GLOCK_OWNED;
583 if ((old & ACPI_GLOCK_OWNED) != 0)
584 new |= ACPI_GLOCK_PENDING;
585 } while (atomic_cmpset_32(lock, old, new) == 0);
587 return ((new & ACPI_GLOCK_PENDING) == 0);
591 * Release the global lock, returning whether there is a waiter pending.
592 * If the BIOS set the pending bit, OSPM must notify the BIOS when it
596 acpi_release_global_lock(volatile uint32_t *lock)
602 new = old & ~(ACPI_GLOCK_PENDING | ACPI_GLOCK_OWNED);
603 } while (atomic_cmpset_32(lock, old, new) == 0);
605 return ((old & ACPI_GLOCK_PENDING) != 0);