1 // SPDX-License-Identifier: GPL-2.0-or-later
2 /*
3 * usbusx2y.c - ALSA USB US-428 Driver
4 *
5 2005-04-14 Karsten Wiese
6 Version 0.8.7.2:
7 Call snd_card_free() instead of snd_card_free_in_thread() to prevent oops with dead keyboard symptom.
8 Tested ok with kernel 2.6.12-rc2.
9
10 2004-12-14 Karsten Wiese
11 Version 0.8.7.1:
12 snd_pcm_open for rawusb pcm-devices now returns -EBUSY if called without rawusb's hwdep device being open.
13
14 2004-12-02 Karsten Wiese
15 Version 0.8.7:
16 Use macro usb_maxpacket() for portability.
17
18 2004-10-26 Karsten Wiese
19 Version 0.8.6:
20 wake_up() process waiting in usx2y_urbs_start() on error.
21
22 2004-10-21 Karsten Wiese
23 Version 0.8.5:
24 nrpacks is runtime or compiletime configurable now with tested values from 1 to 4.
25
26 2004-10-03 Karsten Wiese
27 Version 0.8.2:
28 Avoid any possible racing while in prepare callback.
29
30 2004-09-30 Karsten Wiese
31 Version 0.8.0:
32 Simplified things and made ohci work again.
33
34 2004-09-20 Karsten Wiese
35 Version 0.7.3:
36 Use usb_kill_urb() instead of deprecated (kernel 2.6.9) usb_unlink_urb().
37
38 2004-07-13 Karsten Wiese
39 Version 0.7.1:
40 Don't sleep in START/STOP callbacks anymore.
41 us428 channels C/D not handled just for this version, sorry.
42
43 2004-06-21 Karsten Wiese
44 Version 0.6.4:
45 Temporarely suspend midi input
46 to sanely call usb_set_interface() when setting format.
47
48 2004-06-12 Karsten Wiese
49 Version 0.6.3:
50 Made it thus the following rule is enforced:
51 "All pcm substreams of one usx2y have to operate at the same rate & format."
52
53 2004-04-06 Karsten Wiese
54 Version 0.6.0:
55 Runs on 2.6.5 kernel without any "--with-debug=" things.
56 us224 reported running.
57
58 2004-01-14 Karsten Wiese
59 Version 0.5.1:
60 Runs with 2.6.1 kernel.
61
62 2003-12-30 Karsten Wiese
63 Version 0.4.1:
64 Fix 24Bit 4Channel capturing for the us428.
65
66 2003-11-27 Karsten Wiese, Martin Langer
67 Version 0.4:
68 us122 support.
69 us224 could be tested by uncommenting the sections containing USB_ID_US224
70
71 2003-11-03 Karsten Wiese
72 Version 0.3:
73 24Bit support.
74 "arecord -D hw:1 -c 2 -r 48000 -M -f S24_3LE|aplay -D hw:1 -c 2 -r 48000 -M -f S24_3LE" works.
75
76 2003-08-22 Karsten Wiese
77 Version 0.0.8:
78 Removed EZUSB Firmware. First Stage Firmwaredownload is now done by tascam-firmware downloader.
79 See:
80 http://usb-midi-fw.sourceforge.net/tascam-firmware.tar.gz
81
82 2003-06-18 Karsten Wiese
83 Version 0.0.5:
84 changed to compile with kernel 2.4.21 and alsa 0.9.4
85
86 2002-10-16 Karsten Wiese
87 Version 0.0.4:
88 compiles again with alsa-current.
89 USB_ISO_ASAP not used anymore (most of the time), instead
90 urb->start_frame is calculated here now, some calls inside usb-driver don't need to happen anymore.
91
92 To get the best out of this:
93 Disable APM-support in the kernel as APM-BIOS calls (once each second) hard disable interrupt for many precious milliseconds.
94 This helped me much on my slowish PII 400 & PIII 500.
95 ACPI yet untested but might cause the same bad behaviour.
96 Use a kernel with lowlatency and preemptiv patches applied.
97 To autoload snd-usb-midi append a line
98 post-install snd-usb-us428 modprobe snd-usb-midi
99 to /etc/modules.conf.
100
101 known problems:
102 sliders, knobs, lights not yet handled except MASTER Volume slider.
103 "pcm -c 2" doesn't work. "pcm -c 2 -m direct_interleaved" does.
104 KDE3: "Enable full duplex operation" deadlocks.
105
106 2002-08-31 Karsten Wiese
107 Version 0.0.3: audio also simplex;
108 simplifying: iso urbs only 1 packet, melted structs.
109 ASYNC_UNLINK not used anymore: no more crashes so far.....
110 for alsa 0.9 rc3.
111
112 2002-08-09 Karsten Wiese
113 Version 0.0.2: midi works with snd-usb-midi, audio (only fullduplex now) with i.e. bristol.
114 The firmware has been sniffed from win2k us-428 driver 3.09.
115
116 * Copyright (c) 2002 - 2004 Karsten Wiese
117 */
118
119 #include <linux/init.h>
120 #include <linux/module.h>
121 #include <linux/moduleparam.h>
122 #include <linux/slab.h>
123 #include <linux/interrupt.h>
124 #include <linux/usb.h>
125 #include <sound/core.h>
126 #include <sound/initval.h>
127 #include <sound/pcm.h>
128
129 #include <sound/rawmidi.h>
130 #include "usx2y.h"
131 #include "usbusx2y.h"
132 #include "usX2Yhwdep.h"
133
134 MODULE_AUTHOR("Karsten Wiese <annabellesgarden@yahoo.de>");
135 MODULE_DESCRIPTION("TASCAM "NAME_ALLCAPS" Version 0.8.7.2");
136 MODULE_LICENSE("GPL");
137
138 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-max */
139 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* Id for this card */
140 static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
141
142 module_param_array(index, int, NULL, 0444);
143 MODULE_PARM_DESC(index, "Index value for "NAME_ALLCAPS".");
144 module_param_array(id, charp, NULL, 0444);
145 MODULE_PARM_DESC(id, "ID string for "NAME_ALLCAPS".");
146 module_param_array(enable, bool, NULL, 0444);
147 MODULE_PARM_DESC(enable, "Enable "NAME_ALLCAPS".");
148
149 static int snd_usx2y_card_used[SNDRV_CARDS];
150
151 static void snd_usx2y_card_private_free(struct snd_card *card);
152 static void usx2y_unlinkseq(struct snd_usx2y_async_seq *s);
153
154 #ifdef USX2Y_NRPACKS_VARIABLE
155 int nrpacks = USX2Y_NRPACKS; /* number of packets per urb */
156 module_param(nrpacks, int, 0444);
157 MODULE_PARM_DESC(nrpacks, "Number of packets per URB.");
158 #endif
159
160 /*
161 * pipe 4 is used for switching the lamps, setting samplerate, volumes ....
162 */
i_usx2y_out04_int(struct urb * urb)163 static void i_usx2y_out04_int(struct urb *urb)
164 {
165 #ifdef CONFIG_SND_DEBUG
166 if (urb->status) {
167 int i;
168 struct usx2ydev *usx2y = urb->context;
169
170 for (i = 0; i < 10 && usx2y->as04.urb[i] != urb; i++)
171 ;
172 dev_dbg(&urb->dev->dev, "%s urb %i status=%i\n", __func__, i, urb->status);
173 }
174 #endif
175 }
176
i_usx2y_in04_int(struct urb * urb)177 static void i_usx2y_in04_int(struct urb *urb)
178 {
179 int err = 0;
180 struct usx2ydev *usx2y = urb->context;
181 struct us428ctls_sharedmem *us428ctls = usx2y->us428ctls_sharedmem;
182 struct us428_p4out *p4out;
183 int i, j, n, diff, send, len;
184
185 usx2y->in04_int_calls++;
186
187 if (urb->status) {
188 dev_dbg(&urb->dev->dev, "Interrupt Pipe 4 came back with status=%i\n", urb->status);
189 return;
190 }
191
192 if (urb->actual_length < USX2Y_IN04_SIZE)
193 goto resubmit;
194
195 if (us428ctls) {
196 diff = -1;
197 if (us428ctls->ctl_snapshot_last == -2) {
198 diff = 0;
199 memcpy(usx2y->in04_last, usx2y->in04_buf, sizeof(usx2y->in04_last));
200 us428ctls->ctl_snapshot_last = -1;
201 } else {
202 for (i = 0; i < USX2Y_IN04_SIZE; i++) {
203 if (usx2y->in04_last[i] != ((char *)usx2y->in04_buf)[i]) {
204 if (diff < 0)
205 diff = i;
206 usx2y->in04_last[i] = ((char *)usx2y->in04_buf)[i];
207 }
208 }
209 }
210 if (diff >= 0) {
211 n = us428ctls->ctl_snapshot_last + 1;
212 if (n >= N_US428_CTL_BUFS || n < 0)
213 n = 0;
214 memcpy(us428ctls->ctl_snapshot + n, usx2y->in04_buf, sizeof(us428ctls->ctl_snapshot[0]));
215 us428ctls->ctl_snapshot_differs_at[n] = diff;
216 us428ctls->ctl_snapshot_last = n;
217 wake_up(&usx2y->us428ctls_wait_queue_head);
218 }
219 }
220
221 if (usx2y->us04) {
222 if (!usx2y->us04->submitted) {
223 do {
224 err = usb_submit_urb(usx2y->us04->urb[usx2y->us04->submitted++], GFP_ATOMIC);
225 } while (!err && usx2y->us04->submitted < usx2y->us04->len);
226 }
227 } else {
228 while (us428ctls &&
229 us428ctls->p4out_last >= 0 &&
230 us428ctls->p4out_last < N_US428_P4OUT_BUFS &&
231 us428ctls->p4out_last != us428ctls->p4out_sent) {
232 for (j = 0; j < URBS_ASYNC_SEQ && !err; ++j) {
233 if (!usx2y->as04.urb[j]->status) {
234 send = us428ctls->p4out_sent + 1;
235 if (send >= N_US428_P4OUT_BUFS)
236 send = 0;
237
238 p4out = us428ctls->p4out + send;
239 len = p4out->type == ELT_LIGHT ?
240 sizeof(struct us428_lights) : 5;
241 memcpy(usx2y->as04.urb[j]->transfer_buffer,
242 &p4out->val.vol, len);
243 usx2y->as04.urb[j]->transfer_buffer_length = len;
244 err = usb_submit_urb(usx2y->as04.urb[j], GFP_ATOMIC);
245 if (!err)
246 us428ctls->p4out_sent = send;
247
248 break;
249 }
250 }
251 if (j >= URBS_ASYNC_SEQ || err)
252 break;
253 }
254 }
255
256 if (err)
257 dev_err(&urb->dev->dev, "in04_int() usb_submit_urb err=%i\n", err);
258
259 resubmit:
260 urb->dev = usx2y->dev;
261 usb_submit_urb(urb, GFP_ATOMIC);
262 }
263
264 /*
265 * Prepare some urbs
266 */
usx2y_async_seq04_init(struct usx2ydev * usx2y)267 int usx2y_async_seq04_init(struct usx2ydev *usx2y)
268 {
269 int err = 0, i;
270
271 if (WARN_ON(usx2y->as04.buffer))
272 return -EBUSY;
273
274 usx2y->as04.buffer = kmalloc_array(URBS_ASYNC_SEQ,
275 URB_DATA_LEN_ASYNC_SEQ, GFP_KERNEL);
276 if (!usx2y->as04.buffer) {
277 err = -ENOMEM;
278 } else {
279 for (i = 0; i < URBS_ASYNC_SEQ; ++i) {
280 usx2y->as04.urb[i] = usb_alloc_urb(0, GFP_KERNEL);
281 if (!usx2y->as04.urb[i]) {
282 err = -ENOMEM;
283 break;
284 }
285 usb_fill_bulk_urb(usx2y->as04.urb[i], usx2y->dev,
286 usb_sndbulkpipe(usx2y->dev, 0x04),
287 usx2y->as04.buffer + URB_DATA_LEN_ASYNC_SEQ * i, 0,
288 i_usx2y_out04_int, usx2y);
289 err = usb_urb_ep_type_check(usx2y->as04.urb[i]);
290 if (err < 0)
291 break;
292 }
293 }
294 if (err)
295 usx2y_unlinkseq(&usx2y->as04);
296 return err;
297 }
298
usx2y_in04_init(struct usx2ydev * usx2y)299 int usx2y_in04_init(struct usx2ydev *usx2y)
300 {
301 int err;
302
303 if (WARN_ON(usx2y->in04_urb))
304 return -EBUSY;
305
306 usx2y->in04_urb = usb_alloc_urb(0, GFP_KERNEL);
307 if (!usx2y->in04_urb) {
308 err = -ENOMEM;
309 goto error;
310 }
311
312 usx2y->in04_buf = kzalloc(USX2Y_IN04_SIZE, GFP_KERNEL);
313 if (!usx2y->in04_buf) {
314 err = -ENOMEM;
315 goto error;
316 }
317
318 init_waitqueue_head(&usx2y->in04_wait_queue);
319 usb_fill_int_urb(usx2y->in04_urb, usx2y->dev, usb_rcvintpipe(usx2y->dev, 0x4),
320 usx2y->in04_buf, USX2Y_IN04_SIZE,
321 i_usx2y_in04_int, usx2y,
322 10);
323 if (usb_urb_ep_type_check(usx2y->in04_urb)) {
324 err = -EINVAL;
325 goto error;
326 }
327 return usb_submit_urb(usx2y->in04_urb, GFP_KERNEL);
328
329 error:
330 kfree(usx2y->in04_buf);
331 usb_free_urb(usx2y->in04_urb);
332 usx2y->in04_buf = NULL;
333 usx2y->in04_urb = NULL;
334 return err;
335 }
336
usx2y_unlinkseq(struct snd_usx2y_async_seq * s)337 static void usx2y_unlinkseq(struct snd_usx2y_async_seq *s)
338 {
339 int i;
340
341 for (i = 0; i < URBS_ASYNC_SEQ; ++i) {
342 if (!s->urb[i])
343 continue;
344 usb_kill_urb(s->urb[i]);
345 usb_free_urb(s->urb[i]);
346 s->urb[i] = NULL;
347 }
348 kfree(s->buffer);
349 s->buffer = NULL;
350 }
351
352 static const struct usb_device_id snd_usx2y_usb_id_table[] = {
353 {
354 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
355 .idVendor = 0x1604,
356 .idProduct = USB_ID_US428
357 },
358 {
359 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
360 .idVendor = 0x1604,
361 .idProduct = USB_ID_US122
362 },
363 {
364 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
365 .idVendor = 0x1604,
366 .idProduct = USB_ID_US224
367 },
368 { /* terminator */ }
369 };
370 MODULE_DEVICE_TABLE(usb, snd_usx2y_usb_id_table);
371
usx2y_create_card(struct usb_device * device,struct usb_interface * intf,struct snd_card ** cardp)372 static int usx2y_create_card(struct usb_device *device,
373 struct usb_interface *intf,
374 struct snd_card **cardp)
375 {
376 int dev;
377 struct snd_card *card;
378 int err;
379
380 for (dev = 0; dev < SNDRV_CARDS; ++dev)
381 if (enable[dev] && !snd_usx2y_card_used[dev])
382 break;
383 if (dev >= SNDRV_CARDS)
384 return -ENODEV;
385 err = snd_card_new(&intf->dev, index[dev], id[dev], THIS_MODULE,
386 sizeof(struct usx2ydev), &card);
387 if (err < 0)
388 return err;
389 snd_usx2y_card_used[usx2y(card)->card_index = dev] = 1;
390 card->private_free = snd_usx2y_card_private_free;
391 usx2y(card)->dev = device;
392 init_waitqueue_head(&usx2y(card)->prepare_wait_queue);
393 init_waitqueue_head(&usx2y(card)->us428ctls_wait_queue_head);
394 mutex_init(&usx2y(card)->pcm_mutex);
395 INIT_LIST_HEAD(&usx2y(card)->midi_list);
396 strscpy(card->driver, "USB "NAME_ALLCAPS"");
397 sprintf(card->shortname, "TASCAM "NAME_ALLCAPS"");
398 sprintf(card->longname, "%s (%x:%x if %d at %03d/%03d)",
399 card->shortname,
400 le16_to_cpu(device->descriptor.idVendor),
401 le16_to_cpu(device->descriptor.idProduct),
402 0,//us428(card)->usbmidi.ifnum,
403 usx2y(card)->dev->bus->busnum, usx2y(card)->dev->devnum);
404 *cardp = card;
405 return 0;
406 }
407
snd_usx2y_card_private_free(struct snd_card * card)408 static void snd_usx2y_card_private_free(struct snd_card *card)
409 {
410 struct usx2ydev *usx2y = usx2y(card);
411
412 kfree(usx2y->in04_buf);
413 usb_free_urb(usx2y->in04_urb);
414 if (usx2y->us428ctls_sharedmem)
415 free_pages_exact(usx2y->us428ctls_sharedmem,
416 US428_SHAREDMEM_PAGES);
417 if (usx2y->card_index >= 0 && usx2y->card_index < SNDRV_CARDS)
418 snd_usx2y_card_used[usx2y->card_index] = 0;
419 }
420
snd_usx2y_disconnect(struct usb_interface * intf)421 static void snd_usx2y_disconnect(struct usb_interface *intf)
422 {
423 struct snd_card *card;
424 struct usx2ydev *usx2y;
425 struct list_head *p;
426
427 card = usb_get_intfdata(intf);
428 if (!card)
429 return;
430 usx2y = usx2y(card);
431 usx2y->chip_status = USX2Y_STAT_CHIP_HUP;
432 usx2y_unlinkseq(&usx2y->as04);
433 usb_kill_urb(usx2y->in04_urb);
434 snd_card_disconnect(card);
435
436 /* release the midi resources */
437 list_for_each(p, &usx2y->midi_list) {
438 snd_usbmidi_disconnect(p);
439 }
440 if (usx2y->us428ctls_sharedmem)
441 wake_up(&usx2y->us428ctls_wait_queue_head);
442 snd_card_free_when_closed(card);
443 }
444
snd_usx2y_probe(struct usb_interface * intf,const struct usb_device_id * id)445 static int snd_usx2y_probe(struct usb_interface *intf,
446 const struct usb_device_id *id)
447 {
448 struct usb_device *device = interface_to_usbdev(intf);
449 struct snd_card *card;
450 int err;
451
452 #ifdef USX2Y_NRPACKS_VARIABLE
453 if (nrpacks < 0 || nrpacks > USX2Y_NRPACKS_MAX)
454 return -EINVAL;
455 #endif
456
457 if (le16_to_cpu(device->descriptor.idVendor) != 0x1604 ||
458 (le16_to_cpu(device->descriptor.idProduct) != USB_ID_US122 &&
459 le16_to_cpu(device->descriptor.idProduct) != USB_ID_US224 &&
460 le16_to_cpu(device->descriptor.idProduct) != USB_ID_US428))
461 return -EINVAL;
462
463 err = usx2y_create_card(device, intf, &card);
464 if (err < 0)
465 return err;
466 err = usx2y_hwdep_new(card, device);
467 if (err < 0)
468 goto error;
469 err = snd_card_register(card);
470 if (err < 0)
471 goto error;
472
473 dev_set_drvdata(&intf->dev, card);
474 return 0;
475
476 error:
477 snd_card_free(card);
478 return err;
479 }
480
481 static struct usb_driver snd_usx2y_usb_driver = {
482 .name = "snd-usb-usx2y",
483 .probe = snd_usx2y_probe,
484 .disconnect = snd_usx2y_disconnect,
485 .id_table = snd_usx2y_usb_id_table,
486 };
487 module_usb_driver(snd_usx2y_usb_driver);
488