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)
43 #define ENDPOINT_CAPTURE 2
44 #define ENDPOINT_PLAYBACK 6
46 #define MAKE_CHECKBYTE(dev,stream,i) \
47 (stream << 1) | (~(i / (dev->n_streams * BYTES_PER_SAMPLE_USB)) & 1)
49 static struct snd_pcm_hardware snd_usb_caiaq_pcm_hardware = {
50 .info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
51 SNDRV_PCM_INFO_BLOCK_TRANSFER),
52 .formats = SNDRV_PCM_FMTBIT_S24_3BE,
53 .rates = (SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000 |
54 SNDRV_PCM_RATE_96000),
56 .rate_max = 0, /* will overwrite later */
57 .channels_min = CHANNELS_PER_STREAM,
58 .channels_max = CHANNELS_PER_STREAM,
59 .buffer_bytes_max = MAX_BUFFER_SIZE,
60 .period_bytes_min = 128,
61 .period_bytes_max = MAX_BUFFER_SIZE,
67 activate_substream(struct snd_usb_caiaqdev *dev,
68 struct snd_pcm_substream *sub)
70 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
71 dev->sub_playback[sub->number] = sub;
73 dev->sub_capture[sub->number] = sub;
77 deactivate_substream(struct snd_usb_caiaqdev *dev,
78 struct snd_pcm_substream *sub)
81 spin_lock_irqsave(&dev->spinlock, flags);
83 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
84 dev->sub_playback[sub->number] = NULL;
86 dev->sub_capture[sub->number] = NULL;
88 spin_unlock_irqrestore(&dev->spinlock, flags);
92 all_substreams_zero(struct snd_pcm_substream **subs)
95 for (i = 0; i < MAX_STREAMS; i++)
101 static int stream_start(struct snd_usb_caiaqdev *dev)
105 debug("%s(%p)\n", __func__, dev);
110 memset(dev->sub_playback, 0, sizeof(dev->sub_playback));
111 memset(dev->sub_capture, 0, sizeof(dev->sub_capture));
112 dev->input_panic = 0;
113 dev->output_panic = 0;
114 dev->first_packet = 1;
117 for (i = 0; i < N_URBS; i++) {
118 ret = usb_submit_urb(dev->data_urbs_in[i], GFP_ATOMIC);
120 log("unable to trigger read #%d! (ret %d)\n", i, ret);
129 static void stream_stop(struct snd_usb_caiaqdev *dev)
133 debug("%s(%p)\n", __func__, dev);
139 for (i = 0; i < N_URBS; i++) {
140 usb_kill_urb(dev->data_urbs_in[i]);
141 usb_kill_urb(dev->data_urbs_out[i]);
145 static int snd_usb_caiaq_substream_open(struct snd_pcm_substream *substream)
147 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
148 debug("%s(%p)\n", __func__, substream);
149 substream->runtime->hw = dev->pcm_info;
150 snd_pcm_limit_hw_rates(substream->runtime);
154 static int snd_usb_caiaq_substream_close(struct snd_pcm_substream *substream)
156 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
158 debug("%s(%p)\n", __func__, substream);
159 if (all_substreams_zero(dev->sub_playback) &&
160 all_substreams_zero(dev->sub_capture)) {
161 /* when the last client has stopped streaming,
162 * all sample rates are allowed again */
164 dev->pcm_info.rates = dev->samplerates;
170 static int snd_usb_caiaq_pcm_hw_params(struct snd_pcm_substream *sub,
171 struct snd_pcm_hw_params *hw_params)
173 debug("%s(%p)\n", __func__, sub);
174 return snd_pcm_lib_malloc_pages(sub, params_buffer_bytes(hw_params));
177 static int snd_usb_caiaq_pcm_hw_free(struct snd_pcm_substream *sub)
179 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
180 debug("%s(%p)\n", __func__, sub);
181 deactivate_substream(dev, sub);
182 return snd_pcm_lib_free_pages(sub);
185 /* this should probably go upstream */
186 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
187 #error "Change this table"
190 static unsigned int rates[] = { 5512, 8000, 11025, 16000, 22050, 32000, 44100,
191 48000, 64000, 88200, 96000, 176400, 192000 };
193 static int snd_usb_caiaq_pcm_prepare(struct snd_pcm_substream *substream)
195 int bytes_per_sample, bpp, ret, i;
196 int index = substream->number;
197 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
198 struct snd_pcm_runtime *runtime = substream->runtime;
200 debug("%s(%p)\n", __func__, substream);
202 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
203 dev->audio_out_buf_pos[index] = BYTES_PER_SAMPLE + 1;
205 dev->audio_in_buf_pos[index] = BYTES_PER_SAMPLE;
210 /* the first client that opens a stream defines the sample rate
211 * setting for all subsequent calls, until the last client closed. */
212 for (i=0; i < ARRAY_SIZE(rates); i++)
213 if (runtime->rate == rates[i])
214 dev->pcm_info.rates = 1 << i;
216 snd_pcm_limit_hw_rates(runtime);
218 bytes_per_sample = BYTES_PER_SAMPLE;
219 if (dev->spec.data_alignment == 2)
222 bpp = ((runtime->rate / 8000) + CLOCK_DRIFT_TOLERANCE)
223 * bytes_per_sample * CHANNELS_PER_STREAM * dev->n_streams;
225 ret = snd_usb_caiaq_set_audio_params(dev, runtime->rate,
226 runtime->sample_bits, bpp);
230 ret = stream_start(dev);
234 dev->output_running = 0;
235 wait_event_timeout(dev->prepare_wait_queue, dev->output_running, HZ);
236 if (!dev->output_running) {
244 static int snd_usb_caiaq_pcm_trigger(struct snd_pcm_substream *sub, int cmd)
246 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
249 case SNDRV_PCM_TRIGGER_START:
250 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
251 activate_substream(dev, sub);
253 case SNDRV_PCM_TRIGGER_STOP:
254 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
255 deactivate_substream(dev, sub);
264 static snd_pcm_uframes_t
265 snd_usb_caiaq_pcm_pointer(struct snd_pcm_substream *sub)
267 int index = sub->number;
268 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
270 if (dev->input_panic || dev->output_panic)
271 return SNDRV_PCM_POS_XRUN;
273 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
274 return bytes_to_frames(sub->runtime,
275 dev->audio_out_buf_pos[index]);
277 return bytes_to_frames(sub->runtime,
278 dev->audio_in_buf_pos[index]);
281 /* operators for both playback and capture */
282 static struct snd_pcm_ops snd_usb_caiaq_ops = {
283 .open = snd_usb_caiaq_substream_open,
284 .close = snd_usb_caiaq_substream_close,
285 .ioctl = snd_pcm_lib_ioctl,
286 .hw_params = snd_usb_caiaq_pcm_hw_params,
287 .hw_free = snd_usb_caiaq_pcm_hw_free,
288 .prepare = snd_usb_caiaq_pcm_prepare,
289 .trigger = snd_usb_caiaq_pcm_trigger,
290 .pointer = snd_usb_caiaq_pcm_pointer
293 static void check_for_elapsed_periods(struct snd_usb_caiaqdev *dev,
294 struct snd_pcm_substream **subs)
296 int stream, pb, *cnt;
297 struct snd_pcm_substream *sub;
299 for (stream = 0; stream < dev->n_streams; stream++) {
304 pb = frames_to_bytes(sub->runtime,
305 sub->runtime->period_size);
306 cnt = (sub->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
307 &dev->period_out_count[stream] :
308 &dev->period_in_count[stream];
311 snd_pcm_period_elapsed(sub);
317 static void read_in_urb_mode0(struct snd_usb_caiaqdev *dev,
318 const struct urb *urb,
319 const struct usb_iso_packet_descriptor *iso)
321 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
322 struct snd_pcm_substream *sub;
325 if (all_substreams_zero(dev->sub_capture))
328 for (i = 0; i < iso->actual_length;) {
329 for (stream = 0; stream < dev->n_streams; stream++, i++) {
330 sub = dev->sub_capture[stream];
332 struct snd_pcm_runtime *rt = sub->runtime;
333 char *audio_buf = rt->dma_area;
334 int sz = frames_to_bytes(rt, rt->buffer_size);
335 audio_buf[dev->audio_in_buf_pos[stream]++]
337 dev->period_in_count[stream]++;
338 if (dev->audio_in_buf_pos[stream] == sz)
339 dev->audio_in_buf_pos[stream] = 0;
345 static void read_in_urb_mode2(struct snd_usb_caiaqdev *dev,
346 const struct urb *urb,
347 const struct usb_iso_packet_descriptor *iso)
349 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
350 unsigned char check_byte;
351 struct snd_pcm_substream *sub;
354 for (i = 0; i < iso->actual_length;) {
355 if (i % (dev->n_streams * BYTES_PER_SAMPLE_USB) == 0) {
357 stream < dev->n_streams;
359 if (dev->first_packet)
362 check_byte = MAKE_CHECKBYTE(dev, stream, i);
364 if ((usb_buf[i] & 0x3f) != check_byte)
365 dev->input_panic = 1;
367 if (usb_buf[i] & 0x80)
368 dev->output_panic = 1;
371 dev->first_packet = 0;
373 for (stream = 0; stream < dev->n_streams; stream++, i++) {
374 sub = dev->sub_capture[stream];
376 struct snd_pcm_runtime *rt = sub->runtime;
377 char *audio_buf = rt->dma_area;
378 int sz = frames_to_bytes(rt, rt->buffer_size);
379 audio_buf[dev->audio_in_buf_pos[stream]++] =
381 dev->period_in_count[stream]++;
382 if (dev->audio_in_buf_pos[stream] == sz)
383 dev->audio_in_buf_pos[stream] = 0;
389 static void read_in_urb(struct snd_usb_caiaqdev *dev,
390 const struct urb *urb,
391 const struct usb_iso_packet_descriptor *iso)
396 switch (dev->spec.data_alignment) {
398 read_in_urb_mode0(dev, urb, iso);
401 read_in_urb_mode2(dev, urb, iso);
405 if (dev->input_panic || dev->output_panic) {
406 debug("streaming error detected %s %s\n",
407 dev->input_panic ? "(input)" : "",
408 dev->output_panic ? "(output)" : "");
412 static void fill_out_urb(struct snd_usb_caiaqdev *dev,
414 const struct usb_iso_packet_descriptor *iso)
416 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
417 struct snd_pcm_substream *sub;
420 for (i = 0; i < iso->length;) {
421 for (stream = 0; stream < dev->n_streams; stream++, i++) {
422 sub = dev->sub_playback[stream];
424 struct snd_pcm_runtime *rt = sub->runtime;
425 char *audio_buf = rt->dma_area;
426 int sz = frames_to_bytes(rt, rt->buffer_size);
428 audio_buf[dev->audio_out_buf_pos[stream]];
429 dev->period_out_count[stream]++;
430 dev->audio_out_buf_pos[stream]++;
431 if (dev->audio_out_buf_pos[stream] == sz)
432 dev->audio_out_buf_pos[stream] = 0;
437 /* fill in the check bytes */
438 if (dev->spec.data_alignment == 2 &&
439 i % (dev->n_streams * BYTES_PER_SAMPLE_USB) ==
440 (dev->n_streams * CHANNELS_PER_STREAM))
441 for (stream = 0; stream < dev->n_streams; stream++, i++)
442 usb_buf[i] = MAKE_CHECKBYTE(dev, stream, i);
446 static void read_completed(struct urb *urb)
448 struct snd_usb_caiaq_cb_info *info = urb->context;
449 struct snd_usb_caiaqdev *dev;
451 int frame, len, send_it = 0, outframe = 0;
453 if (urb->status || !info)
461 out = dev->data_urbs_out[info->index];
463 /* read the recently received packet and send back one which has
465 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
466 if (urb->iso_frame_desc[frame].status)
469 len = urb->iso_frame_desc[outframe].actual_length;
470 out->iso_frame_desc[outframe].length = len;
471 out->iso_frame_desc[outframe].actual_length = 0;
472 out->iso_frame_desc[outframe].offset = BYTES_PER_FRAME * frame;
475 spin_lock(&dev->spinlock);
476 fill_out_urb(dev, out, &out->iso_frame_desc[outframe]);
477 read_in_urb(dev, urb, &urb->iso_frame_desc[frame]);
478 spin_unlock(&dev->spinlock);
479 check_for_elapsed_periods(dev, dev->sub_playback);
480 check_for_elapsed_periods(dev, dev->sub_capture);
488 out->number_of_packets = FRAMES_PER_URB;
489 out->transfer_flags = URB_ISO_ASAP;
490 usb_submit_urb(out, GFP_ATOMIC);
493 /* re-submit inbound urb */
494 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
495 urb->iso_frame_desc[frame].offset = BYTES_PER_FRAME * frame;
496 urb->iso_frame_desc[frame].length = BYTES_PER_FRAME;
497 urb->iso_frame_desc[frame].actual_length = 0;
500 urb->number_of_packets = FRAMES_PER_URB;
501 urb->transfer_flags = URB_ISO_ASAP;
502 usb_submit_urb(urb, GFP_ATOMIC);
505 static void write_completed(struct urb *urb)
507 struct snd_usb_caiaq_cb_info *info = urb->context;
508 struct snd_usb_caiaqdev *dev = info->dev;
510 if (!dev->output_running) {
511 dev->output_running = 1;
512 wake_up(&dev->prepare_wait_queue);
516 static struct urb **alloc_urbs(struct snd_usb_caiaqdev *dev, int dir, int *ret)
520 struct usb_device *usb_dev = dev->chip.dev;
523 pipe = (dir == SNDRV_PCM_STREAM_PLAYBACK) ?
524 usb_sndisocpipe(usb_dev, ENDPOINT_PLAYBACK) :
525 usb_rcvisocpipe(usb_dev, ENDPOINT_CAPTURE);
527 urbs = kmalloc(N_URBS * sizeof(*urbs), GFP_KERNEL);
529 log("unable to kmalloc() urbs, OOM!?\n");
534 for (i = 0; i < N_URBS; i++) {
535 urbs[i] = usb_alloc_urb(FRAMES_PER_URB, GFP_KERNEL);
537 log("unable to usb_alloc_urb(), OOM!?\n");
542 urbs[i]->transfer_buffer =
543 kmalloc(FRAMES_PER_URB * BYTES_PER_FRAME, GFP_KERNEL);
544 if (!urbs[i]->transfer_buffer) {
545 log("unable to kmalloc() transfer buffer, OOM!?\n");
550 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
551 struct usb_iso_packet_descriptor *iso =
552 &urbs[i]->iso_frame_desc[frame];
554 iso->offset = BYTES_PER_FRAME * frame;
555 iso->length = BYTES_PER_FRAME;
558 urbs[i]->dev = usb_dev;
559 urbs[i]->pipe = pipe;
560 urbs[i]->transfer_buffer_length = FRAMES_PER_URB
562 urbs[i]->context = &dev->data_cb_info[i];
563 urbs[i]->interval = 1;
564 urbs[i]->transfer_flags = URB_ISO_ASAP;
565 urbs[i]->number_of_packets = FRAMES_PER_URB;
566 urbs[i]->complete = (dir == SNDRV_PCM_STREAM_CAPTURE) ?
567 read_completed : write_completed;
574 static void free_urbs(struct urb **urbs)
581 for (i = 0; i < N_URBS; i++) {
585 usb_kill_urb(urbs[i]);
586 kfree(urbs[i]->transfer_buffer);
587 usb_free_urb(urbs[i]);
593 int snd_usb_caiaq_audio_init(struct snd_usb_caiaqdev *dev)
597 dev->n_audio_in = max(dev->spec.num_analog_audio_in,
598 dev->spec.num_digital_audio_in) /
600 dev->n_audio_out = max(dev->spec.num_analog_audio_out,
601 dev->spec.num_digital_audio_out) /
603 dev->n_streams = max(dev->n_audio_in, dev->n_audio_out);
605 debug("dev->n_audio_in = %d\n", dev->n_audio_in);
606 debug("dev->n_audio_out = %d\n", dev->n_audio_out);
607 debug("dev->n_streams = %d\n", dev->n_streams);
609 if (dev->n_streams > MAX_STREAMS) {
610 log("unable to initialize device, too many streams.\n");
614 ret = snd_pcm_new(dev->chip.card, dev->product_name, 0,
615 dev->n_audio_out, dev->n_audio_in, &dev->pcm);
618 log("snd_pcm_new() returned %d\n", ret);
622 dev->pcm->private_data = dev;
623 strcpy(dev->pcm->name, dev->product_name);
625 memset(dev->sub_playback, 0, sizeof(dev->sub_playback));
626 memset(dev->sub_capture, 0, sizeof(dev->sub_capture));
628 memcpy(&dev->pcm_info, &snd_usb_caiaq_pcm_hardware,
629 sizeof(snd_usb_caiaq_pcm_hardware));
631 /* setup samplerates */
632 dev->samplerates = dev->pcm_info.rates;
633 switch (dev->chip.usb_id) {
634 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
635 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
636 dev->samplerates |= SNDRV_PCM_RATE_88200;
637 dev->samplerates |= SNDRV_PCM_RATE_192000;
639 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
640 dev->samplerates |= SNDRV_PCM_RATE_88200;
644 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_PLAYBACK,
646 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_CAPTURE,
649 snd_pcm_lib_preallocate_pages_for_all(dev->pcm,
650 SNDRV_DMA_TYPE_CONTINUOUS,
651 snd_dma_continuous_data(GFP_KERNEL),
652 MAX_BUFFER_SIZE, MAX_BUFFER_SIZE);
655 kmalloc(sizeof(struct snd_usb_caiaq_cb_info) * N_URBS,
658 if (!dev->data_cb_info)
661 for (i = 0; i < N_URBS; i++) {
662 dev->data_cb_info[i].dev = dev;
663 dev->data_cb_info[i].index = i;
666 dev->data_urbs_in = alloc_urbs(dev, SNDRV_PCM_STREAM_CAPTURE, &ret);
668 kfree(dev->data_cb_info);
669 free_urbs(dev->data_urbs_in);
673 dev->data_urbs_out = alloc_urbs(dev, SNDRV_PCM_STREAM_PLAYBACK, &ret);
675 kfree(dev->data_cb_info);
676 free_urbs(dev->data_urbs_in);
677 free_urbs(dev->data_urbs_out);
684 void snd_usb_caiaq_audio_free(struct snd_usb_caiaqdev *dev)
686 debug("%s(%p)\n", __func__, dev);
688 free_urbs(dev->data_urbs_in);
689 free_urbs(dev->data_urbs_out);
690 kfree(dev->data_cb_info);