1 // SPDX-License-Identifier: GPL-2.0-only
3 * Line 6 Linux USB driver
5 * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at)
8 #include <linux/kernel.h>
9 #include <linux/module.h>
10 #include <linux/export.h>
11 #include <linux/slab.h>
12 #include <linux/usb.h>
14 #include <sound/core.h>
15 #include <sound/initval.h>
16 #include <sound/hwdep.h>
23 #define DRIVER_AUTHOR "Markus Grabner <grabner@icg.tugraz.at>"
24 #define DRIVER_DESC "Line 6 USB Driver"
27 This is Line 6's MIDI manufacturer ID.
29 const unsigned char line6_midi_id[3] = {
32 EXPORT_SYMBOL_GPL(line6_midi_id);
35 Code to request version of POD, Variax interface
36 (and maybe other devices).
38 static const char line6_request_version[] = {
39 0xf0, 0x7e, 0x7f, 0x06, 0x01, 0xf7
43 Class for asynchronous messages.
46 struct usb_line6 *line6;
55 static void line6_data_received(struct urb *urb);
56 static int line6_send_raw_message_async_part(struct message *msg,
60 Start to listen on endpoint.
62 static int line6_start_listen(struct usb_line6 *line6)
66 if (line6->properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
67 usb_fill_int_urb(line6->urb_listen, line6->usbdev,
68 usb_rcvintpipe(line6->usbdev, line6->properties->ep_ctrl_r),
69 line6->buffer_listen, LINE6_BUFSIZE_LISTEN,
70 line6_data_received, line6, line6->interval);
72 usb_fill_bulk_urb(line6->urb_listen, line6->usbdev,
73 usb_rcvbulkpipe(line6->usbdev, line6->properties->ep_ctrl_r),
74 line6->buffer_listen, LINE6_BUFSIZE_LISTEN,
75 line6_data_received, line6);
78 /* sanity checks of EP before actually submitting */
79 if (usb_urb_ep_type_check(line6->urb_listen)) {
80 dev_err(line6->ifcdev, "invalid control EP\n");
84 line6->urb_listen->actual_length = 0;
85 err = usb_submit_urb(line6->urb_listen, GFP_ATOMIC);
90 Stop listening on endpoint.
92 static void line6_stop_listen(struct usb_line6 *line6)
94 usb_kill_urb(line6->urb_listen);
98 Send raw message in pieces of wMaxPacketSize bytes.
100 int line6_send_raw_message(struct usb_line6 *line6, const char *buffer,
104 const struct line6_properties *properties = line6->properties;
106 for (i = 0; i < size; i += line6->max_packet_size) {
108 const char *frag_buf = buffer + i;
109 int frag_size = min(line6->max_packet_size, size - i);
112 if (properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
113 retval = usb_interrupt_msg(line6->usbdev,
114 usb_sndintpipe(line6->usbdev, properties->ep_ctrl_w),
115 (char *)frag_buf, frag_size,
116 &partial, LINE6_TIMEOUT);
118 retval = usb_bulk_msg(line6->usbdev,
119 usb_sndbulkpipe(line6->usbdev, properties->ep_ctrl_w),
120 (char *)frag_buf, frag_size,
121 &partial, LINE6_TIMEOUT);
125 dev_err(line6->ifcdev,
126 "usb_bulk_msg failed (%d)\n", retval);
135 EXPORT_SYMBOL_GPL(line6_send_raw_message);
138 Notification of completion of asynchronous request transmission.
140 static void line6_async_request_sent(struct urb *urb)
142 struct message *msg = (struct message *)urb->context;
144 if (msg->done >= msg->size) {
148 line6_send_raw_message_async_part(msg, urb);
152 Asynchronously send part of a raw message.
154 static int line6_send_raw_message_async_part(struct message *msg,
158 struct usb_line6 *line6 = msg->line6;
159 int done = msg->done;
160 int bytes = min(msg->size - done, line6->max_packet_size);
162 if (line6->properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
163 usb_fill_int_urb(urb, line6->usbdev,
164 usb_sndintpipe(line6->usbdev, line6->properties->ep_ctrl_w),
165 (char *)msg->buffer + done, bytes,
166 line6_async_request_sent, msg, line6->interval);
168 usb_fill_bulk_urb(urb, line6->usbdev,
169 usb_sndbulkpipe(line6->usbdev, line6->properties->ep_ctrl_w),
170 (char *)msg->buffer + done, bytes,
171 line6_async_request_sent, msg);
176 /* sanity checks of EP before actually submitting */
177 retval = usb_urb_ep_type_check(urb);
181 retval = usb_submit_urb(urb, GFP_ATOMIC);
188 dev_err(line6->ifcdev, "%s: usb_submit_urb failed (%d)\n",
196 Asynchronously send raw message.
198 int line6_send_raw_message_async(struct usb_line6 *line6, const char *buffer,
204 /* create message: */
205 msg = kmalloc(sizeof(struct message), GFP_ATOMIC);
210 urb = usb_alloc_urb(0, GFP_ATOMIC);
217 /* set message data: */
219 msg->buffer = buffer;
224 return line6_send_raw_message_async_part(msg, urb);
226 EXPORT_SYMBOL_GPL(line6_send_raw_message_async);
229 Send asynchronous device version request.
231 int line6_version_request_async(struct usb_line6 *line6)
236 buffer = kmemdup(line6_request_version,
237 sizeof(line6_request_version), GFP_ATOMIC);
241 retval = line6_send_raw_message_async(line6, buffer,
242 sizeof(line6_request_version));
246 EXPORT_SYMBOL_GPL(line6_version_request_async);
249 Send sysex message in pieces of wMaxPacketSize bytes.
251 int line6_send_sysex_message(struct usb_line6 *line6, const char *buffer,
254 return line6_send_raw_message(line6, buffer,
255 size + SYSEX_EXTRA_SIZE) -
258 EXPORT_SYMBOL_GPL(line6_send_sysex_message);
261 Allocate buffer for sysex message and prepare header.
262 @param code sysex message code
263 @param size number of bytes between code and sysex end
265 char *line6_alloc_sysex_buffer(struct usb_line6 *line6, int code1, int code2,
268 char *buffer = kmalloc(size + SYSEX_EXTRA_SIZE, GFP_ATOMIC);
273 buffer[0] = LINE6_SYSEX_BEGIN;
274 memcpy(buffer + 1, line6_midi_id, sizeof(line6_midi_id));
275 buffer[sizeof(line6_midi_id) + 1] = code1;
276 buffer[sizeof(line6_midi_id) + 2] = code2;
277 buffer[sizeof(line6_midi_id) + 3 + size] = LINE6_SYSEX_END;
280 EXPORT_SYMBOL_GPL(line6_alloc_sysex_buffer);
283 Notification of data received from the Line 6 device.
285 static void line6_data_received(struct urb *urb)
287 struct usb_line6 *line6 = (struct usb_line6 *)urb->context;
288 struct midi_buffer *mb = &line6->line6midi->midibuf_in;
291 if (urb->status == -ESHUTDOWN)
294 if (line6->properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
296 line6_midibuf_write(mb, urb->transfer_buffer, urb->actual_length);
298 if (done < urb->actual_length) {
299 line6_midibuf_ignore(mb, done);
300 dev_dbg(line6->ifcdev, "%d %d buffer overflow - message skipped\n",
301 done, urb->actual_length);
306 line6_midibuf_read(mb, line6->buffer_message,
307 LINE6_MIDI_MESSAGE_MAXLEN);
312 line6->message_length = done;
313 line6_midi_receive(line6, line6->buffer_message, done);
315 if (line6->process_message)
316 line6->process_message(line6);
319 line6->buffer_message = urb->transfer_buffer;
320 line6->message_length = urb->actual_length;
321 if (line6->process_message)
322 line6->process_message(line6);
323 line6->buffer_message = NULL;
326 line6_start_listen(line6);
329 #define LINE6_READ_WRITE_STATUS_DELAY 2 /* milliseconds */
330 #define LINE6_READ_WRITE_MAX_RETRIES 50
333 Read data from device.
335 int line6_read_data(struct usb_line6 *line6, unsigned address, void *data,
338 struct usb_device *usbdev = line6->usbdev;
343 if (address > 0xffff || datalen > 0xff)
346 /* query the serial number: */
347 ret = usb_control_msg_send(usbdev, 0, 0x67,
348 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
349 (datalen << 8) | 0x21, address, NULL, 0,
350 LINE6_TIMEOUT, GFP_KERNEL);
352 dev_err(line6->ifcdev, "read request failed (error %d)\n", ret);
356 /* Wait for data length. We'll get 0xff until length arrives. */
357 for (count = 0; count < LINE6_READ_WRITE_MAX_RETRIES; count++) {
358 mdelay(LINE6_READ_WRITE_STATUS_DELAY);
360 ret = usb_control_msg_recv(usbdev, 0, 0x67,
361 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
362 0x0012, 0x0000, &len, 1,
363 LINE6_TIMEOUT, GFP_KERNEL);
365 dev_err(line6->ifcdev,
366 "receive length failed (error %d)\n", ret);
376 dev_err(line6->ifcdev, "read failed after %d retries\n",
379 } else if (len != datalen) {
380 /* should be equal or something went wrong */
381 dev_err(line6->ifcdev,
382 "length mismatch (expected %d, got %d)\n",
387 /* receive the result: */
388 ret = usb_control_msg_recv(usbdev, 0, 0x67,
389 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
390 0x0013, 0x0000, data, datalen, LINE6_TIMEOUT,
393 dev_err(line6->ifcdev, "read failed (error %d)\n", ret);
398 EXPORT_SYMBOL_GPL(line6_read_data);
401 Write data to device.
403 int line6_write_data(struct usb_line6 *line6, unsigned address, void *data,
406 struct usb_device *usbdev = line6->usbdev;
408 unsigned char *status;
411 if (address > 0xffff || datalen > 0xffff)
414 status = kmalloc(1, GFP_KERNEL);
418 ret = usb_control_msg_send(usbdev, 0, 0x67,
419 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_OUT,
420 0x0022, address, data, datalen, LINE6_TIMEOUT,
423 dev_err(line6->ifcdev,
424 "write request failed (error %d)\n", ret);
428 for (count = 0; count < LINE6_READ_WRITE_MAX_RETRIES; count++) {
429 mdelay(LINE6_READ_WRITE_STATUS_DELAY);
431 ret = usb_control_msg_recv(usbdev, 0, 0x67,
432 USB_TYPE_VENDOR | USB_RECIP_DEVICE | USB_DIR_IN,
433 0x0012, 0x0000, status, 1, LINE6_TIMEOUT,
436 dev_err(line6->ifcdev,
437 "receiving status failed (error %d)\n", ret);
445 if (*status == 0xff) {
446 dev_err(line6->ifcdev, "write failed after %d retries\n",
449 } else if (*status != 0) {
450 dev_err(line6->ifcdev, "write failed (error %d)\n", ret);
457 EXPORT_SYMBOL_GPL(line6_write_data);
460 Read Line 6 device serial number.
461 (POD, TonePort, GuitarPort)
463 int line6_read_serial_number(struct usb_line6 *line6, u32 *serial_number)
465 return line6_read_data(line6, 0x80d0, serial_number,
466 sizeof(*serial_number));
468 EXPORT_SYMBOL_GPL(line6_read_serial_number);
473 static void line6_destruct(struct snd_card *card)
475 struct usb_line6 *line6 = card->private_data;
476 struct usb_device *usbdev = line6->usbdev;
478 /* Free buffer memory first. We cannot depend on the existence of private
479 * data from the (podhd) module, it may be gone already during this call
481 kfree(line6->buffer_message);
483 kfree(line6->buffer_listen);
485 /* then free URBs: */
486 usb_free_urb(line6->urb_listen);
487 line6->urb_listen = NULL;
489 /* decrement reference counters: */
493 static void line6_get_usb_properties(struct usb_line6 *line6)
495 struct usb_device *usbdev = line6->usbdev;
496 const struct line6_properties *properties = line6->properties;
498 struct usb_host_endpoint *ep = NULL;
500 if (properties->capabilities & LINE6_CAP_CONTROL) {
501 if (properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
502 pipe = usb_rcvintpipe(line6->usbdev,
503 line6->properties->ep_ctrl_r);
505 pipe = usb_rcvbulkpipe(line6->usbdev,
506 line6->properties->ep_ctrl_r);
508 ep = usbdev->ep_in[usb_pipeendpoint(pipe)];
511 /* Control data transfer properties */
513 line6->interval = ep->desc.bInterval;
514 line6->max_packet_size = le16_to_cpu(ep->desc.wMaxPacketSize);
516 if (properties->capabilities & LINE6_CAP_CONTROL) {
517 dev_err(line6->ifcdev,
518 "endpoint not available, using fallback values");
520 line6->interval = LINE6_FALLBACK_INTERVAL;
521 line6->max_packet_size = LINE6_FALLBACK_MAXPACKETSIZE;
524 /* Isochronous transfer properties */
525 if (usbdev->speed == USB_SPEED_LOW) {
526 line6->intervals_per_second = USB_LOW_INTERVALS_PER_SECOND;
527 line6->iso_buffers = USB_LOW_ISO_BUFFERS;
529 line6->intervals_per_second = USB_HIGH_INTERVALS_PER_SECOND;
530 line6->iso_buffers = USB_HIGH_ISO_BUFFERS;
534 /* Enable buffering of incoming messages, flush the buffer */
535 static int line6_hwdep_open(struct snd_hwdep *hw, struct file *file)
537 struct usb_line6 *line6 = hw->private_data;
539 /* NOTE: hwdep layer provides atomicity here */
541 line6->messages.active = 1;
542 line6->messages.nonblock = file->f_flags & O_NONBLOCK ? 1 : 0;
548 static int line6_hwdep_release(struct snd_hwdep *hw, struct file *file)
550 struct usb_line6 *line6 = hw->private_data;
552 line6->messages.active = 0;
557 /* Read from circular buffer, return to user */
559 line6_hwdep_read(struct snd_hwdep *hwdep, char __user *buf, long count,
562 struct usb_line6 *line6 = hwdep->private_data;
564 unsigned int out_count;
566 if (mutex_lock_interruptible(&line6->messages.read_lock))
569 while (kfifo_len(&line6->messages.fifo) == 0) {
570 mutex_unlock(&line6->messages.read_lock);
572 if (line6->messages.nonblock)
575 rv = wait_event_interruptible(
576 line6->messages.wait_queue,
577 kfifo_len(&line6->messages.fifo) != 0);
581 if (mutex_lock_interruptible(&line6->messages.read_lock))
585 if (kfifo_peek_len(&line6->messages.fifo) > count) {
586 /* Buffer too small; allow re-read of the current item... */
589 rv = kfifo_to_user(&line6->messages.fifo, buf, count, &out_count);
594 mutex_unlock(&line6->messages.read_lock);
598 /* Write directly (no buffering) to device by user*/
600 line6_hwdep_write(struct snd_hwdep *hwdep, const char __user *data, long count,
603 struct usb_line6 *line6 = hwdep->private_data;
607 if (count > line6->max_packet_size * LINE6_RAW_MESSAGES_MAXCOUNT) {
608 /* This is an arbitrary limit - still better than nothing... */
612 data_copy = memdup_user(data, count);
613 if (IS_ERR(data_copy))
614 return PTR_ERR(data_copy);
616 rv = line6_send_raw_message(line6, data_copy, count);
623 line6_hwdep_poll(struct snd_hwdep *hwdep, struct file *file, poll_table *wait)
626 struct usb_line6 *line6 = hwdep->private_data;
628 poll_wait(file, &line6->messages.wait_queue, wait);
630 mutex_lock(&line6->messages.read_lock);
631 rv = kfifo_len(&line6->messages.fifo) == 0 ? 0 : EPOLLIN | EPOLLRDNORM;
632 mutex_unlock(&line6->messages.read_lock);
637 static const struct snd_hwdep_ops hwdep_ops = {
638 .open = line6_hwdep_open,
639 .release = line6_hwdep_release,
640 .read = line6_hwdep_read,
641 .write = line6_hwdep_write,
642 .poll = line6_hwdep_poll,
645 /* Insert into circular buffer */
646 static void line6_hwdep_push_message(struct usb_line6 *line6)
648 if (!line6->messages.active)
651 if (kfifo_avail(&line6->messages.fifo) >= line6->message_length) {
652 /* No race condition here, there's only one writer */
653 kfifo_in(&line6->messages.fifo,
654 line6->buffer_message, line6->message_length);
655 } /* else TODO: signal overflow */
657 wake_up_interruptible(&line6->messages.wait_queue);
660 static int line6_hwdep_init(struct usb_line6 *line6)
663 struct snd_hwdep *hwdep;
665 /* TODO: usb_driver_claim_interface(); */
666 line6->process_message = line6_hwdep_push_message;
667 line6->messages.active = 0;
668 init_waitqueue_head(&line6->messages.wait_queue);
669 mutex_init(&line6->messages.read_lock);
670 INIT_KFIFO(line6->messages.fifo);
672 err = snd_hwdep_new(line6->card, "config", 0, &hwdep);
675 strcpy(hwdep->name, "config");
676 hwdep->iface = SNDRV_HWDEP_IFACE_LINE6;
677 hwdep->ops = hwdep_ops;
678 hwdep->private_data = line6;
679 hwdep->exclusive = true;
685 static int line6_init_cap_control(struct usb_line6 *line6)
689 /* initialize USB buffers: */
690 line6->buffer_listen = kmalloc(LINE6_BUFSIZE_LISTEN, GFP_KERNEL);
691 if (!line6->buffer_listen)
694 line6->urb_listen = usb_alloc_urb(0, GFP_KERNEL);
695 if (!line6->urb_listen)
698 if (line6->properties->capabilities & LINE6_CAP_CONTROL_MIDI) {
699 line6->buffer_message = kmalloc(LINE6_MIDI_MESSAGE_MAXLEN, GFP_KERNEL);
700 if (!line6->buffer_message)
703 ret = line6_init_midi(line6);
707 ret = line6_hwdep_init(line6);
712 ret = line6_start_listen(line6);
714 dev_err(line6->ifcdev, "cannot start listening: %d\n", ret);
721 static void line6_startup_work(struct work_struct *work)
723 struct usb_line6 *line6 =
724 container_of(work, struct usb_line6, startup_work.work);
727 line6->startup(line6);
733 int line6_probe(struct usb_interface *interface,
734 const struct usb_device_id *id,
735 const char *driver_name,
736 const struct line6_properties *properties,
737 int (*private_init)(struct usb_line6 *, const struct usb_device_id *id),
740 struct usb_device *usbdev = interface_to_usbdev(interface);
741 struct snd_card *card;
742 struct usb_line6 *line6;
743 int interface_number;
746 if (WARN_ON(data_size < sizeof(*line6)))
749 /* we don't handle multiple configurations */
750 if (usbdev->descriptor.bNumConfigurations != 1)
753 ret = snd_card_new(&interface->dev,
754 SNDRV_DEFAULT_IDX1, SNDRV_DEFAULT_STR1,
755 THIS_MODULE, data_size, &card);
759 /* store basic data: */
760 line6 = card->private_data;
762 line6->properties = properties;
763 line6->usbdev = usbdev;
764 line6->ifcdev = &interface->dev;
765 INIT_DELAYED_WORK(&line6->startup_work, line6_startup_work);
767 strcpy(card->id, properties->id);
768 strcpy(card->driver, driver_name);
769 strcpy(card->shortname, properties->name);
770 sprintf(card->longname, "Line 6 %s at USB %s", properties->name,
771 dev_name(line6->ifcdev));
772 card->private_free = line6_destruct;
774 usb_set_intfdata(interface, line6);
776 /* increment reference counters: */
779 /* initialize device info: */
780 dev_info(&interface->dev, "Line 6 %s found\n", properties->name);
782 /* query interface number */
783 interface_number = interface->cur_altsetting->desc.bInterfaceNumber;
785 /* TODO reserves the bus bandwidth even without actual transfer */
786 ret = usb_set_interface(usbdev, interface_number,
787 properties->altsetting);
789 dev_err(&interface->dev, "set_interface failed\n");
793 line6_get_usb_properties(line6);
795 if (properties->capabilities & LINE6_CAP_CONTROL) {
796 ret = line6_init_cap_control(line6);
801 /* initialize device data based on device: */
802 ret = private_init(line6, id);
806 /* creation of additional special files should go here */
808 dev_info(&interface->dev, "Line 6 %s now attached\n",
814 /* we can call disconnect callback here because no close-sync is
815 * needed yet at this point
817 line6_disconnect(interface);
820 EXPORT_SYMBOL_GPL(line6_probe);
823 Line 6 device disconnected.
825 void line6_disconnect(struct usb_interface *interface)
827 struct usb_line6 *line6 = usb_get_intfdata(interface);
828 struct usb_device *usbdev = interface_to_usbdev(interface);
833 if (WARN_ON(usbdev != line6->usbdev))
836 cancel_delayed_work_sync(&line6->startup_work);
838 if (line6->urb_listen != NULL)
839 line6_stop_listen(line6);
841 snd_card_disconnect(line6->card);
843 line6_pcm_disconnect(line6->line6pcm);
844 if (line6->disconnect)
845 line6->disconnect(line6);
847 dev_info(&interface->dev, "Line 6 %s now disconnected\n",
848 line6->properties->name);
850 /* make sure the device isn't destructed twice: */
851 usb_set_intfdata(interface, NULL);
853 snd_card_free_when_closed(line6->card);
855 EXPORT_SYMBOL_GPL(line6_disconnect);
860 Suspend Line 6 device.
862 int line6_suspend(struct usb_interface *interface, pm_message_t message)
864 struct usb_line6 *line6 = usb_get_intfdata(interface);
865 struct snd_line6_pcm *line6pcm = line6->line6pcm;
867 snd_power_change_state(line6->card, SNDRV_CTL_POWER_D3hot);
869 if (line6->properties->capabilities & LINE6_CAP_CONTROL)
870 line6_stop_listen(line6);
872 if (line6pcm != NULL)
877 EXPORT_SYMBOL_GPL(line6_suspend);
880 Resume Line 6 device.
882 int line6_resume(struct usb_interface *interface)
884 struct usb_line6 *line6 = usb_get_intfdata(interface);
886 if (line6->properties->capabilities & LINE6_CAP_CONTROL)
887 line6_start_listen(line6);
889 snd_power_change_state(line6->card, SNDRV_CTL_POWER_D0);
892 EXPORT_SYMBOL_GPL(line6_resume);
894 #endif /* CONFIG_PM */
896 MODULE_AUTHOR(DRIVER_AUTHOR);
897 MODULE_DESCRIPTION(DRIVER_DESC);
898 MODULE_LICENSE("GPL");