xref: /linux/sound/isa/gus/gus_reset.c (revision 05a54fa773284d1a7923cdfdd8f0c8dabb98bd26)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  *  Copyright (c) by Jaroslav Kysela <perex@perex.cz>
4  */
5 
6 #include <linux/delay.h>
7 #include <linux/interrupt.h>
8 #include <linux/time.h>
9 #include <sound/core.h>
10 #include <sound/gus.h>
11 
12 extern int snd_gf1_synth_init(struct snd_gus_card * gus);
13 extern void snd_gf1_synth_done(struct snd_gus_card * gus);
14 
15 /*
16  *  ok.. default interrupt handlers...
17  */
18 
19 static void snd_gf1_default_interrupt_handler_midi_out(struct snd_gus_card * gus)
20 {
21 	snd_gf1_uart_cmd(gus, gus->gf1.uart_cmd &= ~0x20);
22 }
23 
24 static void snd_gf1_default_interrupt_handler_midi_in(struct snd_gus_card * gus)
25 {
26 	snd_gf1_uart_cmd(gus, gus->gf1.uart_cmd &= ~0x80);
27 }
28 
29 static void snd_gf1_default_interrupt_handler_timer1(struct snd_gus_card * gus)
30 {
31 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_SOUND_BLASTER_CONTROL, gus->gf1.timer_enabled &= ~4);
32 }
33 
34 static void snd_gf1_default_interrupt_handler_timer2(struct snd_gus_card * gus)
35 {
36 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_SOUND_BLASTER_CONTROL, gus->gf1.timer_enabled &= ~8);
37 }
38 
39 static void snd_gf1_default_interrupt_handler_wave_and_volume(struct snd_gus_card * gus, struct snd_gus_voice * voice)
40 {
41 	snd_gf1_i_ctrl_stop(gus, 0x00);
42 	snd_gf1_i_ctrl_stop(gus, 0x0d);
43 }
44 
45 static void snd_gf1_default_interrupt_handler_dma_write(struct snd_gus_card * gus)
46 {
47 	snd_gf1_i_write8(gus, 0x41, 0x00);
48 }
49 
50 static void snd_gf1_default_interrupt_handler_dma_read(struct snd_gus_card * gus)
51 {
52 	snd_gf1_i_write8(gus, 0x49, 0x00);
53 }
54 
55 void snd_gf1_set_default_handlers(struct snd_gus_card * gus, unsigned int what)
56 {
57 	if (what & SNDRV_GF1_HANDLER_MIDI_OUT)
58 		gus->gf1.interrupt_handler_midi_out = snd_gf1_default_interrupt_handler_midi_out;
59 	if (what & SNDRV_GF1_HANDLER_MIDI_IN)
60 		gus->gf1.interrupt_handler_midi_in = snd_gf1_default_interrupt_handler_midi_in;
61 	if (what & SNDRV_GF1_HANDLER_TIMER1)
62 		gus->gf1.interrupt_handler_timer1 = snd_gf1_default_interrupt_handler_timer1;
63 	if (what & SNDRV_GF1_HANDLER_TIMER2)
64 		gus->gf1.interrupt_handler_timer2 = snd_gf1_default_interrupt_handler_timer2;
65 	if (what & SNDRV_GF1_HANDLER_VOICE) {
66 		struct snd_gus_voice *voice;
67 
68 		voice = &gus->gf1.voices[what & 0xffff];
69 		voice->handler_wave =
70 		voice->handler_volume = snd_gf1_default_interrupt_handler_wave_and_volume;
71 		voice->handler_effect = NULL;
72 		voice->volume_change = NULL;
73 	}
74 	if (what & SNDRV_GF1_HANDLER_DMA_WRITE)
75 		gus->gf1.interrupt_handler_dma_write = snd_gf1_default_interrupt_handler_dma_write;
76 	if (what & SNDRV_GF1_HANDLER_DMA_READ)
77 		gus->gf1.interrupt_handler_dma_read = snd_gf1_default_interrupt_handler_dma_read;
78 }
79 
80 /*
81 
82  */
83 
84 static void snd_gf1_clear_regs(struct snd_gus_card * gus)
85 {
86 	guard(spinlock_irqsave)(&gus->reg_lock);
87 	inb(GUSP(gus, IRQSTAT));
88 	snd_gf1_write8(gus, 0x41, 0);	/* DRAM DMA Control Register */
89 	snd_gf1_write8(gus, 0x45, 0);	/* Timer Control */
90 	snd_gf1_write8(gus, 0x49, 0);	/* Sampling Control Register */
91 }
92 
93 static void snd_gf1_look_regs(struct snd_gus_card * gus)
94 {
95 	guard(spinlock_irqsave)(&gus->reg_lock);
96 	snd_gf1_look8(gus, 0x41);	/* DRAM DMA Control Register */
97 	snd_gf1_look8(gus, 0x49);	/* Sampling Control Register */
98 	inb(GUSP(gus, IRQSTAT));
99 	snd_gf1_read8(gus, 0x0f);	/* IRQ Source Register */
100 }
101 
102 /*
103  *  put selected GF1 voices to initial stage...
104  */
105 
106 void snd_gf1_smart_stop_voice(struct snd_gus_card * gus, unsigned short voice)
107 {
108 	guard(spinlock_irqsave)(&gus->reg_lock);
109 	snd_gf1_select_voice(gus, voice);
110 #if 0
111 	dev_dbg(gus->card->dev,
112 		" -%i- smart stop voice - volume = 0x%x\n",
113 		voice, snd_gf1_i_read16(gus, SNDRV_GF1_VW_VOLUME));
114 #endif
115 	snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_ADDRESS_CONTROL);
116 	snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_VOLUME_CONTROL);
117 }
118 
119 void snd_gf1_stop_voice(struct snd_gus_card * gus, unsigned short voice)
120 {
121 	guard(spinlock_irqsave)(&gus->reg_lock);
122 	snd_gf1_select_voice(gus, voice);
123 #if 0
124 	dev_dbg(gus->card->dev,
125 		" -%i- stop voice - volume = 0x%x\n",
126 		voice, snd_gf1_i_read16(gus, SNDRV_GF1_VW_VOLUME));
127 #endif
128 	snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_ADDRESS_CONTROL);
129 	snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_VOLUME_CONTROL);
130 	if (gus->gf1.enh_mode)
131 		snd_gf1_write8(gus, SNDRV_GF1_VB_ACCUMULATOR, 0);
132 }
133 
134 static void snd_gf1_clear_voices(struct snd_gus_card * gus, unsigned short v_min,
135 				 unsigned short v_max)
136 {
137 	unsigned int daddr;
138 	unsigned short i, w_16;
139 
140 	daddr = gus->gf1.default_voice_address << 4;
141 	for (i = v_min; i <= v_max; i++) {
142 #if 0
143 		if (gus->gf1.syn_voices)
144 			gus->gf1.syn_voices[i].flags = ~VFLG_DYNAMIC;
145 #endif
146 		guard(spinlock_irqsave)(&gus->reg_lock);
147 		snd_gf1_select_voice(gus, i);
148 		snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_ADDRESS_CONTROL);	/* Voice Control Register = voice stop */
149 		snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_VOLUME_CONTROL);	/* Volume Ramp Control Register = ramp off */
150 		if (gus->gf1.enh_mode)
151 			snd_gf1_write8(gus, SNDRV_GF1_VB_MODE, gus->gf1.memory ? 0x02 : 0x82);	/* Deactivate voice */
152 		w_16 = snd_gf1_read8(gus, SNDRV_GF1_VB_ADDRESS_CONTROL) & 0x04;
153 		snd_gf1_write16(gus, SNDRV_GF1_VW_FREQUENCY, 0x400);
154 		snd_gf1_write_addr(gus, SNDRV_GF1_VA_START, daddr, w_16);
155 		snd_gf1_write_addr(gus, SNDRV_GF1_VA_END, daddr, w_16);
156 		snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_START, 0);
157 		snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_END, 0);
158 		snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_RATE, 0);
159 		snd_gf1_write16(gus, SNDRV_GF1_VW_VOLUME, 0);
160 		snd_gf1_write_addr(gus, SNDRV_GF1_VA_CURRENT, daddr, w_16);
161 		snd_gf1_write8(gus, SNDRV_GF1_VB_PAN, 7);
162 		if (gus->gf1.enh_mode) {
163 			snd_gf1_write8(gus, SNDRV_GF1_VB_ACCUMULATOR, 0);
164 			snd_gf1_write16(gus, SNDRV_GF1_VW_EFFECT_VOLUME, 0);
165 			snd_gf1_write16(gus, SNDRV_GF1_VW_EFFECT_VOLUME_FINAL, 0);
166 		}
167 	}
168 }
169 
170 void snd_gf1_stop_voices(struct snd_gus_card * gus, unsigned short v_min, unsigned short v_max)
171 {
172 	short i, ramp_ok;
173 	unsigned short ramp_end;
174 
175 	if (!in_interrupt()) {	/* this can't be done in interrupt */
176 		for (i = v_min, ramp_ok = 0; i <= v_max; i++) {
177 			guard(spinlock_irqsave)(&gus->reg_lock);
178 			snd_gf1_select_voice(gus, i);
179 			ramp_end = snd_gf1_read16(gus, 9) >> 8;
180 			if (ramp_end > SNDRV_GF1_MIN_OFFSET) {
181 				ramp_ok++;
182 				snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_RATE, 20);	/* ramp rate */
183 				snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_START, SNDRV_GF1_MIN_OFFSET);	/* ramp start */
184 				snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_END, ramp_end);	/* ramp end */
185 				snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_CONTROL, 0x40);	/* ramp down */
186 				if (gus->gf1.enh_mode) {
187 					snd_gf1_delay(gus);
188 					snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_CONTROL, 0x40);
189 				}
190 			}
191 		}
192 		msleep_interruptible(50);
193 	}
194 	snd_gf1_clear_voices(gus, v_min, v_max);
195 }
196 
197 static void snd_gf1_alloc_voice_use(struct snd_gus_card * gus,
198 				    struct snd_gus_voice * pvoice,
199 				    int type, int client, int port)
200 {
201 	pvoice->use = 1;
202 	switch (type) {
203 	case SNDRV_GF1_VOICE_TYPE_PCM:
204 		gus->gf1.pcm_alloc_voices++;
205 		pvoice->pcm = 1;
206 		break;
207 	case SNDRV_GF1_VOICE_TYPE_SYNTH:
208 		pvoice->synth = 1;
209 		pvoice->client = client;
210 		pvoice->port = port;
211 		break;
212 	case SNDRV_GF1_VOICE_TYPE_MIDI:
213 		pvoice->midi = 1;
214 		pvoice->client = client;
215 		pvoice->port = port;
216 		break;
217 	}
218 }
219 
220 struct snd_gus_voice *snd_gf1_alloc_voice(struct snd_gus_card * gus, int type, int client, int port)
221 {
222 	struct snd_gus_voice *pvoice;
223 	int idx;
224 
225 	guard(spinlock_irqsave)(&gus->voice_alloc);
226 	if (type == SNDRV_GF1_VOICE_TYPE_PCM) {
227 		if (gus->gf1.pcm_alloc_voices >= gus->gf1.pcm_channels)
228 			return NULL;
229 	}
230 	for (idx = 0; idx < 32; idx++) {
231 		pvoice = &gus->gf1.voices[idx];
232 		if (!pvoice->use) {
233 			snd_gf1_alloc_voice_use(gus, pvoice, type, client, port);
234 			return pvoice;
235 		}
236 	}
237 	for (idx = 0; idx < 32; idx++) {
238 		pvoice = &gus->gf1.voices[idx];
239 		if (pvoice->midi && !pvoice->client) {
240 			snd_gf1_clear_voices(gus, pvoice->number, pvoice->number);
241 			snd_gf1_alloc_voice_use(gus, pvoice, type, client, port);
242 			return pvoice;
243 		}
244 	}
245 	return NULL;
246 }
247 
248 void snd_gf1_free_voice(struct snd_gus_card * gus, struct snd_gus_voice *voice)
249 {
250 	void (*private_free)(struct snd_gus_voice *voice);
251 
252 	if (voice == NULL || !voice->use)
253 		return;
254 	snd_gf1_set_default_handlers(gus, SNDRV_GF1_HANDLER_VOICE | voice->number);
255 	snd_gf1_clear_voices(gus, voice->number, voice->number);
256 	scoped_guard(spinlock_irqsave, &gus->voice_alloc) {
257 		private_free = voice->private_free;
258 		voice->private_free = NULL;
259 		voice->private_data = NULL;
260 		if (voice->pcm)
261 			gus->gf1.pcm_alloc_voices--;
262 		voice->use = voice->pcm = 0;
263 		voice->sample_ops = NULL;
264 	}
265 	if (private_free)
266 		private_free(voice);
267 }
268 
269 /*
270  *  call this function only by start of driver
271  */
272 
273 int snd_gf1_start(struct snd_gus_card * gus)
274 {
275 	unsigned int i;
276 
277 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 0);	/* reset GF1 */
278 	udelay(160);
279 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1);	/* disable IRQ & DAC */
280 	udelay(160);
281 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_JOYSTICK_DAC_LEVEL, gus->joystick_dac);
282 
283 	snd_gf1_set_default_handlers(gus, SNDRV_GF1_HANDLER_ALL);
284 	for (i = 0; i < 32; i++) {
285 		gus->gf1.voices[i].number = i;
286 		snd_gf1_set_default_handlers(gus, SNDRV_GF1_HANDLER_VOICE | i);
287 	}
288 
289 	snd_gf1_uart_cmd(gus, 0x03);	/* huh.. this cleanup took me some time... */
290 
291 	if (gus->gf1.enh_mode) {	/* enhanced mode !!!! */
292 		snd_gf1_i_write8(gus, SNDRV_GF1_GB_GLOBAL_MODE, snd_gf1_i_look8(gus, SNDRV_GF1_GB_GLOBAL_MODE) | 0x01);
293 		snd_gf1_i_write8(gus, SNDRV_GF1_GB_MEMORY_CONTROL, 0x01);
294 	}
295 	snd_gf1_clear_regs(gus);
296 	snd_gf1_select_active_voices(gus);
297 	snd_gf1_delay(gus);
298 	gus->gf1.default_voice_address = gus->gf1.memory > 0 ? 0 : 512 - 8;
299 	/* initialize LFOs & clear LFOs memory */
300 	if (gus->gf1.enh_mode && gus->gf1.memory) {
301 		gus->gf1.hw_lfo = 1;
302 		gus->gf1.default_voice_address += 1024;
303 	} else {
304 		gus->gf1.sw_lfo = 1;
305 	}
306 
307 	if (gus->gf1.memory > 0)
308 		for (i = 0; i < 4; i++)
309 			snd_gf1_poke(gus, gus->gf1.default_voice_address + i, 0);
310 	snd_gf1_clear_regs(gus);
311 	snd_gf1_clear_voices(gus, 0, 31);
312 	snd_gf1_look_regs(gus);
313 	udelay(160);
314 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 7);	/* Reset Register = IRQ enable, DAC enable */
315 	udelay(160);
316 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 7);	/* Reset Register = IRQ enable, DAC enable */
317 	if (gus->gf1.enh_mode) {	/* enhanced mode !!!! */
318 		snd_gf1_i_write8(gus, SNDRV_GF1_GB_GLOBAL_MODE, snd_gf1_i_look8(gus, SNDRV_GF1_GB_GLOBAL_MODE) | 0x01);
319 		snd_gf1_i_write8(gus, SNDRV_GF1_GB_MEMORY_CONTROL, 0x01);
320 	}
321 	while ((snd_gf1_i_read8(gus, SNDRV_GF1_GB_VOICES_IRQ) & 0xc0) != 0xc0);
322 
323 	scoped_guard(spinlock_irqsave, &gus->reg_lock) {
324 		outb(gus->gf1.active_voice = 0, GUSP(gus, GF1PAGE));
325 		outb(gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
326 	}
327 
328 	snd_gf1_timers_init(gus);
329 	snd_gf1_look_regs(gus);
330 	snd_gf1_mem_init(gus);
331 	snd_gf1_mem_proc_init(gus);
332 #ifdef CONFIG_SND_DEBUG
333 	snd_gus_irq_profile_init(gus);
334 #endif
335 
336 #if 0
337 	if (gus->pnp_flag) {
338 		if (gus->chip.playback_fifo_size > 0)
339 			snd_gf1_i_write16(gus, SNDRV_GF1_GW_FIFO_RECORD_BASE_ADDR, gus->chip.playback_fifo_block->ptr >> 8);
340 		if (gus->chip.record_fifo_size > 0)
341 			snd_gf1_i_write16(gus, SNDRV_GF1_GW_FIFO_PLAY_BASE_ADDR, gus->chip.record_fifo_block->ptr >> 8);
342 		snd_gf1_i_write16(gus, SNDRV_GF1_GW_FIFO_SIZE, gus->chip.interwave_fifo_reg);
343 	}
344 #endif
345 
346 	return 0;
347 }
348 
349 /*
350  *  call this function only by shutdown of driver
351  */
352 
353 int snd_gf1_stop(struct snd_gus_card * gus)
354 {
355 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_SOUND_BLASTER_CONTROL, 0); /* stop all timers */
356 	snd_gf1_stop_voices(gus, 0, 31);		/* stop all voices */
357 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1);	/* disable IRQ & DAC */
358 	snd_gf1_timers_done(gus);
359 	snd_gf1_mem_done(gus);
360 
361 	return 0;
362 }
363