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 <sound/driver.h>
20 #include <linux/init.h>
21 #include <linux/module.h>
22 #include <linux/moduleparam.h>
23 #include <linux/interrupt.h>
24 #include <linux/usb.h>
25 #include <linux/spinlock.h>
26 #include <sound/core.h>
27 #include <sound/initval.h>
28 #include <sound/pcm.h>
29 #include <sound/rawmidi.h>
30 #ifdef CONFIG_SND_USB_CAIAQ_INPUT
31 #include <linux/input.h>
34 #include "caiaq-device.h"
35 #include "caiaq-audio.h"
38 #define CLOCK_DRIFT_TOLERANCE 5
39 #define FRAMES_PER_URB 8
40 #define BYTES_PER_FRAME 512
41 #define CHANNELS_PER_STREAM 2
42 #define BYTES_PER_SAMPLE 3
43 #define BYTES_PER_SAMPLE_USB 4
44 #define MAX_BUFFER_SIZE (128*1024)
46 #define ENDPOINT_CAPTURE 2
47 #define ENDPOINT_PLAYBACK 6
49 #define MAKE_CHECKBYTE(dev,stream,i) \
50 (stream << 1) | (~(i / (dev->n_streams * BYTES_PER_SAMPLE_USB)) & 1)
52 static struct snd_pcm_hardware snd_usb_caiaq_pcm_hardware = {
53 .info = (SNDRV_PCM_INFO_MMAP | SNDRV_PCM_INFO_INTERLEAVED |
54 SNDRV_PCM_INFO_BLOCK_TRANSFER),
55 .formats = SNDRV_PCM_FMTBIT_S24_3BE,
56 .rates = (SNDRV_PCM_RATE_44100 | SNDRV_PCM_RATE_48000 |
57 SNDRV_PCM_RATE_96000),
59 .rate_max = 0, /* will overwrite later */
60 .channels_min = CHANNELS_PER_STREAM,
61 .channels_max = CHANNELS_PER_STREAM,
62 .buffer_bytes_max = MAX_BUFFER_SIZE,
63 .period_bytes_min = 4096,
64 .period_bytes_max = MAX_BUFFER_SIZE,
70 activate_substream(struct snd_usb_caiaqdev *dev,
71 struct snd_pcm_substream *sub)
73 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
74 dev->sub_playback[sub->number] = sub;
76 dev->sub_capture[sub->number] = sub;
80 deactivate_substream(struct snd_usb_caiaqdev *dev,
81 struct snd_pcm_substream *sub)
83 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
84 dev->sub_playback[sub->number] = NULL;
86 dev->sub_capture[sub->number] = NULL;
90 all_substreams_zero(struct snd_pcm_substream **subs)
93 for (i = 0; i < MAX_STREAMS; i++)
99 static int stream_start(struct snd_usb_caiaqdev *dev)
103 debug("stream_start(%p)\n", dev);
104 spin_lock_irq(&dev->spinlock);
105 if (dev->streaming) {
106 spin_unlock_irq(&dev->spinlock);
110 dev->input_panic = 0;
111 dev->output_panic = 0;
112 dev->first_packet = 1;
115 for (i = 0; i < N_URBS; i++) {
116 ret = usb_submit_urb(dev->data_urbs_in[i], GFP_ATOMIC);
118 log("unable to trigger initial read #%d! (ret = %d)\n",
121 spin_unlock_irq(&dev->spinlock);
126 spin_unlock_irq(&dev->spinlock);
130 static void stream_stop(struct snd_usb_caiaqdev *dev)
134 debug("stream_stop(%p)\n", dev);
139 for (i = 0; i < N_URBS; i++) {
140 usb_unlink_urb(dev->data_urbs_in[i]);
141 usb_unlink_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("snd_usb_caiaq_substream_open(%p)\n", 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("snd_usb_caiaq_substream_close(%p)\n", 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("snd_usb_caiaq_pcm_hw_params(%p)\n", 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("snd_usb_caiaq_pcm_hw_free(%p)\n", sub);
181 spin_lock_irq(&dev->spinlock);
182 deactivate_substream(dev, sub);
183 spin_unlock_irq(&dev->spinlock);
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("snd_usb_caiaq_pcm_prepare(%p)\n", 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] = 0;
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 ret = snd_usb_caiaq_set_audio_params(dev, runtime->rate,
228 runtime->sample_bits, bpp);
232 ret = stream_start(dev);
236 dev->output_running = 0;
237 wait_event_timeout(dev->prepare_wait_queue, dev->output_running, HZ);
238 if (!dev->output_running) {
246 static int snd_usb_caiaq_pcm_trigger(struct snd_pcm_substream *sub, int cmd)
248 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
251 case SNDRV_PCM_TRIGGER_START:
252 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
253 spin_lock(&dev->spinlock);
254 activate_substream(dev, sub);
255 spin_unlock(&dev->spinlock);
257 case SNDRV_PCM_TRIGGER_STOP:
258 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
259 spin_lock(&dev->spinlock);
260 deactivate_substream(dev, sub);
261 spin_unlock(&dev->spinlock);
270 static snd_pcm_uframes_t
271 snd_usb_caiaq_pcm_pointer(struct snd_pcm_substream *sub)
273 int index = sub->number;
274 struct snd_usb_caiaqdev *dev = snd_pcm_substream_chip(sub);
276 if (dev->input_panic || dev->output_panic)
277 return SNDRV_PCM_POS_XRUN;
279 if (sub->stream == SNDRV_PCM_STREAM_PLAYBACK)
280 return bytes_to_frames(sub->runtime,
281 dev->audio_out_buf_pos[index]);
283 return bytes_to_frames(sub->runtime,
284 dev->audio_in_buf_pos[index]);
287 /* operators for both playback and capture */
288 static struct snd_pcm_ops snd_usb_caiaq_ops = {
289 .open = snd_usb_caiaq_substream_open,
290 .close = snd_usb_caiaq_substream_close,
291 .ioctl = snd_pcm_lib_ioctl,
292 .hw_params = snd_usb_caiaq_pcm_hw_params,
293 .hw_free = snd_usb_caiaq_pcm_hw_free,
294 .prepare = snd_usb_caiaq_pcm_prepare,
295 .trigger = snd_usb_caiaq_pcm_trigger,
296 .pointer = snd_usb_caiaq_pcm_pointer
299 static void check_for_elapsed_periods(struct snd_usb_caiaqdev *dev,
300 struct snd_pcm_substream **subs)
302 int stream, pb, *cnt;
303 struct snd_pcm_substream *sub;
305 for (stream = 0; stream < dev->n_streams; stream++) {
310 pb = frames_to_bytes(sub->runtime,
311 sub->runtime->period_size);
312 cnt = (sub->stream == SNDRV_PCM_STREAM_PLAYBACK) ?
313 &dev->period_out_count[stream] :
314 &dev->period_in_count[stream];
317 snd_pcm_period_elapsed(sub);
323 static void read_in_urb_mode0(struct snd_usb_caiaqdev *dev,
324 const struct urb *urb,
325 const struct usb_iso_packet_descriptor *iso)
327 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
328 struct snd_pcm_substream *sub;
331 if (all_substreams_zero(dev->sub_capture))
334 spin_lock(&dev->spinlock);
336 for (i = 0; i < iso->actual_length;) {
337 for (stream = 0; stream < dev->n_streams; stream++, i++) {
338 sub = dev->sub_capture[stream];
340 struct snd_pcm_runtime *rt = sub->runtime;
341 char *audio_buf = rt->dma_area;
342 int sz = frames_to_bytes(rt, rt->buffer_size);
343 audio_buf[dev->audio_in_buf_pos[stream]++]
345 dev->period_in_count[stream]++;
346 if (dev->audio_in_buf_pos[stream] == sz)
347 dev->audio_in_buf_pos[stream] = 0;
352 spin_unlock(&dev->spinlock);
355 static void read_in_urb_mode2(struct snd_usb_caiaqdev *dev,
356 const struct urb *urb,
357 const struct usb_iso_packet_descriptor *iso)
359 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
360 unsigned char check_byte;
361 struct snd_pcm_substream *sub;
364 spin_lock(&dev->spinlock);
366 for (i = 0; i < iso->actual_length;) {
367 if (i % (dev->n_streams * BYTES_PER_SAMPLE_USB) == 0) {
369 stream < dev->n_streams;
371 if (dev->first_packet)
374 check_byte = MAKE_CHECKBYTE(dev, stream, i);
376 if ((usb_buf[i] & 0x3f) != check_byte)
377 dev->input_panic = 1;
379 if (usb_buf[i] & 0x80)
380 dev->output_panic = 1;
383 dev->first_packet = 0;
385 for (stream = 0; stream < dev->n_streams; stream++, i++) {
386 sub = dev->sub_capture[stream];
388 struct snd_pcm_runtime *rt = sub->runtime;
389 char *audio_buf = rt->dma_area;
390 int sz = frames_to_bytes(rt, rt->buffer_size);
391 audio_buf[dev->audio_in_buf_pos[stream]++] =
393 dev->period_in_count[stream]++;
394 if (dev->audio_in_buf_pos[stream] == sz)
395 dev->audio_in_buf_pos[stream] = 0;
400 spin_unlock(&dev->spinlock);
403 static void read_in_urb(struct snd_usb_caiaqdev *dev,
404 const struct urb *urb,
405 const struct usb_iso_packet_descriptor *iso)
410 switch (dev->spec.data_alignment) {
412 read_in_urb_mode0(dev, urb, iso);
415 read_in_urb_mode2(dev, urb, iso);
419 if (dev->input_panic || dev->output_panic) {
420 debug("streaming error detected %s %s\n",
421 dev->input_panic ? "(input)" : "",
422 dev->output_panic ? "(output)" : "");
425 check_for_elapsed_periods(dev, dev->sub_capture);
428 static void fill_out_urb(struct snd_usb_caiaqdev *dev,
430 const struct usb_iso_packet_descriptor *iso)
432 unsigned char *usb_buf = urb->transfer_buffer + iso->offset;
433 struct snd_pcm_substream *sub;
436 spin_lock(&dev->spinlock);
438 for (i = 0; i < iso->length;) {
439 for (stream = 0; stream < dev->n_streams; stream++, i++) {
440 sub = dev->sub_playback[stream];
442 struct snd_pcm_runtime *rt = sub->runtime;
443 char *audio_buf = rt->dma_area;
444 int sz = frames_to_bytes(rt, rt->buffer_size);
446 audio_buf[dev->audio_out_buf_pos[stream]];
447 dev->period_out_count[stream]++;
448 dev->audio_out_buf_pos[stream]++;
449 if (dev->audio_out_buf_pos[stream] == sz)
450 dev->audio_out_buf_pos[stream] = 0;
455 /* fill in the check bytes */
456 if (dev->spec.data_alignment == 2 &&
457 i % (dev->n_streams * BYTES_PER_SAMPLE_USB) ==
458 (dev->n_streams * CHANNELS_PER_STREAM))
459 for (stream = 0; stream < dev->n_streams; stream++, i++)
460 usb_buf[i] = MAKE_CHECKBYTE(dev, stream, i);
463 spin_unlock(&dev->spinlock);
464 check_for_elapsed_periods(dev, dev->sub_playback);
467 static void read_completed(struct urb *urb)
469 struct snd_usb_caiaq_cb_info *info = urb->context;
470 struct snd_usb_caiaqdev *dev;
472 int frame, len, send_it = 0, outframe = 0;
474 if (urb->status || !info)
481 out = dev->data_urbs_out[info->index];
483 /* read the recently received packet and send back one which has
485 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
486 if (urb->iso_frame_desc[frame].status)
489 len = urb->iso_frame_desc[outframe].actual_length;
490 out->iso_frame_desc[outframe].length = len;
491 out->iso_frame_desc[outframe].actual_length = 0;
492 out->iso_frame_desc[outframe].offset = BYTES_PER_FRAME * frame;
495 fill_out_urb(dev, out, &out->iso_frame_desc[outframe]);
496 read_in_urb(dev, urb, &urb->iso_frame_desc[frame]);
504 out->number_of_packets = FRAMES_PER_URB;
505 out->transfer_flags = URB_ISO_ASAP;
506 usb_submit_urb(out, GFP_ATOMIC);
509 /* re-submit inbound urb */
510 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
511 urb->iso_frame_desc[frame].offset = BYTES_PER_FRAME * frame;
512 urb->iso_frame_desc[frame].length = BYTES_PER_FRAME;
513 urb->iso_frame_desc[frame].actual_length = 0;
516 urb->number_of_packets = FRAMES_PER_URB;
517 urb->transfer_flags = URB_ISO_ASAP;
518 usb_submit_urb(urb, GFP_ATOMIC);
521 static void write_completed(struct urb *urb)
523 struct snd_usb_caiaq_cb_info *info = urb->context;
524 struct snd_usb_caiaqdev *dev = info->dev;
526 if (!dev->output_running) {
527 dev->output_running = 1;
528 wake_up(&dev->prepare_wait_queue);
532 static struct urb **alloc_urbs(struct snd_usb_caiaqdev *dev, int dir, int *ret)
536 struct usb_device *usb_dev = dev->chip.dev;
539 pipe = (dir == SNDRV_PCM_STREAM_PLAYBACK) ?
540 usb_sndisocpipe(usb_dev, ENDPOINT_PLAYBACK) :
541 usb_rcvisocpipe(usb_dev, ENDPOINT_CAPTURE);
543 urbs = kmalloc(N_URBS * sizeof(*urbs), GFP_KERNEL);
545 log("unable to kmalloc() urbs, OOM!?\n");
550 for (i = 0; i < N_URBS; i++) {
551 urbs[i] = usb_alloc_urb(FRAMES_PER_URB, GFP_KERNEL);
553 log("unable to usb_alloc_urb(), OOM!?\n");
558 urbs[i]->transfer_buffer =
559 kmalloc(FRAMES_PER_URB * BYTES_PER_FRAME, GFP_KERNEL);
560 if (!urbs[i]->transfer_buffer) {
561 log("unable to kmalloc() transfer buffer, OOM!?\n");
566 for (frame = 0; frame < FRAMES_PER_URB; frame++) {
567 struct usb_iso_packet_descriptor *iso =
568 &urbs[i]->iso_frame_desc[frame];
570 iso->offset = BYTES_PER_FRAME * frame;
571 iso->length = BYTES_PER_FRAME;
574 urbs[i]->dev = usb_dev;
575 urbs[i]->pipe = pipe;
576 urbs[i]->transfer_buffer_length = FRAMES_PER_URB
578 urbs[i]->context = &dev->data_cb_info[i];
579 urbs[i]->interval = 1;
580 urbs[i]->transfer_flags = URB_ISO_ASAP;
581 urbs[i]->number_of_packets = FRAMES_PER_URB;
582 urbs[i]->complete = (dir == SNDRV_PCM_STREAM_CAPTURE) ?
583 read_completed : write_completed;
590 static void free_urbs(struct urb **urbs)
597 for (i = 0; i < N_URBS; i++) {
601 usb_kill_urb(urbs[i]);
602 kfree(urbs[i]->transfer_buffer);
603 usb_free_urb(urbs[i]);
609 int __devinit snd_usb_caiaq_audio_init(struct snd_usb_caiaqdev *dev)
613 dev->n_audio_in = max(dev->spec.num_analog_audio_in,
614 dev->spec.num_digital_audio_in) /
616 dev->n_audio_out = max(dev->spec.num_analog_audio_out,
617 dev->spec.num_digital_audio_out) /
619 dev->n_streams = max(dev->n_audio_in, dev->n_audio_out);
621 debug("dev->n_audio_in = %d\n", dev->n_audio_in);
622 debug("dev->n_audio_out = %d\n", dev->n_audio_out);
623 debug("dev->n_streams = %d\n", dev->n_streams);
625 if (dev->n_streams > MAX_STREAMS) {
626 log("unable to initialize device, too many streams.\n");
630 ret = snd_pcm_new(dev->chip.card, dev->product_name, 0,
631 dev->n_audio_out, dev->n_audio_in, &dev->pcm);
634 log("snd_pcm_new() returned %d\n", ret);
638 dev->pcm->private_data = dev;
639 strcpy(dev->pcm->name, dev->product_name);
641 memset(dev->sub_playback, 0, sizeof(dev->sub_playback));
642 memset(dev->sub_capture, 0, sizeof(dev->sub_capture));
644 memcpy(&dev->pcm_info, &snd_usb_caiaq_pcm_hardware,
645 sizeof(snd_usb_caiaq_pcm_hardware));
647 /* setup samplerates */
648 dev->samplerates = dev->pcm_info.rates;
649 switch (dev->chip.usb_id) {
650 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AK1):
651 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_RIGKONTROL3):
652 dev->samplerates |= SNDRV_PCM_RATE_88200;
653 dev->samplerates |= SNDRV_PCM_RATE_192000;
655 case USB_ID(USB_VID_NATIVEINSTRUMENTS, USB_PID_AUDIO8DJ):
656 dev->samplerates |= SNDRV_PCM_RATE_88200;
660 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_PLAYBACK,
662 snd_pcm_set_ops(dev->pcm, SNDRV_PCM_STREAM_CAPTURE,
665 snd_pcm_lib_preallocate_pages_for_all(dev->pcm,
666 SNDRV_DMA_TYPE_CONTINUOUS,
667 snd_dma_continuous_data(GFP_KERNEL),
668 MAX_BUFFER_SIZE, MAX_BUFFER_SIZE);
671 kmalloc(sizeof(struct snd_usb_caiaq_cb_info) * N_URBS,
674 if (!dev->data_cb_info)
677 for (i = 0; i < N_URBS; i++) {
678 dev->data_cb_info[i].dev = dev;
679 dev->data_cb_info[i].index = i;
682 dev->data_urbs_in = alloc_urbs(dev, SNDRV_PCM_STREAM_CAPTURE, &ret);
684 kfree(dev->data_cb_info);
685 free_urbs(dev->data_urbs_in);
689 dev->data_urbs_out = alloc_urbs(dev, SNDRV_PCM_STREAM_PLAYBACK, &ret);
691 kfree(dev->data_cb_info);
692 free_urbs(dev->data_urbs_in);
693 free_urbs(dev->data_urbs_out);
700 void snd_usb_caiaq_audio_free(struct snd_usb_caiaqdev *dev)
702 debug("snd_usb_caiaq_audio_free (%p)\n", dev);
704 free_urbs(dev->data_urbs_in);
705 free_urbs(dev->data_urbs_out);
706 kfree(dev->data_cb_info);