sys/dev/sound/pcm/sound.h

   1 /*
   2  * Copyright (c) 1999 Cameron Grant <gandalf@vilnya.demon.co.uk>
   3  * Copyright by Hannu Savolainen 1995
   4  * All rights reserved.
   5  *
   6  * Redistribution and use in source and binary forms, with or without
   7  * modification, are permitted provided that the following conditions
   8  * are met:
   9  * 1. Redistributions of source code must retain the above copyright
  10  *    notice, this list of conditions and the following disclaimer.
  11  * 2. Redistributions in binary form must reproduce the above copyright
  12  *    notice, this list of conditions and the following disclaimer in the
  13  *    documentation and/or other materials provided with the distribution.
  14  *
  15  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  16  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  17  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  18  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
  19  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  20  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  21  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  22  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  23  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  24  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  25  * SUCH DAMAGE.
  26  *
  27  * $FreeBSD: src/sys/dev/sound/pcm/sound.h,v 1.10.2.11 2002/04/22 15:49:36 cg Exp $
  28  * $DragonFly: src/sys/dev/sound/pcm/sound.h,v 1.7 2005/10/12 17:35:55 dillon Exp $
  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/tty.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 defined(__FreeBSD__) && __FreeBSD_version > 500000
  57 #include <sys/bio.h>
  58 #endif
  59 #include <sys/buf.h>
  60 #include <machine/clock.h>      /* for DELAY */
  61 #include <machine/resource.h>
  62 #include <machine/bus.h>
  63 #include <sys/rman.h>
  64 #include <sys/mman.h>
  65 #include <sys/poll.h>
  66 #include <sys/sbuf.h>
  67 #include <sys/soundcard.h>
  68 #include <sys/sysctl.h>
  69 #include <sys/thread2.h>
  70 #include <bus/isa/isavar.h>
  71 #include <sys/kobj.h>
  72 #include <vm/vm.h>
  73 #include <vm/pmap.h>
  74
  75 #undef  USING_MUTEX
  76 #undef  USING_DEVFS
  77
  78 #if defined(__FreeBSD__) && __FreeBSD_version > 500000
  79 #define USING_MUTEX
  80 #define USING_DEVFS
  81 #endif
  82
  83 #define SND_DYNSYSCTL
  84
  85 struct pcm_channel;
  86 struct pcm_feeder;
  87 struct snd_dbuf;
  88 struct snd_mixer;
  89
  90 #include <dev/sound/pcm/buffer.h>
  91 #include <dev/sound/pcm/channel.h>
  92 #include <dev/sound/pcm/feeder.h>
  93 #include <dev/sound/pcm/mixer.h>
  94 #include <dev/sound/pcm/dsp.h>
  95
  96 #define PCM_SOFTC_SIZE  512
  97
  98 #define SND_STATUSLEN   64
  99 /* descriptor of audio device */
 100 #ifndef ISADMA_WRITE
 101 #define ISADMA_WRITE B_WRITE
 102 #define ISADMA_READ B_READ
 103 #define ISADMA_RAW B_RAW
 104 #endif
 105
 106 #define PCM_MODVER      1
 107
 108 #define PCM_MINVER      1
 109 #define PCM_PREFVER     PCM_MODVER
 110 #define PCM_MAXVER      1
 111
 112 /*
 113 PROPOSAL:
 114 each unit needs:
 115 status, mixer, dsp, dspW, audio, sequencer, midi-in, seq2, sndproc = 9 devices
 116 dspW and audio are deprecated.
 117 dsp needs min 64 channels, will give it 256
 118
 119 minor = (unit << 20) + (dev << 16) + channel
 120 currently minor = (channel << 16) + (unit << 4) + dev
 121
 122 nomenclature:
 123         /dev/pcmX/dsp.(0..255)
 124         /dev/pcmX/dspW
 125         /dev/pcmX/audio
 126         /dev/pcmX/status
 127         /dev/pcmX/mixer
 128         [etc.]
 129 */
 130
 131 #define PCMMINOR(x) (minor(x))
 132 #define PCMCHAN(x) ((PCMMINOR(x) & 0x00ff0000) >> 16)
 133 #define PCMUNIT(x) ((PCMMINOR(x) & 0x000000f0) >> 4)
 134 #define PCMDEV(x)   (PCMMINOR(x) & 0x0000000f)
 135 #define PCMMKMINOR(u, d, c) ((((c) & 0xff) << 16) | (((u) & 0x0f) << 4) | ((d) & 0x0f))
 136
 137 #define SD_F_SIMPLEX            0x00000001
 138 #define SD_F_AUTOVCHAN          0x00000002
 139 #define SD_F_PRIO_RD            0x10000000
 140 #define SD_F_PRIO_WR            0x20000000
 141 #define SD_F_PRIO_SET           (SD_F_PRIO_RD | SD_F_PRIO_WR)
 142 #define SD_F_DIR_SET            0x40000000
 143 #define SD_F_TRANSIENT          0xf0000000
 144
 145 /* many variables should be reduced to a range. Here define a macro */
 146 #define RANGE(var, low, high) (var) = \
 147         (((var)<(low))? (low) : ((var)>(high))? (high) : (var))
 148 #define DSP_BUFFSIZE (8192)
 149
 150 /* make figuring out what a format is easier. got AFMT_STEREO already */
 151 #define AFMT_32BIT (AFMT_S32_LE | AFMT_S32_BE | AFMT_U32_LE | AFMT_U32_BE)
 152 #define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE)
 153 #define AFMT_8BIT (AFMT_U8 | AFMT_S8)
 154 #define AFMT_SIGNED (AFMT_S16_LE | AFMT_S16_BE | AFMT_S8)
 155 #define AFMT_BIGENDIAN (AFMT_S16_BE | AFMT_U16_BE)
 156
 157 struct pcm_channel *fkchan_setup(device_t dev);
 158 int fkchan_kill(struct pcm_channel *c);
 159
 160 /*
 161  * Major nuber for the sound driver.
 162  */
 163 #define SND_CDEV_MAJOR 30
 164
 165 #define SND_MAXVCHANS   255
 166
 167 /*
 168  * Minor numbers for the sound driver.
 169  *
 170  * Unfortunately Creative called the codec chip of SB as a DSP. For this
 171  * reason the /dev/dsp is reserved for digitized audio use. There is a
 172  * device for true DSP processors but it will be called something else.
 173  * In v3.0 it's /dev/sndproc but this could be a temporary solution.
 174  */
 175
 176 #define SND_DEV_CTL     0       /* Control port /dev/mixer */
 177 #define SND_DEV_SEQ     1       /* Sequencer /dev/sequencer */
 178 #define SND_DEV_MIDIN   2       /* Raw midi access */
 179 #define SND_DEV_DSP     3       /* Digitized voice /dev/dsp */
 180 #define SND_DEV_AUDIO   4       /* Sparc compatible /dev/audio */
 181 #define SND_DEV_DSP16   5       /* Like /dev/dsp but 16 bits/sample */
 182 #define SND_DEV_STATUS  6       /* /dev/sndstat */
 183                                 /* #7 not in use now. */
 184 #define SND_DEV_SEQ2    8       /* /dev/sequencer, level 2 interface */
 185 #define SND_DEV_SNDPROC 9       /* /dev/sndproc for programmable devices */
 186 #define SND_DEV_PSS     SND_DEV_SNDPROC /* ? */
 187 #define SND_DEV_NORESET 10
 188 #define SND_DEV_DSPREC  11      /* recording channels */
 189
 190 #define DSP_DEFAULT_SPEED       8000
 191
 192 #define ON              1
 193 #define OFF             0
 194
 195 extern int pcm_veto_load;
 196 extern int snd_unit;
 197 extern devclass_t pcm_devclass;
 198
 199 /*
 200  * some macros for debugging purposes
 201  * DDB/DEB to enable/disable debugging stuff
 202  * BVDDB   to enable debugging when bootverbose
 203  */
 204 #define DDB(x)  x       /* XXX */
 205 #define BVDDB(x) if (bootverbose) x
 206
 207 #ifndef DEB
 208 #define DEB(x)
 209 #endif
 210
 211 SYSCTL_DECL(_hw_snd);
 212
 213 struct sysctl_ctx_list *snd_sysctl_tree(device_t dev);
 214 struct sysctl_oid *snd_sysctl_tree_top(device_t dev);
 215
 216 void pcm_lock(struct snddev_info *d);
 217 void pcm_unlock(struct snddev_info *d);
 218 struct pcm_channel *pcm_getfakechan(struct snddev_info *d);
 219 struct pcm_channel *pcm_chnalloc(struct snddev_info *d, int direction, pid_t pid, int chnum);
 220 int pcm_chnrelease(struct pcm_channel *c);
 221 int pcm_chnref(struct pcm_channel *c, int ref);
 222 int pcm_inprog(struct snddev_info *d, int delta);
 223
 224 struct pcm_channel *pcm_chn_create(struct snddev_info *d, struct pcm_channel *parent, kobj_class_t cls, int dir, void *devinfo);
 225 int pcm_chn_destroy(struct pcm_channel *ch);
 226 int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch, int mkdev);
 227 int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch, int rmdev);
 228
 229 int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo);
 230 unsigned int pcm_getbuffersize(device_t dev, unsigned int min, unsigned int deflt, unsigned int max);
 231 int pcm_register(device_t dev, void *devinfo, int numplay, int numrec);
 232 int pcm_unregister(device_t dev);
 233 int pcm_setstatus(device_t dev, char *str);
 234 u_int32_t pcm_getflags(device_t dev);
 235 void pcm_setflags(device_t dev, u_int32_t val);
 236 void *pcm_getdevinfo(device_t dev);
 237
 238 int snd_setup_intr(device_t dev, struct resource *res, int flags,
 239                    driver_intr_t hand, void *param,
 240                    void **cookiep, lwkt_serialize_t serializer);
 241
 242 void *snd_mtxcreate(const char *desc, const char *type);
 243 void snd_mtxfree(void *m);
 244 void snd_mtxassert(void *m);
 245 void snd_mtxlock(void *m);
 246 void snd_mtxunlock(void *m);
 247
 248 int sysctl_hw_snd_vchans(SYSCTL_HANDLER_ARGS);
 249
 250 typedef int (*sndstat_handler)(struct sbuf *s, device_t dev, int verbose);
 251 int sndstat_register(device_t dev, char *str, sndstat_handler handler);
 252 int sndstat_registerfile(char *str);
 253 int sndstat_unregister(device_t dev);
 254 int sndstat_unregisterfile(char *str);
 255 int sndstat_busy(void);
 256
 257 #define SND_DECLARE_FILE(version) \
 258         _SND_DECLARE_FILE(__LINE__, version)
 259
 260 #define _SND_DECLARE_FILE(uniq, version) \
 261         __SND_DECLARE_FILE(uniq, version)
 262
 263 #define __SND_DECLARE_FILE(uniq, version) \
 264         static char sndstat_vinfo[] = version; \
 265         SYSINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_registerfile, sndstat_vinfo); \
 266         SYSUNINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_unregisterfile, sndstat_vinfo);
 267
 268 /* usage of flags in device config entry (config file) */
 269 #define DV_F_DRQ_MASK   0x00000007      /* mask for secondary drq */
 270 #define DV_F_DUAL_DMA   0x00000010      /* set to use secondary dma channel */
 271
 272 /* ought to be made obsolete */
 273 #define DV_F_DEV_MASK   0x0000ff00      /* force device type/class */
 274 #define DV_F_DEV_SHIFT  8               /* force device type/class */
 275
 276 #endif /* _KERNEL */
 277
 278 #endif  /* _OS_H_ */