1 // SPDX-License-Identifier: GPL-2.0-only
3 * Line 6 Linux USB driver
5 * Copyright (C) 2004-2010 Markus Grabner (grabner@icg.tugraz.at)
8 #include <linux/slab.h>
9 #include <linux/export.h>
10 #include <sound/core.h>
11 #include <sound/control.h>
12 #include <sound/pcm.h>
13 #include <sound/pcm_params.h>
19 /* impulse response volume controls */
20 static int snd_line6_impulse_volume_info(struct snd_kcontrol
*kcontrol
,
21 struct snd_ctl_elem_info
*uinfo
)
23 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
25 uinfo
->value
.integer
.min
= 0;
26 uinfo
->value
.integer
.max
= 255;
30 static int snd_line6_impulse_volume_get(struct snd_kcontrol
*kcontrol
,
31 struct snd_ctl_elem_value
*ucontrol
)
33 struct snd_line6_pcm
*line6pcm
= snd_kcontrol_chip(kcontrol
);
35 ucontrol
->value
.integer
.value
[0] = line6pcm
->impulse_volume
;
39 static int snd_line6_impulse_volume_put(struct snd_kcontrol
*kcontrol
,
40 struct snd_ctl_elem_value
*ucontrol
)
42 struct snd_line6_pcm
*line6pcm
= snd_kcontrol_chip(kcontrol
);
43 int value
= ucontrol
->value
.integer
.value
[0];
46 if (line6pcm
->impulse_volume
== value
)
49 line6pcm
->impulse_volume
= value
;
51 err
= line6_pcm_acquire(line6pcm
, LINE6_STREAM_IMPULSE
, true);
53 line6pcm
->impulse_volume
= 0;
57 line6_pcm_release(line6pcm
, LINE6_STREAM_IMPULSE
);
62 /* impulse response period controls */
63 static int snd_line6_impulse_period_info(struct snd_kcontrol
*kcontrol
,
64 struct snd_ctl_elem_info
*uinfo
)
66 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
68 uinfo
->value
.integer
.min
= 0;
69 uinfo
->value
.integer
.max
= 2000;
73 static int snd_line6_impulse_period_get(struct snd_kcontrol
*kcontrol
,
74 struct snd_ctl_elem_value
*ucontrol
)
76 struct snd_line6_pcm
*line6pcm
= snd_kcontrol_chip(kcontrol
);
78 ucontrol
->value
.integer
.value
[0] = line6pcm
->impulse_period
;
82 static int snd_line6_impulse_period_put(struct snd_kcontrol
*kcontrol
,
83 struct snd_ctl_elem_value
*ucontrol
)
85 struct snd_line6_pcm
*line6pcm
= snd_kcontrol_chip(kcontrol
);
86 int value
= ucontrol
->value
.integer
.value
[0];
88 if (line6pcm
->impulse_period
== value
)
91 line6pcm
->impulse_period
= value
;
96 Unlink all currently active URBs.
98 static void line6_unlink_audio_urbs(struct snd_line6_pcm
*line6pcm
,
99 struct line6_pcm_stream
*pcms
)
103 for (i
= 0; i
< line6pcm
->line6
->iso_buffers
; i
++) {
104 if (test_bit(i
, &pcms
->active_urbs
)) {
105 if (!test_and_set_bit(i
, &pcms
->unlink_urbs
))
106 usb_unlink_urb(pcms
->urbs
[i
]);
112 Wait until unlinking of all currently active URBs has been finished.
114 static void line6_wait_clear_audio_urbs(struct snd_line6_pcm
*line6pcm
,
115 struct line6_pcm_stream
*pcms
)
123 for (i
= 0; i
< line6pcm
->line6
->iso_buffers
; i
++) {
124 if (test_bit(i
, &pcms
->active_urbs
))
129 set_current_state(TASK_UNINTERRUPTIBLE
);
131 } while (--timeout
> 0);
133 dev_err(line6pcm
->line6
->ifcdev
,
134 "timeout: still %d active urbs..\n", alive
);
137 static inline struct line6_pcm_stream
*
138 get_stream(struct snd_line6_pcm
*line6pcm
, int direction
)
140 return (direction
== SNDRV_PCM_STREAM_PLAYBACK
) ?
141 &line6pcm
->out
: &line6pcm
->in
;
144 /* allocate a buffer if not opened yet;
145 * call this in line6pcm.state_mutex
147 static int line6_buffer_acquire(struct snd_line6_pcm
*line6pcm
,
148 struct line6_pcm_stream
*pstr
, int direction
, int type
)
151 (direction
== SNDRV_PCM_STREAM_PLAYBACK
) ?
152 line6pcm
->max_packet_size_out
:
153 line6pcm
->max_packet_size_in
;
155 /* Invoked multiple times in a row so allocate once only */
156 if (!test_and_set_bit(type
, &pstr
->opened
) && !pstr
->buffer
) {
158 kmalloc(array3_size(line6pcm
->line6
->iso_buffers
,
159 LINE6_ISO_PACKETS
, pkt_size
),
167 /* free a buffer if all streams are closed;
168 * call this in line6pcm.state_mutex
170 static void line6_buffer_release(struct snd_line6_pcm
*line6pcm
,
171 struct line6_pcm_stream
*pstr
, int type
)
173 clear_bit(type
, &pstr
->opened
);
175 line6_wait_clear_audio_urbs(line6pcm
, pstr
);
181 /* start a PCM stream */
182 static int line6_stream_start(struct snd_line6_pcm
*line6pcm
, int direction
,
186 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, direction
);
189 spin_lock_irqsave(&pstr
->lock
, flags
);
190 if (!test_and_set_bit(type
, &pstr
->running
) &&
191 !(pstr
->active_urbs
|| pstr
->unlink_urbs
)) {
193 /* Submit all currently available URBs */
194 if (direction
== SNDRV_PCM_STREAM_PLAYBACK
)
195 ret
= line6_submit_audio_out_all_urbs(line6pcm
);
197 ret
= line6_submit_audio_in_all_urbs(line6pcm
);
201 clear_bit(type
, &pstr
->running
);
202 spin_unlock_irqrestore(&pstr
->lock
, flags
);
206 /* stop a PCM stream; this doesn't sync with the unlinked URBs */
207 static void line6_stream_stop(struct snd_line6_pcm
*line6pcm
, int direction
,
211 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, direction
);
213 spin_lock_irqsave(&pstr
->lock
, flags
);
214 clear_bit(type
, &pstr
->running
);
215 if (!pstr
->running
) {
216 spin_unlock_irqrestore(&pstr
->lock
, flags
);
217 line6_unlink_audio_urbs(line6pcm
, pstr
);
218 spin_lock_irqsave(&pstr
->lock
, flags
);
219 if (direction
== SNDRV_PCM_STREAM_CAPTURE
) {
220 line6pcm
->prev_fbuf
= NULL
;
221 line6pcm
->prev_fsize
= 0;
224 spin_unlock_irqrestore(&pstr
->lock
, flags
);
227 /* common PCM trigger callback */
228 int snd_line6_trigger(struct snd_pcm_substream
*substream
, int cmd
)
230 struct snd_line6_pcm
*line6pcm
= snd_pcm_substream_chip(substream
);
231 struct snd_pcm_substream
*s
;
234 clear_bit(LINE6_FLAG_PREPARED
, &line6pcm
->flags
);
236 snd_pcm_group_for_each_entry(s
, substream
) {
237 if (s
->pcm
->card
!= substream
->pcm
->card
)
241 case SNDRV_PCM_TRIGGER_START
:
242 case SNDRV_PCM_TRIGGER_RESUME
:
243 if (s
->stream
== SNDRV_PCM_STREAM_CAPTURE
&&
244 (line6pcm
->line6
->properties
->capabilities
&
245 LINE6_CAP_IN_NEEDS_OUT
)) {
246 err
= line6_stream_start(line6pcm
, SNDRV_PCM_STREAM_PLAYBACK
,
247 LINE6_STREAM_CAPTURE_HELPER
);
251 err
= line6_stream_start(line6pcm
, s
->stream
,
257 case SNDRV_PCM_TRIGGER_STOP
:
258 case SNDRV_PCM_TRIGGER_SUSPEND
:
259 if (s
->stream
== SNDRV_PCM_STREAM_CAPTURE
&&
260 (line6pcm
->line6
->properties
->capabilities
&
261 LINE6_CAP_IN_NEEDS_OUT
)) {
262 line6_stream_stop(line6pcm
, SNDRV_PCM_STREAM_PLAYBACK
,
263 LINE6_STREAM_CAPTURE_HELPER
);
265 line6_stream_stop(line6pcm
, s
->stream
,
269 case SNDRV_PCM_TRIGGER_PAUSE_PUSH
:
270 if (s
->stream
!= SNDRV_PCM_STREAM_PLAYBACK
)
272 set_bit(LINE6_FLAG_PAUSE_PLAYBACK
, &line6pcm
->flags
);
275 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE
:
276 if (s
->stream
!= SNDRV_PCM_STREAM_PLAYBACK
)
278 clear_bit(LINE6_FLAG_PAUSE_PLAYBACK
, &line6pcm
->flags
);
289 /* common PCM pointer callback */
290 snd_pcm_uframes_t
snd_line6_pointer(struct snd_pcm_substream
*substream
)
292 struct snd_line6_pcm
*line6pcm
= snd_pcm_substream_chip(substream
);
293 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, substream
->stream
);
295 return pstr
->pos_done
;
298 /* Acquire and optionally start duplex streams:
299 * type is either LINE6_STREAM_IMPULSE or LINE6_STREAM_MONITOR
301 int line6_pcm_acquire(struct snd_line6_pcm
*line6pcm
, int type
, bool start
)
303 struct line6_pcm_stream
*pstr
;
306 /* TODO: We should assert SNDRV_PCM_STREAM_PLAYBACK/CAPTURE == 0/1 */
307 mutex_lock(&line6pcm
->state_mutex
);
308 for (dir
= 0; dir
< 2; dir
++) {
309 pstr
= get_stream(line6pcm
, dir
);
310 ret
= line6_buffer_acquire(line6pcm
, pstr
, dir
, type
);
314 line6_wait_clear_audio_urbs(line6pcm
, pstr
);
317 for (dir
= 0; dir
< 2; dir
++) {
318 ret
= line6_stream_start(line6pcm
, dir
, type
);
324 mutex_unlock(&line6pcm
->state_mutex
);
326 line6_pcm_release(line6pcm
, type
);
329 EXPORT_SYMBOL_GPL(line6_pcm_acquire
);
331 /* Stop and release duplex streams */
332 void line6_pcm_release(struct snd_line6_pcm
*line6pcm
, int type
)
334 struct line6_pcm_stream
*pstr
;
337 mutex_lock(&line6pcm
->state_mutex
);
338 for (dir
= 0; dir
< 2; dir
++)
339 line6_stream_stop(line6pcm
, dir
, type
);
340 for (dir
= 0; dir
< 2; dir
++) {
341 pstr
= get_stream(line6pcm
, dir
);
342 line6_buffer_release(line6pcm
, pstr
, type
);
344 mutex_unlock(&line6pcm
->state_mutex
);
346 EXPORT_SYMBOL_GPL(line6_pcm_release
);
348 /* common PCM hw_params callback */
349 int snd_line6_hw_params(struct snd_pcm_substream
*substream
,
350 struct snd_pcm_hw_params
*hw_params
)
353 struct snd_line6_pcm
*line6pcm
= snd_pcm_substream_chip(substream
);
354 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, substream
->stream
);
356 mutex_lock(&line6pcm
->state_mutex
);
357 ret
= line6_buffer_acquire(line6pcm
, pstr
, substream
->stream
,
362 pstr
->period
= params_period_bytes(hw_params
);
364 mutex_unlock(&line6pcm
->state_mutex
);
368 /* common PCM hw_free callback */
369 int snd_line6_hw_free(struct snd_pcm_substream
*substream
)
371 struct snd_line6_pcm
*line6pcm
= snd_pcm_substream_chip(substream
);
372 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, substream
->stream
);
374 mutex_lock(&line6pcm
->state_mutex
);
375 line6_buffer_release(line6pcm
, pstr
, LINE6_STREAM_PCM
);
376 mutex_unlock(&line6pcm
->state_mutex
);
381 /* control info callback */
382 static int snd_line6_control_playback_info(struct snd_kcontrol
*kcontrol
,
383 struct snd_ctl_elem_info
*uinfo
)
385 uinfo
->type
= SNDRV_CTL_ELEM_TYPE_INTEGER
;
387 uinfo
->value
.integer
.min
= 0;
388 uinfo
->value
.integer
.max
= 256;
392 /* control get callback */
393 static int snd_line6_control_playback_get(struct snd_kcontrol
*kcontrol
,
394 struct snd_ctl_elem_value
*ucontrol
)
397 struct snd_line6_pcm
*line6pcm
= snd_kcontrol_chip(kcontrol
);
399 for (i
= 0; i
< 2; i
++)
400 ucontrol
->value
.integer
.value
[i
] = line6pcm
->volume_playback
[i
];
405 /* control put callback */
406 static int snd_line6_control_playback_put(struct snd_kcontrol
*kcontrol
,
407 struct snd_ctl_elem_value
*ucontrol
)
410 struct snd_line6_pcm
*line6pcm
= snd_kcontrol_chip(kcontrol
);
412 for (i
= 0; i
< 2; i
++)
413 if (line6pcm
->volume_playback
[i
] !=
414 ucontrol
->value
.integer
.value
[i
]) {
415 line6pcm
->volume_playback
[i
] =
416 ucontrol
->value
.integer
.value
[i
];
423 /* control definition */
424 static const struct snd_kcontrol_new line6_controls
[] = {
426 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
427 .name
= "PCM Playback Volume",
428 .info
= snd_line6_control_playback_info
,
429 .get
= snd_line6_control_playback_get
,
430 .put
= snd_line6_control_playback_put
433 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
434 .name
= "Impulse Response Volume",
435 .info
= snd_line6_impulse_volume_info
,
436 .get
= snd_line6_impulse_volume_get
,
437 .put
= snd_line6_impulse_volume_put
440 .iface
= SNDRV_CTL_ELEM_IFACE_MIXER
,
441 .name
= "Impulse Response Period",
442 .info
= snd_line6_impulse_period_info
,
443 .get
= snd_line6_impulse_period_get
,
444 .put
= snd_line6_impulse_period_put
449 Cleanup the PCM device.
451 static void cleanup_urbs(struct line6_pcm_stream
*pcms
, int iso_buffers
)
455 /* Most likely impossible in current code... */
456 if (pcms
->urbs
== NULL
)
459 for (i
= 0; i
< iso_buffers
; i
++) {
461 usb_kill_urb(pcms
->urbs
[i
]);
462 usb_free_urb(pcms
->urbs
[i
]);
469 static void line6_cleanup_pcm(struct snd_pcm
*pcm
)
471 struct snd_line6_pcm
*line6pcm
= snd_pcm_chip(pcm
);
473 cleanup_urbs(&line6pcm
->out
, line6pcm
->line6
->iso_buffers
);
474 cleanup_urbs(&line6pcm
->in
, line6pcm
->line6
->iso_buffers
);
478 /* create a PCM device */
479 static int snd_line6_new_pcm(struct usb_line6
*line6
, struct snd_pcm
**pcm_ret
)
484 err
= snd_pcm_new(line6
->card
, (char *)line6
->properties
->name
,
489 strcpy(pcm
->name
, line6
->properties
->name
);
492 snd_pcm_set_ops(pcm
, SNDRV_PCM_STREAM_PLAYBACK
,
493 &snd_line6_playback_ops
);
494 snd_pcm_set_ops(pcm
, SNDRV_PCM_STREAM_CAPTURE
, &snd_line6_capture_ops
);
496 /* pre-allocation of buffers */
497 snd_pcm_set_managed_buffer_all(pcm
, SNDRV_DMA_TYPE_CONTINUOUS
,
498 NULL
, 64 * 1024, 128 * 1024);
503 Sync with PCM stream stops.
505 void line6_pcm_disconnect(struct snd_line6_pcm
*line6pcm
)
507 line6_unlink_audio_urbs(line6pcm
, &line6pcm
->out
);
508 line6_unlink_audio_urbs(line6pcm
, &line6pcm
->in
);
509 line6_wait_clear_audio_urbs(line6pcm
, &line6pcm
->out
);
510 line6_wait_clear_audio_urbs(line6pcm
, &line6pcm
->in
);
514 Create and register the PCM device and mixer entries.
515 Create URBs for playback and capture.
517 int line6_init_pcm(struct usb_line6
*line6
,
518 struct line6_pcm_properties
*properties
)
521 unsigned ep_read
= line6
->properties
->ep_audio_r
;
522 unsigned ep_write
= line6
->properties
->ep_audio_w
;
524 struct snd_line6_pcm
*line6pcm
;
526 if (!(line6
->properties
->capabilities
& LINE6_CAP_PCM
))
527 return 0; /* skip PCM initialization and report success */
529 err
= snd_line6_new_pcm(line6
, &pcm
);
533 line6pcm
= kzalloc(sizeof(*line6pcm
), GFP_KERNEL
);
537 mutex_init(&line6pcm
->state_mutex
);
539 line6pcm
->properties
= properties
;
540 line6pcm
->volume_playback
[0] = line6pcm
->volume_playback
[1] = 255;
541 line6pcm
->volume_monitor
= 255;
542 line6pcm
->line6
= line6
;
544 spin_lock_init(&line6pcm
->out
.lock
);
545 spin_lock_init(&line6pcm
->in
.lock
);
546 line6pcm
->impulse_period
= LINE6_IMPULSE_DEFAULT_PERIOD
;
548 line6
->line6pcm
= line6pcm
;
550 pcm
->private_data
= line6pcm
;
551 pcm
->private_free
= line6_cleanup_pcm
;
553 line6pcm
->max_packet_size_in
=
554 usb_maxpacket(line6
->usbdev
,
555 usb_rcvisocpipe(line6
->usbdev
, ep_read
), 0);
556 line6pcm
->max_packet_size_out
=
557 usb_maxpacket(line6
->usbdev
,
558 usb_sndisocpipe(line6
->usbdev
, ep_write
), 1);
559 if (!line6pcm
->max_packet_size_in
|| !line6pcm
->max_packet_size_out
) {
560 dev_err(line6pcm
->line6
->ifcdev
,
561 "cannot get proper max packet size\n");
565 err
= line6_create_audio_out_urbs(line6pcm
);
569 err
= line6_create_audio_in_urbs(line6pcm
);
574 for (i
= 0; i
< ARRAY_SIZE(line6_controls
); i
++) {
575 err
= snd_ctl_add(line6
->card
,
576 snd_ctl_new1(&line6_controls
[i
], line6pcm
));
583 EXPORT_SYMBOL_GPL(line6_init_pcm
);
585 /* prepare pcm callback */
586 int snd_line6_prepare(struct snd_pcm_substream
*substream
)
588 struct snd_line6_pcm
*line6pcm
= snd_pcm_substream_chip(substream
);
589 struct line6_pcm_stream
*pstr
= get_stream(line6pcm
, substream
->stream
);
591 mutex_lock(&line6pcm
->state_mutex
);
593 line6_wait_clear_audio_urbs(line6pcm
, pstr
);
595 if (!test_and_set_bit(LINE6_FLAG_PREPARED
, &line6pcm
->flags
)) {
596 line6pcm
->out
.count
= 0;
597 line6pcm
->out
.pos
= 0;
598 line6pcm
->out
.pos_done
= 0;
599 line6pcm
->out
.bytes
= 0;
600 line6pcm
->in
.count
= 0;
601 line6pcm
->in
.pos_done
= 0;
602 line6pcm
->in
.bytes
= 0;
605 mutex_unlock(&line6pcm
->state_mutex
);