Loading...
1// SPDX-License-Identifier: GPL-2.0-or-later
2/*
3 * caiaq.c: ALSA driver for caiaq/NativeInstruments devices
4 *
5 * Copyright (c) 2007 Daniel Mack <daniel@caiaq.de>
6 * Karsten Wiese <fzu@wemgehoertderstaat.de>
7*/
8
9#include <linux/moduleparam.h>
10#include <linux/device.h>
11#include <linux/interrupt.h>
12#include <linux/module.h>
13#include <linux/init.h>
14#include <linux/gfp.h>
15#include <linux/usb.h>
16#include <sound/initval.h>
17#include <sound/core.h>
18#include <sound/pcm.h>
19
20#include "device.h"
21#include "audio.h"
22#include "midi.h"
23#include "control.h"
24#include "input.h"
25
26MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
27MODULE_DESCRIPTION("caiaq USB audio");
28MODULE_LICENSE("GPL");
29
30static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-max */
31static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* Id for this card */
32static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
33
34module_param_array(index, int, NULL, 0444);
35MODULE_PARM_DESC(index, "Index value for the caiaq sound device");
36module_param_array(id, charp, NULL, 0444);
37MODULE_PARM_DESC(id, "ID string for the caiaq soundcard.");
38module_param_array(enable, bool, NULL, 0444);
39MODULE_PARM_DESC(enable, "Enable the caiaq soundcard.");
40
41enum {
42 SAMPLERATE_44100 = 0,
43 SAMPLERATE_48000 = 1,
44 SAMPLERATE_96000 = 2,
45 SAMPLERATE_192000 = 3,
46 SAMPLERATE_88200 = 4,
47 SAMPLERATE_INVALID = 0xff
48};
49
50enum {
51 DEPTH_NONE = 0,
52 DEPTH_16 = 1,
53 DEPTH_24 = 2,
54 DEPTH_32 = 3
55};
56
57static const struct usb_device_id snd_usb_id_table[] = {
58 {
59 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
60 .idVendor = USB_VID_NATIVEINSTRUMENTS,
61 .idProduct = USB_PID_RIGKONTROL2
62 },
63 {
64 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
65 .idVendor = USB_VID_NATIVEINSTRUMENTS,
66 .idProduct = USB_PID_RIGKONTROL3
67 },
68 {
69 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
70 .idVendor = USB_VID_NATIVEINSTRUMENTS,
71 .idProduct = USB_PID_KORECONTROLLER
72 },
73 {
74 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
75 .idVendor = USB_VID_NATIVEINSTRUMENTS,
76 .idProduct = USB_PID_KORECONTROLLER2
77 },
78 {
79 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
80 .idVendor = USB_VID_NATIVEINSTRUMENTS,
81 .idProduct = USB_PID_AK1
82 },
83 {
84 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
85 .idVendor = USB_VID_NATIVEINSTRUMENTS,
86 .idProduct = USB_PID_AUDIO8DJ
87 },
88 {
89 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
90 .idVendor = USB_VID_NATIVEINSTRUMENTS,
91 .idProduct = USB_PID_SESSIONIO
92 },
93 {
94 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
95 .idVendor = USB_VID_NATIVEINSTRUMENTS,
96 .idProduct = USB_PID_GUITARRIGMOBILE
97 },
98 {
99 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
100 .idVendor = USB_VID_NATIVEINSTRUMENTS,
101 .idProduct = USB_PID_AUDIO4DJ
102 },
103 {
104 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
105 .idVendor = USB_VID_NATIVEINSTRUMENTS,
106 .idProduct = USB_PID_AUDIO2DJ
107 },
108 {
109 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
110 .idVendor = USB_VID_NATIVEINSTRUMENTS,
111 .idProduct = USB_PID_TRAKTORKONTROLX1
112 },
113 {
114 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
115 .idVendor = USB_VID_NATIVEINSTRUMENTS,
116 .idProduct = USB_PID_TRAKTORKONTROLS4
117 },
118 {
119 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
120 .idVendor = USB_VID_NATIVEINSTRUMENTS,
121 .idProduct = USB_PID_TRAKTORAUDIO2
122 },
123 {
124 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
125 .idVendor = USB_VID_NATIVEINSTRUMENTS,
126 .idProduct = USB_PID_MASCHINECONTROLLER
127 },
128 { /* terminator */ }
129};
130
131static void usb_ep1_command_reply_dispatch (struct urb* urb)
132{
133 int ret;
134 struct device *dev = &urb->dev->dev;
135 struct snd_usb_caiaqdev *cdev = urb->context;
136 unsigned char *buf = urb->transfer_buffer;
137
138 if (urb->status || !cdev) {
139 dev_warn(dev, "received EP1 urb->status = %i\n", urb->status);
140 return;
141 }
142
143 switch(buf[0]) {
144 case EP1_CMD_GET_DEVICE_INFO:
145 memcpy(&cdev->spec, buf+1, sizeof(struct caiaq_device_spec));
146 cdev->spec.fw_version = le16_to_cpu(cdev->spec.fw_version);
147 dev_dbg(dev, "device spec (firmware %d): audio: %d in, %d out, "
148 "MIDI: %d in, %d out, data alignment %d\n",
149 cdev->spec.fw_version,
150 cdev->spec.num_analog_audio_in,
151 cdev->spec.num_analog_audio_out,
152 cdev->spec.num_midi_in,
153 cdev->spec.num_midi_out,
154 cdev->spec.data_alignment);
155
156 cdev->spec_received++;
157 wake_up(&cdev->ep1_wait_queue);
158 break;
159 case EP1_CMD_AUDIO_PARAMS:
160 cdev->audio_parm_answer = buf[1];
161 wake_up(&cdev->ep1_wait_queue);
162 break;
163 case EP1_CMD_MIDI_READ:
164 snd_usb_caiaq_midi_handle_input(cdev, buf[1], buf + 3, buf[2]);
165 break;
166 case EP1_CMD_READ_IO:
167 if (cdev->chip.usb_id ==
168 USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ)) {
169 if (urb->actual_length > sizeof(cdev->control_state))
170 urb->actual_length = sizeof(cdev->control_state);
171 memcpy(cdev->control_state, buf + 1, urb->actual_length);
172 wake_up(&cdev->ep1_wait_queue);
173 break;
174 }
175#ifdef CONFIG_SND_USB_CAIAQ_INPUT
176 fallthrough;
177 case EP1_CMD_READ_ERP:
178 case EP1_CMD_READ_ANALOG:
179 snd_usb_caiaq_input_dispatch(cdev, buf, urb->actual_length);
180#endif
181 break;
182 }
183
184 cdev->ep1_in_urb.actual_length = 0;
185 ret = usb_submit_urb(&cdev->ep1_in_urb, GFP_ATOMIC);
186 if (ret < 0)
187 dev_err(dev, "unable to submit urb. OOM!?\n");
188}
189
190int snd_usb_caiaq_send_command(struct snd_usb_caiaqdev *cdev,
191 unsigned char command,
192 const unsigned char *buffer,
193 int len)
194{
195 int actual_len;
196 struct usb_device *usb_dev = cdev->chip.dev;
197
198 if (!usb_dev)
199 return -EIO;
200
201 if (len > EP1_BUFSIZE - 1)
202 len = EP1_BUFSIZE - 1;
203
204 if (buffer && len > 0)
205 memcpy(cdev->ep1_out_buf+1, buffer, len);
206
207 cdev->ep1_out_buf[0] = command;
208 return usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, 1),
209 cdev->ep1_out_buf, len+1, &actual_len, 200);
210}
211
212int snd_usb_caiaq_send_command_bank(struct snd_usb_caiaqdev *cdev,
213 unsigned char command,
214 unsigned char bank,
215 const unsigned char *buffer,
216 int len)
217{
218 int actual_len;
219 struct usb_device *usb_dev = cdev->chip.dev;
220
221 if (!usb_dev)
222 return -EIO;
223
224 if (len > EP1_BUFSIZE - 2)
225 len = EP1_BUFSIZE - 2;
226
227 if (buffer && len > 0)
228 memcpy(cdev->ep1_out_buf+2, buffer, len);
229
230 cdev->ep1_out_buf[0] = command;
231 cdev->ep1_out_buf[1] = bank;
232
233 return usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, 1),
234 cdev->ep1_out_buf, len+2, &actual_len, 200);
235}
236
237int snd_usb_caiaq_set_audio_params (struct snd_usb_caiaqdev *cdev,
238 int rate, int depth, int bpp)
239{
240 int ret;
241 char tmp[5];
242 struct device *dev = caiaqdev_to_dev(cdev);
243
244 switch (rate) {
245 case 44100: tmp[0] = SAMPLERATE_44100; break;
246 case 48000: tmp[0] = SAMPLERATE_48000; break;
247 case 88200: tmp[0] = SAMPLERATE_88200; break;
248 case 96000: tmp[0] = SAMPLERATE_96000; break;
249 case 192000: tmp[0] = SAMPLERATE_192000; break;
250 default: return -EINVAL;
251 }
252
253 switch (depth) {
254 case 16: tmp[1] = DEPTH_16; break;
255 case 24: tmp[1] = DEPTH_24; break;
256 default: return -EINVAL;
257 }
258
259 tmp[2] = bpp & 0xff;
260 tmp[3] = bpp >> 8;
261 tmp[4] = 1; /* packets per microframe */
262
263 dev_dbg(dev, "setting audio params: %d Hz, %d bits, %d bpp\n",
264 rate, depth, bpp);
265
266 cdev->audio_parm_answer = -1;
267 ret = snd_usb_caiaq_send_command(cdev, EP1_CMD_AUDIO_PARAMS,
268 tmp, sizeof(tmp));
269
270 if (ret)
271 return ret;
272
273 if (!wait_event_timeout(cdev->ep1_wait_queue,
274 cdev->audio_parm_answer >= 0, HZ))
275 return -EPIPE;
276
277 if (cdev->audio_parm_answer != 1)
278 dev_dbg(dev, "unable to set the device's audio params\n");
279 else
280 cdev->bpp = bpp;
281
282 return cdev->audio_parm_answer == 1 ? 0 : -EINVAL;
283}
284
285int snd_usb_caiaq_set_auto_msg(struct snd_usb_caiaqdev *cdev,
286 int digital, int analog, int erp)
287{
288 char tmp[3] = { digital, analog, erp };
289 return snd_usb_caiaq_send_command(cdev, EP1_CMD_AUTO_MSG,
290 tmp, sizeof(tmp));
291}
292
293static void setup_card(struct snd_usb_caiaqdev *cdev)
294{
295 int ret;
296 char val[4];
297 struct device *dev = caiaqdev_to_dev(cdev);
298
299 /* device-specific startup specials */
300 switch (cdev->chip.usb_id) {
301 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL2):
302 /* RigKontrol2 - display centered dash ('-') */
303 val[0] = 0x00;
304 val[1] = 0x00;
305 val[2] = 0x01;
306 snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 3);
307 break;
308 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
309 /* RigKontrol2 - display two centered dashes ('--') */
310 val[0] = 0x00;
311 val[1] = 0x40;
312 val[2] = 0x40;
313 val[3] = 0x00;
314 snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 4);
315 break;
316 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
317 /* Audio Kontrol 1 - make USB-LED stop blinking */
318 val[0] = 0x00;
319 snd_usb_caiaq_send_command(cdev, EP1_CMD_WRITE_IO, val, 1);
320 break;
321 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
322 /* Audio 8 DJ - trigger read of current settings */
323 cdev->control_state[0] = 0xff;
324 snd_usb_caiaq_set_auto_msg(cdev, 1, 0, 0);
325 snd_usb_caiaq_send_command(cdev, EP1_CMD_READ_IO, NULL, 0);
326
327 if (!wait_event_timeout(cdev->ep1_wait_queue,
328 cdev->control_state[0] != 0xff, HZ))
329 return;
330
331 /* fix up some defaults */
332 if ((cdev->control_state[1] != 2) ||
333 (cdev->control_state[2] != 3) ||
334 (cdev->control_state[4] != 2)) {
335 cdev->control_state[1] = 2;
336 cdev->control_state[2] = 3;
337 cdev->control_state[4] = 2;
338 snd_usb_caiaq_send_command(cdev,
339 EP1_CMD_WRITE_IO, cdev->control_state, 6);
340 }
341
342 break;
343 }
344
345 if (cdev->spec.num_analog_audio_out +
346 cdev->spec.num_analog_audio_in +
347 cdev->spec.num_digital_audio_out +
348 cdev->spec.num_digital_audio_in > 0) {
349 ret = snd_usb_caiaq_audio_init(cdev);
350 if (ret < 0)
351 dev_err(dev, "Unable to set up audio system (ret=%d)\n", ret);
352 }
353
354 if (cdev->spec.num_midi_in +
355 cdev->spec.num_midi_out > 0) {
356 ret = snd_usb_caiaq_midi_init(cdev);
357 if (ret < 0)
358 dev_err(dev, "Unable to set up MIDI system (ret=%d)\n", ret);
359 }
360
361#ifdef CONFIG_SND_USB_CAIAQ_INPUT
362 ret = snd_usb_caiaq_input_init(cdev);
363 if (ret < 0)
364 dev_err(dev, "Unable to set up input system (ret=%d)\n", ret);
365#endif
366
367 /* finally, register the card and all its sub-instances */
368 ret = snd_card_register(cdev->chip.card);
369 if (ret < 0) {
370 dev_err(dev, "snd_card_register() returned %d\n", ret);
371 snd_card_free(cdev->chip.card);
372 }
373
374 ret = snd_usb_caiaq_control_init(cdev);
375 if (ret < 0)
376 dev_err(dev, "Unable to set up control system (ret=%d)\n", ret);
377}
378
379static void card_free(struct snd_card *card)
380{
381 struct snd_usb_caiaqdev *cdev = caiaqdev(card);
382
383#ifdef CONFIG_SND_USB_CAIAQ_INPUT
384 snd_usb_caiaq_input_free(cdev);
385#endif
386 snd_usb_caiaq_audio_free(cdev);
387 usb_reset_device(cdev->chip.dev);
388}
389
390static int create_card(struct usb_device *usb_dev,
391 struct usb_interface *intf,
392 struct snd_card **cardp)
393{
394 int devnum;
395 int err;
396 struct snd_card *card;
397 struct snd_usb_caiaqdev *cdev;
398
399 for (devnum = 0; devnum < SNDRV_CARDS; devnum++)
400 if (enable[devnum])
401 break;
402
403 if (devnum >= SNDRV_CARDS)
404 return -ENODEV;
405
406 err = snd_card_new(&intf->dev,
407 index[devnum], id[devnum], THIS_MODULE,
408 sizeof(struct snd_usb_caiaqdev), &card);
409 if (err < 0)
410 return err;
411
412 cdev = caiaqdev(card);
413 cdev->chip.dev = usb_dev;
414 cdev->chip.card = card;
415 cdev->chip.usb_id = USB_ID(le16_to_cpu(usb_dev->descriptor.idVendor),
416 le16_to_cpu(usb_dev->descriptor.idProduct));
417 spin_lock_init(&cdev->spinlock);
418
419 *cardp = card;
420 return 0;
421}
422
423static int init_card(struct snd_usb_caiaqdev *cdev)
424{
425 char *c, usbpath[32];
426 struct usb_device *usb_dev = cdev->chip.dev;
427 struct snd_card *card = cdev->chip.card;
428 struct device *dev = caiaqdev_to_dev(cdev);
429 int err, len;
430
431 if (usb_set_interface(usb_dev, 0, 1) != 0) {
432 dev_err(dev, "can't set alt interface.\n");
433 return -EIO;
434 }
435
436 usb_init_urb(&cdev->ep1_in_urb);
437 usb_init_urb(&cdev->midi_out_urb);
438
439 usb_fill_bulk_urb(&cdev->ep1_in_urb, usb_dev,
440 usb_rcvbulkpipe(usb_dev, 0x1),
441 cdev->ep1_in_buf, EP1_BUFSIZE,
442 usb_ep1_command_reply_dispatch, cdev);
443
444 usb_fill_bulk_urb(&cdev->midi_out_urb, usb_dev,
445 usb_sndbulkpipe(usb_dev, 0x1),
446 cdev->midi_out_buf, EP1_BUFSIZE,
447 snd_usb_caiaq_midi_output_done, cdev);
448
449 /* sanity checks of EPs before actually submitting */
450 if (usb_urb_ep_type_check(&cdev->ep1_in_urb) ||
451 usb_urb_ep_type_check(&cdev->midi_out_urb)) {
452 dev_err(dev, "invalid EPs\n");
453 return -EINVAL;
454 }
455
456 init_waitqueue_head(&cdev->ep1_wait_queue);
457 init_waitqueue_head(&cdev->prepare_wait_queue);
458
459 if (usb_submit_urb(&cdev->ep1_in_urb, GFP_KERNEL) != 0)
460 return -EIO;
461
462 err = snd_usb_caiaq_send_command(cdev, EP1_CMD_GET_DEVICE_INFO, NULL, 0);
463 if (err)
464 goto err_kill_urb;
465
466 if (!wait_event_timeout(cdev->ep1_wait_queue, cdev->spec_received, HZ)) {
467 err = -ENODEV;
468 goto err_kill_urb;
469 }
470
471 usb_string(usb_dev, usb_dev->descriptor.iManufacturer,
472 cdev->vendor_name, CAIAQ_USB_STR_LEN);
473
474 usb_string(usb_dev, usb_dev->descriptor.iProduct,
475 cdev->product_name, CAIAQ_USB_STR_LEN);
476
477 strscpy(card->driver, MODNAME, sizeof(card->driver));
478 strscpy(card->shortname, cdev->product_name, sizeof(card->shortname));
479 strscpy(card->mixername, cdev->product_name, sizeof(card->mixername));
480
481 /* if the id was not passed as module option, fill it with a shortened
482 * version of the product string which does not contain any
483 * whitespaces */
484
485 if (*card->id == '\0') {
486 char id[sizeof(card->id)];
487
488 memset(id, 0, sizeof(id));
489
490 for (c = card->shortname, len = 0;
491 *c && len < sizeof(card->id); c++)
492 if (*c != ' ')
493 id[len++] = *c;
494
495 snd_card_set_id(card, id);
496 }
497
498 usb_make_path(usb_dev, usbpath, sizeof(usbpath));
499 scnprintf(card->longname, sizeof(card->longname), "%s %s (%s)",
500 cdev->vendor_name, cdev->product_name, usbpath);
501
502 setup_card(cdev);
503 card->private_free = card_free;
504 return 0;
505
506 err_kill_urb:
507 usb_kill_urb(&cdev->ep1_in_urb);
508 return err;
509}
510
511static int snd_probe(struct usb_interface *intf,
512 const struct usb_device_id *id)
513{
514 int ret;
515 struct snd_card *card = NULL;
516 struct usb_device *usb_dev = interface_to_usbdev(intf);
517
518 ret = create_card(usb_dev, intf, &card);
519
520 if (ret < 0)
521 return ret;
522
523 usb_set_intfdata(intf, card);
524 ret = init_card(caiaqdev(card));
525 if (ret < 0) {
526 dev_err(&usb_dev->dev, "unable to init card! (ret=%d)\n", ret);
527 snd_card_free(card);
528 return ret;
529 }
530
531 return 0;
532}
533
534static void snd_disconnect(struct usb_interface *intf)
535{
536 struct snd_card *card = usb_get_intfdata(intf);
537 struct device *dev = intf->usb_dev;
538 struct snd_usb_caiaqdev *cdev;
539
540 if (!card)
541 return;
542
543 cdev = caiaqdev(card);
544 dev_dbg(dev, "%s(%p)\n", __func__, intf);
545
546 snd_card_disconnect(card);
547
548#ifdef CONFIG_SND_USB_CAIAQ_INPUT
549 snd_usb_caiaq_input_disconnect(cdev);
550#endif
551 snd_usb_caiaq_audio_disconnect(cdev);
552
553 usb_kill_urb(&cdev->ep1_in_urb);
554 usb_kill_urb(&cdev->midi_out_urb);
555
556 snd_card_free_when_closed(card);
557}
558
559
560MODULE_DEVICE_TABLE(usb, snd_usb_id_table);
561static struct usb_driver snd_usb_driver = {
562 .name = MODNAME,
563 .probe = snd_probe,
564 .disconnect = snd_disconnect,
565 .id_table = snd_usb_id_table,
566};
567
568module_usb_driver(snd_usb_driver);
1/*
2 * caiaq.c: ALSA driver for caiaq/NativeInstruments devices
3 *
4 * Copyright (c) 2007 Daniel Mack <daniel@caiaq.de>
5 * Karsten Wiese <fzu@wemgehoertderstaat.de>
6 *
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
11 *
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
16 *
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
20*/
21
22#include <linux/moduleparam.h>
23#include <linux/interrupt.h>
24#include <linux/module.h>
25#include <linux/init.h>
26#include <linux/gfp.h>
27#include <linux/usb.h>
28#include <sound/initval.h>
29#include <sound/core.h>
30#include <sound/pcm.h>
31
32#include "device.h"
33#include "audio.h"
34#include "midi.h"
35#include "control.h"
36#include "input.h"
37
38MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
39MODULE_DESCRIPTION("caiaq USB audio");
40MODULE_LICENSE("GPL");
41MODULE_SUPPORTED_DEVICE("{{Native Instruments, RigKontrol2},"
42 "{Native Instruments, RigKontrol3},"
43 "{Native Instruments, Kore Controller},"
44 "{Native Instruments, Kore Controller 2},"
45 "{Native Instruments, Audio Kontrol 1},"
46 "{Native Instruments, Audio 2 DJ},"
47 "{Native Instruments, Audio 4 DJ},"
48 "{Native Instruments, Audio 8 DJ},"
49 "{Native Instruments, Traktor Audio 2},"
50 "{Native Instruments, Session I/O},"
51 "{Native Instruments, GuitarRig mobile}"
52 "{Native Instruments, Traktor Kontrol X1}"
53 "{Native Instruments, Traktor Kontrol S4}");
54
55static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-max */
56static char* id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* Id for this card */
57static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; /* Enable this card */
58static int snd_card_used[SNDRV_CARDS];
59
60module_param_array(index, int, NULL, 0444);
61MODULE_PARM_DESC(index, "Index value for the caiaq sound device");
62module_param_array(id, charp, NULL, 0444);
63MODULE_PARM_DESC(id, "ID string for the caiaq soundcard.");
64module_param_array(enable, bool, NULL, 0444);
65MODULE_PARM_DESC(enable, "Enable the caiaq soundcard.");
66
67enum {
68 SAMPLERATE_44100 = 0,
69 SAMPLERATE_48000 = 1,
70 SAMPLERATE_96000 = 2,
71 SAMPLERATE_192000 = 3,
72 SAMPLERATE_88200 = 4,
73 SAMPLERATE_INVALID = 0xff
74};
75
76enum {
77 DEPTH_NONE = 0,
78 DEPTH_16 = 1,
79 DEPTH_24 = 2,
80 DEPTH_32 = 3
81};
82
83static struct usb_device_id snd_usb_id_table[] = {
84 {
85 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
86 .idVendor = USB_VID_NATIVEINSTRUMENTS,
87 .idProduct = USB_PID_RIGKONTROL2
88 },
89 {
90 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
91 .idVendor = USB_VID_NATIVEINSTRUMENTS,
92 .idProduct = USB_PID_RIGKONTROL3
93 },
94 {
95 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
96 .idVendor = USB_VID_NATIVEINSTRUMENTS,
97 .idProduct = USB_PID_KORECONTROLLER
98 },
99 {
100 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
101 .idVendor = USB_VID_NATIVEINSTRUMENTS,
102 .idProduct = USB_PID_KORECONTROLLER2
103 },
104 {
105 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
106 .idVendor = USB_VID_NATIVEINSTRUMENTS,
107 .idProduct = USB_PID_AK1
108 },
109 {
110 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
111 .idVendor = USB_VID_NATIVEINSTRUMENTS,
112 .idProduct = USB_PID_AUDIO8DJ
113 },
114 {
115 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
116 .idVendor = USB_VID_NATIVEINSTRUMENTS,
117 .idProduct = USB_PID_SESSIONIO
118 },
119 {
120 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
121 .idVendor = USB_VID_NATIVEINSTRUMENTS,
122 .idProduct = USB_PID_GUITARRIGMOBILE
123 },
124 {
125 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
126 .idVendor = USB_VID_NATIVEINSTRUMENTS,
127 .idProduct = USB_PID_AUDIO4DJ
128 },
129 {
130 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
131 .idVendor = USB_VID_NATIVEINSTRUMENTS,
132 .idProduct = USB_PID_AUDIO2DJ
133 },
134 {
135 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
136 .idVendor = USB_VID_NATIVEINSTRUMENTS,
137 .idProduct = USB_PID_TRAKTORKONTROLX1
138 },
139 {
140 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
141 .idVendor = USB_VID_NATIVEINSTRUMENTS,
142 .idProduct = USB_PID_TRAKTORKONTROLS4
143 },
144 {
145 .match_flags = USB_DEVICE_ID_MATCH_DEVICE,
146 .idVendor = USB_VID_NATIVEINSTRUMENTS,
147 .idProduct = USB_PID_TRAKTORAUDIO2
148 },
149 { /* terminator */ }
150};
151
152static void usb_ep1_command_reply_dispatch (struct urb* urb)
153{
154 int ret;
155 struct snd_usb_caiaqdev *dev = urb->context;
156 unsigned char *buf = urb->transfer_buffer;
157
158 if (urb->status || !dev) {
159 log("received EP1 urb->status = %i\n", urb->status);
160 return;
161 }
162
163 switch(buf[0]) {
164 case EP1_CMD_GET_DEVICE_INFO:
165 memcpy(&dev->spec, buf+1, sizeof(struct caiaq_device_spec));
166 dev->spec.fw_version = le16_to_cpu(dev->spec.fw_version);
167 debug("device spec (firmware %d): audio: %d in, %d out, "
168 "MIDI: %d in, %d out, data alignment %d\n",
169 dev->spec.fw_version,
170 dev->spec.num_analog_audio_in,
171 dev->spec.num_analog_audio_out,
172 dev->spec.num_midi_in,
173 dev->spec.num_midi_out,
174 dev->spec.data_alignment);
175
176 dev->spec_received++;
177 wake_up(&dev->ep1_wait_queue);
178 break;
179 case EP1_CMD_AUDIO_PARAMS:
180 dev->audio_parm_answer = buf[1];
181 wake_up(&dev->ep1_wait_queue);
182 break;
183 case EP1_CMD_MIDI_READ:
184 snd_usb_caiaq_midi_handle_input(dev, buf[1], buf + 3, buf[2]);
185 break;
186 case EP1_CMD_READ_IO:
187 if (dev->chip.usb_id ==
188 USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ)) {
189 if (urb->actual_length > sizeof(dev->control_state))
190 urb->actual_length = sizeof(dev->control_state);
191 memcpy(dev->control_state, buf + 1, urb->actual_length);
192 wake_up(&dev->ep1_wait_queue);
193 break;
194 }
195#ifdef CONFIG_SND_USB_CAIAQ_INPUT
196 case EP1_CMD_READ_ERP:
197 case EP1_CMD_READ_ANALOG:
198 snd_usb_caiaq_input_dispatch(dev, buf, urb->actual_length);
199#endif
200 break;
201 }
202
203 dev->ep1_in_urb.actual_length = 0;
204 ret = usb_submit_urb(&dev->ep1_in_urb, GFP_ATOMIC);
205 if (ret < 0)
206 log("unable to submit urb. OOM!?\n");
207}
208
209int snd_usb_caiaq_send_command(struct snd_usb_caiaqdev *dev,
210 unsigned char command,
211 const unsigned char *buffer,
212 int len)
213{
214 int actual_len;
215 struct usb_device *usb_dev = dev->chip.dev;
216
217 if (!usb_dev)
218 return -EIO;
219
220 if (len > EP1_BUFSIZE - 1)
221 len = EP1_BUFSIZE - 1;
222
223 if (buffer && len > 0)
224 memcpy(dev->ep1_out_buf+1, buffer, len);
225
226 dev->ep1_out_buf[0] = command;
227 return usb_bulk_msg(usb_dev, usb_sndbulkpipe(usb_dev, 1),
228 dev->ep1_out_buf, len+1, &actual_len, 200);
229}
230
231int snd_usb_caiaq_set_audio_params (struct snd_usb_caiaqdev *dev,
232 int rate, int depth, int bpp)
233{
234 int ret;
235 char tmp[5];
236
237 switch (rate) {
238 case 44100: tmp[0] = SAMPLERATE_44100; break;
239 case 48000: tmp[0] = SAMPLERATE_48000; break;
240 case 88200: tmp[0] = SAMPLERATE_88200; break;
241 case 96000: tmp[0] = SAMPLERATE_96000; break;
242 case 192000: tmp[0] = SAMPLERATE_192000; break;
243 default: return -EINVAL;
244 }
245
246 switch (depth) {
247 case 16: tmp[1] = DEPTH_16; break;
248 case 24: tmp[1] = DEPTH_24; break;
249 default: return -EINVAL;
250 }
251
252 tmp[2] = bpp & 0xff;
253 tmp[3] = bpp >> 8;
254 tmp[4] = 1; /* packets per microframe */
255
256 debug("setting audio params: %d Hz, %d bits, %d bpp\n",
257 rate, depth, bpp);
258
259 dev->audio_parm_answer = -1;
260 ret = snd_usb_caiaq_send_command(dev, EP1_CMD_AUDIO_PARAMS,
261 tmp, sizeof(tmp));
262
263 if (ret)
264 return ret;
265
266 if (!wait_event_timeout(dev->ep1_wait_queue,
267 dev->audio_parm_answer >= 0, HZ))
268 return -EPIPE;
269
270 if (dev->audio_parm_answer != 1)
271 debug("unable to set the device's audio params\n");
272 else
273 dev->bpp = bpp;
274
275 return dev->audio_parm_answer == 1 ? 0 : -EINVAL;
276}
277
278int snd_usb_caiaq_set_auto_msg(struct snd_usb_caiaqdev *dev,
279 int digital, int analog, int erp)
280{
281 char tmp[3] = { digital, analog, erp };
282 return snd_usb_caiaq_send_command(dev, EP1_CMD_AUTO_MSG,
283 tmp, sizeof(tmp));
284}
285
286static void __devinit setup_card(struct snd_usb_caiaqdev *dev)
287{
288 int ret;
289 char val[4];
290
291 /* device-specific startup specials */
292 switch (dev->chip.usb_id) {
293 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL2):
294 /* RigKontrol2 - display centered dash ('-') */
295 val[0] = 0x00;
296 val[1] = 0x00;
297 val[2] = 0x01;
298 snd_usb_caiaq_send_command(dev, EP1_CMD_WRITE_IO, val, 3);
299 break;
300 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
301 /* RigKontrol2 - display two centered dashes ('--') */
302 val[0] = 0x00;
303 val[1] = 0x40;
304 val[2] = 0x40;
305 val[3] = 0x00;
306 snd_usb_caiaq_send_command(dev, EP1_CMD_WRITE_IO, val, 4);
307 break;
308 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
309 /* Audio Kontrol 1 - make USB-LED stop blinking */
310 val[0] = 0x00;
311 snd_usb_caiaq_send_command(dev, EP1_CMD_WRITE_IO, val, 1);
312 break;
313 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
314 /* Audio 8 DJ - trigger read of current settings */
315 dev->control_state[0] = 0xff;
316 snd_usb_caiaq_set_auto_msg(dev, 1, 0, 0);
317 snd_usb_caiaq_send_command(dev, EP1_CMD_READ_IO, NULL, 0);
318
319 if (!wait_event_timeout(dev->ep1_wait_queue,
320 dev->control_state[0] != 0xff, HZ))
321 return;
322
323 /* fix up some defaults */
324 if ((dev->control_state[1] != 2) ||
325 (dev->control_state[2] != 3) ||
326 (dev->control_state[4] != 2)) {
327 dev->control_state[1] = 2;
328 dev->control_state[2] = 3;
329 dev->control_state[4] = 2;
330 snd_usb_caiaq_send_command(dev,
331 EP1_CMD_WRITE_IO, dev->control_state, 6);
332 }
333
334 break;
335 }
336
337 if (dev->spec.num_analog_audio_out +
338 dev->spec.num_analog_audio_in +
339 dev->spec.num_digital_audio_out +
340 dev->spec.num_digital_audio_in > 0) {
341 ret = snd_usb_caiaq_audio_init(dev);
342 if (ret < 0)
343 log("Unable to set up audio system (ret=%d)\n", ret);
344 }
345
346 if (dev->spec.num_midi_in +
347 dev->spec.num_midi_out > 0) {
348 ret = snd_usb_caiaq_midi_init(dev);
349 if (ret < 0)
350 log("Unable to set up MIDI system (ret=%d)\n", ret);
351 }
352
353#ifdef CONFIG_SND_USB_CAIAQ_INPUT
354 ret = snd_usb_caiaq_input_init(dev);
355 if (ret < 0)
356 log("Unable to set up input system (ret=%d)\n", ret);
357#endif
358
359 /* finally, register the card and all its sub-instances */
360 ret = snd_card_register(dev->chip.card);
361 if (ret < 0) {
362 log("snd_card_register() returned %d\n", ret);
363 snd_card_free(dev->chip.card);
364 }
365
366 ret = snd_usb_caiaq_control_init(dev);
367 if (ret < 0)
368 log("Unable to set up control system (ret=%d)\n", ret);
369}
370
371static int create_card(struct usb_device *usb_dev,
372 struct usb_interface *intf,
373 struct snd_card **cardp)
374{
375 int devnum;
376 int err;
377 struct snd_card *card;
378 struct snd_usb_caiaqdev *dev;
379
380 for (devnum = 0; devnum < SNDRV_CARDS; devnum++)
381 if (enable[devnum] && !snd_card_used[devnum])
382 break;
383
384 if (devnum >= SNDRV_CARDS)
385 return -ENODEV;
386
387 err = snd_card_create(index[devnum], id[devnum], THIS_MODULE,
388 sizeof(struct snd_usb_caiaqdev), &card);
389 if (err < 0)
390 return err;
391
392 dev = caiaqdev(card);
393 dev->chip.dev = usb_dev;
394 dev->chip.card = card;
395 dev->chip.usb_id = USB_ID(le16_to_cpu(usb_dev->descriptor.idVendor),
396 le16_to_cpu(usb_dev->descriptor.idProduct));
397 spin_lock_init(&dev->spinlock);
398 snd_card_set_dev(card, &intf->dev);
399
400 *cardp = card;
401 return 0;
402}
403
404static int __devinit init_card(struct snd_usb_caiaqdev *dev)
405{
406 char *c, usbpath[32];
407 struct usb_device *usb_dev = dev->chip.dev;
408 struct snd_card *card = dev->chip.card;
409 int err, len;
410
411 if (usb_set_interface(usb_dev, 0, 1) != 0) {
412 log("can't set alt interface.\n");
413 return -EIO;
414 }
415
416 usb_init_urb(&dev->ep1_in_urb);
417 usb_init_urb(&dev->midi_out_urb);
418
419 usb_fill_bulk_urb(&dev->ep1_in_urb, usb_dev,
420 usb_rcvbulkpipe(usb_dev, 0x1),
421 dev->ep1_in_buf, EP1_BUFSIZE,
422 usb_ep1_command_reply_dispatch, dev);
423
424 usb_fill_bulk_urb(&dev->midi_out_urb, usb_dev,
425 usb_sndbulkpipe(usb_dev, 0x1),
426 dev->midi_out_buf, EP1_BUFSIZE,
427 snd_usb_caiaq_midi_output_done, dev);
428
429 init_waitqueue_head(&dev->ep1_wait_queue);
430 init_waitqueue_head(&dev->prepare_wait_queue);
431
432 if (usb_submit_urb(&dev->ep1_in_urb, GFP_KERNEL) != 0)
433 return -EIO;
434
435 err = snd_usb_caiaq_send_command(dev, EP1_CMD_GET_DEVICE_INFO, NULL, 0);
436 if (err)
437 return err;
438
439 if (!wait_event_timeout(dev->ep1_wait_queue, dev->spec_received, HZ))
440 return -ENODEV;
441
442 usb_string(usb_dev, usb_dev->descriptor.iManufacturer,
443 dev->vendor_name, CAIAQ_USB_STR_LEN);
444
445 usb_string(usb_dev, usb_dev->descriptor.iProduct,
446 dev->product_name, CAIAQ_USB_STR_LEN);
447
448 strlcpy(card->driver, MODNAME, sizeof(card->driver));
449 strlcpy(card->shortname, dev->product_name, sizeof(card->shortname));
450 strlcpy(card->mixername, dev->product_name, sizeof(card->mixername));
451
452 /* if the id was not passed as module option, fill it with a shortened
453 * version of the product string which does not contain any
454 * whitespaces */
455
456 if (*card->id == '\0') {
457 char id[sizeof(card->id)];
458
459 memset(id, 0, sizeof(id));
460
461 for (c = card->shortname, len = 0;
462 *c && len < sizeof(card->id); c++)
463 if (*c != ' ')
464 id[len++] = *c;
465
466 snd_card_set_id(card, id);
467 }
468
469 usb_make_path(usb_dev, usbpath, sizeof(usbpath));
470 snprintf(card->longname, sizeof(card->longname),
471 "%s %s (%s)",
472 dev->vendor_name, dev->product_name, usbpath);
473
474 setup_card(dev);
475 return 0;
476}
477
478static int __devinit snd_probe(struct usb_interface *intf,
479 const struct usb_device_id *id)
480{
481 int ret;
482 struct snd_card *card;
483 struct usb_device *device = interface_to_usbdev(intf);
484
485 ret = create_card(device, intf, &card);
486
487 if (ret < 0)
488 return ret;
489
490 usb_set_intfdata(intf, card);
491 ret = init_card(caiaqdev(card));
492 if (ret < 0) {
493 log("unable to init card! (ret=%d)\n", ret);
494 snd_card_free(card);
495 return ret;
496 }
497
498 return 0;
499}
500
501static void snd_disconnect(struct usb_interface *intf)
502{
503 struct snd_usb_caiaqdev *dev;
504 struct snd_card *card = usb_get_intfdata(intf);
505
506 debug("%s(%p)\n", __func__, intf);
507
508 if (!card)
509 return;
510
511 dev = caiaqdev(card);
512 snd_card_disconnect(card);
513
514#ifdef CONFIG_SND_USB_CAIAQ_INPUT
515 snd_usb_caiaq_input_free(dev);
516#endif
517 snd_usb_caiaq_audio_free(dev);
518
519 usb_kill_urb(&dev->ep1_in_urb);
520 usb_kill_urb(&dev->midi_out_urb);
521
522 snd_card_free(card);
523 usb_reset_device(interface_to_usbdev(intf));
524}
525
526
527MODULE_DEVICE_TABLE(usb, snd_usb_id_table);
528static struct usb_driver snd_usb_driver = {
529 .name = MODNAME,
530 .probe = snd_probe,
531 .disconnect = snd_disconnect,
532 .id_table = snd_usb_id_table,
533};
534
535static int __init snd_module_init(void)
536{
537 return usb_register(&snd_usb_driver);
538}
539
540static void __exit snd_module_exit(void)
541{
542 usb_deregister(&snd_usb_driver);
543}
544
545module_init(snd_module_init)
546module_exit(snd_module_exit)
547