sound.h revision 162588
1/*- 2 * Copyright (c) 1999 Cameron Grant <cg@freebsd.org> 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 162588 2006-09-23 20:45:47Z netchild $ 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/buf.h> 57#endif 58#include <machine/resource.h> 59#include <machine/bus.h> 60#include <sys/rman.h> 61#include <sys/mman.h> 62#include <sys/poll.h> 63#include <sys/sbuf.h> 64#include <sys/soundcard.h> 65#include <sys/sysctl.h> 66#include <sys/kobj.h> 67#include <vm/vm.h> 68#include <vm/pmap.h> 69 70#undef USING_MUTEX 71#undef USING_DEVFS 72 73#if __FreeBSD_version > 500000 74#include <sys/lock.h> 75#include <sys/mutex.h> 76#include <sys/condvar.h> 77 78#define USING_MUTEX 79#define USING_DEVFS 80#else 81#define INTR_TYPE_AV INTR_TYPE_TTY 82#define INTR_MPSAFE 0 83#endif 84 85#define SND_DYNSYSCTL 86 87struct pcm_channel; 88struct pcm_feeder; 89struct snd_dbuf; 90struct snd_mixer; 91 92#include <dev/sound/pcm/buffer.h> 93#include <dev/sound/pcm/channel.h> 94#include <dev/sound/pcm/feeder.h> 95#include <dev/sound/pcm/mixer.h> 96#include <dev/sound/pcm/dsp.h> 97 98#define PCM_SOFTC_SIZE 512 99 100#define SND_STATUSLEN 64 101 102#define SOUND_MODVER 1 103 104#define SOUND_MINVER 1 105#define SOUND_PREFVER SOUND_MODVER 106#define SOUND_MAXVER 1 107 108/* 109PROPOSAL: 110each unit needs: 111status, mixer, dsp, dspW, audio, sequencer, midi-in, seq2, sndproc = 9 devices 112dspW and audio are deprecated. 113dsp needs min 64 channels, will give it 256 114 115minor = (unit << 20) + (dev << 16) + channel 116currently minor = (channel << 16) + (unit << 4) + dev 117 118nomenclature: 119 /dev/pcmX/dsp.(0..255) 120 /dev/pcmX/dspW 121 /dev/pcmX/audio 122 /dev/pcmX/status 123 /dev/pcmX/mixer 124 [etc.] 125*/ 126 127#define PCMMAXCHAN 0xff 128#define PCMMAXDEV 0x0f 129#define PCMMAXUNIT 0x0f 130#define PCMMINOR(x) (minor(x)) 131#define PCMCHAN(x) ((PCMMINOR(x) >> 16) & PCMMAXCHAN) 132#define PCMUNIT(x) ((PCMMINOR(x) >> 4) & PCMMAXUNIT) 133#define PCMDEV(x) (PCMMINOR(x) & PCMMAXDEV) 134#define PCMMKMINOR(u, d, c) ((((c) & PCMMAXCHAN) << 16) | \ 135 (((u) & PCMMAXUNIT) << 4) | ((d) & PCMMAXDEV)) 136 137#define SD_F_SIMPLEX 0x00000001 138#define SD_F_AUTOVCHAN 0x00000002 139#define SD_F_SOFTVOL 0x00000004 140#define SD_F_PRIO_RD 0x10000000 141#define SD_F_PRIO_WR 0x20000000 142#define SD_F_PRIO_SET (SD_F_PRIO_RD | SD_F_PRIO_WR) 143#define SD_F_DIR_SET 0x40000000 144#define SD_F_TRANSIENT 0xf0000000 145 146/* many variables should be reduced to a range. Here define a macro */ 147#define RANGE(var, low, high) (var) = \ 148 (((var)<(low))? (low) : ((var)>(high))? (high) : (var)) 149#define DSP_BUFFSIZE (8192) 150 151/* make figuring out what a format is easier. got AFMT_STEREO already */ 152#define AFMT_32BIT (AFMT_S32_LE | AFMT_S32_BE | AFMT_U32_LE | AFMT_U32_BE) 153#define AFMT_24BIT (AFMT_S24_LE | AFMT_S24_BE | AFMT_U24_LE | AFMT_U24_BE) 154#define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE) 155#define AFMT_8BIT (AFMT_MU_LAW | AFMT_A_LAW | AFMT_U8 | AFMT_S8) 156#define AFMT_SIGNED (AFMT_S32_LE | AFMT_S32_BE | AFMT_S24_LE | AFMT_S24_BE | \ 157 AFMT_S16_LE | AFMT_S16_BE | AFMT_S8) 158#define AFMT_BIGENDIAN (AFMT_S32_BE | AFMT_U32_BE | AFMT_S24_BE | AFMT_U24_BE | \ 159 AFMT_S16_BE | AFMT_U16_BE) 160 161struct pcm_channel *fkchan_setup(device_t dev); 162int fkchan_kill(struct pcm_channel *c); 163 164/* XXX Flawed definition. I'll fix it someday. */ 165#define SND_MAXVCHANS PCMMAXCHAN 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 195extern int pcm_veto_load; 196extern int snd_unit; 197extern devclass_t pcm_devclass; 198extern struct unrhdr *pcmsg_unrhdr; 199 200/* 201 * some macros for debugging purposes 202 * DDB/DEB to enable/disable debugging stuff 203 * BVDDB to enable debugging when bootverbose 204 */ 205#define BVDDB(x) if (bootverbose) x 206 207#ifndef DEB 208#define DEB(x) 209#endif 210 211SYSCTL_DECL(_hw_snd); 212 213struct sysctl_ctx_list *snd_sysctl_tree(device_t dev); 214struct sysctl_oid *snd_sysctl_tree_top(device_t dev); 215 216struct pcm_channel *pcm_getfakechan(struct snddev_info *d); 217int pcm_chnalloc(struct snddev_info *d, struct pcm_channel **ch, int direction, pid_t pid, int chnum); 218int pcm_chnrelease(struct pcm_channel *c); 219int pcm_chnref(struct pcm_channel *c, int ref); 220int pcm_inprog(struct snddev_info *d, int delta); 221 222struct pcm_channel *pcm_chn_create(struct snddev_info *d, struct pcm_channel *parent, kobj_class_t cls, int dir, void *devinfo); 223int pcm_chn_destroy(struct pcm_channel *ch); 224int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch); 225int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch); 226 227int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo); 228unsigned int pcm_getbuffersize(device_t dev, unsigned int minbufsz, unsigned int deflt, unsigned int maxbufsz); 229int pcm_register(device_t dev, void *devinfo, int numplay, int numrec); 230int pcm_unregister(device_t dev); 231int pcm_setstatus(device_t dev, char *str); 232u_int32_t pcm_getflags(device_t dev); 233void pcm_setflags(device_t dev, u_int32_t val); 234void *pcm_getdevinfo(device_t dev); 235 236 237int snd_setup_intr(device_t dev, struct resource *res, int flags, 238 driver_intr_t hand, void *param, void **cookiep); 239 240void *snd_mtxcreate(const char *desc, const char *type); 241void snd_mtxfree(void *m); 242void snd_mtxassert(void *m); 243#define snd_mtxlock(m) mtx_lock(m) 244#define snd_mtxunlock(m) mtx_unlock(m) 245 246int sysctl_hw_snd_vchans(SYSCTL_HANDLER_ARGS); 247 248typedef int (*sndstat_handler)(struct sbuf *s, device_t dev, int verbose); 249int sndstat_acquire(void); 250int sndstat_release(void); 251int sndstat_register(device_t dev, char *str, sndstat_handler handler); 252int sndstat_registerfile(char *str); 253int sndstat_unregister(device_t dev); 254int sndstat_unregisterfile(char *str); 255 256#define SND_DECLARE_FILE(version) \ 257 _SND_DECLARE_FILE(__LINE__, version) 258 259#define _SND_DECLARE_FILE(uniq, version) \ 260 __SND_DECLARE_FILE(uniq, version) 261 262#define __SND_DECLARE_FILE(uniq, version) \ 263 static char sndstat_vinfo[] = version; \ 264 SYSINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_registerfile, sndstat_vinfo); \ 265 SYSUNINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_unregisterfile, sndstat_vinfo); 266 267/* usage of flags in device config entry (config file) */ 268#define DV_F_DRQ_MASK 0x00000007 /* mask for secondary drq */ 269#define DV_F_DUAL_DMA 0x00000010 /* set to use secondary dma channel */ 270 271/* ought to be made obsolete but still used by mss */ 272#define DV_F_DEV_MASK 0x0000ff00 /* force device type/class */ 273#define DV_F_DEV_SHIFT 8 /* force device type/class */ 274 275#define PCM_DEBUG_MTX 276 277/* 278 * this is rather kludgey- we need to duplicate these struct def'ns from sound.c 279 * so that the macro versions of pcm_{,un}lock can dereference them. 280 * we also have to do this now makedev() has gone away. 281 */ 282 283struct snddev_channel { 284 SLIST_ENTRY(snddev_channel) link; 285 struct pcm_channel *channel; 286 int chan_num; 287 struct cdev *dsp_devt; 288 struct cdev *dspW_devt; 289 struct cdev *audio_devt; 290 struct cdev *dspr_devt; 291}; 292 293struct snddev_info { 294 SLIST_HEAD(, snddev_channel) channels; 295 struct pcm_channel *fakechan; 296 unsigned devcount, playcount, reccount, vchancount; 297 unsigned flags; 298 int inprog; 299 unsigned int bufsz; 300 void *devinfo; 301 device_t dev; 302 char status[SND_STATUSLEN]; 303 struct sysctl_ctx_list sysctl_tree; 304 struct sysctl_oid *sysctl_tree_top; 305 struct mtx *lock; 306 struct cdev *mixer_dev; 307 308}; 309 310void sound_oss_sysinfo(oss_sysinfo *); 311 312#ifdef PCM_DEBUG_MTX 313#define pcm_lock(d) mtx_lock(((struct snddev_info *)(d))->lock) 314#define pcm_unlock(d) mtx_unlock(((struct snddev_info *)(d))->lock) 315#else 316void pcm_lock(struct snddev_info *d); 317void pcm_unlock(struct snddev_info *d); 318#endif 319 320#ifdef KLD_MODULE 321#define PCM_KLDSTRING(a) ("kld " # a) 322#else 323#define PCM_KLDSTRING(a) "" 324#endif 325 326#endif /* _KERNEL */ 327 328#endif /* _OS_H_ */ 329