sound.h revision 160439
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 160439 2006-07-17 17:43:06Z 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 77#define USING_MUTEX 78#define USING_DEVFS 79#else 80#define INTR_TYPE_AV INTR_TYPE_TTY 81#define INTR_MPSAFE 0 82#endif 83 84#define SND_DYNSYSCTL 85 86struct pcm_channel; 87struct pcm_feeder; 88struct snd_dbuf; 89struct snd_mixer; 90 91#include <dev/sound/pcm/buffer.h> 92#include <dev/sound/pcm/channel.h> 93#include <dev/sound/pcm/feeder.h> 94#include <dev/sound/pcm/mixer.h> 95 96#define PCM_SOFTC_SIZE 512 97 98#define SND_STATUSLEN 64 99 100#define SOUND_MODVER 1 101 102#define SOUND_MINVER 1 103#define SOUND_PREFVER SOUND_MODVER 104#define SOUND_MAXVER 1 105 106/* 107PROPOSAL: 108each unit needs: 109status, mixer, dsp, dspW, audio, sequencer, midi-in, seq2, sndproc = 9 devices 110dspW and audio are deprecated. 111dsp needs min 64 channels, will give it 256 112 113minor = (unit << 20) + (dev << 16) + channel 114currently minor = (channel << 16) + (unit << 4) + dev 115 116nomenclature: 117 /dev/pcmX/dsp.(0..255) 118 /dev/pcmX/dspW 119 /dev/pcmX/audio 120 /dev/pcmX/status 121 /dev/pcmX/mixer 122 [etc.] 123*/ 124 125#define PCMMAXCHAN 0xff 126#define PCMMAXDEV 0x0f 127#define PCMMAXUNIT 0x0f 128#define PCMMINOR(x) (minor(x)) 129#define PCMCHAN(x) ((PCMMINOR(x) >> 16) & PCMMAXCHAN) 130#define PCMUNIT(x) ((PCMMINOR(x) >> 4) & PCMMAXUNIT) 131#define PCMDEV(x) (PCMMINOR(x) & PCMMAXDEV) 132#define PCMMKMINOR(u, d, c) ((((c) & PCMMAXCHAN) << 16) | \ 133 (((u) & PCMMAXUNIT) << 4) | ((d) & PCMMAXDEV)) 134 135#define SD_F_SIMPLEX 0x00000001 136#define SD_F_AUTOVCHAN 0x00000002 137#define SD_F_SOFTVOL 0x00000004 138#define SD_F_PRIO_RD 0x10000000 139#define SD_F_PRIO_WR 0x20000000 140#define SD_F_PRIO_SET (SD_F_PRIO_RD | SD_F_PRIO_WR) 141#define SD_F_DIR_SET 0x40000000 142#define SD_F_TRANSIENT 0xf0000000 143 144/* many variables should be reduced to a range. Here define a macro */ 145#define RANGE(var, low, high) (var) = \ 146 (((var)<(low))? (low) : ((var)>(high))? (high) : (var)) 147#define DSP_BUFFSIZE (8192) 148 149/* make figuring out what a format is easier. got AFMT_STEREO already */ 150#define AFMT_32BIT (AFMT_S32_LE | AFMT_S32_BE | AFMT_U32_LE | AFMT_U32_BE) 151#define AFMT_24BIT (AFMT_S24_LE | AFMT_S24_BE | AFMT_U24_LE | AFMT_U24_BE) 152#define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE) 153#define AFMT_8BIT (AFMT_MU_LAW | AFMT_A_LAW | AFMT_U8 | AFMT_S8) 154#define AFMT_SIGNED (AFMT_S32_LE | AFMT_S32_BE | AFMT_S24_LE | AFMT_S24_BE | \ 155 AFMT_S16_LE | AFMT_S16_BE | AFMT_S8) 156#define AFMT_BIGENDIAN (AFMT_S32_BE | AFMT_U32_BE | AFMT_S24_BE | AFMT_U24_BE | \ 157 AFMT_S16_BE | AFMT_U16_BE) 158 159struct pcm_channel *fkchan_setup(device_t dev); 160int fkchan_kill(struct pcm_channel *c); 161 162/* XXX Flawed definition. I'll fix it someday. */ 163#define SND_MAXVCHANS PCMMAXCHAN 164 165/* 166 * Minor numbers for the sound driver. 167 * 168 * Unfortunately Creative called the codec chip of SB as a DSP. For this 169 * reason the /dev/dsp is reserved for digitized audio use. There is a 170 * device for true DSP processors but it will be called something else. 171 * In v3.0 it's /dev/sndproc but this could be a temporary solution. 172 */ 173 174#define SND_DEV_CTL 0 /* Control port /dev/mixer */ 175#define SND_DEV_SEQ 1 /* Sequencer /dev/sequencer */ 176#define SND_DEV_MIDIN 2 /* Raw midi access */ 177#define SND_DEV_DSP 3 /* Digitized voice /dev/dsp */ 178#define SND_DEV_AUDIO 4 /* Sparc compatible /dev/audio */ 179#define SND_DEV_DSP16 5 /* Like /dev/dsp but 16 bits/sample */ 180#define SND_DEV_STATUS 6 /* /dev/sndstat */ 181 /* #7 not in use now. */ 182#define SND_DEV_SEQ2 8 /* /dev/sequencer, level 2 interface */ 183#define SND_DEV_SNDPROC 9 /* /dev/sndproc for programmable devices */ 184#define SND_DEV_PSS SND_DEV_SNDPROC /* ? */ 185#define SND_DEV_NORESET 10 186#define SND_DEV_DSPREC 11 /* recording channels */ 187 188#define DSP_DEFAULT_SPEED 8000 189 190#define ON 1 191#define OFF 0 192 193extern int pcm_veto_load; 194extern int snd_unit; 195extern devclass_t pcm_devclass; 196 197/* 198 * some macros for debugging purposes 199 * DDB/DEB to enable/disable debugging stuff 200 * BVDDB to enable debugging when bootverbose 201 */ 202#define BVDDB(x) if (bootverbose) x 203 204#ifndef DEB 205#define DEB(x) 206#endif 207 208SYSCTL_DECL(_hw_snd); 209 210struct sysctl_ctx_list *snd_sysctl_tree(device_t dev); 211struct sysctl_oid *snd_sysctl_tree_top(device_t dev); 212 213struct pcm_channel *pcm_getfakechan(struct snddev_info *d); 214int pcm_chnalloc(struct snddev_info *d, struct pcm_channel **ch, int direction, pid_t pid, int chnum); 215int pcm_chnrelease(struct pcm_channel *c); 216int pcm_chnref(struct pcm_channel *c, int ref); 217int pcm_inprog(struct snddev_info *d, int delta); 218 219struct pcm_channel *pcm_chn_create(struct snddev_info *d, struct pcm_channel *parent, kobj_class_t cls, int dir, void *devinfo); 220int pcm_chn_destroy(struct pcm_channel *ch); 221int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch); 222int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch); 223 224int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo); 225unsigned int pcm_getbuffersize(device_t dev, unsigned int minbufsz, unsigned int deflt, unsigned int maxbufsz); 226int pcm_register(device_t dev, void *devinfo, int numplay, int numrec); 227int pcm_unregister(device_t dev); 228int pcm_setstatus(device_t dev, char *str); 229u_int32_t pcm_getflags(device_t dev); 230void pcm_setflags(device_t dev, u_int32_t val); 231void *pcm_getdevinfo(device_t dev); 232 233 234int snd_setup_intr(device_t dev, struct resource *res, int flags, 235 driver_intr_t hand, void *param, void **cookiep); 236 237void *snd_mtxcreate(const char *desc, const char *type); 238void snd_mtxfree(void *m); 239void snd_mtxassert(void *m); 240#define snd_mtxlock(m) mtx_lock(m) 241#define snd_mtxunlock(m) mtx_unlock(m) 242 243int sysctl_hw_snd_vchans(SYSCTL_HANDLER_ARGS); 244 245typedef int (*sndstat_handler)(struct sbuf *s, device_t dev, int verbose); 246int sndstat_acquire(void); 247int sndstat_release(void); 248int sndstat_register(device_t dev, char *str, sndstat_handler handler); 249int sndstat_registerfile(char *str); 250int sndstat_unregister(device_t dev); 251int sndstat_unregisterfile(char *str); 252 253#define SND_DECLARE_FILE(version) \ 254 _SND_DECLARE_FILE(__LINE__, version) 255 256#define _SND_DECLARE_FILE(uniq, version) \ 257 __SND_DECLARE_FILE(uniq, version) 258 259#define __SND_DECLARE_FILE(uniq, version) \ 260 static char sndstat_vinfo[] = version; \ 261 SYSINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_registerfile, sndstat_vinfo); \ 262 SYSUNINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_unregisterfile, sndstat_vinfo); 263 264/* usage of flags in device config entry (config file) */ 265#define DV_F_DRQ_MASK 0x00000007 /* mask for secondary drq */ 266#define DV_F_DUAL_DMA 0x00000010 /* set to use secondary dma channel */ 267 268/* ought to be made obsolete but still used by mss */ 269#define DV_F_DEV_MASK 0x0000ff00 /* force device type/class */ 270#define DV_F_DEV_SHIFT 8 /* force device type/class */ 271 272#define PCM_DEBUG_MTX 273 274/* 275 * this is rather kludgey- we need to duplicate these struct def'ns from sound.c 276 * so that the macro versions of pcm_{,un}lock can dereference them. 277 * we also have to do this now makedev() has gone away. 278 */ 279 280struct snddev_channel { 281 SLIST_ENTRY(snddev_channel) link; 282 struct pcm_channel *channel; 283 int chan_num; 284 struct cdev *dsp_devt; 285 struct cdev *dspW_devt; 286 struct cdev *audio_devt; 287 struct cdev *dspr_devt; 288}; 289 290struct snddev_info { 291 SLIST_HEAD(, snddev_channel) channels; 292 struct pcm_channel *fakechan; 293 unsigned devcount, playcount, reccount, vchancount; 294 unsigned flags; 295 int inprog; 296 unsigned int bufsz; 297 void *devinfo; 298 device_t dev; 299 char status[SND_STATUSLEN]; 300 struct sysctl_ctx_list sysctl_tree; 301 struct sysctl_oid *sysctl_tree_top; 302 struct mtx *lock; 303 struct cdev *mixer_dev; 304 305}; 306 307#ifdef PCM_DEBUG_MTX 308#define pcm_lock(d) mtx_lock(((struct snddev_info *)(d))->lock) 309#define pcm_unlock(d) mtx_unlock(((struct snddev_info *)(d))->lock) 310#else 311void pcm_lock(struct snddev_info *d); 312void pcm_unlock(struct snddev_info *d); 313#endif 314 315#ifdef KLD_MODULE 316#define PCM_KLDSTRING(a) ("kld " # a) 317#else 318#define PCM_KLDSTRING(a) "" 319#endif 320 321#endif /* _KERNEL */ 322 323#endif /* _OS_H_ */ 324