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