xref: /OK3568_Linux_fs/kernel/sound/pci/ca0106/ca_midi.c (revision 4882a59341e53eb6f0b4789bf948001014eff981)
1*4882a593Smuzhiyun // SPDX-License-Identifier: GPL-2.0-or-later
2*4882a593Smuzhiyun /*
3*4882a593Smuzhiyun  *  Copyright 10/16/2005 Tilman Kranz <tilde@tk-sls.de>
4*4882a593Smuzhiyun  *  Creative Audio MIDI, for the CA0106 Driver
5*4882a593Smuzhiyun  *  Version: 0.0.1
6*4882a593Smuzhiyun  *
7*4882a593Smuzhiyun  *  Changelog:
8*4882a593Smuzhiyun  *    Implementation is based on mpu401 and emu10k1x and
9*4882a593Smuzhiyun  *    tested with ca0106.
10*4882a593Smuzhiyun  *    mpu401: Copyright (c) by Jaroslav Kysela <perex@perex.cz>
11*4882a593Smuzhiyun  *    emu10k1x: Copyright (c) by Francisco Moraes <fmoraes@nc.rr.com>
12*4882a593Smuzhiyun  */
13*4882a593Smuzhiyun 
14*4882a593Smuzhiyun #include <linux/spinlock.h>
15*4882a593Smuzhiyun #include <sound/core.h>
16*4882a593Smuzhiyun #include <sound/rawmidi.h>
17*4882a593Smuzhiyun 
18*4882a593Smuzhiyun #include "ca_midi.h"
19*4882a593Smuzhiyun 
20*4882a593Smuzhiyun #define ca_midi_write_data(midi, data)	midi->write(midi, data, 0)
21*4882a593Smuzhiyun #define ca_midi_write_cmd(midi, data)	midi->write(midi, data, 1)
22*4882a593Smuzhiyun #define ca_midi_read_data(midi)		midi->read(midi, 0)
23*4882a593Smuzhiyun #define ca_midi_read_stat(midi)		midi->read(midi, 1)
24*4882a593Smuzhiyun #define ca_midi_input_avail(midi)	(!(ca_midi_read_stat(midi) & midi->input_avail))
25*4882a593Smuzhiyun #define ca_midi_output_ready(midi)	(!(ca_midi_read_stat(midi) & midi->output_ready))
26*4882a593Smuzhiyun 
ca_midi_clear_rx(struct snd_ca_midi * midi)27*4882a593Smuzhiyun static void ca_midi_clear_rx(struct snd_ca_midi *midi)
28*4882a593Smuzhiyun {
29*4882a593Smuzhiyun 	int timeout = 100000;
30*4882a593Smuzhiyun 	for (; timeout > 0 && ca_midi_input_avail(midi); timeout--)
31*4882a593Smuzhiyun 		ca_midi_read_data(midi);
32*4882a593Smuzhiyun #ifdef CONFIG_SND_DEBUG
33*4882a593Smuzhiyun 	if (timeout <= 0)
34*4882a593Smuzhiyun 		pr_err("ca_midi_clear_rx: timeout (status = 0x%x)\n",
35*4882a593Smuzhiyun 			   ca_midi_read_stat(midi));
36*4882a593Smuzhiyun #endif
37*4882a593Smuzhiyun }
38*4882a593Smuzhiyun 
ca_midi_interrupt(struct snd_ca_midi * midi,unsigned int status)39*4882a593Smuzhiyun static void ca_midi_interrupt(struct snd_ca_midi *midi, unsigned int status)
40*4882a593Smuzhiyun {
41*4882a593Smuzhiyun 	unsigned char byte;
42*4882a593Smuzhiyun 
43*4882a593Smuzhiyun 	if (midi->rmidi == NULL) {
44*4882a593Smuzhiyun 		midi->interrupt_disable(midi,midi->tx_enable | midi->rx_enable);
45*4882a593Smuzhiyun 		return;
46*4882a593Smuzhiyun 	}
47*4882a593Smuzhiyun 
48*4882a593Smuzhiyun 	spin_lock(&midi->input_lock);
49*4882a593Smuzhiyun 	if ((status & midi->ipr_rx) && ca_midi_input_avail(midi)) {
50*4882a593Smuzhiyun 		if (!(midi->midi_mode & CA_MIDI_MODE_INPUT)) {
51*4882a593Smuzhiyun 			ca_midi_clear_rx(midi);
52*4882a593Smuzhiyun 		} else {
53*4882a593Smuzhiyun 			byte = ca_midi_read_data(midi);
54*4882a593Smuzhiyun 			if(midi->substream_input)
55*4882a593Smuzhiyun 				snd_rawmidi_receive(midi->substream_input, &byte, 1);
56*4882a593Smuzhiyun 
57*4882a593Smuzhiyun 
58*4882a593Smuzhiyun 		}
59*4882a593Smuzhiyun 	}
60*4882a593Smuzhiyun 	spin_unlock(&midi->input_lock);
61*4882a593Smuzhiyun 
62*4882a593Smuzhiyun 	spin_lock(&midi->output_lock);
63*4882a593Smuzhiyun 	if ((status & midi->ipr_tx) && ca_midi_output_ready(midi)) {
64*4882a593Smuzhiyun 		if (midi->substream_output &&
65*4882a593Smuzhiyun 		    snd_rawmidi_transmit(midi->substream_output, &byte, 1) == 1) {
66*4882a593Smuzhiyun 			ca_midi_write_data(midi, byte);
67*4882a593Smuzhiyun 		} else {
68*4882a593Smuzhiyun 			midi->interrupt_disable(midi,midi->tx_enable);
69*4882a593Smuzhiyun 		}
70*4882a593Smuzhiyun 	}
71*4882a593Smuzhiyun 	spin_unlock(&midi->output_lock);
72*4882a593Smuzhiyun 
73*4882a593Smuzhiyun }
74*4882a593Smuzhiyun 
ca_midi_cmd(struct snd_ca_midi * midi,unsigned char cmd,int ack)75*4882a593Smuzhiyun static void ca_midi_cmd(struct snd_ca_midi *midi, unsigned char cmd, int ack)
76*4882a593Smuzhiyun {
77*4882a593Smuzhiyun 	unsigned long flags;
78*4882a593Smuzhiyun 	int timeout, ok;
79*4882a593Smuzhiyun 
80*4882a593Smuzhiyun 	spin_lock_irqsave(&midi->input_lock, flags);
81*4882a593Smuzhiyun 	ca_midi_write_data(midi, 0x00);
82*4882a593Smuzhiyun 	/* ca_midi_clear_rx(midi); */
83*4882a593Smuzhiyun 
84*4882a593Smuzhiyun 	ca_midi_write_cmd(midi, cmd);
85*4882a593Smuzhiyun 	if (ack) {
86*4882a593Smuzhiyun 		ok = 0;
87*4882a593Smuzhiyun 		timeout = 10000;
88*4882a593Smuzhiyun 		while (!ok && timeout-- > 0) {
89*4882a593Smuzhiyun 			if (ca_midi_input_avail(midi)) {
90*4882a593Smuzhiyun 				if (ca_midi_read_data(midi) == midi->ack)
91*4882a593Smuzhiyun 					ok = 1;
92*4882a593Smuzhiyun 			}
93*4882a593Smuzhiyun 		}
94*4882a593Smuzhiyun 		if (!ok && ca_midi_read_data(midi) == midi->ack)
95*4882a593Smuzhiyun 			ok = 1;
96*4882a593Smuzhiyun 	} else {
97*4882a593Smuzhiyun 		ok = 1;
98*4882a593Smuzhiyun 	}
99*4882a593Smuzhiyun 	spin_unlock_irqrestore(&midi->input_lock, flags);
100*4882a593Smuzhiyun 	if (!ok)
101*4882a593Smuzhiyun 		pr_err("ca_midi_cmd: 0x%x failed at 0x%x (status = 0x%x, data = 0x%x)!!!\n",
102*4882a593Smuzhiyun 			   cmd,
103*4882a593Smuzhiyun 			   midi->get_dev_id_port(midi->dev_id),
104*4882a593Smuzhiyun 			   ca_midi_read_stat(midi),
105*4882a593Smuzhiyun 			   ca_midi_read_data(midi));
106*4882a593Smuzhiyun }
107*4882a593Smuzhiyun 
ca_midi_input_open(struct snd_rawmidi_substream * substream)108*4882a593Smuzhiyun static int ca_midi_input_open(struct snd_rawmidi_substream *substream)
109*4882a593Smuzhiyun {
110*4882a593Smuzhiyun 	struct snd_ca_midi *midi = substream->rmidi->private_data;
111*4882a593Smuzhiyun 	unsigned long flags;
112*4882a593Smuzhiyun 
113*4882a593Smuzhiyun 	if (snd_BUG_ON(!midi->dev_id))
114*4882a593Smuzhiyun 		return -ENXIO;
115*4882a593Smuzhiyun 	spin_lock_irqsave(&midi->open_lock, flags);
116*4882a593Smuzhiyun 	midi->midi_mode |= CA_MIDI_MODE_INPUT;
117*4882a593Smuzhiyun 	midi->substream_input = substream;
118*4882a593Smuzhiyun 	if (!(midi->midi_mode & CA_MIDI_MODE_OUTPUT)) {
119*4882a593Smuzhiyun 		spin_unlock_irqrestore(&midi->open_lock, flags);
120*4882a593Smuzhiyun 		ca_midi_cmd(midi, midi->reset, 1);
121*4882a593Smuzhiyun 		ca_midi_cmd(midi, midi->enter_uart, 1);
122*4882a593Smuzhiyun 	} else {
123*4882a593Smuzhiyun 		spin_unlock_irqrestore(&midi->open_lock, flags);
124*4882a593Smuzhiyun 	}
125*4882a593Smuzhiyun 	return 0;
126*4882a593Smuzhiyun }
127*4882a593Smuzhiyun 
ca_midi_output_open(struct snd_rawmidi_substream * substream)128*4882a593Smuzhiyun static int ca_midi_output_open(struct snd_rawmidi_substream *substream)
129*4882a593Smuzhiyun {
130*4882a593Smuzhiyun 	struct snd_ca_midi *midi = substream->rmidi->private_data;
131*4882a593Smuzhiyun 	unsigned long flags;
132*4882a593Smuzhiyun 
133*4882a593Smuzhiyun 	if (snd_BUG_ON(!midi->dev_id))
134*4882a593Smuzhiyun 		return -ENXIO;
135*4882a593Smuzhiyun 	spin_lock_irqsave(&midi->open_lock, flags);
136*4882a593Smuzhiyun 	midi->midi_mode |= CA_MIDI_MODE_OUTPUT;
137*4882a593Smuzhiyun 	midi->substream_output = substream;
138*4882a593Smuzhiyun 	if (!(midi->midi_mode & CA_MIDI_MODE_INPUT)) {
139*4882a593Smuzhiyun 		spin_unlock_irqrestore(&midi->open_lock, flags);
140*4882a593Smuzhiyun 		ca_midi_cmd(midi, midi->reset, 1);
141*4882a593Smuzhiyun 		ca_midi_cmd(midi, midi->enter_uart, 1);
142*4882a593Smuzhiyun 	} else {
143*4882a593Smuzhiyun 		spin_unlock_irqrestore(&midi->open_lock, flags);
144*4882a593Smuzhiyun 	}
145*4882a593Smuzhiyun 	return 0;
146*4882a593Smuzhiyun }
147*4882a593Smuzhiyun 
ca_midi_input_close(struct snd_rawmidi_substream * substream)148*4882a593Smuzhiyun static int ca_midi_input_close(struct snd_rawmidi_substream *substream)
149*4882a593Smuzhiyun {
150*4882a593Smuzhiyun 	struct snd_ca_midi *midi = substream->rmidi->private_data;
151*4882a593Smuzhiyun 	unsigned long flags;
152*4882a593Smuzhiyun 
153*4882a593Smuzhiyun 	if (snd_BUG_ON(!midi->dev_id))
154*4882a593Smuzhiyun 		return -ENXIO;
155*4882a593Smuzhiyun 	spin_lock_irqsave(&midi->open_lock, flags);
156*4882a593Smuzhiyun 	midi->interrupt_disable(midi,midi->rx_enable);
157*4882a593Smuzhiyun 	midi->midi_mode &= ~CA_MIDI_MODE_INPUT;
158*4882a593Smuzhiyun 	midi->substream_input = NULL;
159*4882a593Smuzhiyun 	if (!(midi->midi_mode & CA_MIDI_MODE_OUTPUT)) {
160*4882a593Smuzhiyun 		spin_unlock_irqrestore(&midi->open_lock, flags);
161*4882a593Smuzhiyun 		ca_midi_cmd(midi, midi->reset, 0);
162*4882a593Smuzhiyun 	} else {
163*4882a593Smuzhiyun 		spin_unlock_irqrestore(&midi->open_lock, flags);
164*4882a593Smuzhiyun 	}
165*4882a593Smuzhiyun 	return 0;
166*4882a593Smuzhiyun }
167*4882a593Smuzhiyun 
ca_midi_output_close(struct snd_rawmidi_substream * substream)168*4882a593Smuzhiyun static int ca_midi_output_close(struct snd_rawmidi_substream *substream)
169*4882a593Smuzhiyun {
170*4882a593Smuzhiyun 	struct snd_ca_midi *midi = substream->rmidi->private_data;
171*4882a593Smuzhiyun 	unsigned long flags;
172*4882a593Smuzhiyun 
173*4882a593Smuzhiyun 	if (snd_BUG_ON(!midi->dev_id))
174*4882a593Smuzhiyun 		return -ENXIO;
175*4882a593Smuzhiyun 
176*4882a593Smuzhiyun 	spin_lock_irqsave(&midi->open_lock, flags);
177*4882a593Smuzhiyun 
178*4882a593Smuzhiyun 	midi->interrupt_disable(midi,midi->tx_enable);
179*4882a593Smuzhiyun 	midi->midi_mode &= ~CA_MIDI_MODE_OUTPUT;
180*4882a593Smuzhiyun 	midi->substream_output = NULL;
181*4882a593Smuzhiyun 
182*4882a593Smuzhiyun 	if (!(midi->midi_mode & CA_MIDI_MODE_INPUT)) {
183*4882a593Smuzhiyun 		spin_unlock_irqrestore(&midi->open_lock, flags);
184*4882a593Smuzhiyun 		ca_midi_cmd(midi, midi->reset, 0);
185*4882a593Smuzhiyun 	} else {
186*4882a593Smuzhiyun 		spin_unlock_irqrestore(&midi->open_lock, flags);
187*4882a593Smuzhiyun 	}
188*4882a593Smuzhiyun 	return 0;
189*4882a593Smuzhiyun }
190*4882a593Smuzhiyun 
ca_midi_input_trigger(struct snd_rawmidi_substream * substream,int up)191*4882a593Smuzhiyun static void ca_midi_input_trigger(struct snd_rawmidi_substream *substream, int up)
192*4882a593Smuzhiyun {
193*4882a593Smuzhiyun 	struct snd_ca_midi *midi = substream->rmidi->private_data;
194*4882a593Smuzhiyun 
195*4882a593Smuzhiyun 	if (snd_BUG_ON(!midi->dev_id))
196*4882a593Smuzhiyun 		return;
197*4882a593Smuzhiyun 
198*4882a593Smuzhiyun 	if (up) {
199*4882a593Smuzhiyun 		midi->interrupt_enable(midi,midi->rx_enable);
200*4882a593Smuzhiyun 	} else {
201*4882a593Smuzhiyun 		midi->interrupt_disable(midi, midi->rx_enable);
202*4882a593Smuzhiyun 	}
203*4882a593Smuzhiyun }
204*4882a593Smuzhiyun 
ca_midi_output_trigger(struct snd_rawmidi_substream * substream,int up)205*4882a593Smuzhiyun static void ca_midi_output_trigger(struct snd_rawmidi_substream *substream, int up)
206*4882a593Smuzhiyun {
207*4882a593Smuzhiyun 	struct snd_ca_midi *midi = substream->rmidi->private_data;
208*4882a593Smuzhiyun 	unsigned long flags;
209*4882a593Smuzhiyun 
210*4882a593Smuzhiyun 	if (snd_BUG_ON(!midi->dev_id))
211*4882a593Smuzhiyun 		return;
212*4882a593Smuzhiyun 
213*4882a593Smuzhiyun 	if (up) {
214*4882a593Smuzhiyun 		int max = 4;
215*4882a593Smuzhiyun 		unsigned char byte;
216*4882a593Smuzhiyun 
217*4882a593Smuzhiyun 		spin_lock_irqsave(&midi->output_lock, flags);
218*4882a593Smuzhiyun 
219*4882a593Smuzhiyun 		/* try to send some amount of bytes here before interrupts */
220*4882a593Smuzhiyun 		while (max > 0) {
221*4882a593Smuzhiyun 			if (ca_midi_output_ready(midi)) {
222*4882a593Smuzhiyun 				if (!(midi->midi_mode & CA_MIDI_MODE_OUTPUT) ||
223*4882a593Smuzhiyun 				    snd_rawmidi_transmit(substream, &byte, 1) != 1) {
224*4882a593Smuzhiyun 					/* no more data */
225*4882a593Smuzhiyun 					spin_unlock_irqrestore(&midi->output_lock, flags);
226*4882a593Smuzhiyun 					return;
227*4882a593Smuzhiyun 				}
228*4882a593Smuzhiyun 				ca_midi_write_data(midi, byte);
229*4882a593Smuzhiyun 				max--;
230*4882a593Smuzhiyun 			} else {
231*4882a593Smuzhiyun 				break;
232*4882a593Smuzhiyun 			}
233*4882a593Smuzhiyun 		}
234*4882a593Smuzhiyun 
235*4882a593Smuzhiyun 		spin_unlock_irqrestore(&midi->output_lock, flags);
236*4882a593Smuzhiyun 		midi->interrupt_enable(midi,midi->tx_enable);
237*4882a593Smuzhiyun 
238*4882a593Smuzhiyun 	} else {
239*4882a593Smuzhiyun 		midi->interrupt_disable(midi,midi->tx_enable);
240*4882a593Smuzhiyun 	}
241*4882a593Smuzhiyun }
242*4882a593Smuzhiyun 
243*4882a593Smuzhiyun static const struct snd_rawmidi_ops ca_midi_output =
244*4882a593Smuzhiyun {
245*4882a593Smuzhiyun 	.open =		ca_midi_output_open,
246*4882a593Smuzhiyun 	.close =	ca_midi_output_close,
247*4882a593Smuzhiyun 	.trigger =	ca_midi_output_trigger,
248*4882a593Smuzhiyun };
249*4882a593Smuzhiyun 
250*4882a593Smuzhiyun static const struct snd_rawmidi_ops ca_midi_input =
251*4882a593Smuzhiyun {
252*4882a593Smuzhiyun 	.open =		ca_midi_input_open,
253*4882a593Smuzhiyun 	.close =	ca_midi_input_close,
254*4882a593Smuzhiyun 	.trigger =	ca_midi_input_trigger,
255*4882a593Smuzhiyun };
256*4882a593Smuzhiyun 
ca_midi_free(struct snd_ca_midi * midi)257*4882a593Smuzhiyun static void ca_midi_free(struct snd_ca_midi *midi)
258*4882a593Smuzhiyun {
259*4882a593Smuzhiyun 	midi->interrupt = NULL;
260*4882a593Smuzhiyun 	midi->interrupt_enable = NULL;
261*4882a593Smuzhiyun 	midi->interrupt_disable = NULL;
262*4882a593Smuzhiyun 	midi->read = NULL;
263*4882a593Smuzhiyun 	midi->write = NULL;
264*4882a593Smuzhiyun 	midi->get_dev_id_card = NULL;
265*4882a593Smuzhiyun 	midi->get_dev_id_port = NULL;
266*4882a593Smuzhiyun 	midi->rmidi = NULL;
267*4882a593Smuzhiyun }
268*4882a593Smuzhiyun 
ca_rmidi_free(struct snd_rawmidi * rmidi)269*4882a593Smuzhiyun static void ca_rmidi_free(struct snd_rawmidi *rmidi)
270*4882a593Smuzhiyun {
271*4882a593Smuzhiyun 	ca_midi_free(rmidi->private_data);
272*4882a593Smuzhiyun }
273*4882a593Smuzhiyun 
ca_midi_init(void * dev_id,struct snd_ca_midi * midi,int device,char * name)274*4882a593Smuzhiyun int ca_midi_init(void *dev_id, struct snd_ca_midi *midi, int device, char *name)
275*4882a593Smuzhiyun {
276*4882a593Smuzhiyun 	struct snd_rawmidi *rmidi;
277*4882a593Smuzhiyun 	int err;
278*4882a593Smuzhiyun 
279*4882a593Smuzhiyun 	if ((err = snd_rawmidi_new(midi->get_dev_id_card(midi->dev_id), name, device, 1, 1, &rmidi)) < 0)
280*4882a593Smuzhiyun 		return err;
281*4882a593Smuzhiyun 
282*4882a593Smuzhiyun 	midi->dev_id = dev_id;
283*4882a593Smuzhiyun 	midi->interrupt = ca_midi_interrupt;
284*4882a593Smuzhiyun 
285*4882a593Smuzhiyun 	spin_lock_init(&midi->open_lock);
286*4882a593Smuzhiyun 	spin_lock_init(&midi->input_lock);
287*4882a593Smuzhiyun 	spin_lock_init(&midi->output_lock);
288*4882a593Smuzhiyun 
289*4882a593Smuzhiyun 	strcpy(rmidi->name, name);
290*4882a593Smuzhiyun 	snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_OUTPUT, &ca_midi_output);
291*4882a593Smuzhiyun 	snd_rawmidi_set_ops(rmidi, SNDRV_RAWMIDI_STREAM_INPUT, &ca_midi_input);
292*4882a593Smuzhiyun 	rmidi->info_flags |= SNDRV_RAWMIDI_INFO_OUTPUT |
293*4882a593Smuzhiyun 	                     SNDRV_RAWMIDI_INFO_INPUT |
294*4882a593Smuzhiyun 	                     SNDRV_RAWMIDI_INFO_DUPLEX;
295*4882a593Smuzhiyun 	rmidi->private_data = midi;
296*4882a593Smuzhiyun 	rmidi->private_free = ca_rmidi_free;
297*4882a593Smuzhiyun 
298*4882a593Smuzhiyun 	midi->rmidi = rmidi;
299*4882a593Smuzhiyun 	return 0;
300*4882a593Smuzhiyun }
301*4882a593Smuzhiyun 
302