OsdSynch.c revision 128227
1279264Sdelphij/*- 2238405Sjkim * Copyright (c) 2000 Michael Smith 3238405Sjkim * Copyright (c) 2000 BSDi 4238405Sjkim * All rights reserved. 5238405Sjkim * 6238405Sjkim * Redistribution and use in source and binary forms, with or without 7238405Sjkim * modification, are permitted provided that the following conditions 8238405Sjkim * are met: 9238405Sjkim * 1. Redistributions of source code must retain the above copyright 10238405Sjkim * notice, this list of conditions and the following disclaimer. 11238405Sjkim * 2. Redistributions in binary form must reproduce the above copyright 12238405Sjkim * notice, this list of conditions and the following disclaimer in the 13238405Sjkim * documentation and/or other materials provided with the distribution. 14238405Sjkim * 15238405Sjkim * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16238405Sjkim * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17238405Sjkim * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18238405Sjkim * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19238405Sjkim * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20238405Sjkim * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21238405Sjkim * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22238405Sjkim * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23238405Sjkim * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24238405Sjkim * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25238405Sjkim * SUCH DAMAGE. 26238405Sjkim * 27238405Sjkim * $FreeBSD: head/sys/dev/acpica/Osd/OsdSynch.c 128227 2004-04-14 03:43:06Z njl $ 28238405Sjkim */ 29238405Sjkim 30238405Sjkim/* 31238405Sjkim * 6.1 : Mutual Exclusion and Synchronisation 32238405Sjkim */ 33238405Sjkim 34238405Sjkim#include "acpi.h" 35238405Sjkim 36238405Sjkim#include "opt_acpi.h" 37238405Sjkim#include <sys/kernel.h> 38238405Sjkim#include <sys/malloc.h> 39238405Sjkim#include <sys/sysctl.h> 40238405Sjkim#if __FreeBSD_version >= 500000 41279264Sdelphij#include <sys/lock.h> 42279264Sdelphij#include <sys/mutex.h> 43238405Sjkim#endif 44238405Sjkim 45238405Sjkim#define _COMPONENT ACPI_OS_SERVICES 46238405SjkimACPI_MODULE_NAME("SYNCH") 47238405Sjkim 48238405SjkimMALLOC_DEFINE(M_ACPISEM, "acpisem", "ACPI semaphore"); 49238405Sjkim 50238405Sjkim#if __FreeBSD_version < 500000 51238405Sjkim# define AS_LOCK(as) s = splhigh() 52238405Sjkim# define AS_UNLOCK(as) splx(s) 53279264Sdelphij# define AS_LOCK_DECL int s 54279264Sdelphij# define msleep(a, b, c, d, e) tsleep(a, c, d, e) 55279264Sdelphij#else 56238405Sjkim# define AS_LOCK(as) mtx_lock(&(as)->as_mtx) 57279264Sdelphij# define AS_UNLOCK(as) mtx_unlock(&(as)->as_mtx) 58279264Sdelphij# define AS_LOCK_DECL 59279264Sdelphij#endif 60279264Sdelphij 61279264Sdelphij/* 62279264Sdelphij * Simple counting semaphore implemented using a mutex. (Subsequently used 63238405Sjkim * in the OSI code to implement a mutex. Go figure.) 64279264Sdelphij */ 65279264Sdelphijstruct acpi_semaphore { 66279264Sdelphij#if __FreeBSD_version >= 500000 67279264Sdelphij struct mtx as_mtx; 68279264Sdelphij#endif 69238405Sjkim UINT32 as_units; 70279264Sdelphij UINT32 as_maxunits; 71238405Sjkim UINT32 as_pendings; 72238405Sjkim UINT32 as_resetting; 73238405Sjkim UINT32 as_timeouts; 74238405Sjkim}; 75238405Sjkim 76238405Sjkim#ifndef ACPI_NO_SEMAPHORES 77238405Sjkim#ifndef ACPI_SEMAPHORES_MAX_PENDING 78238405Sjkim#define ACPI_SEMAPHORES_MAX_PENDING 4 79238405Sjkim#endif 80238405Sjkimstatic int acpi_semaphore_debug = 0; 81238405SjkimTUNABLE_INT("debug.acpi_semaphore_debug", &acpi_semaphore_debug); 82238405SjkimSYSCTL_DECL(_debug_acpi); 83238405SjkimSYSCTL_INT(_debug_acpi, OID_AUTO, semaphore_debug, CTLFLAG_RW, 84238405Sjkim &acpi_semaphore_debug, 0, "Enable ACPI semaphore debug messages"); 85238405Sjkim#endif /* !ACPI_NO_SEMAPHORES */ 86238405Sjkim 87238405SjkimACPI_STATUS 88238405SjkimAcpiOsCreateSemaphore(UINT32 MaxUnits, UINT32 InitialUnits, 89238405Sjkim ACPI_HANDLE *OutHandle) 90238405Sjkim{ 91238405Sjkim#ifndef ACPI_NO_SEMAPHORES 92238405Sjkim struct acpi_semaphore *as; 93238405Sjkim 94238405Sjkim ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 95238405Sjkim 96238405Sjkim if (OutHandle == NULL) 97238405Sjkim return_ACPI_STATUS (AE_BAD_PARAMETER); 98238405Sjkim if (InitialUnits > MaxUnits) 99238405Sjkim return_ACPI_STATUS (AE_BAD_PARAMETER); 100238405Sjkim 101238405Sjkim if ((as = malloc(sizeof(*as), M_ACPISEM, M_NOWAIT | M_ZERO)) == NULL) 102238405Sjkim return_ACPI_STATUS (AE_NO_MEMORY); 103238405Sjkim 104238405Sjkim#if __FreeBSD_version >= 500000 105238405Sjkim mtx_init(&as->as_mtx, "ACPI semaphore", NULL, MTX_DEF); 106238405Sjkim#endif 107238405Sjkim as->as_units = InitialUnits; 108238405Sjkim as->as_maxunits = MaxUnits; 109238405Sjkim as->as_pendings = as->as_resetting = as->as_timeouts = 0; 110238405Sjkim 111238405Sjkim ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, 112238405Sjkim "created semaphore %p max %d, initial %d\n", 113238405Sjkim as, InitialUnits, MaxUnits)); 114238405Sjkim 115238405Sjkim *OutHandle = (ACPI_HANDLE)as; 116238405Sjkim#else 117238405Sjkim *OutHandle = (ACPI_HANDLE)OutHandle; 118238405Sjkim#endif /* !ACPI_NO_SEMAPHORES */ 119238405Sjkim 120238405Sjkim return_ACPI_STATUS (AE_OK); 121238405Sjkim} 122238405Sjkim 123238405SjkimACPI_STATUS 124238405SjkimAcpiOsDeleteSemaphore(ACPI_HANDLE Handle) 125238405Sjkim{ 126238405Sjkim#ifndef ACPI_NO_SEMAPHORES 127238405Sjkim struct acpi_semaphore *as = (struct acpi_semaphore *)Handle; 128238405Sjkim 129238405Sjkim ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 130238405Sjkim 131238405Sjkim ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "destroyed semaphore %p\n", as)); 132238405Sjkim#if __FreeBSD_version >= 500000 133238405Sjkim mtx_destroy(&as->as_mtx); 134238405Sjkim#endif 135238405Sjkim free(Handle, M_ACPISEM); 136279264Sdelphij#endif /* !ACPI_NO_SEMAPHORES */ 137238405Sjkim 138238405Sjkim return_ACPI_STATUS (AE_OK); 139238405Sjkim} 140238405Sjkim 141238405Sjkim/* 142238405Sjkim * This implementation has a bug, in that it has to stall for the entire 143238405Sjkim * timeout before it will return AE_TIME. A better implementation would 144238405Sjkim * use getmicrotime() to correctly adjust the timeout after being woken up. 145238405Sjkim */ 146238405SjkimACPI_STATUS 147238405SjkimAcpiOsWaitSemaphore(ACPI_HANDLE Handle, UINT32 Units, UINT16 Timeout) 148238405Sjkim{ 149238405Sjkim#ifndef ACPI_NO_SEMAPHORES 150238405Sjkim ACPI_STATUS result; 151238405Sjkim struct acpi_semaphore *as = (struct acpi_semaphore *)Handle; 152238405Sjkim int rv, tmo; 153238405Sjkim struct timeval timeouttv, currenttv, timelefttv; 154238405Sjkim AS_LOCK_DECL; 155238405Sjkim 156238405Sjkim ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 157238405Sjkim 158238405Sjkim if (as == NULL) 159238405Sjkim return_ACPI_STATUS (AE_BAD_PARAMETER); 160279264Sdelphij 161238405Sjkim if (cold) 162238405Sjkim return_ACPI_STATUS (AE_OK); 163238405Sjkim 164238405Sjkim#if 0 165238405Sjkim if (as->as_units < Units && as->as_timeouts > 10) { 166238405Sjkim printf("%s: semaphore %p too many timeouts, resetting\n", __func__, as); 167238405Sjkim AS_LOCK(as); 168238405Sjkim as->as_units = as->as_maxunits; 169238405Sjkim if (as->as_pendings) 170238405Sjkim as->as_resetting = 1; 171238405Sjkim as->as_timeouts = 0; 172238405Sjkim wakeup(as); 173238405Sjkim AS_UNLOCK(as); 174238405Sjkim return_ACPI_STATUS (AE_TIME); 175238405Sjkim } 176238405Sjkim 177238405Sjkim if (as->as_resetting) 178238405Sjkim return_ACPI_STATUS (AE_TIME); 179238405Sjkim#endif 180238405Sjkim 181238405Sjkim /* a timeout of ACPI_WAIT_FOREVER means "forever" */ 182238405Sjkim if (Timeout == ACPI_WAIT_FOREVER) { 183238405Sjkim tmo = 0; 184238405Sjkim timeouttv.tv_sec = ((0xffff/1000) + 1); /* cf. ACPI spec */ 185238405Sjkim timeouttv.tv_usec = 0; 186238405Sjkim } else { 187238405Sjkim /* compute timeout using microseconds per tick */ 188238405Sjkim tmo = (Timeout * 1000) / (1000000 / hz); 189238405Sjkim if (tmo <= 0) 190238405Sjkim tmo = 1; 191238405Sjkim timeouttv.tv_sec = Timeout / 1000; 192238405Sjkim timeouttv.tv_usec = (Timeout % 1000) * 1000; 193238405Sjkim } 194238405Sjkim 195279264Sdelphij /* calculate timeout value in timeval */ 196279264Sdelphij getmicrotime(¤ttv); 197279264Sdelphij timevaladd(&timeouttv, ¤ttv); 198238405Sjkim 199238405Sjkim AS_LOCK(as); 200238405Sjkim ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, 201238405Sjkim "get %d units from semaphore %p (has %d), timeout %d\n", 202238405Sjkim Units, as, as->as_units, Timeout)); 203238405Sjkim for (;;) { 204238405Sjkim if (as->as_maxunits == ACPI_NO_UNIT_LIMIT) { 205238405Sjkim result = AE_OK; 206238405Sjkim break; 207238405Sjkim } 208238405Sjkim if (as->as_units >= Units) { 209238405Sjkim as->as_units -= Units; 210238405Sjkim result = AE_OK; 211238405Sjkim break; 212238405Sjkim } 213238405Sjkim 214238405Sjkim /* limit number of pending treads */ 215238405Sjkim if (as->as_pendings >= ACPI_SEMAPHORES_MAX_PENDING) { 216238405Sjkim result = AE_TIME; 217238405Sjkim break; 218238405Sjkim } 219238405Sjkim 220238405Sjkim /* if timeout values of zero is specified, return immediately */ 221238405Sjkim if (Timeout == 0) { 222279264Sdelphij result = AE_TIME; 223238405Sjkim break; 224238405Sjkim } 225238405Sjkim 226238405Sjkim#if __FreeBSD_version >= 500000 227238405Sjkim ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, 228238405Sjkim "semaphore blocked, calling msleep(%p, %p, %d, \"acsem\", %d)\n", 229238405Sjkim as, &as->as_mtx, PCATCH, tmo)); 230238405Sjkim#endif 231238405Sjkim 232238405Sjkim as->as_pendings++; 233238405Sjkim 234238405Sjkim if (acpi_semaphore_debug) { 235238405Sjkim printf("%s: Sleep %d, pending %d, semaphore %p, thread %d\n", 236238405Sjkim __func__, Timeout, as->as_pendings, as, AcpiOsGetThreadId()); 237238405Sjkim } 238238405Sjkim 239238405Sjkim rv = msleep(as, &as->as_mtx, PCATCH, "acsem", tmo); 240238405Sjkim 241238405Sjkim as->as_pendings--; 242238405Sjkim 243238405Sjkim#if 0 244238405Sjkim if (as->as_resetting) { 245238405Sjkim /* semaphore reset, return immediately */ 246238405Sjkim if (as->as_pendings == 0) { 247238405Sjkim as->as_resetting = 0; 248238405Sjkim } 249238405Sjkim result = AE_TIME; 250238405Sjkim break; 251238405Sjkim } 252238405Sjkim#endif 253238405Sjkim 254 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "msleep(%d) returned %d\n", tmo, rv)); 255 if (rv == EWOULDBLOCK) { 256 result = AE_TIME; 257 break; 258 } 259 260 /* check if we already awaited enough */ 261 timelefttv = timeouttv; 262 getmicrotime(¤ttv); 263 timevalsub(&timelefttv, ¤ttv); 264 if (timelefttv.tv_sec < 0) { 265 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, "await semaphore %p timeout\n", 266 as)); 267 result = AE_TIME; 268 break; 269 } 270 271 /* adjust timeout for the next sleep */ 272 tmo = (timelefttv.tv_sec * 1000000 + timelefttv.tv_usec) / 273 (1000000 / hz); 274 if (tmo <= 0) 275 tmo = 1; 276 277 if (acpi_semaphore_debug) { 278 printf("%s: Wakeup timeleft(%lu, %lu), tmo %u, sem %p, thread %d\n", 279 __func__, timelefttv.tv_sec, timelefttv.tv_usec, tmo, as, 280 AcpiOsGetThreadId()); 281 } 282 } 283 284 if (acpi_semaphore_debug) { 285 if (result == AE_TIME && Timeout > 0) { 286 printf("%s: Timeout %d, pending %d, semaphore %p\n", 287 __func__, Timeout, as->as_pendings, as); 288 } 289 if (result == AE_OK && (as->as_timeouts > 0 || as->as_pendings > 0)) { 290 printf("%s: Acquire %d, units %d, pending %d, sem %p, thread %d\n", 291 __func__, Units, as->as_units, as->as_pendings, as, 292 AcpiOsGetThreadId()); 293 } 294 } 295 296 if (result == AE_TIME) 297 as->as_timeouts++; 298 else 299 as->as_timeouts = 0; 300 301 AS_UNLOCK(as); 302 return_ACPI_STATUS (result); 303#else 304 return_ACPI_STATUS (AE_OK); 305#endif /* !ACPI_NO_SEMAPHORES */ 306} 307 308ACPI_STATUS 309AcpiOsSignalSemaphore(ACPI_HANDLE Handle, UINT32 Units) 310{ 311#ifndef ACPI_NO_SEMAPHORES 312 struct acpi_semaphore *as = (struct acpi_semaphore *)Handle; 313 AS_LOCK_DECL; 314 315 ACPI_FUNCTION_TRACE((char *)(uintptr_t)__func__); 316 317 if (as == NULL) 318 return_ACPI_STATUS(AE_BAD_PARAMETER); 319 320 AS_LOCK(as); 321 ACPI_DEBUG_PRINT((ACPI_DB_MUTEX, 322 "return %d units to semaphore %p (has %d)\n", 323 Units, as, as->as_units)); 324 if (as->as_maxunits != ACPI_NO_UNIT_LIMIT) { 325 as->as_units += Units; 326 if (as->as_units > as->as_maxunits) 327 as->as_units = as->as_maxunits; 328 } 329 330 if (acpi_semaphore_debug && (as->as_timeouts > 0 || as->as_pendings > 0)) { 331 printf("%s: Release %d, units %d, pending %d, semaphore %p, thread %d\n", 332 __func__, Units, as->as_units, as->as_pendings, as, AcpiOsGetThreadId()); 333 } 334 335 wakeup(as); 336 AS_UNLOCK(as); 337#endif /* !ACPI_NO_SEMAPHORES */ 338 339 return_ACPI_STATUS (AE_OK); 340} 341 342ACPI_STATUS 343AcpiOsCreateLock (ACPI_HANDLE *OutHandle) 344{ 345 struct mtx *m; 346 347 if (OutHandle == NULL) 348 return (AE_BAD_PARAMETER); 349 m = malloc(sizeof(*m), M_ACPISEM, M_NOWAIT | M_ZERO); 350 if (m == NULL) 351 return (AE_NO_MEMORY); 352 353 mtx_init(m, "acpica subsystem lock", NULL, MTX_DEF); 354 *OutHandle = (ACPI_HANDLE)m; 355 return (AE_OK); 356} 357 358void 359AcpiOsDeleteLock (ACPI_HANDLE Handle) 360{ 361 struct mtx *m = (struct mtx *)Handle; 362 363 if (Handle == NULL) 364 return; 365 mtx_destroy(m); 366} 367 368/* 369 * The Flags parameter seems to state whether or not caller is an ISR 370 * (and thus can't block) but since we have ithreads, we don't worry 371 * about potentially blocking. 372 */ 373void 374AcpiOsAcquireLock (ACPI_HANDLE Handle, UINT32 Flags) 375{ 376 struct mtx *m = (struct mtx *)Handle; 377 378 if (Handle == NULL) 379 return; 380 mtx_lock(m); 381} 382 383void 384AcpiOsReleaseLock (ACPI_HANDLE Handle, UINT32 Flags) 385{ 386 struct mtx *m = (struct mtx *)Handle; 387 388 if (Handle == NULL) 389 return; 390 mtx_unlock(m); 391} 392