Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 1 | /* |
Chris Rorvick | c078a4a | 2015-01-20 02:20:50 -0600 | [diff] [blame] | 2 | * Line 6 Linux USB driver |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 3 | * |
Markus Grabner | 1027f47 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 4 | * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at) |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 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 | #ifndef DRIVER_H |
| 13 | #define DRIVER_H |
| 14 | |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 15 | #include <linux/usb.h> |
Andrej Krutak | a16039c | 2016-09-18 20:59:32 +0200 | [diff] [blame] | 16 | #include <linux/mutex.h> |
| 17 | #include <linux/kfifo.h> |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 18 | #include <sound/core.h> |
| 19 | |
| 20 | #include "midi.h" |
| 21 | |
Andrej Krutak | 79faa2b | 2016-09-18 20:59:22 +0200 | [diff] [blame] | 22 | /* USB 1.1 speed configuration */ |
| 23 | #define USB_LOW_INTERVALS_PER_SECOND 1000 |
| 24 | #define USB_LOW_ISO_BUFFERS 2 |
| 25 | |
| 26 | /* USB 2.0+ speed configuration */ |
| 27 | #define USB_HIGH_INTERVALS_PER_SECOND 8000 |
| 28 | #define USB_HIGH_ISO_BUFFERS 16 |
Takashi Iwai | 129b3be | 2015-01-28 14:50:08 +0100 | [diff] [blame] | 29 | |
| 30 | /* Fallback USB interval and max packet size values */ |
| 31 | #define LINE6_FALLBACK_INTERVAL 10 |
| 32 | #define LINE6_FALLBACK_MAXPACKETSIZE 16 |
| 33 | |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 34 | #define LINE6_TIMEOUT 1 |
Andrej Krutak | 97d78ac | 2016-09-18 20:59:24 +0200 | [diff] [blame] | 35 | #define LINE6_BUFSIZE_LISTEN 64 |
Andrej Krutak | a16039c | 2016-09-18 20:59:32 +0200 | [diff] [blame] | 36 | #define LINE6_MIDI_MESSAGE_MAXLEN 256 |
| 37 | |
| 38 | #define LINE6_RAW_MESSAGES_MAXCOUNT_ORDER 7 |
| 39 | /* 4k packets are common, BUFSIZE * MAXCOUNT should be bigger... */ |
| 40 | #define LINE6_RAW_MESSAGES_MAXCOUNT (1 << LINE6_RAW_MESSAGES_MAXCOUNT_ORDER) |
| 41 | |
| 42 | |
| 43 | #if LINE6_BUFSIZE_LISTEN > 65535 |
| 44 | #error "Use dynamic fifo instead" |
| 45 | #endif |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 46 | |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 47 | /* |
Chris Rorvick | c6fffce | 2015-01-20 02:20:49 -0600 | [diff] [blame] | 48 | Line 6 MIDI control commands |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 49 | */ |
| 50 | #define LINE6_PARAM_CHANGE 0xb0 |
| 51 | #define LINE6_PROGRAM_CHANGE 0xc0 |
| 52 | #define LINE6_SYSEX_BEGIN 0xf0 |
| 53 | #define LINE6_SYSEX_END 0xf7 |
| 54 | #define LINE6_RESET 0xff |
| 55 | |
| 56 | /* |
| 57 | MIDI channel for messages initiated by the host |
| 58 | (and eventually echoed back by the device) |
| 59 | */ |
| 60 | #define LINE6_CHANNEL_HOST 0x00 |
| 61 | |
| 62 | /* |
| 63 | MIDI channel for messages initiated by the device |
| 64 | */ |
| 65 | #define LINE6_CHANNEL_DEVICE 0x02 |
| 66 | |
Markus Grabner | e1a164d | 2010-08-23 01:08:25 +0200 | [diff] [blame] | 67 | #define LINE6_CHANNEL_UNKNOWN 5 /* don't know yet what this is good for */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 68 | |
| 69 | #define LINE6_CHANNEL_MASK 0x0f |
| 70 | |
Greg Kroah-Hartman | 027360c | 2010-09-21 16:58:00 -0700 | [diff] [blame] | 71 | #define CHECK_STARTUP_PROGRESS(x, n) \ |
| 72 | do { \ |
| 73 | if ((x) >= (n)) \ |
| 74 | return; \ |
| 75 | x = (n); \ |
| 76 | } while (0) |
Markus Grabner | 1027f47 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 77 | |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 78 | extern const unsigned char line6_midi_id[3]; |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 79 | |
| 80 | static const int SYSEX_DATA_OFS = sizeof(line6_midi_id) + 3; |
| 81 | static const int SYSEX_EXTRA_SIZE = sizeof(line6_midi_id) + 4; |
| 82 | |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 83 | /* |
Chris Rorvick | c6fffce | 2015-01-20 02:20:49 -0600 | [diff] [blame] | 84 | Common properties of Line 6 devices. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 85 | */ |
| 86 | struct line6_properties { |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 87 | /* Card id string (maximum 16 characters). |
| 88 | * This can be used to address the device in ALSA programs as |
| 89 | * "default:CARD=<id>" |
| 90 | */ |
Markus Grabner | 1027f47 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 91 | const char *id; |
| 92 | |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 93 | /* Card short name (maximum 32 characters) */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 94 | const char *name; |
Markus Grabner | 1027f47 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 95 | |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 96 | /* Bit vector defining this device's capabilities in line6usb driver */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 97 | int capabilities; |
Chris Rorvick | 7b9584f | 2015-01-12 12:42:52 -0800 | [diff] [blame] | 98 | |
| 99 | int altsetting; |
Chris Rorvick | 9e165be | 2015-01-12 12:42:53 -0800 | [diff] [blame] | 100 | |
| 101 | unsigned ep_ctrl_r; |
| 102 | unsigned ep_ctrl_w; |
Chris Rorvick | 16d603d | 2015-01-12 12:42:55 -0800 | [diff] [blame] | 103 | unsigned ep_audio_r; |
| 104 | unsigned ep_audio_w; |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 105 | }; |
| 106 | |
Takashi Iwai | 129b3be | 2015-01-28 14:50:08 +0100 | [diff] [blame] | 107 | /* Capability bits */ |
| 108 | enum { |
| 109 | /* device supports settings parameter via USB */ |
| 110 | LINE6_CAP_CONTROL = 1 << 0, |
| 111 | /* device supports PCM input/output via USB */ |
| 112 | LINE6_CAP_PCM = 1 << 1, |
Andrej Krutak | f56742c | 2016-09-18 20:59:25 +0200 | [diff] [blame] | 113 | /* device supports hardware monitoring */ |
Takashi Iwai | 129b3be | 2015-01-28 14:50:08 +0100 | [diff] [blame] | 114 | LINE6_CAP_HWMON = 1 << 2, |
Andrej Krutak | f56742c | 2016-09-18 20:59:25 +0200 | [diff] [blame] | 115 | /* device requires output data when input is read */ |
| 116 | LINE6_CAP_IN_NEEDS_OUT = 1 << 3, |
Andrej Krutak | 174e1fc | 2016-09-18 20:59:26 +0200 | [diff] [blame] | 117 | /* device uses raw MIDI via USB (data endpoints) */ |
| 118 | LINE6_CAP_CONTROL_MIDI = 1 << 4, |
Takashi Iwai | 129b3be | 2015-01-28 14:50:08 +0100 | [diff] [blame] | 119 | }; |
| 120 | |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 121 | /* |
Chris Rorvick | c6fffce | 2015-01-20 02:20:49 -0600 | [diff] [blame] | 122 | Common data shared by all Line 6 devices. |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 123 | Corresponds to a pair of USB endpoints. |
| 124 | */ |
| 125 | struct usb_line6 { |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 126 | /* USB device */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 127 | struct usb_device *usbdev; |
| 128 | |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 129 | /* Properties */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 130 | const struct line6_properties *properties; |
| 131 | |
Andrej Krutak | 79faa2b | 2016-09-18 20:59:22 +0200 | [diff] [blame] | 132 | /* Interval for data USB packets */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 133 | int interval; |
Andrej Krutak | 79faa2b | 2016-09-18 20:59:22 +0200 | [diff] [blame] | 134 | /* ...for isochronous transfers framing */ |
| 135 | int intervals_per_second; |
| 136 | |
Andrej Krutak | b2233d9 | 2016-09-18 20:59:21 +0200 | [diff] [blame] | 137 | /* Number of isochronous URBs used for frame transfers */ |
| 138 | int iso_buffers; |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 139 | |
Andrej Krutak | 79faa2b | 2016-09-18 20:59:22 +0200 | [diff] [blame] | 140 | /* Maximum size of data USB packet */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 141 | int max_packet_size; |
| 142 | |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 143 | /* Device representing the USB interface */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 144 | struct device *ifcdev; |
| 145 | |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 146 | /* Line 6 sound card data structure. |
| 147 | * Each device has at least MIDI or PCM. |
| 148 | */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 149 | struct snd_card *card; |
| 150 | |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 151 | /* Line 6 PCM device data structure */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 152 | struct snd_line6_pcm *line6pcm; |
| 153 | |
Takashi Iwai | cddbd4f | 2015-01-28 14:43:11 +0100 | [diff] [blame] | 154 | /* Line 6 MIDI device data structure */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 155 | struct snd_line6_midi *line6midi; |
| 156 | |
Andrej Krutak | 174e1fc | 2016-09-18 20:59:26 +0200 | [diff] [blame] | 157 | /* URB for listening to POD data endpoint */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 158 | struct urb *urb_listen; |
| 159 | |
Andrej Krutak | 7811a3a | 2016-09-18 20:59:27 +0200 | [diff] [blame] | 160 | /* Buffer for incoming data from POD data endpoint */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 161 | unsigned char *buffer_listen; |
| 162 | |
Andrej Krutak | 7811a3a | 2016-09-18 20:59:27 +0200 | [diff] [blame] | 163 | /* Buffer for message to be processed, generated from MIDI layer */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 164 | unsigned char *buffer_message; |
| 165 | |
Andrej Krutak | 7811a3a | 2016-09-18 20:59:27 +0200 | [diff] [blame] | 166 | /* Length of message to be processed, generated from MIDI layer */ |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 167 | int message_length; |
Chris Rorvick | 01f6b2b | 2015-01-12 12:42:58 -0800 | [diff] [blame] | 168 | |
Andrej Krutak | a16039c | 2016-09-18 20:59:32 +0200 | [diff] [blame] | 169 | /* Circular buffer for non-MIDI control messages */ |
| 170 | struct { |
| 171 | struct mutex read_lock; |
| 172 | wait_queue_head_t wait_queue; |
| 173 | unsigned int active:1; |
| 174 | STRUCT_KFIFO_REC_2(LINE6_BUFSIZE_LISTEN * LINE6_RAW_MESSAGES_MAXCOUNT) |
| 175 | fifo; |
| 176 | } messages; |
| 177 | |
Andrej Krutak | 7811a3a | 2016-09-18 20:59:27 +0200 | [diff] [blame] | 178 | /* If MIDI is supported, buffer_message contains the pre-processed data; |
| 179 | * otherwise the data is only in urb_listen (buffer_incoming). |
| 180 | */ |
Chris Rorvick | 01f6b2b | 2015-01-12 12:42:58 -0800 | [diff] [blame] | 181 | void (*process_message)(struct usb_line6 *); |
Takashi Iwai | f66fd99 | 2015-01-25 18:22:58 +0100 | [diff] [blame] | 182 | void (*disconnect)(struct usb_line6 *line6); |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 183 | }; |
| 184 | |
Greg Kroah-Hartman | a49e483 | 2009-02-27 21:09:55 -0800 | [diff] [blame] | 185 | extern char *line6_alloc_sysex_buffer(struct usb_line6 *line6, int code1, |
| 186 | int code2, int size); |
Chris Rorvick | 25a0707 | 2015-02-11 06:03:31 -0600 | [diff] [blame] | 187 | extern int line6_read_data(struct usb_line6 *line6, unsigned address, |
| 188 | void *data, unsigned datalen); |
Greg Kroah-Hartman | a49e483 | 2009-02-27 21:09:55 -0800 | [diff] [blame] | 189 | extern int line6_read_serial_number(struct usb_line6 *line6, |
Chris Rorvick | 12b0015 | 2015-02-10 23:03:16 -0600 | [diff] [blame] | 190 | u32 *serial_number); |
Greg Kroah-Hartman | a49e483 | 2009-02-27 21:09:55 -0800 | [diff] [blame] | 191 | extern int line6_send_raw_message_async(struct usb_line6 *line6, |
| 192 | const char *buffer, int size); |
| 193 | extern int line6_send_sysex_message(struct usb_line6 *line6, |
| 194 | const char *buffer, int size); |
| 195 | extern ssize_t line6_set_raw(struct device *dev, struct device_attribute *attr, |
| 196 | const char *buf, size_t count); |
Nicholas Mc Guire | 6ccd93b | 2015-02-03 02:38:56 -0500 | [diff] [blame] | 197 | extern void line6_start_timer(struct timer_list *timer, unsigned long msecs, |
Monam Agarwal | 56733e9 | 2014-02-27 21:06:58 +0530 | [diff] [blame] | 198 | void (*function)(unsigned long), |
Markus Grabner | e1a164d | 2010-08-23 01:08:25 +0200 | [diff] [blame] | 199 | unsigned long data); |
Markus Grabner | 1027f47 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 200 | extern int line6_version_request_async(struct usb_line6 *line6); |
Chris Rorvick | 25a0707 | 2015-02-11 06:03:31 -0600 | [diff] [blame] | 201 | extern int line6_write_data(struct usb_line6 *line6, unsigned address, |
| 202 | void *data, unsigned datalen); |
Markus Grabner | 1027f47 | 2010-08-12 01:35:30 +0200 | [diff] [blame] | 203 | |
Takashi Iwai | ccddbe4 | 2015-01-15 08:22:31 +0100 | [diff] [blame] | 204 | int line6_probe(struct usb_interface *interface, |
Takashi Iwai | f66fd99 | 2015-01-25 18:22:58 +0100 | [diff] [blame] | 205 | const struct usb_device_id *id, |
Chris Rorvick | 12865ca | 2015-02-07 10:43:19 -0600 | [diff] [blame] | 206 | const char *driver_name, |
Takashi Iwai | ccddbe4 | 2015-01-15 08:22:31 +0100 | [diff] [blame] | 207 | const struct line6_properties *properties, |
Takashi Iwai | aca514b | 2015-01-25 18:36:29 +0100 | [diff] [blame] | 208 | int (*private_init)(struct usb_line6 *, const struct usb_device_id *id), |
| 209 | size_t data_size); |
Takashi Iwai | f66fd99 | 2015-01-25 18:22:58 +0100 | [diff] [blame] | 210 | |
Takashi Iwai | ccddbe4 | 2015-01-15 08:22:31 +0100 | [diff] [blame] | 211 | void line6_disconnect(struct usb_interface *interface); |
| 212 | |
| 213 | #ifdef CONFIG_PM |
| 214 | int line6_suspend(struct usb_interface *interface, pm_message_t message); |
| 215 | int line6_resume(struct usb_interface *interface); |
| 216 | #endif |
| 217 | |
Markus Grabner | 705ecec | 2009-02-27 19:43:04 -0800 | [diff] [blame] | 218 | #endif |