1 /* 2 * Line 6 Linux USB driver 3 * 4 * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at) 5 * 6 * This program is free software; you can redistribute it and/or 7 * modify it under the terms of the GNU General Public License as 8 * published by the Free Software Foundation, version 2. 9 * 10 */ 11 12 #include <linux/kernel.h> 13 #include <linux/module.h> 14 #include <linux/export.h> 15 #include <linux/slab.h> 16 #include <linux/usb.h> 17 18 #include <sound/core.h> 19 #include <sound/initval.h> 20 21 #include "capture.h" 22 #include "driver.h" 23 #include "midi.h" 24 #include "playback.h" 25 26 #define DRIVER_AUTHOR "Markus Grabner <grabner@icg.tugraz.at>" 27 #define DRIVER_DESC "Line 6 USB Driver" 28 29 /* 30 This is Line 6's MIDI manufacturer ID. 31 */ 32 const unsigned char line6_midi_id[] = { 33 0x00, 0x01, 0x0c 34 }; 35 EXPORT_SYMBOL_GPL(line6_midi_id); 36 37 /* 38 Code to request version of POD, Variax interface 39 (and maybe other devices). 40 */ 41 static const char line6_request_version[] = { 42 0xf0, 0x7e, 0x7f, 0x06, 0x01, 0xf7 43 }; 44 45 /* 46 Class for asynchronous messages. 47 */ 48 struct message { 49 struct usb_line6 *line6; 50 const char *buffer; 51 int size; 52 int done; 53 }; 54 55 /* 56 Forward declarations. 57 */ 58 static void line6_data_received(struct urb *urb); 59 static int line6_send_raw_message_async_part(struct message *msg, 60 struct urb *urb); 61 62 /* 63 Start to listen on endpoint. 64 */ 65 static int line6_start_listen(struct usb_line6 *line6) 66 { 67 int err; 68 69 usb_fill_int_urb(line6->urb_listen, line6->usbdev, 70 usb_rcvintpipe(line6->usbdev, line6->properties->ep_ctrl_r), 71 line6->buffer_listen, LINE6_BUFSIZE_LISTEN, 72 line6_data_received, line6, line6->interval); 73 line6->urb_listen->actual_length = 0; 74 err = usb_submit_urb(line6->urb_listen, GFP_ATOMIC); 75 return err; 76 } 77 78 /* 79 Stop listening on endpoint. 80 */ 81 static void line6_stop_listen(struct usb_line6 *line6) 82 { 83 usb_kill_urb(line6->urb_listen); 84 } 85 86 /* 87 Send raw message in pieces of wMaxPacketSize bytes. 88 */ 89 static int line6_send_raw_message(struct usb_line6 *line6, const char *buffer, 90 int size) 91 { 92 int i, done = 0; 93 94 for (i = 0; i < size; i += line6->max_packet_size) { 95 int partial; 96 const char *frag_buf = buffer + i; 97 int frag_size = min(line6->max_packet_size, size - i); 98 int retval; 99 100 retval = usb_interrupt_msg(line6->usbdev, 101 usb_sndintpipe(line6->usbdev, 102 line6->properties->ep_ctrl_w), 103 (char *)frag_buf, frag_size, 104 &partial, LINE6_TIMEOUT * HZ); 105 106 if (retval) { 107 dev_err(line6->ifcdev, 108 "usb_interrupt_msg failed (%d)\n", retval); 109 break; 110 } 111 112 done += frag_size; 113 } 114 115 return done; 116 } 117 118 /* 119 Notification of completion of asynchronous request transmission. 120 */ 121 static void line6_async_request_sent(struct urb *urb) 122 { 123 struct message *msg = (struct message *)urb->context; 124 125 if (msg->done >= msg->size) { 126 usb_free_urb(urb); 127 kfree(msg); 128 } else 129 line6_send_raw_message_async_part(msg, urb); 130 } 131 132 /* 133 Asynchronously send part of a raw message. 134 */ 135 static int line6_send_raw_message_async_part(struct message *msg, 136 struct urb *urb) 137 { 138 int retval; 139 struct usb_line6 *line6 = msg->line6; 140 int done = msg->done; 141 int bytes = min(msg->size - done, line6->max_packet_size); 142 143 usb_fill_int_urb(urb, line6->usbdev, 144 usb_sndintpipe(line6->usbdev, line6->properties->ep_ctrl_w), 145 (char *)msg->buffer + done, bytes, 146 line6_async_request_sent, msg, line6->interval); 147 148 msg->done += bytes; 149 retval = usb_submit_urb(urb, GFP_ATOMIC); 150 151 if (retval < 0) { 152 dev_err(line6->ifcdev, "%s: usb_submit_urb failed (%d)\n", 153 __func__, retval); 154 usb_free_urb(urb); 155 kfree(msg); 156 return retval; 157 } 158 159 return 0; 160 } 161 162 /* 163 Setup and start timer. 164 */ 165 void line6_start_timer(struct timer_list *timer, unsigned long msecs, 166 void (*function)(unsigned long), unsigned long data) 167 { 168 setup_timer(timer, function, data); 169 mod_timer(timer, jiffies + msecs_to_jiffies(msecs)); 170 } 171 EXPORT_SYMBOL_GPL(line6_start_timer); 172 173 /* 174 Asynchronously send raw message. 175 */ 176 int line6_send_raw_message_async(struct usb_line6 *line6, const char *buffer, 177 int size) 178 { 179 struct message *msg; 180 struct urb *urb; 181 182 /* create message: */ 183 msg = kmalloc(sizeof(struct message), GFP_ATOMIC); 184 if (msg == NULL) 185 return -ENOMEM; 186 187 /* create URB: */ 188 urb = usb_alloc_urb(0, GFP_ATOMIC); 189 190 if (urb == NULL) { 191 kfree(msg); 192 return -ENOMEM; 193 } 194 195 /* set message data: */ 196 msg->line6 = line6; 197 msg->buffer = buffer; 198 msg->size = size; 199 msg->done = 0; 200 201 /* start sending: */ 202 return line6_send_raw_message_async_part(msg, urb); 203 } 204 EXPORT_SYMBOL_GPL(line6_send_raw_message_async); 205 206 /* 207 Send asynchronous device version request. 208 */ 209 int line6_version_request_async(struct usb_line6 *line6) 210 { 211 char *buffer; 212 int retval; 213 214 buffer = kmemdup(line6_request_version, 215 sizeof(line6_request_version), GFP_ATOMIC); 216 if (buffer == NULL) 217 return -ENOMEM; 218 219 retval = line6_send_raw_message_async(line6, buffer, 220 sizeof(line6_request_version)); 221 kfree(buffer); 222 return retval; 223 } 224 EXPORT_SYMBOL_GPL(line6_version_request_async); 225 226 /* 227 Send sysex message in pieces of wMaxPacketSize bytes. 228 */ 229 int line6_send_sysex_message(struct usb_line6 *line6, const char *buffer, 230 int size) 231 { 232 return line6_send_raw_message(line6, buffer, 233 size + SYSEX_EXTRA_SIZE) - 234 SYSEX_EXTRA_SIZE; 235 } 236 EXPORT_SYMBOL_GPL(line6_send_sysex_message); 237 238 /* 239 Allocate buffer for sysex message and prepare header. 240 @param code sysex message code 241 @param size number of bytes between code and sysex end 242 */ 243 char *line6_alloc_sysex_buffer(struct usb_line6 *line6, int code1, int code2, 244 int size) 245 { 246 char *buffer = kmalloc(size + SYSEX_EXTRA_SIZE, GFP_ATOMIC); 247 248 if (!buffer) 249 return NULL; 250 251 buffer[0] = LINE6_SYSEX_BEGIN; 252 memcpy(buffer + 1, line6_midi_id, sizeof(line6_midi_id)); 253 buffer[sizeof(line6_midi_id) + 1] = code1; 254 buffer[sizeof(line6_midi_id) + 2] = code2; 255 buffer[sizeof(line6_midi_id) + 3 + size] = LINE6_SYSEX_END; 256 return buffer; 257 } 258 EXPORT_SYMBOL_GPL(line6_alloc_sysex_buffer); 259 260 /* 261 Notification of data received from the Line 6 device. 262 */ 263 static void line6_data_received(struct urb *urb) 264 { 265 struct usb_line6 *line6 = (struct usb_line6 *)urb->context; 266 struct midi_buffer *mb = &line6->line6midi->midibuf_in; 267 int done; 268 269 if (urb->status == -ESHUTDOWN) 270 return; 271 272 done = 273 line6_midibuf_write(mb, urb->transfer_buffer, urb->actual_length); 274 275 if (done < urb->actual_length) { 276 line6_midibuf_ignore(mb, done); 277 dev_dbg(line6->ifcdev, "%d %d buffer overflow - message skipped\n", 278 done, urb->actual_length); 279 } 280 281 for (;;) { 282 done = 283 line6_midibuf_read(mb, line6->buffer_message, 284 LINE6_MESSAGE_MAXLEN); 285 286 if (done == 0) 287 break; 288 289 line6->message_length = done; 290 line6_midi_receive(line6, line6->buffer_message, done); 291 292 if (line6->process_message) 293 line6->process_message(line6); 294 } 295 296 line6_start_listen(line6); 297 } 298 299 /* 300 Read data from device. 301 */ 302 int line6_read_data(struct usb_line6 *line6, int address, void *data, 303 size_t datalen) 304 { 305 struct usb_device *usbdev = line6->usbdev; 306 int ret; 307 unsigned char len; 308 309 /* query the serial number: */ 310 ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0), 0x67, 311 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT, 312 (datalen << 8) | 0x21, address, 313 NULL, 0, LINE6_TIMEOUT * HZ); 314 315 if (ret < 0) { 316 dev_err(line6->ifcdev, "read request failed (error %d)\n", ret); 317 return ret; 318 } 319 320 /* Wait for data length. We'll get 0xff until length arrives. */ 321 do { 322 ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0), 0x67, 323 USB_TYPE_VENDOR | USB_RECIP_DEVICE | 324 USB_DIR_IN, 325 0x0012, 0x0000, &len, 1, 326 LINE6_TIMEOUT * HZ); 327 if (ret < 0) { 328 dev_err(line6->ifcdev, 329 "receive length failed (error %d)\n", ret); 330 return ret; 331 } 332 } while (len == 0xff); 333 334 if (len != datalen) { 335 /* should be equal or something went wrong */ 336 dev_err(line6->ifcdev, 337 "length mismatch (expected %d, got %d)\n", 338 (int)datalen, (int)len); 339 return -EINVAL; 340 } 341 342 /* receive the result: */ 343 ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0), 0x67, 344 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN, 345 0x0013, 0x0000, data, datalen, 346 LINE6_TIMEOUT * HZ); 347 348 if (ret < 0) { 349 dev_err(line6->ifcdev, "read failed (error %d)\n", ret); 350 return ret; 351 } 352 353 return 0; 354 } 355 EXPORT_SYMBOL_GPL(line6_read_data); 356 357 /* 358 Write data to device. 359 */ 360 int line6_write_data(struct usb_line6 *line6, int address, void *data, 361 size_t datalen) 362 { 363 struct usb_device *usbdev = line6->usbdev; 364 int ret; 365 unsigned char status; 366 367 ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0), 0x67, 368 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT, 369 0x0022, address, data, datalen, 370 LINE6_TIMEOUT * HZ); 371 372 if (ret < 0) { 373 dev_err(line6->ifcdev, 374 "write request failed (error %d)\n", ret); 375 return ret; 376 } 377 378 do { 379 ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0), 380 0x67, 381 USB_TYPE_VENDOR | USB_RECIP_DEVICE | 382 USB_DIR_IN, 383 0x0012, 0x0000, 384 &status, 1, LINE6_TIMEOUT * HZ); 385 386 if (ret < 0) { 387 dev_err(line6->ifcdev, 388 "receiving status failed (error %d)\n", ret); 389 return ret; 390 } 391 } while (status == 0xff); 392 393 if (status != 0) { 394 dev_err(line6->ifcdev, "write failed (error %d)\n", ret); 395 return -EINVAL; 396 } 397 398 return 0; 399 } 400 EXPORT_SYMBOL_GPL(line6_write_data); 401 402 /* 403 Read Line 6 device serial number. 404 (POD, TonePort, GuitarPort) 405 */ 406 int line6_read_serial_number(struct usb_line6 *line6, int *serial_number) 407 { 408 return line6_read_data(line6, 0x80d0, serial_number, 409 sizeof(*serial_number)); 410 } 411 EXPORT_SYMBOL_GPL(line6_read_serial_number); 412 413 /* 414 Card destructor. 415 */ 416 static void line6_destruct(struct snd_card *card) 417 { 418 struct usb_line6 *line6 = card->private_data; 419 struct usb_device *usbdev = line6->usbdev; 420 421 /* free buffer memory first: */ 422 kfree(line6->buffer_message); 423 kfree(line6->buffer_listen); 424 425 /* then free URBs: */ 426 usb_free_urb(line6->urb_listen); 427 428 /* decrement reference counters: */ 429 usb_put_dev(usbdev); 430 } 431 432 /* get data from endpoint descriptor (see usb_maxpacket): */ 433 static void line6_get_interval(struct usb_line6 *line6) 434 { 435 struct usb_device *usbdev = line6->usbdev; 436 struct usb_host_endpoint *ep; 437 unsigned pipe = usb_rcvintpipe(usbdev, line6->properties->ep_ctrl_r); 438 unsigned epnum = usb_pipeendpoint(pipe); 439 440 ep = usbdev->ep_in[epnum]; 441 if (ep) { 442 line6->interval = ep->desc.bInterval; 443 line6->max_packet_size = le16_to_cpu(ep->desc.wMaxPacketSize); 444 } else { 445 dev_err(line6->ifcdev, 446 "endpoint not available, using fallback values"); 447 line6->interval = LINE6_FALLBACK_INTERVAL; 448 line6->max_packet_size = LINE6_FALLBACK_MAXPACKETSIZE; 449 } 450 } 451 452 static int line6_init_cap_control(struct usb_line6 *line6) 453 { 454 int ret; 455 456 /* initialize USB buffers: */ 457 line6->buffer_listen = kmalloc(LINE6_BUFSIZE_LISTEN, GFP_KERNEL); 458 if (!line6->buffer_listen) 459 return -ENOMEM; 460 461 line6->buffer_message = kmalloc(LINE6_MESSAGE_MAXLEN, GFP_KERNEL); 462 if (!line6->buffer_message) 463 return -ENOMEM; 464 465 line6->urb_listen = usb_alloc_urb(0, GFP_KERNEL); 466 if (!line6->urb_listen) 467 return -ENOMEM; 468 469 ret = line6_start_listen(line6); 470 if (ret < 0) { 471 dev_err(line6->ifcdev, "cannot start listening: %d\n", ret); 472 return ret; 473 } 474 475 return 0; 476 } 477 478 /* 479 Probe USB device. 480 */ 481 int line6_probe(struct usb_interface *interface, 482 const struct usb_device_id *id, 483 const struct line6_properties *properties, 484 int (*private_init)(struct usb_line6 *, const struct usb_device_id *id), 485 size_t data_size) 486 { 487 struct usb_device *usbdev = interface_to_usbdev(interface); 488 struct snd_card *card; 489 struct usb_line6 *line6; 490 int interface_number; 491 int ret; 492 493 if (WARN_ON(data_size < sizeof(*line6))) 494 return -EINVAL; 495 496 /* we don't handle multiple configurations */ 497 if (usbdev->descriptor.bNumConfigurations != 1) 498 return -ENODEV; 499 500 ret = snd_card_new(&interface->dev, 501 SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1, 502 THIS_MODULE, data_size, &card); 503 if (ret < 0) 504 return ret; 505 506 /* store basic data: */ 507 line6 = card->private_data; 508 line6->card = card; 509 line6->properties = properties; 510 line6->usbdev = usbdev; 511 line6->ifcdev = &interface->dev; 512 513 strcpy(card->id, properties->id); 514 strcpy(card->driver, DRIVER_NAME); 515 strcpy(card->shortname, properties->name); 516 sprintf(card->longname, "Line 6 %s at USB %s", properties->name, 517 dev_name(line6->ifcdev)); 518 card->private_free = line6_destruct; 519 520 usb_set_intfdata(interface, line6); 521 522 /* increment reference counters: */ 523 usb_get_dev(usbdev); 524 525 /* initialize device info: */ 526 dev_info(&interface->dev, "Line 6 %s found\n", properties->name); 527 528 /* query interface number */ 529 interface_number = interface->cur_altsetting->desc.bInterfaceNumber; 530 531 ret = usb_set_interface(usbdev, interface_number, 532 properties->altsetting); 533 if (ret < 0) { 534 dev_err(&interface->dev, "set_interface failed\n"); 535 goto error; 536 } 537 538 line6_get_interval(line6); 539 540 if (properties->capabilities & LINE6_CAP_CONTROL) { 541 ret = line6_init_cap_control(line6); 542 if (ret < 0) 543 goto error; 544 } 545 546 /* initialize device data based on device: */ 547 ret = private_init(line6, id); 548 if (ret < 0) 549 goto error; 550 551 /* creation of additional special files should go here */ 552 553 dev_info(&interface->dev, "Line 6 %s now attached\n", 554 properties->name); 555 556 return 0; 557 558 error: 559 if (line6->disconnect) 560 line6->disconnect(line6); 561 snd_card_free(card); 562 return ret; 563 } 564 EXPORT_SYMBOL_GPL(line6_probe); 565 566 /* 567 Line 6 device disconnected. 568 */ 569 void line6_disconnect(struct usb_interface *interface) 570 { 571 struct usb_line6 *line6 = usb_get_intfdata(interface); 572 struct usb_device *usbdev = interface_to_usbdev(interface); 573 574 if (!line6) 575 return; 576 577 if (WARN_ON(usbdev != line6->usbdev)) 578 return; 579 580 if (line6->urb_listen != NULL) 581 line6_stop_listen(line6); 582 583 snd_card_disconnect(line6->card); 584 if (line6->line6pcm) 585 line6_pcm_disconnect(line6->line6pcm); 586 if (line6->disconnect) 587 line6->disconnect(line6); 588 589 dev_info(&interface->dev, "Line 6 %s now disconnected\n", 590 line6->properties->name); 591 592 /* make sure the device isn't destructed twice: */ 593 usb_set_intfdata(interface, NULL); 594 595 snd_card_free_when_closed(line6->card); 596 } 597 EXPORT_SYMBOL_GPL(line6_disconnect); 598 599 #ifdef CONFIG_PM 600 601 /* 602 Suspend Line 6 device. 603 */ 604 int line6_suspend(struct usb_interface *interface, pm_message_t message) 605 { 606 struct usb_line6 *line6 = usb_get_intfdata(interface); 607 struct snd_line6_pcm *line6pcm = line6->line6pcm; 608 609 snd_power_change_state(line6->card, SNDRV_CTL_POWER_D3hot); 610 611 if (line6->properties->capabilities & LINE6_CAP_CONTROL) 612 line6_stop_listen(line6); 613 614 if (line6pcm != NULL) { 615 snd_pcm_suspend_all(line6pcm->pcm); 616 line6pcm->flags = 0; 617 } 618 619 return 0; 620 } 621 EXPORT_SYMBOL_GPL(line6_suspend); 622 623 /* 624 Resume Line 6 device. 625 */ 626 int line6_resume(struct usb_interface *interface) 627 { 628 struct usb_line6 *line6 = usb_get_intfdata(interface); 629 630 if (line6->properties->capabilities & LINE6_CAP_CONTROL) 631 line6_start_listen(line6); 632 633 snd_power_change_state(line6->card, SNDRV_CTL_POWER_D0); 634 return 0; 635 } 636 EXPORT_SYMBOL_GPL(line6_resume); 637 638 #endif /* CONFIG_PM */ 639 640 MODULE_AUTHOR(DRIVER_AUTHOR); 641 MODULE_DESCRIPTION(DRIVER_DESC); 642 MODULE_LICENSE("GPL"); 643