sound.h revision 78362 
1/*
2 * Copyright (c) 1999 Cameron Grant <gandalf@vilnya.demon.co.uk>
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 78362 2001-06-16 21:25:10Z cg $
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/bio.h>
57#endif
58#include <sys/buf.h>
59#include <machine/clock.h>	/* for DELAY */
60#include <machine/resource.h>
61#include <machine/bus.h>
62#include <sys/rman.h>
63#include <sys/mman.h>
64#include <sys/poll.h>
65#include <sys/soundcard.h>
66#include <sys/sysctl.h>
67#include <isa/isavar.h>
68#include <sys/kobj.h>
69#include <vm/vm.h>
70#include <vm/pmap.h>
71
72#if __FreeBSD_version > 500000
73#define USING_MUTEX
74#define USING_DEVFS
75#endif
76#define SND_DYNSYSCTL
77
78#else
79struct isa_device { int dummy; };
80#define d_open_t void
81#define d_close_t void
82#define d_read_t void
83#define d_write_t void
84#define d_ioctl_t void
85#define d_select_t void
86#endif /* _KERNEL */
87
88#endif	/* _OS_H_ */
89
90struct pcm_channel;
91struct pcm_feeder;
92struct snd_dbuf;
93struct snd_mixer;
94
95#include <dev/sound/pcm/buffer.h>
96#include <dev/sound/pcm/channel.h>
97#include <dev/sound/pcm/feeder.h>
98#include <dev/sound/pcm/mixer.h>
99#include <dev/sound/pcm/dsp.h>
100
101struct snddev_channel {
102	SLIST_ENTRY(snddev_channel) link;
103	struct pcm_channel *channel;
104};
105
106#define SND_STATUSLEN	64
107/* descriptor of audio device */
108struct snddev_info {
109	SLIST_HEAD(, snddev_channel) channels;
110	struct pcm_channel *fakechan;
111	unsigned chancount, defaultchan;
112	/* struct snd_mixer *mixer; */
113	unsigned flags;
114	int inprog;
115	void *devinfo;
116	device_t dev;
117	char status[SND_STATUSLEN];
118	struct sysctl_ctx_list sysctl_tree;
119	struct sysctl_oid *sysctl_tree_top;
120	void *lock;
121};
122
123#ifndef ISADMA_WRITE
124#define ISADMA_WRITE B_WRITE
125#define ISADMA_READ B_READ
126#define ISADMA_RAW B_RAW
127#endif
128
129#define PCM_MODVER	1
130
131#define PCM_MINVER	1
132#define PCM_PREFVER	PCM_MODVER
133#define PCM_MAXVER	1
134
135/*
136PROPOSAL:
137each unit needs:
138status, mixer, dsp, dspW, audio, sequencer, midi-in, seq2, sndproc = 9 devices
139dspW and audio are deprecated.
140dsp needs min 64 channels, will give it 256
141
142minor = (unit << 20) + (dev << 16) + channel
143currently minor = (channel << 16) + (unit << 4) + dev
144
145nomenclature:
146	/dev/pcmX/dsp.(0..255)
147	/dev/pcmX/dspW
148	/dev/pcmX/audio
149	/dev/pcmX/status
150	/dev/pcmX/mixer
151	[etc.]
152*/
153
154#define PCMMINOR(x) (minor(x))
155#define PCMCHAN(x) ((PCMMINOR(x) & 0x00ff0000) >> 16)
156#define PCMUNIT(x) ((PCMMINOR(x) & 0x000000f0) >> 4)
157#define PCMDEV(x)   (PCMMINOR(x) & 0x0000000f)
158#define PCMMKMINOR(u, d, c) ((((c) & 0xff) << 16) | (((u) & 0x0f) << 4) | ((d) & 0x0f))
159
160#define SD_F_SIMPLEX		0x00000001
161#define SD_F_PRIO_RD		0x10000000
162#define SD_F_PRIO_WR		0x20000000
163#define SD_F_PRIO_SET		(SD_F_PRIO_RD | SD_F_PRIO_WR)
164#define SD_F_DIR_SET		0x40000000
165#define SD_F_TRANSIENT		0xf0000000
166
167/* many variables should be reduced to a range. Here define a macro */
168#define RANGE(var, low, high) (var) = \
169	(((var)<(low))? (low) : ((var)>(high))? (high) : (var))
170#define DSP_BUFFSIZE (8192)
171
172/* make figuring out what a format is easier. got AFMT_STEREO already */
173#define AFMT_32BIT (AFMT_S32_LE | AFMT_S32_BE | AFMT_U32_LE | AFMT_U32_BE)
174#define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE)
175#define AFMT_8BIT (AFMT_U8 | AFMT_S8)
176#define AFMT_SIGNED (AFMT_S16_LE | AFMT_S16_BE | AFMT_S8)
177#define AFMT_BIGENDIAN (AFMT_S16_BE | AFMT_U16_BE)
178
179struct pcm_channel *fkchan_setup(device_t dev);
180int fkchan_kill(struct pcm_channel *c);
181
182/*
183 * Major nuber for the sound driver.
184 */
185#define SND_CDEV_MAJOR 30
186
187/*
188 * Minor numbers for the sound driver.
189 *
190 * Unfortunately Creative called the codec chip of SB as a DSP. For this
191 * reason the /dev/dsp is reserved for digitized audio use. There is a
192 * device for true DSP processors but it will be called something else.
193 * In v3.0 it's /dev/sndproc but this could be a temporary solution.
194 */
195
196#define SND_DEV_CTL	0	/* Control port /dev/mixer */
197#define SND_DEV_SEQ	1	/* Sequencer /dev/sequencer */
198#define SND_DEV_MIDIN	2	/* Raw midi access */
199#define SND_DEV_DSP	3	/* Digitized voice /dev/dsp */
200#define SND_DEV_AUDIO	4	/* Sparc compatible /dev/audio */
201#define SND_DEV_DSP16	5	/* Like /dev/dsp but 16 bits/sample */
202#define SND_DEV_STATUS	6	/* /dev/sndstat */
203				/* #7 not in use now. */
204#define SND_DEV_SEQ2	8	/* /dev/sequencer, level 2 interface */
205#define SND_DEV_SNDPROC 9	/* /dev/sndproc for programmable devices */
206#define SND_DEV_PSS	SND_DEV_SNDPROC /* ? */
207#define SND_DEV_NORESET	10
208
209#define DSP_DEFAULT_SPEED	8000
210
211#define ON		1
212#define OFF		0
213
214#ifdef _KERNEL
215
216extern int snd_unit;
217extern devclass_t pcm_devclass;
218
219/*
220 * some macros for debugging purposes
221 * DDB/DEB to enable/disable debugging stuff
222 * BVDDB   to enable debugging when bootverbose
223 */
224#define DDB(x)	x	/* XXX */
225#define BVDDB(x) if (bootverbose) x
226
227#ifndef DEB
228#define DEB(x)
229#endif
230
231SYSCTL_DECL(_hw_snd);
232
233struct pcm_channel *pcm_chnalloc(struct snddev_info *d, int direction, pid_t pid);
234int pcm_chnrelease(struct pcm_channel *c);
235int pcm_chnref(struct pcm_channel *c, int ref);
236
237struct pcm_channel *pcm_chn_create(struct snddev_info *d, struct pcm_channel *parent, kobj_class_t cls, int dir, void *devinfo);
238int pcm_chn_destroy(struct pcm_channel *ch);
239int pcm_chn_add(struct snddev_info *d, struct pcm_channel *ch);
240int pcm_chn_remove(struct snddev_info *d, struct pcm_channel *ch);
241
242int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo);
243int pcm_register(device_t dev, void *devinfo, int numplay, int numrec);
244int pcm_unregister(device_t dev);
245int pcm_setstatus(device_t dev, char *str);
246u_int32_t pcm_getflags(device_t dev);
247void pcm_setflags(device_t dev, u_int32_t val);
248void *pcm_getdevinfo(device_t dev);
249
250int snd_setup_intr(device_t dev, struct resource *res, int flags,
251		   driver_intr_t hand, void *param, void **cookiep);
252
253void *snd_mtxcreate(const char *desc);
254void snd_mtxfree(void *m);
255void snd_mtxassert(void *m);
256void snd_mtxlock(void *m);
257void snd_mtxunlock(void *m);
258#endif /* _KERNEL */
259
260/* usage of flags in device config entry (config file) */
261#define DV_F_DRQ_MASK	0x00000007	/* mask for secondary drq */
262#define	DV_F_DUAL_DMA	0x00000010	/* set to use secondary dma channel */
263
264/* ought to be made obsolete */
265#define	DV_F_DEV_MASK	0x0000ff00	/* force device type/class */
266#define	DV_F_DEV_SHIFT	8		/* force device type/class */
267