1 /* SPDX-License-Identifier: GPL-2.0-only */ 1 /* SPDX-License-Identifier: GPL-2.0-only */
2 /* 2 /*
3 * Line 6 Linux USB driver 3 * Line 6 Linux USB driver
4 * 4 *
5 * Copyright (C) 2004-2010 Markus Grabner (lin 5 * Copyright (C) 2004-2010 Markus Grabner (line6@grabner-graz.at)
6 */ 6 */
7 7
8 #ifndef DRIVER_H 8 #ifndef DRIVER_H
9 #define DRIVER_H 9 #define DRIVER_H
10 10
11 #include <linux/usb.h> 11 #include <linux/usb.h>
12 #include <linux/mutex.h> 12 #include <linux/mutex.h>
13 #include <linux/kfifo.h> 13 #include <linux/kfifo.h>
14 #include <sound/core.h> 14 #include <sound/core.h>
15 15
16 #include "midi.h" 16 #include "midi.h"
17 17
18 /* USB 1.1 speed configuration */ 18 /* USB 1.1 speed configuration */
19 #define USB_LOW_INTERVALS_PER_SECOND 1000 19 #define USB_LOW_INTERVALS_PER_SECOND 1000
20 #define USB_LOW_ISO_BUFFERS 2 20 #define USB_LOW_ISO_BUFFERS 2
21 21
22 /* USB 2.0+ speed configuration */ 22 /* USB 2.0+ speed configuration */
23 #define USB_HIGH_INTERVALS_PER_SECOND 8000 23 #define USB_HIGH_INTERVALS_PER_SECOND 8000
24 #define USB_HIGH_ISO_BUFFERS 16 24 #define USB_HIGH_ISO_BUFFERS 16
25 25
26 /* Fallback USB interval and max packet size v 26 /* Fallback USB interval and max packet size values */
27 #define LINE6_FALLBACK_INTERVAL 10 27 #define LINE6_FALLBACK_INTERVAL 10
28 #define LINE6_FALLBACK_MAXPACKETSIZE 16 28 #define LINE6_FALLBACK_MAXPACKETSIZE 16
29 29
30 #define LINE6_TIMEOUT 1000 30 #define LINE6_TIMEOUT 1000
31 #define LINE6_BUFSIZE_LISTEN 64 31 #define LINE6_BUFSIZE_LISTEN 64
32 #define LINE6_MIDI_MESSAGE_MAXLEN 256 32 #define LINE6_MIDI_MESSAGE_MAXLEN 256
33 33
34 #define LINE6_RAW_MESSAGES_MAXCOUNT_ORDER 7 34 #define LINE6_RAW_MESSAGES_MAXCOUNT_ORDER 7
35 /* 4k packets are common, BUFSIZE * MAXCOUNT s 35 /* 4k packets are common, BUFSIZE * MAXCOUNT should be bigger... */
36 #define LINE6_RAW_MESSAGES_MAXCOUNT (1 << LINE 36 #define LINE6_RAW_MESSAGES_MAXCOUNT (1 << LINE6_RAW_MESSAGES_MAXCOUNT_ORDER)
37 37
38 38
39 #if LINE6_BUFSIZE_LISTEN > 65535 39 #if LINE6_BUFSIZE_LISTEN > 65535
40 #error "Use dynamic fifo instead" 40 #error "Use dynamic fifo instead"
41 #endif 41 #endif
42 42
43 /* 43 /*
44 Line 6 MIDI control commands 44 Line 6 MIDI control commands
45 */ 45 */
46 #define LINE6_PARAM_CHANGE 0xb0 46 #define LINE6_PARAM_CHANGE 0xb0
47 #define LINE6_PROGRAM_CHANGE 0xc0 47 #define LINE6_PROGRAM_CHANGE 0xc0
48 #define LINE6_SYSEX_BEGIN 0xf0 48 #define LINE6_SYSEX_BEGIN 0xf0
49 #define LINE6_SYSEX_END 0xf7 49 #define LINE6_SYSEX_END 0xf7
50 #define LINE6_RESET 0xff 50 #define LINE6_RESET 0xff
51 51
52 /* 52 /*
53 MIDI channel for messages initiated by 53 MIDI channel for messages initiated by the host
54 (and eventually echoed back by the dev 54 (and eventually echoed back by the device)
55 */ 55 */
56 #define LINE6_CHANNEL_HOST 0x00 56 #define LINE6_CHANNEL_HOST 0x00
57 57
58 /* 58 /*
59 MIDI channel for messages initiated by 59 MIDI channel for messages initiated by the device
60 */ 60 */
61 #define LINE6_CHANNEL_DEVICE 0x02 61 #define LINE6_CHANNEL_DEVICE 0x02
62 62
63 #define LINE6_CHANNEL_UNKNOWN 5 /* don't know 63 #define LINE6_CHANNEL_UNKNOWN 5 /* don't know yet what this is good for */
64 64
65 #define LINE6_CHANNEL_MASK 0x0f 65 #define LINE6_CHANNEL_MASK 0x0f
66 66
67 extern const unsigned char line6_midi_id[3]; 67 extern const unsigned char line6_midi_id[3];
68 68
69 #define SYSEX_DATA_OFS (sizeof(line6_midi_id) 69 #define SYSEX_DATA_OFS (sizeof(line6_midi_id) + 3)
70 #define SYSEX_EXTRA_SIZE (sizeof(line6_midi_id 70 #define SYSEX_EXTRA_SIZE (sizeof(line6_midi_id) + 4)
71 71
72 /* 72 /*
73 Common properties of Line 6 devices. 73 Common properties of Line 6 devices.
74 */ 74 */
75 struct line6_properties { 75 struct line6_properties {
76 /* Card id string (maximum 16 characte 76 /* Card id string (maximum 16 characters).
77 * This can be used to address the dev 77 * This can be used to address the device in ALSA programs as
78 * "default:CARD=<id>" 78 * "default:CARD=<id>"
79 */ 79 */
80 const char *id; 80 const char *id;
81 81
82 /* Card short name (maximum 32 charact 82 /* Card short name (maximum 32 characters) */
83 const char *name; 83 const char *name;
84 84
85 /* Bit vector defining this device's c 85 /* Bit vector defining this device's capabilities in line6usb driver */
86 int capabilities; 86 int capabilities;
87 87
88 int altsetting; 88 int altsetting;
89 89
90 unsigned int ctrl_if; 90 unsigned int ctrl_if;
91 unsigned int ep_ctrl_r; 91 unsigned int ep_ctrl_r;
92 unsigned int ep_ctrl_w; 92 unsigned int ep_ctrl_w;
93 unsigned int ep_audio_r; 93 unsigned int ep_audio_r;
94 unsigned int ep_audio_w; 94 unsigned int ep_audio_w;
95 }; 95 };
96 96
97 /* Capability bits */ 97 /* Capability bits */
98 enum { 98 enum {
99 /* device supports settings parameter 99 /* device supports settings parameter via USB */
100 LINE6_CAP_CONTROL = 1 << 0, 100 LINE6_CAP_CONTROL = 1 << 0,
101 /* device supports PCM input/output vi 101 /* device supports PCM input/output via USB */
102 LINE6_CAP_PCM = 1 << 1, 102 LINE6_CAP_PCM = 1 << 1,
103 /* device supports hardware monitoring 103 /* device supports hardware monitoring */
104 LINE6_CAP_HWMON = 1 << 2, 104 LINE6_CAP_HWMON = 1 << 2,
105 /* device requires output data when in 105 /* device requires output data when input is read */
106 LINE6_CAP_IN_NEEDS_OUT = 1 << 3, 106 LINE6_CAP_IN_NEEDS_OUT = 1 << 3,
107 /* device uses raw MIDI via USB (data 107 /* device uses raw MIDI via USB (data endpoints) */
108 LINE6_CAP_CONTROL_MIDI = 1 << 4, 108 LINE6_CAP_CONTROL_MIDI = 1 << 4,
109 /* device provides low-level informati 109 /* device provides low-level information */
110 LINE6_CAP_CONTROL_INFO = 1 << 5, 110 LINE6_CAP_CONTROL_INFO = 1 << 5,
111 /* device provides hardware monitoring 111 /* device provides hardware monitoring volume control */
112 LINE6_CAP_HWMON_CTL = 1 << 6, 112 LINE6_CAP_HWMON_CTL = 1 << 6,
113 }; 113 };
114 114
115 /* 115 /*
116 Common data shared by all Line 6 devi 116 Common data shared by all Line 6 devices.
117 Corresponds to a pair of USB endpoint 117 Corresponds to a pair of USB endpoints.
118 */ 118 */
119 struct usb_line6 { 119 struct usb_line6 {
120 /* USB device */ 120 /* USB device */
121 struct usb_device *usbdev; 121 struct usb_device *usbdev;
122 122
123 /* Properties */ 123 /* Properties */
124 const struct line6_properties *propert 124 const struct line6_properties *properties;
125 125
126 /* Interval for data USB packets */ 126 /* Interval for data USB packets */
127 int interval; 127 int interval;
128 /* ...for isochronous transfers framin 128 /* ...for isochronous transfers framing */
129 int intervals_per_second; 129 int intervals_per_second;
130 130
131 /* Number of isochronous URBs used for 131 /* Number of isochronous URBs used for frame transfers */
132 int iso_buffers; 132 int iso_buffers;
133 133
134 /* Maximum size of data USB packet */ 134 /* Maximum size of data USB packet */
135 int max_packet_size; 135 int max_packet_size;
136 136
137 /* Device representing the USB interfa 137 /* Device representing the USB interface */
138 struct device *ifcdev; 138 struct device *ifcdev;
139 139
140 /* Line 6 sound card data structure. 140 /* Line 6 sound card data structure.
141 * Each device has at least MIDI or PC 141 * Each device has at least MIDI or PCM.
142 */ 142 */
143 struct snd_card *card; 143 struct snd_card *card;
144 144
145 /* Line 6 PCM device data structure */ 145 /* Line 6 PCM device data structure */
146 struct snd_line6_pcm *line6pcm; 146 struct snd_line6_pcm *line6pcm;
147 147
148 /* Line 6 MIDI device data structure * 148 /* Line 6 MIDI device data structure */
149 struct snd_line6_midi *line6midi; 149 struct snd_line6_midi *line6midi;
150 150
151 /* URB for listening to POD data endpo 151 /* URB for listening to POD data endpoint */
152 struct urb *urb_listen; 152 struct urb *urb_listen;
153 153
154 /* Buffer for incoming data from POD d 154 /* Buffer for incoming data from POD data endpoint */
155 unsigned char *buffer_listen; 155 unsigned char *buffer_listen;
156 156
157 /* Buffer for message to be processed, 157 /* Buffer for message to be processed, generated from MIDI layer */
158 unsigned char *buffer_message; 158 unsigned char *buffer_message;
159 159
160 /* Length of message to be processed, 160 /* Length of message to be processed, generated from MIDI layer */
161 int message_length; 161 int message_length;
162 162
163 /* Circular buffer for non-MIDI contro 163 /* Circular buffer for non-MIDI control messages */
164 struct { 164 struct {
165 struct mutex read_lock; 165 struct mutex read_lock;
166 wait_queue_head_t wait_queue; 166 wait_queue_head_t wait_queue;
167 unsigned int active:1; 167 unsigned int active:1;
168 unsigned int nonblock:1; 168 unsigned int nonblock:1;
169 STRUCT_KFIFO_REC_2(LINE6_BUFSI 169 STRUCT_KFIFO_REC_2(LINE6_BUFSIZE_LISTEN * LINE6_RAW_MESSAGES_MAXCOUNT)
170 fifo; 170 fifo;
171 } messages; 171 } messages;
172 172
173 /* Work for delayed PCM startup */ 173 /* Work for delayed PCM startup */
174 struct delayed_work startup_work; 174 struct delayed_work startup_work;
175 175
176 /* If MIDI is supported, buffer_messag 176 /* If MIDI is supported, buffer_message contains the pre-processed data;
177 * otherwise the data is only in urb_l 177 * otherwise the data is only in urb_listen (buffer_incoming).
178 */ 178 */
179 void (*process_message)(struct usb_lin 179 void (*process_message)(struct usb_line6 *);
180 void (*disconnect)(struct usb_line6 *l 180 void (*disconnect)(struct usb_line6 *line6);
181 void (*startup)(struct usb_line6 *line 181 void (*startup)(struct usb_line6 *line6);
182 }; 182 };
183 183
184 extern char *line6_alloc_sysex_buffer(struct u 184 extern char *line6_alloc_sysex_buffer(struct usb_line6 *line6, int code1,
185 int code 185 int code2, int size);
186 extern int line6_read_data(struct usb_line6 *l 186 extern int line6_read_data(struct usb_line6 *line6, unsigned address,
187 void *data, unsigne 187 void *data, unsigned datalen);
188 extern int line6_read_serial_number(struct usb 188 extern int line6_read_serial_number(struct usb_line6 *line6,
189 u32 *seria 189 u32 *serial_number);
190 extern int line6_send_raw_message(struct usb_l 190 extern int line6_send_raw_message(struct usb_line6 *line6,
191 const 191 const char *buffer, int size);
192 extern int line6_send_raw_message_async(struct 192 extern int line6_send_raw_message_async(struct usb_line6 *line6,
193 const 193 const char *buffer, int size);
194 extern int line6_send_sysex_message(struct usb 194 extern int line6_send_sysex_message(struct usb_line6 *line6,
195 const char 195 const char *buffer, int size);
196 extern int line6_version_request_async(struct 196 extern int line6_version_request_async(struct usb_line6 *line6);
197 extern int line6_write_data(struct usb_line6 * 197 extern int line6_write_data(struct usb_line6 *line6, unsigned address,
198 void *data, unsign 198 void *data, unsigned datalen);
199 199
200 int line6_probe(struct usb_interface *interfac 200 int line6_probe(struct usb_interface *interface,
201 const struct usb_device_id *id 201 const struct usb_device_id *id,
202 const char *driver_name, 202 const char *driver_name,
203 const struct line6_properties 203 const struct line6_properties *properties,
204 int (*private_init)(struct usb 204 int (*private_init)(struct usb_line6 *, const struct usb_device_id *id),
205 size_t data_size); 205 size_t data_size);
206 206
207 void line6_disconnect(struct usb_interface *in 207 void line6_disconnect(struct usb_interface *interface);
208 208
209 #ifdef CONFIG_PM 209 #ifdef CONFIG_PM
210 int line6_suspend(struct usb_interface *interf 210 int line6_suspend(struct usb_interface *interface, pm_message_t message);
211 int line6_resume(struct usb_interface *interfa 211 int line6_resume(struct usb_interface *interface);
212 #endif 212 #endif
213 213
214 #endif 214 #endif
215 215
Linux® is a registered trademark of Linus Torvalds in the United States and other countries.
TOMOYO® is a registered trademark of NTT DATA CORPORATION.