xref: /linux/sound/usb/6fire/midi.c (revision 9fe49dbc023e82dfaee7b245997d820d01742a9a)
1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3  * Linux driver for TerraTec DMX 6Fire USB
4  *
5  * Rawmidi driver
6  *
7  * Author:	Torsten Schenk <torsten.schenk@zoho.com>
8  * Created:	Jan 01, 2011
9  * Copyright:	(C) Torsten Schenk
10  */
11 
12 #include <sound/rawmidi.h>
13 
14 #include "midi.h"
15 #include "chip.h"
16 #include "comm.h"
17 
18 enum {
19 	MIDI_BUFSIZE = 64
20 };
21 
22 static void usb6fire_midi_out_handler(struct urb *urb)
23 {
24 	struct midi_runtime *rt = urb->context;
25 	int ret;
26 
27 	guard(spinlock_irqsave)(&rt->out_lock);
28 
29 	if (rt->out) {
30 		ret = snd_rawmidi_transmit(rt->out, rt->out_buffer + 4,
31 				MIDI_BUFSIZE - 4);
32 		if (ret > 0) { /* more data available, send next packet */
33 			rt->out_buffer[1] = ret + 2;
34 			rt->out_buffer[3] = rt->out_serial++;
35 			urb->transfer_buffer_length = ret + 4;
36 
37 			ret = usb_submit_urb(urb, GFP_ATOMIC);
38 			if (ret < 0)
39 				dev_err(&urb->dev->dev,
40 					"midi out urb submit failed: %d\n",
41 					ret);
42 		} else /* no more data to transmit */
43 			rt->out = NULL;
44 	}
45 }
46 
47 static void usb6fire_midi_in_received(
48 		struct midi_runtime *rt, u8 *data, int length)
49 {
50 	guard(spinlock_irqsave)(&rt->in_lock);
51 	if (rt->in)
52 		snd_rawmidi_receive(rt->in, data, length);
53 }
54 
55 static int usb6fire_midi_out_open(struct snd_rawmidi_substream *alsa_sub)
56 {
57 	return 0;
58 }
59 
60 static int usb6fire_midi_out_close(struct snd_rawmidi_substream *alsa_sub)
61 {
62 	return 0;
63 }
64 
65 static void usb6fire_midi_out_trigger(
66 		struct snd_rawmidi_substream *alsa_sub, int up)
67 {
68 	struct midi_runtime *rt = alsa_sub->rmidi->private_data;
69 	struct urb *urb = rt->out_urb;
70 	__s8 ret;
71 
72 	guard(spinlock_irqsave)(&rt->out_lock);
73 	if (up) { /* start transfer */
74 		if (rt->out) /* we are already transmitting so just return */
75 			return;
76 
77 		ret = snd_rawmidi_transmit(alsa_sub, rt->out_buffer + 4,
78 				MIDI_BUFSIZE - 4);
79 		if (ret > 0) {
80 			rt->out_buffer[1] = ret + 2;
81 			rt->out_buffer[3] = rt->out_serial++;
82 			urb->transfer_buffer_length = ret + 4;
83 
84 			ret = usb_submit_urb(urb, GFP_ATOMIC);
85 			if (ret < 0)
86 				dev_err(&urb->dev->dev,
87 					"midi out urb submit failed: %d\n",
88 					ret);
89 			else
90 				rt->out = alsa_sub;
91 		}
92 	} else if (rt->out == alsa_sub)
93 		rt->out = NULL;
94 }
95 
96 static void usb6fire_midi_out_drain(struct snd_rawmidi_substream *alsa_sub)
97 {
98 	struct midi_runtime *rt = alsa_sub->rmidi->private_data;
99 	int retry = 0;
100 
101 	while (rt->out && retry++ < 100)
102 		msleep(10);
103 }
104 
105 static int usb6fire_midi_in_open(struct snd_rawmidi_substream *alsa_sub)
106 {
107 	return 0;
108 }
109 
110 static int usb6fire_midi_in_close(struct snd_rawmidi_substream *alsa_sub)
111 {
112 	return 0;
113 }
114 
115 static void usb6fire_midi_in_trigger(
116 		struct snd_rawmidi_substream *alsa_sub, int up)
117 {
118 	struct midi_runtime *rt = alsa_sub->rmidi->private_data;
119 
120 	guard(spinlock_irqsave)(&rt->in_lock);
121 	if (up)
122 		rt->in = alsa_sub;
123 	else
124 		rt->in = NULL;
125 }
126 
127 static const struct snd_rawmidi_ops out_ops = {
128 	.open = usb6fire_midi_out_open,
129 	.close = usb6fire_midi_out_close,
130 	.trigger = usb6fire_midi_out_trigger,
131 	.drain = usb6fire_midi_out_drain
132 };
133 
134 static const struct snd_rawmidi_ops in_ops = {
135 	.open = usb6fire_midi_in_open,
136 	.close = usb6fire_midi_in_close,
137 	.trigger = usb6fire_midi_in_trigger
138 };
139 
140 static void usb6fire_midi_free(struct midi_runtime *rt)
141 {
142 	if (!rt)
143 		return;
144 
145 	if (rt->chip)
146 		rt->chip->midi = NULL;
147 
148 	usb_free_urb(rt->out_urb);
149 	kfree(rt->out_buffer);
150 	kfree(rt);
151 }
152 
153 int usb6fire_midi_init(struct sfire_chip *chip)
154 {
155 	int ret;
156 	struct midi_runtime *rt = kzalloc_obj(struct midi_runtime);
157 	struct comm_runtime *comm_rt = chip->comm;
158 
159 	if (!rt)
160 		return -ENOMEM;
161 
162 	rt->out_buffer = kzalloc(MIDI_BUFSIZE, GFP_KERNEL);
163 	if (!rt->out_buffer) {
164 		ret = -ENOMEM;
165 		goto error;
166 	}
167 
168 	rt->out_urb = usb_alloc_urb(0, GFP_KERNEL);
169 	if (!rt->out_urb) {
170 		ret = -ENOMEM;
171 		goto error;
172 	}
173 
174 	rt->chip = chip;
175 	rt->in_received = usb6fire_midi_in_received;
176 	rt->out_buffer[0] = 0x80; /* 'send midi' command */
177 	rt->out_buffer[1] = 0x00; /* size of data */
178 	rt->out_buffer[2] = 0x00; /* always 0 */
179 	spin_lock_init(&rt->in_lock);
180 	spin_lock_init(&rt->out_lock);
181 
182 	comm_rt->init_urb(comm_rt, rt->out_urb, rt->out_buffer, rt,
183 			usb6fire_midi_out_handler);
184 
185 	ret = snd_rawmidi_new(chip->card, "6FireUSB", 0, 1, 1, &rt->instance);
186 	if (ret < 0) {
187 		dev_err(&chip->dev->dev, "unable to create midi.\n");
188 		goto error;
189 	}
190 	rt->instance->private_data = rt;
191 	strscpy(rt->instance->name, "DMX6FireUSB MIDI");
192 	rt->instance->info_flags = SNDRV_RAWMIDI_INFO_OUTPUT |
193 			SNDRV_RAWMIDI_INFO_INPUT |
194 			SNDRV_RAWMIDI_INFO_DUPLEX;
195 	snd_rawmidi_set_ops(rt->instance, SNDRV_RAWMIDI_STREAM_OUTPUT,
196 			&out_ops);
197 	snd_rawmidi_set_ops(rt->instance, SNDRV_RAWMIDI_STREAM_INPUT,
198 			&in_ops);
199 
200 	chip->midi = rt;
201 	return 0;
202 
203  error:
204 	usb6fire_midi_free(rt);
205 	return ret;
206 }
207 
208 void usb6fire_midi_abort(struct sfire_chip *chip)
209 {
210 	struct midi_runtime *rt = chip->midi;
211 
212 	if (rt)
213 		usb_poison_urb(rt->out_urb);
214 }
215 
216 void usb6fire_midi_destroy(struct sfire_chip *chip)
217 {
218 	usb6fire_midi_free(chip->midi);
219 }
220