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