sys/dev/sound/pcm/sound.h

   1 /*-
   2  * Copyright (c) 2005-2009 Ariff Abdullah <ariff@FreeBSD.org>
   3  * Copyright (c) 1999 Cameron Grant <cg@FreeBSD.org>
   4  * Copyright (c) 1995 Hannu Savolainen
   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  * $FreeBSD$
  29  */
  30
  31 /*
  32  * first, include kernel header files.
  33  */
  34
  35 #ifndef _OS_H_
  36 #define _OS_H_
  37
  38 #ifdef _KERNEL
  39 #include <sys/param.h>
  40 #include <sys/systm.h>
  41 #include <sys/ioccom.h>
  42 #include <sys/filio.h>
  43 #include <sys/sockio.h>
  44 #include <sys/fcntl.h>
  45 #include <sys/selinfo.h>
  46 #include <sys/proc.h>
  47 #include <sys/kernel.h> /* for DATA_SET */
  48 #include <sys/module.h>
  49 #include <sys/conf.h>
  50 #include <sys/file.h>
  51 #include <sys/uio.h>
  52 #include <sys/syslog.h>
  53 #include <sys/errno.h>
  54 #include <sys/malloc.h>
  55 #include <sys/bus.h>
  56 #if __FreeBSD_version < 500000
  57 #include <sys/buf.h>
  58 #endif
  59 #include <machine/resource.h>
  60 #include <machine/bus.h>
  61 #include <sys/rman.h>
  62 #include <sys/limits.h>
  63 #include <sys/mman.h>
  64 #include <sys/poll.h>
  65 #include <sys/sbuf.h>
  66 #include <sys/soundcard.h>
  67 #include <sys/sysctl.h>
  68 #include <sys/kobj.h>
  69 #include <vm/vm.h>
  70 #include <vm/pmap.h>
  71
  72 #include <sys/lock.h>
  73 #include <sys/mutex.h>
  74 #include <sys/condvar.h>
  75
  76 #ifndef KOBJMETHOD_END
  77 #define KOBJMETHOD_END  { NULL, NULL }
  78 #endif
  79
  80 struct pcm_channel;
  81 struct pcm_feeder;
  82 struct snd_dbuf;
  83 struct snd_mixer;
  84
  85 #include <dev/sound/pcm/buffer.h>
  86 #include <dev/sound/pcm/matrix.h>
  87 #include <dev/sound/pcm/matrix_map.h>
  88 #include <dev/sound/pcm/channel.h>
  89 #include <dev/sound/pcm/feeder.h>
  90 #include <dev/sound/pcm/mixer.h>
  91 #include <dev/sound/pcm/dsp.h>
  92 #include <dev/sound/clone.h>
  93 #include <dev/sound/unit.h>
  94
  95 #define PCM_SOFTC_SIZE  (sizeof(struct snddev_info))
  96
  97 #define SND_STATUSLEN   64
  98
  99 #define SOUND_MODVER    5
 100
 101 #define SOUND_MINVER    SOUND_MODVER
 102 #define SOUND_PREFVER   SOUND_MODVER
 103 #define SOUND_MAXVER    SOUND_MODVER
 104
 105 /*
 106  * We're abusing the fact that MAXMINOR still have enough room
 107  * for our bit twiddling and nobody ever need 512 unique soundcards,
 108  * 32 unique device types and 1024 unique cloneable devices for the
 109  * next 100 years...
 110  */
 111
 112 #define PCMMAXUNIT              (snd_max_u())
 113 #define PCMMAXDEV               (snd_max_d())
 114 #define PCMMAXCHAN              (snd_max_c())
 115
 116 #define PCMMAXCLONE             PCMMAXCHAN
 117
 118 #define PCMUNIT(x)              (snd_unit2u(dev2unit(x)))
 119 #define PCMDEV(x)               (snd_unit2d(dev2unit(x)))
 120 #define PCMCHAN(x)              (snd_unit2c(dev2unit(x)))
 121
 122 /* XXX unit2minor compat */
 123 #if __FreeBSD_version >= 800062
 124 #define PCMMINOR(x)     (x)
 125 #else
 126 #define PCMMINOR(x)     unit2minor(x)
 127 #endif
 128
 129 /*
 130  * By design, limit possible channels for each direction.
 131  */
 132 #define SND_MAXHWCHAN           256
 133 #define SND_MAXVCHANS           SND_MAXHWCHAN
 134
 135 #define SD_F_SIMPLEX            0x00000001
 136 #define SD_F_AUTOVCHAN          0x00000002
 137 #define SD_F_SOFTPCMVOL         0x00000004
 138 /*
 139  * Obsolete due to better matrixing
 140  */
 141 #if 0
 142 #define SD_F_PSWAPLR            0x00000008
 143 #define SD_F_RSWAPLR            0x00000010
 144 #endif
 145 #define SD_F_DYING              0x00000008
 146 #define SD_F_SUICIDE            0x00000010
 147 #define SD_F_BUSY               0x00000020
 148 #define SD_F_MPSAFE             0x00000040
 149 #define SD_F_REGISTERED         0x00000080
 150 #define SD_F_BITPERFECT         0x00000100
 151 #define SD_F_VPC                0x00000200      /* volume-per-channel */
 152 #define SD_F_EQ                 0x00000400      /* EQ */
 153 #define SD_F_EQ_ENABLED         0x00000800      /* EQ enabled */
 154 #define SD_F_EQ_BYPASSED        0x00001000      /* EQ bypassed */
 155 #define SD_F_EQ_PC              0x00002000      /* EQ per-channel */
 156
 157 #define SD_F_EQ_DEFAULT         (SD_F_EQ | SD_F_EQ_ENABLED)
 158 #define SD_F_EQ_MASK            (SD_F_EQ | SD_F_EQ_ENABLED |            \
 159                                  SD_F_EQ_BYPASSED | SD_F_EQ_PC)
 160
 161 #define SD_F_PRIO_RD            0x10000000
 162 #define SD_F_PRIO_WR            0x20000000
 163 #define SD_F_PRIO_SET           (SD_F_PRIO_RD | SD_F_PRIO_WR)
 164 #define SD_F_DIR_SET            0x40000000
 165 #define SD_F_TRANSIENT          0xf0000000
 166
 167 #define SD_F_BITS               "\020"                                  \
 168                                 "\001SIMPLEX"                           \
 169                                 "\002AUTOVCHAN"                         \
 170                                 "\003SOFTPCMVOL"                        \
 171                                 "\004DYING"                             \
 172                                 "\005SUICIDE"                           \
 173                                 "\006BUSY"                              \
 174                                 "\007MPSAFE"                            \
 175                                 "\010REGISTERED"                        \
 176                                 "\011BITPERFECT"                        \
 177                                 "\012VPC"                               \
 178                                 "\013EQ"                                \
 179                                 "\014EQ_ENABLED"                        \
 180                                 "\015EQ_BYPASSED"                       \
 181                                 "\016EQ_PC"                             \
 182                                 "\035PRIO_RD"                           \
 183                                 "\036PRIO_WR"                           \
 184                                 "\037DIR_SET"
 185
 186 #define PCM_ALIVE(x)            ((x) != NULL && (x)->lock != NULL &&    \
 187                                  !((x)->flags & SD_F_DYING))
 188 #define PCM_REGISTERED(x)       (PCM_ALIVE(x) &&                        \
 189                                  ((x)->flags & SD_F_REGISTERED))
 190
 191 /* many variables should be reduced to a range. Here define a macro */
 192 #define RANGE(var, low, high) (var) = \
 193         (((var)<(low))? (low) : ((var)>(high))? (high) : (var))
 194 #define DSP_BUFFSIZE (8192)
 195
 196 /* make figuring out what a format is easier. got AFMT_STEREO already */
 197 #define AFMT_32BIT (AFMT_S32_LE | AFMT_S32_BE | AFMT_U32_LE | AFMT_U32_BE)
 198 #define AFMT_24BIT (AFMT_S24_LE | AFMT_S24_BE | AFMT_U24_LE | AFMT_U24_BE)
 199 #define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE)
 200 #define AFMT_G711  (AFMT_MU_LAW | AFMT_A_LAW)
 201 #define AFMT_8BIT (AFMT_G711 | AFMT_U8 | AFMT_S8)
 202 #define AFMT_SIGNED (AFMT_S32_LE | AFMT_S32_BE | AFMT_S24_LE | AFMT_S24_BE | \
 203                         AFMT_S16_LE | AFMT_S16_BE | AFMT_S8)
 204 #define AFMT_BIGENDIAN (AFMT_S32_BE | AFMT_U32_BE | AFMT_S24_BE | AFMT_U24_BE | \
 205                         AFMT_S16_BE | AFMT_U16_BE)
 206
 207 #define AFMT_CONVERTIBLE        (AFMT_8BIT | AFMT_16BIT | AFMT_24BIT |  \
 208                                  AFMT_32BIT)
 209
 210 /* Supported vchan mixing formats */
 211 #define AFMT_VCHAN              (AFMT_CONVERTIBLE & ~AFMT_G711)
 212
 213 #define AFMT_PASSTHROUGH                AFMT_AC3
 214 #define AFMT_PASSTHROUGH_RATE           48000
 215 #define AFMT_PASSTHROUGH_CHANNEL        2
 216 #define AFMT_PASSTHROUGH_EXTCHANNEL     0
 217
 218 /*
 219  * We're simply using unused, contiguous bits from various AFMT_ definitions.
 220  * ~(0xb00ff7ff)
 221  */
 222 #define AFMT_ENCODING_MASK      0xf00fffff
 223 #define AFMT_CHANNEL_MASK       0x07f00000
 224 #define AFMT_CHANNEL_SHIFT      20
 225 #define AFMT_CHANNEL_MAX        0x7f
 226 #define AFMT_EXTCHANNEL_MASK    0x08000000
 227 #define AFMT_EXTCHANNEL_SHIFT   27
 228 #define AFMT_EXTCHANNEL_MAX     1
 229
 230 #define AFMT_ENCODING(v)        ((v) & AFMT_ENCODING_MASK)
 231
 232 #define AFMT_EXTCHANNEL(v)      (((v) & AFMT_EXTCHANNEL_MASK) >>        \
 233                                 AFMT_EXTCHANNEL_SHIFT)
 234
 235 #define AFMT_CHANNEL(v)         (((v) & AFMT_CHANNEL_MASK) >>           \
 236                                 AFMT_CHANNEL_SHIFT)
 237
 238 #define AFMT_BIT(v)             (((v) & AFMT_32BIT) ? 32 :              \
 239                                 (((v) & AFMT_24BIT) ? 24 :              \
 240                                 ((((v) & AFMT_16BIT) ||                 \
 241                                 ((v) & AFMT_PASSTHROUGH)) ? 16 : 8)))
 242
 243 #define AFMT_BPS(v)             (AFMT_BIT(v) >> 3)
 244 #define AFMT_ALIGN(v)           (AFMT_BPS(v) * AFMT_CHANNEL(v))
 245
 246 #define SND_FORMAT(f, c, e)     (AFMT_ENCODING(f) |             \
 247                                 (((c) << AFMT_CHANNEL_SHIFT) &          \
 248                                 AFMT_CHANNEL_MASK) |                    \
 249                                 (((e) << AFMT_EXTCHANNEL_SHIFT) &       \
 250                                 AFMT_EXTCHANNEL_MASK))
 251
 252 #define AFMT_U8_NE      AFMT_U8
 253 #define AFMT_S8_NE      AFMT_S8
 254
 255 #define AFMT_SIGNED_NE  (AFMT_S8_NE | AFMT_S16_NE | AFMT_S24_NE | AFMT_S32_NE)
 256
 257 #define AFMT_NE         (AFMT_SIGNED_NE | AFMT_U8_NE | AFMT_U16_NE |    \
 258                          AFMT_U24_NE | AFMT_U32_NE)
 259
 260 /*
 261  * Minor numbers for the sound driver.
 262  *
 263  * Unfortunately Creative called the codec chip of SB as a DSP. For this
 264  * reason the /dev/dsp is reserved for digitized audio use. There is a
 265  * device for true DSP processors but it will be called something else.
 266  * In v3.0 it's /dev/sndproc but this could be a temporary solution.
 267  */
 268
 269 #define SND_DEV_CTL     0       /* Control port /dev/mixer */
 270 #define SND_DEV_SEQ     1       /* Sequencer /dev/sequencer */
 271 #define SND_DEV_MIDIN   2       /* Raw midi access */
 272 #define SND_DEV_DSP     3       /* Digitized voice /dev/dsp */
 273 #define SND_DEV_AUDIO   4       /* Sparc compatible /dev/audio */
 274 #define SND_DEV_DSP16   5       /* Like /dev/dsp but 16 bits/sample */
 275 #define SND_DEV_STATUS  6       /* /dev/sndstat */
 276                                 /* #7 not in use now. */
 277 #define SND_DEV_SEQ2    8       /* /dev/sequencer, level 2 interface */
 278 #define SND_DEV_SNDPROC 9       /* /dev/sndproc for programmable devices */
 279 #define SND_DEV_PSS     SND_DEV_SNDPROC /* ? */
 280 #define SND_DEV_NORESET 10
 281
 282 #define SND_DEV_DSPHW_PLAY      11      /* specific playback channel */
 283 #define SND_DEV_DSPHW_VPLAY     12      /* specific virtual playback channel */
 284 #define SND_DEV_DSPHW_REC       13      /* specific record channel */
 285 #define SND_DEV_DSPHW_VREC      14      /* specific virtual record channel */
 286
 287 #define SND_DEV_DSPHW_CD        15      /* s16le/stereo 44100Hz CD */
 288
 289 /*
 290  * OSSv4 compatible device. For now, it serve no purpose and
 291  * the cloning itself will forward the request to ordinary /dev/dsp
 292  * instead.
 293  */
 294 #define SND_DEV_DSP_MMAP        16      /* /dev/dsp_mmap     */
 295 #define SND_DEV_DSP_AC3         17      /* /dev/dsp_ac3      */
 296 #define SND_DEV_DSP_MULTICH     18      /* /dev/dsp_multich  */
 297 #define SND_DEV_DSP_SPDIFOUT    19      /* /dev/dsp_spdifout */
 298 #define SND_DEV_DSP_SPDIFIN     20      /* /dev/dsp_spdifin  */
 299
 300 #define SND_DEV_LAST            SND_DEV_DSP_SPDIFIN
 301 #define SND_DEV_MAX             PCMMAXDEV
 302
 303 #define DSP_DEFAULT_SPEED       8000
 304
 305 #define ON              1
 306 #define OFF             0
 307
 308 extern int pcm_veto_load;
 309 extern int snd_unit;
 310 extern int snd_maxautovchans;
 311 extern int snd_verbose;
 312 extern devclass_t pcm_devclass;
 313 extern struct unrhdr *pcmsg_unrhdr;
 314
 315 /*
 316  * some macros for debugging purposes
 317  * DDB/DEB to enable/disable debugging stuff
 318  * BVDDB   to enable debugging when bootverbose
 319  */
 320 #define BVDDB(x) if (bootverbose) x
 321
 322 #ifndef DEB
 323 #define DEB(x)
 324 #endif
 325
 326 SYSCTL_DECL(_hw_snd);
 327
 328 int pcm_setvchans(struct snddev_info *d, int direction, int newcnt, int num);
 329 int pcm_chnalloc(struct snddev_info *d, struct pcm_channel **ch, int direction,
 330     pid_t pid, char *comm, int devunit);
 331 int pcm_chnrelease(struct pcm_channel *c);
 332 int pcm_chnref(struct pcm_channel *c, int ref);
 333 int pcm_inprog(struct snddev_info *d, int delta);
 334
 335 struct pcm_channel *pcm_chn_create(struct snddev_info *d, struct pcm_channel *parent, kobj_class_t cls, int dir, int num, void *devinfo);
 336 int pcm_chn_destroy(struct pcm_channel *ch);
 337 int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch);
 338 int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch);
 339
 340 int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo);
 341 unsigned int pcm_getbuffersize(device_t dev, unsigned int minbufsz, unsigned int deflt, unsigned int maxbufsz);
 342 int pcm_register(device_t dev, void *devinfo, int numplay, int numrec);
 343 int pcm_unregister(device_t dev);
 344 int pcm_setstatus(device_t dev, char *str);
 345 u_int32_t pcm_getflags(device_t dev);
 346 void pcm_setflags(device_t dev, u_int32_t val);
 347 void *pcm_getdevinfo(device_t dev);
 348
 349
 350 int snd_setup_intr(device_t dev, struct resource *res, int flags,
 351                    driver_intr_t hand, void *param, void **cookiep);
 352
 353 void *snd_mtxcreate(const char *desc, const char *type);
 354 void snd_mtxfree(void *m);
 355 void snd_mtxassert(void *m);
 356 #define snd_mtxlock(m) mtx_lock(m)
 357 #define snd_mtxunlock(m) mtx_unlock(m)
 358
 359 typedef int (*sndstat_handler)(struct sbuf *s, device_t dev, int verbose);
 360 int sndstat_acquire(struct thread *td);
 361 int sndstat_release(struct thread *td);
 362 int sndstat_register(device_t dev, char *str, sndstat_handler handler);
 363 int sndstat_registerfile(char *str);
 364 int sndstat_unregister(device_t dev);
 365 int sndstat_unregisterfile(char *str);
 366
 367 #define SND_DECLARE_FILE(version) \
 368         _SND_DECLARE_FILE(__LINE__, version)
 369
 370 #define _SND_DECLARE_FILE(uniq, version) \
 371         __SND_DECLARE_FILE(uniq, version)
 372
 373 #define __SND_DECLARE_FILE(uniq, version) \
 374         static char sndstat_vinfo[] = version; \
 375         SYSINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_registerfile, sndstat_vinfo); \
 376         SYSUNINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_unregisterfile, sndstat_vinfo);
 377
 378 /* usage of flags in device config entry (config file) */
 379 #define DV_F_DRQ_MASK   0x00000007      /* mask for secondary drq */
 380 #define DV_F_DUAL_DMA   0x00000010      /* set to use secondary dma channel */
 381
 382 /* ought to be made obsolete but still used by mss */
 383 #define DV_F_DEV_MASK   0x0000ff00      /* force device type/class */
 384 #define DV_F_DEV_SHIFT  8               /* force device type/class */
 385
 386 /*
 387  * this is rather kludgey- we need to duplicate these struct def'ns from sound.c
 388  * so that the macro versions of pcm_{,un}lock can dereference them.
 389  * we also have to do this now makedev() has gone away.
 390  */
 391
 392 struct snddev_info {
 393         struct {
 394                 struct {
 395                         SLIST_HEAD(, pcm_channel) head;
 396                         struct {
 397                                 SLIST_HEAD(, pcm_channel) head;
 398                         } busy;
 399                         struct {
 400                                 SLIST_HEAD(, pcm_channel) head;
 401                         } opened;
 402                 } pcm;
 403         } channels;
 404         TAILQ_HEAD(dsp_cdevinfo_linkhead, dsp_cdevinfo) dsp_cdevinfo_pool;
 405         struct snd_clone *clones;
 406         unsigned devcount, playcount, reccount, pvchancount, rvchancount ;
 407         unsigned flags;
 408         int inprog;
 409         unsigned int bufsz;
 410         void *devinfo;
 411         device_t dev;
 412         char status[SND_STATUSLEN];
 413         struct mtx *lock;
 414         struct cdev *mixer_dev;
 415         uint32_t pvchanrate, pvchanformat;
 416         uint32_t rvchanrate, rvchanformat;
 417         int32_t eqpreamp;
 418         struct sysctl_ctx_list play_sysctl_ctx, rec_sysctl_ctx;
 419         struct sysctl_oid *play_sysctl_tree, *rec_sysctl_tree;
 420         struct cv cv;
 421 };
 422
 423 void    sound_oss_sysinfo(oss_sysinfo *);
 424 int     sound_oss_card_info(oss_card_info *);
 425
 426 #define PCM_LOCKOWNED(d)        mtx_owned((d)->lock)
 427 #define PCM_LOCK(d)             mtx_lock((d)->lock)
 428 #define PCM_UNLOCK(d)           mtx_unlock((d)->lock)
 429 #define PCM_TRYLOCK(d)          mtx_trylock((d)->lock)
 430 #define PCM_LOCKASSERT(d)       mtx_assert((d)->lock, MA_OWNED)
 431 #define PCM_UNLOCKASSERT(d)     mtx_assert((d)->lock, MA_NOTOWNED)
 432
 433 /*
 434  * For PCM_[WAIT | ACQUIRE | RELEASE], be sure to surround these
 435  * with PCM_LOCK/UNLOCK() sequence, or I'll come to gnaw upon you!
 436  */
 437 #ifdef SND_DIAGNOSTIC
 438 #define PCM_WAIT(x)             do {                                    \
 439         if (!PCM_LOCKOWNED(x))                                          \
 440                 panic("%s(%d): [PCM WAIT] Mutex not owned!",            \
 441                     __func__, __LINE__);                                \
 442         while ((x)->flags & SD_F_BUSY) {                                \
 443                 if (snd_verbose > 3)                                    \
 444                         device_printf((x)->dev,                         \
 445                             "%s(%d): [PCM WAIT] calling cv_wait().\n",  \
 446                             __func__, __LINE__);                        \
 447                 cv_wait(&(x)->cv, (x)->lock);                           \
 448         }                                                               \
 449 } while (0)
 450
 451 #define PCM_ACQUIRE(x)          do {                                    \
 452         if (!PCM_LOCKOWNED(x))                                          \
 453                 panic("%s(%d): [PCM ACQUIRE] Mutex not owned!",         \
 454                     __func__, __LINE__);                                \
 455         if ((x)->flags & SD_F_BUSY)                                     \
 456                 panic("%s(%d): [PCM ACQUIRE] "                          \
 457                     "Trying to acquire BUSY cv!", __func__, __LINE__);  \
 458         (x)->flags |= SD_F_BUSY;                                        \
 459 } while (0)
 460
 461 #define PCM_RELEASE(x)          do {                                    \
 462         if (!PCM_LOCKOWNED(x))                                          \
 463                 panic("%s(%d): [PCM RELEASE] Mutex not owned!",         \
 464                     __func__, __LINE__);                                \
 465         if ((x)->flags & SD_F_BUSY) {                                   \
 466                 (x)->flags &= ~SD_F_BUSY;                               \
 467                 if ((x)->cv.cv_waiters != 0) {                          \
 468                         if ((x)->cv.cv_waiters > 1 && snd_verbose > 3)  \
 469                                 device_printf((x)->dev,                 \
 470                                     "%s(%d): [PCM RELEASE] "            \
 471                                     "cv_waiters=%d > 1!\n",             \
 472                                     __func__, __LINE__,                 \
 473                                     (x)->cv.cv_waiters);                \
 474                         cv_broadcast(&(x)->cv);                         \
 475                 }                                                       \
 476         } else                                                          \
 477                 panic("%s(%d): [PCM RELEASE] Releasing non-BUSY cv!",   \
 478                     __func__, __LINE__);                                \
 479 } while (0)
 480
 481 /* Quick version, for shorter path. */
 482 #define PCM_ACQUIRE_QUICK(x)    do {                                    \
 483         if (PCM_LOCKOWNED(x))                                           \
 484                 panic("%s(%d): [PCM ACQUIRE QUICK] Mutex owned!",       \
 485                     __func__, __LINE__);                                \
 486         PCM_LOCK(x);                                                    \
 487         PCM_WAIT(x);                                                    \
 488         PCM_ACQUIRE(x);                                                 \
 489         PCM_UNLOCK(x);                                                  \
 490 } while (0)
 491
 492 #define PCM_RELEASE_QUICK(x)    do {                                    \
 493         if (PCM_LOCKOWNED(x))                                           \
 494                 panic("%s(%d): [PCM RELEASE QUICK] Mutex owned!",       \
 495                     __func__, __LINE__);                                \
 496         PCM_LOCK(x);                                                    \
 497         PCM_RELEASE(x);                                                 \
 498         PCM_UNLOCK(x);                                                  \
 499 } while (0)
 500
 501 #define PCM_BUSYASSERT(x)       do {                                    \
 502         if (!((x) != NULL && ((x)->flags & SD_F_BUSY)))                 \
 503                 panic("%s(%d): [PCM BUSYASSERT] "                       \
 504                     "Failed, snddev_info=%p", __func__, __LINE__, x);   \
 505 } while (0)
 506
 507 #define PCM_GIANT_ENTER(x)      do {                                    \
 508         int _pcm_giant = 0;                                             \
 509         if (PCM_LOCKOWNED(x))                                           \
 510                 panic("%s(%d): [GIANT ENTER] PCM lock owned!",          \
 511                     __func__, __LINE__);                                \
 512         if (mtx_owned(&Giant) != 0 && snd_verbose > 3)                  \
 513                 device_printf((x)->dev,                                 \
 514                     "%s(%d): [GIANT ENTER] Giant owned!\n",             \
 515                     __func__, __LINE__);                                \
 516         if (!((x)->flags & SD_F_MPSAFE) && mtx_owned(&Giant) == 0)      \
 517                 do {                                                    \
 518                         mtx_lock(&Giant);                               \
 519                         _pcm_giant = 1;                                 \
 520                 } while (0)
 521
 522 #define PCM_GIANT_EXIT(x)       do {                                    \
 523         if (PCM_LOCKOWNED(x))                                           \
 524                 panic("%s(%d): [GIANT EXIT] PCM lock owned!",           \
 525                     __func__, __LINE__);                                \
 526         if (!(_pcm_giant == 0 || _pcm_giant == 1))                      \
 527                 panic("%s(%d): [GIANT EXIT] _pcm_giant screwed!",       \
 528                     __func__, __LINE__);                                \
 529         if ((x)->flags & SD_F_MPSAFE) {                                 \
 530                 if (_pcm_giant == 1)                                    \
 531                         panic("%s(%d): [GIANT EXIT] MPSAFE Giant?",     \
 532                             __func__, __LINE__);                        \
 533                 if (mtx_owned(&Giant) != 0 && snd_verbose > 3)          \
 534                         device_printf((x)->dev,                         \
 535                             "%s(%d): [GIANT EXIT] Giant owned!\n",      \
 536                             __func__, __LINE__);                        \
 537         }                                                               \
 538         if (_pcm_giant != 0) {                                          \
 539                 if (mtx_owned(&Giant) == 0)                             \
 540                         panic("%s(%d): [GIANT EXIT] Giant not owned!",  \
 541                             __func__, __LINE__);                        \
 542                 _pcm_giant = 0;                                         \
 543                 mtx_unlock(&Giant);                                     \
 544         }                                                               \
 545 } while (0)
 546 #else /* SND_DIAGNOSTIC */
 547 #define PCM_WAIT(x)             do {                                    \
 548         PCM_LOCKASSERT(x);                                              \
 549         while ((x)->flags & SD_F_BUSY)                                  \
 550                 cv_wait(&(x)->cv, (x)->lock);                           \
 551 } while (0)
 552
 553 #define PCM_ACQUIRE(x)          do {                                    \
 554         PCM_LOCKASSERT(x);                                              \
 555         KASSERT(!((x)->flags & SD_F_BUSY),                              \
 556             ("%s(%d): [PCM ACQUIRE] Trying to acquire BUSY cv!",        \
 557             __func__, __LINE__));                                       \
 558         (x)->flags |= SD_F_BUSY;                                        \
 559 } while (0)
 560
 561 #define PCM_RELEASE(x)          do {                                    \
 562         PCM_LOCKASSERT(x);                                              \
 563         KASSERT((x)->flags & SD_F_BUSY,                                 \
 564             ("%s(%d): [PCM RELEASE] Releasing non-BUSY cv!",            \
 565             __func__, __LINE__));                                       \
 566         (x)->flags &= ~SD_F_BUSY;                                       \
 567         if ((x)->cv.cv_waiters != 0)                                    \
 568                 cv_broadcast(&(x)->cv);                                 \
 569 } while (0)
 570
 571 /* Quick version, for shorter path. */
 572 #define PCM_ACQUIRE_QUICK(x)    do {                                    \
 573         PCM_UNLOCKASSERT(x);                                            \
 574         PCM_LOCK(x);                                                    \
 575         PCM_WAIT(x);                                                    \
 576         PCM_ACQUIRE(x);                                                 \
 577         PCM_UNLOCK(x);                                                  \
 578 } while (0)
 579
 580 #define PCM_RELEASE_QUICK(x)    do {                                    \
 581         PCM_UNLOCKASSERT(x);                                            \
 582         PCM_LOCK(x);                                                    \
 583         PCM_RELEASE(x);                                                 \
 584         PCM_UNLOCK(x);                                                  \
 585 } while (0)
 586
 587 #define PCM_BUSYASSERT(x)       KASSERT(x != NULL &&                    \
 588                                     ((x)->flags & SD_F_BUSY),           \
 589                                     ("%s(%d): [PCM BUSYASSERT] "        \
 590                                     "Failed, snddev_info=%p",           \
 591                                     __func__, __LINE__, x))
 592
 593 #define PCM_GIANT_ENTER(x)      do {                                    \
 594         int _pcm_giant = 0;                                             \
 595         PCM_UNLOCKASSERT(x);                                            \
 596         if (!((x)->flags & SD_F_MPSAFE) && mtx_owned(&Giant) == 0)      \
 597                 do {                                                    \
 598                         mtx_lock(&Giant);                               \
 599                         _pcm_giant = 1;                                 \
 600                 } while (0)
 601
 602 #define PCM_GIANT_EXIT(x)       do {                                    \
 603         PCM_UNLOCKASSERT(x);                                            \
 604         KASSERT(_pcm_giant == 0 || _pcm_giant == 1,                     \
 605             ("%s(%d): [GIANT EXIT] _pcm_giant screwed!",                \
 606             __func__, __LINE__));                                       \
 607         KASSERT(!((x)->flags & SD_F_MPSAFE) ||                          \
 608             (((x)->flags & SD_F_MPSAFE) && _pcm_giant == 0),            \
 609             ("%s(%d): [GIANT EXIT] MPSAFE Giant?",                      \
 610             __func__, __LINE__));                                       \
 611         if (_pcm_giant != 0) {                                          \
 612                 mtx_assert(&Giant, MA_OWNED);                           \
 613                 _pcm_giant = 0;                                         \
 614                 mtx_unlock(&Giant);                                     \
 615         }                                                               \
 616 } while (0)
 617 #endif /* !SND_DIAGNOSTIC */
 618
 619 #define PCM_GIANT_LEAVE(x)                                              \
 620         PCM_GIANT_EXIT(x);                                              \
 621 } while (0)
 622
 623 #ifdef KLD_MODULE
 624 #define PCM_KLDSTRING(a) ("kld " # a)
 625 #else
 626 #define PCM_KLDSTRING(a) ""
 627 #endif
 628
 629 #endif /* _KERNEL */
 630
 631 #endif  /* _OS_H_ */