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/spinlock.h>
20 #include <linux/init.h>
21 #include <linux/usb.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
29 #define CLOCK_DRIFT_TOLERANCE 5
30 #define FRAMES_PER_URB 8
31 #define BYTES_PER_FRAME 512
32 #define CHANNELS_PER_STREAM 2
33 #define BYTES_PER_SAMPLE 3
34 #define BYTES_PER_SAMPLE_USB 4
35 #define MAX_BUFFER_SIZE (128*1024)
36 #define MAX_ENDPOINT_SIZE 512
38 #define ENDPOINT_CAPTURE 2
39 #define ENDPOINT_PLAYBACK 6
41 #define MAKE_CHECKBYTE(dev,stream,i) \
42 (stream << 1) | (~(i / (dev->n_streams * BYTES_PER_SAMPLE_USB)) & 1)
44 static struct snd_pcm_hardware snd_usb_caiaq_pcm_hardware = {
45 .info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
46 SNDRV_PCM_INFO_BLOCK_TRANSFER),
47 .formats = SNDRV_PCM_FMTBIT_S24_3BE,
48 .rates = (SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000 |
49 SNDRV_PCM_RATE_96000),
51 .rate_max = 0, /* will overwrite later */
52 .channels_min = CHANNELS_PER_STREAM,
53 .channels_max = CHANNELS_PER_STREAM,
54 .buffer_bytes_max = MAX_BUFFER_SIZE,
55 .period_bytes_min = 128,
56 .period_bytes_max = MAX_BUFFER_SIZE,
62 activate_substream(struct snd_usb_caiaqdev *dev,
63 struct snd_pcm_substream *sub)
65 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
66 dev->sub_playback[sub->number] = sub;
68 dev->sub_capture[sub->number] = sub;
72 deactivate_substream(struct snd_usb_caiaqdev *dev,
73 struct snd_pcm_substream *sub)
76 spin_lock_irqsave(&dev->spinlock, flags);
78 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
79 dev->sub_playback[sub->number] = NULL;
81 dev->sub_capture[sub->number] = NULL;
83 spin_unlock_irqrestore(&dev->spinlock, flags);
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("%s(%p)\n", __func__, dev);
105 memset(dev->sub_playback, 0, sizeof(dev->sub_playback));
106 memset(dev->sub_capture, 0, sizeof(dev->sub_capture));
107 dev->input_panic = 0;
108 dev->output_panic = 0;
109 dev->first_packet = 1;
113 for (i = 0; i < N_URBS; i++) {
114 ret = usb_submit_urb(dev->data_urbs_in[i], GFP_ATOMIC);
116 log("unable to trigger read #%d! (ret %d)\n", i, ret);
125 static void stream_stop(struct snd_usb_caiaqdev *dev)
129 debug("%s(%p)\n", __func__, dev);
135 for (i = 0; i < N_URBS; i++) {
136 usb_kill_urb(dev->data_urbs_in[i]);
137 usb_kill_urb(dev->data_urbs_out[i]);
141 static int snd_usb_caiaq_substream_open(struct snd_pcm_substream *substream)
143 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
144 debug("%s(%p)\n", __func__, substream);
145 substream->runtime->hw = dev->pcm_info;
146 snd_pcm_limit_hw_rates(substream->runtime);
150 static int snd_usb_caiaq_substream_close(struct snd_pcm_substream *substream)
152 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
154 debug("%s(%p)\n", __func__, substream);
155 if (all_substreams_zero(dev->sub_playback) &&
156 all_substreams_zero(dev->sub_capture)) {
157 /* when the last client has stopped streaming,
158 * all sample rates are allowed again */
160 dev->pcm_info.rates = dev->samplerates;
166 static int snd_usb_caiaq_pcm_hw_params(struct snd_pcm_substream *sub,
167 struct snd_pcm_hw_params *hw_params)
169 debug("%s(%p)\n", __func__, sub);
170 return snd_pcm_lib_malloc_pages(sub, params_buffer_bytes(hw_params));
173 static int snd_usb_caiaq_pcm_hw_free(struct snd_pcm_substream *sub)
175 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
176 debug("%s(%p)\n", __func__, sub);
177 deactivate_substream(dev, sub);
178 return snd_pcm_lib_free_pages(sub);
181 /* this should probably go upstream */
182 #if SNDRV_PCM_RATE_5512 != 1 << 0 || SNDRV_PCM_RATE_192000 != 1 << 12
183 #error "Change this table"
186 static unsigned int rates[] = { 5512, 8000, 11025, 16000, 22050, 32000, 44100,
187 48000, 64000, 88200, 96000, 176400, 192000 };
189 static int snd_usb_caiaq_pcm_prepare(struct snd_pcm_substream *substream)
191 int bytes_per_sample, bpp, ret, i;
192 int index = substream->number;
193 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(substream);
194 struct snd_pcm_runtime *runtime = substream->runtime;
196 debug("%s(%p)\n", __func__, substream);
198 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
199 dev->audio_out_buf_pos[index] = BYTES_PER_SAMPLE + 1;
201 dev->audio_in_buf_pos[index] = BYTES_PER_SAMPLE;
206 /* the first client that opens a stream defines the sample rate
207 * setting for all subsequent calls, until the last client closed. */
208 for (i=0; i < ARRAY_SIZE(rates); i++)
209 if (runtime->rate == rates[i])
210 dev->pcm_info.rates = 1 << i;
212 snd_pcm_limit_hw_rates(runtime);
214 bytes_per_sample = BYTES_PER_SAMPLE;
215 if (dev->spec.data_alignment == 2)
218 bpp = ((runtime->rate / 8000) + CLOCK_DRIFT_TOLERANCE)
219 * bytes_per_sample * CHANNELS_PER_STREAM * dev->n_streams;
221 if (bpp > MAX_ENDPOINT_SIZE)
222 bpp = MAX_ENDPOINT_SIZE;
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 activate_substream(dev, sub);
252 case SNDRV_PCM_TRIGGER_STOP:
253 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
254 deactivate_substream(dev, sub);
263 static snd_pcm_uframes_t
264 snd_usb_caiaq_pcm_pointer(struct snd_pcm_substream *sub)
266 int index = sub->number;
267 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
269 if (dev->input_panic || dev->output_panic)
270 return SNDRV_PCM_POS_XRUN;
272 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
273 return bytes_to_frames(sub->runtime,
274 dev->audio_out_buf_pos[index]);
276 return bytes_to_frames(sub->runtime,
277 dev->audio_in_buf_pos[index]);
280 /* operators for both playback and capture */
281 static struct snd_pcm_ops snd_usb_caiaq_ops = {
282 .open = snd_usb_caiaq_substream_open,
283 .close = snd_usb_caiaq_substream_close,
284 .ioctl = snd_pcm_lib_ioctl,
285 .hw_params = snd_usb_caiaq_pcm_hw_params,
286 .hw_free = snd_usb_caiaq_pcm_hw_free,
287 .prepare = snd_usb_caiaq_pcm_prepare,
288 .trigger = snd_usb_caiaq_pcm_trigger,
289 .pointer = snd_usb_caiaq_pcm_pointer
292 static void check_for_elapsed_periods(struct snd_usb_caiaqdev *dev,
293 struct snd_pcm_substream **subs)
295 int stream, pb, *cnt;
296 struct snd_pcm_substream *sub;
298 for (stream = 0; stream < dev->n_streams; stream++) {
303 pb = frames_to_bytes(sub->runtime,
304 sub->runtime->period_size);
305 cnt = (sub->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
306 &dev->period_out_count[stream] :
307 &dev->period_in_count[stream];
310 snd_pcm_period_elapsed(sub);
316 static void read_in_urb_mode0(struct snd_usb_caiaqdev *dev,
317 const struct urb *urb,
318 const struct usb_iso_packet_descriptor *iso)
320 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
321 struct snd_pcm_substream *sub;
324 if (all_substreams_zero(dev->sub_capture))
327 for (i = 0; i < iso->actual_length;) {
328 for (stream = 0; stream < dev->n_streams; stream++, i++) {
329 sub = dev->sub_capture[stream];
331 struct snd_pcm_runtime *rt = sub->runtime;
332 char *audio_buf = rt->dma_area;
333 int sz = frames_to_bytes(rt, rt->buffer_size);
334 audio_buf[dev->audio_in_buf_pos[stream]++]
336 dev->period_in_count[stream]++;
337 if (dev->audio_in_buf_pos[stream] == sz)
338 dev->audio_in_buf_pos[stream] = 0;
344 static void read_in_urb_mode2(struct snd_usb_caiaqdev *dev,
345 const struct urb *urb,
346 const struct usb_iso_packet_descriptor *iso)
348 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
349 unsigned char check_byte;
350 struct snd_pcm_substream *sub;
353 for (i = 0; i < iso->actual_length;) {
354 if (i % (dev->n_streams * BYTES_PER_SAMPLE_USB) == 0) {
356 stream < dev->n_streams;
358 if (dev->first_packet)
361 check_byte = MAKE_CHECKBYTE(dev, stream, i);
363 if ((usb_buf[i] & 0x3f) != check_byte)
364 dev->input_panic = 1;
366 if (usb_buf[i] & 0x80)
367 dev->output_panic = 1;
370 dev->first_packet = 0;
372 for (stream = 0; stream < dev->n_streams; stream++, i++) {
373 sub = dev->sub_capture[stream];
374 if (dev->input_panic)
378 struct snd_pcm_runtime *rt = sub->runtime;
379 char *audio_buf = rt->dma_area;
380 int sz = frames_to_bytes(rt, rt->buffer_size);
381 audio_buf[dev->audio_in_buf_pos[stream]++] =
383 dev->period_in_count[stream]++;
384 if (dev->audio_in_buf_pos[stream] == sz)
385 dev->audio_in_buf_pos[stream] = 0;
391 static void read_in_urb(struct snd_usb_caiaqdev *dev,
392 const struct urb *urb,
393 const struct usb_iso_packet_descriptor *iso)
398 if (iso->actual_length < dev->bpp)
401 switch (dev->spec.data_alignment) {
403 read_in_urb_mode0(dev, urb, iso);
406 read_in_urb_mode2(dev, urb, iso);
410 if ((dev->input_panic || dev->output_panic) && !dev->warned) {
411 debug("streaming error detected %s %s\n",
412 dev->input_panic ? "(input)" : "",
413 dev->output_panic ? "(output)" : "");
418 static void fill_out_urb(struct snd_usb_caiaqdev *dev,
420 const struct usb_iso_packet_descriptor *iso)
422 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
423 struct snd_pcm_substream *sub;
426 for (i = 0; i < iso->length;) {
427 for (stream = 0; stream < dev->n_streams; stream++, i++) {
428 sub = dev->sub_playback[stream];
430 struct snd_pcm_runtime *rt = sub->runtime;
431 char *audio_buf = rt->dma_area;
432 int sz = frames_to_bytes(rt, rt->buffer_size);
434 audio_buf[dev->audio_out_buf_pos[stream]];
435 dev->period_out_count[stream]++;
436 dev->audio_out_buf_pos[stream]++;
437 if (dev->audio_out_buf_pos[stream] == sz)
438 dev->audio_out_buf_pos[stream] = 0;
443 /* fill in the check bytes */
444 if (dev->spec.data_alignment == 2 &&
445 i % (dev->n_streams * BYTES_PER_SAMPLE_USB) ==
446 (dev->n_streams * CHANNELS_PER_STREAM))
447 for (stream = 0; stream < dev->n_streams; stream++, i++)
448 usb_buf[i] = MAKE_CHECKBYTE(dev, stream, i);
452 static void read_completed(struct urb *urb)
454 struct snd_usb_caiaq_cb_info *info = urb->context;
455 struct snd_usb_caiaqdev *dev;
457 int frame, len, send_it = 0, outframe = 0;
459 if (urb->status || !info)
467 out = dev->data_urbs_out[info->index];
469 /* read the recently received packet and send back one which has
471 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
472 if (urb->iso_frame_desc[frame].status)
475 len = urb->iso_frame_desc[outframe].actual_length;
476 out->iso_frame_desc[outframe].length = len;
477 out->iso_frame_desc[outframe].actual_length = 0;
478 out->iso_frame_desc[outframe].offset = BYTES_PER_FRAME * frame;
481 spin_lock(&dev->spinlock);
482 fill_out_urb(dev, out, &out->iso_frame_desc[outframe]);
483 read_in_urb(dev, urb, &urb->iso_frame_desc[frame]);
484 spin_unlock(&dev->spinlock);
485 check_for_elapsed_periods(dev, dev->sub_playback);
486 check_for_elapsed_periods(dev, dev->sub_capture);
494 out->number_of_packets = FRAMES_PER_URB;
495 out->transfer_flags = URB_ISO_ASAP;
496 usb_submit_urb(out, GFP_ATOMIC);
499 /* re-submit inbound urb */
500 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
501 urb->iso_frame_desc[frame].offset = BYTES_PER_FRAME * frame;
502 urb->iso_frame_desc[frame].length = BYTES_PER_FRAME;
503 urb->iso_frame_desc[frame].actual_length = 0;
506 urb->number_of_packets = FRAMES_PER_URB;
507 urb->transfer_flags = URB_ISO_ASAP;
508 usb_submit_urb(urb, GFP_ATOMIC);
511 static void write_completed(struct urb *urb)
513 struct snd_usb_caiaq_cb_info *info = urb->context;
514 struct snd_usb_caiaqdev *dev = info->dev;
516 if (!dev->output_running) {
517 dev->output_running = 1;
518 wake_up(&dev->prepare_wait_queue);
522 static struct urb **alloc_urbs(struct snd_usb_caiaqdev *dev, int dir, int *ret)
526 struct usb_device *usb_dev = dev->chip.dev;
529 pipe = (dir == SNDRV_PCM_STREAM_PLAYBACK) ?
530 usb_sndisocpipe(usb_dev, ENDPOINT_PLAYBACK) :
531 usb_rcvisocpipe(usb_dev, ENDPOINT_CAPTURE);
533 urbs = kmalloc(N_URBS * sizeof(*urbs), GFP_KERNEL);
535 log("unable to kmalloc() urbs, OOM!?\n");
540 for (i = 0; i < N_URBS; i++) {
541 urbs[i] = usb_alloc_urb(FRAMES_PER_URB, GFP_KERNEL);
543 log("unable to usb_alloc_urb(), OOM!?\n");
548 urbs[i]->transfer_buffer =
549 kmalloc(FRAMES_PER_URB * BYTES_PER_FRAME, GFP_KERNEL);
550 if (!urbs[i]->transfer_buffer) {
551 log("unable to kmalloc() transfer buffer, OOM!?\n");
556 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
557 struct usb_iso_packet_descriptor *iso =
558 &urbs[i]->iso_frame_desc[frame];
560 iso->offset = BYTES_PER_FRAME * frame;
561 iso->length = BYTES_PER_FRAME;
564 urbs[i]->dev = usb_dev;
565 urbs[i]->pipe = pipe;
566 urbs[i]->transfer_buffer_length = FRAMES_PER_URB
568 urbs[i]->context = &dev->data_cb_info[i];
569 urbs[i]->interval = 1;
570 urbs[i]->transfer_flags = URB_ISO_ASAP;
571 urbs[i]->number_of_packets = FRAMES_PER_URB;
572 urbs[i]->complete = (dir == SNDRV_PCM_STREAM_CAPTURE) ?
573 read_completed : write_completed;
580 static void free_urbs(struct urb **urbs)
587 for (i = 0; i < N_URBS; i++) {
591 usb_kill_urb(urbs[i]);
592 kfree(urbs[i]->transfer_buffer);
593 usb_free_urb(urbs[i]);
599 int snd_usb_caiaq_audio_init(struct snd_usb_caiaqdev *dev)
603 dev->n_audio_in = max(dev->spec.num_analog_audio_in,
604 dev->spec.num_digital_audio_in) /
606 dev->n_audio_out = max(dev->spec.num_analog_audio_out,
607 dev->spec.num_digital_audio_out) /
609 dev->n_streams = max(dev->n_audio_in, dev->n_audio_out);
611 debug("dev->n_audio_in = %d\n", dev->n_audio_in);
612 debug("dev->n_audio_out = %d\n", dev->n_audio_out);
613 debug("dev->n_streams = %d\n", dev->n_streams);
615 if (dev->n_streams > MAX_STREAMS) {
616 log("unable to initialize device, too many streams.\n");
620 ret = snd_pcm_new(dev->chip.card, dev->product_name, 0,
621 dev->n_audio_out, dev->n_audio_in, &dev->pcm);
624 log("snd_pcm_new() returned %d\n", ret);
628 dev->pcm->private_data = dev;
629 strcpy(dev->pcm->name, dev->product_name);
631 memset(dev->sub_playback, 0, sizeof(dev->sub_playback));
632 memset(dev->sub_capture, 0, sizeof(dev->sub_capture));
634 memcpy(&dev->pcm_info, &snd_usb_caiaq_pcm_hardware,
635 sizeof(snd_usb_caiaq_pcm_hardware));
637 /* setup samplerates */
638 dev->samplerates = dev->pcm_info.rates;
639 switch (dev->chip.usb_id) {
640 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
641 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
642 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_SESSIONIO):
643 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_GUITARRIGMOBILE):
644 dev->samplerates |= SNDRV_PCM_RATE_192000;
646 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO4DJ):
647 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
648 dev->samplerates |= SNDRV_PCM_RATE_88200;
652 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_PLAYBACK,
654 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_CAPTURE,
657 snd_pcm_lib_preallocate_pages_for_all(dev->pcm,
658 SNDRV_DMA_TYPE_CONTINUOUS,
659 snd_dma_continuous_data(GFP_KERNEL),
660 MAX_BUFFER_SIZE, MAX_BUFFER_SIZE);
663 kmalloc(sizeof(struct snd_usb_caiaq_cb_info) * N_URBS,
666 if (!dev->data_cb_info)
669 for (i = 0; i < N_URBS; i++) {
670 dev->data_cb_info[i].dev = dev;
671 dev->data_cb_info[i].index = i;
674 dev->data_urbs_in = alloc_urbs(dev, SNDRV_PCM_STREAM_CAPTURE, &ret);
676 kfree(dev->data_cb_info);
677 free_urbs(dev->data_urbs_in);
681 dev->data_urbs_out = alloc_urbs(dev, SNDRV_PCM_STREAM_PLAYBACK, &ret);
683 kfree(dev->data_cb_info);
684 free_urbs(dev->data_urbs_in);
685 free_urbs(dev->data_urbs_out);
692 void snd_usb_caiaq_audio_free(struct snd_usb_caiaqdev *dev)
694 debug("%s(%p)\n", __func__, dev);
696 free_urbs(dev->data_urbs_in);
697 free_urbs(dev->data_urbs_out);
698 kfree(dev->data_cb_info);