1 // SPDX-License-Identifier: GPL-2.0-or-later
3 * caiaq.c: ALSA driver for caiaq/NativeInstruments devices
5 * Copyright (c) 2007 Daniel Mack <daniel@caiaq.de>
6 * Karsten Wiese <fzu@wemgehoertderstaat.de>
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>
26 MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
27 MODULE_DESCRIPTION("caiaq USB audio");
28 MODULE_LICENSE("GPL");
30 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-max */
31 static char* id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* Id for this card */
32 static bool enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
; /* Enable this card */
34 module_param_array(index
, int, NULL
, 0444);
35 MODULE_PARM_DESC(index
, "Index value for the caiaq sound device");
36 module_param_array(id
, charp
, NULL
, 0444);
37 MODULE_PARM_DESC(id
, "ID string for the caiaq soundcard.");
38 module_param_array(enable
, bool, NULL
, 0444);
39 MODULE_PARM_DESC(enable
, "Enable the caiaq soundcard.");
45 SAMPLERATE_192000
= 3,
47 SAMPLERATE_INVALID
= 0xff
57 static const struct usb_device_id snd_usb_id_table
[] = {
59 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
60 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
61 .idProduct
= USB_PID_RIGKONTROL2
64 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
65 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
66 .idProduct
= USB_PID_RIGKONTROL3
69 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
70 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
71 .idProduct
= USB_PID_KORECONTROLLER
74 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
75 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
76 .idProduct
= USB_PID_KORECONTROLLER2
79 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
80 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
81 .idProduct
= USB_PID_AK1
84 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
85 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
86 .idProduct
= USB_PID_AUDIO8DJ
89 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
90 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
91 .idProduct
= USB_PID_SESSIONIO
94 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
95 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
96 .idProduct
= USB_PID_GUITARRIGMOBILE
99 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
100 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
101 .idProduct
= USB_PID_AUDIO4DJ
104 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
105 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
106 .idProduct
= USB_PID_AUDIO2DJ
109 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
110 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
111 .idProduct
= USB_PID_TRAKTORKONTROLX1
114 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
115 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
116 .idProduct
= USB_PID_TRAKTORKONTROLS4
119 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
120 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
121 .idProduct
= USB_PID_TRAKTORAUDIO2
124 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
125 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
126 .idProduct
= USB_PID_MASCHINECONTROLLER
131 static void usb_ep1_command_reply_dispatch (struct urb
* urb
)
134 struct device
*dev
= &urb
->dev
->dev
;
135 struct snd_usb_caiaqdev
*cdev
= urb
->context
;
136 unsigned char *buf
= urb
->transfer_buffer
;
138 if (urb
->status
|| !cdev
) {
139 dev_warn(dev
, "received EP1 urb->status = %i\n", urb
->status
);
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
);
156 cdev
->spec_received
++;
157 wake_up(&cdev
->ep1_wait_queue
);
159 case EP1_CMD_AUDIO_PARAMS
:
160 cdev
->audio_parm_answer
= buf
[1];
161 wake_up(&cdev
->ep1_wait_queue
);
163 case EP1_CMD_MIDI_READ
:
164 snd_usb_caiaq_midi_handle_input(cdev
, buf
[1], buf
+ 3, buf
[2]);
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
);
175 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
177 case EP1_CMD_READ_ERP
:
178 case EP1_CMD_READ_ANALOG
:
179 snd_usb_caiaq_input_dispatch(cdev
, buf
, urb
->actual_length
);
184 cdev
->ep1_in_urb
.actual_length
= 0;
185 ret
= usb_submit_urb(&cdev
->ep1_in_urb
, GFP_ATOMIC
);
187 dev_err(dev
, "unable to submit urb. OOM!?\n");
190 int snd_usb_caiaq_send_command(struct snd_usb_caiaqdev
*cdev
,
191 unsigned char command
,
192 const unsigned char *buffer
,
196 struct usb_device
*usb_dev
= cdev
->chip
.dev
;
201 if (len
> EP1_BUFSIZE
- 1)
202 len
= EP1_BUFSIZE
- 1;
204 if (buffer
&& len
> 0)
205 memcpy(cdev
->ep1_out_buf
+1, buffer
, len
);
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);
212 int snd_usb_caiaq_send_command_bank(struct snd_usb_caiaqdev
*cdev
,
213 unsigned char command
,
215 const unsigned char *buffer
,
219 struct usb_device
*usb_dev
= cdev
->chip
.dev
;
224 if (len
> EP1_BUFSIZE
- 2)
225 len
= EP1_BUFSIZE
- 2;
227 if (buffer
&& len
> 0)
228 memcpy(cdev
->ep1_out_buf
+2, buffer
, len
);
230 cdev
->ep1_out_buf
[0] = command
;
231 cdev
->ep1_out_buf
[1] = bank
;
233 return usb_bulk_msg(usb_dev
, usb_sndbulkpipe(usb_dev
, 1),
234 cdev
->ep1_out_buf
, len
+2, &actual_len
, 200);
237 int snd_usb_caiaq_set_audio_params (struct snd_usb_caiaqdev
*cdev
,
238 int rate
, int depth
, int bpp
)
242 struct device
*dev
= caiaqdev_to_dev(cdev
);
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
;
254 case 16: tmp
[1] = DEPTH_16
; break;
255 case 24: tmp
[1] = DEPTH_24
; break;
256 default: return -EINVAL
;
261 tmp
[4] = 1; /* packets per microframe */
263 dev_dbg(dev
, "setting audio params: %d Hz, %d bits, %d bpp\n",
266 cdev
->audio_parm_answer
= -1;
267 ret
= snd_usb_caiaq_send_command(cdev
, EP1_CMD_AUDIO_PARAMS
,
273 if (!wait_event_timeout(cdev
->ep1_wait_queue
,
274 cdev
->audio_parm_answer
>= 0, HZ
))
277 if (cdev
->audio_parm_answer
!= 1)
278 dev_dbg(dev
, "unable to set the device's audio params\n");
282 return cdev
->audio_parm_answer
== 1 ? 0 : -EINVAL
;
285 int snd_usb_caiaq_set_auto_msg(struct snd_usb_caiaqdev
*cdev
,
286 int digital
, int analog
, int erp
)
288 char tmp
[3] = { digital
, analog
, erp
};
289 return snd_usb_caiaq_send_command(cdev
, EP1_CMD_AUTO_MSG
,
293 static void setup_card(struct snd_usb_caiaqdev
*cdev
)
297 struct device
*dev
= caiaqdev_to_dev(cdev
);
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 ('-') */
306 snd_usb_caiaq_send_command(cdev
, EP1_CMD_WRITE_IO
, val
, 3);
308 case USB_ID(USB_VID_NATIVEINSTRUMENTS
, USB_PID_RIGKONTROL3
):
309 /* RigKontrol2 - display two centered dashes ('--') */
314 snd_usb_caiaq_send_command(cdev
, EP1_CMD_WRITE_IO
, val
, 4);
316 case USB_ID(USB_VID_NATIVEINSTRUMENTS
, USB_PID_AK1
):
317 /* Audio Kontrol 1 - make USB-LED stop blinking */
319 snd_usb_caiaq_send_command(cdev
, EP1_CMD_WRITE_IO
, val
, 1);
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);
327 if (!wait_event_timeout(cdev
->ep1_wait_queue
,
328 cdev
->control_state
[0] != 0xff, HZ
))
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);
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
);
351 dev_err(dev
, "Unable to set up audio system (ret=%d)\n", ret
);
354 if (cdev
->spec
.num_midi_in
+
355 cdev
->spec
.num_midi_out
> 0) {
356 ret
= snd_usb_caiaq_midi_init(cdev
);
358 dev_err(dev
, "Unable to set up MIDI system (ret=%d)\n", ret
);
361 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
362 ret
= snd_usb_caiaq_input_init(cdev
);
364 dev_err(dev
, "Unable to set up input system (ret=%d)\n", ret
);
367 /* finally, register the card and all its sub-instances */
368 ret
= snd_card_register(cdev
->chip
.card
);
370 dev_err(dev
, "snd_card_register() returned %d\n", ret
);
371 snd_card_free(cdev
->chip
.card
);
374 ret
= snd_usb_caiaq_control_init(cdev
);
376 dev_err(dev
, "Unable to set up control system (ret=%d)\n", ret
);
379 static void card_free(struct snd_card
*card
)
381 struct snd_usb_caiaqdev
*cdev
= caiaqdev(card
);
383 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
384 snd_usb_caiaq_input_free(cdev
);
386 snd_usb_caiaq_audio_free(cdev
);
387 usb_reset_device(cdev
->chip
.dev
);
390 static int create_card(struct usb_device
*usb_dev
,
391 struct usb_interface
*intf
,
392 struct snd_card
**cardp
)
396 struct snd_card
*card
;
397 struct snd_usb_caiaqdev
*cdev
;
399 for (devnum
= 0; devnum
< SNDRV_CARDS
; devnum
++)
403 if (devnum
>= SNDRV_CARDS
)
406 err
= snd_card_new(&intf
->dev
,
407 index
[devnum
], id
[devnum
], THIS_MODULE
,
408 sizeof(struct snd_usb_caiaqdev
), &card
);
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
);
423 static int init_card(struct snd_usb_caiaqdev
*cdev
)
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
);
431 if (usb_set_interface(usb_dev
, 0, 1) != 0) {
432 dev_err(dev
, "can't set alt interface.\n");
436 usb_init_urb(&cdev
->ep1_in_urb
);
437 usb_init_urb(&cdev
->midi_out_urb
);
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
);
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
);
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");
456 init_waitqueue_head(&cdev
->ep1_wait_queue
);
457 init_waitqueue_head(&cdev
->prepare_wait_queue
);
459 if (usb_submit_urb(&cdev
->ep1_in_urb
, GFP_KERNEL
) != 0)
462 err
= snd_usb_caiaq_send_command(cdev
, EP1_CMD_GET_DEVICE_INFO
, NULL
, 0);
466 if (!wait_event_timeout(cdev
->ep1_wait_queue
, cdev
->spec_received
, HZ
)) {
471 usb_string(usb_dev
, usb_dev
->descriptor
.iManufacturer
,
472 cdev
->vendor_name
, CAIAQ_USB_STR_LEN
);
474 usb_string(usb_dev
, usb_dev
->descriptor
.iProduct
,
475 cdev
->product_name
, CAIAQ_USB_STR_LEN
);
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
));
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
485 if (*card
->id
== '\0') {
486 char id
[sizeof(card
->id
)];
488 memset(id
, 0, sizeof(id
));
490 for (c
= card
->shortname
, len
= 0;
491 *c
&& len
< sizeof(card
->id
); c
++)
495 snd_card_set_id(card
, id
);
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
);
503 card
->private_free
= card_free
;
507 usb_kill_urb(&cdev
->ep1_in_urb
);
511 static int snd_probe(struct usb_interface
*intf
,
512 const struct usb_device_id
*id
)
515 struct snd_card
*card
= NULL
;
516 struct usb_device
*usb_dev
= interface_to_usbdev(intf
);
518 ret
= create_card(usb_dev
, intf
, &card
);
523 usb_set_intfdata(intf
, card
);
524 ret
= init_card(caiaqdev(card
));
526 dev_err(&usb_dev
->dev
, "unable to init card! (ret=%d)\n", ret
);
534 static void snd_disconnect(struct usb_interface
*intf
)
536 struct snd_card
*card
= usb_get_intfdata(intf
);
537 struct device
*dev
= intf
->usb_dev
;
538 struct snd_usb_caiaqdev
*cdev
;
543 cdev
= caiaqdev(card
);
544 dev_dbg(dev
, "%s(%p)\n", __func__
, intf
);
546 snd_card_disconnect(card
);
548 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
549 snd_usb_caiaq_input_disconnect(cdev
);
551 snd_usb_caiaq_audio_disconnect(cdev
);
553 usb_kill_urb(&cdev
->ep1_in_urb
);
554 usb_kill_urb(&cdev
->midi_out_urb
);
556 snd_card_free_when_closed(card
);
560 MODULE_DEVICE_TABLE(usb
, snd_usb_id_table
);
561 static struct usb_driver snd_usb_driver
= {
564 .disconnect
= snd_disconnect
,
565 .id_table
= snd_usb_id_table
,
568 module_usb_driver(snd_usb_driver
);