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
) {
161 pstr
->buffer
= kmalloc(line6pcm
->line6
->iso_buffers
*
162 LINE6_ISO_PACKETS
* pkt_size
, GFP_KERNEL
);
169 /* free a buffer if all streams are closed;
170 * call this in line6pcm.state_mutex
172 static void line6_buffer_release(struct snd_line6_pcm
*line6pcm
,
173 struct line6_pcm_stream
*pstr
, int type
)
175 clear_bit(type
, &pstr
->opened
);
177 line6_wait_clear_audio_urbs(line6pcm
, pstr
);
183 /* start a PCM stream */
184 static int line6_stream_start(struct snd_line6_pcm
*line6pcm
, int direction
,
188 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, direction
);
191 spin_lock_irqsave(&pstr
->lock
, flags
);
192 if (!test_and_set_bit(type
, &pstr
->running
) &&
193 !(pstr
->active_urbs
|| pstr
->unlink_urbs
)) {
195 /* Submit all currently available URBs */
196 if (direction
== SNDRV_PCM_STREAM_PLAYBACK
)
197 ret
= line6_submit_audio_out_all_urbs(line6pcm
);
199 ret
= line6_submit_audio_in_all_urbs(line6pcm
);
203 clear_bit(type
, &pstr
->running
);
204 spin_unlock_irqrestore(&pstr
->lock
, flags
);
208 /* stop a PCM stream; this doesn't sync with the unlinked URBs */
209 static void line6_stream_stop(struct snd_line6_pcm
*line6pcm
, int direction
,
213 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, direction
);
215 spin_lock_irqsave(&pstr
->lock
, flags
);
216 clear_bit(type
, &pstr
->running
);
217 if (!pstr
->running
) {
218 spin_unlock_irqrestore(&pstr
->lock
, flags
);
219 line6_unlink_audio_urbs(line6pcm
, pstr
);
220 spin_lock_irqsave(&pstr
->lock
, flags
);
221 if (direction
== SNDRV_PCM_STREAM_CAPTURE
) {
222 line6pcm
->prev_fbuf
= NULL
;
223 line6pcm
->prev_fsize
= 0;
226 spin_unlock_irqrestore(&pstr
->lock
, flags
);
229 /* common PCM trigger callback */
230 int snd_line6_trigger(struct snd_pcm_substream
*substream
, int cmd
)
232 struct snd_line6_pcm
*line6pcm
= snd_pcm_substream_chip(substream
);
233 struct snd_pcm_substream
*s
;
236 clear_bit(LINE6_FLAG_PREPARED
, &line6pcm
->flags
);
238 snd_pcm_group_for_each_entry(s
, substream
) {
239 if (s
->pcm
->card
!= substream
->pcm
->card
)
243 case SNDRV_PCM_TRIGGER_START
:
244 case SNDRV_PCM_TRIGGER_RESUME
:
245 if (s
->stream
== SNDRV_PCM_STREAM_CAPTURE
&&
246 (line6pcm
->line6
->properties
->capabilities
&
247 LINE6_CAP_IN_NEEDS_OUT
)) {
248 err
= line6_stream_start(line6pcm
, SNDRV_PCM_STREAM_PLAYBACK
,
249 LINE6_STREAM_CAPTURE_HELPER
);
253 err
= line6_stream_start(line6pcm
, s
->stream
,
259 case SNDRV_PCM_TRIGGER_STOP
:
260 case SNDRV_PCM_TRIGGER_SUSPEND
:
261 if (s
->stream
== SNDRV_PCM_STREAM_CAPTURE
&&
262 (line6pcm
->line6
->properties
->capabilities
&
263 LINE6_CAP_IN_NEEDS_OUT
)) {
264 line6_stream_stop(line6pcm
, SNDRV_PCM_STREAM_PLAYBACK
,
265 LINE6_STREAM_CAPTURE_HELPER
);
267 line6_stream_stop(line6pcm
, s
->stream
,
271 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
272 if (s
->stream
!= SNDRV_PCM_STREAM_PLAYBACK
)
274 set_bit(LINE6_FLAG_PAUSE_PLAYBACK
, &line6pcm
->flags
);
277 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
278 if (s
->stream
!= SNDRV_PCM_STREAM_PLAYBACK
)
280 clear_bit(LINE6_FLAG_PAUSE_PLAYBACK
, &line6pcm
->flags
);
291 /* common PCM pointer callback */
292 snd_pcm_uframes_t
snd_line6_pointer(struct snd_pcm_substream
*substream
)
294 struct snd_line6_pcm
*line6pcm
= snd_pcm_substream_chip(substream
);
295 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, substream
->stream
);
297 return pstr
->pos_done
;
300 /* Acquire and optionally start duplex streams:
301 * type is either LINE6_STREAM_IMPULSE or LINE6_STREAM_MONITOR
303 int line6_pcm_acquire(struct snd_line6_pcm
*line6pcm
, int type
, bool start
)
305 struct line6_pcm_stream
*pstr
;
308 /* TODO: We should assert SNDRV_PCM_STREAM_PLAYBACK/CAPTURE == 0/1 */
309 mutex_lock(&line6pcm
->state_mutex
);
310 for (dir
= 0; dir
< 2; dir
++) {
311 pstr
= get_stream(line6pcm
, dir
);
312 ret
= line6_buffer_acquire(line6pcm
, pstr
, dir
, type
);
316 line6_wait_clear_audio_urbs(line6pcm
, pstr
);
319 for (dir
= 0; dir
< 2; dir
++) {
320 ret
= line6_stream_start(line6pcm
, dir
, type
);
326 mutex_unlock(&line6pcm
->state_mutex
);
328 line6_pcm_release(line6pcm
, type
);
331 EXPORT_SYMBOL_GPL(line6_pcm_acquire
);
333 /* Stop and release duplex streams */
334 void line6_pcm_release(struct snd_line6_pcm
*line6pcm
, int type
)
336 struct line6_pcm_stream
*pstr
;
339 mutex_lock(&line6pcm
->state_mutex
);
340 for (dir
= 0; dir
< 2; dir
++)
341 line6_stream_stop(line6pcm
, dir
, type
);
342 for (dir
= 0; dir
< 2; dir
++) {
343 pstr
= get_stream(line6pcm
, dir
);
344 line6_buffer_release(line6pcm
, pstr
, type
);
346 mutex_unlock(&line6pcm
->state_mutex
);
348 EXPORT_SYMBOL_GPL(line6_pcm_release
);
350 /* common PCM hw_params callback */
351 int snd_line6_hw_params(struct snd_pcm_substream
*substream
,
352 struct snd_pcm_hw_params
*hw_params
)
355 struct snd_line6_pcm
*line6pcm
= snd_pcm_substream_chip(substream
);
356 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, substream
->stream
);
358 mutex_lock(&line6pcm
->state_mutex
);
359 ret
= line6_buffer_acquire(line6pcm
, pstr
, substream
->stream
,
364 ret
= snd_pcm_lib_malloc_pages(substream
,
365 params_buffer_bytes(hw_params
));
367 line6_buffer_release(line6pcm
, pstr
, LINE6_STREAM_PCM
);
371 pstr
->period
= params_period_bytes(hw_params
);
373 mutex_unlock(&line6pcm
->state_mutex
);
377 /* common PCM hw_free callback */
378 int snd_line6_hw_free(struct snd_pcm_substream
*substream
)
380 struct snd_line6_pcm
*line6pcm
= snd_pcm_substream_chip(substream
);
381 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, substream
->stream
);
383 mutex_lock(&line6pcm
->state_mutex
);
384 line6_buffer_release(line6pcm
, pstr
, LINE6_STREAM_PCM
);
385 mutex_unlock(&line6pcm
->state_mutex
);
386 return snd_pcm_lib_free_pages(substream
);
390 /* control info callback */
391 static int snd_line6_control_playback_info(struct snd_kcontrol
*kcontrol
,
392 struct snd_ctl_elem_info
*uinfo
)
394 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
396 uinfo
->value
.integer
.min
= 0;
397 uinfo
->value
.integer
.max
= 256;
401 /* control get callback */
402 static int snd_line6_control_playback_get(struct snd_kcontrol
*kcontrol
,
403 struct snd_ctl_elem_value
*ucontrol
)
406 struct snd_line6_pcm
*line6pcm
= snd_kcontrol_chip(kcontrol
);
408 for (i
= 0; i
< 2; i
++)
409 ucontrol
->value
.integer
.value
[i
] = line6pcm
->volume_playback
[i
];
414 /* control put callback */
415 static int snd_line6_control_playback_put(struct snd_kcontrol
*kcontrol
,
416 struct snd_ctl_elem_value
*ucontrol
)
419 struct snd_line6_pcm
*line6pcm
= snd_kcontrol_chip(kcontrol
);
421 for (i
= 0; i
< 2; i
++)
422 if (line6pcm
->volume_playback
[i
] !=
423 ucontrol
->value
.integer
.value
[i
]) {
424 line6pcm
->volume_playback
[i
] =
425 ucontrol
->value
.integer
.value
[i
];
432 /* control definition */
433 static const struct snd_kcontrol_new line6_controls
[] = {
435 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
436 .name
= "PCM Playback Volume",
437 .info
= snd_line6_control_playback_info
,
438 .get
= snd_line6_control_playback_get
,
439 .put
= snd_line6_control_playback_put
442 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
443 .name
= "Impulse Response Volume",
444 .info
= snd_line6_impulse_volume_info
,
445 .get
= snd_line6_impulse_volume_get
,
446 .put
= snd_line6_impulse_volume_put
449 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
450 .name
= "Impulse Response Period",
451 .info
= snd_line6_impulse_period_info
,
452 .get
= snd_line6_impulse_period_get
,
453 .put
= snd_line6_impulse_period_put
458 Cleanup the PCM device.
460 static void cleanup_urbs(struct line6_pcm_stream
*pcms
, int iso_buffers
)
464 /* Most likely impossible in current code... */
465 if (pcms
->urbs
== NULL
)
468 for (i
= 0; i
< iso_buffers
; i
++) {
470 usb_kill_urb(pcms
->urbs
[i
]);
471 usb_free_urb(pcms
->urbs
[i
]);
478 static void line6_cleanup_pcm(struct snd_pcm
*pcm
)
480 struct snd_line6_pcm
*line6pcm
= snd_pcm_chip(pcm
);
482 cleanup_urbs(&line6pcm
->out
, line6pcm
->line6
->iso_buffers
);
483 cleanup_urbs(&line6pcm
->in
, line6pcm
->line6
->iso_buffers
);
487 /* create a PCM device */
488 static int snd_line6_new_pcm(struct usb_line6
*line6
, struct snd_pcm
**pcm_ret
)
493 err
= snd_pcm_new(line6
->card
, (char *)line6
->properties
->name
,
498 strcpy(pcm
->name
, line6
->properties
->name
);
501 snd_pcm_set_ops(pcm
, SNDRV_PCM_STREAM_PLAYBACK
,
502 &snd_line6_playback_ops
);
503 snd_pcm_set_ops(pcm
, SNDRV_PCM_STREAM_CAPTURE
, &snd_line6_capture_ops
);
505 /* pre-allocation of buffers */
506 snd_pcm_lib_preallocate_pages_for_all(pcm
, SNDRV_DMA_TYPE_CONTINUOUS
,
507 snd_dma_continuous_data
508 (GFP_KERNEL
), 64 * 1024,
514 Sync with PCM stream stops.
516 void line6_pcm_disconnect(struct snd_line6_pcm
*line6pcm
)
518 line6_unlink_audio_urbs(line6pcm
, &line6pcm
->out
);
519 line6_unlink_audio_urbs(line6pcm
, &line6pcm
->in
);
520 line6_wait_clear_audio_urbs(line6pcm
, &line6pcm
->out
);
521 line6_wait_clear_audio_urbs(line6pcm
, &line6pcm
->in
);
525 Create and register the PCM device and mixer entries.
526 Create URBs for playback and capture.
528 int line6_init_pcm(struct usb_line6
*line6
,
529 struct line6_pcm_properties
*properties
)
532 unsigned ep_read
= line6
->properties
->ep_audio_r
;
533 unsigned ep_write
= line6
->properties
->ep_audio_w
;
535 struct snd_line6_pcm
*line6pcm
;
537 if (!(line6
->properties
->capabilities
& LINE6_CAP_PCM
))
538 return 0; /* skip PCM initialization and report success */
540 err
= snd_line6_new_pcm(line6
, &pcm
);
544 line6pcm
= kzalloc(sizeof(*line6pcm
), GFP_KERNEL
);
548 mutex_init(&line6pcm
->state_mutex
);
550 line6pcm
->properties
= properties
;
551 line6pcm
->volume_playback
[0] = line6pcm
->volume_playback
[1] = 255;
552 line6pcm
->volume_monitor
= 255;
553 line6pcm
->line6
= line6
;
555 line6pcm
->max_packet_size_in
=
556 usb_maxpacket(line6
->usbdev
,
557 usb_rcvisocpipe(line6
->usbdev
, ep_read
), 0);
558 line6pcm
->max_packet_size_out
=
559 usb_maxpacket(line6
->usbdev
,
560 usb_sndisocpipe(line6
->usbdev
, ep_write
), 1);
562 spin_lock_init(&line6pcm
->out
.lock
);
563 spin_lock_init(&line6pcm
->in
.lock
);
564 line6pcm
->impulse_period
= LINE6_IMPULSE_DEFAULT_PERIOD
;
566 line6
->line6pcm
= line6pcm
;
568 pcm
->private_data
= line6pcm
;
569 pcm
->private_free
= line6_cleanup_pcm
;
571 err
= line6_create_audio_out_urbs(line6pcm
);
575 err
= line6_create_audio_in_urbs(line6pcm
);
580 for (i
= 0; i
< ARRAY_SIZE(line6_controls
); i
++) {
581 err
= snd_ctl_add(line6
->card
,
582 snd_ctl_new1(&line6_controls
[i
], line6pcm
));
589 EXPORT_SYMBOL_GPL(line6_init_pcm
);
591 /* prepare pcm callback */
592 int snd_line6_prepare(struct snd_pcm_substream
*substream
)
594 struct snd_line6_pcm
*line6pcm
= snd_pcm_substream_chip(substream
);
595 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, substream
->stream
);
597 mutex_lock(&line6pcm
->state_mutex
);
599 line6_wait_clear_audio_urbs(line6pcm
, pstr
);
601 if (!test_and_set_bit(LINE6_FLAG_PREPARED
, &line6pcm
->flags
)) {
602 line6pcm
->out
.count
= 0;
603 line6pcm
->out
.pos
= 0;
604 line6pcm
->out
.pos_done
= 0;
605 line6pcm
->out
.bytes
= 0;
606 line6pcm
->in
.count
= 0;
607 line6pcm
->in
.pos_done
= 0;
608 line6pcm
->in
.bytes
= 0;
611 mutex_unlock(&line6pcm
->state_mutex
);