2 * Copyright (c) 2006,2007 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)
80 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
81 dev->sub_playback[sub->number] = NULL;
83 dev->sub_capture[sub->number] = NULL;
87 all_substreams_zero(struct snd_pcm_substream **subs)
90 for (i = 0; i < MAX_STREAMS; i++)
96 static int stream_start(struct snd_usb_caiaqdev *dev)
100 debug("stream_start(%p)\n", dev);
101 spin_lock_irq(&dev->spinlock);
102 if (dev->streaming) {
103 spin_unlock_irq(&dev->spinlock);
107 dev->input_panic = 0;
108 dev->output_panic = 0;
109 dev->first_packet = 1;
112 for (i = 0; i < N_URBS; i++) {
113 ret = usb_submit_urb(dev->data_urbs_in[i], GFP_ATOMIC);
115 log("unable to trigger initial read #%d! (ret = %d)\n",
118 spin_unlock_irq(&dev->spinlock);
123 spin_unlock_irq(&dev->spinlock);
127 static void stream_stop(struct snd_usb_caiaqdev *dev)
131 debug("stream_stop(%p)\n", dev);
136 for (i = 0; i < N_URBS; i++) {
137 usb_unlink_urb(dev->data_urbs_in[i]);
138 usb_unlink_urb(dev->data_urbs_out[i]);
142 static int snd_usb_caiaq_substream_open(struct snd_pcm_substream *substream)
144 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
145 debug("snd_usb_caiaq_substream_open(%p)\n", substream);
146 substream->runtime->hw = dev->pcm_info;
147 snd_pcm_limit_hw_rates(substream->runtime);
151 static int snd_usb_caiaq_substream_close(struct snd_pcm_substream *substream)
153 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
155 debug("snd_usb_caiaq_substream_close(%p)\n", substream);
156 if (all_substreams_zero(dev->sub_playback) &&
157 all_substreams_zero(dev->sub_capture)) {
158 /* when the last client has stopped streaming,
159 * all sample rates are allowed again */
161 dev->pcm_info.rates = dev->samplerates;
167 static int snd_usb_caiaq_pcm_hw_params(struct snd_pcm_substream *sub,
168 struct snd_pcm_hw_params *hw_params)
170 debug("snd_usb_caiaq_pcm_hw_params(%p)\n", sub);
171 return snd_pcm_lib_malloc_pages(sub, params_buffer_bytes(hw_params));
174 static int snd_usb_caiaq_pcm_hw_free(struct snd_pcm_substream *sub)
176 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
177 debug("snd_usb_caiaq_pcm_hw_free(%p)\n", sub);
178 spin_lock_irq(&dev->spinlock);
179 deactivate_substream(dev, sub);
180 spin_unlock_irq(&dev->spinlock);
181 return snd_pcm_lib_free_pages(sub);
184 /* this should probably go upstream */
185 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
186 #error "Change this table"
189 static unsigned int rates[] = { 5512, 8000, 11025, 16000, 22050, 32000, 44100,
190 48000, 64000, 88200, 96000, 176400, 192000 };
192 static int snd_usb_caiaq_pcm_prepare(struct snd_pcm_substream *substream)
194 int bytes_per_sample, bpp, ret, i;
195 int index = substream->number;
196 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
197 struct snd_pcm_runtime *runtime = substream->runtime;
199 debug("snd_usb_caiaq_pcm_prepare(%p)\n", substream);
201 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
202 dev->audio_out_buf_pos[index] = BYTES_PER_SAMPLE + 1;
204 dev->audio_in_buf_pos[index] = 0;
209 /* the first client that opens a stream defines the sample rate
210 * setting for all subsequent calls, until the last client closed. */
211 for (i=0; i < ARRAY_SIZE(rates); i++)
212 if (runtime->rate == rates[i])
213 dev->pcm_info.rates = 1 << i;
215 snd_pcm_limit_hw_rates(runtime);
217 bytes_per_sample = BYTES_PER_SAMPLE;
218 if (dev->spec.data_alignment == 2)
221 bpp = ((runtime->rate / 8000) + CLOCK_DRIFT_TOLERANCE)
222 * bytes_per_sample * CHANNELS_PER_STREAM * dev->n_streams;
224 ret = snd_usb_caiaq_set_audio_params(dev, runtime->rate,
225 runtime->sample_bits, bpp);
229 ret = stream_start(dev);
233 dev->output_running = 0;
234 wait_event_timeout(dev->prepare_wait_queue, dev->output_running, HZ);
235 if (!dev->output_running) {
243 static int snd_usb_caiaq_pcm_trigger(struct snd_pcm_substream *sub, int cmd)
245 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
248 case SNDRV_PCM_TRIGGER_START:
249 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
250 spin_lock(&dev->spinlock);
251 activate_substream(dev, sub);
252 spin_unlock(&dev->spinlock);
254 case SNDRV_PCM_TRIGGER_STOP:
255 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
256 spin_lock(&dev->spinlock);
257 deactivate_substream(dev, sub);
258 spin_unlock(&dev->spinlock);
267 static snd_pcm_uframes_t
268 snd_usb_caiaq_pcm_pointer(struct snd_pcm_substream *sub)
270 int index = sub->number;
271 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
273 if (dev->input_panic || dev->output_panic)
274 return SNDRV_PCM_POS_XRUN;
276 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
277 return bytes_to_frames(sub->runtime,
278 dev->audio_out_buf_pos[index]);
280 return bytes_to_frames(sub->runtime,
281 dev->audio_in_buf_pos[index]);
284 /* operators for both playback and capture */
285 static struct snd_pcm_ops snd_usb_caiaq_ops = {
286 .open = snd_usb_caiaq_substream_open,
287 .close = snd_usb_caiaq_substream_close,
288 .ioctl = snd_pcm_lib_ioctl,
289 .hw_params = snd_usb_caiaq_pcm_hw_params,
290 .hw_free = snd_usb_caiaq_pcm_hw_free,
291 .prepare = snd_usb_caiaq_pcm_prepare,
292 .trigger = snd_usb_caiaq_pcm_trigger,
293 .pointer = snd_usb_caiaq_pcm_pointer
296 static void check_for_elapsed_periods(struct snd_usb_caiaqdev *dev,
297 struct snd_pcm_substream **subs)
299 int stream, pb, *cnt;
300 struct snd_pcm_substream *sub;
302 for (stream = 0; stream < dev->n_streams; stream++) {
307 pb = frames_to_bytes(sub->runtime,
308 sub->runtime->period_size);
309 cnt = (sub->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
310 &dev->period_out_count[stream] :
311 &dev->period_in_count[stream];
314 snd_pcm_period_elapsed(sub);
320 static void read_in_urb_mode0(struct snd_usb_caiaqdev *dev,
321 const struct urb *urb,
322 const struct usb_iso_packet_descriptor *iso)
324 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
325 struct snd_pcm_substream *sub;
328 if (all_substreams_zero(dev->sub_capture))
331 spin_lock(&dev->spinlock);
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;
349 spin_unlock(&dev->spinlock);
352 static void read_in_urb_mode2(struct snd_usb_caiaqdev *dev,
353 const struct urb *urb,
354 const struct usb_iso_packet_descriptor *iso)
356 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
357 unsigned char check_byte;
358 struct snd_pcm_substream *sub;
361 spin_lock(&dev->spinlock);
363 for (i = 0; i < iso->actual_length;) {
364 if (i % (dev->n_streams * BYTES_PER_SAMPLE_USB) == 0) {
366 stream < dev->n_streams;
368 if (dev->first_packet)
371 check_byte = MAKE_CHECKBYTE(dev, stream, i);
373 if ((usb_buf[i] & 0x3f) != check_byte)
374 dev->input_panic = 1;
376 if (usb_buf[i] & 0x80)
377 dev->output_panic = 1;
380 dev->first_packet = 0;
382 for (stream = 0; stream < dev->n_streams; stream++, i++) {
383 sub = dev->sub_capture[stream];
385 struct snd_pcm_runtime *rt = sub->runtime;
386 char *audio_buf = rt->dma_area;
387 int sz = frames_to_bytes(rt, rt->buffer_size);
388 audio_buf[dev->audio_in_buf_pos[stream]++] =
390 dev->period_in_count[stream]++;
391 if (dev->audio_in_buf_pos[stream] == sz)
392 dev->audio_in_buf_pos[stream] = 0;
397 spin_unlock(&dev->spinlock);
400 static void read_in_urb(struct snd_usb_caiaqdev *dev,
401 const struct urb *urb,
402 const struct usb_iso_packet_descriptor *iso)
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) {
417 debug("streaming error detected %s %s\n",
418 dev->input_panic ? "(input)" : "",
419 dev->output_panic ? "(output)" : "");
422 check_for_elapsed_periods(dev, dev->sub_capture);
425 static void fill_out_urb(struct snd_usb_caiaqdev *dev,
427 const struct usb_iso_packet_descriptor *iso)
429 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
430 struct snd_pcm_substream *sub;
433 spin_lock(&dev->spinlock);
435 for (i = 0; i < iso->length;) {
436 for (stream = 0; stream < dev->n_streams; stream++, i++) {
437 sub = dev->sub_playback[stream];
439 struct snd_pcm_runtime *rt = sub->runtime;
440 char *audio_buf = rt->dma_area;
441 int sz = frames_to_bytes(rt, rt->buffer_size);
443 audio_buf[dev->audio_out_buf_pos[stream]];
444 dev->period_out_count[stream]++;
445 dev->audio_out_buf_pos[stream]++;
446 if (dev->audio_out_buf_pos[stream] == sz)
447 dev->audio_out_buf_pos[stream] = 0;
452 /* fill in the check bytes */
453 if (dev->spec.data_alignment == 2 &&
454 i % (dev->n_streams * BYTES_PER_SAMPLE_USB) ==
455 (dev->n_streams * CHANNELS_PER_STREAM))
456 for (stream = 0; stream < dev->n_streams; stream++, i++)
457 usb_buf[i] = MAKE_CHECKBYTE(dev, stream, i);
460 spin_unlock(&dev->spinlock);
461 check_for_elapsed_periods(dev, dev->sub_playback);
464 static void read_completed(struct urb *urb)
466 struct snd_usb_caiaq_cb_info *info = urb->context;
467 struct snd_usb_caiaqdev *dev;
469 int frame, len, send_it = 0, outframe = 0;
471 if (urb->status || !info)
478 out = dev->data_urbs_out[info->index];
480 /* read the recently received packet and send back one which has
482 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
483 if (urb->iso_frame_desc[frame].status)
486 len = urb->iso_frame_desc[outframe].actual_length;
487 out->iso_frame_desc[outframe].length = len;
488 out->iso_frame_desc[outframe].actual_length = 0;
489 out->iso_frame_desc[outframe].offset = BYTES_PER_FRAME * frame;
492 fill_out_urb(dev, out, &out->iso_frame_desc[outframe]);
493 read_in_urb(dev, urb, &urb->iso_frame_desc[frame]);
501 out->number_of_packets = FRAMES_PER_URB;
502 out->transfer_flags = URB_ISO_ASAP;
503 usb_submit_urb(out, GFP_ATOMIC);
506 /* re-submit inbound urb */
507 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
508 urb->iso_frame_desc[frame].offset = BYTES_PER_FRAME * frame;
509 urb->iso_frame_desc[frame].length = BYTES_PER_FRAME;
510 urb->iso_frame_desc[frame].actual_length = 0;
513 urb->number_of_packets = FRAMES_PER_URB;
514 urb->transfer_flags = URB_ISO_ASAP;
515 usb_submit_urb(urb, GFP_ATOMIC);
518 static void write_completed(struct urb *urb)
520 struct snd_usb_caiaq_cb_info *info = urb->context;
521 struct snd_usb_caiaqdev *dev = info->dev;
523 if (!dev->output_running) {
524 dev->output_running = 1;
525 wake_up(&dev->prepare_wait_queue);
529 static struct urb **alloc_urbs(struct snd_usb_caiaqdev *dev, int dir, int *ret)
533 struct usb_device *usb_dev = dev->chip.dev;
536 pipe = (dir == SNDRV_PCM_STREAM_PLAYBACK) ?
537 usb_sndisocpipe(usb_dev, ENDPOINT_PLAYBACK) :
538 usb_rcvisocpipe(usb_dev, ENDPOINT_CAPTURE);
540 urbs = kmalloc(N_URBS * sizeof(*urbs), GFP_KERNEL);
542 log("unable to kmalloc() urbs, OOM!?\n");
547 for (i = 0; i < N_URBS; i++) {
548 urbs[i] = usb_alloc_urb(FRAMES_PER_URB, GFP_KERNEL);
550 log("unable to usb_alloc_urb(), OOM!?\n");
555 urbs[i]->transfer_buffer =
556 kmalloc(FRAMES_PER_URB * BYTES_PER_FRAME, GFP_KERNEL);
557 if (!urbs[i]->transfer_buffer) {
558 log("unable to kmalloc() transfer buffer, OOM!?\n");
563 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
564 struct usb_iso_packet_descriptor *iso =
565 &urbs[i]->iso_frame_desc[frame];
567 iso->offset = BYTES_PER_FRAME * frame;
568 iso->length = BYTES_PER_FRAME;
571 urbs[i]->dev = usb_dev;
572 urbs[i]->pipe = pipe;
573 urbs[i]->transfer_buffer_length = FRAMES_PER_URB
575 urbs[i]->context = &dev->data_cb_info[i];
576 urbs[i]->interval = 1;
577 urbs[i]->transfer_flags = URB_ISO_ASAP;
578 urbs[i]->number_of_packets = FRAMES_PER_URB;
579 urbs[i]->complete = (dir == SNDRV_PCM_STREAM_CAPTURE) ?
580 read_completed : write_completed;
587 static void free_urbs(struct urb **urbs)
594 for (i = 0; i < N_URBS; i++) {
598 usb_kill_urb(urbs[i]);
599 kfree(urbs[i]->transfer_buffer);
600 usb_free_urb(urbs[i]);
606 int snd_usb_caiaq_audio_init(struct snd_usb_caiaqdev *dev)
610 dev->n_audio_in = max(dev->spec.num_analog_audio_in,
611 dev->spec.num_digital_audio_in) /
613 dev->n_audio_out = max(dev->spec.num_analog_audio_out,
614 dev->spec.num_digital_audio_out) /
616 dev->n_streams = max(dev->n_audio_in, dev->n_audio_out);
618 debug("dev->n_audio_in = %d\n", dev->n_audio_in);
619 debug("dev->n_audio_out = %d\n", dev->n_audio_out);
620 debug("dev->n_streams = %d\n", dev->n_streams);
622 if (dev->n_streams > MAX_STREAMS) {
623 log("unable to initialize device, too many streams.\n");
627 ret = snd_pcm_new(dev->chip.card, dev->product_name, 0,
628 dev->n_audio_out, dev->n_audio_in, &dev->pcm);
631 log("snd_pcm_new() returned %d\n", ret);
635 dev->pcm->private_data = dev;
636 strcpy(dev->pcm->name, dev->product_name);
638 memset(dev->sub_playback, 0, sizeof(dev->sub_playback));
639 memset(dev->sub_capture, 0, sizeof(dev->sub_capture));
641 memcpy(&dev->pcm_info, &snd_usb_caiaq_pcm_hardware,
642 sizeof(snd_usb_caiaq_pcm_hardware));
644 /* setup samplerates */
645 dev->samplerates = dev->pcm_info.rates;
646 switch (dev->chip.usb_id) {
647 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
648 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
649 dev->samplerates |= SNDRV_PCM_RATE_88200;
650 dev->samplerates |= SNDRV_PCM_RATE_192000;
652 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
653 dev->samplerates |= SNDRV_PCM_RATE_88200;
657 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_PLAYBACK,
659 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_CAPTURE,
662 snd_pcm_lib_preallocate_pages_for_all(dev->pcm,
663 SNDRV_DMA_TYPE_CONTINUOUS,
664 snd_dma_continuous_data(GFP_KERNEL),
665 MAX_BUFFER_SIZE, MAX_BUFFER_SIZE);
668 kmalloc(sizeof(struct snd_usb_caiaq_cb_info) * N_URBS,
671 if (!dev->data_cb_info)
674 for (i = 0; i < N_URBS; i++) {
675 dev->data_cb_info[i].dev = dev;
676 dev->data_cb_info[i].index = i;
679 dev->data_urbs_in = alloc_urbs(dev, SNDRV_PCM_STREAM_CAPTURE, &ret);
681 kfree(dev->data_cb_info);
682 free_urbs(dev->data_urbs_in);
686 dev->data_urbs_out = alloc_urbs(dev, SNDRV_PCM_STREAM_PLAYBACK, &ret);
688 kfree(dev->data_cb_info);
689 free_urbs(dev->data_urbs_in);
690 free_urbs(dev->data_urbs_out);
697 void snd_usb_caiaq_audio_free(struct snd_usb_caiaqdev *dev)
699 debug("snd_usb_caiaq_audio_free (%p)\n", dev);
701 free_urbs(dev->data_urbs_in);
702 free_urbs(dev->data_urbs_out);
703 kfree(dev->data_cb_info);