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 snd_printdd("%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;
184
185 usx2y->in04_int_calls++;
186
187 if (urb->status) {
188 snd_printdd("Interrupt Pipe 4 came back with status=%i\n", urb->status);
189 return;
190 }
191
192 // printk("%i:0x%02X ", 8, (int)((unsigned char*)usx2y->in04_buf)[8]); Master volume shows 0 here if fader is at max during boot ?!?
193 if (us428ctls) {
194 diff = -1;
195 if (us428ctls->ctl_snapshot_last == -2) {
196 diff = 0;
197 memcpy(usx2y->in04_last, usx2y->in04_buf, sizeof(usx2y->in04_last));
198 us428ctls->ctl_snapshot_last = -1;
199 } else {
200 for (i = 0; i < 21; i++) {
201 if (usx2y->in04_last[i] != ((char *)usx2y->in04_buf)[i]) {
202 if (diff < 0)
203 diff = i;
204 usx2y->in04_last[i] = ((char *)usx2y->in04_buf)[i];
205 }
206 }
207 }
208 if (diff >= 0) {
209 n = us428ctls->ctl_snapshot_last + 1;
210 if (n >= N_US428_CTL_BUFS || n < 0)
211 n = 0;
212 memcpy(us428ctls->ctl_snapshot + n, usx2y->in04_buf, sizeof(us428ctls->ctl_snapshot[0]));
213 us428ctls->ctl_snapshot_differs_at[n] = diff;
214 us428ctls->ctl_snapshot_last = n;
215 wake_up(&usx2y->us428ctls_wait_queue_head);
216 }
217 }
218
219 if (usx2y->us04) {
220 if (!usx2y->us04->submitted) {
221 do {
222 err = usb_submit_urb(usx2y->us04->urb[usx2y->us04->submitted++], GFP_ATOMIC);
223 } while (!err && usx2y->us04->submitted < usx2y->us04->len);
224 }
225 } else {
226 if (us428ctls && us428ctls->p4out_last >= 0 && us428ctls->p4out_last < N_US428_P4OUT_BUFS) {
227 if (us428ctls->p4out_last != us428ctls->p4out_sent) {
228 send = us428ctls->p4out_sent + 1;
229 if (send >= N_US428_P4OUT_BUFS)
230 send = 0;
231 for (j = 0; j < URBS_ASYNC_SEQ && !err; ++j) {
232 if (!usx2y->as04.urb[j]->status) {
233 p4out = us428ctls->p4out + send; // FIXME if more than 1 p4out is new, 1 gets lost.
234 usb_fill_bulk_urb(usx2y->as04.urb[j], usx2y->dev,
235 usb_sndbulkpipe(usx2y->dev, 0x04), &p4out->val.vol,
236 p4out->type == ELT_LIGHT ? sizeof(struct us428_lights) : 5,
237 i_usx2y_out04_int, usx2y);
238 err = usb_submit_urb(usx2y->as04.urb[j], GFP_ATOMIC);
239 us428ctls->p4out_sent = send;
240 break;
241 }
242 }
243 }
244 }
245 }
246
247 if (err)
248 snd_printk(KERN_ERR "in04_int() usb_submit_urb err=%i\n", err);
249
250 urb->dev = usx2y->dev;
251 usb_submit_urb(urb, GFP_ATOMIC);
252 }
253
254 /*
255 * Prepare some urbs
256 */
usx2y_async_seq04_init(struct usx2ydev * usx2y)257 int usx2y_async_seq04_init(struct usx2ydev *usx2y)
258 {
259 int err = 0, i;
260
261 if (WARN_ON(usx2y->as04.buffer))
262 return -EBUSY;
263
264 usx2y->as04.buffer = kmalloc_array(URBS_ASYNC_SEQ,
265 URB_DATA_LEN_ASYNC_SEQ, GFP_KERNEL);
266 if (!usx2y->as04.buffer) {
267 err = -ENOMEM;
268 } else {
269 for (i = 0; i < URBS_ASYNC_SEQ; ++i) {
270 usx2y->as04.urb[i] = usb_alloc_urb(0, GFP_KERNEL);
271 if (!usx2y->as04.urb[i]) {
272 err = -ENOMEM;
273 break;
274 }
275 usb_fill_bulk_urb(usx2y->as04.urb[i], usx2y->dev,
276 usb_sndbulkpipe(usx2y->dev, 0x04),
277 usx2y->as04.buffer + URB_DATA_LEN_ASYNC_SEQ * i, 0,
278 i_usx2y_out04_int, usx2y);
279 err = usb_urb_ep_type_check(usx2y->as04.urb[i]);
280 if (err < 0)
281 break;
282 }
283 }
284 if (err)
285 usx2y_unlinkseq(&usx2y->as04);
286 return err;
287 }
288
usx2y_in04_init(struct usx2ydev * usx2y)289 int usx2y_in04_init(struct usx2ydev *usx2y)
290 {
291 int err;
292
293 if (WARN_ON(usx2y->in04_urb))
294 return -EBUSY;
295
296 usx2y->in04_urb = usb_alloc_urb(0, GFP_KERNEL);
297 if (!usx2y->in04_urb) {
298 err = -ENOMEM;
299 goto error;
300 }
301
302 usx2y->in04_buf = kmalloc(21, GFP_KERNEL);
303 if (!usx2y->in04_buf) {
304 err = -ENOMEM;
305 goto error;
306 }
307
308 init_waitqueue_head(&usx2y->in04_wait_queue);
309 usb_fill_int_urb(usx2y->in04_urb, usx2y->dev, usb_rcvintpipe(usx2y->dev, 0x4),
310 usx2y->in04_buf, 21,
311 i_usx2y_in04_int, usx2y,
312 10);
313 if (usb_urb_ep_type_check(usx2y->in04_urb)) {
314 err = -EINVAL;
315 goto error;
316 }
317 return usb_submit_urb(usx2y->in04_urb, GFP_KERNEL);
318
319 error:
320 kfree(usx2y->in04_buf);
321 usb_free_urb(usx2y->in04_urb);
322 usx2y->in04_buf = NULL;
323 usx2y->in04_urb = NULL;
324 return err;
325 }
326
usx2y_unlinkseq(struct snd_usx2y_async_seq * s)327 static void usx2y_unlinkseq(struct snd_usx2y_async_seq *s)
328 {
329 int i;
330
331 for (i = 0; i < URBS_ASYNC_SEQ; ++i) {
332 if (!s->urb[i])
333 continue;
334 usb_kill_urb(s->urb[i]);
335 usb_free_urb(s->urb[i]);
336 s->urb[i] = NULL;
337 }
338 kfree(s->buffer);
339 s->buffer = NULL;
340 }
341
342 static const struct usb_device_id snd_usx2y_usb_id_table[] = {
343 {
344 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
345 .idVendor = 0x1604,
346 .idProduct = USB_ID_US428
347 },
348 {
349 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
350 .idVendor = 0x1604,
351 .idProduct = USB_ID_US122
352 },
353 {
354 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
355 .idVendor = 0x1604,
356 .idProduct = USB_ID_US224
357 },
358 { /* terminator */ }
359 };
360 MODULE_DEVICE_TABLE(usb, snd_usx2y_usb_id_table);
361
usx2y_create_card(struct usb_device * device,struct usb_interface * intf,struct snd_card ** cardp)362 static int usx2y_create_card(struct usb_device *device,
363 struct usb_interface *intf,
364 struct snd_card **cardp)
365 {
366 int dev;
367 struct snd_card *card;
368 int err;
369
370 for (dev = 0; dev < SNDRV_CARDS; ++dev)
371 if (enable[dev] && !snd_usx2y_card_used[dev])
372 break;
373 if (dev >= SNDRV_CARDS)
374 return -ENODEV;
375 err = snd_card_new(&intf->dev, index[dev], id[dev], THIS_MODULE,
376 sizeof(struct usx2ydev), &card);
377 if (err < 0)
378 return err;
379 snd_usx2y_card_used[usx2y(card)->card_index = dev] = 1;
380 card->private_free = snd_usx2y_card_private_free;
381 usx2y(card)->dev = device;
382 init_waitqueue_head(&usx2y(card)->prepare_wait_queue);
383 init_waitqueue_head(&usx2y(card)->us428ctls_wait_queue_head);
384 mutex_init(&usx2y(card)->pcm_mutex);
385 INIT_LIST_HEAD(&usx2y(card)->midi_list);
386 strcpy(card->driver, "USB "NAME_ALLCAPS"");
387 sprintf(card->shortname, "TASCAM "NAME_ALLCAPS"");
388 sprintf(card->longname, "%s (%x:%x if %d at %03d/%03d)",
389 card->shortname,
390 le16_to_cpu(device->descriptor.idVendor),
391 le16_to_cpu(device->descriptor.idProduct),
392 0,//us428(card)->usbmidi.ifnum,
393 usx2y(card)->dev->bus->busnum, usx2y(card)->dev->devnum);
394 *cardp = card;
395 return 0;
396 }
397
snd_usx2y_card_private_free(struct snd_card * card)398 static void snd_usx2y_card_private_free(struct snd_card *card)
399 {
400 struct usx2ydev *usx2y = usx2y(card);
401
402 kfree(usx2y->in04_buf);
403 usb_free_urb(usx2y->in04_urb);
404 if (usx2y->us428ctls_sharedmem)
405 free_pages_exact(usx2y->us428ctls_sharedmem,
406 US428_SHAREDMEM_PAGES);
407 if (usx2y->card_index >= 0 && usx2y->card_index < SNDRV_CARDS)
408 snd_usx2y_card_used[usx2y->card_index] = 0;
409 }
410
snd_usx2y_disconnect(struct usb_interface * intf)411 static void snd_usx2y_disconnect(struct usb_interface *intf)
412 {
413 struct snd_card *card;
414 struct usx2ydev *usx2y;
415 struct list_head *p;
416
417 card = usb_get_intfdata(intf);
418 if (!card)
419 return;
420 usx2y = usx2y(card);
421 usx2y->chip_status = USX2Y_STAT_CHIP_HUP;
422 usx2y_unlinkseq(&usx2y->as04);
423 usb_kill_urb(usx2y->in04_urb);
424 snd_card_disconnect(card);
425
426 /* release the midi resources */
427 list_for_each(p, &usx2y->midi_list) {
428 snd_usbmidi_disconnect(p);
429 }
430 if (usx2y->us428ctls_sharedmem)
431 wake_up(&usx2y->us428ctls_wait_queue_head);
432 snd_card_free_when_closed(card);
433 }
434
snd_usx2y_probe(struct usb_interface * intf,const struct usb_device_id * id)435 static int snd_usx2y_probe(struct usb_interface *intf,
436 const struct usb_device_id *id)
437 {
438 struct usb_device *device = interface_to_usbdev(intf);
439 struct snd_card *card;
440 int err;
441
442 #ifdef USX2Y_NRPACKS_VARIABLE
443 if (nrpacks < 0 || nrpacks > USX2Y_NRPACKS_MAX)
444 return -EINVAL;
445 #endif
446
447 if (le16_to_cpu(device->descriptor.idVendor) != 0x1604 ||
448 (le16_to_cpu(device->descriptor.idProduct) != USB_ID_US122 &&
449 le16_to_cpu(device->descriptor.idProduct) != USB_ID_US224 &&
450 le16_to_cpu(device->descriptor.idProduct) != USB_ID_US428))
451 return -EINVAL;
452
453 err = usx2y_create_card(device, intf, &card);
454 if (err < 0)
455 return err;
456 err = usx2y_hwdep_new(card, device);
457 if (err < 0)
458 goto error;
459 err = snd_card_register(card);
460 if (err < 0)
461 goto error;
462
463 dev_set_drvdata(&intf->dev, card);
464 return 0;
465
466 error:
467 snd_card_free(card);
468 return err;
469 }
470
471 static struct usb_driver snd_usx2y_usb_driver = {
472 .name = "snd-usb-usx2y",
473 .probe = snd_usx2y_probe,
474 .disconnect = snd_usx2y_disconnect,
475 .id_table = snd_usx2y_usb_id_table,
476 };
477 module_usb_driver(snd_usx2y_usb_driver);
478