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