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