2005-04-16 16:20:36 -06:00
|
|
|
#ifndef __USBAUDIO_H
|
|
|
|
#define __USBAUDIO_H
|
|
|
|
/*
|
|
|
|
* (Tentative) USB Audio Driver for ALSA
|
|
|
|
*
|
|
|
|
* Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
|
|
|
|
*
|
|
|
|
*
|
|
|
|
* This program is free software; you can redistribute it and/or modify
|
|
|
|
* it under the terms of the GNU General Public License as published by
|
|
|
|
* the Free Software Foundation; either version 2 of the License, or
|
|
|
|
* (at your option) any later version.
|
|
|
|
*
|
|
|
|
* This program is distributed in the hope that it will be useful,
|
|
|
|
* but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
|
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
|
* GNU General Public License for more details.
|
|
|
|
*
|
|
|
|
* You should have received a copy of the GNU General Public License
|
|
|
|
* along with this program; if not, write to the Free Software
|
|
|
|
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
|
|
*/
|
|
|
|
|
2005-05-02 00:51:26 -06:00
|
|
|
/* handling of USB vendor/product ID pairs as 32-bit numbers */
|
|
|
|
#define USB_ID(vendor, product) (((vendor) << 16) | (product))
|
|
|
|
#define USB_ID_VENDOR(id) ((id) >> 16)
|
|
|
|
#define USB_ID_PRODUCT(id) ((u16)(id))
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
/*
|
2010-03-04 11:46:13 -07:00
|
|
|
*
|
2005-04-16 16:20:36 -06:00
|
|
|
*/
|
|
|
|
|
|
|
|
struct snd_usb_audio {
|
|
|
|
int index;
|
|
|
|
struct usb_device *dev;
|
2005-11-17 07:08:02 -07:00
|
|
|
struct snd_card *card;
|
2011-03-11 06:51:12 -07:00
|
|
|
struct usb_interface *pm_intf;
|
2005-05-02 00:51:26 -06:00
|
|
|
u32 usb_id;
|
2012-04-12 05:51:10 -06:00
|
|
|
struct mutex mutex;
|
2011-03-11 06:51:12 -07:00
|
|
|
unsigned int autosuspended:1;
|
ALSA: usb-audio: Avoid nested autoresume calls
After the recent fix of runtime PM for USB-audio driver, we got a
lockdep warning like:
=============================================
[ INFO: possible recursive locking detected ]
4.2.0-rc8+ #61 Not tainted
---------------------------------------------
pulseaudio/980 is trying to acquire lock:
(&chip->shutdown_rwsem){.+.+.+}, at: [<ffffffffa0355dac>] snd_usb_autoresume+0x1d/0x52 [snd_usb_audio]
but task is already holding lock:
(&chip->shutdown_rwsem){.+.+.+}, at: [<ffffffffa0355dac>] snd_usb_autoresume+0x1d/0x52 [snd_usb_audio]
This comes from snd_usb_autoresume() invoking down_read() and it's
used in a nested way. Although it's basically safe, per se (as these
are read locks), it's better to reduce such spurious warnings.
The read lock is needed to guarantee the execution of "shutdown"
(cleanup at disconnection) task after all concurrent tasks are
finished. This can be implemented in another better way.
Also, the current check of chip->in_pm isn't good enough for
protecting the racy execution of multiple auto-resumes.
This patch rewrites the logic of snd_usb_autoresume() & co; namely,
- The recursive call of autopm is avoided by the new refcount,
chip->active. The chip->in_pm flag is removed accordingly.
- Instead of rwsem, another refcount, chip->usage_count, is introduced
for tracking the period to delay the shutdown procedure. At
the last clear of this refcount, wake_up() to the shutdown waiter is
called.
- The shutdown flag is replaced with shutdown atomic count; this is
for reducing the lock.
- Two new helpers are introduced to simplify the management of these
refcounts; snd_usb_lock_shutdown() increases the usage_count, checks
the shutdown state, and does autoresume. snd_usb_unlock_shutdown()
does the opposite. Most of mixer and other codes just need this,
and simply returns an error if it receives an error from lock.
Fixes: 9003ebb13f61 ('ALSA: usb-audio: Fix runtime PM unbalance')
Reported-and-tested-by: Alexnader Kuleshov <kuleshovmail@gmail.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-08-25 08:09:00 -06:00
|
|
|
atomic_t active;
|
|
|
|
atomic_t shutdown;
|
|
|
|
atomic_t usage_count;
|
|
|
|
wait_queue_head_t shutdown_wait;
|
2009-12-27 10:19:58 -07:00
|
|
|
unsigned int txfr_quirk:1; /* Subframe boundaries on transfers */
|
ALSA: USB-audio: Add quirk for Zoom R16/24 playback
The Zoom R16/24 have a nonstandard playback format where each isochronous
packet contains a length descriptor in the first four bytes. (Curiously,
capture data does not contain this and requires no quirk.)
The quirk involves adding the extra length descriptor whenever outgoing
isochronous packets are generated, both in pcm.c (outgoing audio) and
endpoint.c (silent data).
In order to make the quirk as unintrusive as possible, for
pcm.c:prepare_playback_urb(), the isochronous packet descriptors are
initially set up in the same way no matter if the quirk is enabled or not.
Once it is time to actually copy the data into the outgoing packet buffer
(together with the added length descriptors) the isochronous descriptors
are adjusted in order take the increased payload length into account.
For endpoint.c:prepare_silent_urb() it makes more sense to modify the
actual function, partly because the function is less complex to start with
and partly because it is not as time-critical as prepare_playback_urb()
(whose bulk is run with interrupts disabled), so the (minute) additional
time spent in the non-quirk case is motivated by the simplicity of having
a single function for all cases.
The quirk is controlled by the new tx_length_quirk member in struct
snd_usb_substream and struct snd_usb_audio, which is conveyed to pcm.c
and endpoint.c from quirks.c in a similar manner to the txfr_quirk member
in the same structs.
In contrast to txfr_quirk however, the quirk is enabled directly in
quirks.c:create_standard_audio_quirk() by checking the USB ID in that
function. Another option would be to introduce a new
QUIRK_AUDIO_ZOOM_INTERFACE or somesuch, which would have made the quirk
very plain to see in the quirk table, but it was felt that the additional
code needed to implement it this way would just make the implementation
more complex with no real gain.
Tested with a Zoom R16, both by doing capture and playback separately
using arecord and aplay (8 channel capture and 2 channel playback,
respectively), as well as capture and playback together using Ardour, as
well as Audacity and Qtractor together with jackd.
The R24 is reportedly compatible with the R16 when used as an audio
interface. Both devices share the same USB ID and have the same number of
inputs (8) and outputs (2). Therefore "R16/24" is mentioned throughout the
patch.
Regression tested using an Edirol UA-5 in both class compliant (16-bit)
and "advanced" (24 bit, forces the use of quirks) modes.
Signed-off-by: Ricard Wanderlof <ricardw@axis.com>
Tested-by: Panu Matilainen <pmatilai@laiskiainen.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-10-19 00:52:53 -06:00
|
|
|
unsigned int tx_length_quirk:1; /* Put length specifier in transfers */
|
2011-03-11 06:51:12 -07:00
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
int num_interfaces;
|
2007-12-14 06:42:41 -07:00
|
|
|
int num_suspended_intf;
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
struct list_head pcm_list; /* list of pcm streams */
|
2012-04-12 05:51:11 -06:00
|
|
|
struct list_head ep_list; /* list of audio-related endpoints */
|
2005-04-16 16:20:36 -06:00
|
|
|
int pcm_devs;
|
|
|
|
|
|
|
|
struct list_head midi_list; /* list of midi interfaces */
|
|
|
|
|
2005-04-29 08:23:13 -06:00
|
|
|
struct list_head mixer_list; /* list of mixer interfaces */
|
2010-03-04 11:46:13 -07:00
|
|
|
|
|
|
|
int setup; /* from the 'device_setup' module param */
|
2013-04-03 15:18:56 -06:00
|
|
|
bool autoclock; /* from the 'autoclock' module param */
|
2010-05-31 06:51:31 -06:00
|
|
|
|
|
|
|
struct usb_host_interface *ctrl_intf; /* the audio control interface */
|
2005-04-16 16:20:36 -06:00
|
|
|
};
|
|
|
|
|
2014-02-26 05:02:17 -07:00
|
|
|
#define usb_audio_err(chip, fmt, args...) \
|
|
|
|
dev_err(&(chip)->dev->dev, fmt, ##args)
|
|
|
|
#define usb_audio_warn(chip, fmt, args...) \
|
|
|
|
dev_warn(&(chip)->dev->dev, fmt, ##args)
|
|
|
|
#define usb_audio_info(chip, fmt, args...) \
|
|
|
|
dev_info(&(chip)->dev->dev, fmt, ##args)
|
|
|
|
#define usb_audio_dbg(chip, fmt, args...) \
|
|
|
|
dev_dbg(&(chip)->dev->dev, fmt, ##args)
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
/*
|
|
|
|
* Information about devices with broken descriptors
|
|
|
|
*/
|
|
|
|
|
|
|
|
/* special values for .ifnum */
|
|
|
|
#define QUIRK_NO_INTERFACE -2
|
|
|
|
#define QUIRK_ANY_INTERFACE -1
|
|
|
|
|
2005-07-25 08:19:10 -06:00
|
|
|
enum quirk_type {
|
|
|
|
QUIRK_IGNORE_INTERFACE,
|
|
|
|
QUIRK_COMPOSITE,
|
2013-03-31 15:43:12 -06:00
|
|
|
QUIRK_AUTODETECT,
|
2005-07-25 08:19:10 -06:00
|
|
|
QUIRK_MIDI_STANDARD_INTERFACE,
|
|
|
|
QUIRK_MIDI_FIXED_ENDPOINT,
|
|
|
|
QUIRK_MIDI_YAMAHA,
|
2013-03-31 15:43:12 -06:00
|
|
|
QUIRK_MIDI_ROLAND,
|
2005-07-25 08:19:10 -06:00
|
|
|
QUIRK_MIDI_MIDIMAN,
|
|
|
|
QUIRK_MIDI_NOVATION,
|
2010-10-22 10:20:48 -06:00
|
|
|
QUIRK_MIDI_RAW_BYTES,
|
2005-07-25 08:19:10 -06:00
|
|
|
QUIRK_MIDI_EMAGIC,
|
2006-02-07 09:11:06 -07:00
|
|
|
QUIRK_MIDI_CME,
|
2010-05-20 13:31:10 -06:00
|
|
|
QUIRK_MIDI_AKAI,
|
2008-07-30 07:13:29 -06:00
|
|
|
QUIRK_MIDI_US122L,
|
2011-08-26 05:19:49 -06:00
|
|
|
QUIRK_MIDI_FTDI,
|
2015-11-15 14:38:29 -07:00
|
|
|
QUIRK_MIDI_CH345,
|
2005-07-25 08:19:10 -06:00
|
|
|
QUIRK_AUDIO_STANDARD_INTERFACE,
|
|
|
|
QUIRK_AUDIO_FIXED_ENDPOINT,
|
2008-10-04 08:27:36 -06:00
|
|
|
QUIRK_AUDIO_EDIROL_UAXX,
|
2009-12-27 10:19:59 -07:00
|
|
|
QUIRK_AUDIO_ALIGN_TRANSFER,
|
2011-05-25 01:09:02 -06:00
|
|
|
QUIRK_AUDIO_STANDARD_MIXER,
|
2005-07-25 08:19:10 -06:00
|
|
|
|
|
|
|
QUIRK_TYPE_COUNT
|
|
|
|
};
|
2005-04-16 16:20:36 -06:00
|
|
|
|
|
|
|
struct snd_usb_audio_quirk {
|
|
|
|
const char *vendor_name;
|
|
|
|
const char *product_name;
|
|
|
|
int16_t ifnum;
|
2005-07-25 08:19:10 -06:00
|
|
|
uint16_t type;
|
2005-04-16 16:20:36 -06:00
|
|
|
const void *data;
|
|
|
|
};
|
|
|
|
|
2009-11-06 14:44:53 -07:00
|
|
|
#define combine_word(s) ((*(s)) | ((unsigned int)(s)[1] << 8))
|
2005-04-16 16:20:36 -06:00
|
|
|
#define combine_triple(s) (combine_word(s) | ((unsigned int)(s)[2] << 16))
|
|
|
|
#define combine_quad(s) (combine_triple(s) | ((unsigned int)(s)[3] << 24))
|
|
|
|
|
ALSA: usb-audio: Avoid nested autoresume calls
After the recent fix of runtime PM for USB-audio driver, we got a
lockdep warning like:
=============================================
[ INFO: possible recursive locking detected ]
4.2.0-rc8+ #61 Not tainted
---------------------------------------------
pulseaudio/980 is trying to acquire lock:
(&chip->shutdown_rwsem){.+.+.+}, at: [<ffffffffa0355dac>] snd_usb_autoresume+0x1d/0x52 [snd_usb_audio]
but task is already holding lock:
(&chip->shutdown_rwsem){.+.+.+}, at: [<ffffffffa0355dac>] snd_usb_autoresume+0x1d/0x52 [snd_usb_audio]
This comes from snd_usb_autoresume() invoking down_read() and it's
used in a nested way. Although it's basically safe, per se (as these
are read locks), it's better to reduce such spurious warnings.
The read lock is needed to guarantee the execution of "shutdown"
(cleanup at disconnection) task after all concurrent tasks are
finished. This can be implemented in another better way.
Also, the current check of chip->in_pm isn't good enough for
protecting the racy execution of multiple auto-resumes.
This patch rewrites the logic of snd_usb_autoresume() & co; namely,
- The recursive call of autopm is avoided by the new refcount,
chip->active. The chip->in_pm flag is removed accordingly.
- Instead of rwsem, another refcount, chip->usage_count, is introduced
for tracking the period to delay the shutdown procedure. At
the last clear of this refcount, wake_up() to the shutdown waiter is
called.
- The shutdown flag is replaced with shutdown atomic count; this is
for reducing the lock.
- Two new helpers are introduced to simplify the management of these
refcounts; snd_usb_lock_shutdown() increases the usage_count, checks
the shutdown state, and does autoresume. snd_usb_unlock_shutdown()
does the opposite. Most of mixer and other codes just need this,
and simply returns an error if it receives an error from lock.
Fixes: 9003ebb13f61 ('ALSA: usb-audio: Fix runtime PM unbalance')
Reported-and-tested-by: Alexnader Kuleshov <kuleshovmail@gmail.com>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
2015-08-25 08:09:00 -06:00
|
|
|
int snd_usb_lock_shutdown(struct snd_usb_audio *chip);
|
|
|
|
void snd_usb_unlock_shutdown(struct snd_usb_audio *chip);
|
|
|
|
|
2005-04-16 16:20:36 -06:00
|
|
|
#endif /* __USBAUDIO_H */
|