sound.h revision 130585
1258299Sjmmv/* 2258299Sjmmv * Copyright (c) 1999 Cameron Grant <cg@freebsd.org> 3258299Sjmmv * Copyright by Hannu Savolainen 1995 4258299Sjmmv * All rights reserved. 5258299Sjmmv * 6258299Sjmmv * Redistribution and use in source and binary forms, with or without 7258299Sjmmv * modification, are permitted provided that the following conditions 8258299Sjmmv * are met: 9258299Sjmmv * 1. Redistributions of source code must retain the above copyright 10258299Sjmmv * notice, this list of conditions and the following disclaimer. 11258299Sjmmv * 2. Redistributions in binary form must reproduce the above copyright 12321648Sngie * notice, this list of conditions and the following disclaimer in the 13321648Sngie * documentation and/or other materials provided with the distribution. 14321648Sngie * 15321648Sngie * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 16258299Sjmmv * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 17258299Sjmmv * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 18258299Sjmmv * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 19258299Sjmmv * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 20321648Sngie * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 21321648Sngie * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 22321646Sngie * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 23258299Sjmmv * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 24258299Sjmmv * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 25258299Sjmmv * SUCH DAMAGE. 26258299Sjmmv * 27258299Sjmmv * $FreeBSD: head/sys/dev/sound/pcm/sound.h 130585 2004-06-16 09:47:26Z phk $ 28258299Sjmmv */ 29258299Sjmmv 30258299Sjmmv/* 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/clock.h> /* for DELAY */ 59#include <machine/resource.h> 60#include <machine/bus.h> 61#include <sys/rman.h> 62#include <sys/mman.h> 63#include <sys/poll.h> 64#include <sys/sbuf.h> 65#include <sys/soundcard.h> 66#include <sys/sysctl.h> 67#include <sys/kobj.h> 68#include <vm/vm.h> 69#include <vm/pmap.h> 70 71#undef USING_MUTEX 72#undef USING_DEVFS 73 74#if __FreeBSD_version > 500000 75#include <sys/lock.h> 76#include <sys/mutex.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 97#define PCM_SOFTC_SIZE 512 98 99#define SND_STATUSLEN 64 100 101#define PCM_MODVER 1 102 103#define PCM_MINVER 1 104#define PCM_PREFVER PCM_MODVER 105#define PCM_MAXVER 1 106 107/* 108PROPOSAL: 109each unit needs: 110status, mixer, dsp, dspW, audio, sequencer, midi-in, seq2, sndproc = 9 devices 111dspW and audio are deprecated. 112dsp needs min 64 channels, will give it 256 113 114minor = (unit << 20) + (dev << 16) + channel 115currently minor = (channel << 16) + (unit << 4) + dev 116 117nomenclature: 118 /dev/pcmX/dsp.(0..255) 119 /dev/pcmX/dspW 120 /dev/pcmX/audio 121 /dev/pcmX/status 122 /dev/pcmX/mixer 123 [etc.] 124*/ 125 126#define PCMMINOR(x) (minor(x)) 127#define PCMCHAN(x) ((PCMMINOR(x) & 0x00ff0000) >> 16) 128#define PCMUNIT(x) ((PCMMINOR(x) & 0x000000f0) >> 4) 129#define PCMDEV(x) (PCMMINOR(x) & 0x0000000f) 130#define PCMMKMINOR(u, d, c) ((((c) & 0xff) << 16) | (((u) & 0x0f) << 4) | ((d) & 0x0f)) 131 132#define SD_F_SIMPLEX 0x00000001 133#define SD_F_AUTOVCHAN 0x00000002 134#define SD_F_PRIO_RD 0x10000000 135#define SD_F_PRIO_WR 0x20000000 136#define SD_F_PRIO_SET (SD_F_PRIO_RD | SD_F_PRIO_WR) 137#define SD_F_DIR_SET 0x40000000 138#define SD_F_TRANSIENT 0xf0000000 139 140/* many variables should be reduced to a range. Here define a macro */ 141#define RANGE(var, low, high) (var) = \ 142 (((var)<(low))? (low) : ((var)>(high))? (high) : (var)) 143#define DSP_BUFFSIZE (8192) 144 145/* make figuring out what a format is easier. got AFMT_STEREO already */ 146#define AFMT_32BIT (AFMT_S32_LE | AFMT_S32_BE | AFMT_U32_LE | AFMT_U32_BE) 147#define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE) 148#define AFMT_8BIT (AFMT_U8 | AFMT_S8) 149#define AFMT_SIGNED (AFMT_S16_LE | AFMT_S16_BE | AFMT_S8) 150#define AFMT_BIGENDIAN (AFMT_S16_BE | AFMT_U16_BE) 151 152struct pcm_channel *fkchan_setup(device_t dev); 153int fkchan_kill(struct pcm_channel *c); 154 155/* 156 * Major nuber for the sound driver. 157 */ 158#define SND_CDEV_MAJOR 30 159 160#define SND_MAXVCHANS 255 161 162/* 163 * Minor numbers for the sound driver. 164 * 165 * Unfortunately Creative called the codec chip of SB as a DSP. For this 166 * reason the /dev/dsp is reserved for digitized audio use. There is a 167 * device for true DSP processors but it will be called something else. 168 * In v3.0 it's /dev/sndproc but this could be a temporary solution. 169 */ 170 171#define SND_DEV_CTL 0 /* Control port /dev/mixer */ 172#define SND_DEV_SEQ 1 /* Sequencer /dev/sequencer */ 173#define SND_DEV_MIDIN 2 /* Raw midi access */ 174#define SND_DEV_DSP 3 /* Digitized voice /dev/dsp */ 175#define SND_DEV_AUDIO 4 /* Sparc compatible /dev/audio */ 176#define SND_DEV_DSP16 5 /* Like /dev/dsp but 16 bits/sample */ 177#define SND_DEV_STATUS 6 /* /dev/sndstat */ 178 /* #7 not in use now. */ 179#define SND_DEV_SEQ2 8 /* /dev/sequencer, level 2 interface */ 180#define SND_DEV_SNDPROC 9 /* /dev/sndproc for programmable devices */ 181#define SND_DEV_PSS SND_DEV_SNDPROC /* ? */ 182#define SND_DEV_NORESET 10 183#define SND_DEV_DSPREC 11 /* recording channels */ 184 185#define DSP_DEFAULT_SPEED 8000 186 187#define ON 1 188#define OFF 0 189 190extern int pcm_veto_load; 191extern int snd_unit; 192extern devclass_t pcm_devclass; 193 194/* 195 * some macros for debugging purposes 196 * DDB/DEB to enable/disable debugging stuff 197 * BVDDB to enable debugging when bootverbose 198 */ 199#define DDB(x) x /* XXX */ 200#define BVDDB(x) if (bootverbose) x 201 202#ifndef DEB 203#define DEB(x) 204#endif 205 206SYSCTL_DECL(_hw_snd); 207 208struct sysctl_ctx_list *snd_sysctl_tree(device_t dev); 209struct sysctl_oid *snd_sysctl_tree_top(device_t dev); 210 211struct pcm_channel *pcm_getfakechan(struct snddev_info *d); 212struct pcm_channel *pcm_chnalloc(struct snddev_info *d, int direction, pid_t pid, int chnum); 213int pcm_chnrelease(struct pcm_channel *c); 214int pcm_chnref(struct pcm_channel *c, int ref); 215int pcm_inprog(struct snddev_info *d, int delta); 216 217struct pcm_channel *pcm_chn_create(struct snddev_info *d, struct pcm_channel *parent, kobj_class_t cls, int dir, void *devinfo); 218int pcm_chn_destroy(struct pcm_channel *ch); 219int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch); 220int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch); 221 222int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo); 223unsigned int pcm_getbuffersize(device_t dev, unsigned int min, unsigned int deflt, unsigned int max); 224int pcm_register(device_t dev, void *devinfo, int numplay, int numrec); 225int pcm_unregister(device_t dev); 226int pcm_setstatus(device_t dev, char *str); 227u_int32_t pcm_getflags(device_t dev); 228void pcm_setflags(device_t dev, u_int32_t val); 229void *pcm_getdevinfo(device_t dev); 230 231 232int snd_setup_intr(device_t dev, struct resource *res, int flags, 233 driver_intr_t hand, void *param, void **cookiep); 234 235void *snd_mtxcreate(const char *desc, const char *type); 236void snd_mtxfree(void *m); 237void snd_mtxassert(void *m); 238#define snd_mtxlock(m) mtx_lock(m) 239#define snd_mtxunlock(m) mtx_unlock(m) 240 241int sysctl_hw_snd_vchans(SYSCTL_HANDLER_ARGS); 242 243typedef int (*sndstat_handler)(struct sbuf *s, device_t dev, int verbose); 244int sndstat_register(device_t dev, char *str, sndstat_handler handler); 245int sndstat_registerfile(char *str); 246int sndstat_unregister(device_t dev); 247int sndstat_unregisterfile(char *str); 248int sndstat_busy(void); 249 250#define SND_DECLARE_FILE(version) \ 251 _SND_DECLARE_FILE(__LINE__, version) 252 253#define _SND_DECLARE_FILE(uniq, version) \ 254 __SND_DECLARE_FILE(uniq, version) 255 256#define __SND_DECLARE_FILE(uniq, version) \ 257 static char sndstat_vinfo[] = version; \ 258 SYSINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_registerfile, sndstat_vinfo); \ 259 SYSUNINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_unregisterfile, sndstat_vinfo); 260 261/* usage of flags in device config entry (config file) */ 262#define DV_F_DRQ_MASK 0x00000007 /* mask for secondary drq */ 263#define DV_F_DUAL_DMA 0x00000010 /* set to use secondary dma channel */ 264 265/* ought to be made obsolete but still used by mss */ 266#define DV_F_DEV_MASK 0x0000ff00 /* force device type/class */ 267#define DV_F_DEV_SHIFT 8 /* force device type/class */ 268 269#define PCM_DEBUG_MTX 270 271/* 272 * this is rather kludgey- we need to duplicate these struct def'ns from sound.c 273 * so that the macro versions of pcm_{,un}lock can dereference them. 274 * we also have to do this now makedev() has gone away. 275 */ 276 277struct snddev_channel { 278 SLIST_ENTRY(snddev_channel) link; 279 struct pcm_channel *channel; 280 int chan_num; 281 struct cdev *dsp_devt; 282 struct cdev *dspW_devt; 283 struct cdev *audio_devt; 284 struct cdev *dspr_devt; 285}; 286 287struct snddev_info { 288 SLIST_HEAD(, snddev_channel) channels; 289 struct pcm_channel *fakechan; 290 unsigned devcount, playcount, reccount, vchancount; 291 unsigned flags; 292 int inprog; 293 unsigned int bufsz; 294 void *devinfo; 295 device_t dev; 296 char status[SND_STATUSLEN]; 297 struct sysctl_ctx_list sysctl_tree; 298 struct sysctl_oid *sysctl_tree_top; 299 struct mtx *lock; 300 struct cdev *mixer_dev; 301 302}; 303 304#ifdef PCM_DEBUG_MTX 305#define pcm_lock(d) mtx_lock(((struct snddev_info *)(d))->lock) 306#define pcm_unlock(d) mtx_unlock(((struct snddev_info *)(d))->lock) 307#else 308void pcm_lock(struct snddev_info *d); 309void pcm_unlock(struct snddev_info *d); 310#endif 311 312#ifdef KLD_MODULE 313#define PCM_KLDSTRING(a) ("kld " # a) 314#else 315#define PCM_KLDSTRING(a) "" 316#endif 317 318#endif /* _KERNEL */ 319 320#endif /* _OS_H_ */ 321