2 * Line 6 Linux USB driver
4 * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at)
6 * This program is free software; you can redistribute it and/or
7 * modify it under the terms of the GNU General Public License as
8 * published by the Free Software Foundation, version 2.
12 #include <linux/slab.h>
13 #include <linux/export.h>
14 #include <sound/core.h>
15 #include <sound/control.h>
16 #include <sound/pcm.h>
17 #include <sound/pcm_params.h>
23 /* impulse response volume controls */
24 static int snd_line6_impulse_volume_info(struct snd_kcontrol *kcontrol,
25 struct snd_ctl_elem_info *uinfo)
27 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
29 uinfo->value.integer.min = 0;
30 uinfo->value.integer.max = 255;
34 static int snd_line6_impulse_volume_get(struct snd_kcontrol *kcontrol,
35 struct snd_ctl_elem_value *ucontrol)
37 struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
39 ucontrol->value.integer.value[0] = line6pcm->impulse_volume;
43 static int snd_line6_impulse_volume_put(struct snd_kcontrol *kcontrol,
44 struct snd_ctl_elem_value *ucontrol)
46 struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
47 int value = ucontrol->value.integer.value[0];
50 if (line6pcm->impulse_volume == value)
53 line6pcm->impulse_volume = value;
55 err = line6_pcm_acquire(line6pcm, LINE6_STREAM_IMPULSE, true);
57 line6pcm->impulse_volume = 0;
61 line6_pcm_release(line6pcm, LINE6_STREAM_IMPULSE);
66 /* impulse response period controls */
67 static int snd_line6_impulse_period_info(struct snd_kcontrol *kcontrol,
68 struct snd_ctl_elem_info *uinfo)
70 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
72 uinfo->value.integer.min = 0;
73 uinfo->value.integer.max = 2000;
77 static int snd_line6_impulse_period_get(struct snd_kcontrol *kcontrol,
78 struct snd_ctl_elem_value *ucontrol)
80 struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
82 ucontrol->value.integer.value[0] = line6pcm->impulse_period;
86 static int snd_line6_impulse_period_put(struct snd_kcontrol *kcontrol,
87 struct snd_ctl_elem_value *ucontrol)
89 struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
90 int value = ucontrol->value.integer.value[0];
92 if (line6pcm->impulse_period == value)
95 line6pcm->impulse_period = value;
100 Unlink all currently active URBs.
102 static void line6_unlink_audio_urbs(struct snd_line6_pcm *line6pcm,
103 struct line6_pcm_stream *pcms)
107 for (i = 0; i < line6pcm->line6->iso_buffers; i++) {
108 if (test_bit(i, &pcms->active_urbs)) {
109 if (!test_and_set_bit(i, &pcms->unlink_urbs))
110 usb_unlink_urb(pcms->urbs[i]);
116 Wait until unlinking of all currently active URBs has been finished.
118 static void line6_wait_clear_audio_urbs(struct snd_line6_pcm *line6pcm,
119 struct line6_pcm_stream *pcms)
127 for (i = 0; i < line6pcm->line6->iso_buffers; i++) {
128 if (test_bit(i, &pcms->active_urbs))
133 set_current_state(TASK_UNINTERRUPTIBLE);
135 } while (--timeout > 0);
137 dev_err(line6pcm->line6->ifcdev,
138 "timeout: still %d active urbs..\n", alive);
141 static inline struct line6_pcm_stream *
142 get_stream(struct snd_line6_pcm *line6pcm, int direction)
144 return (direction == SNDRV_PCM_STREAM_PLAYBACK) ?
145 &line6pcm->out : &line6pcm->in;
148 /* allocate a buffer if not opened yet;
149 * call this in line6pcm.state_mutex
151 static int line6_buffer_acquire(struct snd_line6_pcm *line6pcm,
152 struct line6_pcm_stream *pstr, int direction, int type)
155 (direction == SNDRV_PCM_STREAM_PLAYBACK) ?
156 line6pcm->max_packet_size_out :
157 line6pcm->max_packet_size_in;
159 /* Invoked multiple times in a row so allocate once only */
160 if (!test_and_set_bit(type, &pstr->opened) && !pstr->buffer) {
162 kmalloc(array3_size(line6pcm->line6->iso_buffers,
163 LINE6_ISO_PACKETS, pkt_size),
171 /* free a buffer if all streams are closed;
172 * call this in line6pcm.state_mutex
174 static void line6_buffer_release(struct snd_line6_pcm *line6pcm,
175 struct line6_pcm_stream *pstr, int type)
177 clear_bit(type, &pstr->opened);
179 line6_wait_clear_audio_urbs(line6pcm, pstr);
185 /* start a PCM stream */
186 static int line6_stream_start(struct snd_line6_pcm *line6pcm, int direction,
190 struct line6_pcm_stream *pstr = get_stream(line6pcm, direction);
193 spin_lock_irqsave(&pstr->lock, flags);
194 if (!test_and_set_bit(type, &pstr->running) &&
195 !(pstr->active_urbs || pstr->unlink_urbs)) {
197 /* Submit all currently available URBs */
198 if (direction == SNDRV_PCM_STREAM_PLAYBACK)
199 ret = line6_submit_audio_out_all_urbs(line6pcm);
201 ret = line6_submit_audio_in_all_urbs(line6pcm);
205 clear_bit(type, &pstr->running);
206 spin_unlock_irqrestore(&pstr->lock, flags);
210 /* stop a PCM stream; this doesn't sync with the unlinked URBs */
211 static void line6_stream_stop(struct snd_line6_pcm *line6pcm, int direction,
215 struct line6_pcm_stream *pstr = get_stream(line6pcm, direction);
217 spin_lock_irqsave(&pstr->lock, flags);
218 clear_bit(type, &pstr->running);
219 if (!pstr->running) {
220 spin_unlock_irqrestore(&pstr->lock, flags);
221 line6_unlink_audio_urbs(line6pcm, pstr);
222 spin_lock_irqsave(&pstr->lock, flags);
223 if (direction == SNDRV_PCM_STREAM_CAPTURE) {
224 line6pcm->prev_fbuf = NULL;
225 line6pcm->prev_fsize = 0;
228 spin_unlock_irqrestore(&pstr->lock, flags);
231 /* common PCM trigger callback */
232 int snd_line6_trigger(struct snd_pcm_substream *substream, int cmd)
234 struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
235 struct snd_pcm_substream *s;
238 clear_bit(LINE6_FLAG_PREPARED, &line6pcm->flags);
240 snd_pcm_group_for_each_entry(s, substream) {
241 if (s->pcm->card != substream->pcm->card)
245 case SNDRV_PCM_TRIGGER_START:
246 case SNDRV_PCM_TRIGGER_RESUME:
247 if (s->stream == SNDRV_PCM_STREAM_CAPTURE &&
248 (line6pcm->line6->properties->capabilities &
249 LINE6_CAP_IN_NEEDS_OUT)) {
250 err = line6_stream_start(line6pcm, SNDRV_PCM_STREAM_PLAYBACK,
251 LINE6_STREAM_CAPTURE_HELPER);
255 err = line6_stream_start(line6pcm, s->stream,
261 case SNDRV_PCM_TRIGGER_STOP:
262 case SNDRV_PCM_TRIGGER_SUSPEND:
263 if (s->stream == SNDRV_PCM_STREAM_CAPTURE &&
264 (line6pcm->line6->properties->capabilities &
265 LINE6_CAP_IN_NEEDS_OUT)) {
266 line6_stream_stop(line6pcm, SNDRV_PCM_STREAM_PLAYBACK,
267 LINE6_STREAM_CAPTURE_HELPER);
269 line6_stream_stop(line6pcm, s->stream,
273 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
274 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
276 set_bit(LINE6_FLAG_PAUSE_PLAYBACK, &line6pcm->flags);
279 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
280 if (s->stream != SNDRV_PCM_STREAM_PLAYBACK)
282 clear_bit(LINE6_FLAG_PAUSE_PLAYBACK, &line6pcm->flags);
293 /* common PCM pointer callback */
294 snd_pcm_uframes_t snd_line6_pointer(struct snd_pcm_substream *substream)
296 struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
297 struct line6_pcm_stream *pstr = get_stream(line6pcm, substream->stream);
299 return pstr->pos_done;
302 /* Acquire and optionally start duplex streams:
303 * type is either LINE6_STREAM_IMPULSE or LINE6_STREAM_MONITOR
305 int line6_pcm_acquire(struct snd_line6_pcm *line6pcm, int type, bool start)
307 struct line6_pcm_stream *pstr;
310 /* TODO: We should assert SNDRV_PCM_STREAM_PLAYBACK/CAPTURE == 0/1 */
311 mutex_lock(&line6pcm->state_mutex);
312 for (dir = 0; dir < 2; dir++) {
313 pstr = get_stream(line6pcm, dir);
314 ret = line6_buffer_acquire(line6pcm, pstr, dir, type);
318 line6_wait_clear_audio_urbs(line6pcm, pstr);
321 for (dir = 0; dir < 2; dir++) {
322 ret = line6_stream_start(line6pcm, dir, type);
328 mutex_unlock(&line6pcm->state_mutex);
330 line6_pcm_release(line6pcm, type);
333 EXPORT_SYMBOL_GPL(line6_pcm_acquire);
335 /* Stop and release duplex streams */
336 void line6_pcm_release(struct snd_line6_pcm *line6pcm, int type)
338 struct line6_pcm_stream *pstr;
341 mutex_lock(&line6pcm->state_mutex);
342 for (dir = 0; dir < 2; dir++)
343 line6_stream_stop(line6pcm, dir, type);
344 for (dir = 0; dir < 2; dir++) {
345 pstr = get_stream(line6pcm, dir);
346 line6_buffer_release(line6pcm, pstr, type);
348 mutex_unlock(&line6pcm->state_mutex);
350 EXPORT_SYMBOL_GPL(line6_pcm_release);
352 /* common PCM hw_params callback */
353 int snd_line6_hw_params(struct snd_pcm_substream *substream,
354 struct snd_pcm_hw_params *hw_params)
357 struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
358 struct line6_pcm_stream *pstr = get_stream(line6pcm, substream->stream);
360 mutex_lock(&line6pcm->state_mutex);
361 ret = line6_buffer_acquire(line6pcm, pstr, substream->stream,
366 ret = snd_pcm_lib_malloc_pages(substream,
367 params_buffer_bytes(hw_params));
369 line6_buffer_release(line6pcm, pstr, LINE6_STREAM_PCM);
373 pstr->period = params_period_bytes(hw_params);
375 mutex_unlock(&line6pcm->state_mutex);
379 /* common PCM hw_free callback */
380 int snd_line6_hw_free(struct snd_pcm_substream *substream)
382 struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
383 struct line6_pcm_stream *pstr = get_stream(line6pcm, substream->stream);
385 mutex_lock(&line6pcm->state_mutex);
386 line6_buffer_release(line6pcm, pstr, LINE6_STREAM_PCM);
387 mutex_unlock(&line6pcm->state_mutex);
388 return snd_pcm_lib_free_pages(substream);
392 /* control info callback */
393 static int snd_line6_control_playback_info(struct snd_kcontrol *kcontrol,
394 struct snd_ctl_elem_info *uinfo)
396 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
398 uinfo->value.integer.min = 0;
399 uinfo->value.integer.max = 256;
403 /* control get callback */
404 static int snd_line6_control_playback_get(struct snd_kcontrol *kcontrol,
405 struct snd_ctl_elem_value *ucontrol)
408 struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
410 for (i = 0; i < 2; i++)
411 ucontrol->value.integer.value[i] = line6pcm->volume_playback[i];
416 /* control put callback */
417 static int snd_line6_control_playback_put(struct snd_kcontrol *kcontrol,
418 struct snd_ctl_elem_value *ucontrol)
421 struct snd_line6_pcm *line6pcm = snd_kcontrol_chip(kcontrol);
423 for (i = 0; i < 2; i++)
424 if (line6pcm->volume_playback[i] !=
425 ucontrol->value.integer.value[i]) {
426 line6pcm->volume_playback[i] =
427 ucontrol->value.integer.value[i];
434 /* control definition */
435 static const struct snd_kcontrol_new line6_controls[] = {
437 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
438 .name = "PCM Playback Volume",
439 .info = snd_line6_control_playback_info,
440 .get = snd_line6_control_playback_get,
441 .put = snd_line6_control_playback_put
444 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
445 .name = "Impulse Response Volume",
446 .info = snd_line6_impulse_volume_info,
447 .get = snd_line6_impulse_volume_get,
448 .put = snd_line6_impulse_volume_put
451 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
452 .name = "Impulse Response Period",
453 .info = snd_line6_impulse_period_info,
454 .get = snd_line6_impulse_period_get,
455 .put = snd_line6_impulse_period_put
460 Cleanup the PCM device.
462 static void cleanup_urbs(struct line6_pcm_stream *pcms, int iso_buffers)
466 /* Most likely impossible in current code... */
467 if (pcms->urbs == NULL)
470 for (i = 0; i < iso_buffers; i++) {
472 usb_kill_urb(pcms->urbs[i]);
473 usb_free_urb(pcms->urbs[i]);
480 static void line6_cleanup_pcm(struct snd_pcm *pcm)
482 struct snd_line6_pcm *line6pcm = snd_pcm_chip(pcm);
484 cleanup_urbs(&line6pcm->out, line6pcm->line6->iso_buffers);
485 cleanup_urbs(&line6pcm->in, line6pcm->line6->iso_buffers);
489 /* create a PCM device */
490 static int snd_line6_new_pcm(struct usb_line6 *line6, struct snd_pcm **pcm_ret)
495 err = snd_pcm_new(line6->card, (char *)line6->properties->name,
500 strcpy(pcm->name, line6->properties->name);
503 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_PLAYBACK,
504 &snd_line6_playback_ops);
505 snd_pcm_set_ops(pcm, SNDRV_PCM_STREAM_CAPTURE, &snd_line6_capture_ops);
507 /* pre-allocation of buffers */
508 snd_pcm_lib_preallocate_pages_for_all(pcm, SNDRV_DMA_TYPE_CONTINUOUS,
509 snd_dma_continuous_data
510 (GFP_KERNEL), 64 * 1024,
516 Sync with PCM stream stops.
518 void line6_pcm_disconnect(struct snd_line6_pcm *line6pcm)
520 line6_unlink_audio_urbs(line6pcm, &line6pcm->out);
521 line6_unlink_audio_urbs(line6pcm, &line6pcm->in);
522 line6_wait_clear_audio_urbs(line6pcm, &line6pcm->out);
523 line6_wait_clear_audio_urbs(line6pcm, &line6pcm->in);
527 Create and register the PCM device and mixer entries.
528 Create URBs for playback and capture.
530 int line6_init_pcm(struct usb_line6 *line6,
531 struct line6_pcm_properties *properties)
534 unsigned ep_read = line6->properties->ep_audio_r;
535 unsigned ep_write = line6->properties->ep_audio_w;
537 struct snd_line6_pcm *line6pcm;
539 if (!(line6->properties->capabilities & LINE6_CAP_PCM))
540 return 0; /* skip PCM initialization and report success */
542 err = snd_line6_new_pcm(line6, &pcm);
546 line6pcm = kzalloc(sizeof(*line6pcm), GFP_KERNEL);
550 mutex_init(&line6pcm->state_mutex);
552 line6pcm->properties = properties;
553 line6pcm->volume_playback[0] = line6pcm->volume_playback[1] = 255;
554 line6pcm->volume_monitor = 255;
555 line6pcm->line6 = line6;
557 spin_lock_init(&line6pcm->out.lock);
558 spin_lock_init(&line6pcm->in.lock);
559 line6pcm->impulse_period = LINE6_IMPULSE_DEFAULT_PERIOD;
561 line6->line6pcm = line6pcm;
563 pcm->private_data = line6pcm;
564 pcm->private_free = line6_cleanup_pcm;
566 line6pcm->max_packet_size_in =
567 usb_maxpacket(line6->usbdev,
568 usb_rcvisocpipe(line6->usbdev, ep_read), 0);
569 line6pcm->max_packet_size_out =
570 usb_maxpacket(line6->usbdev,
571 usb_sndisocpipe(line6->usbdev, ep_write), 1);
572 if (!line6pcm->max_packet_size_in || !line6pcm->max_packet_size_out) {
573 dev_err(line6pcm->line6->ifcdev,
574 "cannot get proper max packet size\n");
578 err = line6_create_audio_out_urbs(line6pcm);
582 err = line6_create_audio_in_urbs(line6pcm);
587 for (i = 0; i < ARRAY_SIZE(line6_controls); i++) {
588 err = snd_ctl_add(line6->card,
589 snd_ctl_new1(&line6_controls[i], line6pcm));
596 EXPORT_SYMBOL_GPL(line6_init_pcm);
598 /* prepare pcm callback */
599 int snd_line6_prepare(struct snd_pcm_substream *substream)
601 struct snd_line6_pcm *line6pcm = snd_pcm_substream_chip(substream);
602 struct line6_pcm_stream *pstr = get_stream(line6pcm, substream->stream);
604 mutex_lock(&line6pcm->state_mutex);
606 line6_wait_clear_audio_urbs(line6pcm, pstr);
608 if (!test_and_set_bit(LINE6_FLAG_PREPARED, &line6pcm->flags)) {
609 line6pcm->out.count = 0;
610 line6pcm->out.pos = 0;
611 line6pcm->out.pos_done = 0;
612 line6pcm->out.bytes = 0;
613 line6pcm->in.count = 0;
614 line6pcm->in.pos_done = 0;
615 line6pcm->in.bytes = 0;
618 mutex_unlock(&line6pcm->state_mutex);