2 * Copyright (c) 2006-2008 Daniel Mack, Karsten Wiese
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License as published by
6 * the Free Software Foundation; either version 2 of the License, or
7 * (at your option) any later version.
9 * This program is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
12 * GNU General Public License for more details.
14 * You should have received a copy of the GNU General Public License
15 * along with this program; if not, write to the Free Software
16 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
19 #include <linux/init.h>
20 #include <linux/module.h>
21 #include <linux/moduleparam.h>
22 #include <linux/interrupt.h>
23 #include <linux/usb.h>
24 #include <linux/spinlock.h>
25 #include <sound/core.h>
26 #include <sound/initval.h>
27 #include <sound/pcm.h>
28 #include <sound/rawmidi.h>
29 #include <linux/input.h>
31 #include "caiaq-device.h"
32 #include "caiaq-audio.h"
35 #define CLOCK_DRIFT_TOLERANCE 5
36 #define FRAMES_PER_URB 8
37 #define BYTES_PER_FRAME 512
38 #define CHANNELS_PER_STREAM 2
39 #define BYTES_PER_SAMPLE 3
40 #define BYTES_PER_SAMPLE_USB 4
41 #define MAX_BUFFER_SIZE (128*1024)
42 #define MAX_ENDPOINT_SIZE 512
44 #define ENDPOINT_CAPTURE 2
45 #define ENDPOINT_PLAYBACK 6
47 #define MAKE_CHECKBYTE(dev,stream,i) \
48 (stream << 1) | (~(i / (dev->n_streams * BYTES_PER_SAMPLE_USB)) & 1)
50 static struct snd_pcm_hardware snd_usb_caiaq_pcm_hardware = {
51 .info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
52 SNDRV_PCM_INFO_BLOCK_TRANSFER),
53 .formats = SNDRV_PCM_FMTBIT_S24_3BE,
54 .rates = (SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000 |
55 SNDRV_PCM_RATE_96000),
57 .rate_max = 0, /* will overwrite later */
58 .channels_min = CHANNELS_PER_STREAM,
59 .channels_max = CHANNELS_PER_STREAM,
60 .buffer_bytes_max = MAX_BUFFER_SIZE,
61 .period_bytes_min = 128,
62 .period_bytes_max = MAX_BUFFER_SIZE,
68 activate_substream(struct snd_usb_caiaqdev *dev,
69 struct snd_pcm_substream *sub)
71 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
72 dev->sub_playback[sub->number] = sub;
74 dev->sub_capture[sub->number] = sub;
78 deactivate_substream(struct snd_usb_caiaqdev *dev,
79 struct snd_pcm_substream *sub)
82 spin_lock_irqsave(&dev->spinlock, flags);
84 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
85 dev->sub_playback[sub->number] = NULL;
87 dev->sub_capture[sub->number] = NULL;
89 spin_unlock_irqrestore(&dev->spinlock, flags);
93 all_substreams_zero(struct snd_pcm_substream **subs)
96 for (i = 0; i < MAX_STREAMS; i++)
102 static int stream_start(struct snd_usb_caiaqdev *dev)
106 debug("%s(%p)\n", __func__, dev);
111 memset(dev->sub_playback, 0, sizeof(dev->sub_playback));
112 memset(dev->sub_capture, 0, sizeof(dev->sub_capture));
113 dev->input_panic = 0;
114 dev->output_panic = 0;
115 dev->first_packet = 1;
119 for (i = 0; i < N_URBS; i++) {
120 ret = usb_submit_urb(dev->data_urbs_in[i], GFP_ATOMIC);
122 log("unable to trigger read #%d! (ret %d)\n", i, ret);
131 static void stream_stop(struct snd_usb_caiaqdev *dev)
135 debug("%s(%p)\n", __func__, dev);
141 for (i = 0; i < N_URBS; i++) {
142 usb_kill_urb(dev->data_urbs_in[i]);
143 usb_kill_urb(dev->data_urbs_out[i]);
147 static int snd_usb_caiaq_substream_open(struct snd_pcm_substream *substream)
149 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
150 debug("%s(%p)\n", __func__, substream);
151 substream->runtime->hw = dev->pcm_info;
152 snd_pcm_limit_hw_rates(substream->runtime);
156 static int snd_usb_caiaq_substream_close(struct snd_pcm_substream *substream)
158 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
160 debug("%s(%p)\n", __func__, substream);
161 if (all_substreams_zero(dev->sub_playback) &&
162 all_substreams_zero(dev->sub_capture)) {
163 /* when the last client has stopped streaming,
164 * all sample rates are allowed again */
166 dev->pcm_info.rates = dev->samplerates;
172 static int snd_usb_caiaq_pcm_hw_params(struct snd_pcm_substream *sub,
173 struct snd_pcm_hw_params *hw_params)
175 debug("%s(%p)\n", __func__, sub);
176 return snd_pcm_lib_malloc_pages(sub, params_buffer_bytes(hw_params));
179 static int snd_usb_caiaq_pcm_hw_free(struct snd_pcm_substream *sub)
181 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
182 debug("%s(%p)\n", __func__, sub);
183 deactivate_substream(dev, sub);
184 return snd_pcm_lib_free_pages(sub);
187 /* this should probably go upstream */
188 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
189 #error "Change this table"
192 static unsigned int rates[] = { 5512, 8000, 11025, 16000, 22050, 32000, 44100,
193 48000, 64000, 88200, 96000, 176400, 192000 };
195 static int snd_usb_caiaq_pcm_prepare(struct snd_pcm_substream *substream)
197 int bytes_per_sample, bpp, ret, i;
198 int index = substream->number;
199 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
200 struct snd_pcm_runtime *runtime = substream->runtime;
202 debug("%s(%p)\n", __func__, substream);
204 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
205 dev->audio_out_buf_pos[index] = BYTES_PER_SAMPLE + 1;
207 dev->audio_in_buf_pos[index] = BYTES_PER_SAMPLE;
212 /* the first client that opens a stream defines the sample rate
213 * setting for all subsequent calls, until the last client closed. */
214 for (i=0; i < ARRAY_SIZE(rates); i++)
215 if (runtime->rate == rates[i])
216 dev->pcm_info.rates = 1 << i;
218 snd_pcm_limit_hw_rates(runtime);
220 bytes_per_sample = BYTES_PER_SAMPLE;
221 if (dev->spec.data_alignment == 2)
224 bpp = ((runtime->rate / 8000) + CLOCK_DRIFT_TOLERANCE)
225 * bytes_per_sample * CHANNELS_PER_STREAM * dev->n_streams;
227 if (bpp > MAX_ENDPOINT_SIZE)
228 bpp = MAX_ENDPOINT_SIZE;
230 ret = snd_usb_caiaq_set_audio_params(dev, runtime->rate,
231 runtime->sample_bits, bpp);
235 ret = stream_start(dev);
239 dev->output_running = 0;
240 wait_event_timeout(dev->prepare_wait_queue, dev->output_running, HZ);
241 if (!dev->output_running) {
249 static int snd_usb_caiaq_pcm_trigger(struct snd_pcm_substream *sub, int cmd)
251 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
254 case SNDRV_PCM_TRIGGER_START:
255 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
256 activate_substream(dev, sub);
258 case SNDRV_PCM_TRIGGER_STOP:
259 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
260 deactivate_substream(dev, sub);
269 static snd_pcm_uframes_t
270 snd_usb_caiaq_pcm_pointer(struct snd_pcm_substream *sub)
272 int index = sub->number;
273 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
275 if (dev->input_panic || dev->output_panic)
276 return SNDRV_PCM_POS_XRUN;
278 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
279 return bytes_to_frames(sub->runtime,
280 dev->audio_out_buf_pos[index]);
282 return bytes_to_frames(sub->runtime,
283 dev->audio_in_buf_pos[index]);
286 /* operators for both playback and capture */
287 static struct snd_pcm_ops snd_usb_caiaq_ops = {
288 .open = snd_usb_caiaq_substream_open,
289 .close = snd_usb_caiaq_substream_close,
290 .ioctl = snd_pcm_lib_ioctl,
291 .hw_params = snd_usb_caiaq_pcm_hw_params,
292 .hw_free = snd_usb_caiaq_pcm_hw_free,
293 .prepare = snd_usb_caiaq_pcm_prepare,
294 .trigger = snd_usb_caiaq_pcm_trigger,
295 .pointer = snd_usb_caiaq_pcm_pointer
298 static void check_for_elapsed_periods(struct snd_usb_caiaqdev *dev,
299 struct snd_pcm_substream **subs)
301 int stream, pb, *cnt;
302 struct snd_pcm_substream *sub;
304 for (stream = 0; stream < dev->n_streams; stream++) {
309 pb = frames_to_bytes(sub->runtime,
310 sub->runtime->period_size);
311 cnt = (sub->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
312 &dev->period_out_count[stream] :
313 &dev->period_in_count[stream];
316 snd_pcm_period_elapsed(sub);
322 static void read_in_urb_mode0(struct snd_usb_caiaqdev *dev,
323 const struct urb *urb,
324 const struct usb_iso_packet_descriptor *iso)
326 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
327 struct snd_pcm_substream *sub;
330 if (all_substreams_zero(dev->sub_capture))
333 for (i = 0; i < iso->actual_length;) {
334 for (stream = 0; stream < dev->n_streams; stream++, i++) {
335 sub = dev->sub_capture[stream];
337 struct snd_pcm_runtime *rt = sub->runtime;
338 char *audio_buf = rt->dma_area;
339 int sz = frames_to_bytes(rt, rt->buffer_size);
340 audio_buf[dev->audio_in_buf_pos[stream]++]
342 dev->period_in_count[stream]++;
343 if (dev->audio_in_buf_pos[stream] == sz)
344 dev->audio_in_buf_pos[stream] = 0;
350 static void read_in_urb_mode2(struct snd_usb_caiaqdev *dev,
351 const struct urb *urb,
352 const struct usb_iso_packet_descriptor *iso)
354 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
355 unsigned char check_byte;
356 struct snd_pcm_substream *sub;
359 for (i = 0; i < iso->actual_length;) {
360 if (i % (dev->n_streams * BYTES_PER_SAMPLE_USB) == 0) {
362 stream < dev->n_streams;
364 if (dev->first_packet)
367 check_byte = MAKE_CHECKBYTE(dev, stream, i);
369 if ((usb_buf[i] & 0x3f) != check_byte)
370 dev->input_panic = 1;
372 if (usb_buf[i] & 0x80)
373 dev->output_panic = 1;
376 dev->first_packet = 0;
378 for (stream = 0; stream < dev->n_streams; stream++, i++) {
379 sub = dev->sub_capture[stream];
380 if (dev->input_panic)
384 struct snd_pcm_runtime *rt = sub->runtime;
385 char *audio_buf = rt->dma_area;
386 int sz = frames_to_bytes(rt, rt->buffer_size);
387 audio_buf[dev->audio_in_buf_pos[stream]++] =
389 dev->period_in_count[stream]++;
390 if (dev->audio_in_buf_pos[stream] == sz)
391 dev->audio_in_buf_pos[stream] = 0;
397 static void read_in_urb(struct snd_usb_caiaqdev *dev,
398 const struct urb *urb,
399 const struct usb_iso_packet_descriptor *iso)
404 if (iso->actual_length < dev->bpp)
407 switch (dev->spec.data_alignment) {
409 read_in_urb_mode0(dev, urb, iso);
412 read_in_urb_mode2(dev, urb, iso);
416 if ((dev->input_panic || dev->output_panic) && !dev->warned) {
417 debug("streaming error detected %s %s\n",
418 dev->input_panic ? "(input)" : "",
419 dev->output_panic ? "(output)" : "");
424 static void fill_out_urb(struct snd_usb_caiaqdev *dev,
426 const struct usb_iso_packet_descriptor *iso)
428 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
429 struct snd_pcm_substream *sub;
432 for (i = 0; i < iso->length;) {
433 for (stream = 0; stream < dev->n_streams; stream++, i++) {
434 sub = dev->sub_playback[stream];
436 struct snd_pcm_runtime *rt = sub->runtime;
437 char *audio_buf = rt->dma_area;
438 int sz = frames_to_bytes(rt, rt->buffer_size);
440 audio_buf[dev->audio_out_buf_pos[stream]];
441 dev->period_out_count[stream]++;
442 dev->audio_out_buf_pos[stream]++;
443 if (dev->audio_out_buf_pos[stream] == sz)
444 dev->audio_out_buf_pos[stream] = 0;
449 /* fill in the check bytes */
450 if (dev->spec.data_alignment == 2 &&
451 i % (dev->n_streams * BYTES_PER_SAMPLE_USB) ==
452 (dev->n_streams * CHANNELS_PER_STREAM))
453 for (stream = 0; stream < dev->n_streams; stream++, i++)
454 usb_buf[i] = MAKE_CHECKBYTE(dev, stream, i);
458 static void read_completed(struct urb *urb)
460 struct snd_usb_caiaq_cb_info *info = urb->context;
461 struct snd_usb_caiaqdev *dev;
463 int frame, len, send_it = 0, outframe = 0;
465 if (urb->status || !info)
473 out = dev->data_urbs_out[info->index];
475 /* read the recently received packet and send back one which has
477 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
478 if (urb->iso_frame_desc[frame].status)
481 len = urb->iso_frame_desc[outframe].actual_length;
482 out->iso_frame_desc[outframe].length = len;
483 out->iso_frame_desc[outframe].actual_length = 0;
484 out->iso_frame_desc[outframe].offset = BYTES_PER_FRAME * frame;
487 spin_lock(&dev->spinlock);
488 fill_out_urb(dev, out, &out->iso_frame_desc[outframe]);
489 read_in_urb(dev, urb, &urb->iso_frame_desc[frame]);
490 spin_unlock(&dev->spinlock);
491 check_for_elapsed_periods(dev, dev->sub_playback);
492 check_for_elapsed_periods(dev, dev->sub_capture);
500 out->number_of_packets = FRAMES_PER_URB;
501 out->transfer_flags = URB_ISO_ASAP;
502 usb_submit_urb(out, GFP_ATOMIC);
505 /* re-submit inbound urb */
506 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
507 urb->iso_frame_desc[frame].offset = BYTES_PER_FRAME * frame;
508 urb->iso_frame_desc[frame].length = BYTES_PER_FRAME;
509 urb->iso_frame_desc[frame].actual_length = 0;
512 urb->number_of_packets = FRAMES_PER_URB;
513 urb->transfer_flags = URB_ISO_ASAP;
514 usb_submit_urb(urb, GFP_ATOMIC);
517 static void write_completed(struct urb *urb)
519 struct snd_usb_caiaq_cb_info *info = urb->context;
520 struct snd_usb_caiaqdev *dev = info->dev;
522 if (!dev->output_running) {
523 dev->output_running = 1;
524 wake_up(&dev->prepare_wait_queue);
528 static struct urb **alloc_urbs(struct snd_usb_caiaqdev *dev, int dir, int *ret)
532 struct usb_device *usb_dev = dev->chip.dev;
535 pipe = (dir == SNDRV_PCM_STREAM_PLAYBACK) ?
536 usb_sndisocpipe(usb_dev, ENDPOINT_PLAYBACK) :
537 usb_rcvisocpipe(usb_dev, ENDPOINT_CAPTURE);
539 urbs = kmalloc(N_URBS * sizeof(*urbs), GFP_KERNEL);
541 log("unable to kmalloc() urbs, OOM!?\n");
546 for (i = 0; i < N_URBS; i++) {
547 urbs[i] = usb_alloc_urb(FRAMES_PER_URB, GFP_KERNEL);
549 log("unable to usb_alloc_urb(), OOM!?\n");
554 urbs[i]->transfer_buffer =
555 kmalloc(FRAMES_PER_URB * BYTES_PER_FRAME, GFP_KERNEL);
556 if (!urbs[i]->transfer_buffer) {
557 log("unable to kmalloc() transfer buffer, OOM!?\n");
562 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
563 struct usb_iso_packet_descriptor *iso =
564 &urbs[i]->iso_frame_desc[frame];
566 iso->offset = BYTES_PER_FRAME * frame;
567 iso->length = BYTES_PER_FRAME;
570 urbs[i]->dev = usb_dev;
571 urbs[i]->pipe = pipe;
572 urbs[i]->transfer_buffer_length = FRAMES_PER_URB
574 urbs[i]->context = &dev->data_cb_info[i];
575 urbs[i]->interval = 1;
576 urbs[i]->transfer_flags = URB_ISO_ASAP;
577 urbs[i]->number_of_packets = FRAMES_PER_URB;
578 urbs[i]->complete = (dir == SNDRV_PCM_STREAM_CAPTURE) ?
579 read_completed : write_completed;
586 static void free_urbs(struct urb **urbs)
593 for (i = 0; i < N_URBS; i++) {
597 usb_kill_urb(urbs[i]);
598 kfree(urbs[i]->transfer_buffer);
599 usb_free_urb(urbs[i]);
605 int snd_usb_caiaq_audio_init(struct snd_usb_caiaqdev *dev)
609 dev->n_audio_in = max(dev->spec.num_analog_audio_in,
610 dev->spec.num_digital_audio_in) /
612 dev->n_audio_out = max(dev->spec.num_analog_audio_out,
613 dev->spec.num_digital_audio_out) /
615 dev->n_streams = max(dev->n_audio_in, dev->n_audio_out);
617 debug("dev->n_audio_in = %d\n", dev->n_audio_in);
618 debug("dev->n_audio_out = %d\n", dev->n_audio_out);
619 debug("dev->n_streams = %d\n", dev->n_streams);
621 if (dev->n_streams > MAX_STREAMS) {
622 log("unable to initialize device, too many streams.\n");
626 ret = snd_pcm_new(dev->chip.card, dev->product_name, 0,
627 dev->n_audio_out, dev->n_audio_in, &dev->pcm);
630 log("snd_pcm_new() returned %d\n", ret);
634 dev->pcm->private_data = dev;
635 strcpy(dev->pcm->name, dev->product_name);
637 memset(dev->sub_playback, 0, sizeof(dev->sub_playback));
638 memset(dev->sub_capture, 0, sizeof(dev->sub_capture));
640 memcpy(&dev->pcm_info, &snd_usb_caiaq_pcm_hardware,
641 sizeof(snd_usb_caiaq_pcm_hardware));
643 /* setup samplerates */
644 dev->samplerates = dev->pcm_info.rates;
645 switch (dev->chip.usb_id) {
646 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
647 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
648 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_SESSIONIO):
649 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_GUITARRIGMOBILE):
650 dev->samplerates |= SNDRV_PCM_RATE_192000;
652 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO4DJ):
653 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
654 dev->samplerates |= SNDRV_PCM_RATE_88200;
658 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_PLAYBACK,
660 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_CAPTURE,
663 snd_pcm_lib_preallocate_pages_for_all(dev->pcm,
664 SNDRV_DMA_TYPE_CONTINUOUS,
665 snd_dma_continuous_data(GFP_KERNEL),
666 MAX_BUFFER_SIZE, MAX_BUFFER_SIZE);
669 kmalloc(sizeof(struct snd_usb_caiaq_cb_info) * N_URBS,
672 if (!dev->data_cb_info)
675 for (i = 0; i < N_URBS; i++) {
676 dev->data_cb_info[i].dev = dev;
677 dev->data_cb_info[i].index = i;
680 dev->data_urbs_in = alloc_urbs(dev, SNDRV_PCM_STREAM_CAPTURE, &ret);
682 kfree(dev->data_cb_info);
683 free_urbs(dev->data_urbs_in);
687 dev->data_urbs_out = alloc_urbs(dev, SNDRV_PCM_STREAM_PLAYBACK, &ret);
689 kfree(dev->data_cb_info);
690 free_urbs(dev->data_urbs_in);
691 free_urbs(dev->data_urbs_out);
698 void snd_usb_caiaq_audio_free(struct snd_usb_caiaqdev *dev)
700 debug("%s(%p)\n", __func__, dev);
702 free_urbs(dev->data_urbs_in);
703 free_urbs(dev->data_urbs_out);
704 kfree(dev->data_cb_info);