2 * Line 6 Linux USB driver
4 * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at)
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.
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>
18 #include <sound/core.h>
19 #include <sound/initval.h>
26 #define DRIVER_AUTHOR "Markus Grabner <grabner@icg.tugraz.at>"
27 #define DRIVER_DESC "Line 6 USB Driver"
30 This is Line 6's MIDI manufacturer ID.
32 const unsigned char line6_midi_id[] = {
35 EXPORT_SYMBOL_GPL(line6_midi_id);
38 Code to request version of POD, Variax interface
39 (and maybe other devices).
41 static const char line6_request_version[] = {
42 0xf0, 0x7e, 0x7f, 0x06, 0x01, 0xf7
46 Class for asynchronous messages.
49 struct usb_line6 *line6;
58 static void line6_data_received(struct urb *urb);
59 static int line6_send_raw_message_async_part(struct message *msg,
63 Start to listen on endpoint.
65 static int line6_start_listen(struct usb_line6 *line6)
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);
79 Stop listening on endpoint.
81 static void line6_stop_listen(struct usb_line6 *line6)
83 usb_kill_urb(line6->urb_listen);
87 Send raw message in pieces of wMaxPacketSize bytes.
89 static int line6_send_raw_message(struct usb_line6 *line6, const char *buffer,
94 for (i = 0; i < size; i += line6->max_packet_size) {
96 const char *frag_buf = buffer + i;
97 int frag_size = min(line6->max_packet_size, size - i);
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);
107 dev_err(line6->ifcdev,
108 "usb_interrupt_msg failed (%d)\n", retval);
119 Notification of completion of asynchronous request transmission.
121 static void line6_async_request_sent(struct urb *urb)
123 struct message *msg = (struct message *)urb->context;
125 if (msg->done >= msg->size) {
129 line6_send_raw_message_async_part(msg, urb);
133 Asynchronously send part of a raw message.
135 static int line6_send_raw_message_async_part(struct message *msg,
139 struct usb_line6 *line6 = msg->line6;
140 int done = msg->done;
141 int bytes = min(msg->size - done, line6->max_packet_size);
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);
149 retval = usb_submit_urb(urb, GFP_ATOMIC);
152 dev_err(line6->ifcdev, "%s: usb_submit_urb failed (%d)\n",
163 Setup and start timer.
165 void line6_start_timer(struct timer_list *timer, unsigned long msecs,
166 void (*function)(unsigned long), unsigned long data)
168 setup_timer(timer, function, data);
169 mod_timer(timer, jiffies + msecs_to_jiffies(msecs));
171 EXPORT_SYMBOL_GPL(line6_start_timer);
174 Asynchronously send raw message.
176 int line6_send_raw_message_async(struct usb_line6 *line6, const char *buffer,
182 /* create message: */
183 msg = kmalloc(sizeof(struct message), GFP_ATOMIC);
188 urb = usb_alloc_urb(0, GFP_ATOMIC);
195 /* set message data: */
197 msg->buffer = buffer;
202 return line6_send_raw_message_async_part(msg, urb);
204 EXPORT_SYMBOL_GPL(line6_send_raw_message_async);
207 Send asynchronous device version request.
209 int line6_version_request_async(struct usb_line6 *line6)
214 buffer = kmemdup(line6_request_version,
215 sizeof(line6_request_version), GFP_ATOMIC);
219 retval = line6_send_raw_message_async(line6, buffer,
220 sizeof(line6_request_version));
224 EXPORT_SYMBOL_GPL(line6_version_request_async);
227 Send sysex message in pieces of wMaxPacketSize bytes.
229 int line6_send_sysex_message(struct usb_line6 *line6, const char *buffer,
232 return line6_send_raw_message(line6, buffer,
233 size + SYSEX_EXTRA_SIZE) -
236 EXPORT_SYMBOL_GPL(line6_send_sysex_message);
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
243 char *line6_alloc_sysex_buffer(struct usb_line6 *line6, int code1, int code2,
246 char *buffer = kmalloc(size + SYSEX_EXTRA_SIZE, GFP_ATOMIC);
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;
258 EXPORT_SYMBOL_GPL(line6_alloc_sysex_buffer);
261 Notification of data received from the Line 6 device.
263 static void line6_data_received(struct urb *urb)
265 struct usb_line6 *line6 = (struct usb_line6 *)urb->context;
266 struct midi_buffer *mb = &line6->line6midi->midibuf_in;
269 if (urb->status == -ESHUTDOWN)
273 line6_midibuf_write(mb, urb->transfer_buffer, urb->actual_length);
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);
283 line6_midibuf_read(mb, line6->buffer_message,
284 LINE6_MESSAGE_MAXLEN);
289 line6->message_length = done;
290 line6_midi_receive(line6, line6->buffer_message, done);
292 if (line6->process_message)
293 line6->process_message(line6);
296 line6_start_listen(line6);
299 #define LINE6_READ_WRITE_STATUS_DELAY 2 /* milliseconds */
302 Read data from device.
304 int line6_read_data(struct usb_line6 *line6, int address, void *data,
307 struct usb_device *usbdev = line6->usbdev;
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);
318 dev_err(line6->ifcdev, "read request failed (error %d)\n", ret);
322 /* Wait for data length. We'll get 0xff until length arrives. */
324 mdelay(LINE6_READ_WRITE_STATUS_DELAY);
326 ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0), 0x67,
327 USB_TYPE_VENDOR | USB_RECIP_DEVICE |
329 0x0012, 0x0000, &len, 1,
332 dev_err(line6->ifcdev,
333 "receive length failed (error %d)\n", ret);
336 } while (len == 0xff);
338 if (len != datalen) {
339 /* should be equal or something went wrong */
340 dev_err(line6->ifcdev,
341 "length mismatch (expected %d, got %d)\n",
342 (int)datalen, (int)len);
346 /* receive the result: */
347 ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0), 0x67,
348 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
349 0x0013, 0x0000, data, datalen,
353 dev_err(line6->ifcdev, "read failed (error %d)\n", ret);
359 EXPORT_SYMBOL_GPL(line6_read_data);
362 Write data to device.
364 int line6_write_data(struct usb_line6 *line6, int address, void *data,
367 struct usb_device *usbdev = line6->usbdev;
369 unsigned char status;
371 ret = usb_control_msg(usbdev, usb_sndctrlpipe(usbdev, 0), 0x67,
372 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
373 0x0022, address, data, datalen,
377 dev_err(line6->ifcdev,
378 "write request failed (error %d)\n", ret);
383 mdelay(LINE6_READ_WRITE_STATUS_DELAY);
385 ret = usb_control_msg(usbdev, usb_rcvctrlpipe(usbdev, 0),
387 USB_TYPE_VENDOR | USB_RECIP_DEVICE |
390 &status, 1, LINE6_TIMEOUT * HZ);
393 dev_err(line6->ifcdev,
394 "receiving status failed (error %d)\n", ret);
397 } while (status == 0xff);
400 dev_err(line6->ifcdev, "write failed (error %d)\n", ret);
406 EXPORT_SYMBOL_GPL(line6_write_data);
409 Read Line 6 device serial number.
410 (POD, TonePort, GuitarPort)
412 int line6_read_serial_number(struct usb_line6 *line6, int *serial_number)
414 return line6_read_data(line6, 0x80d0, serial_number,
415 sizeof(*serial_number));
417 EXPORT_SYMBOL_GPL(line6_read_serial_number);
422 static void line6_destruct(struct snd_card *card)
424 struct usb_line6 *line6 = card->private_data;
425 struct usb_device *usbdev = line6->usbdev;
427 /* free buffer memory first: */
428 kfree(line6->buffer_message);
429 kfree(line6->buffer_listen);
431 /* then free URBs: */
432 usb_free_urb(line6->urb_listen);
434 /* decrement reference counters: */
438 /* get data from endpoint descriptor (see usb_maxpacket): */
439 static void line6_get_interval(struct usb_line6 *line6)
441 struct usb_device *usbdev = line6->usbdev;
442 struct usb_host_endpoint *ep;
443 unsigned pipe = usb_rcvintpipe(usbdev, line6->properties->ep_ctrl_r);
444 unsigned epnum = usb_pipeendpoint(pipe);
446 ep = usbdev->ep_in[epnum];
448 line6->interval = ep->desc.bInterval;
449 line6->max_packet_size = le16_to_cpu(ep->desc.wMaxPacketSize);
451 dev_err(line6->ifcdev,
452 "endpoint not available, using fallback values");
453 line6->interval = LINE6_FALLBACK_INTERVAL;
454 line6->max_packet_size = LINE6_FALLBACK_MAXPACKETSIZE;
458 static int line6_init_cap_control(struct usb_line6 *line6)
462 /* initialize USB buffers: */
463 line6->buffer_listen = kmalloc(LINE6_BUFSIZE_LISTEN, GFP_KERNEL);
464 if (!line6->buffer_listen)
467 line6->buffer_message = kmalloc(LINE6_MESSAGE_MAXLEN, GFP_KERNEL);
468 if (!line6->buffer_message)
471 line6->urb_listen = usb_alloc_urb(0, GFP_KERNEL);
472 if (!line6->urb_listen)
475 ret = line6_start_listen(line6);
477 dev_err(line6->ifcdev, "cannot start listening: %d\n", ret);
487 int line6_probe(struct usb_interface *interface,
488 const struct usb_device_id *id,
489 const char *driver_name,
490 const struct line6_properties *properties,
491 int (*private_init)(struct usb_line6 *, const struct usb_device_id *id),
494 struct usb_device *usbdev = interface_to_usbdev(interface);
495 struct snd_card *card;
496 struct usb_line6 *line6;
497 int interface_number;
500 if (WARN_ON(data_size < sizeof(*line6)))
503 /* we don't handle multiple configurations */
504 if (usbdev->descriptor.bNumConfigurations != 1)
507 ret = snd_card_new(&interface->dev,
508 SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
509 THIS_MODULE, data_size, &card);
513 /* store basic data: */
514 line6 = card->private_data;
516 line6->properties = properties;
517 line6->usbdev = usbdev;
518 line6->ifcdev = &interface->dev;
520 strcpy(card->id, properties->id);
521 strcpy(card->driver, driver_name);
522 strcpy(card->shortname, properties->name);
523 sprintf(card->longname, "Line 6 %s at USB %s", properties->name,
524 dev_name(line6->ifcdev));
525 card->private_free = line6_destruct;
527 usb_set_intfdata(interface, line6);
529 /* increment reference counters: */
532 /* initialize device info: */
533 dev_info(&interface->dev, "Line 6 %s found\n", properties->name);
535 /* query interface number */
536 interface_number = interface->cur_altsetting->desc.bInterfaceNumber;
538 ret = usb_set_interface(usbdev, interface_number,
539 properties->altsetting);
541 dev_err(&interface->dev, "set_interface failed\n");
545 line6_get_interval(line6);
547 if (properties->capabilities & LINE6_CAP_CONTROL) {
548 ret = line6_init_cap_control(line6);
553 /* initialize device data based on device: */
554 ret = private_init(line6, id);
558 /* creation of additional special files should go here */
560 dev_info(&interface->dev, "Line 6 %s now attached\n",
566 if (line6->disconnect)
567 line6->disconnect(line6);
571 EXPORT_SYMBOL_GPL(line6_probe);
574 Line 6 device disconnected.
576 void line6_disconnect(struct usb_interface *interface)
578 struct usb_line6 *line6 = usb_get_intfdata(interface);
579 struct usb_device *usbdev = interface_to_usbdev(interface);
584 if (WARN_ON(usbdev != line6->usbdev))
587 if (line6->urb_listen != NULL)
588 line6_stop_listen(line6);
590 snd_card_disconnect(line6->card);
592 line6_pcm_disconnect(line6->line6pcm);
593 if (line6->disconnect)
594 line6->disconnect(line6);
596 dev_info(&interface->dev, "Line 6 %s now disconnected\n",
597 line6->properties->name);
599 /* make sure the device isn't destructed twice: */
600 usb_set_intfdata(interface, NULL);
602 snd_card_free_when_closed(line6->card);
604 EXPORT_SYMBOL_GPL(line6_disconnect);
609 Suspend Line 6 device.
611 int line6_suspend(struct usb_interface *interface, pm_message_t message)
613 struct usb_line6 *line6 = usb_get_intfdata(interface);
614 struct snd_line6_pcm *line6pcm = line6->line6pcm;
616 snd_power_change_state(line6->card, SNDRV_CTL_POWER_D3hot);
618 if (line6->properties->capabilities & LINE6_CAP_CONTROL)
619 line6_stop_listen(line6);
621 if (line6pcm != NULL) {
622 snd_pcm_suspend_all(line6pcm->pcm);
628 EXPORT_SYMBOL_GPL(line6_suspend);
631 Resume Line 6 device.
633 int line6_resume(struct usb_interface *interface)
635 struct usb_line6 *line6 = usb_get_intfdata(interface);
637 if (line6->properties->capabilities & LINE6_CAP_CONTROL)
638 line6_start_listen(line6);
640 snd_power_change_state(line6->card, SNDRV_CTL_POWER_D0);
643 EXPORT_SYMBOL_GPL(line6_resume);
645 #endif /* CONFIG_PM */
647 MODULE_AUTHOR(DRIVER_AUTHOR);
648 MODULE_DESCRIPTION(DRIVER_DESC);
649 MODULE_LICENSE("GPL");