xref: /openbmc/linux/sound/pci/sonicvibes.c (revision 7f6964c5)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  Driver for S3 SonicVibes soundcard
4  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
5  *
6  *  BUGS:
7  *    It looks like 86c617 rev 3 doesn't supports DDMA buffers above 16MB?
8  *    Driver sometimes hangs... Nobody knows why at this moment...
9  */
10 
11 #include <linux/delay.h>
12 #include <linux/init.h>
13 #include <linux/interrupt.h>
14 #include <linux/pci.h>
15 #include <linux/slab.h>
16 #include <linux/gameport.h>
17 #include <linux/module.h>
18 #include <linux/dma-mapping.h>
19 #include <linux/io.h>
20 
21 #include <sound/core.h>
22 #include <sound/pcm.h>
23 #include <sound/info.h>
24 #include <sound/control.h>
25 #include <sound/mpu401.h>
26 #include <sound/opl3.h>
27 #include <sound/initval.h>
28 
29 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
30 MODULE_DESCRIPTION("S3 SonicVibes PCI");
31 MODULE_LICENSE("GPL");
32 MODULE_SUPPORTED_DEVICE("{{S3,SonicVibes PCI}}");
33 
34 #if IS_REACHABLE(CONFIG_GAMEPORT)
35 #define SUPPORT_JOYSTICK 1
36 #endif
37 
38 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;	/* Index 0-MAX */
39 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;	/* ID for this card */
40 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;	/* Enable this card */
41 static bool reverb[SNDRV_CARDS];
42 static bool mge[SNDRV_CARDS];
43 static unsigned int dmaio = 0x7a00;	/* DDMA i/o address */
44 
45 module_param_array(index, int, NULL, 0444);
46 MODULE_PARM_DESC(index, "Index value for S3 SonicVibes soundcard.");
47 module_param_array(id, charp, NULL, 0444);
48 MODULE_PARM_DESC(id, "ID string for S3 SonicVibes soundcard.");
49 module_param_array(enable, bool, NULL, 0444);
50 MODULE_PARM_DESC(enable, "Enable S3 SonicVibes soundcard.");
51 module_param_array(reverb, bool, NULL, 0444);
52 MODULE_PARM_DESC(reverb, "Enable reverb (SRAM is present) for S3 SonicVibes soundcard.");
53 module_param_array(mge, bool, NULL, 0444);
54 MODULE_PARM_DESC(mge, "MIC Gain Enable for S3 SonicVibes soundcard.");
55 module_param_hw(dmaio, uint, ioport, 0444);
56 MODULE_PARM_DESC(dmaio, "DDMA i/o base address for S3 SonicVibes soundcard.");
57 
58 /*
59  * Enhanced port direct registers
60  */
61 
62 #define SV_REG(sonic, x) ((sonic)->enh_port + SV_REG_##x)
63 
64 #define SV_REG_CONTROL	0x00	/* R/W: CODEC/Mixer control register */
65 #define   SV_ENHANCED	  0x01	/* audio mode select - enhanced mode */
66 #define   SV_TEST	  0x02	/* test bit */
67 #define   SV_REVERB	  0x04	/* reverb enable */
68 #define   SV_WAVETABLE	  0x08	/* wavetable active / FM active if not set */
69 #define   SV_INTA	  0x20	/* INTA driving - should be always 1 */
70 #define   SV_RESET	  0x80	/* reset chip */
71 #define SV_REG_IRQMASK	0x01	/* R/W: CODEC/Mixer interrupt mask register */
72 #define   SV_DMAA_MASK	  0x01	/* mask DMA-A interrupt */
73 #define   SV_DMAC_MASK	  0x04	/* mask DMA-C interrupt */
74 #define   SV_SPEC_MASK	  0x08	/* special interrupt mask - should be always masked */
75 #define   SV_UD_MASK	  0x40	/* Up/Down button interrupt mask */
76 #define   SV_MIDI_MASK	  0x80	/* mask MIDI interrupt */
77 #define SV_REG_STATUS	0x02	/* R/O: CODEC/Mixer status register */
78 #define   SV_DMAA_IRQ	  0x01	/* DMA-A interrupt */
79 #define   SV_DMAC_IRQ	  0x04	/* DMA-C interrupt */
80 #define   SV_SPEC_IRQ	  0x08	/* special interrupt */
81 #define   SV_UD_IRQ	  0x40	/* Up/Down interrupt */
82 #define   SV_MIDI_IRQ	  0x80	/* MIDI interrupt */
83 #define SV_REG_INDEX	0x04	/* R/W: CODEC/Mixer index address register */
84 #define   SV_MCE          0x40	/* mode change enable */
85 #define   SV_TRD	  0x80	/* DMA transfer request disabled */
86 #define SV_REG_DATA	0x05	/* R/W: CODEC/Mixer index data register */
87 
88 /*
89  * Enhanced port indirect registers
90  */
91 
92 #define SV_IREG_LEFT_ADC	0x00	/* Left ADC Input Control */
93 #define SV_IREG_RIGHT_ADC	0x01	/* Right ADC Input Control */
94 #define SV_IREG_LEFT_AUX1	0x02	/* Left AUX1 Input Control */
95 #define SV_IREG_RIGHT_AUX1	0x03	/* Right AUX1 Input Control */
96 #define SV_IREG_LEFT_CD		0x04	/* Left CD Input Control */
97 #define SV_IREG_RIGHT_CD	0x05	/* Right CD Input Control */
98 #define SV_IREG_LEFT_LINE	0x06	/* Left Line Input Control */
99 #define SV_IREG_RIGHT_LINE	0x07	/* Right Line Input Control */
100 #define SV_IREG_MIC		0x08	/* MIC Input Control */
101 #define SV_IREG_GAME_PORT	0x09	/* Game Port Control */
102 #define SV_IREG_LEFT_SYNTH	0x0a	/* Left Synth Input Control */
103 #define SV_IREG_RIGHT_SYNTH	0x0b	/* Right Synth Input Control */
104 #define SV_IREG_LEFT_AUX2	0x0c	/* Left AUX2 Input Control */
105 #define SV_IREG_RIGHT_AUX2	0x0d	/* Right AUX2 Input Control */
106 #define SV_IREG_LEFT_ANALOG	0x0e	/* Left Analog Mixer Output Control */
107 #define SV_IREG_RIGHT_ANALOG	0x0f	/* Right Analog Mixer Output Control */
108 #define SV_IREG_LEFT_PCM	0x10	/* Left PCM Input Control */
109 #define SV_IREG_RIGHT_PCM	0x11	/* Right PCM Input Control */
110 #define SV_IREG_DMA_DATA_FMT	0x12	/* DMA Data Format */
111 #define SV_IREG_PC_ENABLE	0x13	/* Playback/Capture Enable Register */
112 #define SV_IREG_UD_BUTTON	0x14	/* Up/Down Button Register */
113 #define SV_IREG_REVISION	0x15	/* Revision */
114 #define SV_IREG_ADC_OUTPUT_CTRL	0x16	/* ADC Output Control */
115 #define SV_IREG_DMA_A_UPPER	0x18	/* DMA A Upper Base Count */
116 #define SV_IREG_DMA_A_LOWER	0x19	/* DMA A Lower Base Count */
117 #define SV_IREG_DMA_C_UPPER	0x1c	/* DMA C Upper Base Count */
118 #define SV_IREG_DMA_C_LOWER	0x1d	/* DMA C Lower Base Count */
119 #define SV_IREG_PCM_RATE_LOW	0x1e	/* PCM Sampling Rate Low Byte */
120 #define SV_IREG_PCM_RATE_HIGH	0x1f	/* PCM Sampling Rate High Byte */
121 #define SV_IREG_SYNTH_RATE_LOW	0x20	/* Synthesizer Sampling Rate Low Byte */
122 #define SV_IREG_SYNTH_RATE_HIGH 0x21	/* Synthesizer Sampling Rate High Byte */
123 #define SV_IREG_ADC_CLOCK	0x22	/* ADC Clock Source Selection */
124 #define SV_IREG_ADC_ALT_RATE	0x23	/* ADC Alternative Sampling Rate Selection */
125 #define SV_IREG_ADC_PLL_M	0x24	/* ADC PLL M Register */
126 #define SV_IREG_ADC_PLL_N	0x25	/* ADC PLL N Register */
127 #define SV_IREG_SYNTH_PLL_M	0x26	/* Synthesizer PLL M Register */
128 #define SV_IREG_SYNTH_PLL_N	0x27	/* Synthesizer PLL N Register */
129 #define SV_IREG_MPU401		0x2a	/* MPU-401 UART Operation */
130 #define SV_IREG_DRIVE_CTRL	0x2b	/* Drive Control */
131 #define SV_IREG_SRS_SPACE	0x2c	/* SRS Space Control */
132 #define SV_IREG_SRS_CENTER	0x2d	/* SRS Center Control */
133 #define SV_IREG_WAVE_SOURCE	0x2e	/* Wavetable Sample Source Select */
134 #define SV_IREG_ANALOG_POWER	0x30	/* Analog Power Down Control */
135 #define SV_IREG_DIGITAL_POWER	0x31	/* Digital Power Down Control */
136 
137 #define SV_IREG_ADC_PLL		SV_IREG_ADC_PLL_M
138 #define SV_IREG_SYNTH_PLL	SV_IREG_SYNTH_PLL_M
139 
140 /*
141  *  DMA registers
142  */
143 
144 #define SV_DMA_ADDR0		0x00
145 #define SV_DMA_ADDR1		0x01
146 #define SV_DMA_ADDR2		0x02
147 #define SV_DMA_ADDR3		0x03
148 #define SV_DMA_COUNT0		0x04
149 #define SV_DMA_COUNT1		0x05
150 #define SV_DMA_COUNT2		0x06
151 #define SV_DMA_MODE		0x0b
152 #define SV_DMA_RESET		0x0d
153 #define SV_DMA_MASK		0x0f
154 
155 /*
156  *  Record sources
157  */
158 
159 #define SV_RECSRC_RESERVED	(0x00<<5)
160 #define SV_RECSRC_CD		(0x01<<5)
161 #define SV_RECSRC_DAC		(0x02<<5)
162 #define SV_RECSRC_AUX2		(0x03<<5)
163 #define SV_RECSRC_LINE		(0x04<<5)
164 #define SV_RECSRC_AUX1		(0x05<<5)
165 #define SV_RECSRC_MIC		(0x06<<5)
166 #define SV_RECSRC_OUT		(0x07<<5)
167 
168 /*
169  *  constants
170  */
171 
172 #define SV_FULLRATE		48000
173 #define SV_REFFREQUENCY		24576000
174 #define SV_ADCMULT		512
175 
176 #define SV_MODE_PLAY		1
177 #define SV_MODE_CAPTURE		2
178 
179 /*
180 
181  */
182 
183 struct sonicvibes {
184 	unsigned long dma1size;
185 	unsigned long dma2size;
186 	int irq;
187 
188 	unsigned long sb_port;
189 	unsigned long enh_port;
190 	unsigned long synth_port;
191 	unsigned long midi_port;
192 	unsigned long game_port;
193 	unsigned int dmaa_port;
194 	struct resource *res_dmaa;
195 	unsigned int dmac_port;
196 	struct resource *res_dmac;
197 
198 	unsigned char enable;
199 	unsigned char irqmask;
200 	unsigned char revision;
201 	unsigned char format;
202 	unsigned char srs_space;
203 	unsigned char srs_center;
204 	unsigned char mpu_switch;
205 	unsigned char wave_source;
206 
207 	unsigned int mode;
208 
209 	struct pci_dev *pci;
210 	struct snd_card *card;
211 	struct snd_pcm *pcm;
212 	struct snd_pcm_substream *playback_substream;
213 	struct snd_pcm_substream *capture_substream;
214 	struct snd_rawmidi *rmidi;
215 	struct snd_hwdep *fmsynth;	/* S3FM */
216 
217 	spinlock_t reg_lock;
218 
219 	unsigned int p_dma_size;
220 	unsigned int c_dma_size;
221 
222 	struct snd_kcontrol *master_mute;
223 	struct snd_kcontrol *master_volume;
224 
225 #ifdef SUPPORT_JOYSTICK
226 	struct gameport *gameport;
227 #endif
228 };
229 
230 static const struct pci_device_id snd_sonic_ids[] = {
231 	{ PCI_VDEVICE(S3, 0xca00), 0, },
232         { 0, }
233 };
234 
235 MODULE_DEVICE_TABLE(pci, snd_sonic_ids);
236 
237 static const struct snd_ratden sonicvibes_adc_clock = {
238 	.num_min = 4000 * 65536,
239 	.num_max = 48000UL * 65536,
240 	.num_step = 1,
241 	.den = 65536,
242 };
243 static const struct snd_pcm_hw_constraint_ratdens snd_sonicvibes_hw_constraints_adc_clock = {
244 	.nrats = 1,
245 	.rats = &sonicvibes_adc_clock,
246 };
247 
248 /*
249  *  common I/O routines
250  */
251 
252 static inline void snd_sonicvibes_setdmaa(struct sonicvibes * sonic,
253 					  unsigned int addr,
254 					  unsigned int count)
255 {
256 	count--;
257 	outl(addr, sonic->dmaa_port + SV_DMA_ADDR0);
258 	outl(count, sonic->dmaa_port + SV_DMA_COUNT0);
259 	outb(0x18, sonic->dmaa_port + SV_DMA_MODE);
260 #if 0
261 	dev_dbg(sonic->card->dev, "program dmaa: addr = 0x%x, paddr = 0x%x\n",
262 	       addr, inl(sonic->dmaa_port + SV_DMA_ADDR0));
263 #endif
264 }
265 
266 static inline void snd_sonicvibes_setdmac(struct sonicvibes * sonic,
267 					  unsigned int addr,
268 					  unsigned int count)
269 {
270 	/* note: dmac is working in word mode!!! */
271 	count >>= 1;
272 	count--;
273 	outl(addr, sonic->dmac_port + SV_DMA_ADDR0);
274 	outl(count, sonic->dmac_port + SV_DMA_COUNT0);
275 	outb(0x14, sonic->dmac_port + SV_DMA_MODE);
276 #if 0
277 	dev_dbg(sonic->card->dev, "program dmac: addr = 0x%x, paddr = 0x%x\n",
278 	       addr, inl(sonic->dmac_port + SV_DMA_ADDR0));
279 #endif
280 }
281 
282 static inline unsigned int snd_sonicvibes_getdmaa(struct sonicvibes * sonic)
283 {
284 	return (inl(sonic->dmaa_port + SV_DMA_COUNT0) & 0xffffff) + 1;
285 }
286 
287 static inline unsigned int snd_sonicvibes_getdmac(struct sonicvibes * sonic)
288 {
289 	/* note: dmac is working in word mode!!! */
290 	return ((inl(sonic->dmac_port + SV_DMA_COUNT0) & 0xffffff) + 1) << 1;
291 }
292 
293 static void snd_sonicvibes_out1(struct sonicvibes * sonic,
294 				unsigned char reg,
295 				unsigned char value)
296 {
297 	outb(reg, SV_REG(sonic, INDEX));
298 	udelay(10);
299 	outb(value, SV_REG(sonic, DATA));
300 	udelay(10);
301 }
302 
303 static void snd_sonicvibes_out(struct sonicvibes * sonic,
304 			       unsigned char reg,
305 			       unsigned char value)
306 {
307 	unsigned long flags;
308 
309 	spin_lock_irqsave(&sonic->reg_lock, flags);
310 	outb(reg, SV_REG(sonic, INDEX));
311 	udelay(10);
312 	outb(value, SV_REG(sonic, DATA));
313 	udelay(10);
314 	spin_unlock_irqrestore(&sonic->reg_lock, flags);
315 }
316 
317 static unsigned char snd_sonicvibes_in1(struct sonicvibes * sonic, unsigned char reg)
318 {
319 	unsigned char value;
320 
321 	outb(reg, SV_REG(sonic, INDEX));
322 	udelay(10);
323 	value = inb(SV_REG(sonic, DATA));
324 	udelay(10);
325 	return value;
326 }
327 
328 static unsigned char snd_sonicvibes_in(struct sonicvibes * sonic, unsigned char reg)
329 {
330 	unsigned long flags;
331 	unsigned char value;
332 
333 	spin_lock_irqsave(&sonic->reg_lock, flags);
334 	outb(reg, SV_REG(sonic, INDEX));
335 	udelay(10);
336 	value = inb(SV_REG(sonic, DATA));
337 	udelay(10);
338 	spin_unlock_irqrestore(&sonic->reg_lock, flags);
339 	return value;
340 }
341 
342 #if 0
343 static void snd_sonicvibes_debug(struct sonicvibes * sonic)
344 {
345 	dev_dbg(sonic->card->dev,
346 		"SV REGS:          INDEX = 0x%02x                   STATUS = 0x%02x\n",
347 		inb(SV_REG(sonic, INDEX)), inb(SV_REG(sonic, STATUS)));
348 	dev_dbg(sonic->card->dev,
349 		"  0x00: left input      = 0x%02x    0x20: synth rate low  = 0x%02x\n",
350 		snd_sonicvibes_in(sonic, 0x00), snd_sonicvibes_in(sonic, 0x20));
351 	dev_dbg(sonic->card->dev,
352 		"  0x01: right input     = 0x%02x    0x21: synth rate high = 0x%02x\n",
353 		snd_sonicvibes_in(sonic, 0x01), snd_sonicvibes_in(sonic, 0x21));
354 	dev_dbg(sonic->card->dev,
355 		"  0x02: left AUX1       = 0x%02x    0x22: ADC clock       = 0x%02x\n",
356 		snd_sonicvibes_in(sonic, 0x02), snd_sonicvibes_in(sonic, 0x22));
357 	dev_dbg(sonic->card->dev,
358 		"  0x03: right AUX1      = 0x%02x    0x23: ADC alt rate    = 0x%02x\n",
359 		snd_sonicvibes_in(sonic, 0x03), snd_sonicvibes_in(sonic, 0x23));
360 	dev_dbg(sonic->card->dev,
361 		"  0x04: left CD         = 0x%02x    0x24: ADC pll M       = 0x%02x\n",
362 		snd_sonicvibes_in(sonic, 0x04), snd_sonicvibes_in(sonic, 0x24));
363 	dev_dbg(sonic->card->dev,
364 		"  0x05: right CD        = 0x%02x    0x25: ADC pll N       = 0x%02x\n",
365 		snd_sonicvibes_in(sonic, 0x05), snd_sonicvibes_in(sonic, 0x25));
366 	dev_dbg(sonic->card->dev,
367 		"  0x06: left line       = 0x%02x    0x26: Synth pll M     = 0x%02x\n",
368 		snd_sonicvibes_in(sonic, 0x06), snd_sonicvibes_in(sonic, 0x26));
369 	dev_dbg(sonic->card->dev,
370 		"  0x07: right line      = 0x%02x    0x27: Synth pll N     = 0x%02x\n",
371 		snd_sonicvibes_in(sonic, 0x07), snd_sonicvibes_in(sonic, 0x27));
372 	dev_dbg(sonic->card->dev,
373 		"  0x08: MIC             = 0x%02x    0x28: ---             = 0x%02x\n",
374 		snd_sonicvibes_in(sonic, 0x08), snd_sonicvibes_in(sonic, 0x28));
375 	dev_dbg(sonic->card->dev,
376 		"  0x09: Game port       = 0x%02x    0x29: ---             = 0x%02x\n",
377 		snd_sonicvibes_in(sonic, 0x09), snd_sonicvibes_in(sonic, 0x29));
378 	dev_dbg(sonic->card->dev,
379 		"  0x0a: left synth      = 0x%02x    0x2a: MPU401          = 0x%02x\n",
380 		snd_sonicvibes_in(sonic, 0x0a), snd_sonicvibes_in(sonic, 0x2a));
381 	dev_dbg(sonic->card->dev,
382 		"  0x0b: right synth     = 0x%02x    0x2b: drive ctrl      = 0x%02x\n",
383 		snd_sonicvibes_in(sonic, 0x0b), snd_sonicvibes_in(sonic, 0x2b));
384 	dev_dbg(sonic->card->dev,
385 		"  0x0c: left AUX2       = 0x%02x    0x2c: SRS space       = 0x%02x\n",
386 		snd_sonicvibes_in(sonic, 0x0c), snd_sonicvibes_in(sonic, 0x2c));
387 	dev_dbg(sonic->card->dev,
388 		"  0x0d: right AUX2      = 0x%02x    0x2d: SRS center      = 0x%02x\n",
389 		snd_sonicvibes_in(sonic, 0x0d), snd_sonicvibes_in(sonic, 0x2d));
390 	dev_dbg(sonic->card->dev,
391 		"  0x0e: left analog     = 0x%02x    0x2e: wave source     = 0x%02x\n",
392 		snd_sonicvibes_in(sonic, 0x0e), snd_sonicvibes_in(sonic, 0x2e));
393 	dev_dbg(sonic->card->dev,
394 		"  0x0f: right analog    = 0x%02x    0x2f: ---             = 0x%02x\n",
395 		snd_sonicvibes_in(sonic, 0x0f), snd_sonicvibes_in(sonic, 0x2f));
396 	dev_dbg(sonic->card->dev,
397 		"  0x10: left PCM        = 0x%02x    0x30: analog power    = 0x%02x\n",
398 		snd_sonicvibes_in(sonic, 0x10), snd_sonicvibes_in(sonic, 0x30));
399 	dev_dbg(sonic->card->dev,
400 		"  0x11: right PCM       = 0x%02x    0x31: analog power    = 0x%02x\n",
401 		snd_sonicvibes_in(sonic, 0x11), snd_sonicvibes_in(sonic, 0x31));
402 	dev_dbg(sonic->card->dev,
403 		"  0x12: DMA data format = 0x%02x    0x32: ---             = 0x%02x\n",
404 		snd_sonicvibes_in(sonic, 0x12), snd_sonicvibes_in(sonic, 0x32));
405 	dev_dbg(sonic->card->dev,
406 		"  0x13: P/C enable      = 0x%02x    0x33: ---             = 0x%02x\n",
407 		snd_sonicvibes_in(sonic, 0x13), snd_sonicvibes_in(sonic, 0x33));
408 	dev_dbg(sonic->card->dev,
409 		"  0x14: U/D button      = 0x%02x    0x34: ---             = 0x%02x\n",
410 		snd_sonicvibes_in(sonic, 0x14), snd_sonicvibes_in(sonic, 0x34));
411 	dev_dbg(sonic->card->dev,
412 		"  0x15: revision        = 0x%02x    0x35: ---             = 0x%02x\n",
413 		snd_sonicvibes_in(sonic, 0x15), snd_sonicvibes_in(sonic, 0x35));
414 	dev_dbg(sonic->card->dev,
415 		"  0x16: ADC output ctrl = 0x%02x    0x36: ---             = 0x%02x\n",
416 		snd_sonicvibes_in(sonic, 0x16), snd_sonicvibes_in(sonic, 0x36));
417 	dev_dbg(sonic->card->dev,
418 		"  0x17: ---             = 0x%02x    0x37: ---             = 0x%02x\n",
419 		snd_sonicvibes_in(sonic, 0x17), snd_sonicvibes_in(sonic, 0x37));
420 	dev_dbg(sonic->card->dev,
421 		"  0x18: DMA A upper cnt = 0x%02x    0x38: ---             = 0x%02x\n",
422 		snd_sonicvibes_in(sonic, 0x18), snd_sonicvibes_in(sonic, 0x38));
423 	dev_dbg(sonic->card->dev,
424 		"  0x19: DMA A lower cnt = 0x%02x    0x39: ---             = 0x%02x\n",
425 		snd_sonicvibes_in(sonic, 0x19), snd_sonicvibes_in(sonic, 0x39));
426 	dev_dbg(sonic->card->dev,
427 		"  0x1a: ---             = 0x%02x    0x3a: ---             = 0x%02x\n",
428 		snd_sonicvibes_in(sonic, 0x1a), snd_sonicvibes_in(sonic, 0x3a));
429 	dev_dbg(sonic->card->dev,
430 		"  0x1b: ---             = 0x%02x    0x3b: ---             = 0x%02x\n",
431 		snd_sonicvibes_in(sonic, 0x1b), snd_sonicvibes_in(sonic, 0x3b));
432 	dev_dbg(sonic->card->dev,
433 		"  0x1c: DMA C upper cnt = 0x%02x    0x3c: ---             = 0x%02x\n",
434 		snd_sonicvibes_in(sonic, 0x1c), snd_sonicvibes_in(sonic, 0x3c));
435 	dev_dbg(sonic->card->dev,
436 		"  0x1d: DMA C upper cnt = 0x%02x    0x3d: ---             = 0x%02x\n",
437 		snd_sonicvibes_in(sonic, 0x1d), snd_sonicvibes_in(sonic, 0x3d));
438 	dev_dbg(sonic->card->dev,
439 		"  0x1e: PCM rate low    = 0x%02x    0x3e: ---             = 0x%02x\n",
440 		snd_sonicvibes_in(sonic, 0x1e), snd_sonicvibes_in(sonic, 0x3e));
441 	dev_dbg(sonic->card->dev,
442 		"  0x1f: PCM rate high   = 0x%02x    0x3f: ---             = 0x%02x\n",
443 		snd_sonicvibes_in(sonic, 0x1f), snd_sonicvibes_in(sonic, 0x3f));
444 }
445 
446 #endif
447 
448 static void snd_sonicvibes_setfmt(struct sonicvibes * sonic,
449                                   unsigned char mask,
450                                   unsigned char value)
451 {
452 	unsigned long flags;
453 
454 	spin_lock_irqsave(&sonic->reg_lock, flags);
455 	outb(SV_MCE | SV_IREG_DMA_DATA_FMT, SV_REG(sonic, INDEX));
456 	if (mask) {
457 		sonic->format = inb(SV_REG(sonic, DATA));
458 		udelay(10);
459 	}
460 	sonic->format = (sonic->format & mask) | value;
461 	outb(sonic->format, SV_REG(sonic, DATA));
462 	udelay(10);
463 	outb(0, SV_REG(sonic, INDEX));
464 	udelay(10);
465 	spin_unlock_irqrestore(&sonic->reg_lock, flags);
466 }
467 
468 static void snd_sonicvibes_pll(unsigned int rate,
469 			       unsigned int *res_r,
470 			       unsigned int *res_m,
471 			       unsigned int *res_n)
472 {
473 	unsigned int r, m = 0, n = 0;
474 	unsigned int xm, xn, xr, xd, metric = ~0U;
475 
476 	if (rate < 625000 / SV_ADCMULT)
477 		rate = 625000 / SV_ADCMULT;
478 	if (rate > 150000000 / SV_ADCMULT)
479 		rate = 150000000 / SV_ADCMULT;
480 	/* slight violation of specs, needed for continuous sampling rates */
481 	for (r = 0; rate < 75000000 / SV_ADCMULT; r += 0x20, rate <<= 1);
482 	for (xn = 3; xn < 33; xn++)	/* 35 */
483 		for (xm = 3; xm < 257; xm++) {
484 			xr = ((SV_REFFREQUENCY / SV_ADCMULT) * xm) / xn;
485 			if (xr >= rate)
486 				xd = xr - rate;
487 			else
488 				xd = rate - xr;
489 			if (xd < metric) {
490 				metric = xd;
491 				m = xm - 2;
492 				n = xn - 2;
493 			}
494 		}
495 	*res_r = r;
496 	*res_m = m;
497 	*res_n = n;
498 #if 0
499 	dev_dbg(sonic->card->dev,
500 		"metric = %i, xm = %i, xn = %i\n", metric, xm, xn);
501 	dev_dbg(sonic->card->dev,
502 		"pll: m = 0x%x, r = 0x%x, n = 0x%x\n", reg, m, r, n);
503 #endif
504 }
505 
506 static void snd_sonicvibes_setpll(struct sonicvibes * sonic,
507                                   unsigned char reg,
508                                   unsigned int rate)
509 {
510 	unsigned long flags;
511 	unsigned int r, m, n;
512 
513 	snd_sonicvibes_pll(rate, &r, &m, &n);
514 	if (sonic != NULL) {
515 		spin_lock_irqsave(&sonic->reg_lock, flags);
516 		snd_sonicvibes_out1(sonic, reg, m);
517 		snd_sonicvibes_out1(sonic, reg + 1, r | n);
518 		spin_unlock_irqrestore(&sonic->reg_lock, flags);
519 	}
520 }
521 
522 static void snd_sonicvibes_set_adc_rate(struct sonicvibes * sonic, unsigned int rate)
523 {
524 	unsigned long flags;
525 	unsigned int div;
526 	unsigned char clock;
527 
528 	div = 48000 / rate;
529 	if (div > 8)
530 		div = 8;
531 	if ((48000 / div) == rate) {	/* use the alternate clock */
532 		clock = 0x10;
533 	} else {			/* use the PLL source */
534 		clock = 0x00;
535 		snd_sonicvibes_setpll(sonic, SV_IREG_ADC_PLL, rate);
536 	}
537 	spin_lock_irqsave(&sonic->reg_lock, flags);
538 	snd_sonicvibes_out1(sonic, SV_IREG_ADC_ALT_RATE, (div - 1) << 4);
539 	snd_sonicvibes_out1(sonic, SV_IREG_ADC_CLOCK, clock);
540 	spin_unlock_irqrestore(&sonic->reg_lock, flags);
541 }
542 
543 static int snd_sonicvibes_hw_constraint_dac_rate(struct snd_pcm_hw_params *params,
544 						 struct snd_pcm_hw_rule *rule)
545 {
546 	unsigned int rate, div, r, m, n;
547 
548 	if (hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE)->min ==
549 	    hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE)->max) {
550 		rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE)->min;
551 		div = 48000 / rate;
552 		if (div > 8)
553 			div = 8;
554 		if ((48000 / div) == rate) {
555 			params->rate_num = rate;
556 			params->rate_den = 1;
557 		} else {
558 			snd_sonicvibes_pll(rate, &r, &m, &n);
559 			snd_BUG_ON(SV_REFFREQUENCY % 16);
560 			snd_BUG_ON(SV_ADCMULT % 512);
561 			params->rate_num = (SV_REFFREQUENCY/16) * (n+2) * r;
562 			params->rate_den = (SV_ADCMULT/512) * (m+2);
563 		}
564 	}
565 	return 0;
566 }
567 
568 static void snd_sonicvibes_set_dac_rate(struct sonicvibes * sonic, unsigned int rate)
569 {
570 	unsigned int div;
571 	unsigned long flags;
572 
573 	div = (rate * 65536 + SV_FULLRATE / 2) / SV_FULLRATE;
574 	if (div > 65535)
575 		div = 65535;
576 	spin_lock_irqsave(&sonic->reg_lock, flags);
577 	snd_sonicvibes_out1(sonic, SV_IREG_PCM_RATE_HIGH, div >> 8);
578 	snd_sonicvibes_out1(sonic, SV_IREG_PCM_RATE_LOW, div);
579 	spin_unlock_irqrestore(&sonic->reg_lock, flags);
580 }
581 
582 static int snd_sonicvibes_trigger(struct sonicvibes * sonic, int what, int cmd)
583 {
584 	int result = 0;
585 
586 	spin_lock(&sonic->reg_lock);
587 	if (cmd == SNDRV_PCM_TRIGGER_START) {
588 		if (!(sonic->enable & what)) {
589 			sonic->enable |= what;
590 			snd_sonicvibes_out1(sonic, SV_IREG_PC_ENABLE, sonic->enable);
591 		}
592 	} else if (cmd == SNDRV_PCM_TRIGGER_STOP) {
593 		if (sonic->enable & what) {
594 			sonic->enable &= ~what;
595 			snd_sonicvibes_out1(sonic, SV_IREG_PC_ENABLE, sonic->enable);
596 		}
597 	} else {
598 		result = -EINVAL;
599 	}
600 	spin_unlock(&sonic->reg_lock);
601 	return result;
602 }
603 
604 static irqreturn_t snd_sonicvibes_interrupt(int irq, void *dev_id)
605 {
606 	struct sonicvibes *sonic = dev_id;
607 	unsigned char status;
608 
609 	status = inb(SV_REG(sonic, STATUS));
610 	if (!(status & (SV_DMAA_IRQ | SV_DMAC_IRQ | SV_MIDI_IRQ)))
611 		return IRQ_NONE;
612 	if (status == 0xff) {	/* failure */
613 		outb(sonic->irqmask = ~0, SV_REG(sonic, IRQMASK));
614 		dev_err(sonic->card->dev,
615 			"IRQ failure - interrupts disabled!!\n");
616 		return IRQ_HANDLED;
617 	}
618 	if (sonic->pcm) {
619 		if (status & SV_DMAA_IRQ)
620 			snd_pcm_period_elapsed(sonic->playback_substream);
621 		if (status & SV_DMAC_IRQ)
622 			snd_pcm_period_elapsed(sonic->capture_substream);
623 	}
624 	if (sonic->rmidi) {
625 		if (status & SV_MIDI_IRQ)
626 			snd_mpu401_uart_interrupt(irq, sonic->rmidi->private_data);
627 	}
628 	if (status & SV_UD_IRQ) {
629 		unsigned char udreg;
630 		int vol, oleft, oright, mleft, mright;
631 
632 		spin_lock(&sonic->reg_lock);
633 		udreg = snd_sonicvibes_in1(sonic, SV_IREG_UD_BUTTON);
634 		vol = udreg & 0x3f;
635 		if (!(udreg & 0x40))
636 			vol = -vol;
637 		oleft = mleft = snd_sonicvibes_in1(sonic, SV_IREG_LEFT_ANALOG);
638 		oright = mright = snd_sonicvibes_in1(sonic, SV_IREG_RIGHT_ANALOG);
639 		oleft &= 0x1f;
640 		oright &= 0x1f;
641 		oleft += vol;
642 		if (oleft < 0)
643 			oleft = 0;
644 		if (oleft > 0x1f)
645 			oleft = 0x1f;
646 		oright += vol;
647 		if (oright < 0)
648 			oright = 0;
649 		if (oright > 0x1f)
650 			oright = 0x1f;
651 		if (udreg & 0x80) {
652 			mleft ^= 0x80;
653 			mright ^= 0x80;
654 		}
655 		oleft |= mleft & 0x80;
656 		oright |= mright & 0x80;
657 		snd_sonicvibes_out1(sonic, SV_IREG_LEFT_ANALOG, oleft);
658 		snd_sonicvibes_out1(sonic, SV_IREG_RIGHT_ANALOG, oright);
659 		spin_unlock(&sonic->reg_lock);
660 		snd_ctl_notify(sonic->card, SNDRV_CTL_EVENT_MASK_VALUE, &sonic->master_mute->id);
661 		snd_ctl_notify(sonic->card, SNDRV_CTL_EVENT_MASK_VALUE, &sonic->master_volume->id);
662 	}
663 	return IRQ_HANDLED;
664 }
665 
666 /*
667  *  PCM part
668  */
669 
670 static int snd_sonicvibes_playback_trigger(struct snd_pcm_substream *substream,
671 					   int cmd)
672 {
673 	struct sonicvibes *sonic = snd_pcm_substream_chip(substream);
674 	return snd_sonicvibes_trigger(sonic, 1, cmd);
675 }
676 
677 static int snd_sonicvibes_capture_trigger(struct snd_pcm_substream *substream,
678 					  int cmd)
679 {
680 	struct sonicvibes *sonic = snd_pcm_substream_chip(substream);
681 	return snd_sonicvibes_trigger(sonic, 2, cmd);
682 }
683 
684 static int snd_sonicvibes_hw_params(struct snd_pcm_substream *substream,
685 				    struct snd_pcm_hw_params *hw_params)
686 {
687 	return snd_pcm_lib_malloc_pages(substream, params_buffer_bytes(hw_params));
688 }
689 
690 static int snd_sonicvibes_hw_free(struct snd_pcm_substream *substream)
691 {
692 	return snd_pcm_lib_free_pages(substream);
693 }
694 
695 static int snd_sonicvibes_playback_prepare(struct snd_pcm_substream *substream)
696 {
697 	struct sonicvibes *sonic = snd_pcm_substream_chip(substream);
698 	struct snd_pcm_runtime *runtime = substream->runtime;
699 	unsigned char fmt = 0;
700 	unsigned int size = snd_pcm_lib_buffer_bytes(substream);
701 	unsigned int count = snd_pcm_lib_period_bytes(substream);
702 
703 	sonic->p_dma_size = size;
704 	count--;
705 	if (runtime->channels > 1)
706 		fmt |= 1;
707 	if (snd_pcm_format_width(runtime->format) == 16)
708 		fmt |= 2;
709 	snd_sonicvibes_setfmt(sonic, ~3, fmt);
710 	snd_sonicvibes_set_dac_rate(sonic, runtime->rate);
711 	spin_lock_irq(&sonic->reg_lock);
712 	snd_sonicvibes_setdmaa(sonic, runtime->dma_addr, size);
713 	snd_sonicvibes_out1(sonic, SV_IREG_DMA_A_UPPER, count >> 8);
714 	snd_sonicvibes_out1(sonic, SV_IREG_DMA_A_LOWER, count);
715 	spin_unlock_irq(&sonic->reg_lock);
716 	return 0;
717 }
718 
719 static int snd_sonicvibes_capture_prepare(struct snd_pcm_substream *substream)
720 {
721 	struct sonicvibes *sonic = snd_pcm_substream_chip(substream);
722 	struct snd_pcm_runtime *runtime = substream->runtime;
723 	unsigned char fmt = 0;
724 	unsigned int size = snd_pcm_lib_buffer_bytes(substream);
725 	unsigned int count = snd_pcm_lib_period_bytes(substream);
726 
727 	sonic->c_dma_size = size;
728 	count >>= 1;
729 	count--;
730 	if (runtime->channels > 1)
731 		fmt |= 0x10;
732 	if (snd_pcm_format_width(runtime->format) == 16)
733 		fmt |= 0x20;
734 	snd_sonicvibes_setfmt(sonic, ~0x30, fmt);
735 	snd_sonicvibes_set_adc_rate(sonic, runtime->rate);
736 	spin_lock_irq(&sonic->reg_lock);
737 	snd_sonicvibes_setdmac(sonic, runtime->dma_addr, size);
738 	snd_sonicvibes_out1(sonic, SV_IREG_DMA_C_UPPER, count >> 8);
739 	snd_sonicvibes_out1(sonic, SV_IREG_DMA_C_LOWER, count);
740 	spin_unlock_irq(&sonic->reg_lock);
741 	return 0;
742 }
743 
744 static snd_pcm_uframes_t snd_sonicvibes_playback_pointer(struct snd_pcm_substream *substream)
745 {
746 	struct sonicvibes *sonic = snd_pcm_substream_chip(substream);
747 	size_t ptr;
748 
749 	if (!(sonic->enable & 1))
750 		return 0;
751 	ptr = sonic->p_dma_size - snd_sonicvibes_getdmaa(sonic);
752 	return bytes_to_frames(substream->runtime, ptr);
753 }
754 
755 static snd_pcm_uframes_t snd_sonicvibes_capture_pointer(struct snd_pcm_substream *substream)
756 {
757 	struct sonicvibes *sonic = snd_pcm_substream_chip(substream);
758 	size_t ptr;
759 	if (!(sonic->enable & 2))
760 		return 0;
761 	ptr = sonic->c_dma_size - snd_sonicvibes_getdmac(sonic);
762 	return bytes_to_frames(substream->runtime, ptr);
763 }
764 
765 static const struct snd_pcm_hardware snd_sonicvibes_playback =
766 {
767 	.info =			(SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
768 				 SNDRV_PCM_INFO_BLOCK_TRANSFER |
769 				 SNDRV_PCM_INFO_MMAP_VALID),
770 	.formats =		SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE,
771 	.rates =		SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_8000_48000,
772 	.rate_min =		4000,
773 	.rate_max =		48000,
774 	.channels_min =		1,
775 	.channels_max =		2,
776 	.buffer_bytes_max =	(128*1024),
777 	.period_bytes_min =	32,
778 	.period_bytes_max =	(128*1024),
779 	.periods_min =		1,
780 	.periods_max =		1024,
781 	.fifo_size =		0,
782 };
783 
784 static const struct snd_pcm_hardware snd_sonicvibes_capture =
785 {
786 	.info =			(SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
787 				 SNDRV_PCM_INFO_BLOCK_TRANSFER |
788 				 SNDRV_PCM_INFO_MMAP_VALID),
789 	.formats =		SNDRV_PCM_FMTBIT_U8 | SNDRV_PCM_FMTBIT_S16_LE,
790 	.rates =		SNDRV_PCM_RATE_CONTINUOUS | SNDRV_PCM_RATE_8000_48000,
791 	.rate_min =		4000,
792 	.rate_max =		48000,
793 	.channels_min =		1,
794 	.channels_max =		2,
795 	.buffer_bytes_max =	(128*1024),
796 	.period_bytes_min =	32,
797 	.period_bytes_max =	(128*1024),
798 	.periods_min =		1,
799 	.periods_max =		1024,
800 	.fifo_size =		0,
801 };
802 
803 static int snd_sonicvibes_playback_open(struct snd_pcm_substream *substream)
804 {
805 	struct sonicvibes *sonic = snd_pcm_substream_chip(substream);
806 	struct snd_pcm_runtime *runtime = substream->runtime;
807 
808 	sonic->mode |= SV_MODE_PLAY;
809 	sonic->playback_substream = substream;
810 	runtime->hw = snd_sonicvibes_playback;
811 	snd_pcm_hw_rule_add(runtime, 0, SNDRV_PCM_HW_PARAM_RATE, snd_sonicvibes_hw_constraint_dac_rate, NULL, SNDRV_PCM_HW_PARAM_RATE, -1);
812 	return 0;
813 }
814 
815 static int snd_sonicvibes_capture_open(struct snd_pcm_substream *substream)
816 {
817 	struct sonicvibes *sonic = snd_pcm_substream_chip(substream);
818 	struct snd_pcm_runtime *runtime = substream->runtime;
819 
820 	sonic->mode |= SV_MODE_CAPTURE;
821 	sonic->capture_substream = substream;
822 	runtime->hw = snd_sonicvibes_capture;
823 	snd_pcm_hw_constraint_ratdens(runtime, 0, SNDRV_PCM_HW_PARAM_RATE,
824 				      &snd_sonicvibes_hw_constraints_adc_clock);
825 	return 0;
826 }
827 
828 static int snd_sonicvibes_playback_close(struct snd_pcm_substream *substream)
829 {
830 	struct sonicvibes *sonic = snd_pcm_substream_chip(substream);
831 
832 	sonic->playback_substream = NULL;
833 	sonic->mode &= ~SV_MODE_PLAY;
834 	return 0;
835 }
836 
837 static int snd_sonicvibes_capture_close(struct snd_pcm_substream *substream)
838 {
839 	struct sonicvibes *sonic = snd_pcm_substream_chip(substream);
840 
841 	sonic->capture_substream = NULL;
842 	sonic->mode &= ~SV_MODE_CAPTURE;
843 	return 0;
844 }
845 
846 static const struct snd_pcm_ops snd_sonicvibes_playback_ops = {
847 	.open =		snd_sonicvibes_playback_open,
848 	.close =	snd_sonicvibes_playback_close,
849 	.ioctl =	snd_pcm_lib_ioctl,
850 	.hw_params =	snd_sonicvibes_hw_params,
851 	.hw_free =	snd_sonicvibes_hw_free,
852 	.prepare =	snd_sonicvibes_playback_prepare,
853 	.trigger =	snd_sonicvibes_playback_trigger,
854 	.pointer =	snd_sonicvibes_playback_pointer,
855 };
856 
857 static const struct snd_pcm_ops snd_sonicvibes_capture_ops = {
858 	.open =		snd_sonicvibes_capture_open,
859 	.close =	snd_sonicvibes_capture_close,
860 	.ioctl =	snd_pcm_lib_ioctl,
861 	.hw_params =	snd_sonicvibes_hw_params,
862 	.hw_free =	snd_sonicvibes_hw_free,
863 	.prepare =	snd_sonicvibes_capture_prepare,
864 	.trigger =	snd_sonicvibes_capture_trigger,
865 	.pointer =	snd_sonicvibes_capture_pointer,
866 };
867 
868 static int snd_sonicvibes_pcm(struct sonicvibes *sonic, int device)
869 {
870 	struct snd_pcm *pcm;
871 	int err;
872 
873 	if ((err = snd_pcm_new(sonic->card, "s3_86c617", device, 1, 1, &pcm)) < 0)
874 		return err;
875 	if (snd_BUG_ON(!pcm))
876 		return -EINVAL;
877 
878 	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK, &snd_sonicvibes_playback_ops);
879 	snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_sonicvibes_capture_ops);
880 
881 	pcm->private_data = sonic;
882 	pcm->info_flags = 0;
883 	strcpy(pcm->name, "S3 SonicVibes");
884 	sonic->pcm = pcm;
885 
886 	snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_DEV,
887 					      snd_dma_pci_data(sonic->pci), 64*1024, 128*1024);
888 
889 	return 0;
890 }
891 
892 /*
893  *  Mixer part
894  */
895 
896 #define SONICVIBES_MUX(xname, xindex) \
897 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
898   .info = snd_sonicvibes_info_mux, \
899   .get = snd_sonicvibes_get_mux, .put = snd_sonicvibes_put_mux }
900 
901 static int snd_sonicvibes_info_mux(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
902 {
903 	static const char * const texts[7] = {
904 		"CD", "PCM", "Aux1", "Line", "Aux0", "Mic", "Mix"
905 	};
906 
907 	return snd_ctl_enum_info(uinfo, 2, 7, texts);
908 }
909 
910 static int snd_sonicvibes_get_mux(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
911 {
912 	struct sonicvibes *sonic = snd_kcontrol_chip(kcontrol);
913 
914 	spin_lock_irq(&sonic->reg_lock);
915 	ucontrol->value.enumerated.item[0] = ((snd_sonicvibes_in1(sonic, SV_IREG_LEFT_ADC) & SV_RECSRC_OUT) >> 5) - 1;
916 	ucontrol->value.enumerated.item[1] = ((snd_sonicvibes_in1(sonic, SV_IREG_RIGHT_ADC) & SV_RECSRC_OUT) >> 5) - 1;
917 	spin_unlock_irq(&sonic->reg_lock);
918 	return 0;
919 }
920 
921 static int snd_sonicvibes_put_mux(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
922 {
923 	struct sonicvibes *sonic = snd_kcontrol_chip(kcontrol);
924 	unsigned short left, right, oval1, oval2;
925 	int change;
926 
927 	if (ucontrol->value.enumerated.item[0] >= 7 ||
928 	    ucontrol->value.enumerated.item[1] >= 7)
929 		return -EINVAL;
930 	left = (ucontrol->value.enumerated.item[0] + 1) << 5;
931 	right = (ucontrol->value.enumerated.item[1] + 1) << 5;
932 	spin_lock_irq(&sonic->reg_lock);
933 	oval1 = snd_sonicvibes_in1(sonic, SV_IREG_LEFT_ADC);
934 	oval2 = snd_sonicvibes_in1(sonic, SV_IREG_RIGHT_ADC);
935 	left = (oval1 & ~SV_RECSRC_OUT) | left;
936 	right = (oval2 & ~SV_RECSRC_OUT) | right;
937 	change = left != oval1 || right != oval2;
938 	snd_sonicvibes_out1(sonic, SV_IREG_LEFT_ADC, left);
939 	snd_sonicvibes_out1(sonic, SV_IREG_RIGHT_ADC, right);
940 	spin_unlock_irq(&sonic->reg_lock);
941 	return change;
942 }
943 
944 #define SONICVIBES_SINGLE(xname, xindex, reg, shift, mask, invert) \
945 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
946   .info = snd_sonicvibes_info_single, \
947   .get = snd_sonicvibes_get_single, .put = snd_sonicvibes_put_single, \
948   .private_value = reg | (shift << 8) | (mask << 16) | (invert << 24) }
949 
950 static int snd_sonicvibes_info_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
951 {
952 	int mask = (kcontrol->private_value >> 16) & 0xff;
953 
954 	uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
955 	uinfo->count = 1;
956 	uinfo->value.integer.min = 0;
957 	uinfo->value.integer.max = mask;
958 	return 0;
959 }
960 
961 static int snd_sonicvibes_get_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
962 {
963 	struct sonicvibes *sonic = snd_kcontrol_chip(kcontrol);
964 	int reg = kcontrol->private_value & 0xff;
965 	int shift = (kcontrol->private_value >> 8) & 0xff;
966 	int mask = (kcontrol->private_value >> 16) & 0xff;
967 	int invert = (kcontrol->private_value >> 24) & 0xff;
968 
969 	spin_lock_irq(&sonic->reg_lock);
970 	ucontrol->value.integer.value[0] = (snd_sonicvibes_in1(sonic, reg)>> shift) & mask;
971 	spin_unlock_irq(&sonic->reg_lock);
972 	if (invert)
973 		ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
974 	return 0;
975 }
976 
977 static int snd_sonicvibes_put_single(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
978 {
979 	struct sonicvibes *sonic = snd_kcontrol_chip(kcontrol);
980 	int reg = kcontrol->private_value & 0xff;
981 	int shift = (kcontrol->private_value >> 8) & 0xff;
982 	int mask = (kcontrol->private_value >> 16) & 0xff;
983 	int invert = (kcontrol->private_value >> 24) & 0xff;
984 	int change;
985 	unsigned short val, oval;
986 
987 	val = (ucontrol->value.integer.value[0] & mask);
988 	if (invert)
989 		val = mask - val;
990 	val <<= shift;
991 	spin_lock_irq(&sonic->reg_lock);
992 	oval = snd_sonicvibes_in1(sonic, reg);
993 	val = (oval & ~(mask << shift)) | val;
994 	change = val != oval;
995 	snd_sonicvibes_out1(sonic, reg, val);
996 	spin_unlock_irq(&sonic->reg_lock);
997 	return change;
998 }
999 
1000 #define SONICVIBES_DOUBLE(xname, xindex, left_reg, right_reg, shift_left, shift_right, mask, invert) \
1001 { .iface = SNDRV_CTL_ELEM_IFACE_MIXER, .name = xname, .index = xindex, \
1002   .info = snd_sonicvibes_info_double, \
1003   .get = snd_sonicvibes_get_double, .put = snd_sonicvibes_put_double, \
1004   .private_value = left_reg | (right_reg << 8) | (shift_left << 16) | (shift_right << 19) | (mask << 24) | (invert << 22) }
1005 
1006 static int snd_sonicvibes_info_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
1007 {
1008 	int mask = (kcontrol->private_value >> 24) & 0xff;
1009 
1010 	uinfo->type = mask == 1 ? SNDRV_CTL_ELEM_TYPE_BOOLEAN : SNDRV_CTL_ELEM_TYPE_INTEGER;
1011 	uinfo->count = 2;
1012 	uinfo->value.integer.min = 0;
1013 	uinfo->value.integer.max = mask;
1014 	return 0;
1015 }
1016 
1017 static int snd_sonicvibes_get_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1018 {
1019 	struct sonicvibes *sonic = snd_kcontrol_chip(kcontrol);
1020 	int left_reg = kcontrol->private_value & 0xff;
1021 	int right_reg = (kcontrol->private_value >> 8) & 0xff;
1022 	int shift_left = (kcontrol->private_value >> 16) & 0x07;
1023 	int shift_right = (kcontrol->private_value >> 19) & 0x07;
1024 	int mask = (kcontrol->private_value >> 24) & 0xff;
1025 	int invert = (kcontrol->private_value >> 22) & 1;
1026 
1027 	spin_lock_irq(&sonic->reg_lock);
1028 	ucontrol->value.integer.value[0] = (snd_sonicvibes_in1(sonic, left_reg) >> shift_left) & mask;
1029 	ucontrol->value.integer.value[1] = (snd_sonicvibes_in1(sonic, right_reg) >> shift_right) & mask;
1030 	spin_unlock_irq(&sonic->reg_lock);
1031 	if (invert) {
1032 		ucontrol->value.integer.value[0] = mask - ucontrol->value.integer.value[0];
1033 		ucontrol->value.integer.value[1] = mask - ucontrol->value.integer.value[1];
1034 	}
1035 	return 0;
1036 }
1037 
1038 static int snd_sonicvibes_put_double(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1039 {
1040 	struct sonicvibes *sonic = snd_kcontrol_chip(kcontrol);
1041 	int left_reg = kcontrol->private_value & 0xff;
1042 	int right_reg = (kcontrol->private_value >> 8) & 0xff;
1043 	int shift_left = (kcontrol->private_value >> 16) & 0x07;
1044 	int shift_right = (kcontrol->private_value >> 19) & 0x07;
1045 	int mask = (kcontrol->private_value >> 24) & 0xff;
1046 	int invert = (kcontrol->private_value >> 22) & 1;
1047 	int change;
1048 	unsigned short val1, val2, oval1, oval2;
1049 
1050 	val1 = ucontrol->value.integer.value[0] & mask;
1051 	val2 = ucontrol->value.integer.value[1] & mask;
1052 	if (invert) {
1053 		val1 = mask - val1;
1054 		val2 = mask - val2;
1055 	}
1056 	val1 <<= shift_left;
1057 	val2 <<= shift_right;
1058 	spin_lock_irq(&sonic->reg_lock);
1059 	oval1 = snd_sonicvibes_in1(sonic, left_reg);
1060 	oval2 = snd_sonicvibes_in1(sonic, right_reg);
1061 	val1 = (oval1 & ~(mask << shift_left)) | val1;
1062 	val2 = (oval2 & ~(mask << shift_right)) | val2;
1063 	change = val1 != oval1 || val2 != oval2;
1064 	snd_sonicvibes_out1(sonic, left_reg, val1);
1065 	snd_sonicvibes_out1(sonic, right_reg, val2);
1066 	spin_unlock_irq(&sonic->reg_lock);
1067 	return change;
1068 }
1069 
1070 static struct snd_kcontrol_new snd_sonicvibes_controls[] = {
1071 SONICVIBES_DOUBLE("Capture Volume", 0, SV_IREG_LEFT_ADC, SV_IREG_RIGHT_ADC, 0, 0, 15, 0),
1072 SONICVIBES_DOUBLE("Aux Playback Switch", 0, SV_IREG_LEFT_AUX1, SV_IREG_RIGHT_AUX1, 7, 7, 1, 1),
1073 SONICVIBES_DOUBLE("Aux Playback Volume", 0, SV_IREG_LEFT_AUX1, SV_IREG_RIGHT_AUX1, 0, 0, 31, 1),
1074 SONICVIBES_DOUBLE("CD Playback Switch", 0, SV_IREG_LEFT_CD, SV_IREG_RIGHT_CD, 7, 7, 1, 1),
1075 SONICVIBES_DOUBLE("CD Playback Volume", 0, SV_IREG_LEFT_CD, SV_IREG_RIGHT_CD, 0, 0, 31, 1),
1076 SONICVIBES_DOUBLE("Line Playback Switch", 0, SV_IREG_LEFT_LINE, SV_IREG_RIGHT_LINE, 7, 7, 1, 1),
1077 SONICVIBES_DOUBLE("Line Playback Volume", 0, SV_IREG_LEFT_LINE, SV_IREG_RIGHT_LINE, 0, 0, 31, 1),
1078 SONICVIBES_SINGLE("Mic Playback Switch", 0, SV_IREG_MIC, 7, 1, 1),
1079 SONICVIBES_SINGLE("Mic Playback Volume", 0, SV_IREG_MIC, 0, 15, 1),
1080 SONICVIBES_SINGLE("Mic Boost", 0, SV_IREG_LEFT_ADC, 4, 1, 0),
1081 SONICVIBES_DOUBLE("Synth Playback Switch", 0, SV_IREG_LEFT_SYNTH, SV_IREG_RIGHT_SYNTH, 7, 7, 1, 1),
1082 SONICVIBES_DOUBLE("Synth Playback Volume", 0, SV_IREG_LEFT_SYNTH, SV_IREG_RIGHT_SYNTH, 0, 0, 31, 1),
1083 SONICVIBES_DOUBLE("Aux Playback Switch", 1, SV_IREG_LEFT_AUX2, SV_IREG_RIGHT_AUX2, 7, 7, 1, 1),
1084 SONICVIBES_DOUBLE("Aux Playback Volume", 1, SV_IREG_LEFT_AUX2, SV_IREG_RIGHT_AUX2, 0, 0, 31, 1),
1085 SONICVIBES_DOUBLE("Master Playback Switch", 0, SV_IREG_LEFT_ANALOG, SV_IREG_RIGHT_ANALOG, 7, 7, 1, 1),
1086 SONICVIBES_DOUBLE("Master Playback Volume", 0, SV_IREG_LEFT_ANALOG, SV_IREG_RIGHT_ANALOG, 0, 0, 31, 1),
1087 SONICVIBES_DOUBLE("PCM Playback Switch", 0, SV_IREG_LEFT_PCM, SV_IREG_RIGHT_PCM, 7, 7, 1, 1),
1088 SONICVIBES_DOUBLE("PCM Playback Volume", 0, SV_IREG_LEFT_PCM, SV_IREG_RIGHT_PCM, 0, 0, 63, 1),
1089 SONICVIBES_SINGLE("Loopback Capture Switch", 0, SV_IREG_ADC_OUTPUT_CTRL, 0, 1, 0),
1090 SONICVIBES_SINGLE("Loopback Capture Volume", 0, SV_IREG_ADC_OUTPUT_CTRL, 2, 63, 1),
1091 SONICVIBES_MUX("Capture Source", 0)
1092 };
1093 
1094 static void snd_sonicvibes_master_free(struct snd_kcontrol *kcontrol)
1095 {
1096 	struct sonicvibes *sonic = snd_kcontrol_chip(kcontrol);
1097 	sonic->master_mute = NULL;
1098 	sonic->master_volume = NULL;
1099 }
1100 
1101 static int snd_sonicvibes_mixer(struct sonicvibes *sonic)
1102 {
1103 	struct snd_card *card;
1104 	struct snd_kcontrol *kctl;
1105 	unsigned int idx;
1106 	int err;
1107 
1108 	if (snd_BUG_ON(!sonic || !sonic->card))
1109 		return -EINVAL;
1110 	card = sonic->card;
1111 	strcpy(card->mixername, "S3 SonicVibes");
1112 
1113 	for (idx = 0; idx < ARRAY_SIZE(snd_sonicvibes_controls); idx++) {
1114 		if ((err = snd_ctl_add(card, kctl = snd_ctl_new1(&snd_sonicvibes_controls[idx], sonic))) < 0)
1115 			return err;
1116 		switch (idx) {
1117 		case 0:
1118 		case 1: kctl->private_free = snd_sonicvibes_master_free; break;
1119 		}
1120 	}
1121 	return 0;
1122 }
1123 
1124 /*
1125 
1126  */
1127 
1128 static void snd_sonicvibes_proc_read(struct snd_info_entry *entry,
1129 				     struct snd_info_buffer *buffer)
1130 {
1131 	struct sonicvibes *sonic = entry->private_data;
1132 	unsigned char tmp;
1133 
1134 	tmp = sonic->srs_space & 0x0f;
1135 	snd_iprintf(buffer, "SRS 3D           : %s\n",
1136 		    sonic->srs_space & 0x80 ? "off" : "on");
1137 	snd_iprintf(buffer, "SRS Space        : %s\n",
1138 		    tmp == 0x00 ? "100%" :
1139 		    tmp == 0x01 ? "75%" :
1140 		    tmp == 0x02 ? "50%" :
1141 		    tmp == 0x03 ? "25%" : "0%");
1142 	tmp = sonic->srs_center & 0x0f;
1143 	snd_iprintf(buffer, "SRS Center       : %s\n",
1144 		    tmp == 0x00 ? "100%" :
1145 		    tmp == 0x01 ? "75%" :
1146 		    tmp == 0x02 ? "50%" :
1147 		    tmp == 0x03 ? "25%" : "0%");
1148 	tmp = sonic->wave_source & 0x03;
1149 	snd_iprintf(buffer, "WaveTable Source : %s\n",
1150 		    tmp == 0x00 ? "on-board ROM" :
1151 		    tmp == 0x01 ? "PCI bus" : "on-board ROM + PCI bus");
1152 	tmp = sonic->mpu_switch;
1153 	snd_iprintf(buffer, "Onboard synth    : %s\n", tmp & 0x01 ? "on" : "off");
1154 	snd_iprintf(buffer, "Ext. Rx to synth : %s\n", tmp & 0x02 ? "on" : "off");
1155 	snd_iprintf(buffer, "MIDI to ext. Tx  : %s\n", tmp & 0x04 ? "on" : "off");
1156 }
1157 
1158 static void snd_sonicvibes_proc_init(struct sonicvibes *sonic)
1159 {
1160 	snd_card_ro_proc_new(sonic->card, "sonicvibes", sonic,
1161 			     snd_sonicvibes_proc_read);
1162 }
1163 
1164 /*
1165 
1166  */
1167 
1168 #ifdef SUPPORT_JOYSTICK
1169 static struct snd_kcontrol_new snd_sonicvibes_game_control =
1170 SONICVIBES_SINGLE("Joystick Speed", 0, SV_IREG_GAME_PORT, 1, 15, 0);
1171 
1172 static int snd_sonicvibes_create_gameport(struct sonicvibes *sonic)
1173 {
1174 	struct gameport *gp;
1175 	int err;
1176 
1177 	sonic->gameport = gp = gameport_allocate_port();
1178 	if (!gp) {
1179 		dev_err(sonic->card->dev,
1180 			"sonicvibes: cannot allocate memory for gameport\n");
1181 		return -ENOMEM;
1182 	}
1183 
1184 	gameport_set_name(gp, "SonicVibes Gameport");
1185 	gameport_set_phys(gp, "pci%s/gameport0", pci_name(sonic->pci));
1186 	gameport_set_dev_parent(gp, &sonic->pci->dev);
1187 	gp->io = sonic->game_port;
1188 
1189 	gameport_register_port(gp);
1190 
1191 	err = snd_ctl_add(sonic->card,
1192 		snd_ctl_new1(&snd_sonicvibes_game_control, sonic));
1193 	if (err < 0)
1194 		return err;
1195 
1196 	return 0;
1197 }
1198 
1199 static void snd_sonicvibes_free_gameport(struct sonicvibes *sonic)
1200 {
1201 	if (sonic->gameport) {
1202 		gameport_unregister_port(sonic->gameport);
1203 		sonic->gameport = NULL;
1204 	}
1205 }
1206 #else
1207 static inline int snd_sonicvibes_create_gameport(struct sonicvibes *sonic) { return -ENOSYS; }
1208 static inline void snd_sonicvibes_free_gameport(struct sonicvibes *sonic) { }
1209 #endif
1210 
1211 static int snd_sonicvibes_free(struct sonicvibes *sonic)
1212 {
1213 	snd_sonicvibes_free_gameport(sonic);
1214 	pci_write_config_dword(sonic->pci, 0x40, sonic->dmaa_port);
1215 	pci_write_config_dword(sonic->pci, 0x48, sonic->dmac_port);
1216 	if (sonic->irq >= 0)
1217 		free_irq(sonic->irq, sonic);
1218 	release_and_free_resource(sonic->res_dmaa);
1219 	release_and_free_resource(sonic->res_dmac);
1220 	pci_release_regions(sonic->pci);
1221 	pci_disable_device(sonic->pci);
1222 	kfree(sonic);
1223 	return 0;
1224 }
1225 
1226 static int snd_sonicvibes_dev_free(struct snd_device *device)
1227 {
1228 	struct sonicvibes *sonic = device->device_data;
1229 	return snd_sonicvibes_free(sonic);
1230 }
1231 
1232 static int snd_sonicvibes_create(struct snd_card *card,
1233 				 struct pci_dev *pci,
1234 				 int reverb,
1235 				 int mge,
1236 				 struct sonicvibes **rsonic)
1237 {
1238 	struct sonicvibes *sonic;
1239 	unsigned int dmaa, dmac;
1240 	int err;
1241 	static struct snd_device_ops ops = {
1242 		.dev_free =	snd_sonicvibes_dev_free,
1243 	};
1244 
1245 	*rsonic = NULL;
1246 	/* enable PCI device */
1247 	if ((err = pci_enable_device(pci)) < 0)
1248 		return err;
1249 	/* check, if we can restrict PCI DMA transfers to 24 bits */
1250 	if (dma_set_mask(&pci->dev, DMA_BIT_MASK(24)) < 0 ||
1251 	    dma_set_coherent_mask(&pci->dev, DMA_BIT_MASK(24)) < 0) {
1252 		dev_err(card->dev,
1253 			"architecture does not support 24bit PCI busmaster DMA\n");
1254 		pci_disable_device(pci);
1255                 return -ENXIO;
1256         }
1257 
1258 	sonic = kzalloc(sizeof(*sonic), GFP_KERNEL);
1259 	if (sonic == NULL) {
1260 		pci_disable_device(pci);
1261 		return -ENOMEM;
1262 	}
1263 	spin_lock_init(&sonic->reg_lock);
1264 	sonic->card = card;
1265 	sonic->pci = pci;
1266 	sonic->irq = -1;
1267 
1268 	if ((err = pci_request_regions(pci, "S3 SonicVibes")) < 0) {
1269 		kfree(sonic);
1270 		pci_disable_device(pci);
1271 		return err;
1272 	}
1273 
1274 	sonic->sb_port = pci_resource_start(pci, 0);
1275 	sonic->enh_port = pci_resource_start(pci, 1);
1276 	sonic->synth_port = pci_resource_start(pci, 2);
1277 	sonic->midi_port = pci_resource_start(pci, 3);
1278 	sonic->game_port = pci_resource_start(pci, 4);
1279 
1280 	if (request_irq(pci->irq, snd_sonicvibes_interrupt, IRQF_SHARED,
1281 			KBUILD_MODNAME, sonic)) {
1282 		dev_err(card->dev, "unable to grab IRQ %d\n", pci->irq);
1283 		snd_sonicvibes_free(sonic);
1284 		return -EBUSY;
1285 	}
1286 	sonic->irq = pci->irq;
1287 
1288 	pci_read_config_dword(pci, 0x40, &dmaa);
1289 	pci_read_config_dword(pci, 0x48, &dmac);
1290 	dmaio &= ~0x0f;
1291 	dmaa &= ~0x0f;
1292 	dmac &= ~0x0f;
1293 	if (!dmaa) {
1294 		dmaa = dmaio;
1295 		dmaio += 0x10;
1296 		dev_info(card->dev,
1297 			 "BIOS did not allocate DDMA channel A i/o, allocated at 0x%x\n",
1298 			 dmaa);
1299 	}
1300 	if (!dmac) {
1301 		dmac = dmaio;
1302 		dmaio += 0x10;
1303 		dev_info(card->dev,
1304 			 "BIOS did not allocate DDMA channel C i/o, allocated at 0x%x\n",
1305 			 dmac);
1306 	}
1307 	pci_write_config_dword(pci, 0x40, dmaa);
1308 	pci_write_config_dword(pci, 0x48, dmac);
1309 
1310 	if ((sonic->res_dmaa = request_region(dmaa, 0x10, "S3 SonicVibes DDMA-A")) == NULL) {
1311 		snd_sonicvibes_free(sonic);
1312 		dev_err(card->dev,
1313 			"unable to grab DDMA-A port at 0x%x-0x%x\n",
1314 			dmaa, dmaa + 0x10 - 1);
1315 		return -EBUSY;
1316 	}
1317 	if ((sonic->res_dmac = request_region(dmac, 0x10, "S3 SonicVibes DDMA-C")) == NULL) {
1318 		snd_sonicvibes_free(sonic);
1319 		dev_err(card->dev,
1320 			"unable to grab DDMA-C port at 0x%x-0x%x\n",
1321 			dmac, dmac + 0x10 - 1);
1322 		return -EBUSY;
1323 	}
1324 
1325 	pci_read_config_dword(pci, 0x40, &sonic->dmaa_port);
1326 	pci_read_config_dword(pci, 0x48, &sonic->dmac_port);
1327 	sonic->dmaa_port &= ~0x0f;
1328 	sonic->dmac_port &= ~0x0f;
1329 	pci_write_config_dword(pci, 0x40, sonic->dmaa_port | 9);	/* enable + enhanced */
1330 	pci_write_config_dword(pci, 0x48, sonic->dmac_port | 9);	/* enable */
1331 	/* ok.. initialize S3 SonicVibes chip */
1332 	outb(SV_RESET, SV_REG(sonic, CONTROL));		/* reset chip */
1333 	udelay(100);
1334 	outb(0, SV_REG(sonic, CONTROL));	/* release reset */
1335 	udelay(100);
1336 	outb(SV_ENHANCED | SV_INTA | (reverb ? SV_REVERB : 0), SV_REG(sonic, CONTROL));
1337 	inb(SV_REG(sonic, STATUS));	/* clear IRQs */
1338 #if 1
1339 	snd_sonicvibes_out(sonic, SV_IREG_DRIVE_CTRL, 0);	/* drive current 16mA */
1340 #else
1341 	snd_sonicvibes_out(sonic, SV_IREG_DRIVE_CTRL, 0x40);	/* drive current 8mA */
1342 #endif
1343 	snd_sonicvibes_out(sonic, SV_IREG_PC_ENABLE, sonic->enable = 0);	/* disable playback & capture */
1344 	outb(sonic->irqmask = ~(SV_DMAA_MASK | SV_DMAC_MASK | SV_UD_MASK), SV_REG(sonic, IRQMASK));
1345 	inb(SV_REG(sonic, STATUS));	/* clear IRQs */
1346 	snd_sonicvibes_out(sonic, SV_IREG_ADC_CLOCK, 0);	/* use PLL as clock source */
1347 	snd_sonicvibes_out(sonic, SV_IREG_ANALOG_POWER, 0);	/* power up analog parts */
1348 	snd_sonicvibes_out(sonic, SV_IREG_DIGITAL_POWER, 0);	/* power up digital parts */
1349 	snd_sonicvibes_setpll(sonic, SV_IREG_ADC_PLL, 8000);
1350 	snd_sonicvibes_out(sonic, SV_IREG_SRS_SPACE, sonic->srs_space = 0x80);	/* SRS space off */
1351 	snd_sonicvibes_out(sonic, SV_IREG_SRS_CENTER, sonic->srs_center = 0x00);/* SRS center off */
1352 	snd_sonicvibes_out(sonic, SV_IREG_MPU401, sonic->mpu_switch = 0x05);	/* MPU-401 switch */
1353 	snd_sonicvibes_out(sonic, SV_IREG_WAVE_SOURCE, sonic->wave_source = 0x00);	/* onboard ROM */
1354 	snd_sonicvibes_out(sonic, SV_IREG_PCM_RATE_LOW, (8000 * 65536 / SV_FULLRATE) & 0xff);
1355 	snd_sonicvibes_out(sonic, SV_IREG_PCM_RATE_HIGH, ((8000 * 65536 / SV_FULLRATE) >> 8) & 0xff);
1356 	snd_sonicvibes_out(sonic, SV_IREG_LEFT_ADC, mge ? 0xd0 : 0xc0);
1357 	snd_sonicvibes_out(sonic, SV_IREG_RIGHT_ADC, 0xc0);
1358 	snd_sonicvibes_out(sonic, SV_IREG_LEFT_AUX1, 0x9f);
1359 	snd_sonicvibes_out(sonic, SV_IREG_RIGHT_AUX1, 0x9f);
1360 	snd_sonicvibes_out(sonic, SV_IREG_LEFT_CD, 0x9f);
1361 	snd_sonicvibes_out(sonic, SV_IREG_RIGHT_CD, 0x9f);
1362 	snd_sonicvibes_out(sonic, SV_IREG_LEFT_LINE, 0x9f);
1363 	snd_sonicvibes_out(sonic, SV_IREG_RIGHT_LINE, 0x9f);
1364 	snd_sonicvibes_out(sonic, SV_IREG_MIC, 0x8f);
1365 	snd_sonicvibes_out(sonic, SV_IREG_LEFT_SYNTH, 0x9f);
1366 	snd_sonicvibes_out(sonic, SV_IREG_RIGHT_SYNTH, 0x9f);
1367 	snd_sonicvibes_out(sonic, SV_IREG_LEFT_AUX2, 0x9f);
1368 	snd_sonicvibes_out(sonic, SV_IREG_RIGHT_AUX2, 0x9f);
1369 	snd_sonicvibes_out(sonic, SV_IREG_LEFT_ANALOG, 0x9f);
1370 	snd_sonicvibes_out(sonic, SV_IREG_RIGHT_ANALOG, 0x9f);
1371 	snd_sonicvibes_out(sonic, SV_IREG_LEFT_PCM, 0xbf);
1372 	snd_sonicvibes_out(sonic, SV_IREG_RIGHT_PCM, 0xbf);
1373 	snd_sonicvibes_out(sonic, SV_IREG_ADC_OUTPUT_CTRL, 0xfc);
1374 #if 0
1375 	snd_sonicvibes_debug(sonic);
1376 #endif
1377 	sonic->revision = snd_sonicvibes_in(sonic, SV_IREG_REVISION);
1378 
1379 	if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, sonic, &ops)) < 0) {
1380 		snd_sonicvibes_free(sonic);
1381 		return err;
1382 	}
1383 
1384 	snd_sonicvibes_proc_init(sonic);
1385 
1386 	*rsonic = sonic;
1387 	return 0;
1388 }
1389 
1390 /*
1391  *  MIDI section
1392  */
1393 
1394 static struct snd_kcontrol_new snd_sonicvibes_midi_controls[] = {
1395 SONICVIBES_SINGLE("SonicVibes Wave Source RAM", 0, SV_IREG_WAVE_SOURCE, 0, 1, 0),
1396 SONICVIBES_SINGLE("SonicVibes Wave Source RAM+ROM", 0, SV_IREG_WAVE_SOURCE, 1, 1, 0),
1397 SONICVIBES_SINGLE("SonicVibes Onboard Synth", 0, SV_IREG_MPU401, 0, 1, 0),
1398 SONICVIBES_SINGLE("SonicVibes External Rx to Synth", 0, SV_IREG_MPU401, 1, 1, 0),
1399 SONICVIBES_SINGLE("SonicVibes External Tx", 0, SV_IREG_MPU401, 2, 1, 0)
1400 };
1401 
1402 static int snd_sonicvibes_midi_input_open(struct snd_mpu401 * mpu)
1403 {
1404 	struct sonicvibes *sonic = mpu->private_data;
1405 	outb(sonic->irqmask &= ~SV_MIDI_MASK, SV_REG(sonic, IRQMASK));
1406 	return 0;
1407 }
1408 
1409 static void snd_sonicvibes_midi_input_close(struct snd_mpu401 * mpu)
1410 {
1411 	struct sonicvibes *sonic = mpu->private_data;
1412 	outb(sonic->irqmask |= SV_MIDI_MASK, SV_REG(sonic, IRQMASK));
1413 }
1414 
1415 static int snd_sonicvibes_midi(struct sonicvibes *sonic,
1416 			       struct snd_rawmidi *rmidi)
1417 {
1418 	struct snd_mpu401 * mpu = rmidi->private_data;
1419 	struct snd_card *card = sonic->card;
1420 	unsigned int idx;
1421 	int err;
1422 
1423 	mpu->private_data = sonic;
1424 	mpu->open_input = snd_sonicvibes_midi_input_open;
1425 	mpu->close_input = snd_sonicvibes_midi_input_close;
1426 	for (idx = 0; idx < ARRAY_SIZE(snd_sonicvibes_midi_controls); idx++)
1427 		if ((err = snd_ctl_add(card, snd_ctl_new1(&snd_sonicvibes_midi_controls[idx], sonic))) < 0)
1428 			return err;
1429 	return 0;
1430 }
1431 
1432 static int snd_sonic_probe(struct pci_dev *pci,
1433 			   const struct pci_device_id *pci_id)
1434 {
1435 	static int dev;
1436 	struct snd_card *card;
1437 	struct sonicvibes *sonic;
1438 	struct snd_rawmidi *midi_uart;
1439 	struct snd_opl3 *opl3;
1440 	int idx, err;
1441 
1442 	if (dev >= SNDRV_CARDS)
1443 		return -ENODEV;
1444 	if (!enable[dev]) {
1445 		dev++;
1446 		return -ENOENT;
1447 	}
1448 
1449 	err = snd_card_new(&pci->dev, index[dev], id[dev], THIS_MODULE,
1450 			   0, &card);
1451 	if (err < 0)
1452 		return err;
1453 	for (idx = 0; idx < 5; idx++) {
1454 		if (pci_resource_start(pci, idx) == 0 ||
1455 		    !(pci_resource_flags(pci, idx) & IORESOURCE_IO)) {
1456 			snd_card_free(card);
1457 			return -ENODEV;
1458 		}
1459 	}
1460 	if ((err = snd_sonicvibes_create(card, pci,
1461 					 reverb[dev] ? 1 : 0,
1462 					 mge[dev] ? 1 : 0,
1463 					 &sonic)) < 0) {
1464 		snd_card_free(card);
1465 		return err;
1466 	}
1467 
1468 	strcpy(card->driver, "SonicVibes");
1469 	strcpy(card->shortname, "S3 SonicVibes");
1470 	sprintf(card->longname, "%s rev %i at 0x%llx, irq %i",
1471 		card->shortname,
1472 		sonic->revision,
1473 		(unsigned long long)pci_resource_start(pci, 1),
1474 		sonic->irq);
1475 
1476 	if ((err = snd_sonicvibes_pcm(sonic, 0)) < 0) {
1477 		snd_card_free(card);
1478 		return err;
1479 	}
1480 	if ((err = snd_sonicvibes_mixer(sonic)) < 0) {
1481 		snd_card_free(card);
1482 		return err;
1483 	}
1484 	if ((err = snd_mpu401_uart_new(card, 0, MPU401_HW_SONICVIBES,
1485 				       sonic->midi_port,
1486 				       MPU401_INFO_INTEGRATED |
1487 				       MPU401_INFO_IRQ_HOOK,
1488 				       -1, &midi_uart)) < 0) {
1489 		snd_card_free(card);
1490 		return err;
1491 	}
1492 	snd_sonicvibes_midi(sonic, midi_uart);
1493 	if ((err = snd_opl3_create(card, sonic->synth_port,
1494 				   sonic->synth_port + 2,
1495 				   OPL3_HW_OPL3_SV, 1, &opl3)) < 0) {
1496 		snd_card_free(card);
1497 		return err;
1498 	}
1499 	if ((err = snd_opl3_hwdep_new(opl3, 0, 1, NULL)) < 0) {
1500 		snd_card_free(card);
1501 		return err;
1502 	}
1503 
1504 	err = snd_sonicvibes_create_gameport(sonic);
1505 	if (err < 0) {
1506 		snd_card_free(card);
1507 		return err;
1508 	}
1509 
1510 	if ((err = snd_card_register(card)) < 0) {
1511 		snd_card_free(card);
1512 		return err;
1513 	}
1514 
1515 	pci_set_drvdata(pci, card);
1516 	dev++;
1517 	return 0;
1518 }
1519 
1520 static void snd_sonic_remove(struct pci_dev *pci)
1521 {
1522 	snd_card_free(pci_get_drvdata(pci));
1523 }
1524 
1525 static struct pci_driver sonicvibes_driver = {
1526 	.name = KBUILD_MODNAME,
1527 	.id_table = snd_sonic_ids,
1528 	.probe = snd_sonic_probe,
1529 	.remove = snd_sonic_remove,
1530 };
1531 
1532 module_pci_driver(sonicvibes_driver);
1533