2 * caiaq.c: ALSA driver for caiaq/NativeInstruments devices
4 * Copyright (c) 2007 Daniel Mack <daniel@caiaq.de>
5 * Karsten Wiese <fzu@wemgehoertderstaat.de>
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.
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.
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
22 #include <linux/moduleparam.h>
23 #include <linux/interrupt.h>
24 #include <linux/module.h>
25 #include <linux/init.h>
26 #include <linux/usb.h>
27 #include <sound/initval.h>
28 #include <sound/core.h>
29 #include <sound/pcm.h>
37 MODULE_AUTHOR("Daniel Mack <daniel@caiaq.de>");
38 MODULE_DESCRIPTION("caiaq USB audio, version 1.3.15");
39 MODULE_LICENSE("GPL");
40 MODULE_SUPPORTED_DEVICE("{{Native Instruments, RigKontrol2},"
41 "{Native Instruments, RigKontrol3},"
42 "{Native Instruments, Kore Controller},"
43 "{Native Instruments, Kore Controller 2},"
44 "{Native Instruments, Audio Kontrol 1},"
45 "{Native Instruments, Audio 4 DJ},"
46 "{Native Instruments, Audio 8 DJ},"
47 "{Native Instruments, Session I/O},"
48 "{Native Instruments, GuitarRig mobile}");
50 static int index
[SNDRV_CARDS
] = SNDRV_DEFAULT_IDX
; /* Index 0-max */
51 static char* id
[SNDRV_CARDS
] = SNDRV_DEFAULT_STR
; /* Id for this card */
52 static int enable
[SNDRV_CARDS
] = SNDRV_DEFAULT_ENABLE_PNP
; /* Enable this card */
53 static int snd_card_used
[SNDRV_CARDS
];
55 module_param_array(index
, int, NULL
, 0444);
56 MODULE_PARM_DESC(index
, "Index value for the caiaq sound device");
57 module_param_array(id
, charp
, NULL
, 0444);
58 MODULE_PARM_DESC(id
, "ID string for the caiaq soundcard.");
59 module_param_array(enable
, bool, NULL
, 0444);
60 MODULE_PARM_DESC(enable
, "Enable the caiaq soundcard.");
66 SAMPLERATE_192000
= 3,
68 SAMPLERATE_INVALID
= 0xff
78 static struct usb_device_id snd_usb_id_table
[] = {
80 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
81 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
82 .idProduct
= USB_PID_RIGKONTROL2
85 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
86 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
87 .idProduct
= USB_PID_RIGKONTROL3
90 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
91 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
92 .idProduct
= USB_PID_KORECONTROLLER
95 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
96 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
97 .idProduct
= USB_PID_KORECONTROLLER2
100 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
101 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
102 .idProduct
= USB_PID_AK1
105 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
106 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
107 .idProduct
= USB_PID_AUDIO8DJ
110 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
111 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
112 .idProduct
= USB_PID_SESSIONIO
115 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
116 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
117 .idProduct
= USB_PID_GUITARRIGMOBILE
120 .match_flags
= USB_DEVICE_ID_MATCH_DEVICE
,
121 .idVendor
= USB_VID_NATIVEINSTRUMENTS
,
122 .idProduct
= USB_PID_AUDIO4DJ
127 static void usb_ep1_command_reply_dispatch (struct urb
* urb
)
130 struct snd_usb_caiaqdev
*dev
= urb
->context
;
131 unsigned char *buf
= urb
->transfer_buffer
;
133 if (urb
->status
|| !dev
) {
134 log("received EP1 urb->status = %i\n", urb
->status
);
139 case EP1_CMD_GET_DEVICE_INFO
:
140 memcpy(&dev
->spec
, buf
+1, sizeof(struct caiaq_device_spec
));
141 dev
->spec
.fw_version
= le16_to_cpu(dev
->spec
.fw_version
);
142 debug("device spec (firmware %d): audio: %d in, %d out, "
143 "MIDI: %d in, %d out, data alignment %d\n",
144 dev
->spec
.fw_version
,
145 dev
->spec
.num_analog_audio_in
,
146 dev
->spec
.num_analog_audio_out
,
147 dev
->spec
.num_midi_in
,
148 dev
->spec
.num_midi_out
,
149 dev
->spec
.data_alignment
);
151 dev
->spec_received
++;
152 wake_up(&dev
->ep1_wait_queue
);
154 case EP1_CMD_AUDIO_PARAMS
:
155 dev
->audio_parm_answer
= buf
[1];
156 wake_up(&dev
->ep1_wait_queue
);
158 case EP1_CMD_MIDI_READ
:
159 snd_usb_caiaq_midi_handle_input(dev
, buf
[1], buf
+ 3, buf
[2]);
161 case EP1_CMD_READ_IO
:
162 if (dev
->chip
.usb_id
==
163 USB_ID(USB_VID_NATIVEINSTRUMENTS
, USB_PID_AUDIO8DJ
)) {
164 if (urb
->actual_length
> sizeof(dev
->control_state
))
165 urb
->actual_length
= sizeof(dev
->control_state
);
166 memcpy(dev
->control_state
, buf
+ 1, urb
->actual_length
);
167 wake_up(&dev
->ep1_wait_queue
);
170 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
171 case EP1_CMD_READ_ERP
:
172 case EP1_CMD_READ_ANALOG
:
173 snd_usb_caiaq_input_dispatch(dev
, buf
, urb
->actual_length
);
178 dev
->ep1_in_urb
.actual_length
= 0;
179 ret
= usb_submit_urb(&dev
->ep1_in_urb
, GFP_ATOMIC
);
181 log("unable to submit urb. OOM!?\n");
184 int snd_usb_caiaq_send_command(struct snd_usb_caiaqdev
*dev
,
185 unsigned char command
,
186 const unsigned char *buffer
,
190 struct usb_device
*usb_dev
= dev
->chip
.dev
;
195 if (len
> EP1_BUFSIZE
- 1)
196 len
= EP1_BUFSIZE
- 1;
198 if (buffer
&& len
> 0)
199 memcpy(dev
->ep1_out_buf
+1, buffer
, len
);
201 dev
->ep1_out_buf
[0] = command
;
202 return usb_bulk_msg(usb_dev
, usb_sndbulkpipe(usb_dev
, 1),
203 dev
->ep1_out_buf
, len
+1, &actual_len
, 200);
206 int snd_usb_caiaq_set_audio_params (struct snd_usb_caiaqdev
*dev
,
207 int rate
, int depth
, int bpp
)
213 case 44100: tmp
[0] = SAMPLERATE_44100
; break;
214 case 48000: tmp
[0] = SAMPLERATE_48000
; break;
215 case 88200: tmp
[0] = SAMPLERATE_88200
; break;
216 case 96000: tmp
[0] = SAMPLERATE_96000
; break;
217 case 192000: tmp
[0] = SAMPLERATE_192000
; break;
218 default: return -EINVAL
;
222 case 16: tmp
[1] = DEPTH_16
; break;
223 case 24: tmp
[1] = DEPTH_24
; break;
224 default: return -EINVAL
;
229 tmp
[4] = 1; /* packets per microframe */
231 debug("setting audio params: %d Hz, %d bits, %d bpp\n",
234 dev
->audio_parm_answer
= -1;
235 ret
= snd_usb_caiaq_send_command(dev
, EP1_CMD_AUDIO_PARAMS
,
241 if (!wait_event_timeout(dev
->ep1_wait_queue
,
242 dev
->audio_parm_answer
>= 0, HZ
))
245 if (dev
->audio_parm_answer
!= 1)
246 debug("unable to set the device's audio params\n");
250 return dev
->audio_parm_answer
== 1 ? 0 : -EINVAL
;
253 int snd_usb_caiaq_set_auto_msg(struct snd_usb_caiaqdev
*dev
,
254 int digital
, int analog
, int erp
)
256 char tmp
[3] = { digital
, analog
, erp
};
257 return snd_usb_caiaq_send_command(dev
, EP1_CMD_AUTO_MSG
,
261 static void __devinit
setup_card(struct snd_usb_caiaqdev
*dev
)
266 /* device-specific startup specials */
267 switch (dev
->chip
.usb_id
) {
268 case USB_ID(USB_VID_NATIVEINSTRUMENTS
, USB_PID_RIGKONTROL2
):
269 /* RigKontrol2 - display centered dash ('-') */
273 snd_usb_caiaq_send_command(dev
, EP1_CMD_WRITE_IO
, val
, 3);
275 case USB_ID(USB_VID_NATIVEINSTRUMENTS
, USB_PID_RIGKONTROL3
):
276 /* RigKontrol2 - display two centered dashes ('--') */
281 snd_usb_caiaq_send_command(dev
, EP1_CMD_WRITE_IO
, val
, 4);
283 case USB_ID(USB_VID_NATIVEINSTRUMENTS
, USB_PID_AK1
):
284 /* Audio Kontrol 1 - make USB-LED stop blinking */
286 snd_usb_caiaq_send_command(dev
, EP1_CMD_WRITE_IO
, val
, 1);
288 case USB_ID(USB_VID_NATIVEINSTRUMENTS
, USB_PID_AUDIO8DJ
):
289 /* Audio 8 DJ - trigger read of current settings */
290 dev
->control_state
[0] = 0xff;
291 snd_usb_caiaq_set_auto_msg(dev
, 1, 0, 0);
292 snd_usb_caiaq_send_command(dev
, EP1_CMD_READ_IO
, NULL
, 0);
294 if (!wait_event_timeout(dev
->ep1_wait_queue
,
295 dev
->control_state
[0] != 0xff, HZ
))
298 /* fix up some defaults */
299 if ((dev
->control_state
[1] != 2) ||
300 (dev
->control_state
[2] != 3) ||
301 (dev
->control_state
[4] != 2)) {
302 dev
->control_state
[1] = 2;
303 dev
->control_state
[2] = 3;
304 dev
->control_state
[4] = 2;
305 snd_usb_caiaq_send_command(dev
,
306 EP1_CMD_WRITE_IO
, dev
->control_state
, 6);
310 case USB_ID(USB_VID_NATIVEINSTRUMENTS
, USB_PID_AUDIO4DJ
):
311 /* Audio 4 DJ - default input mode to phono */
312 dev
->control_state
[0] = 2;
313 snd_usb_caiaq_send_command(dev
, EP1_CMD_WRITE_IO
,
314 dev
->control_state
, 1);
318 if (dev
->spec
.num_analog_audio_out
+
319 dev
->spec
.num_analog_audio_in
+
320 dev
->spec
.num_digital_audio_out
+
321 dev
->spec
.num_digital_audio_in
> 0) {
322 ret
= snd_usb_caiaq_audio_init(dev
);
324 log("Unable to set up audio system (ret=%d)\n", ret
);
327 if (dev
->spec
.num_midi_in
+
328 dev
->spec
.num_midi_out
> 0) {
329 ret
= snd_usb_caiaq_midi_init(dev
);
331 log("Unable to set up MIDI system (ret=%d)\n", ret
);
334 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
335 ret
= snd_usb_caiaq_input_init(dev
);
337 log("Unable to set up input system (ret=%d)\n", ret
);
340 /* finally, register the card and all its sub-instances */
341 ret
= snd_card_register(dev
->chip
.card
);
343 log("snd_card_register() returned %d\n", ret
);
344 snd_card_free(dev
->chip
.card
);
347 ret
= snd_usb_caiaq_control_init(dev
);
349 log("Unable to set up control system (ret=%d)\n", ret
);
352 static int create_card(struct usb_device
* usb_dev
, struct snd_card
**cardp
)
356 struct snd_card
*card
;
357 struct snd_usb_caiaqdev
*dev
;
359 for (devnum
= 0; devnum
< SNDRV_CARDS
; devnum
++)
360 if (enable
[devnum
] && !snd_card_used
[devnum
])
363 if (devnum
>= SNDRV_CARDS
)
366 err
= snd_card_create(index
[devnum
], id
[devnum
], THIS_MODULE
,
367 sizeof(struct snd_usb_caiaqdev
), &card
);
371 dev
= caiaqdev(card
);
372 dev
->chip
.dev
= usb_dev
;
373 dev
->chip
.card
= card
;
374 dev
->chip
.usb_id
= USB_ID(le16_to_cpu(usb_dev
->descriptor
.idVendor
),
375 le16_to_cpu(usb_dev
->descriptor
.idProduct
));
376 spin_lock_init(&dev
->spinlock
);
377 snd_card_set_dev(card
, &usb_dev
->dev
);
383 static int __devinit
init_card(struct snd_usb_caiaqdev
*dev
)
385 char *c
, usbpath
[32];
386 struct usb_device
*usb_dev
= dev
->chip
.dev
;
387 struct snd_card
*card
= dev
->chip
.card
;
390 if (usb_set_interface(usb_dev
, 0, 1) != 0) {
391 log("can't set alt interface.\n");
395 usb_init_urb(&dev
->ep1_in_urb
);
396 usb_init_urb(&dev
->midi_out_urb
);
398 usb_fill_bulk_urb(&dev
->ep1_in_urb
, usb_dev
,
399 usb_rcvbulkpipe(usb_dev
, 0x1),
400 dev
->ep1_in_buf
, EP1_BUFSIZE
,
401 usb_ep1_command_reply_dispatch
, dev
);
403 usb_fill_bulk_urb(&dev
->midi_out_urb
, usb_dev
,
404 usb_sndbulkpipe(usb_dev
, 0x1),
405 dev
->midi_out_buf
, EP1_BUFSIZE
,
406 snd_usb_caiaq_midi_output_done
, dev
);
408 init_waitqueue_head(&dev
->ep1_wait_queue
);
409 init_waitqueue_head(&dev
->prepare_wait_queue
);
411 if (usb_submit_urb(&dev
->ep1_in_urb
, GFP_KERNEL
) != 0)
414 err
= snd_usb_caiaq_send_command(dev
, EP1_CMD_GET_DEVICE_INFO
, NULL
, 0);
418 if (!wait_event_timeout(dev
->ep1_wait_queue
, dev
->spec_received
, HZ
))
421 usb_string(usb_dev
, usb_dev
->descriptor
.iManufacturer
,
422 dev
->vendor_name
, CAIAQ_USB_STR_LEN
);
424 usb_string(usb_dev
, usb_dev
->descriptor
.iProduct
,
425 dev
->product_name
, CAIAQ_USB_STR_LEN
);
427 strlcpy(card
->driver
, MODNAME
, sizeof(card
->driver
));
428 strlcpy(card
->shortname
, dev
->product_name
, sizeof(card
->shortname
));
430 /* if the id was not passed as module option, fill it with a shortened
431 * version of the product string which does not contain any
434 if (*card
->id
== '\0') {
435 char id
[sizeof(card
->id
)];
437 memset(id
, 0, sizeof(id
));
439 for (c
= card
->shortname
, len
= 0;
440 *c
&& len
< sizeof(card
->id
); c
++)
444 snd_card_set_id(card
, id
);
447 usb_make_path(usb_dev
, usbpath
, sizeof(usbpath
));
448 snprintf(card
->longname
, sizeof(card
->longname
),
450 dev
->vendor_name
, dev
->product_name
, usbpath
);
456 static int __devinit
snd_probe(struct usb_interface
*intf
,
457 const struct usb_device_id
*id
)
460 struct snd_card
*card
;
461 struct usb_device
*device
= interface_to_usbdev(intf
);
463 ret
= create_card(device
, &card
);
468 usb_set_intfdata(intf
, card
);
469 ret
= init_card(caiaqdev(card
));
471 log("unable to init card! (ret=%d)\n", ret
);
479 static void snd_disconnect(struct usb_interface
*intf
)
481 struct snd_usb_caiaqdev
*dev
;
482 struct snd_card
*card
= usb_get_intfdata(intf
);
484 debug("%s(%p)\n", __func__
, intf
);
489 dev
= caiaqdev(card
);
490 snd_card_disconnect(card
);
492 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
493 snd_usb_caiaq_input_free(dev
);
495 snd_usb_caiaq_audio_free(dev
);
497 usb_kill_urb(&dev
->ep1_in_urb
);
498 usb_kill_urb(&dev
->midi_out_urb
);
501 usb_reset_device(interface_to_usbdev(intf
));
505 MODULE_DEVICE_TABLE(usb
, snd_usb_id_table
);
506 static struct usb_driver snd_usb_driver
= {
509 .disconnect
= snd_disconnect
,
510 .id_table
= snd_usb_id_table
,
513 static int __init
snd_module_init(void)
515 return usb_register(&snd_usb_driver
);
518 static void __exit
snd_module_exit(void)
520 usb_deregister(&snd_usb_driver
);
523 module_init(snd_module_init
)
524 module_exit(snd_module_exit
)