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