/*-
 * Copyright (c) 2005-2009 Ariff Abdullah <ariff@FreeBSD.org>
 * Copyright (c) 1999 Cameron Grant <cg@FreeBSD.org>
 * Copyright (c) 1995 Hannu Savolainen
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 * 1. Redistributions of source code must retain the above copyright
 *    notice, this list of conditions and the following disclaimer.
 * 2. Redistributions in binary form must reproduce the above copyright
 *    notice, this list of conditions and the following disclaimer in the
 *    documentation and/or other materials provided with the distribution.
 *
 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
 * SUCH DAMAGE.
 *
 * $FreeBSD: head/sys/dev/sound/pcm/sound.h 274035 2014-11-03 11:11:45Z bapt $
 */

/*
 * first, include kernel header files.
 */

#ifndef _OS_H_
#define _OS_H_

#ifdef _KERNEL
#include <sys/param.h>
#include <sys/systm.h>
#include <sys/filio.h>
#include <sys/sockio.h>
#include <sys/fcntl.h>
#include <sys/proc.h>
#include <sys/kernel.h> /* for DATA_SET */
#include <sys/module.h>
#include <sys/conf.h>
#include <sys/file.h>
#include <sys/uio.h>
#include <sys/syslog.h>
#include <sys/errno.h>
#include <sys/malloc.h>
#include <sys/bus.h>
#include <sys/rman.h>
#include <sys/limits.h>
#include <sys/mman.h>
#include <sys/poll.h>
#include <sys/sbuf.h>
#include <sys/soundcard.h>
#include <sys/sysctl.h>
#include <sys/kobj.h>
#include <vm/vm.h>
#include <vm/pmap.h>

#include <sys/lock.h>
#include <sys/mplock2.h>
#include <sys/mutex.h>
#include <sys/condvar.h>
#include <sys/taskqueue.h>

struct pcm_channel;
struct pcm_feeder;
struct snd_dbuf;
struct snd_mixer;

#include <dev/sound/pcm/buffer.h>
#include <dev/sound/pcm/matrix.h>
#include <dev/sound/pcm/matrix_map.h>
#include <dev/sound/pcm/channel.h>
#include <dev/sound/pcm/feeder.h>
#include <dev/sound/pcm/mixer.h>
#include <dev/sound/pcm/dsp.h>
#include <dev/sound/clone.h>
#include <dev/sound/unit.h>

#define PCM_SOFTC_SIZE  (sizeof(struct snddev_info))

#define SND_STATUSLEN   64

#define SOUND_MODVER    5

#define SOUND_MINVER    SOUND_MODVER
#define SOUND_PREFVER   SOUND_MODVER
#define SOUND_MAXVER    SOUND_MODVER

/*
 * Minor number encoding: 0xFFFF00FF
 *      unit              0x000000FF
 *      chan              0x07FF0000
 *      devtype           0xF8000000
 */

#define SND_U_MASK      0x000000FF
#define SND_C_MASK      0x07FF0000
#define SND_D_MASK      0xF8000000

#define PCMMAXUNIT      255
#define PCMMAXDEV       31
#define PCMMAXCHAN      2047
#define PCMMAXCLONE     PCMMAXCHAN

/*
 *
 */
#define PCMUNIT(x)              (minor(x) & 0x00FF)
#define PCMSUBUNIT(x)           ((minor(x) >> 16) & 0x07FF)
#define PCMDEV(x)               ((minor(x) >> 27) & 0x001F)

#define PCMUNIT_DEFAULT         0x00FF

#define PCMMKMINOR(u, d, sub)   (snd_u2unit(u) | snd_c2unit(sub) | snd_d2unit(d))

#define snd_unit2u(m)           ((m) & 0x00FF)
#define snd_unit2c(m)           (((m) >> 16) & 0x07FF)
#define snd_unit2d(m)           (((m) >> 27) & 0x001F)

#define snd_u2unit(u)           ((u) & 0x00FF)
#define snd_c2unit(c)           (((c) & 0x07FF) << 16)
#define snd_d2unit(d)           (((d) & 0x001F) << 27)

#define snd_mkunit(u, d, c)     (snd_u2unit(u) | snd_d2unit(d) | snd_c2unit(c))

/*
 * By design, limit possible channels for each direction.
 */
#define SND_MAXHWCHAN           256
#define SND_MAXVCHANS           SND_MAXHWCHAN

#define SD_F_SIMPLEX            0x00000001
#define SD_F_AUTOVCHAN          0x00000002
#define SD_F_SOFTPCMVOL         0x00000004
/*
 * Obsolete due to better matrixing
 */
#if 0
#define SD_F_PSWAPLR            0x00000008
#define SD_F_RSWAPLR            0x00000010
#endif
#define SD_F_DYING              0x00000008
#define SD_F_SUICIDE            0x00000010
#define SD_F_BUSY               0x00000020
#define SD_F_MPSAFE             0x00000040
#define SD_F_REGISTERED         0x00000080
#define SD_F_BITPERFECT         0x00000100
#define SD_F_VPC                0x00000200      /* volume-per-channel */
#define SD_F_EQ                 0x00000400      /* EQ */
#define SD_F_EQ_ENABLED         0x00000800      /* EQ enabled */
#define SD_F_EQ_BYPASSED        0x00001000      /* EQ bypassed */
#define SD_F_EQ_PC              0x00002000      /* EQ per-channel */

#define SD_F_EQ_DEFAULT         (SD_F_EQ | SD_F_EQ_ENABLED)
#define SD_F_EQ_MASK            (SD_F_EQ | SD_F_EQ_ENABLED |            \
                                 SD_F_EQ_BYPASSED | SD_F_EQ_PC)

#define SD_F_PRIO_RD            0x10000000
#define SD_F_PRIO_WR            0x20000000
#define SD_F_PRIO_SET           (SD_F_PRIO_RD | SD_F_PRIO_WR)
#define SD_F_DIR_SET            0x40000000
#define SD_F_TRANSIENT          0xf0000000

#define SD_F_BITS               "\020"                                  \
                                "\001SIMPLEX"                           \
                                "\002AUTOVCHAN"                         \
                                "\003SOFTPCMVOL"                        \
                                "\004DYING"                             \
                                "\005SUICIDE"                           \
                                "\006BUSY"                              \
                                "\007MPSAFE"                            \
                                "\010REGISTERED"                        \
                                "\011BITPERFECT"                        \
                                "\012VPC"                               \
                                "\013EQ"                                \
                                "\014EQ_ENABLED"                        \
                                "\015EQ_BYPASSED"                       \
                                "\016EQ_PC"                             \
                                "\035PRIO_RD"                           \
                                "\036PRIO_WR"                           \
                                "\037DIR_SET"

#define PCM_ALIVE(x)            ((x) != NULL && (x)->lock != NULL &&    \
                                 !((x)->flags & SD_F_DYING))
#define PCM_REGISTERED(x)       (PCM_ALIVE(x) &&                        \
                                 ((x)->flags & SD_F_REGISTERED))

/* many variables should be reduced to a range. Here define a macro */
#define RANGE(var, low, high) (var) = \
        (((var)<(low))? (low) : ((var)>(high))? (high) : (var))
#define DSP_BUFFSIZE (8192)

/* make figuring out what a format is easier. got AFMT_STEREO already */
#define AFMT_32BIT (AFMT_S32_LE | AFMT_S32_BE | AFMT_U32_LE | AFMT_U32_BE)
#define AFMT_24BIT (AFMT_S24_LE | AFMT_S24_BE | AFMT_U24_LE | AFMT_U24_BE)
#define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE)
#define AFMT_G711  (AFMT_MU_LAW | AFMT_A_LAW)
#define AFMT_8BIT (AFMT_G711 | AFMT_U8 | AFMT_S8)
#define AFMT_SIGNED (AFMT_S32_LE | AFMT_S32_BE | AFMT_S24_LE | AFMT_S24_BE | \
                        AFMT_S16_LE | AFMT_S16_BE | AFMT_S8)
#define AFMT_BIGENDIAN (AFMT_S32_BE | AFMT_U32_BE | AFMT_S24_BE | AFMT_U24_BE | \
                        AFMT_S16_BE | AFMT_U16_BE)

#define AFMT_CONVERTIBLE        (AFMT_8BIT | AFMT_16BIT | AFMT_24BIT |  \
                                 AFMT_32BIT)

/* Supported vchan mixing formats */
#define AFMT_VCHAN              (AFMT_CONVERTIBLE & ~AFMT_G711)

#define AFMT_PASSTHROUGH                AFMT_AC3
#define AFMT_PASSTHROUGH_RATE           48000
#define AFMT_PASSTHROUGH_CHANNEL        2
#define AFMT_PASSTHROUGH_EXTCHANNEL     0

/*
 * We're simply using unused, contiguous bits from various AFMT_ definitions.
 * ~(0xb00ff7ff)
 */
#define AFMT_ENCODING_MASK      0xf00fffff
#define AFMT_CHANNEL_MASK       0x01f00000
#define AFMT_CHANNEL_SHIFT      20
#define AFMT_CHANNEL_MAX        0x7f
#define AFMT_EXTCHANNEL_MASK    0x0e000000
#define AFMT_EXTCHANNEL_SHIFT   25

#define AFMT_ENCODING(v)        ((v) & AFMT_ENCODING_MASK)

#define AFMT_EXTCHANNEL(v)      (((v) & AFMT_EXTCHANNEL_MASK) >>        \
                                AFMT_EXTCHANNEL_SHIFT)

#define AFMT_CHANNEL(v)         (((v) & AFMT_CHANNEL_MASK) >>           \
                                AFMT_CHANNEL_SHIFT)

#define AFMT_BIT(v)             (((v) & AFMT_32BIT) ? 32 :              \
                                (((v) & AFMT_24BIT) ? 24 :              \
                                ((((v) & AFMT_16BIT) ||                 \
                                ((v) & AFMT_PASSTHROUGH)) ? 16 : 8)))

#define AFMT_BPS(v)             (AFMT_BIT(v) >> 3)
#define AFMT_ALIGN(v)           (AFMT_BPS(v) * AFMT_CHANNEL(v))

#define SND_FORMAT(f, c, e)     (AFMT_ENCODING(f) |             \
                                (((c) << AFMT_CHANNEL_SHIFT) &          \
                                AFMT_CHANNEL_MASK) |                    \
                                (((e) << AFMT_EXTCHANNEL_SHIFT) &       \
                                AFMT_EXTCHANNEL_MASK))

#define AFMT_U8_NE      AFMT_U8
#define AFMT_S8_NE      AFMT_S8

#define AFMT_SIGNED_NE  (AFMT_S8_NE | AFMT_S16_NE | AFMT_S24_NE | AFMT_S32_NE)

#define AFMT_NE         (AFMT_SIGNED_NE | AFMT_U8_NE | AFMT_U16_NE |    \
                         AFMT_U24_NE | AFMT_U32_NE)

/*
 * Minor numbers for the sound driver.
 *
 * Unfortunately Creative called the codec chip of SB as a DSP. For this
 * reason the /dev/dsp is reserved for digitized audio use. There is a
 * device for true DSP processors but it will be called something else.
 * In v3.0 it's /dev/sndproc but this could be a temporary solution.
 */

#define SND_DEV_CTL     0       /* Control port /dev/mixer */
#define SND_DEV_SEQ     1       /* Sequencer /dev/sequencer */
#define SND_DEV_MIDIN   2       /* Raw midi access */
#define SND_DEV_DSP     3       /* Digitized voice /dev/dsp */
#define SND_DEV_AUDIO   4       /* Sparc compatible /dev/audio */
#define SND_DEV_DSP16   5       /* Like /dev/dsp but 16 bits/sample */
#define SND_DEV_STATUS  6       /* /dev/sndstat */
                                /* #7 not in use now. */
#define SND_DEV_SEQ2    8       /* /dev/sequencer, level 2 interface */
#define SND_DEV_SNDPROC 9       /* /dev/sndproc for programmable devices */
#define SND_DEV_PSS     SND_DEV_SNDPROC /* ? */
#define SND_DEV_NORESET 10

#define SND_DEV_DSPHW_PLAY      11      /* specific playback channel */
#define SND_DEV_DSPHW_VPLAY     12      /* specific virtual playback channel */
#define SND_DEV_DSPHW_REC       13      /* specific record channel */
#define SND_DEV_DSPHW_VREC      14      /* specific virtual record channel */

#define SND_DEV_DSPHW_CD        15      /* s16le/stereo 44100Hz CD */

/* 
 * OSSv4 compatible device. For now, it serve no purpose and
 * the cloning itself will forward the request to ordinary /dev/dsp
 * instead.
 */
#define SND_DEV_DSP_MMAP        16      /* /dev/dsp_mmap     */
#define SND_DEV_DSP_AC3         17      /* /dev/dsp_ac3      */
#define SND_DEV_DSP_MULTICH     18      /* /dev/dsp_multich  */
#define SND_DEV_DSP_SPDIFOUT    19      /* /dev/dsp_spdifout */
#define SND_DEV_DSP_SPDIFIN     20      /* /dev/dsp_spdifin  */

#define SND_DEV_LAST            SND_DEV_DSP_SPDIFIN
#define SND_DEV_MAX             PCMMAXDEV

#define DSP_DEFAULT_SPEED       8000

#define ON              1
#define OFF             0

extern int pcm_veto_load;
extern int snd_unit;
extern int snd_maxautovchans;
extern int snd_verbose;
extern devclass_t pcm_devclass;
extern struct unrhdr *pcmsg_unrhdr;

/*
 * some macros for debugging purposes
 * DDB/DEB to enable/disable debugging stuff
 * BVDDB   to enable debugging when bootverbose
 */
#define BVDDB(x) if (bootverbose) x

#ifndef DEB
#define DEB(x)
#endif

SYSCTL_DECL(_hw_snd);

int pcm_setvchans(struct snddev_info *d, int direction, int newcnt, int num);
int pcm_chnalloc(struct snddev_info *d, struct pcm_channel **ch, int direction,
    pid_t pid, char *comm, int devunit);
int pcm_chnrelease(struct pcm_channel *c);
int pcm_chnref(struct pcm_channel *c, int ref);
int pcm_inprog(struct snddev_info *d, int delta);

struct pcm_channel *pcm_chn_create(struct snddev_info *d, struct pcm_channel *parent, kobj_class_t cls, int dir, int num, void *devinfo);
int pcm_chn_destroy(struct pcm_channel *ch);
int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch);
int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch);

int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo);
unsigned int pcm_getbuffersize(device_t dev, unsigned int minbufsz, unsigned int deflt, unsigned int maxbufsz);
int pcm_register(device_t dev, void *devinfo, int numplay, int numrec);
int pcm_unregister(device_t dev);
int pcm_setstatus(device_t dev, char *str);
u_int32_t pcm_getflags(device_t dev);
void pcm_setflags(device_t dev, u_int32_t val);
void *pcm_getdevinfo(device_t dev);


int snd_setup_intr(device_t dev, struct resource *res, int flags,
                   driver_intr_t hand, void *param, void **cookiep);

void *snd_mtxcreate(const char *desc, const char *type);
void snd_mtxfree(void *m);
void snd_mtxassert(void *m);
#define snd_mtxlock(m) lockmgr(m, LK_EXCLUSIVE)
#define snd_mtxunlock(m) lockmgr(m, LK_RELEASE)

typedef int (*sndstat_handler)(struct sbuf *s, device_t dev, int verbose);
int sndstat_acquire(struct thread *td);
int sndstat_release(struct thread *td);
int sndstat_register(device_t dev, char *str, sndstat_handler handler);
int sndstat_registerfile(char *str);
int sndstat_unregister(device_t dev);
int sndstat_unregisterfile(char *str);

#define SND_DECLARE_FILE(version) \
        _SND_DECLARE_FILE(__LINE__, version)

#define _SND_DECLARE_FILE(uniq, version) \
        __SND_DECLARE_FILE(uniq, version)

#define __SND_DECLARE_FILE(uniq, version) \
        static char sndstat_vinfo[] = version; \
        SYSINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_registerfile, sndstat_vinfo); \
        SYSUNINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_unregisterfile, sndstat_vinfo)

/* usage of flags in device config entry (config file) */
#define DV_F_DRQ_MASK   0x00000007      /* mask for secondary drq */
#define DV_F_DUAL_DMA   0x00000010      /* set to use secondary dma channel */

/* ought to be made obsolete but still used by mss */
#define DV_F_DEV_MASK   0x0000ff00      /* force device type/class */
#define DV_F_DEV_SHIFT  8               /* force device type/class */

/*
 * this is rather kludgey- we need to duplicate these struct def'ns from sound.c
 * so that the macro versions of pcm_{,un}lock can dereference them.
 * we also have to do this now makedev() has gone away.
 */

struct snddev_info {
        struct {
                struct {
                        SLIST_HEAD(, pcm_channel) head;
                        struct {
                                SLIST_HEAD(, pcm_channel) head;
                        } busy;
                        struct {
                                SLIST_HEAD(, pcm_channel) head;
                        } opened;
                } pcm;
        } channels;
        TAILQ_HEAD(dsp_cdevinfo_linkhead, dsp_cdevinfo) dsp_cdevinfo_pool;
        struct snd_clone *clones;
        unsigned devcount, playcount, reccount, pvchancount, rvchancount ;
        unsigned flags;
        int inprog;
        unsigned int bufsz;
        void *devinfo;
        device_t dev;
        char status[SND_STATUSLEN];
        struct lock *lock;
        struct cdev *mixer_dev;
        struct cdev *dsp_clonedev;
        uint32_t pvchanrate, pvchanformat;
        uint32_t rvchanrate, rvchanformat;
        int32_t eqpreamp;
        struct sysctl_ctx_list play_sysctl_ctx, rec_sysctl_ctx;
        struct sysctl_oid *play_sysctl_tree, *rec_sysctl_tree;
        struct cv cv;
};

void    sound_oss_sysinfo(oss_sysinfo *);
int     sound_oss_card_info(oss_card_info *);

#define PCM_LOCKOWNED(d)        (lockstatus((d)->lock, curthread) == LK_EXCLUSIVE)
#define PCM_LOCK(d)             lockmgr((d)->lock, LK_EXCLUSIVE)
#define PCM_UNLOCK(d)           lockmgr((d)->lock, LK_RELEASE)
#define PCM_TRYLOCK(d)          lockmgr_try((d)->lock, LK_EXCLUSIVE)
#define PCM_LOCKASSERT(d)       KKASSERT(lockstatus((d)->lock, curthread) == LK_EXCLUSIVE)
#define PCM_UNLOCKASSERT(d)     KKASSERT(lockstatus((d)->lock, curthread) != LK_EXCLUSIVE)

/*
 * For PCM_[WAIT | ACQUIRE | RELEASE], be sure to surround these
 * with PCM_LOCK/UNLOCK() sequence, or I'll come to gnaw upon you!
 */
#ifdef SND_DIAGNOSTIC
#define PCM_WAIT(x)             do {                                    \
        if (!PCM_LOCKOWNED(x))                                          \
                panic("%s(%d): [PCM WAIT] Mutex not owned!",            \
                    __func__, __LINE__);                                \
        while ((x)->flags & SD_F_BUSY) {                                \
                if (snd_verbose > 3)                                    \
                        device_printf((x)->dev,                         \
                            "%s(%d): [PCM WAIT] calling cv_wait().\n",  \
                            __func__, __LINE__);                        \
                cv_wait(&(x)->cv, (x)->lock);                           \
        }                                                               \
} while (0)

#define PCM_ACQUIRE(x)          do {                                    \
        if (!PCM_LOCKOWNED(x))                                          \
                panic("%s(%d): [PCM ACQUIRE] Mutex not owned!",         \
                    __func__, __LINE__);                                \
        if ((x)->flags & SD_F_BUSY)                                     \
                panic("%s(%d): [PCM ACQUIRE] "                          \
                    "Trying to acquire BUSY cv!", __func__, __LINE__);  \
        (x)->flags |= SD_F_BUSY;                                        \
} while (0)

#define PCM_RELEASE(x)          do {                                    \
        if (!PCM_LOCKOWNED(x))                                          \
                panic("%s(%d): [PCM RELEASE] Mutex not owned!",         \
                    __func__, __LINE__);                                \
        if ((x)->flags & SD_F_BUSY) {                                   \
                (x)->flags &= ~SD_F_BUSY;                               \
                if ((x)->cv.cv_waiters != 0) {                          \
                        if ((x)->cv.cv_waiters > 1 && snd_verbose > 3)  \
                                device_printf((x)->dev,                 \
                                    "%s(%d): [PCM RELEASE] "            \
                                    "cv_waiters=%d > 1!\n",             \
                                    __func__, __LINE__,                 \
                                    (x)->cv.cv_waiters);                \
                        cv_broadcast(&(x)->cv);                         \
                }                                                       \
        } else                                                          \
                panic("%s(%d): [PCM RELEASE] Releasing non-BUSY cv!",   \
                    __func__, __LINE__);                                \
} while (0)

/* Quick version, for shorter path. */
#define PCM_ACQUIRE_QUICK(x)    do {                                    \
        if (PCM_LOCKOWNED(x))                                           \
                panic("%s(%d): [PCM ACQUIRE QUICK] Mutex owned!",       \
                    __func__, __LINE__);                                \
        PCM_LOCK(x);                                                    \
        PCM_WAIT(x);                                                    \
        PCM_ACQUIRE(x);                                                 \
        PCM_UNLOCK(x);                                                  \
} while (0)

#define PCM_RELEASE_QUICK(x)    do {                                    \
        if (PCM_LOCKOWNED(x))                                           \
                panic("%s(%d): [PCM RELEASE QUICK] Mutex owned!",       \
                    __func__, __LINE__);                                \
        PCM_LOCK(x);                                                    \
        PCM_RELEASE(x);                                                 \
        PCM_UNLOCK(x);                                                  \
} while (0)

#define PCM_BUSYASSERT(x)       do {                                    \
        if (!((x) != NULL && ((x)->flags & SD_F_BUSY)))                 \
                panic("%s(%d): [PCM BUSYASSERT] "                       \
                    "Failed, snddev_info=%p", __func__, __LINE__, x);   \
} while (0)

#define PCM_GIANT_ENTER(x)      do {                                    \
        int _pcm_giant = 0;                                             \
        if (PCM_LOCKOWNED(x))                                           \
                panic("%s(%d): [GIANT ENTER] PCM lock owned!",          \
                    __func__, __LINE__);                                \
        if (mtx_owned(&Giant) != 0 && snd_verbose > 3)                  \
                device_printf((x)->dev,                                 \
                    "%s(%d): [GIANT ENTER] Giant owned!\n",             \
                    __func__, __LINE__);                                \
        if (!((x)->flags & SD_F_MPSAFE) && mtx_owned(&Giant) == 0)      \
                do {                                                    \
                        mtx_lock(&Giant);                               \
                        _pcm_giant = 1;                                 \
                } while (0)

#define PCM_GIANT_EXIT(x)       do {                                    \
        if (PCM_LOCKOWNED(x))                                           \
                panic("%s(%d): [GIANT EXIT] PCM lock owned!",           \
                    __func__, __LINE__);                                \
        if (!(_pcm_giant == 0 || _pcm_giant == 1))                      \
                panic("%s(%d): [GIANT EXIT] _pcm_giant screwed!",       \
                    __func__, __LINE__);                                \
        if ((x)->flags & SD_F_MPSAFE) {                                 \
                if (_pcm_giant == 1)                                    \
                        panic("%s(%d): [GIANT EXIT] MPSAFE Giant?",     \
                            __func__, __LINE__);                        \
                if (mtx_owned(&Giant) != 0 && snd_verbose > 3)          \
                        device_printf((x)->dev,                         \
                            "%s(%d): [GIANT EXIT] Giant owned!\n",      \
                            __func__, __LINE__);                        \
        }                                                               \
        if (_pcm_giant != 0) {                                          \
                if (mtx_owned(&Giant) == 0)                             \
                        panic("%s(%d): [GIANT EXIT] Giant not owned!",  \
                            __func__, __LINE__);                        \
                _pcm_giant = 0;                                         \
                mtx_unlock(&Giant);                                     \
        }                                                               \
} while (0)
#else /* SND_DIAGNOSTIC */
#define PCM_WAIT(x)             do {                                    \
        PCM_LOCKASSERT(x);                                              \
        while ((x)->flags & SD_F_BUSY)                                  \
                cv_wait(&(x)->cv, (x)->lock);                           \
} while (0)

#define PCM_ACQUIRE(x)          do {                                    \
        PCM_LOCKASSERT(x);                                              \
        KASSERT(!((x)->flags & SD_F_BUSY),                              \
            ("%s(%d): [PCM ACQUIRE] Trying to acquire BUSY cv!",        \
            __func__, __LINE__));                                       \
        (x)->flags |= SD_F_BUSY;                                        \
} while (0)

#define PCM_RELEASE(x)          do {                                    \
        PCM_LOCKASSERT(x);                                              \
        KASSERT((x)->flags & SD_F_BUSY,                                 \
            ("%s(%d): [PCM RELEASE] Releasing non-BUSY cv!",            \
            __func__, __LINE__));                                       \
        (x)->flags &= ~SD_F_BUSY;                                       \
        if ((x)->cv.cv_waiters != 0)                                    \
                cv_broadcast(&(x)->cv);                                 \
} while (0)

/* Quick version, for shorter path. */
#define PCM_ACQUIRE_QUICK(x)    do {                                    \
        PCM_UNLOCKASSERT(x);                                            \
        PCM_LOCK(x);                                                    \
        PCM_WAIT(x);                                                    \
        PCM_ACQUIRE(x);                                                 \
        PCM_UNLOCK(x);                                                  \
} while (0)

#define PCM_RELEASE_QUICK(x)    do {                                    \
        PCM_UNLOCKASSERT(x);                                            \
        PCM_LOCK(x);                                                    \
        PCM_RELEASE(x);                                                 \
        PCM_UNLOCK(x);                                                  \
} while (0)

#define PCM_BUSYASSERT(x)       KASSERT(x != NULL &&                    \
                                    ((x)->flags & SD_F_BUSY),           \
                                    ("%s(%d): [PCM BUSYASSERT] "        \
                                    "Failed, snddev_info=%p",           \
                                    __func__, __LINE__, x))

#define PCM_GIANT_ENTER(x)      do {                                    \
        if (!((x)->flags & SD_F_MPSAFE))                                \
                get_mplock();                                           \
} while (0)

#define PCM_GIANT_EXIT(x)       do {                                    \
        if (!((x)->flags & SD_F_MPSAFE))                                \
                rel_mplock();                                           \
} while (0)
#endif /* !SND_DIAGNOSTIC */

#define PCM_GIANT_LEAVE(x)      PCM_GIANT_EXIT(x)

#ifdef KLD_MODULE
#define PCM_KLDSTRING(a) ("kld " # a)
#else
#define PCM_KLDSTRING(a) ""
#endif

#endif /* _KERNEL */

#endif  /* _OS_H_ */