2 * Copyright (c) 1999 Cameron Grant <gandalf@vilnya.demon.co.uk>
3 * Copyright by Hannu Savolainen 1995
6 * Redistribution and use in source and binary forms, with or without
7 * modification, are permitted provided that the following conditions
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.
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
27 * $FreeBSD: src/sys/dev/sound/pcm/sound.h,v 1.10.2.11 2002/04/22 15:49:36 cg Exp $
28 * $DragonFly: src/sys/dev/sound/pcm/sound.h,v 1.8 2006/04/30 17:22:17 dillon Exp $
32 * first, include kernel header files.
39 #include <sys/param.h>
40 #include <sys/systm.h>
41 #include <sys/ioccom.h>
42 #include <sys/filio.h>
43 #include <sys/sockio.h>
44 #include <sys/fcntl.h>
47 #include <sys/kernel.h> /* for DATA_SET */
48 #include <sys/module.h>
52 #include <sys/syslog.h>
53 #include <sys/errno.h>
54 #include <sys/malloc.h>
56 #if defined(__FreeBSD__) && __FreeBSD_version > 500000
60 #include <machine/clock.h> /* for DELAY */
61 #include <machine/resource.h>
62 #include <machine/bus.h>
67 #include <sys/soundcard.h>
68 #include <sys/sysctl.h>
69 #include <sys/thread2.h>
70 #include <bus/isa/isavar.h>
78 #if defined(__FreeBSD__) && __FreeBSD_version > 500000
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 #include <dev/sound/pcm/dsp.h>
96 #define PCM_SOFTC_SIZE 512
98 #define SND_STATUSLEN 64
99 /* descriptor of audio device */
104 #define PCM_PREFVER PCM_MODVER
110 status, mixer, dsp, dspW, audio, sequencer, midi-in, seq2, sndproc = 9 devices
111 dspW and audio are deprecated.
112 dsp needs min 64 channels, will give it 256
114 minor = (unit << 20) + (dev << 16) + channel
115 currently minor = (channel << 16) + (unit << 4) + dev
118 /dev/pcmX/dsp.(0..255)
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))
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
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)
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)
152 struct pcm_channel *fkchan_setup(device_t dev);
153 int fkchan_kill(struct pcm_channel *c);
156 * Major nuber for the sound driver.
158 #define SND_CDEV_MAJOR 30
160 #define SND_MAXVCHANS 255
163 * Minor numbers for the sound driver.
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.
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 */
185 #define DSP_DEFAULT_SPEED 8000
190 extern int pcm_veto_load;
192 extern devclass_t pcm_devclass;
195 * some macros for debugging purposes
196 * DDB/DEB to enable/disable debugging stuff
197 * BVDDB to enable debugging when bootverbose
199 #define DDB(x) x /* XXX */
200 #define BVDDB(x) if (bootverbose) x
206 SYSCTL_DECL(_hw_snd);
208 struct sysctl_ctx_list *snd_sysctl_tree(device_t dev);
209 struct sysctl_oid *snd_sysctl_tree_top(device_t dev);
211 void pcm_lock(struct snddev_info *d);
212 void pcm_unlock(struct snddev_info *d);
213 struct pcm_channel *pcm_getfakechan(struct snddev_info *d);
214 struct pcm_channel *pcm_chnalloc(struct snddev_info *d, int direction, pid_t pid, int chnum);
215 int pcm_chnrelease(struct pcm_channel *c);
216 int pcm_chnref(struct pcm_channel *c, int ref);
217 int pcm_inprog(struct snddev_info *d, int delta);
219 struct pcm_channel *pcm_chn_create(struct snddev_info *d, struct pcm_channel *parent, kobj_class_t cls, int dir, void *devinfo);
220 int pcm_chn_destroy(struct pcm_channel *ch);
221 int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch, int mkdev);
222 int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch, int rmdev);
224 int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo);
225 unsigned int pcm_getbuffersize(device_t dev, unsigned int min, unsigned int deflt, unsigned int max);
226 int pcm_register(device_t dev, void *devinfo, int numplay, int numrec);
227 int pcm_unregister(device_t dev);
228 int pcm_setstatus(device_t dev, char *str);
229 u_int32_t pcm_getflags(device_t dev);
230 void pcm_setflags(device_t dev, u_int32_t val);
231 void *pcm_getdevinfo(device_t dev);
233 int snd_setup_intr(device_t dev, struct resource *res, int flags,
234 driver_intr_t hand, void *param,
235 void **cookiep, lwkt_serialize_t serializer);
237 void *snd_mtxcreate(const char *desc, const char *type);
238 void snd_mtxfree(void *m);
239 void snd_mtxassert(void *m);
240 void snd_mtxlock(void *m);
241 void snd_mtxunlock(void *m);
243 int sysctl_hw_snd_vchans(SYSCTL_HANDLER_ARGS);
245 typedef int (*sndstat_handler)(struct sbuf *s, device_t dev, int verbose);
246 int sndstat_register(device_t dev, char *str, sndstat_handler handler);
247 int sndstat_registerfile(char *str);
248 int sndstat_unregister(device_t dev);
249 int sndstat_unregisterfile(char *str);
250 int sndstat_busy(void);
252 #define SND_DECLARE_FILE(version) \
253 _SND_DECLARE_FILE(__LINE__, version)
255 #define _SND_DECLARE_FILE(uniq, version) \
256 __SND_DECLARE_FILE(uniq, version)
258 #define __SND_DECLARE_FILE(uniq, version) \
259 static char sndstat_vinfo[] = version; \
260 SYSINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_registerfile, sndstat_vinfo); \
261 SYSUNINIT(sdf_ ## uniq, SI_SUB_DRIVERS, SI_ORDER_MIDDLE, sndstat_unregisterfile, sndstat_vinfo);
263 /* usage of flags in device config entry (config file) */
264 #define DV_F_DRQ_MASK 0x00000007 /* mask for secondary drq */
265 #define DV_F_DUAL_DMA 0x00000010 /* set to use secondary dma channel */
267 /* ought to be made obsolete */
268 #define DV_F_DEV_MASK 0x0000ff00 /* force device type/class */
269 #define DV_F_DEV_SHIFT 8 /* force device type/class */