1182 lines · c
1// SPDX-License-Identifier: GPL-2.0-or-later2/*3 * (Tentative) USB Audio Driver for ALSA4 *5 * Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>6 *7 * Many codes borrowed from audio.c by8 * Alan Cox (alan@lxorguk.ukuu.org.uk)9 * Thomas Sailer (sailer@ife.ee.ethz.ch)10 *11 * Audio Class 3.0 support by Ruslan Bilovol <ruslan.bilovol@gmail.com>12 *13 * NOTES:14 *15 * - the linked URBs would be preferred but not used so far because of16 * the instability of unlinking.17 * - type II is not supported properly. there is no device which supports18 * this type *correctly*. SB extigy looks as if it supports, but it's19 * indeed an AC3 stream packed in SPDIF frames (i.e. no real AC3 stream).20 */21 22 23#include <linux/bitops.h>24#include <linux/init.h>25#include <linux/list.h>26#include <linux/slab.h>27#include <linux/string.h>28#include <linux/ctype.h>29#include <linux/usb.h>30#include <linux/moduleparam.h>31#include <linux/mutex.h>32#include <linux/usb/audio.h>33#include <linux/usb/audio-v2.h>34#include <linux/usb/audio-v3.h>35#include <linux/module.h>36 37#include <sound/control.h>38#include <sound/core.h>39#include <sound/info.h>40#include <sound/pcm.h>41#include <sound/pcm_params.h>42#include <sound/initval.h>43 44#include "usbaudio.h"45#include "card.h"46#include "midi.h"47#include "midi2.h"48#include "mixer.h"49#include "proc.h"50#include "quirks.h"51#include "endpoint.h"52#include "helper.h"53#include "pcm.h"54#include "format.h"55#include "power.h"56#include "stream.h"57#include "media.h"58 59MODULE_AUTHOR("Takashi Iwai <tiwai@suse.de>");60MODULE_DESCRIPTION("USB Audio");61MODULE_LICENSE("GPL");62 63static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; /* Index 0-MAX */64static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; /* ID for this card */65static bool enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;/* Enable this card */66/* Vendor/product IDs for this card */67static int vid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };68static int pid[SNDRV_CARDS] = { [0 ... (SNDRV_CARDS-1)] = -1 };69static int device_setup[SNDRV_CARDS]; /* device parameter for this card */70static bool ignore_ctl_error;71static bool autoclock = true;72static bool lowlatency = true;73static char *quirk_alias[SNDRV_CARDS];74static char *delayed_register[SNDRV_CARDS];75static bool implicit_fb[SNDRV_CARDS];76static unsigned int quirk_flags[SNDRV_CARDS];77 78bool snd_usb_use_vmalloc = true;79bool snd_usb_skip_validation;80 81module_param_array(index, int, NULL, 0444);82MODULE_PARM_DESC(index, "Index value for the USB audio adapter.");83module_param_array(id, charp, NULL, 0444);84MODULE_PARM_DESC(id, "ID string for the USB audio adapter.");85module_param_array(enable, bool, NULL, 0444);86MODULE_PARM_DESC(enable, "Enable USB audio adapter.");87module_param_array(vid, int, NULL, 0444);88MODULE_PARM_DESC(vid, "Vendor ID for the USB audio device.");89module_param_array(pid, int, NULL, 0444);90MODULE_PARM_DESC(pid, "Product ID for the USB audio device.");91module_param_array(device_setup, int, NULL, 0444);92MODULE_PARM_DESC(device_setup, "Specific device setup (if needed).");93module_param(ignore_ctl_error, bool, 0444);94MODULE_PARM_DESC(ignore_ctl_error,95 "Ignore errors from USB controller for mixer interfaces.");96module_param(autoclock, bool, 0444);97MODULE_PARM_DESC(autoclock, "Enable auto-clock selection for UAC2 devices (default: yes).");98module_param(lowlatency, bool, 0444);99MODULE_PARM_DESC(lowlatency, "Enable low latency playback (default: yes).");100module_param_array(quirk_alias, charp, NULL, 0444);101MODULE_PARM_DESC(quirk_alias, "Quirk aliases, e.g. 0123abcd:5678beef.");102module_param_array(delayed_register, charp, NULL, 0444);103MODULE_PARM_DESC(delayed_register, "Quirk for delayed registration, given by id:iface, e.g. 0123abcd:4.");104module_param_array(implicit_fb, bool, NULL, 0444);105MODULE_PARM_DESC(implicit_fb, "Apply generic implicit feedback sync mode.");106module_param_array(quirk_flags, uint, NULL, 0444);107MODULE_PARM_DESC(quirk_flags, "Driver quirk bit flags.");108module_param_named(use_vmalloc, snd_usb_use_vmalloc, bool, 0444);109MODULE_PARM_DESC(use_vmalloc, "Use vmalloc for PCM intermediate buffers (default: yes).");110module_param_named(skip_validation, snd_usb_skip_validation, bool, 0444);111MODULE_PARM_DESC(skip_validation, "Skip unit descriptor validation (default: no).");112 113/*114 * we keep the snd_usb_audio_t instances by ourselves for merging115 * the all interfaces on the same card as one sound device.116 */117 118static DEFINE_MUTEX(register_mutex);119static struct snd_usb_audio *usb_chip[SNDRV_CARDS];120static struct usb_driver usb_audio_driver;121 122/*123 * disconnect streams124 * called from usb_audio_disconnect()125 */126static void snd_usb_stream_disconnect(struct snd_usb_stream *as)127{128 int idx;129 struct snd_usb_substream *subs;130 131 for (idx = 0; idx < 2; idx++) {132 subs = &as->substream[idx];133 if (!subs->num_formats)134 continue;135 subs->data_endpoint = NULL;136 subs->sync_endpoint = NULL;137 }138}139 140static int snd_usb_create_stream(struct snd_usb_audio *chip, int ctrlif, int interface)141{142 struct usb_device *dev = chip->dev;143 struct usb_host_interface *alts;144 struct usb_interface_descriptor *altsd;145 struct usb_interface *iface = usb_ifnum_to_if(dev, interface);146 147 if (!iface) {148 dev_err(&dev->dev, "%u:%d : does not exist\n",149 ctrlif, interface);150 return -EINVAL;151 }152 153 alts = &iface->altsetting[0];154 altsd = get_iface_desc(alts);155 156 /*157 * Android with both accessory and audio interfaces enabled gets the158 * interface numbers wrong.159 */160 if ((chip->usb_id == USB_ID(0x18d1, 0x2d04) ||161 chip->usb_id == USB_ID(0x18d1, 0x2d05)) &&162 interface == 0 &&163 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC &&164 altsd->bInterfaceSubClass == USB_SUBCLASS_VENDOR_SPEC) {165 interface = 2;166 iface = usb_ifnum_to_if(dev, interface);167 if (!iface)168 return -EINVAL;169 alts = &iface->altsetting[0];170 altsd = get_iface_desc(alts);171 }172 173 if (usb_interface_claimed(iface)) {174 dev_dbg(&dev->dev, "%d:%d: skipping, already claimed\n",175 ctrlif, interface);176 return -EINVAL;177 }178 179 if ((altsd->bInterfaceClass == USB_CLASS_AUDIO ||180 altsd->bInterfaceClass == USB_CLASS_VENDOR_SPEC) &&181 altsd->bInterfaceSubClass == USB_SUBCLASS_MIDISTREAMING) {182 int err = snd_usb_midi_v2_create(chip, iface, NULL,183 chip->usb_id);184 if (err < 0) {185 dev_err(&dev->dev,186 "%u:%d: cannot create sequencer device\n",187 ctrlif, interface);188 return -EINVAL;189 }190 return usb_driver_claim_interface(&usb_audio_driver, iface,191 USB_AUDIO_IFACE_UNUSED);192 }193 194 if ((altsd->bInterfaceClass != USB_CLASS_AUDIO &&195 altsd->bInterfaceClass != USB_CLASS_VENDOR_SPEC) ||196 altsd->bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING) {197 dev_dbg(&dev->dev,198 "%u:%d: skipping non-supported interface %d\n",199 ctrlif, interface, altsd->bInterfaceClass);200 /* skip non-supported classes */201 return -EINVAL;202 }203 204 if (snd_usb_get_speed(dev) == USB_SPEED_LOW) {205 dev_err(&dev->dev, "low speed audio streaming not supported\n");206 return -EINVAL;207 }208 209 snd_usb_add_ctrl_interface_link(chip, interface, ctrlif);210 211 if (! snd_usb_parse_audio_interface(chip, interface)) {212 usb_set_interface(dev, interface, 0); /* reset the current interface */213 return usb_driver_claim_interface(&usb_audio_driver, iface,214 USB_AUDIO_IFACE_UNUSED);215 }216 217 return 0;218}219 220/*221 * parse audio control descriptor and create pcm/midi streams222 */223static int snd_usb_create_streams(struct snd_usb_audio *chip, int ctrlif)224{225 struct usb_device *dev = chip->dev;226 struct usb_host_interface *host_iface;227 struct usb_interface_descriptor *altsd;228 int i, protocol;229 230 /* find audiocontrol interface */231 host_iface = &usb_ifnum_to_if(dev, ctrlif)->altsetting[0];232 altsd = get_iface_desc(host_iface);233 protocol = altsd->bInterfaceProtocol;234 235 switch (protocol) {236 default:237 dev_warn(&dev->dev,238 "unknown interface protocol %#02x, assuming v1\n",239 protocol);240 fallthrough;241 242 case UAC_VERSION_1: {243 struct uac1_ac_header_descriptor *h1;244 int rest_bytes;245 246 h1 = snd_usb_find_csint_desc(host_iface->extra,247 host_iface->extralen,248 NULL, UAC_HEADER);249 if (!h1 || h1->bLength < sizeof(*h1)) {250 dev_err(&dev->dev, "cannot find UAC_HEADER\n");251 return -EINVAL;252 }253 254 rest_bytes = (void *)(host_iface->extra +255 host_iface->extralen) - (void *)h1;256 257 /* just to be sure -- this shouldn't hit at all */258 if (rest_bytes <= 0) {259 dev_err(&dev->dev, "invalid control header\n");260 return -EINVAL;261 }262 263 if (rest_bytes < sizeof(*h1)) {264 dev_err(&dev->dev, "too short v1 buffer descriptor\n");265 return -EINVAL;266 }267 268 if (!h1->bInCollection) {269 dev_info(&dev->dev, "skipping empty audio interface (v1)\n");270 return -EINVAL;271 }272 273 if (rest_bytes < h1->bLength) {274 dev_err(&dev->dev, "invalid buffer length (v1)\n");275 return -EINVAL;276 }277 278 if (h1->bLength < sizeof(*h1) + h1->bInCollection) {279 dev_err(&dev->dev, "invalid UAC_HEADER (v1)\n");280 return -EINVAL;281 }282 283 for (i = 0; i < h1->bInCollection; i++)284 snd_usb_create_stream(chip, ctrlif, h1->baInterfaceNr[i]);285 286 break;287 }288 289 case UAC_VERSION_2:290 case UAC_VERSION_3: {291 struct usb_interface_assoc_descriptor *assoc =292 usb_ifnum_to_if(dev, ctrlif)->intf_assoc;293 294 if (!assoc) {295 /*296 * Firmware writers cannot count to three. So to find297 * the IAD on the NuForce UDH-100, also check the next298 * interface.299 */300 struct usb_interface *iface =301 usb_ifnum_to_if(dev, ctrlif + 1);302 if (iface &&303 iface->intf_assoc &&304 iface->intf_assoc->bFunctionClass == USB_CLASS_AUDIO &&305 iface->intf_assoc->bFunctionProtocol == UAC_VERSION_2)306 assoc = iface->intf_assoc;307 }308 309 if (!assoc) {310 dev_err(&dev->dev, "Audio class v2/v3 interfaces need an interface association\n");311 return -EINVAL;312 }313 314 if (protocol == UAC_VERSION_3) {315 int badd = assoc->bFunctionSubClass;316 317 if (badd != UAC3_FUNCTION_SUBCLASS_FULL_ADC_3_0 &&318 (badd < UAC3_FUNCTION_SUBCLASS_GENERIC_IO ||319 badd > UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE)) {320 dev_err(&dev->dev,321 "Unsupported UAC3 BADD profile\n");322 return -EINVAL;323 }324 325 chip->badd_profile = badd;326 }327 328 for (i = 0; i < assoc->bInterfaceCount; i++) {329 int intf = assoc->bFirstInterface + i;330 331 if (intf != ctrlif)332 snd_usb_create_stream(chip, ctrlif, intf);333 }334 335 break;336 }337 }338 339 return 0;340}341 342/*343 * Profile name preset table344 */345struct usb_audio_device_name {346 u32 id;347 const char *vendor_name;348 const char *product_name;349 const char *profile_name; /* override card->longname */350};351 352#define PROFILE_NAME(vid, pid, vendor, product, profile) \353 { .id = USB_ID(vid, pid), .vendor_name = (vendor), \354 .product_name = (product), .profile_name = (profile) }355#define DEVICE_NAME(vid, pid, vendor, product) \356 PROFILE_NAME(vid, pid, vendor, product, NULL)357 358/* vendor/product and profile name presets, sorted in device id order */359static const struct usb_audio_device_name usb_audio_names[] = {360 /* HP Thunderbolt Dock Audio Headset */361 PROFILE_NAME(0x03f0, 0x0269, "HP", "Thunderbolt Dock Audio Headset",362 "HP-Thunderbolt-Dock-Audio-Headset"),363 /* HP Thunderbolt Dock Audio Module */364 PROFILE_NAME(0x03f0, 0x0567, "HP", "Thunderbolt Dock Audio Module",365 "HP-Thunderbolt-Dock-Audio-Module"),366 367 /* Two entries for Gigabyte TRX40 Aorus Master:368 * TRX40 Aorus Master has two USB-audio devices, one for the front369 * headphone with ESS SABRE9218 DAC chip, while another for the rest370 * I/O (the rear panel and the front mic) with Realtek ALC1220-VB.371 * Here we provide two distinct names for making UCM profiles easier.372 */373 PROFILE_NAME(0x0414, 0xa000, "Gigabyte", "Aorus Master Front Headphone",374 "Gigabyte-Aorus-Master-Front-Headphone"),375 PROFILE_NAME(0x0414, 0xa001, "Gigabyte", "Aorus Master Main Audio",376 "Gigabyte-Aorus-Master-Main-Audio"),377 378 /* Gigabyte TRX40 Aorus Pro WiFi */379 PROFILE_NAME(0x0414, 0xa002,380 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),381 382 /* Creative/E-Mu devices */383 DEVICE_NAME(0x041e, 0x3010, "Creative Labs", "Sound Blaster MP3+"),384 /* Creative/Toshiba Multimedia Center SB-0500 */385 DEVICE_NAME(0x041e, 0x3048, "Toshiba", "SB-0500"),386 387 /* Logitech Audio Devices */388 DEVICE_NAME(0x046d, 0x0867, "Logitech, Inc.", "Logi-MeetUp"),389 DEVICE_NAME(0x046d, 0x0874, "Logitech, Inc.", "Logi-Tap-Audio"),390 DEVICE_NAME(0x046d, 0x087c, "Logitech, Inc.", "Logi-Huddle"),391 DEVICE_NAME(0x046d, 0x0898, "Logitech, Inc.", "Logi-RB-Audio"),392 DEVICE_NAME(0x046d, 0x08d2, "Logitech, Inc.", "Logi-RBM-Audio"),393 DEVICE_NAME(0x046d, 0x0990, "Logitech, Inc.", "QuickCam Pro 9000"),394 395 DEVICE_NAME(0x05e1, 0x0408, "Syntek", "STK1160"),396 DEVICE_NAME(0x05e1, 0x0480, "Hauppauge", "Woodbury"),397 398 /* ASUS ROG Zenith II: this machine has also two devices, one for399 * the front headphone and another for the rest400 */401 PROFILE_NAME(0x0b05, 0x1915, "ASUS", "Zenith II Front Headphone",402 "Zenith-II-Front-Headphone"),403 PROFILE_NAME(0x0b05, 0x1916, "ASUS", "Zenith II Main Audio",404 "Zenith-II-Main-Audio"),405 406 /* ASUS ROG Strix */407 PROFILE_NAME(0x0b05, 0x1917,408 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),409 /* ASUS PRIME TRX40 PRO-S */410 PROFILE_NAME(0x0b05, 0x1918,411 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),412 413 /* Dell WD15 Dock */414 PROFILE_NAME(0x0bda, 0x4014, "Dell", "WD15 Dock", "Dell-WD15-Dock"),415 /* Dell WD19 Dock */416 PROFILE_NAME(0x0bda, 0x402e, "Dell", "WD19 Dock", "Dell-WD15-Dock"),417 418 DEVICE_NAME(0x0ccd, 0x0028, "TerraTec", "Aureon5.1MkII"),419 420 /*421 * The original product_name is "USB Sound Device", however this name422 * is also used by the CM106 based cards, so make it unique.423 */424 DEVICE_NAME(0x0d8c, 0x0102, NULL, "ICUSBAUDIO7D"),425 DEVICE_NAME(0x0d8c, 0x0103, NULL, "Audio Advantage MicroII"),426 427 /* MSI TRX40 Creator */428 PROFILE_NAME(0x0db0, 0x0d64,429 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),430 /* MSI TRX40 */431 PROFILE_NAME(0x0db0, 0x543d,432 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),433 434 DEVICE_NAME(0x0fd9, 0x0008, "Hauppauge", "HVR-950Q"),435 436 /* Dock/Stand for HP Engage Go */437 PROFILE_NAME(0x103c, 0x830a, "HP", "HP Engage Go Dock",438 "HP-Engage-Go-Dock"),439 440 /* Stanton/N2IT Final Scratch v1 device ('Scratchamp') */441 DEVICE_NAME(0x103d, 0x0100, "Stanton", "ScratchAmp"),442 DEVICE_NAME(0x103d, 0x0101, "Stanton", "ScratchAmp"),443 444 /* aka. Serato Scratch Live DJ Box */445 DEVICE_NAME(0x13e5, 0x0001, "Rane", "SL-1"),446 447 /* Lenovo ThinkStation P620 Rear Line-in, Line-out and Microphone */448 PROFILE_NAME(0x17aa, 0x1046, "Lenovo", "ThinkStation P620 Rear",449 "Lenovo-ThinkStation-P620-Rear"),450 /* Lenovo ThinkStation P620 Internal Speaker + Front Headset */451 PROFILE_NAME(0x17aa, 0x104d, "Lenovo", "ThinkStation P620 Main",452 "Lenovo-ThinkStation-P620-Main"),453 454 /* Asrock TRX40 Creator */455 PROFILE_NAME(0x26ce, 0x0a01,456 "Realtek", "ALC1220-VB-DT", "Realtek-ALC1220-VB-Desktop"),457 458 DEVICE_NAME(0x2040, 0x7200, "Hauppauge", "HVR-950Q"),459 DEVICE_NAME(0x2040, 0x7201, "Hauppauge", "HVR-950Q-MXL"),460 DEVICE_NAME(0x2040, 0x7210, "Hauppauge", "HVR-950Q"),461 DEVICE_NAME(0x2040, 0x7211, "Hauppauge", "HVR-950Q-MXL"),462 DEVICE_NAME(0x2040, 0x7213, "Hauppauge", "HVR-950Q"),463 DEVICE_NAME(0x2040, 0x7217, "Hauppauge", "HVR-950Q"),464 DEVICE_NAME(0x2040, 0x721b, "Hauppauge", "HVR-950Q"),465 DEVICE_NAME(0x2040, 0x721e, "Hauppauge", "HVR-950Q"),466 DEVICE_NAME(0x2040, 0x721f, "Hauppauge", "HVR-950Q"),467 DEVICE_NAME(0x2040, 0x7240, "Hauppauge", "HVR-850"),468 DEVICE_NAME(0x2040, 0x7260, "Hauppauge", "HVR-950Q"),469 DEVICE_NAME(0x2040, 0x7270, "Hauppauge", "HVR-950Q"),470 DEVICE_NAME(0x2040, 0x7280, "Hauppauge", "HVR-950Q"),471 DEVICE_NAME(0x2040, 0x7281, "Hauppauge", "HVR-950Q-MXL"),472 DEVICE_NAME(0x2040, 0x8200, "Hauppauge", "Woodbury"),473 474 { } /* terminator */475};476 477static const struct usb_audio_device_name *478lookup_device_name(u32 id)479{480 static const struct usb_audio_device_name *p;481 482 for (p = usb_audio_names; p->id; p++)483 if (p->id == id)484 return p;485 return NULL;486}487 488/*489 * free the chip instance490 *491 * here we have to do not much, since pcm and controls are already freed492 *493 */494 495static void snd_usb_audio_free(struct snd_card *card)496{497 struct snd_usb_audio *chip = card->private_data;498 499 snd_usb_endpoint_free_all(chip);500 snd_usb_midi_v2_free_all(chip);501 502 mutex_destroy(&chip->mutex);503 if (!atomic_read(&chip->shutdown))504 dev_set_drvdata(&chip->dev->dev, NULL);505}506 507static void usb_audio_make_shortname(struct usb_device *dev,508 struct snd_usb_audio *chip,509 const struct snd_usb_audio_quirk *quirk)510{511 struct snd_card *card = chip->card;512 const struct usb_audio_device_name *preset;513 const char *s = NULL;514 515 preset = lookup_device_name(chip->usb_id);516 if (preset && preset->product_name)517 s = preset->product_name;518 else if (quirk && quirk->product_name)519 s = quirk->product_name;520 if (s && *s) {521 strscpy(card->shortname, s, sizeof(card->shortname));522 return;523 }524 525 /* retrieve the device string as shortname */526 if (!dev->descriptor.iProduct ||527 usb_string(dev, dev->descriptor.iProduct,528 card->shortname, sizeof(card->shortname)) <= 0) {529 /* no name available from anywhere, so use ID */530 sprintf(card->shortname, "USB Device %#04x:%#04x",531 USB_ID_VENDOR(chip->usb_id),532 USB_ID_PRODUCT(chip->usb_id));533 }534 535 strim(card->shortname);536}537 538static void usb_audio_make_longname(struct usb_device *dev,539 struct snd_usb_audio *chip,540 const struct snd_usb_audio_quirk *quirk)541{542 struct snd_card *card = chip->card;543 const struct usb_audio_device_name *preset;544 const char *s = NULL;545 int len;546 547 preset = lookup_device_name(chip->usb_id);548 549 /* shortcut - if any pre-defined string is given, use it */550 if (preset && preset->profile_name)551 s = preset->profile_name;552 if (s && *s) {553 strscpy(card->longname, s, sizeof(card->longname));554 return;555 }556 557 if (preset && preset->vendor_name)558 s = preset->vendor_name;559 else if (quirk && quirk->vendor_name)560 s = quirk->vendor_name;561 *card->longname = 0;562 if (s && *s) {563 strscpy(card->longname, s, sizeof(card->longname));564 } else {565 /* retrieve the vendor and device strings as longname */566 if (dev->descriptor.iManufacturer)567 usb_string(dev, dev->descriptor.iManufacturer,568 card->longname, sizeof(card->longname));569 /* we don't really care if there isn't any vendor string */570 }571 if (*card->longname) {572 strim(card->longname);573 if (*card->longname)574 strlcat(card->longname, " ", sizeof(card->longname));575 }576 577 strlcat(card->longname, card->shortname, sizeof(card->longname));578 579 len = strlcat(card->longname, " at ", sizeof(card->longname));580 581 if (len < sizeof(card->longname))582 usb_make_path(dev, card->longname + len, sizeof(card->longname) - len);583 584 switch (snd_usb_get_speed(dev)) {585 case USB_SPEED_LOW:586 strlcat(card->longname, ", low speed", sizeof(card->longname));587 break;588 case USB_SPEED_FULL:589 strlcat(card->longname, ", full speed", sizeof(card->longname));590 break;591 case USB_SPEED_HIGH:592 strlcat(card->longname, ", high speed", sizeof(card->longname));593 break;594 case USB_SPEED_SUPER:595 strlcat(card->longname, ", super speed", sizeof(card->longname));596 break;597 case USB_SPEED_SUPER_PLUS:598 strlcat(card->longname, ", super speed plus", sizeof(card->longname));599 break;600 default:601 break;602 }603}604 605/*606 * create a chip instance and set its names.607 */608static int snd_usb_audio_create(struct usb_interface *intf,609 struct usb_device *dev, int idx,610 const struct snd_usb_audio_quirk *quirk,611 unsigned int usb_id,612 struct snd_usb_audio **rchip)613{614 struct snd_card *card;615 struct snd_usb_audio *chip;616 int err;617 char component[14];618 619 *rchip = NULL;620 621 switch (snd_usb_get_speed(dev)) {622 case USB_SPEED_LOW:623 case USB_SPEED_FULL:624 case USB_SPEED_HIGH:625 case USB_SPEED_SUPER:626 case USB_SPEED_SUPER_PLUS:627 break;628 default:629 dev_err(&dev->dev, "unknown device speed %d\n", snd_usb_get_speed(dev));630 return -ENXIO;631 }632 633 err = snd_card_new(&intf->dev, index[idx], id[idx], THIS_MODULE,634 sizeof(*chip), &card);635 if (err < 0) {636 dev_err(&dev->dev, "cannot create card instance %d\n", idx);637 return err;638 }639 640 chip = card->private_data;641 mutex_init(&chip->mutex);642 init_waitqueue_head(&chip->shutdown_wait);643 chip->index = idx;644 chip->dev = dev;645 chip->card = card;646 chip->setup = device_setup[idx];647 chip->generic_implicit_fb = implicit_fb[idx];648 chip->autoclock = autoclock;649 chip->lowlatency = lowlatency;650 atomic_set(&chip->active, 1); /* avoid autopm during probing */651 atomic_set(&chip->usage_count, 0);652 atomic_set(&chip->shutdown, 0);653 654 chip->usb_id = usb_id;655 INIT_LIST_HEAD(&chip->pcm_list);656 INIT_LIST_HEAD(&chip->ep_list);657 INIT_LIST_HEAD(&chip->iface_ref_list);658 INIT_LIST_HEAD(&chip->clock_ref_list);659 INIT_LIST_HEAD(&chip->midi_list);660 INIT_LIST_HEAD(&chip->midi_v2_list);661 INIT_LIST_HEAD(&chip->mixer_list);662 663 if (quirk_flags[idx])664 chip->quirk_flags = quirk_flags[idx];665 else666 snd_usb_init_quirk_flags(chip);667 668 card->private_free = snd_usb_audio_free;669 670 strcpy(card->driver, "USB-Audio");671 sprintf(component, "USB%04x:%04x",672 USB_ID_VENDOR(chip->usb_id), USB_ID_PRODUCT(chip->usb_id));673 snd_component_add(card, component);674 675 usb_audio_make_shortname(dev, chip, quirk);676 usb_audio_make_longname(dev, chip, quirk);677 678 snd_usb_audio_create_proc(chip);679 680 *rchip = chip;681 return 0;682}683 684/* look for a matching quirk alias id */685static bool get_alias_id(struct usb_device *dev, unsigned int *id)686{687 int i;688 unsigned int src, dst;689 690 for (i = 0; i < ARRAY_SIZE(quirk_alias); i++) {691 if (!quirk_alias[i] ||692 sscanf(quirk_alias[i], "%x:%x", &src, &dst) != 2 ||693 src != *id)694 continue;695 dev_info(&dev->dev,696 "device (%04x:%04x): applying quirk alias %04x:%04x\n",697 USB_ID_VENDOR(*id), USB_ID_PRODUCT(*id),698 USB_ID_VENDOR(dst), USB_ID_PRODUCT(dst));699 *id = dst;700 return true;701 }702 703 return false;704}705 706static int check_delayed_register_option(struct snd_usb_audio *chip)707{708 int i;709 unsigned int id, inum;710 711 for (i = 0; i < ARRAY_SIZE(delayed_register); i++) {712 if (delayed_register[i] &&713 sscanf(delayed_register[i], "%x:%x", &id, &inum) == 2 &&714 id == chip->usb_id)715 return inum;716 }717 718 return -1;719}720 721static const struct usb_device_id usb_audio_ids[]; /* defined below */722 723/* look for the last interface that matches with our ids and remember it */724static void find_last_interface(struct snd_usb_audio *chip)725{726 struct usb_host_config *config = chip->dev->actconfig;727 struct usb_interface *intf;728 int i;729 730 if (!config)731 return;732 for (i = 0; i < config->desc.bNumInterfaces; i++) {733 intf = config->interface[i];734 if (usb_match_id(intf, usb_audio_ids))735 chip->last_iface = intf->altsetting[0].desc.bInterfaceNumber;736 }737 usb_audio_dbg(chip, "Found last interface = %d\n", chip->last_iface);738}739 740/* look for the corresponding quirk */741static const struct snd_usb_audio_quirk *742get_alias_quirk(struct usb_device *dev, unsigned int id)743{744 const struct usb_device_id *p;745 746 for (p = usb_audio_ids; p->match_flags; p++) {747 /* FIXME: this checks only vendor:product pair in the list */748 if ((p->match_flags & USB_DEVICE_ID_MATCH_DEVICE) ==749 USB_DEVICE_ID_MATCH_DEVICE &&750 p->idVendor == USB_ID_VENDOR(id) &&751 p->idProduct == USB_ID_PRODUCT(id))752 return (const struct snd_usb_audio_quirk *)p->driver_info;753 }754 755 return NULL;756}757 758/* register card if we reach to the last interface or to the specified759 * one given via option760 */761static int try_to_register_card(struct snd_usb_audio *chip, int ifnum)762{763 if (check_delayed_register_option(chip) == ifnum ||764 chip->last_iface == ifnum ||765 usb_interface_claimed(usb_ifnum_to_if(chip->dev, chip->last_iface)))766 return snd_card_register(chip->card);767 return 0;768}769 770/*771 * probe the active usb device772 *773 * note that this can be called multiple times per a device, when it774 * includes multiple audio control interfaces.775 *776 * thus we check the usb device pointer and creates the card instance777 * only at the first time. the successive calls of this function will778 * append the pcm interface to the corresponding card.779 */780static int usb_audio_probe(struct usb_interface *intf,781 const struct usb_device_id *usb_id)782{783 struct usb_device *dev = interface_to_usbdev(intf);784 const struct snd_usb_audio_quirk *quirk =785 (const struct snd_usb_audio_quirk *)usb_id->driver_info;786 struct snd_usb_audio *chip;787 int i, err;788 struct usb_host_interface *alts;789 int ifnum;790 u32 id;791 792 alts = &intf->altsetting[0];793 ifnum = get_iface_desc(alts)->bInterfaceNumber;794 id = USB_ID(le16_to_cpu(dev->descriptor.idVendor),795 le16_to_cpu(dev->descriptor.idProduct));796 if (get_alias_id(dev, &id))797 quirk = get_alias_quirk(dev, id);798 if (quirk && quirk->ifnum >= 0 && ifnum != quirk->ifnum)799 return -ENXIO;800 if (quirk && quirk->ifnum == QUIRK_NODEV_INTERFACE)801 return -ENODEV;802 803 err = snd_usb_apply_boot_quirk(dev, intf, quirk, id);804 if (err < 0)805 return err;806 807 /*808 * found a config. now register to ALSA809 */810 811 /* check whether it's already registered */812 chip = NULL;813 mutex_lock(®ister_mutex);814 for (i = 0; i < SNDRV_CARDS; i++) {815 if (usb_chip[i] && usb_chip[i]->dev == dev) {816 if (atomic_read(&usb_chip[i]->shutdown)) {817 dev_err(&dev->dev, "USB device is in the shutdown state, cannot create a card instance\n");818 err = -EIO;819 goto __error;820 }821 chip = usb_chip[i];822 atomic_inc(&chip->active); /* avoid autopm */823 break;824 }825 }826 if (! chip) {827 err = snd_usb_apply_boot_quirk_once(dev, intf, quirk, id);828 if (err < 0)829 goto __error;830 831 /* it's a fresh one.832 * now look for an empty slot and create a new card instance833 */834 for (i = 0; i < SNDRV_CARDS; i++)835 if (!usb_chip[i] &&836 (vid[i] == -1 || vid[i] == USB_ID_VENDOR(id)) &&837 (pid[i] == -1 || pid[i] == USB_ID_PRODUCT(id))) {838 if (enable[i]) {839 err = snd_usb_audio_create(intf, dev, i, quirk,840 id, &chip);841 if (err < 0)842 goto __error;843 break;844 } else if (vid[i] != -1 || pid[i] != -1) {845 dev_info(&dev->dev,846 "device (%04x:%04x) is disabled\n",847 USB_ID_VENDOR(id),848 USB_ID_PRODUCT(id));849 err = -ENOENT;850 goto __error;851 }852 }853 if (!chip) {854 dev_err(&dev->dev, "no available usb audio device\n");855 err = -ENODEV;856 goto __error;857 }858 find_last_interface(chip);859 }860 861 if (chip->num_interfaces >= MAX_CARD_INTERFACES) {862 dev_info(&dev->dev, "Too many interfaces assigned to the single USB-audio card\n");863 err = -EINVAL;864 goto __error;865 }866 867 dev_set_drvdata(&dev->dev, chip);868 869 if (ignore_ctl_error)870 chip->quirk_flags |= QUIRK_FLAG_IGNORE_CTL_ERROR;871 872 if (chip->quirk_flags & QUIRK_FLAG_DISABLE_AUTOSUSPEND)873 usb_disable_autosuspend(interface_to_usbdev(intf));874 875 /*876 * For devices with more than one control interface, we assume the877 * first contains the audio controls. We might need a more specific878 * check here in the future.879 */880 if (!chip->ctrl_intf)881 chip->ctrl_intf = alts;882 883 err = 1; /* continue */884 if (quirk && quirk->ifnum != QUIRK_NO_INTERFACE) {885 /* need some special handlings */886 err = snd_usb_create_quirk(chip, intf, &usb_audio_driver, quirk);887 if (err < 0)888 goto __error;889 }890 891 if (err > 0) {892 /* create normal USB audio interfaces */893 err = snd_usb_create_streams(chip, ifnum);894 if (err < 0)895 goto __error;896 err = snd_usb_create_mixer(chip, ifnum);897 if (err < 0)898 goto __error;899 }900 901 if (chip->need_delayed_register) {902 dev_info(&dev->dev,903 "Found post-registration device assignment: %08x:%02x\n",904 chip->usb_id, ifnum);905 chip->need_delayed_register = false; /* clear again */906 }907 908 err = try_to_register_card(chip, ifnum);909 if (err < 0)910 goto __error_no_register;911 912 if (chip->quirk_flags & QUIRK_FLAG_SHARE_MEDIA_DEVICE) {913 /* don't want to fail when snd_media_device_create() fails */914 snd_media_device_create(chip, intf);915 }916 917 if (quirk)918 chip->quirk_type = quirk->type;919 920 usb_chip[chip->index] = chip;921 chip->intf[chip->num_interfaces] = intf;922 chip->num_interfaces++;923 usb_set_intfdata(intf, chip);924 atomic_dec(&chip->active);925 mutex_unlock(®ister_mutex);926 return 0;927 928 __error:929 /* in the case of error in secondary interface, still try to register */930 if (chip)931 try_to_register_card(chip, ifnum);932 933 __error_no_register:934 if (chip) {935 /* chip->active is inside the chip->card object,936 * decrement before memory is possibly returned.937 */938 atomic_dec(&chip->active);939 if (!chip->num_interfaces)940 snd_card_free(chip->card);941 }942 mutex_unlock(®ister_mutex);943 return err;944}945 946/*947 * we need to take care of counter, since disconnection can be called also948 * many times as well as usb_audio_probe().949 */950static void usb_audio_disconnect(struct usb_interface *intf)951{952 struct snd_usb_audio *chip = usb_get_intfdata(intf);953 struct snd_card *card;954 struct list_head *p;955 956 if (chip == USB_AUDIO_IFACE_UNUSED)957 return;958 959 card = chip->card;960 961 mutex_lock(®ister_mutex);962 if (atomic_inc_return(&chip->shutdown) == 1) {963 struct snd_usb_stream *as;964 struct snd_usb_endpoint *ep;965 struct usb_mixer_interface *mixer;966 967 /* wait until all pending tasks done;968 * they are protected by snd_usb_lock_shutdown()969 */970 wait_event(chip->shutdown_wait,971 !atomic_read(&chip->usage_count));972 snd_card_disconnect(card);973 /* release the pcm resources */974 list_for_each_entry(as, &chip->pcm_list, list) {975 snd_usb_stream_disconnect(as);976 }977 /* release the endpoint resources */978 list_for_each_entry(ep, &chip->ep_list, list) {979 snd_usb_endpoint_release(ep);980 }981 /* release the midi resources */982 list_for_each(p, &chip->midi_list) {983 snd_usbmidi_disconnect(p);984 }985 snd_usb_midi_v2_disconnect_all(chip);986 /*987 * Nice to check quirk && quirk->shares_media_device and988 * then call the snd_media_device_delete(). Don't have989 * access to the quirk here. snd_media_device_delete()990 * accesses mixer_list991 */992 snd_media_device_delete(chip);993 994 /* release mixer resources */995 list_for_each_entry(mixer, &chip->mixer_list, list) {996 snd_usb_mixer_disconnect(mixer);997 }998 }999 1000 if (chip->quirk_flags & QUIRK_FLAG_DISABLE_AUTOSUSPEND)1001 usb_enable_autosuspend(interface_to_usbdev(intf));1002 1003 chip->num_interfaces--;1004 if (chip->num_interfaces <= 0) {1005 usb_chip[chip->index] = NULL;1006 mutex_unlock(®ister_mutex);1007 snd_card_free_when_closed(card);1008 } else {1009 mutex_unlock(®ister_mutex);1010 }1011}1012 1013/* lock the shutdown (disconnect) task and autoresume */1014int snd_usb_lock_shutdown(struct snd_usb_audio *chip)1015{1016 int err;1017 1018 atomic_inc(&chip->usage_count);1019 if (atomic_read(&chip->shutdown)) {1020 err = -EIO;1021 goto error;1022 }1023 err = snd_usb_autoresume(chip);1024 if (err < 0)1025 goto error;1026 return 0;1027 1028 error:1029 if (atomic_dec_and_test(&chip->usage_count))1030 wake_up(&chip->shutdown_wait);1031 return err;1032}1033 1034/* autosuspend and unlock the shutdown */1035void snd_usb_unlock_shutdown(struct snd_usb_audio *chip)1036{1037 snd_usb_autosuspend(chip);1038 if (atomic_dec_and_test(&chip->usage_count))1039 wake_up(&chip->shutdown_wait);1040}1041 1042int snd_usb_autoresume(struct snd_usb_audio *chip)1043{1044 int i, err;1045 1046 if (atomic_read(&chip->shutdown))1047 return -EIO;1048 if (atomic_inc_return(&chip->active) != 1)1049 return 0;1050 1051 for (i = 0; i < chip->num_interfaces; i++) {1052 err = usb_autopm_get_interface(chip->intf[i]);1053 if (err < 0) {1054 /* rollback */1055 while (--i >= 0)1056 usb_autopm_put_interface(chip->intf[i]);1057 atomic_dec(&chip->active);1058 return err;1059 }1060 }1061 return 0;1062}1063 1064void snd_usb_autosuspend(struct snd_usb_audio *chip)1065{1066 int i;1067 1068 if (atomic_read(&chip->shutdown))1069 return;1070 if (!atomic_dec_and_test(&chip->active))1071 return;1072 1073 for (i = 0; i < chip->num_interfaces; i++)1074 usb_autopm_put_interface(chip->intf[i]);1075}1076 1077static int usb_audio_suspend(struct usb_interface *intf, pm_message_t message)1078{1079 struct snd_usb_audio *chip = usb_get_intfdata(intf);1080 struct snd_usb_stream *as;1081 struct snd_usb_endpoint *ep;1082 struct usb_mixer_interface *mixer;1083 struct list_head *p;1084 1085 if (chip == USB_AUDIO_IFACE_UNUSED)1086 return 0;1087 1088 if (!chip->num_suspended_intf++) {1089 list_for_each_entry(as, &chip->pcm_list, list)1090 snd_usb_pcm_suspend(as);1091 list_for_each_entry(ep, &chip->ep_list, list)1092 snd_usb_endpoint_suspend(ep);1093 list_for_each(p, &chip->midi_list)1094 snd_usbmidi_suspend(p);1095 list_for_each_entry(mixer, &chip->mixer_list, list)1096 snd_usb_mixer_suspend(mixer);1097 snd_usb_midi_v2_suspend_all(chip);1098 }1099 1100 if (!PMSG_IS_AUTO(message) && !chip->system_suspend) {1101 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D3hot);1102 chip->system_suspend = chip->num_suspended_intf;1103 }1104 1105 return 0;1106}1107 1108static int usb_audio_resume(struct usb_interface *intf)1109{1110 struct snd_usb_audio *chip = usb_get_intfdata(intf);1111 struct snd_usb_stream *as;1112 struct usb_mixer_interface *mixer;1113 struct list_head *p;1114 int err = 0;1115 1116 if (chip == USB_AUDIO_IFACE_UNUSED)1117 return 0;1118 1119 atomic_inc(&chip->active); /* avoid autopm */1120 if (chip->num_suspended_intf > 1)1121 goto out;1122 1123 list_for_each_entry(as, &chip->pcm_list, list) {1124 err = snd_usb_pcm_resume(as);1125 if (err < 0)1126 goto err_out;1127 }1128 1129 /*1130 * ALSA leaves material resumption to user space1131 * we just notify and restart the mixers1132 */1133 list_for_each_entry(mixer, &chip->mixer_list, list) {1134 err = snd_usb_mixer_resume(mixer);1135 if (err < 0)1136 goto err_out;1137 }1138 1139 list_for_each(p, &chip->midi_list) {1140 snd_usbmidi_resume(p);1141 }1142 1143 snd_usb_midi_v2_resume_all(chip);1144 1145 out:1146 if (chip->num_suspended_intf == chip->system_suspend) {1147 snd_power_change_state(chip->card, SNDRV_CTL_POWER_D0);1148 chip->system_suspend = 0;1149 }1150 chip->num_suspended_intf--;1151 1152err_out:1153 atomic_dec(&chip->active); /* allow autopm after this point */1154 return err;1155}1156 1157static const struct usb_device_id usb_audio_ids [] = {1158#include "quirks-table.h"1159 { .match_flags = (USB_DEVICE_ID_MATCH_INT_CLASS | USB_DEVICE_ID_MATCH_INT_SUBCLASS),1160 .bInterfaceClass = USB_CLASS_AUDIO,1161 .bInterfaceSubClass = USB_SUBCLASS_AUDIOCONTROL },1162 { } /* Terminating entry */1163};1164MODULE_DEVICE_TABLE(usb, usb_audio_ids);1165 1166/*1167 * entry point for linux usb interface1168 */1169 1170static struct usb_driver usb_audio_driver = {1171 .name = "snd-usb-audio",1172 .probe = usb_audio_probe,1173 .disconnect = usb_audio_disconnect,1174 .suspend = usb_audio_suspend,1175 .resume = usb_audio_resume,1176 .reset_resume = usb_audio_resume,1177 .id_table = usb_audio_ids,1178 .supports_autosuspend = 1,1179};1180 1181module_usb_driver(usb_audio_driver);1182