xref: /freebsd/sys/dev/sound/pcm/sound.h (revision b601c69bdbe8755d26570261d7fd4c02ee4eff74)
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$
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 
42 #include <sys/filio.h>
43 #include <sys/sockio.h>
44 #include <sys/fcntl.h>
45 #include <sys/tty.h>
46 #include <sys/proc.h>
47 
48 #include <sys/kernel.h> /* for DATA_SET */
49 
50 #if __FreeBSD_version < 500000
51 #define MODULE_VERSION(mod, ver)
52 #define MODULE_DEPEND(mod, dep, min, pref, max)
53 
54 #define ISADMA_WRITE B_WRITE
55 #define ISADMA_READ B_READ
56 #define ISADMA_RAW B_RAW
57 #endif
58 
59 #include <sys/module.h>
60 #include <sys/conf.h>
61 #include <sys/file.h>
62 #include <sys/uio.h>
63 #include <sys/syslog.h>
64 #include <sys/errno.h>
65 #include <sys/malloc.h>
66 #include <sys/bus.h>
67 #if __FreeBSD_version > 500000
68 #include <sys/bio.h>
69 #endif
70 #include <sys/buf.h>
71 #include <machine/clock.h>	/* for DELAY */
72 #include <machine/resource.h>
73 #include <machine/bus.h>
74 #include <sys/rman.h>
75 #include <sys/mman.h>
76 #include <sys/poll.h>
77 #include <sys/soundcard.h>
78 #include <isa/isavar.h>
79 #include <vm/vm.h>
80 #include <vm/pmap.h>
81 
82 #else
83 struct isa_device { int dummy; };
84 #define d_open_t void
85 #define d_close_t void
86 #define d_read_t void
87 #define d_write_t void
88 #define d_ioctl_t void
89 #define d_select_t void
90 #endif /* _KERNEL */
91 
92 #endif	/* _OS_H_ */
93 
94 #include <dev/sound/pcm/datatypes.h>
95 #include <dev/sound/pcm/channel.h>
96 #include <dev/sound/pcm/mixer.h>
97 #include <dev/sound/pcm/dsp.h>
98 
99 #define PCM_MODVER	1
100 
101 #define PCM_MINVER	1
102 #define PCM_PREFVER	PCM_MODVER
103 #define PCM_MAXVER	1
104 
105 #define	MAGIC(unit) (0xa4d10de0 + unit)
106 
107 #define SD_F_SIMPLEX		0x00000001
108 #define SD_F_PRIO_RD		0x10000000
109 #define SD_F_PRIO_WR		0x20000000
110 #define SD_F_PRIO_SET		(SD_F_PRIO_RD | SD_F_PRIO_WR)
111 #define SD_F_DIR_SET		0x40000000
112 #define SD_F_TRANSIENT		0xf0000000
113 
114 /* many variables should be reduced to a range. Here define a macro */
115 #define RANGE(var, low, high) (var) = \
116 	(((var)<(low))? (low) : ((var)>(high))? (high) : (var))
117 /*
118 #define DSP_BUFFSIZE (65536 - 256)
119 */
120 #define DSP_BUFFSIZE (8192)
121 /* the last 256 bytes are room for buggy soundcard to overflow. */
122 
123 /* make figuring out what a format is easier. got AFMT_STEREO already */
124 #define AFMT_16BIT (AFMT_S16_LE | AFMT_S16_BE | AFMT_U16_LE | AFMT_U16_BE)
125 #define AFMT_SIGNED (AFMT_S16_LE | AFMT_S16_BE | AFMT_S8)
126 #define AFMT_BIGENDIAN (AFMT_S16_BE | AFMT_U16_BE)
127 
128 int fkchan_setup(pcm_channel *c);
129 
130 /*
131  * Minor numbers for the sound driver.
132  *
133  * Unfortunately Creative called the codec chip of SB as a DSP. For this
134  * reason the /dev/dsp is reserved for digitized audio use. There is a
135  * device for true DSP processors but it will be called something else.
136  * In v3.0 it's /dev/sndproc but this could be a temporary solution.
137  */
138 
139 #define SND_DEV_CTL	0	/* Control port /dev/mixer */
140 #define SND_DEV_SEQ	1	/* Sequencer /dev/sequencer */
141 #define SND_DEV_MIDIN	2	/* Raw midi access */
142 #define SND_DEV_DSP	3	/* Digitized voice /dev/dsp */
143 #define SND_DEV_AUDIO	4	/* Sparc compatible /dev/audio */
144 #define SND_DEV_DSP16	5	/* Like /dev/dsp but 16 bits/sample */
145 #define SND_DEV_STATUS	6	/* /dev/sndstat */
146 				/* #7 not in use now. */
147 #define SND_DEV_SEQ2	8	/* /dev/sequencer, level 2 interface */
148 #define SND_DEV_SNDPROC 9	/* /dev/sndproc for programmable devices */
149 #define SND_DEV_PSS	SND_DEV_SNDPROC /* ? */
150 #define SND_DEV_NORESET	10
151 
152 #define DSP_DEFAULT_SPEED	8000
153 
154 #define ON		1
155 #define OFF		0
156 
157 #ifdef _KERNEL
158 
159 /*
160  * some macros for debugging purposes
161  * DDB/DEB to enable/disable debugging stuff
162  * BVDDB   to enable debugging when bootverbose
163  */
164 #define DDB(x)	x	/* XXX */
165 #define BVDDB(x) if (bootverbose) x
166 
167 #ifndef DEB
168 #define DEB(x)
169 #endif
170 
171 int pcm_addchan(device_t dev, int dir, pcm_channel *templ, void *devinfo);
172 int pcm_register(device_t dev, void *devinfo, int numplay, int numrec);
173 int pcm_setstatus(device_t dev, char *str);
174 u_int32_t pcm_getflags(device_t dev);
175 void pcm_setflags(device_t dev, u_int32_t val);
176 void *pcm_getdevinfo(device_t dev);
177 void pcm_setswap(device_t dev, pcm_swap_t *swap);
178 
179 #endif /* _KERNEL */
180 
181 /* usage of flags in device config entry (config file) */
182 #define DV_F_DRQ_MASK	0x00000007	/* mask for secondary drq */
183 #define	DV_F_DUAL_DMA	0x00000010	/* set to use secondary dma channel */
184 
185 /* ought to be made obsolete */
186 #define	DV_F_DEV_MASK	0x0000ff00	/* force device type/class */
187 #define	DV_F_DEV_SHIFT	8		/* force device type/class */
188