Add USB-audio quirk alias option
Subsystems (3)
cover Add USB-audio quirk alias option
Hi,
this is an experimental patchset to add a new option, quirk_alias, to snd-usb-audio driver. It allows to use the existing quirk for the given vendor:product id pair matching with the new device. Passing like:
quirk_alias=1234abcd:5678beef
will make the driver applying the quirk for 5678:beef against to the new device 1234:abcd.
Obviously, this is for helping to find a workaround for a new device that may need the same / similar quirk for the previous models. Then you can apply the quirk without recompiling the kernel driver with a manual patch.
Takashi
===
Takashi Iwai (3):
ALSA: usb-audio: Refer to chip->usb_id for quirks and MIDI creation
ALSA: usb-audio: Add quirk_alias option
ALSA: doc: Update option descriptions for snd-usb-audio
Documentation/sound/alsa/ALSA-Configuration.txt | 9 ++++ sound/usb/card.c | 56 +++++++++++++++++++++++-- sound/usb/midi.c | 15 ++++--- sound/usb/midi.h | 14 ++++++- sound/usb/quirks.c | 34 ++++++++------- sound/usb/quirks.h | 3 +- 6 files changed, 105 insertions(+), 26 deletions(-)
Signature · 1 line
2.7.0
RFC PATCH 1/3 ALSA: usb-audio: Refer to chip->usb_id for quirks and MIDI creation
This is a preliminary patch for the later change to allow a better quirk ID management. In the current USB-audio code, there are a few places looking at usb_device idVendor and idProduct fields directly even though we have already a static member in snd_usb_audio.usb_id. This patch modifies such codes to refer to the latter field.
For achieving this, two slightly intensive changes have been done:
- The snd_usb_audio object is set/reset via dev_getdrv() for the given USB device; it's needed for minimizing the changes for some existing quirks that take only usb_device object.
- __snd_usbmidi_create() is introduced to receive the pre-given usb_id argument. The exported snd_usbmidi_create() is unchanged by calling this new function internally.
--- sound/usb/card.c | 9 ++++++--- sound/usb/midi.c | 15 +++++++++------ sound/usb/midi.h | 14 ++++++++++++-- sound/usb/quirks.c | 34 ++++++++++++++++++++-------------- sound/usb/quirks.h | 3 ++- 5 files changed, 49 insertions(+), 26 deletions(-)
sound/usb/card.c +6 -3
@@ -171,8 +171,9 @@ static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int intif ((altsd->bInterfaceClass ==USB_CLASS_AUDIO || altsd->bInterfaceClass ==USB_CLASS_VENDOR_SPEC ) && altsd->bInterfaceSubClass ==USB_SUBCLASS_MIDISTREAMING ) { -int err =snd_usbmidi_create (chip->card, iface, - &chip->midi_list,NULL ); +int err =__snd_usbmidi_create (chip->card, iface, + &chip->midi_list,NULL , + chip->usb_id);if (err <0 ) { dev_err(&dev->dev, "%u:%d: cannot create sequencer device\n",
@@ -311,6 +312,7 @@ static int snd_usb_audio_free(struct snd_usb_audio *chip)snd_usb_endpoint_free (ep);mutex_destroy (&chip->mutex); +dev_set_drvdata (&chip->dev->dev,NULL );kfree (chip);return 0 ; }
@@ -484,7 +486,7 @@ static int usb_audio_probe(struct usb_interface *intf,if (quirk && quirk->ifnum >=0 && ifnum != quirk->ifnum)return -ENXIO ; - err =snd_usb_apply_boot_quirk (dev, intf, quirk); + err =snd_usb_apply_boot_quirk (dev, intf, quirk, id);if (err <0 )return err;
@@ -503,6 +505,7 @@ static int usb_audio_probe(struct usb_interface *intf, goto __error; } chip = usb_chip[i]; +dev_set_drvdata (&dev->dev, chip);atomic_inc (&chip->active);/* avoid autopm */ break ; }
sound/usb/midi.c +9 -6
@@ -2320,10 +2320,11 @@ EXPORT_SYMBOL(snd_usbmidi_resume);/* * Creates and registers everything needed for a MIDI streaming interface. */ -int snd_usbmidi_create (struct snd_card *card, -struct usb_interface *iface, -struct list_head *midi_list, -const struct snd_usb_audio_quirk *quirk) +int __snd_usbmidi_create (struct snd_card *card, +struct usb_interface *iface, +struct list_head *midi_list, +const struct snd_usb_audio_quirk *quirk, +unsigned int usb_id) {struct snd_usb_midi *umidi;struct snd_usb_midi_endpoint_info endpoints[MIDI_MAX_ENDPOINTS ];
@@ -2341,8 +2342,10 @@ int snd_usbmidi_create(struct snd_card *card,spin_lock_init (&umidi->disc_lock);init_rwsem (&umidi->disc_rwsem);mutex_init (&umidi->mutex); - umidi->usb_id =USB_ID (le16_to_cpu (umidi->dev->descriptor.idVendor), +if (!usb_id) + usb_id =USB_ID (le16_to_cpu (umidi->dev->descriptor.idVendor),le16_to_cpu (umidi->dev->descriptor.idProduct)); + umidi->usb_id = usb_id;setup_timer (&umidi->error_timer, snd_usbmidi_error_timer, (unsigned long )umidi);
@@ -2464,4 +2467,4 @@ int snd_usbmidi_create(struct snd_card *card,list_add_tail (&umidi->list, midi_list);return 0 ; } -EXPORT_SYMBOL (snd_usbmidi_create); +EXPORT_SYMBOL (__snd_usbmidi_create);
sound/usb/midi.h +12 -2
@@ -39,10 +39,20 @@ struct snd_usb_midi_endpoint_info {/* for QUIRK_MIDI_AKAI, data is NULL */ -int snd_usbmidi_create (struct snd_card *card, +int __snd_usbmidi_create (struct snd_card *card, +struct usb_interface *iface, +struct list_head *midi_list, +const struct snd_usb_audio_quirk *quirk, +unsigned int usb_id); + +static inline int snd_usbmidi_create (struct snd_card *card,struct usb_interface *iface,struct list_head *midi_list, -const struct snd_usb_audio_quirk *quirk); +const struct snd_usb_audio_quirk *quirk) +{ +return __snd_usbmidi_create (card, iface, midi_list, quirk,0 ); +} +void snd_usbmidi_input_stop (struct list_head *p);void snd_usbmidi_input_start (struct list_head *p);void snd_usbmidi_disconnect (struct list_head *p);
sound/usb/quirks.c +20 -14
@@ -446,8 +446,9 @@ static int create_uaxx_quirk(struct snd_usb_audio *chip,const struct snd_usb_audio_quirk *quirk = chip->usb_id ==USB_ID (0x0582 ,0x002b ) ? &ua700_quirk : &uaxx_quirk; -return snd_usbmidi_create (chip->card, iface, - &chip->midi_list, quirk); +return __snd_usbmidi_create (chip->card, iface, + &chip->midi_list, quirk, + chip->usb_id); }if (altsd->bNumEndpoints !=1 )
@@ -974,11 +975,9 @@ int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,int snd_usb_apply_boot_quirk (struct usb_device *dev,struct usb_interface *intf, -const struct snd_usb_audio_quirk *quirk) +const struct snd_usb_audio_quirk *quirk, +unsigned int id) { -u32 id =USB_ID (le16_to_cpu (dev->descriptor.idVendor), -le16_to_cpu (dev->descriptor.idProduct)); -switch (id) {case USB_ID (0x041e ,0x3000 ):/* SB Extigy needs special boot-up sequence */
@@ -1182,7 +1181,7 @@ void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)* "Playback Design" products send bogus feedback data at the start * of the stream. Ignore them. */ -if ((le16_to_cpu (ep->chip->dev->descriptor.idVendor) ==0x23ba ) && +if (USB_ID_VENDOR (ep->chip->usb_id) ==0x23ba && ep->type ==SND_USB_ENDPOINT_TYPE_SYNC ) ep->skip_packets =4 ;
@@ -1201,39 +1200,46 @@ void snd_usb_endpoint_start_quirk(struct snd_usb_endpoint *ep)void snd_usb_set_interface_quirk (struct usb_device *dev) { +struct snd_usb_audio *chip =dev_get_drvdata (&dev->dev); + +if (!chip) +return ;/* * "Playback Design" products need a 50ms delay after setting the * USB interface. */ -if (le16_to_cpu (dev->descriptor.idVendor) ==0x23ba ) +if (USB_ID_VENDOR (chip->usb_id) ==0x23ba )mdelay (50 ); } +/* quirk applied after snd_usb_ctl_msg(); not applied during boot quirks */ void snd_usb_ctl_msg_quirk (struct usb_device *dev,unsigned int pipe,__u8 request,__u8 requesttype,__u16 value,__u16 index,void *data,__u16 size) { +struct snd_usb_audio *chip =dev_get_drvdata (&dev->dev); + +if (!chip) +return ;/* * "Playback Design" products need a 20ms delay after each * class compliant request */ -if ((le16_to_cpu (dev->descriptor.idVendor) ==0x23ba ) && +if (USB_ID_VENDOR (chip->usb_id) ==0x23ba && (requesttype &USB_TYPE_MASK ) ==USB_TYPE_CLASS )mdelay (20 );/* Marantz/Denon devices with USB DAC functionality need a delay * after each class compliant request */ -if (is_marantz_denon_dac (USB_ID (le16_to_cpu (dev->descriptor.idVendor), -le16_to_cpu (dev->descriptor.idProduct))) +if (is_marantz_denon_dac (chip->usb_id) && (requesttype &USB_TYPE_MASK ) ==USB_TYPE_CLASS )mdelay (20 );/* Zoom R16/24 needs a tiny delay here, otherwise requests like * get/set frequency return as failed despite actually succeeding. */ -if ((le16_to_cpu (dev->descriptor.idVendor) ==0x1686 ) && - (le16_to_cpu (dev->descriptor.idProduct) ==0x00dd ) && +if (chip->usb_id ==USB_ID (0x1686 ,0x00dd ) && (requesttype &USB_TYPE_MASK ) ==USB_TYPE_CLASS )mdelay (1 ); }
@@ -1250,7 +1256,7 @@ u64 snd_usb_interface_dsd_format_quirks(struct snd_usb_audio *chip, unsigned int sample_bytes) {/* Playback Designs */ -if (le16_to_cpu (chip->dev->descriptor.idVendor) ==0x23ba ) { +if (USB_ID_VENDOR (chip->usb_id) ==0x23ba ) {switch (fp->altsetting) {case 1 : fp->dsd_dop = true;
sound/usb/quirks.h +2 -1
@@ -16,7 +16,8 @@ int snd_usb_apply_interface_quirk(struct snd_usb_audio *chip,int snd_usb_apply_boot_quirk (struct usb_device *dev,struct usb_interface *intf, -const struct snd_usb_audio_quirk *quirk); +const struct snd_usb_audio_quirk *quirk, +unsigned int usb_id);void snd_usb_set_format_quirk (struct snd_usb_substream *subs,struct audioformat *fmt);
Signature · 1 line
2.7.0
RFC PATCH 2/3 ALSA: usb-audio: Add quirk_alias option
In reply to Takashi IwaiThis patch adds a new option "quirk_alias" to snd-usb-audio driver for allowing user to pass the quirk alias list. A quirk alias consists of a string form like 0123abcd:5678beef, which makes to apply a quirk to a device with USB ID 0123:abcd treated as if it were 5678:beef. This feature is useful to test an existing quirk, typically for a newer model of the same vendor, without patching / rebuilding the kernel driver.
The current implementation is fairly simplistic: since there is no API for matching a usb_device_id to the given ID pair, it has an open code to loop over the id table and matches only with vendor:product pair. So far, this is OK, as all existing entries are with vendor:product pairs, indeed. Once when we have another matching entry, however, we'd need to update get_alias_quirk() as well.
Note that this option is provided only for testing / development. If you want to have a proper support, contact to upstream for adding the matching quirk in the driver code statically.
--- sound/usb/card.c | 47 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+)
sound/usb/card.c +47 -0
@@ -82,6 +82,7 @@ static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };static int device_setup[SNDRV_CARDS ];/* device parameter for this card */ static bool ignore_ctl_error;static bool autoclock = true; +static char *quirk_alias[SNDRV_CARDS ];module_param_array (index, int,NULL ,0444 );MODULE_PARM_DESC (index,"Index value for the USB audio adapter." );
@@ -100,6 +101,8 @@ MODULE_PARM_DESC(ignore_ctl_error, "Ignore errors from USB controller for mixer interfaces.");module_param (autoclock, bool,0444 );MODULE_PARM_DESC (autoclock,"Enable auto-clock selection for UAC2 devices (default: yes)." ); +module_param_array (quirk_alias, charp,NULL ,0444 ); +MODULE_PARM_DESC (quirk_alias,"Quirk aliases, e.g. 0123abcd:5678beef." );/* * we keep the snd_usb_audio_t instances by ourselves for merging
@@ -457,6 +460,48 @@ static int snd_usb_audio_create(struct usb_interface *intf,return 0 ; } +/* look for a matching quirk alias id */ +static bool get_alias_id (struct usb_device *dev,unsigned int *id) +{ +int i; +unsigned int src, dst; + +for (i =0 ; i <ARRAY_SIZE (quirk_alias); i++) { +if (!quirk_alias[i] || +sscanf (quirk_alias[i],"%x:%x" , &src, &dst) !=2 || + src != *id) +continue ; +dev_info (&dev->dev, +"device (%04x:%04x): applying quirk alias %04x:%04x\n" , +USB_ID_VENDOR (*id),USB_ID_PRODUCT (*id), +USB_ID_VENDOR (dst),USB_ID_PRODUCT (dst)); + *id = dst; +return true; + } + +return false; +} + +static struct usb_device_id usb_audio_ids[];/* defined below */ + +/* look for the corresponding quirk */ +static const struct snd_usb_audio_quirk * +get_alias_quirk (struct usb_device *dev,unsigned int id) +{ +const struct usb_device_id *p; + +for (p = usb_audio_ids; p->match_flags; p++) { +/* FIXME: this checks only vendor:product pair in the list */ +if ((p->match_flags &USB_DEVICE_ID_MATCH_DEVICE ) == +USB_DEVICE_ID_MATCH_DEVICE && + p->idVendor ==USB_ID_VENDOR (id) && + p->idProduct ==USB_ID_PRODUCT (id)) +return (const struct snd_usb_audio_quirk *)p->driver_info; + } + +return NULL ; +} +/* * probe the active usb device *
@@ -483,6 +528,8 @@ static int usb_audio_probe(struct usb_interface *intf, ifnum =get_iface_desc (alts)->bInterfaceNumber; id =USB_ID (le16_to_cpu (dev->descriptor.idVendor),le16_to_cpu (dev->descriptor.idProduct)); +if (get_alias_id (dev, &id)) + quirk =get_alias_quirk (dev, id);if (quirk && quirk->ifnum >=0 && ifnum != quirk->ifnum)return -ENXIO ;
Signature · 1 line
2.7.0
RFC PATCH 3/3 ALSA: doc: Update option descriptions for snd-usb-audio
In reply to Takashi IwaiThe autoclock and quirk_alias options have been added.
--- Documentation/sound/alsa/ALSA-Configuration.txt | 9 +++++++++ 1 file changed, 9 insertions(+)
Documentation/sound/alsa/ALSA-Configuration.txt +9 -0
@@ -1910,6 +1910,12 @@ Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed. - Default: 0x0000 ignore_ctl_error - Ignore any USB-controller regarding mixer interface (default: no) + autoclock - Enable auto-clock selection for UAC2 devices + (default: yes) + quirk_alias - Quirk alias list, pass strings like + "0123abcd:5678beef", which applies the existing + quirk for the device 5678:beef to a new device + 0123:abcd. This module supports multiple devices, autoprobe and hotplugging.
@@ -1919,6 +1925,9 @@ Prior to version 0.9.0rc4 options had a 'snd_' prefix. This was removed. NB: ignore_ctl_error=1 may help when you get an error at accessing the mixer element such as URB error -22. This happens on some buggy USB device or the controller. + NB: quirk_alias option is provided only for testing / development. + If you want to have a proper support, contact to upstream for + adding the matching quirk in the driver code statically. Module snd-usb-caiaq --------------------
Signature · 1 line
2.7.0