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 	unsigned long flags;
87 
88 	spin_lock_irqsave(&gus->reg_lock, flags);
89 	inb(GUSP(gus, IRQSTAT));
90 	snd_gf1_write8(gus, 0x41, 0);	/* DRAM DMA Control Register */
91 	snd_gf1_write8(gus, 0x45, 0);	/* Timer Control */
92 	snd_gf1_write8(gus, 0x49, 0);	/* Sampling Control Register */
93 	spin_unlock_irqrestore(&gus->reg_lock, flags);
94 }
95 
96 static void snd_gf1_look_regs(struct snd_gus_card * gus)
97 {
98 	unsigned long flags;
99 
100 	spin_lock_irqsave(&gus->reg_lock, flags);
101 	snd_gf1_look8(gus, 0x41);	/* DRAM DMA Control Register */
102 	snd_gf1_look8(gus, 0x49);	/* Sampling Control Register */
103 	inb(GUSP(gus, IRQSTAT));
104 	snd_gf1_read8(gus, 0x0f);	/* IRQ Source Register */
105 	spin_unlock_irqrestore(&gus->reg_lock, flags);
106 }
107 
108 /*
109  *  put selected GF1 voices to initial stage...
110  */
111 
112 void snd_gf1_smart_stop_voice(struct snd_gus_card * gus, unsigned short voice)
113 {
114 	unsigned long flags;
115 
116 	spin_lock_irqsave(&gus->reg_lock, flags);
117 	snd_gf1_select_voice(gus, voice);
118 #if 0
119 	dev_dbg(gus->card->dev,
120 		" -%i- smart stop voice - volume = 0x%x\n",
121 		voice, snd_gf1_i_read16(gus, SNDRV_GF1_VW_VOLUME));
122 #endif
123 	snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_ADDRESS_CONTROL);
124 	snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_VOLUME_CONTROL);
125 	spin_unlock_irqrestore(&gus->reg_lock, flags);
126 }
127 
128 void snd_gf1_stop_voice(struct snd_gus_card * gus, unsigned short voice)
129 {
130 	unsigned long flags;
131 
132 	spin_lock_irqsave(&gus->reg_lock, flags);
133 	snd_gf1_select_voice(gus, voice);
134 #if 0
135 	dev_dbg(gus->card->dev,
136 		" -%i- stop voice - volume = 0x%x\n",
137 		voice, snd_gf1_i_read16(gus, SNDRV_GF1_VW_VOLUME));
138 #endif
139 	snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_ADDRESS_CONTROL);
140 	snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_VOLUME_CONTROL);
141 	if (gus->gf1.enh_mode)
142 		snd_gf1_write8(gus, SNDRV_GF1_VB_ACCUMULATOR, 0);
143 	spin_unlock_irqrestore(&gus->reg_lock, flags);
144 }
145 
146 static void snd_gf1_clear_voices(struct snd_gus_card * gus, unsigned short v_min,
147 				 unsigned short v_max)
148 {
149 	unsigned long flags;
150 	unsigned int daddr;
151 	unsigned short i, w_16;
152 
153 	daddr = gus->gf1.default_voice_address << 4;
154 	for (i = v_min; i <= v_max; i++) {
155 #if 0
156 		if (gus->gf1.syn_voices)
157 			gus->gf1.syn_voices[i].flags = ~VFLG_DYNAMIC;
158 #endif
159 		spin_lock_irqsave(&gus->reg_lock, flags);
160 		snd_gf1_select_voice(gus, i);
161 		snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_ADDRESS_CONTROL);	/* Voice Control Register = voice stop */
162 		snd_gf1_ctrl_stop(gus, SNDRV_GF1_VB_VOLUME_CONTROL);	/* Volume Ramp Control Register = ramp off */
163 		if (gus->gf1.enh_mode)
164 			snd_gf1_write8(gus, SNDRV_GF1_VB_MODE, gus->gf1.memory ? 0x02 : 0x82);	/* Deactivate voice */
165 		w_16 = snd_gf1_read8(gus, SNDRV_GF1_VB_ADDRESS_CONTROL) & 0x04;
166 		snd_gf1_write16(gus, SNDRV_GF1_VW_FREQUENCY, 0x400);
167 		snd_gf1_write_addr(gus, SNDRV_GF1_VA_START, daddr, w_16);
168 		snd_gf1_write_addr(gus, SNDRV_GF1_VA_END, daddr, w_16);
169 		snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_START, 0);
170 		snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_END, 0);
171 		snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_RATE, 0);
172 		snd_gf1_write16(gus, SNDRV_GF1_VW_VOLUME, 0);
173 		snd_gf1_write_addr(gus, SNDRV_GF1_VA_CURRENT, daddr, w_16);
174 		snd_gf1_write8(gus, SNDRV_GF1_VB_PAN, 7);
175 		if (gus->gf1.enh_mode) {
176 			snd_gf1_write8(gus, SNDRV_GF1_VB_ACCUMULATOR, 0);
177 			snd_gf1_write16(gus, SNDRV_GF1_VW_EFFECT_VOLUME, 0);
178 			snd_gf1_write16(gus, SNDRV_GF1_VW_EFFECT_VOLUME_FINAL, 0);
179 		}
180 		spin_unlock_irqrestore(&gus->reg_lock, flags);
181 	}
182 }
183 
184 void snd_gf1_stop_voices(struct snd_gus_card * gus, unsigned short v_min, unsigned short v_max)
185 {
186 	unsigned long flags;
187 	short i, ramp_ok;
188 	unsigned short ramp_end;
189 
190 	if (!in_interrupt()) {	/* this can't be done in interrupt */
191 		for (i = v_min, ramp_ok = 0; i <= v_max; i++) {
192 			spin_lock_irqsave(&gus->reg_lock, flags);
193 			snd_gf1_select_voice(gus, i);
194 			ramp_end = snd_gf1_read16(gus, 9) >> 8;
195 			if (ramp_end > SNDRV_GF1_MIN_OFFSET) {
196 				ramp_ok++;
197 				snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_RATE, 20);	/* ramp rate */
198 				snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_START, SNDRV_GF1_MIN_OFFSET);	/* ramp start */
199 				snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_END, ramp_end);	/* ramp end */
200 				snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_CONTROL, 0x40);	/* ramp down */
201 				if (gus->gf1.enh_mode) {
202 					snd_gf1_delay(gus);
203 					snd_gf1_write8(gus, SNDRV_GF1_VB_VOLUME_CONTROL, 0x40);
204 				}
205 			}
206 			spin_unlock_irqrestore(&gus->reg_lock, flags);
207 		}
208 		msleep_interruptible(50);
209 	}
210 	snd_gf1_clear_voices(gus, v_min, v_max);
211 }
212 
213 static void snd_gf1_alloc_voice_use(struct snd_gus_card * gus,
214 				    struct snd_gus_voice * pvoice,
215 				    int type, int client, int port)
216 {
217 	pvoice->use = 1;
218 	switch (type) {
219 	case SNDRV_GF1_VOICE_TYPE_PCM:
220 		gus->gf1.pcm_alloc_voices++;
221 		pvoice->pcm = 1;
222 		break;
223 	case SNDRV_GF1_VOICE_TYPE_SYNTH:
224 		pvoice->synth = 1;
225 		pvoice->client = client;
226 		pvoice->port = port;
227 		break;
228 	case SNDRV_GF1_VOICE_TYPE_MIDI:
229 		pvoice->midi = 1;
230 		pvoice->client = client;
231 		pvoice->port = port;
232 		break;
233 	}
234 }
235 
236 struct snd_gus_voice *snd_gf1_alloc_voice(struct snd_gus_card * gus, int type, int client, int port)
237 {
238 	struct snd_gus_voice *pvoice;
239 	unsigned long flags;
240 	int idx;
241 
242 	spin_lock_irqsave(&gus->voice_alloc, flags);
243 	if (type == SNDRV_GF1_VOICE_TYPE_PCM) {
244 		if (gus->gf1.pcm_alloc_voices >= gus->gf1.pcm_channels) {
245 			spin_unlock_irqrestore(&gus->voice_alloc, flags);
246 			return NULL;
247 		}
248 	}
249 	for (idx = 0; idx < 32; idx++) {
250 		pvoice = &gus->gf1.voices[idx];
251 		if (!pvoice->use) {
252 			snd_gf1_alloc_voice_use(gus, pvoice, type, client, port);
253 			spin_unlock_irqrestore(&gus->voice_alloc, flags);
254 			return pvoice;
255 		}
256 	}
257 	for (idx = 0; idx < 32; idx++) {
258 		pvoice = &gus->gf1.voices[idx];
259 		if (pvoice->midi && !pvoice->client) {
260 			snd_gf1_clear_voices(gus, pvoice->number, pvoice->number);
261 			snd_gf1_alloc_voice_use(gus, pvoice, type, client, port);
262 			spin_unlock_irqrestore(&gus->voice_alloc, flags);
263 			return pvoice;
264 		}
265 	}
266 	spin_unlock_irqrestore(&gus->voice_alloc, flags);
267 	return NULL;
268 }
269 
270 void snd_gf1_free_voice(struct snd_gus_card * gus, struct snd_gus_voice *voice)
271 {
272 	unsigned long flags;
273 	void (*private_free)(struct snd_gus_voice *voice);
274 
275 	if (voice == NULL || !voice->use)
276 		return;
277 	snd_gf1_set_default_handlers(gus, SNDRV_GF1_HANDLER_VOICE | voice->number);
278 	snd_gf1_clear_voices(gus, voice->number, voice->number);
279 	spin_lock_irqsave(&gus->voice_alloc, flags);
280 	private_free = voice->private_free;
281 	voice->private_free = NULL;
282 	voice->private_data = NULL;
283 	if (voice->pcm)
284 		gus->gf1.pcm_alloc_voices--;
285 	voice->use = voice->pcm = 0;
286 	voice->sample_ops = NULL;
287 	spin_unlock_irqrestore(&gus->voice_alloc, flags);
288 	if (private_free)
289 		private_free(voice);
290 }
291 
292 /*
293  *  call this function only by start of driver
294  */
295 
296 int snd_gf1_start(struct snd_gus_card * gus)
297 {
298 	unsigned long flags;
299 	unsigned int i;
300 
301 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 0);	/* reset GF1 */
302 	udelay(160);
303 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1);	/* disable IRQ & DAC */
304 	udelay(160);
305 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_JOYSTICK_DAC_LEVEL, gus->joystick_dac);
306 
307 	snd_gf1_set_default_handlers(gus, SNDRV_GF1_HANDLER_ALL);
308 	for (i = 0; i < 32; i++) {
309 		gus->gf1.voices[i].number = i;
310 		snd_gf1_set_default_handlers(gus, SNDRV_GF1_HANDLER_VOICE | i);
311 	}
312 
313 	snd_gf1_uart_cmd(gus, 0x03);	/* huh.. this cleanup took me some time... */
314 
315 	if (gus->gf1.enh_mode) {	/* enhanced mode !!!! */
316 		snd_gf1_i_write8(gus, SNDRV_GF1_GB_GLOBAL_MODE, snd_gf1_i_look8(gus, SNDRV_GF1_GB_GLOBAL_MODE) | 0x01);
317 		snd_gf1_i_write8(gus, SNDRV_GF1_GB_MEMORY_CONTROL, 0x01);
318 	}
319 	snd_gf1_clear_regs(gus);
320 	snd_gf1_select_active_voices(gus);
321 	snd_gf1_delay(gus);
322 	gus->gf1.default_voice_address = gus->gf1.memory > 0 ? 0 : 512 - 8;
323 	/* initialize LFOs & clear LFOs memory */
324 	if (gus->gf1.enh_mode && gus->gf1.memory) {
325 		gus->gf1.hw_lfo = 1;
326 		gus->gf1.default_voice_address += 1024;
327 	} else {
328 		gus->gf1.sw_lfo = 1;
329 	}
330 
331 	if (gus->gf1.memory > 0)
332 		for (i = 0; i < 4; i++)
333 			snd_gf1_poke(gus, gus->gf1.default_voice_address + i, 0);
334 	snd_gf1_clear_regs(gus);
335 	snd_gf1_clear_voices(gus, 0, 31);
336 	snd_gf1_look_regs(gus);
337 	udelay(160);
338 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 7);	/* Reset Register = IRQ enable, DAC enable */
339 	udelay(160);
340 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 7);	/* Reset Register = IRQ enable, DAC enable */
341 	if (gus->gf1.enh_mode) {	/* enhanced mode !!!! */
342 		snd_gf1_i_write8(gus, SNDRV_GF1_GB_GLOBAL_MODE, snd_gf1_i_look8(gus, SNDRV_GF1_GB_GLOBAL_MODE) | 0x01);
343 		snd_gf1_i_write8(gus, SNDRV_GF1_GB_MEMORY_CONTROL, 0x01);
344 	}
345 	while ((snd_gf1_i_read8(gus, SNDRV_GF1_GB_VOICES_IRQ) & 0xc0) != 0xc0);
346 
347 	spin_lock_irqsave(&gus->reg_lock, flags);
348 	outb(gus->gf1.active_voice = 0, GUSP(gus, GF1PAGE));
349 	outb(gus->mix_cntrl_reg, GUSP(gus, MIXCNTRLREG));
350 	spin_unlock_irqrestore(&gus->reg_lock, flags);
351 
352 	snd_gf1_timers_init(gus);
353 	snd_gf1_look_regs(gus);
354 	snd_gf1_mem_init(gus);
355 	snd_gf1_mem_proc_init(gus);
356 #ifdef CONFIG_SND_DEBUG
357 	snd_gus_irq_profile_init(gus);
358 #endif
359 
360 #if 0
361 	if (gus->pnp_flag) {
362 		if (gus->chip.playback_fifo_size > 0)
363 			snd_gf1_i_write16(gus, SNDRV_GF1_GW_FIFO_RECORD_BASE_ADDR, gus->chip.playback_fifo_block->ptr >> 8);
364 		if (gus->chip.record_fifo_size > 0)
365 			snd_gf1_i_write16(gus, SNDRV_GF1_GW_FIFO_PLAY_BASE_ADDR, gus->chip.record_fifo_block->ptr >> 8);
366 		snd_gf1_i_write16(gus, SNDRV_GF1_GW_FIFO_SIZE, gus->chip.interwave_fifo_reg);
367 	}
368 #endif
369 
370 	return 0;
371 }
372 
373 /*
374  *  call this function only by shutdown of driver
375  */
376 
377 int snd_gf1_stop(struct snd_gus_card * gus)
378 {
379 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_SOUND_BLASTER_CONTROL, 0); /* stop all timers */
380 	snd_gf1_stop_voices(gus, 0, 31);		/* stop all voices */
381 	snd_gf1_i_write8(gus, SNDRV_GF1_GB_RESET, 1);	/* disable IRQ & DAC */
382 	snd_gf1_timers_done(gus);
383 	snd_gf1_mem_done(gus);
384 
385 	return 0;
386 }
387