sound.h revision 73760 
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 73760 2001-03-05 15:58:05Z 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 <vm/vm.h>
69#include <vm/pmap.h>
70
71#if __FreeBSD_version > 500000
72#define USING_MUTEX
73#define USING_DEVFS
74#endif
75#define SND_DYNSYSCTL
76
77#else
78struct isa_device { int dummy; };
79#define d_open_t void
80#define d_close_t void
81#define d_read_t void
82#define d_write_t void
83#define d_ioctl_t void
84#define d_select_t void
85#endif /* _KERNEL */
86
87#endif	/* _OS_H_ */
88
89#include <dev/sound/pcm/datatypes.h>
90#include <dev/sound/pcm/channel.h>
91#include <dev/sound/pcm/buffer.h>
92#include <dev/sound/pcm/feeder.h>
93#include <dev/sound/pcm/mixer.h>
94#include <dev/sound/pcm/dsp.h>
95
96#ifndef ISADMA_WRITE
97#define ISADMA_WRITE B_WRITE
98#define ISADMA_READ B_READ
99#define ISADMA_RAW B_RAW
100#endif
101
102#define PCM_MODVER	1
103
104#define PCM_MINVER	1
105#define PCM_PREFVER	PCM_MODVER
106#define PCM_MAXVER	1
107
108#define	MAGIC(unit) (0xa4d10de0 + unit)
109
110#define SD_F_SIMPLEX		0x00000001
111#define SD_F_PRIO_RD		0x10000000
112#define SD_F_PRIO_WR		0x20000000
113#define SD_F_PRIO_SET		(SD_F_PRIO_RD | SD_F_PRIO_WR)
114#define SD_F_DIR_SET		0x40000000
115#define SD_F_TRANSIENT		0xf0000000
116
117/* many variables should be reduced to a range. Here define a macro */
118#define RANGE(var, low, high) (var) = \
119	(((var)<(low))? (low) : ((var)>(high))? (high) : (var))
120#define DSP_BUFFSIZE (8192)
121
122/* make figuring out what a format is easier. got AFMT_STEREO already */
123#define AFMT_32BIT (AFMT_S32_LE | AFMT_S32_BE | AFMT_U32_LE | AFMT_U32_BE)
124#define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE)
125#define AFMT_8BIT (AFMT_U8 | AFMT_S8)
126#define AFMT_SIGNED (AFMT_S16_LE | AFMT_S16_BE | AFMT_S8)
127#define AFMT_BIGENDIAN (AFMT_S16_BE | AFMT_U16_BE)
128
129int fkchan_setup(pcm_channel *c);
130int fkchan_kill(pcm_channel *c);
131
132/*
133 * Minor numbers for the sound driver.
134 *
135 * Unfortunately Creative called the codec chip of SB as a DSP. For this
136 * reason the /dev/dsp is reserved for digitized audio use. There is a
137 * device for true DSP processors but it will be called something else.
138 * In v3.0 it's /dev/sndproc but this could be a temporary solution.
139 */
140
141#define SND_DEV_CTL	0	/* Control port /dev/mixer */
142#define SND_DEV_SEQ	1	/* Sequencer /dev/sequencer */
143#define SND_DEV_MIDIN	2	/* Raw midi access */
144#define SND_DEV_DSP	3	/* Digitized voice /dev/dsp */
145#define SND_DEV_AUDIO	4	/* Sparc compatible /dev/audio */
146#define SND_DEV_DSP16	5	/* Like /dev/dsp but 16 bits/sample */
147#define SND_DEV_STATUS	6	/* /dev/sndstat */
148				/* #7 not in use now. */
149#define SND_DEV_SEQ2	8	/* /dev/sequencer, level 2 interface */
150#define SND_DEV_SNDPROC 9	/* /dev/sndproc for programmable devices */
151#define SND_DEV_PSS	SND_DEV_SNDPROC /* ? */
152#define SND_DEV_NORESET	10
153
154#define DSP_DEFAULT_SPEED	8000
155
156#define ON		1
157#define OFF		0
158
159#ifdef _KERNEL
160
161/*
162 * some macros for debugging purposes
163 * DDB/DEB to enable/disable debugging stuff
164 * BVDDB   to enable debugging when bootverbose
165 */
166#define DDB(x)	x	/* XXX */
167#define BVDDB(x) if (bootverbose) x
168
169#ifndef DEB
170#define DEB(x)
171#endif
172
173SYSCTL_DECL(_hw_snd);
174
175int pcm_addchan(device_t dev, int dir, kobj_class_t cls, void *devinfo);
176int pcm_register(device_t dev, void *devinfo, int numplay, int numrec);
177int pcm_unregister(device_t dev);
178int pcm_setstatus(device_t dev, char *str);
179u_int32_t pcm_getflags(device_t dev);
180void pcm_setflags(device_t dev, u_int32_t val);
181void *pcm_getdevinfo(device_t dev);
182
183int snd_setup_intr(device_t dev, struct resource *res, int flags,
184		   driver_intr_t hand, void *param, void **cookiep);
185
186void *snd_mtxcreate(const char *desc);
187void snd_mtxfree(void *m);
188void snd_mtxassert(void *m);
189void snd_mtxlock(void *m);
190void snd_mtxunlock(void *m);
191
192#endif /* _KERNEL */
193
194/* usage of flags in device config entry (config file) */
195#define DV_F_DRQ_MASK	0x00000007	/* mask for secondary drq */
196#define	DV_F_DUAL_DMA	0x00000010	/* set to use secondary dma channel */
197
198/* ought to be made obsolete */
199#define	DV_F_DEV_MASK	0x0000ff00	/* force device type/class */
200#define	DV_F_DEV_SHIFT	8		/* force device type/class */
201