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/slab.h>
9 #include <linux/wait.h>
10 #include <linux/interrupt.h>
11 #include <linux/module.h>
12 #include <linux/usb.h>
14 #include <sound/core.h>
15 #include <sound/control.h>
22 Locate name in binary program dump
24 #define POD_NAME_OFFSET 0
25 #define POD_NAME_LENGTH 16
30 #define POD_CONTROL_SIZE 0x80
31 #define POD_BUFSIZE_DUMPREQ 7
32 #define POD_STARTUP_DELAY 1000
35 Stages of POD startup procedure
38 POD_STARTUP_VERSIONREQ,
53 struct usb_line6_pod {
54 /* Generic Line 6 USB data */
55 struct usb_line6 line6;
57 /* Instrument monitor level */
60 /* Current progress in startup procedure */
63 /* Serial number of device */
66 /* Firmware version (x 100) */
73 #define line6_to_pod(x) container_of(x, struct usb_line6_pod, line6)
75 #define POD_SYSEX_CODE 3
80 POD_SYSEX_SAVE = 0x24,
81 POD_SYSEX_SYSTEM = 0x56,
82 POD_SYSEX_SYSTEMREQ = 0x57,
83 /* POD_SYSEX_UPDATE = 0x6c, */ /* software update! */
84 POD_SYSEX_STORE = 0x71,
85 POD_SYSEX_FINISH = 0x72,
86 POD_SYSEX_DUMPMEM = 0x73,
87 POD_SYSEX_DUMP = 0x74,
88 POD_SYSEX_DUMPREQ = 0x75
90 /* dumps entire internal memory of PODxt Pro */
91 /* POD_SYSEX_DUMPMEM2 = 0x76 */
95 POD_MONITOR_LEVEL = 0x04,
96 POD_SYSTEM_INVALID = 0x10000
113 static const struct snd_ratden pod_ratden = {
120 static struct line6_pcm_properties pod_pcm_properties = {
122 .info = (SNDRV_PCM_INFO_MMAP |
123 SNDRV_PCM_INFO_INTERLEAVED |
124 SNDRV_PCM_INFO_BLOCK_TRANSFER |
125 SNDRV_PCM_INFO_MMAP_VALID |
126 SNDRV_PCM_INFO_PAUSE |
127 SNDRV_PCM_INFO_SYNC_START),
128 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
129 .rates = SNDRV_PCM_RATE_KNOT,
134 .buffer_bytes_max = 60000,
135 .period_bytes_min = 64,
136 .period_bytes_max = 8192,
138 .periods_max = 1024},
140 .info = (SNDRV_PCM_INFO_MMAP |
141 SNDRV_PCM_INFO_INTERLEAVED |
142 SNDRV_PCM_INFO_BLOCK_TRANSFER |
143 SNDRV_PCM_INFO_MMAP_VALID |
144 SNDRV_PCM_INFO_SYNC_START),
145 .formats = SNDRV_PCM_FMTBIT_S24_3LE,
146 .rates = SNDRV_PCM_RATE_KNOT,
151 .buffer_bytes_max = 60000,
152 .period_bytes_min = 64,
153 .period_bytes_max = 8192,
155 .periods_max = 1024},
158 .rats = &pod_ratden},
159 .bytes_per_channel = 3 /* SNDRV_PCM_FMTBIT_S24_3LE */
162 static const char pod_version_header[] = {
163 0xf2, 0x7e, 0x7f, 0x06, 0x02
166 static char *pod_alloc_sysex_buffer(struct usb_line6_pod *pod, int code,
169 return line6_alloc_sysex_buffer(&pod->line6, POD_SYSEX_CODE, code,
174 Process a completely received message.
176 static void line6_pod_process_message(struct usb_line6 *line6)
178 struct usb_line6_pod *pod = line6_to_pod(line6);
179 const unsigned char *buf = pod->line6.buffer_message;
181 if (memcmp(buf, pod_version_header, sizeof(pod_version_header)) == 0) {
182 pod->firmware_version = buf[13] * 100 + buf[14] * 10 + buf[15];
183 pod->device_id = ((int)buf[8] << 16) | ((int)buf[9] << 8) |
185 if (pod->startup_progress == POD_STARTUP_VERSIONREQ) {
186 pod->startup_progress = POD_STARTUP_SETUP;
187 schedule_delayed_work(&line6->startup_work, 0);
192 /* Only look for sysex messages from this device */
193 if (buf[0] != (LINE6_SYSEX_BEGIN | LINE6_CHANNEL_DEVICE) &&
194 buf[0] != (LINE6_SYSEX_BEGIN | LINE6_CHANNEL_UNKNOWN)) {
197 if (memcmp(buf + 1, line6_midi_id, sizeof(line6_midi_id)) != 0)
200 if (buf[5] == POD_SYSEX_SYSTEM && buf[6] == POD_MONITOR_LEVEL) {
201 short value = ((int)buf[7] << 12) | ((int)buf[8] << 8) |
202 ((int)buf[9] << 4) | (int)buf[10];
203 pod->monitor_level = value;
208 Send system parameter (from integer).
210 static int pod_set_system_param_int(struct usb_line6_pod *pod, int value,
214 static const int size = 5;
216 sysex = pod_alloc_sysex_buffer(pod, POD_SYSEX_SYSTEM, size);
219 sysex[SYSEX_DATA_OFS] = code;
220 sysex[SYSEX_DATA_OFS + 1] = (value >> 12) & 0x0f;
221 sysex[SYSEX_DATA_OFS + 2] = (value >> 8) & 0x0f;
222 sysex[SYSEX_DATA_OFS + 3] = (value >> 4) & 0x0f;
223 sysex[SYSEX_DATA_OFS + 4] = (value) & 0x0f;
224 line6_send_sysex_message(&pod->line6, sysex, size);
230 "read" request on "serial_number" special file.
232 static ssize_t serial_number_show(struct device *dev,
233 struct device_attribute *attr, char *buf)
235 struct snd_card *card = dev_to_snd_card(dev);
236 struct usb_line6_pod *pod = card->private_data;
238 return sprintf(buf, "%u\n", pod->serial_number);
242 "read" request on "firmware_version" special file.
244 static ssize_t firmware_version_show(struct device *dev,
245 struct device_attribute *attr, char *buf)
247 struct snd_card *card = dev_to_snd_card(dev);
248 struct usb_line6_pod *pod = card->private_data;
250 return sprintf(buf, "%d.%02d\n", pod->firmware_version / 100,
251 pod->firmware_version % 100);
255 "read" request on "device_id" special file.
257 static ssize_t device_id_show(struct device *dev,
258 struct device_attribute *attr, char *buf)
260 struct snd_card *card = dev_to_snd_card(dev);
261 struct usb_line6_pod *pod = card->private_data;
263 return sprintf(buf, "%d\n", pod->device_id);
267 POD startup procedure.
268 This is a sequence of functions with special requirements (e.g., must
269 not run immediately after initialization, must not run in interrupt
270 context). After the last one has finished, the device is ready to use.
273 static void pod_startup(struct usb_line6 *line6)
275 struct usb_line6_pod *pod = line6_to_pod(line6);
277 switch (pod->startup_progress) {
278 case POD_STARTUP_VERSIONREQ:
279 /* request firmware version: */
280 line6_version_request_async(line6);
282 case POD_STARTUP_SETUP:
284 line6_read_serial_number(&pod->line6, &pod->serial_number);
286 /* ALSA audio interface: */
287 if (snd_card_register(line6->card))
288 dev_err(line6->ifcdev, "Failed to register POD card.\n");
289 pod->startup_progress = POD_STARTUP_DONE;
296 /* POD special files: */
297 static DEVICE_ATTR_RO(device_id);
298 static DEVICE_ATTR_RO(firmware_version);
299 static DEVICE_ATTR_RO(serial_number);
301 static struct attribute *pod_dev_attrs[] = {
302 &dev_attr_device_id.attr,
303 &dev_attr_firmware_version.attr,
304 &dev_attr_serial_number.attr,
308 static const struct attribute_group pod_dev_attr_group = {
310 .attrs = pod_dev_attrs,
313 /* control info callback */
314 static int snd_pod_control_monitor_info(struct snd_kcontrol *kcontrol,
315 struct snd_ctl_elem_info *uinfo)
317 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
319 uinfo->value.integer.min = 0;
320 uinfo->value.integer.max = 65535;
324 /* control get callback */
325 static int snd_pod_control_monitor_get(struct snd_kcontrol *kcontrol,
326 struct snd_ctl_elem_value *ucontrol)
328 struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
329 struct usb_line6_pod *pod = line6_to_pod(line6pcm->line6);
331 ucontrol->value.integer.value[0] = pod->monitor_level;
335 /* control put callback */
336 static int snd_pod_control_monitor_put(struct snd_kcontrol *kcontrol,
337 struct snd_ctl_elem_value *ucontrol)
339 struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
340 struct usb_line6_pod *pod = line6_to_pod(line6pcm->line6);
342 if (ucontrol->value.integer.value[0] == pod->monitor_level)
345 pod->monitor_level = ucontrol->value.integer.value[0];
346 pod_set_system_param_int(pod, ucontrol->value.integer.value[0],
351 /* control definition */
352 static const struct snd_kcontrol_new pod_control_monitor = {
353 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
354 .name = "Monitor Playback Volume",
356 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
357 .info = snd_pod_control_monitor_info,
358 .get = snd_pod_control_monitor_get,
359 .put = snd_pod_control_monitor_put
363 Try to init POD device.
365 static int pod_init(struct usb_line6 *line6,
366 const struct usb_device_id *id)
369 struct usb_line6_pod *pod = line6_to_pod(line6);
371 line6->process_message = line6_pod_process_message;
372 line6->startup = pod_startup;
374 /* create sysfs entries: */
375 err = snd_card_add_dev_attr(line6->card, &pod_dev_attr_group);
379 /* initialize PCM subsystem: */
380 err = line6_init_pcm(line6, &pod_pcm_properties);
384 /* register monitor control: */
385 err = snd_ctl_add(line6->card,
386 snd_ctl_new1(&pod_control_monitor, line6->line6pcm));
391 When the sound card is registered at this point, the PODxt Live
392 displays "Invalid Code Error 07", so we do it later in the event
396 if (pod->line6.properties->capabilities & LINE6_CAP_CONTROL) {
397 pod->monitor_level = POD_SYSTEM_INVALID;
399 /* initiate startup procedure: */
400 schedule_delayed_work(&line6->startup_work,
401 msecs_to_jiffies(POD_STARTUP_DELAY));
407 #define LINE6_DEVICE(prod) USB_DEVICE(0x0e41, prod)
408 #define LINE6_IF_NUM(prod, n) USB_DEVICE_INTERFACE_NUMBER(0x0e41, prod, n)
410 /* table of devices that work with this driver */
411 static const struct usb_device_id pod_id_table[] = {
412 { LINE6_DEVICE(0x4250), .driver_info = LINE6_BASSPODXT },
413 { LINE6_DEVICE(0x4642), .driver_info = LINE6_BASSPODXTLIVE },
414 { LINE6_DEVICE(0x4252), .driver_info = LINE6_BASSPODXTPRO },
415 { LINE6_IF_NUM(0x5051, 1), .driver_info = LINE6_POCKETPOD },
416 { LINE6_DEVICE(0x5044), .driver_info = LINE6_PODXT },
417 { LINE6_IF_NUM(0x4650, 0), .driver_info = LINE6_PODXTLIVE_POD },
418 { LINE6_DEVICE(0x5050), .driver_info = LINE6_PODXTPRO },
422 MODULE_DEVICE_TABLE(usb, pod_id_table);
424 static const struct line6_properties pod_properties_table[] = {
425 [LINE6_BASSPODXT] = {
428 .capabilities = LINE6_CAP_CONTROL
429 | LINE6_CAP_CONTROL_MIDI
438 [LINE6_BASSPODXTLIVE] = {
439 .id = "BassPODxtLive",
440 .name = "BassPODxt Live",
441 .capabilities = LINE6_CAP_CONTROL
442 | LINE6_CAP_CONTROL_MIDI
451 [LINE6_BASSPODXTPRO] = {
452 .id = "BassPODxtPro",
453 .name = "BassPODxt Pro",
454 .capabilities = LINE6_CAP_CONTROL
455 | LINE6_CAP_CONTROL_MIDI
464 [LINE6_POCKETPOD] = {
466 .name = "Pocket POD",
467 .capabilities = LINE6_CAP_CONTROL
468 | LINE6_CAP_CONTROL_MIDI,
472 /* no audio channel */
477 .capabilities = LINE6_CAP_CONTROL
478 | LINE6_CAP_CONTROL_MIDI
487 [LINE6_PODXTLIVE_POD] = {
489 .name = "PODxt Live",
490 .capabilities = LINE6_CAP_CONTROL
491 | LINE6_CAP_CONTROL_MIDI
503 .capabilities = LINE6_CAP_CONTROL
504 | LINE6_CAP_CONTROL_MIDI
518 static int pod_probe(struct usb_interface *interface,
519 const struct usb_device_id *id)
521 return line6_probe(interface, id, "Line6-POD",
522 &pod_properties_table[id->driver_info],
523 pod_init, sizeof(struct usb_line6_pod));
526 static struct usb_driver pod_driver = {
527 .name = KBUILD_MODNAME,
529 .disconnect = line6_disconnect,
531 .suspend = line6_suspend,
532 .resume = line6_resume,
533 .reset_resume = line6_resume,
535 .id_table = pod_id_table,
538 module_usb_driver(pod_driver);
540 MODULE_DESCRIPTION("Line 6 POD USB driver");
541 MODULE_LICENSE("GPL");