The Design and Implementation of the FreeBSD Operating System, Second Edition
Now available: The Design and Implementation of the FreeBSD Operating System (Second Edition)


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]

FreeBSD/Linux Kernel Cross Reference
sys/dev/sound/pcm/sound.h

Version: -  FREEBSD  -  FREEBSD-12-STABLE  -  FREEBSD-12-0  -  FREEBSD-11-STABLE  -  FREEBSD-11-2  -  FREEBSD-11-1  -  FREEBSD-11-0  -  FREEBSD-10-STABLE  -  FREEBSD-10-4  -  FREEBSD-10-3  -  FREEBSD-10-2  -  FREEBSD-10-1  -  FREEBSD-10-0  -  FREEBSD-9-STABLE  -  FREEBSD-9-3  -  FREEBSD-9-2  -  FREEBSD-9-1  -  FREEBSD-9-0  -  FREEBSD-8-STABLE  -  FREEBSD-8-4  -  FREEBSD-8-3  -  FREEBSD-8-2  -  FREEBSD-8-1  -  FREEBSD-8-0  -  FREEBSD-7-STABLE  -  FREEBSD-7-4  -  FREEBSD-7-3  -  FREEBSD-7-2  -  FREEBSD-7-1  -  FREEBSD-7-0  -  FREEBSD-6-STABLE  -  FREEBSD-6-4  -  FREEBSD-6-3  -  FREEBSD-6-2  -  FREEBSD-6-1  -  FREEBSD-6-0  -  FREEBSD-5-STABLE  -  FREEBSD-5-5  -  FREEBSD-5-4  -  FREEBSD-5-3  -  FREEBSD-5-2  -  FREEBSD-5-1  -  FREEBSD-5-0  -  FREEBSD-4-STABLE  -  FREEBSD-3-STABLE  -  FREEBSD22  -  linux-2.6  -  linux-2.4.22  -  MK83  -  MK84  -  PLAN9  -  DFBSD  -  NETBSD  -  NETBSD5  -  NETBSD4  -  NETBSD3  -  NETBSD20  -  OPENBSD  -  xnu-517  -  xnu-792  -  xnu-792.6.70  -  xnu-1228  -  xnu-1456.1.26  -  xnu-1699.24.8  -  xnu-2050.18.24  -  OPENSOLARIS  -  minix-3-1-1 
SearchContext: -  none  -  3  -  10 

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

Cache object: 4cfbd9a0c185c892372cbd46c02f6bb9


[ source navigation ] [ diff markup ] [ identifier search ] [ freetext search ] [ file search ] [ list types ] [ track identifier ]


This page is part of the FreeBSD/Linux Linux Kernel Cross-Reference, and was automatically generated using a modified version of the LXR engine.