sound.h revision 78853
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: head/sys/dev/sound/pcm/sound.h 78853 2001-06-26 21:54:55Z cg $ 28 */ 29 30/* 31 * first, include kernel header files. 32 */ 33 34#ifndef _OS_H_ 35#define _OS_H_ 36 37#ifdef _KERNEL 38#include <sys/param.h> 39#include <sys/systm.h> 40#include <sys/ioccom.h> 41#include <sys/filio.h> 42#include <sys/sockio.h> 43#include <sys/fcntl.h> 44#include <sys/tty.h> 45#include <sys/proc.h> 46#include <sys/kernel.h> /* for DATA_SET */ 47#include <sys/module.h> 48#include <sys/conf.h> 49#include <sys/file.h> 50#include <sys/uio.h> 51#include <sys/syslog.h> 52#include <sys/errno.h> 53#include <sys/malloc.h> 54#include <sys/bus.h> 55#if __FreeBSD_version > 500000 56#include <sys/bio.h> 57#endif 58#include <sys/buf.h> 59#include <machine/clock.h> /* for DELAY */ 60#include <machine/resource.h> 61#include <machine/bus.h> 62#include <sys/rman.h> 63#include <sys/mman.h> 64#include <sys/poll.h> 65#include <sys/soundcard.h> 66#include <sys/sysctl.h> 67#include <isa/isavar.h> 68#include <sys/kobj.h> 69#include <vm/vm.h> 70#include <vm/pmap.h> 71 72#undef USING_MUTEX 73#undef USING_DEVFS 74 75#if __FreeBSD_version > 500000 76#define USING_MUTEX 77#define USING_DEVFS 78#endif 79#define SND_DYNSYSCTL 80 81#ifndef INTR_MPSAFE 82#define INTR_MPSAFE 0 83#endif 84 85#else 86struct isa_device { int dummy; }; 87#define d_open_t void 88#define d_close_t void 89#define d_read_t void 90#define d_write_t void 91#define d_ioctl_t void 92#define d_select_t void 93#endif /* _KERNEL */ 94 95#endif /* _OS_H_ */ 96 97struct pcm_channel; 98struct pcm_feeder; 99struct snd_dbuf; 100struct snd_mixer; 101 102#include <dev/sound/pcm/buffer.h> 103#include <dev/sound/pcm/channel.h> 104#include <dev/sound/pcm/feeder.h> 105#include <dev/sound/pcm/mixer.h> 106#include <dev/sound/pcm/dsp.h> 107 108struct snddev_channel { 109 SLIST_ENTRY(snddev_channel) link; 110 struct pcm_channel *channel; 111}; 112 113#define SND_STATUSLEN 64 114/* descriptor of audio device */ 115struct snddev_info { 116 SLIST_HEAD(, snddev_channel) channels; 117 struct pcm_channel *fakechan; 118 unsigned chancount; 119 unsigned flags; 120 int inprog; 121 void *devinfo; 122 device_t dev; 123 char status[SND_STATUSLEN]; 124 struct sysctl_ctx_list sysctl_tree; 125 struct sysctl_oid *sysctl_tree_top; 126 void *lock; 127}; 128 129#ifndef ISADMA_WRITE 130#define ISADMA_WRITE B_WRITE 131#define ISADMA_READ B_READ 132#define ISADMA_RAW B_RAW 133#endif 134 135#define PCM_MODVER 1 136 137#define PCM_MINVER 1 138#define PCM_PREFVER PCM_MODVER 139#define PCM_MAXVER 1 140 141/* 142PROPOSAL: 143each unit needs: 144status, mixer, dsp, dspW, audio, sequencer, midi-in, seq2, sndproc = 9 devices 145dspW and audio are deprecated. 146dsp needs min 64 channels, will give it 256 147 148minor = (unit << 20) + (dev << 16) + channel 149currently minor = (channel << 16) + (unit << 4) + dev 150 151nomenclature: 152 /dev/pcmX/dsp.(0..255) 153 /dev/pcmX/dspW 154 /dev/pcmX/audio 155 /dev/pcmX/status 156 /dev/pcmX/mixer 157 [etc.] 158*/ 159 160#define PCMMINOR(x) (minor(x)) 161#define PCMCHAN(x) ((PCMMINOR(x) & 0x00ff0000) >> 16) 162#define PCMUNIT(x) ((PCMMINOR(x) & 0x000000f0) >> 4) 163#define PCMDEV(x) (PCMMINOR(x) & 0x0000000f) 164#define PCMMKMINOR(u, d, c) ((((c) & 0xff) << 16) | (((u) & 0x0f) << 4) | ((d) & 0x0f)) 165 166#define SD_F_SIMPLEX 0x00000001 167#define SD_F_AUTOVCHAN 0x00000002 168#define SD_F_PRIO_RD 0x10000000 169#define SD_F_PRIO_WR 0x20000000 170#define SD_F_PRIO_SET (SD_F_PRIO_RD | SD_F_PRIO_WR) 171#define SD_F_DIR_SET 0x40000000 172#define SD_F_TRANSIENT 0xf0000000 173 174/* many variables should be reduced to a range. Here define a macro */ 175#define RANGE(var, low, high) (var) = \ 176 (((var)<(low))? (low) : ((var)>(high))? (high) : (var)) 177#define DSP_BUFFSIZE (8192) 178 179/* make figuring out what a format is easier. got AFMT_STEREO already */ 180#define AFMT_32BIT (AFMT_S32_LE | AFMT_S32_BE | AFMT_U32_LE | AFMT_U32_BE) 181#define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE) 182#define AFMT_8BIT (AFMT_U8 | AFMT_S8) 183#define AFMT_SIGNED (AFMT_S16_LE | AFMT_S16_BE | AFMT_S8) 184#define AFMT_BIGENDIAN (AFMT_S16_BE | AFMT_U16_BE) 185 186struct pcm_channel *fkchan_setup(device_t dev); 187int fkchan_kill(struct pcm_channel *c); 188 189/* 190 * Major nuber for the sound driver. 191 */ 192#define SND_CDEV_MAJOR 30 193 194#define SND_MAXVCHANS 255 195 196/* 197 * Minor numbers for the sound driver. 198 * 199 * Unfortunately Creative called the codec chip of SB as a DSP. For this 200 * reason the /dev/dsp is reserved for digitized audio use. There is a 201 * device for true DSP processors but it will be called something else. 202 * In v3.0 it's /dev/sndproc but this could be a temporary solution. 203 */ 204 205#define SND_DEV_CTL 0 /* Control port /dev/mixer */ 206#define SND_DEV_SEQ 1 /* Sequencer /dev/sequencer */ 207#define SND_DEV_MIDIN 2 /* Raw midi access */ 208#define SND_DEV_DSP 3 /* Digitized voice /dev/dsp */ 209#define SND_DEV_AUDIO 4 /* Sparc compatible /dev/audio */ 210#define SND_DEV_DSP16 5 /* Like /dev/dsp but 16 bits/sample */ 211#define SND_DEV_STATUS 6 /* /dev/sndstat */ 212 /* #7 not in use now. */ 213#define SND_DEV_SEQ2 8 /* /dev/sequencer, level 2 interface */ 214#define SND_DEV_SNDPROC 9 /* /dev/sndproc for programmable devices */ 215#define SND_DEV_PSS SND_DEV_SNDPROC /* ? */ 216#define SND_DEV_NORESET 10 217 218#define DSP_DEFAULT_SPEED 8000 219 220#define ON 1 221#define OFF 0 222 223#ifdef _KERNEL 224 225extern int snd_unit; 226extern devclass_t pcm_devclass; 227 228/* 229 * some macros for debugging purposes 230 * DDB/DEB to enable/disable debugging stuff 231 * BVDDB to enable debugging when bootverbose 232 */ 233#define DDB(x) x /* XXX */ 234#define BVDDB(x) if (bootverbose) x 235 236#ifndef DEB 237#define DEB(x) 238#endif 239 240SYSCTL_DECL(_hw_snd); 241 242struct pcm_channel *pcm_chnalloc(struct snddev_info *d, int direction, pid_t pid); 243int pcm_chnrelease(struct pcm_channel *c); 244int pcm_chnref(struct pcm_channel *c, int ref); 245 246struct pcm_channel *pcm_chn_create(struct snddev_info *d, struct pcm_channel *parent, kobj_class_t cls, int dir, void *devinfo); 247int pcm_chn_destroy(struct pcm_channel *ch); 248int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch); 249int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch); 250 251int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo); 252int pcm_register(device_t dev, void *devinfo, int numplay, int numrec); 253int pcm_unregister(device_t dev); 254int pcm_setstatus(device_t dev, char *str); 255u_int32_t pcm_getflags(device_t dev); 256void pcm_setflags(device_t dev, u_int32_t val); 257void *pcm_getdevinfo(device_t dev); 258 259int snd_setup_intr(device_t dev, struct resource *res, int flags, 260 driver_intr_t hand, void *param, void **cookiep); 261 262void *snd_mtxcreate(const char *desc); 263void snd_mtxfree(void *m); 264void snd_mtxassert(void *m); 265void snd_mtxlock(void *m); 266void snd_mtxunlock(void *m); 267#endif /* _KERNEL */ 268 269/* usage of flags in device config entry (config file) */ 270#define DV_F_DRQ_MASK 0x00000007 /* mask for secondary drq */ 271#define DV_F_DUAL_DMA 0x00000010 /* set to use secondary dma channel */ 272 273/* ought to be made obsolete */ 274#define DV_F_DEV_MASK 0x0000ff00 /* force device type/class */ 275#define DV_F_DEV_SHIFT 8 /* force device type/class */ 276