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;
118 for (i = 0; i < N_URBS; i++) {
119 ret = usb_submit_urb(dev->data_urbs_in[i], GFP_ATOMIC);
121 log("unable to trigger read #%d! (ret %d)\n", i, ret);
130 static void stream_stop(struct snd_usb_caiaqdev *dev)
134 debug("%s(%p)\n", __func__, dev);
140 for (i = 0; i < N_URBS; i++) {
141 usb_kill_urb(dev->data_urbs_in[i]);
142 usb_kill_urb(dev->data_urbs_out[i]);
146 static int snd_usb_caiaq_substream_open(struct snd_pcm_substream *substream)
148 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
149 debug("%s(%p)\n", __func__, substream);
150 substream->runtime->hw = dev->pcm_info;
151 snd_pcm_limit_hw_rates(substream->runtime);
155 static int snd_usb_caiaq_substream_close(struct snd_pcm_substream *substream)
157 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
159 debug("%s(%p)\n", __func__, substream);
160 if (all_substreams_zero(dev->sub_playback) &&
161 all_substreams_zero(dev->sub_capture)) {
162 /* when the last client has stopped streaming,
163 * all sample rates are allowed again */
165 dev->pcm_info.rates = dev->samplerates;
171 static int snd_usb_caiaq_pcm_hw_params(struct snd_pcm_substream *sub,
172 struct snd_pcm_hw_params *hw_params)
174 debug("%s(%p)\n", __func__, sub);
175 return snd_pcm_lib_malloc_pages(sub, params_buffer_bytes(hw_params));
178 static int snd_usb_caiaq_pcm_hw_free(struct snd_pcm_substream *sub)
180 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
181 debug("%s(%p)\n", __func__, sub);
182 deactivate_substream(dev, sub);
183 return snd_pcm_lib_free_pages(sub);
186 /* this should probably go upstream */
187 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
188 #error "Change this table"
191 static unsigned int rates[] = { 5512, 8000, 11025, 16000, 22050, 32000, 44100,
192 48000, 64000, 88200, 96000, 176400, 192000 };
194 static int snd_usb_caiaq_pcm_prepare(struct snd_pcm_substream *substream)
196 int bytes_per_sample, bpp, ret, i;
197 int index = substream->number;
198 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
199 struct snd_pcm_runtime *runtime = substream->runtime;
201 debug("%s(%p)\n", __func__, substream);
203 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
204 dev->audio_out_buf_pos[index] = BYTES_PER_SAMPLE + 1;
206 dev->audio_in_buf_pos[index] = BYTES_PER_SAMPLE;
211 /* the first client that opens a stream defines the sample rate
212 * setting for all subsequent calls, until the last client closed. */
213 for (i=0; i < ARRAY_SIZE(rates); i++)
214 if (runtime->rate == rates[i])
215 dev->pcm_info.rates = 1 << i;
217 snd_pcm_limit_hw_rates(runtime);
219 bytes_per_sample = BYTES_PER_SAMPLE;
220 if (dev->spec.data_alignment == 2)
223 bpp = ((runtime->rate / 8000) + CLOCK_DRIFT_TOLERANCE)
224 * bytes_per_sample * CHANNELS_PER_STREAM * dev->n_streams;
226 if (bpp > MAX_ENDPOINT_SIZE)
227 bpp = MAX_ENDPOINT_SIZE;
229 ret = snd_usb_caiaq_set_audio_params(dev, runtime->rate,
230 runtime->sample_bits, bpp);
234 ret = stream_start(dev);
238 dev->output_running = 0;
239 wait_event_timeout(dev->prepare_wait_queue, dev->output_running, HZ);
240 if (!dev->output_running) {
248 static int snd_usb_caiaq_pcm_trigger(struct snd_pcm_substream *sub, int cmd)
250 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
253 case SNDRV_PCM_TRIGGER_START:
254 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
255 activate_substream(dev, sub);
257 case SNDRV_PCM_TRIGGER_STOP:
258 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
259 deactivate_substream(dev, sub);
268 static snd_pcm_uframes_t
269 snd_usb_caiaq_pcm_pointer(struct snd_pcm_substream *sub)
271 int index = sub->number;
272 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
274 if (dev->input_panic || dev->output_panic)
275 return SNDRV_PCM_POS_XRUN;
277 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
278 return bytes_to_frames(sub->runtime,
279 dev->audio_out_buf_pos[index]);
281 return bytes_to_frames(sub->runtime,
282 dev->audio_in_buf_pos[index]);
285 /* operators for both playback and capture */
286 static struct snd_pcm_ops snd_usb_caiaq_ops = {
287 .open = snd_usb_caiaq_substream_open,
288 .close = snd_usb_caiaq_substream_close,
289 .ioctl = snd_pcm_lib_ioctl,
290 .hw_params = snd_usb_caiaq_pcm_hw_params,
291 .hw_free = snd_usb_caiaq_pcm_hw_free,
292 .prepare = snd_usb_caiaq_pcm_prepare,
293 .trigger = snd_usb_caiaq_pcm_trigger,
294 .pointer = snd_usb_caiaq_pcm_pointer
297 static void check_for_elapsed_periods(struct snd_usb_caiaqdev *dev,
298 struct snd_pcm_substream **subs)
300 int stream, pb, *cnt;
301 struct snd_pcm_substream *sub;
303 for (stream = 0; stream < dev->n_streams; stream++) {
308 pb = frames_to_bytes(sub->runtime,
309 sub->runtime->period_size);
310 cnt = (sub->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
311 &dev->period_out_count[stream] :
312 &dev->period_in_count[stream];
315 snd_pcm_period_elapsed(sub);
321 static void read_in_urb_mode0(struct snd_usb_caiaqdev *dev,
322 const struct urb *urb,
323 const struct usb_iso_packet_descriptor *iso)
325 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
326 struct snd_pcm_substream *sub;
329 if (all_substreams_zero(dev->sub_capture))
332 for (i = 0; i < iso->actual_length;) {
333 for (stream = 0; stream < dev->n_streams; stream++, i++) {
334 sub = dev->sub_capture[stream];
336 struct snd_pcm_runtime *rt = sub->runtime;
337 char *audio_buf = rt->dma_area;
338 int sz = frames_to_bytes(rt, rt->buffer_size);
339 audio_buf[dev->audio_in_buf_pos[stream]++]
341 dev->period_in_count[stream]++;
342 if (dev->audio_in_buf_pos[stream] == sz)
343 dev->audio_in_buf_pos[stream] = 0;
349 static void read_in_urb_mode2(struct snd_usb_caiaqdev *dev,
350 const struct urb *urb,
351 const struct usb_iso_packet_descriptor *iso)
353 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
354 unsigned char check_byte;
355 struct snd_pcm_substream *sub;
358 for (i = 0; i < iso->actual_length;) {
359 if (i % (dev->n_streams * BYTES_PER_SAMPLE_USB) == 0) {
361 stream < dev->n_streams;
363 if (dev->first_packet)
366 check_byte = MAKE_CHECKBYTE(dev, stream, i);
368 if ((usb_buf[i] & 0x3f) != check_byte)
369 dev->input_panic = 1;
371 if (usb_buf[i] & 0x80)
372 dev->output_panic = 1;
375 dev->first_packet = 0;
377 for (stream = 0; stream < dev->n_streams; stream++, i++) {
378 sub = dev->sub_capture[stream];
380 struct snd_pcm_runtime *rt = sub->runtime;
381 char *audio_buf = rt->dma_area;
382 int sz = frames_to_bytes(rt, rt->buffer_size);
383 audio_buf[dev->audio_in_buf_pos[stream]++] =
385 dev->period_in_count[stream]++;
386 if (dev->audio_in_buf_pos[stream] == sz)
387 dev->audio_in_buf_pos[stream] = 0;
393 static void read_in_urb(struct snd_usb_caiaqdev *dev,
394 const struct urb *urb,
395 const struct usb_iso_packet_descriptor *iso)
400 switch (dev->spec.data_alignment) {
402 read_in_urb_mode0(dev, urb, iso);
405 read_in_urb_mode2(dev, urb, iso);
409 if (dev->input_panic || dev->output_panic) {
410 debug("streaming error detected %s %s\n",
411 dev->input_panic ? "(input)" : "",
412 dev->output_panic ? "(output)" : "");
416 static void fill_out_urb(struct snd_usb_caiaqdev *dev,
418 const struct usb_iso_packet_descriptor *iso)
420 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
421 struct snd_pcm_substream *sub;
424 for (i = 0; i < iso->length;) {
425 for (stream = 0; stream < dev->n_streams; stream++, i++) {
426 sub = dev->sub_playback[stream];
428 struct snd_pcm_runtime *rt = sub->runtime;
429 char *audio_buf = rt->dma_area;
430 int sz = frames_to_bytes(rt, rt->buffer_size);
432 audio_buf[dev->audio_out_buf_pos[stream]];
433 dev->period_out_count[stream]++;
434 dev->audio_out_buf_pos[stream]++;
435 if (dev->audio_out_buf_pos[stream] == sz)
436 dev->audio_out_buf_pos[stream] = 0;
441 /* fill in the check bytes */
442 if (dev->spec.data_alignment == 2 &&
443 i % (dev->n_streams * BYTES_PER_SAMPLE_USB) ==
444 (dev->n_streams * CHANNELS_PER_STREAM))
445 for (stream = 0; stream < dev->n_streams; stream++, i++)
446 usb_buf[i] = MAKE_CHECKBYTE(dev, stream, i);
450 static void read_completed(struct urb *urb)
452 struct snd_usb_caiaq_cb_info *info = urb->context;
453 struct snd_usb_caiaqdev *dev;
455 int frame, len, send_it = 0, outframe = 0;
457 if (urb->status || !info)
465 out = dev->data_urbs_out[info->index];
467 /* read the recently received packet and send back one which has
469 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
470 if (urb->iso_frame_desc[frame].status)
473 len = urb->iso_frame_desc[outframe].actual_length;
474 out->iso_frame_desc[outframe].length = len;
475 out->iso_frame_desc[outframe].actual_length = 0;
476 out->iso_frame_desc[outframe].offset = BYTES_PER_FRAME * frame;
479 spin_lock(&dev->spinlock);
480 fill_out_urb(dev, out, &out->iso_frame_desc[outframe]);
481 read_in_urb(dev, urb, &urb->iso_frame_desc[frame]);
482 spin_unlock(&dev->spinlock);
483 check_for_elapsed_periods(dev, dev->sub_playback);
484 check_for_elapsed_periods(dev, dev->sub_capture);
492 out->number_of_packets = FRAMES_PER_URB;
493 out->transfer_flags = URB_ISO_ASAP;
494 usb_submit_urb(out, GFP_ATOMIC);
497 /* re-submit inbound urb */
498 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
499 urb->iso_frame_desc[frame].offset = BYTES_PER_FRAME * frame;
500 urb->iso_frame_desc[frame].length = BYTES_PER_FRAME;
501 urb->iso_frame_desc[frame].actual_length = 0;
504 urb->number_of_packets = FRAMES_PER_URB;
505 urb->transfer_flags = URB_ISO_ASAP;
506 usb_submit_urb(urb, GFP_ATOMIC);
509 static void write_completed(struct urb *urb)
511 struct snd_usb_caiaq_cb_info *info = urb->context;
512 struct snd_usb_caiaqdev *dev = info->dev;
514 if (!dev->output_running) {
515 dev->output_running = 1;
516 wake_up(&dev->prepare_wait_queue);
520 static struct urb **alloc_urbs(struct snd_usb_caiaqdev *dev, int dir, int *ret)
524 struct usb_device *usb_dev = dev->chip.dev;
527 pipe = (dir == SNDRV_PCM_STREAM_PLAYBACK) ?
528 usb_sndisocpipe(usb_dev, ENDPOINT_PLAYBACK) :
529 usb_rcvisocpipe(usb_dev, ENDPOINT_CAPTURE);
531 urbs = kmalloc(N_URBS * sizeof(*urbs), GFP_KERNEL);
533 log("unable to kmalloc() urbs, OOM!?\n");
538 for (i = 0; i < N_URBS; i++) {
539 urbs[i] = usb_alloc_urb(FRAMES_PER_URB, GFP_KERNEL);
541 log("unable to usb_alloc_urb(), OOM!?\n");
546 urbs[i]->transfer_buffer =
547 kmalloc(FRAMES_PER_URB * BYTES_PER_FRAME, GFP_KERNEL);
548 if (!urbs[i]->transfer_buffer) {
549 log("unable to kmalloc() transfer buffer, OOM!?\n");
554 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
555 struct usb_iso_packet_descriptor *iso =
556 &urbs[i]->iso_frame_desc[frame];
558 iso->offset = BYTES_PER_FRAME * frame;
559 iso->length = BYTES_PER_FRAME;
562 urbs[i]->dev = usb_dev;
563 urbs[i]->pipe = pipe;
564 urbs[i]->transfer_buffer_length = FRAMES_PER_URB
566 urbs[i]->context = &dev->data_cb_info[i];
567 urbs[i]->interval = 1;
568 urbs[i]->transfer_flags = URB_ISO_ASAP;
569 urbs[i]->number_of_packets = FRAMES_PER_URB;
570 urbs[i]->complete = (dir == SNDRV_PCM_STREAM_CAPTURE) ?
571 read_completed : write_completed;
578 static void free_urbs(struct urb **urbs)
585 for (i = 0; i < N_URBS; i++) {
589 usb_kill_urb(urbs[i]);
590 kfree(urbs[i]->transfer_buffer);
591 usb_free_urb(urbs[i]);
597 int snd_usb_caiaq_audio_init(struct snd_usb_caiaqdev *dev)
601 dev->n_audio_in = max(dev->spec.num_analog_audio_in,
602 dev->spec.num_digital_audio_in) /
604 dev->n_audio_out = max(dev->spec.num_analog_audio_out,
605 dev->spec.num_digital_audio_out) /
607 dev->n_streams = max(dev->n_audio_in, dev->n_audio_out);
609 debug("dev->n_audio_in = %d\n", dev->n_audio_in);
610 debug("dev->n_audio_out = %d\n", dev->n_audio_out);
611 debug("dev->n_streams = %d\n", dev->n_streams);
613 if (dev->n_streams > MAX_STREAMS) {
614 log("unable to initialize device, too many streams.\n");
618 ret = snd_pcm_new(dev->chip.card, dev->product_name, 0,
619 dev->n_audio_out, dev->n_audio_in, &dev->pcm);
622 log("snd_pcm_new() returned %d\n", ret);
626 dev->pcm->private_data = dev;
627 strcpy(dev->pcm->name, dev->product_name);
629 memset(dev->sub_playback, 0, sizeof(dev->sub_playback));
630 memset(dev->sub_capture, 0, sizeof(dev->sub_capture));
632 memcpy(&dev->pcm_info, &snd_usb_caiaq_pcm_hardware,
633 sizeof(snd_usb_caiaq_pcm_hardware));
635 /* setup samplerates */
636 dev->samplerates = dev->pcm_info.rates;
637 switch (dev->chip.usb_id) {
638 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
639 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
640 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_SESSIONIO):
641 dev->samplerates |= SNDRV_PCM_RATE_88200;
642 dev->samplerates |= SNDRV_PCM_RATE_192000;
644 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
645 dev->samplerates |= SNDRV_PCM_RATE_88200;
649 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_PLAYBACK,
651 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_CAPTURE,
654 snd_pcm_lib_preallocate_pages_for_all(dev->pcm,
655 SNDRV_DMA_TYPE_CONTINUOUS,
656 snd_dma_continuous_data(GFP_KERNEL),
657 MAX_BUFFER_SIZE, MAX_BUFFER_SIZE);
660 kmalloc(sizeof(struct snd_usb_caiaq_cb_info) * N_URBS,
663 if (!dev->data_cb_info)
666 for (i = 0; i < N_URBS; i++) {
667 dev->data_cb_info[i].dev = dev;
668 dev->data_cb_info[i].index = i;
671 dev->data_urbs_in = alloc_urbs(dev, SNDRV_PCM_STREAM_CAPTURE, &ret);
673 kfree(dev->data_cb_info);
674 free_urbs(dev->data_urbs_in);
678 dev->data_urbs_out = alloc_urbs(dev, SNDRV_PCM_STREAM_PLAYBACK, &ret);
680 kfree(dev->data_cb_info);
681 free_urbs(dev->data_urbs_in);
682 free_urbs(dev->data_urbs_out);
689 void snd_usb_caiaq_audio_free(struct snd_usb_caiaqdev *dev)
691 debug("%s(%p)\n", __func__, dev);
693 free_urbs(dev->data_urbs_in);
694 free_urbs(dev->data_urbs_out);
695 kfree(dev->data_cb_info);