xref: /netbsd-src/sys/dev/isa/sbdspvar.h (revision e622eac459adf11c2e710d7a4de0f05510bbbe61)
1 /*	$NetBSD: sbdspvar.h,v 1.62 2019/05/08 13:40:18 isaki Exp $	*/
2 
3 /*
4  * Copyright (c) 1991-1993 Regents of the University of California.
5  * All rights reserved.
6  *
7  * Redistribution and use in source and binary forms, with or without
8  * modification, are permitted provided that the following conditions
9  * are met:
10  * 1. Redistributions of source code must retain the above copyright
11  *    notice, this list of conditions and the following disclaimer.
12  * 2. Redistributions in binary form must reproduce the above copyright
13  *    notice, this list of conditions and the following disclaimer in the
14  *    documentation and/or other materials provided with the distribution.
15  * 3. All advertising materials mentioning features or use of this software
16  *    must display the following acknowledgement:
17  *	This product includes software developed by the Computer Systems
18  *	Engineering Group at Lawrence Berkeley Laboratory.
19  * 4. Neither the name of the University nor of the Laboratory may be used
20  *    to endorse or promote products derived from this software without
21  *    specific prior written permission.
22  *
23  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33  * SUCH DAMAGE.
34  *
35  */
36 
37 #include "mpu.h"
38 #if NMPU > 0
39 #include <dev/ic/mpuvar.h>
40 #endif
41 
42 #define SB_MASTER_VOL	0
43 #define SB_MIDI_VOL	1
44 #define SB_CD_VOL	2
45 #define SB_VOICE_VOL	3
46 #define SB_OUTPUT_CLASS	4
47 
48 #define SB_MIC_VOL	5
49 #define SB_LINE_IN_VOL	6
50 #define	SB_RECORD_SOURCE 7
51 #define SB_TREBLE	8
52 #define SB_BASS		9
53 #define SB_RECORD_CLASS	10
54 #define SB_INPUT_CLASS	11
55 
56 #define SB_PCSPEAKER	12
57 #define SB_INPUT_GAIN	13
58 #define SB_OUTPUT_GAIN	14
59 #define SB_AGC		15
60 #define SB_EQUALIZATION_CLASS 16
61 
62 #define SB_CD_IN_MUTE	17
63 #define SB_MIC_IN_MUTE	18
64 #define SB_LINE_IN_MUTE	19
65 #define SB_MIDI_IN_MUTE	20
66 
67 #define SB_CD_SWAP	21
68 #define SB_MIC_SWAP	22
69 #define SB_LINE_SWAP	23
70 #define SB_MIDI_SWAP	24
71 
72 #define SB_CD_OUT_MUTE	25
73 #define SB_MIC_OUT_MUTE	26
74 #define SB_LINE_OUT_MUTE 27
75 
76 #define SB_NDEVS	28
77 
78 #define SB_IS_IN_MUTE(x) ((x) < SB_CD_SWAP)
79 
80 /*
81  * Software state, per SoundBlaster card.
82  * The soundblaster has multiple functionality, which we must demultiplex.
83  * One approach is to have one major device number for the soundblaster card,
84  * and use different minor numbers to indicate which hardware function
85  * we want.  This would make for one large driver.  Instead our approach
86  * is to partition the design into a set of drivers that share an underlying
87  * piece of hardware.  Most things are hard to share, for example, the audio
88  * and midi ports.  For audio, we might want to mix two processes' signals,
89  * and for midi we might want to merge streams (this is hard due to
90  * running status).  Moreover, we should be able to re-use the high-level
91  * modules with other kinds of hardware.  In this module, we only handle the
92  * most basic communications with the sb card.
93  */
94 struct sbdsp_softc {
95 	device_t sc_dev;		/* base device */
96 	isa_chipset_tag_t sc_ic;
97 	bus_space_tag_t sc_iot;		/* tag */
98 	bus_space_handle_t sc_ioh;	/* handle */
99 	void	*sc_ih;			/* interrupt vectoring */
100 	kmutex_t sc_lock;
101 	kmutex_t sc_intr_lock;
102 
103 	/* XXX These are only for setting chip configuration registers. */
104 	int	sc_iobase;		/* I/O port base address */
105 	int	sc_irq;			/* interrupt */
106 
107 	int	sc_drq8;		/* DMA (8-bit) */
108 	bus_size_t sc_drq8_maxsize;
109 	int	sc_drq16;		/* DMA (16-bit) */
110 	bus_size_t sc_drq16_maxsize;
111 
112 	u_int	sc_quirks;		/* minor variations */
113 #define SB_QUIRK_NO_INIT_DRQ	0x01
114 
115 	int	sc_open;		/* reference count of open calls */
116 #define SB_CLOSED 0
117 #define SB_OPEN_AUDIO 1
118 #define SB_OPEN_MIDI 2
119 
120 	u_char	gain[SB_NDEVS][2];	/* kept in input levels */
121 #define SB_LEFT 0
122 #define SB_RIGHT 1
123 #define SB_LR 0
124 
125 	u_int	in_mask;		/* input ports */
126 	u_int	in_port;		/* XXX needed for MI interface */
127 	u_int	in_filter;		/* one of SB_TREBLE_EQ, SB_BASS_EQ, 0 */
128 
129 	u_int	spkr_state;		/* non-null is on */
130 
131 	struct sbdsp_state {
132 		u_int	rate;		/* Sample rate */
133 		u_char	tc;		/* Time constant */
134 		struct	sbmode *modep;
135 		u_char	bmode;
136 		int	dmachan;	/* DMA channel */
137 		int	blksize;	/* Block size, preadjusted */
138 		u_char	run;
139 #define SB_NOTRUNNING 0		/* Not running, not initialized */
140 #define SB_RUNNING 3		/* non-looping mode */
141 #define SB_LOOPING 2		/* DMA&PCM running (looping mode) */
142 	} sc_i, sc_o;			/* Input and output state */
143 
144 	u_long	sc_interrupts;		/* number of interrupts taken */
145 
146 	int	(*sc_intr8)(void*);	/* DMA completion intr handler */
147 	int	(*sc_intr16)(void*);	/* DMA completion intr handler */
148 	void	(*sc_intrp)(void*);	/* PCM output intr handler */
149 	void	*sc_argp;		/* arg for sc_intrp() */
150 	void	(*sc_intrr)(void*);	/* PCM input intr handler */
151 	void	*sc_argr;		/* arg for sc_intrr() */
152 	void	(*sc_intrm)(void*, int);/* midi input intr handler */
153 	void	*sc_argm;		/* arg for sc_intrm() */
154 
155 	u_int	sc_mixer_model;
156 #define SBM_NONE	0
157 #define SBM_CT1335	1
158 #define SBM_CT1345	2
159 #define SBM_CT1XX5	3
160 #define SBM_CT1745	4
161 #define ISSBM1745(x) ((x)->sc_mixer_model >= SBM_CT1XX5)
162 
163 	u_int	sc_model;		/* DSP model */
164 #define SB_UNK	-1
165 #define SB_1	0			/* original SB */
166 #define SB_20	1			/* SB 2 */
167 #define SB_2x	2			/* SB 2, new version */
168 #define SB_PRO	3			/* SB Pro */
169 #define SB_JAZZ	4			/* Jazz 16 */
170 #define SB_16	5			/* SB 16 */
171 #define SB_32	6			/* SB AWE 32 */
172 #define SB_64	7			/* SB AWE 64 */
173 
174 #define SB_NAMES { "SB_1", "SB_2.0", "SB_2.x", "SB_Pro", "Jazz_16", "SB_16", \
175 		"SB_AWE_32", "SB_AWE_64" }
176 
177 	u_int	sc_version;		/* DSP version */
178 #define SBVER_MAJOR(v)	(((v)>>8) & 0xff)
179 #define SBVER_MINOR(v)	((v)&0xff)
180 
181 	struct audio_format sc_formats[4];
182 	int sc_nformats;
183 
184 #if NMPU > 0
185 	int	sc_hasmpu;
186 #define SBMPU_EXTERNAL	1
187 #define SBMPU_INTERNAL	0
188 #define SBMPU_NONE	-1
189 	device_t sc_mpudev;
190 	bus_space_tag_t sc_mpu_iot;	/* tag */
191 	bus_space_handle_t sc_mpu_ioh;	/* handle */
192 #endif
193 };
194 
195 #define ISSBPRO(sc) ((sc)->sc_model == SB_PRO || (sc)->sc_model == SB_JAZZ)
196 #define ISSBPROCLASS(sc) ((sc)->sc_model >= SB_PRO)
197 #define ISSB16CLASS(sc) ((sc)->sc_model >= SB_16)
198 
199 #ifdef _KERNEL
200 struct malloc_type;
201 
202 int	sbdsp_open(void *, int);
203 void	sbdsp_close(void *);
204 
205 int	sbdsp_probe(struct sbdsp_softc *, cfdata_t);
206 void	sbdsp_attach(struct sbdsp_softc *);
207 
208 int	sbdsp_set_in_gain(void *, u_int, u_char);
209 int	sbdsp_set_in_gain_real(void *, u_int, u_char);
210 int	sbdsp_get_in_gain(void *);
211 int	sbdsp_set_out_gain(void *, u_int, u_char);
212 int	sbdsp_set_out_gain_real(void *, u_int, u_char);
213 int	sbdsp_get_out_gain(void *);
214 int	sbdsp_set_monitor_gain(void *, u_int);
215 int	sbdsp_get_monitor_gain(void *);
216 int	sbdsp_query_format(void *, audio_format_query_t *);
217 int	sbdsp_set_format(void *, int,
218 	    const audio_params_t *, const audio_params_t *,
219 	    audio_filter_reg_t *, audio_filter_reg_t *);
220 int	sbdsp_round_blocksize(void *, int, int, const audio_params_t *);
221 int	sbdsp_get_avail_in_ports(void *);
222 int	sbdsp_get_avail_out_ports(void *);
223 int	sbdsp_speaker_ctl(void *, int);
224 
225 int	sbdsp_commit(void *);
226 int	sbdsp_trigger_output(void *, void *, void *, int, void (*)(void *),
227 	    void *, const audio_params_t *);
228 int	sbdsp_trigger_input(void *, void *, void *, int, void (*)(void *),
229 	    void *, const audio_params_t *);
230 int	sbdsp_halt_output(void *);
231 int	sbdsp_halt_input(void *);
232 
233 void	sbdsp_compress(int, u_char *, int);
234 void	sbdsp_expand(int, u_char *, int);
235 
236 int	sbdsp_reset(struct sbdsp_softc *);
237 void	sbdsp_spkron(struct sbdsp_softc *);
238 void	sbdsp_spkroff(struct sbdsp_softc *);
239 
240 int	sbdsp_wdsp(struct sbdsp_softc *, int);
241 int	sbdsp_rdsp(struct sbdsp_softc *);
242 
243 int	sbdsp_intr(void *);
244 
245 int	sbdsp_set_sr(struct sbdsp_softc *, u_long *, int);
246 
247 void	sbdsp_mix_write(struct sbdsp_softc *, int, int);
248 int	sbdsp_mix_read(struct sbdsp_softc *, int);
249 
250 int	sbdsp_mixer_set_port(void *, mixer_ctrl_t *);
251 int	sbdsp_mixer_get_port(void *, mixer_ctrl_t *);
252 int	sbdsp_mixer_query_devinfo(void *, mixer_devinfo_t *);
253 
254 void	*sb_malloc(void *, int, size_t);
255 void	sb_free(void *, void *, size_t);
256 size_t	sb_round_buffersize(void *, int, size_t);
257 
258 int	sbdsp_get_props(void *);
259 void	sbdsp_get_locks(void *, kmutex_t **, kmutex_t **);
260 
261 int	sbdsp_midi_open(void *, int, void (*iintr)(void *, int),
262 	    void (*ointr)(void *), void *);
263 void	sbdsp_midi_close(void *);
264 int	sbdsp_midi_output(void *, int);
265 void	sbdsp_midi_getinfo(void *, struct midi_info *);
266 #endif
267