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

     /*
      * Copyright (c) 1999 Cameron Grant <cg@freebsd.org>
      * Copyright by Hannu Savolainen 1995
      * 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: releng/5.2/sys/dev/sound/pcm/sound.h 119853 2003-09-07 16:28:03Z cg $
     */
    
    /*
     * first, include kernel header files.
     */
    
    #ifndef _OS_H_
    #define _OS_H_
    
    #ifdef _KERNEL
    #include <sys/param.h>
    #include <sys/systm.h>
    #include <sys/ioccom.h>
    #include <sys/filio.h>
    #include <sys/sockio.h>
    #include <sys/fcntl.h>
    #include <sys/tty.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>
    #if __FreeBSD_version < 500000
    #include <sys/buf.h>
    #endif
    #include <machine/clock.h>      /* for DELAY */
    #include <machine/resource.h>
    #include <machine/bus.h>
    #include <sys/rman.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>
    
    #undef  USING_MUTEX
    #undef  USING_DEVFS
    
    #if __FreeBSD_version > 500000
    #include <sys/lock.h>
    #include <sys/mutex.h>
    
    #define USING_MUTEX
    #define USING_DEVFS
    #endif
    
    #define SND_DYNSYSCTL
    
    #ifndef INTR_MPSAFE
    #define INTR_TYPE_AV    INTR_TYPE_TTY
    #endif
    
    #ifndef INTR_MPSAFE
    #define INTR_MPSAFE     0
    #endif
    
    struct pcm_channel;
    struct pcm_feeder;
    struct snd_dbuf;
    struct snd_mixer;
    
    #include <dev/sound/pcm/buffer.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>
   
   #define PCM_SOFTC_SIZE  512
   
   #define SND_STATUSLEN   64
   
   #define PCM_MODVER      1
   
   #define PCM_MINVER      1
   #define PCM_PREFVER     PCM_MODVER
   #define PCM_MAXVER      1
   
   /*
   PROPOSAL:
   each unit needs:
   status, mixer, dsp, dspW, audio, sequencer, midi-in, seq2, sndproc = 9 devices
   dspW and audio are deprecated.
   dsp needs min 64 channels, will give it 256
   
   minor = (unit << 20) + (dev << 16) + channel
   currently minor = (channel << 16) + (unit << 4) + dev
   
   nomenclature:
           /dev/pcmX/dsp.(0..255)
           /dev/pcmX/dspW
           /dev/pcmX/audio
           /dev/pcmX/status
           /dev/pcmX/mixer
           [etc.]
   */
   
   #define PCMMINOR(x) (minor(x))
   #define PCMCHAN(x) ((PCMMINOR(x) & 0x00ff0000) >> 16)
   #define PCMUNIT(x) ((PCMMINOR(x) & 0x000000f0) >> 4)
   #define PCMDEV(x)   (PCMMINOR(x) & 0x0000000f)
   #define PCMMKMINOR(u, d, c) ((((c) & 0xff) << 16) | (((u) & 0x0f) << 4) | ((d) & 0x0f))
   
   #define SD_F_SIMPLEX            0x00000001
   #define SD_F_AUTOVCHAN          0x00000002
   #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
   
   /* 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_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE)
   #define AFMT_8BIT (AFMT_U8 | AFMT_S8)
   #define AFMT_SIGNED (AFMT_S16_LE | AFMT_S16_BE | AFMT_S8)
   #define AFMT_BIGENDIAN (AFMT_S16_BE | AFMT_U16_BE)
   
   struct pcm_channel *fkchan_setup(device_t dev);
   int fkchan_kill(struct pcm_channel *c);
   
   /*
    * Major nuber for the sound driver.
    */
   #define SND_CDEV_MAJOR 30
   
   #define SND_MAXVCHANS   255
   
   /*
    * 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_DSPREC  11      /* recording channels */
   
   #define DSP_DEFAULT_SPEED       8000
   
   #define ON              1
   #define OFF             0
   
   extern int pcm_veto_load;
   extern int snd_unit;
   extern devclass_t pcm_devclass;
   
   /*
    * some macros for debugging purposes
    * DDB/DEB to enable/disable debugging stuff
    * BVDDB   to enable debugging when bootverbose
    */
   #define DDB(x)  x       /* XXX */
   #define BVDDB(x) if (bootverbose) x
   
   #ifndef DEB
   #define DEB(x)
   #endif
   
   SYSCTL_DECL(_hw_snd);
   
   struct sysctl_ctx_list *snd_sysctl_tree(device_t dev);
   struct sysctl_oid *snd_sysctl_tree_top(device_t dev);
   
   struct pcm_channel *pcm_getfakechan(struct snddev_info *d);
   struct pcm_channel *pcm_chnalloc(struct snddev_info *d, int direction, pid_t pid, int chnum);
   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, void *devinfo);
   int pcm_chn_destroy(struct pcm_channel *ch);
   int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch, int mkdev);
   int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch, int rmdev);
   
   int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo);
   unsigned int pcm_getbuffersize(device_t dev, unsigned int min, unsigned int deflt, unsigned int max);
   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) mtx_lock(m)
   #define snd_mtxunlock(m) mtx_unlock(m)
   
   int sysctl_hw_snd_vchans(SYSCTL_HANDLER_ARGS);
   
   typedef int (*sndstat_handler)(struct sbuf *s, device_t dev, int verbose);
   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);
   int sndstat_busy(void);
   
   #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 */
   
   #define PCM_DEBUG_MTX
   
   /*
    * 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.
    */
   
   #ifdef  PCM_DEBUG_MTX
   struct snddev_channel {
           SLIST_ENTRY(snddev_channel) link;
           struct pcm_channel *channel;
   };
   
   struct snddev_info {
           SLIST_HEAD(, snddev_channel) channels;
           struct pcm_channel *fakechan;
           unsigned devcount, playcount, reccount, vchancount;
           unsigned flags;
           int inprog;
           unsigned int bufsz;
           void *devinfo;
           device_t dev;
           char status[SND_STATUSLEN];
           struct sysctl_ctx_list sysctl_tree;
           struct sysctl_oid *sysctl_tree_top;
           struct mtx *lock;
   };
   
   #define pcm_lock(d) mtx_lock(((struct snddev_info *)(d))->lock)
   #define pcm_unlock(d) mtx_unlock(((struct snddev_info *)(d))->lock)
   #else
   void pcm_lock(struct snddev_info *d);
   void pcm_unlock(struct snddev_info *d);
   #endif
   
   #endif /* _KERNEL */
   
   #endif  /* _OS_H_ */

Cache object: 2988c706ae214e8ca33c76a591ed17a0