1 // SPDX-License-Identifier: GPL-2.0-or-later 2 // 3 // Special handling for implicit feedback mode 4 // 5 6 #include <linux/init.h> 7 #include <linux/usb.h> 8 #include <linux/usb/audio.h> 9 #include <linux/usb/audio-v2.h> 10 11 #include <sound/core.h> 12 #include <sound/pcm.h> 13 #include <sound/pcm_params.h> 14 15 #include "usbaudio.h" 16 #include "card.h" 17 #include "helper.h" 18 #include "implicit.h" 19 20 enum { 21 IMPLICIT_FB_NONE, 22 IMPLICIT_FB_GENERIC, 23 IMPLICIT_FB_FIXED, 24 }; 25 26 struct snd_usb_implicit_fb_match { 27 unsigned int id; 28 unsigned int iface_class; 29 unsigned int ep_num; 30 unsigned int iface; 31 int type; 32 }; 33 34 #define IMPLICIT_FB_GENERIC_DEV(vend, prod) \ 35 { .id = USB_ID(vend, prod), .type = IMPLICIT_FB_GENERIC } 36 #define IMPLICIT_FB_FIXED_DEV(vend, prod, ep, ifnum) \ 37 { .id = USB_ID(vend, prod), .type = IMPLICIT_FB_FIXED, .ep_num = (ep),\ 38 .iface = (ifnum) } 39 #define IMPLICIT_FB_SKIP_DEV(vend, prod) \ 40 { .id = USB_ID(vend, prod), .type = IMPLICIT_FB_NONE } 41 42 /* Implicit feedback quirk table for playback */ 43 static const struct snd_usb_implicit_fb_match playback_implicit_fb_quirks[] = { 44 /* Generic matching */ 45 IMPLICIT_FB_GENERIC_DEV(0x0499, 0x1509), /* Steinberg UR22 */ 46 IMPLICIT_FB_GENERIC_DEV(0x0763, 0x2080), /* M-Audio FastTrack Ultra */ 47 IMPLICIT_FB_GENERIC_DEV(0x0763, 0x2081), /* M-Audio FastTrack Ultra */ 48 IMPLICIT_FB_GENERIC_DEV(0x0763, 0x2030), /* M-Audio Fast Track C400 */ 49 IMPLICIT_FB_GENERIC_DEV(0x0763, 0x2031), /* M-Audio Fast Track C600 */ 50 51 /* Fixed EP */ 52 /* FIXME: check the availability of generic matching */ 53 IMPLICIT_FB_FIXED_DEV(0x1397, 0x0001, 0x81, 1), /* Behringer UFX1604 */ 54 IMPLICIT_FB_FIXED_DEV(0x1397, 0x0002, 0x81, 1), /* Behringer UFX1204 */ 55 IMPLICIT_FB_FIXED_DEV(0x2466, 0x8010, 0x81, 2), /* Fractal Audio Axe-Fx III */ 56 IMPLICIT_FB_FIXED_DEV(0x31e9, 0x0001, 0x81, 2), /* Solid State Logic SSL2 */ 57 IMPLICIT_FB_FIXED_DEV(0x31e9, 0x0002, 0x81, 2), /* Solid State Logic SSL2+ */ 58 IMPLICIT_FB_FIXED_DEV(0x0499, 0x172f, 0x81, 2), /* Steinberg UR22C */ 59 IMPLICIT_FB_FIXED_DEV(0x0d9a, 0x00df, 0x81, 2), /* RTX6001 */ 60 IMPLICIT_FB_FIXED_DEV(0x22f0, 0x0006, 0x81, 3), /* Allen&Heath Qu-16 */ 61 IMPLICIT_FB_FIXED_DEV(0x1686, 0xf029, 0x82, 2), /* Zoom UAC-2 */ 62 IMPLICIT_FB_FIXED_DEV(0x2466, 0x8003, 0x86, 2), /* Fractal Audio Axe-Fx II */ 63 IMPLICIT_FB_FIXED_DEV(0x0499, 0x172a, 0x86, 2), /* Yamaha MODX */ 64 65 /* Special matching */ 66 { .id = USB_ID(0x07fd, 0x0004), .iface_class = USB_CLASS_AUDIO, 67 .type = IMPLICIT_FB_NONE }, /* MicroBook IIc */ 68 /* ep = 0x84, ifnum = 0 */ 69 { .id = USB_ID(0x07fd, 0x0004), .iface_class = USB_CLASS_VENDOR_SPEC, 70 .type = IMPLICIT_FB_FIXED, 71 .ep_num = 0x84, .iface = 0 }, /* MOTU MicroBook II */ 72 73 /* No quirk for playback but with capture quirk (see below) */ 74 IMPLICIT_FB_SKIP_DEV(0x0582, 0x0130), /* BOSS BR-80 */ 75 IMPLICIT_FB_SKIP_DEV(0x0582, 0x0171), /* BOSS RC-505 */ 76 IMPLICIT_FB_SKIP_DEV(0x0582, 0x0189), /* BOSS GT-100v2 */ 77 IMPLICIT_FB_SKIP_DEV(0x0582, 0x01d6), /* BOSS GT-1 */ 78 IMPLICIT_FB_SKIP_DEV(0x0582, 0x01d8), /* BOSS Katana */ 79 IMPLICIT_FB_SKIP_DEV(0x0582, 0x01e5), /* BOSS GT-001 */ 80 IMPLICIT_FB_SKIP_DEV(0x0582, 0x0203), /* BOSS AD-10 */ 81 82 {} /* terminator */ 83 }; 84 85 /* Implicit feedback quirk table for capture: only FIXED type */ 86 static const struct snd_usb_implicit_fb_match capture_implicit_fb_quirks[] = { 87 IMPLICIT_FB_FIXED_DEV(0x0582, 0x0130, 0x0d, 0x01), /* BOSS BR-80 */ 88 IMPLICIT_FB_FIXED_DEV(0x0582, 0x0171, 0x0d, 0x01), /* BOSS RC-505 */ 89 IMPLICIT_FB_FIXED_DEV(0x0582, 0x0189, 0x0d, 0x01), /* BOSS GT-100v2 */ 90 IMPLICIT_FB_FIXED_DEV(0x0582, 0x01d6, 0x0d, 0x01), /* BOSS GT-1 */ 91 IMPLICIT_FB_FIXED_DEV(0x0582, 0x01d8, 0x0d, 0x01), /* BOSS Katana */ 92 IMPLICIT_FB_FIXED_DEV(0x0582, 0x01e5, 0x0d, 0x01), /* BOSS GT-001 */ 93 IMPLICIT_FB_FIXED_DEV(0x0582, 0x0203, 0x0d, 0x01), /* BOSS AD-10 */ 94 95 {} /* terminator */ 96 }; 97 98 /* set up sync EP information on the audioformat */ 99 static int add_implicit_fb_sync_ep(struct snd_usb_audio *chip, 100 struct audioformat *fmt, 101 int ep, int ep_idx, int ifnum, 102 const struct usb_host_interface *alts) 103 { 104 struct usb_interface *iface; 105 106 if (!alts) { 107 iface = usb_ifnum_to_if(chip->dev, ifnum); 108 if (!iface || iface->num_altsetting < 2) 109 return 0; 110 alts = &iface->altsetting[1]; 111 } 112 113 fmt->sync_ep = ep; 114 fmt->sync_iface = ifnum; 115 fmt->sync_altsetting = alts->desc.bAlternateSetting; 116 fmt->sync_ep_idx = ep_idx; 117 fmt->implicit_fb = 1; 118 usb_audio_dbg(chip, 119 "%d:%d: added %s implicit_fb sync_ep %x, iface %d:%d\n", 120 fmt->iface, fmt->altsetting, 121 (ep & USB_DIR_IN) ? "playback" : "capture", 122 fmt->sync_ep, fmt->sync_iface, fmt->sync_altsetting); 123 return 1; 124 } 125 126 /* Check whether the given UAC2 iface:altset points to an implicit fb source */ 127 static int add_generic_uac2_implicit_fb(struct snd_usb_audio *chip, 128 struct audioformat *fmt, 129 unsigned int ifnum, 130 unsigned int altsetting) 131 { 132 struct usb_host_interface *alts; 133 struct usb_endpoint_descriptor *epd; 134 135 alts = snd_usb_get_host_interface(chip, ifnum, altsetting); 136 if (!alts) 137 return 0; 138 if (alts->desc.bInterfaceClass != USB_CLASS_AUDIO || 139 alts->desc.bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING || 140 alts->desc.bInterfaceProtocol != UAC_VERSION_2 || 141 alts->desc.bNumEndpoints < 1) 142 return 0; 143 epd = get_endpoint(alts, 0); 144 if (!usb_endpoint_is_isoc_in(epd) || 145 (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) != 146 USB_ENDPOINT_USAGE_IMPLICIT_FB) 147 return 0; 148 return add_implicit_fb_sync_ep(chip, fmt, epd->bEndpointAddress, 0, 149 ifnum, alts); 150 } 151 152 /* Like the function above, but specific to Roland with vendor class and hack */ 153 static int add_roland_implicit_fb(struct snd_usb_audio *chip, 154 struct audioformat *fmt, 155 unsigned int ifnum, 156 unsigned int altsetting) 157 { 158 struct usb_host_interface *alts; 159 struct usb_endpoint_descriptor *epd; 160 161 alts = snd_usb_get_host_interface(chip, ifnum, altsetting); 162 if (!alts) 163 return 0; 164 if (alts->desc.bInterfaceClass != USB_CLASS_VENDOR_SPEC || 165 (alts->desc.bInterfaceSubClass != 2 && 166 alts->desc.bInterfaceProtocol != 2) || 167 alts->desc.bNumEndpoints < 1) 168 return 0; 169 epd = get_endpoint(alts, 0); 170 if (!usb_endpoint_is_isoc_in(epd) || 171 (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) != 172 USB_ENDPOINT_USAGE_IMPLICIT_FB) 173 return 0; 174 return add_implicit_fb_sync_ep(chip, fmt, epd->bEndpointAddress, 0, 175 ifnum, alts); 176 } 177 178 /* Pioneer devices: playback and capture streams sharing the same iface/altset 179 */ 180 static int add_pioneer_implicit_fb(struct snd_usb_audio *chip, 181 struct audioformat *fmt, 182 struct usb_host_interface *alts) 183 { 184 struct usb_endpoint_descriptor *epd; 185 186 if (alts->desc.bNumEndpoints != 2) 187 return 0; 188 189 epd = get_endpoint(alts, 1); 190 if (!usb_endpoint_is_isoc_in(epd) || 191 (epd->bmAttributes & USB_ENDPOINT_SYNCTYPE) != USB_ENDPOINT_SYNC_ASYNC || 192 ((epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) != 193 USB_ENDPOINT_USAGE_DATA && 194 (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) != 195 USB_ENDPOINT_USAGE_IMPLICIT_FB)) 196 return 0; 197 return add_implicit_fb_sync_ep(chip, fmt, epd->bEndpointAddress, 1, 198 alts->desc.bInterfaceNumber, alts); 199 } 200 201 static int __add_generic_implicit_fb(struct snd_usb_audio *chip, 202 struct audioformat *fmt, 203 int iface, int altset) 204 { 205 struct usb_host_interface *alts; 206 struct usb_endpoint_descriptor *epd; 207 208 alts = snd_usb_get_host_interface(chip, iface, altset); 209 if (!alts) 210 return 0; 211 212 if ((alts->desc.bInterfaceClass != USB_CLASS_VENDOR_SPEC && 213 alts->desc.bInterfaceClass != USB_CLASS_AUDIO) || 214 alts->desc.bNumEndpoints < 1) 215 return 0; 216 epd = get_endpoint(alts, 0); 217 if (!usb_endpoint_is_isoc_in(epd) || 218 (epd->bmAttributes & USB_ENDPOINT_SYNCTYPE) != USB_ENDPOINT_SYNC_ASYNC) 219 return 0; 220 return add_implicit_fb_sync_ep(chip, fmt, epd->bEndpointAddress, 0, 221 iface, alts); 222 } 223 224 /* More generic quirk: look for the sync EP next to the data EP */ 225 static int add_generic_implicit_fb(struct snd_usb_audio *chip, 226 struct audioformat *fmt, 227 struct usb_host_interface *alts) 228 { 229 if ((fmt->ep_attr & USB_ENDPOINT_SYNCTYPE) != USB_ENDPOINT_SYNC_ASYNC) 230 return 0; 231 232 if (__add_generic_implicit_fb(chip, fmt, 233 alts->desc.bInterfaceNumber + 1, 234 alts->desc.bAlternateSetting)) 235 return 1; 236 return __add_generic_implicit_fb(chip, fmt, 237 alts->desc.bInterfaceNumber - 1, 238 alts->desc.bAlternateSetting); 239 } 240 241 static const struct snd_usb_implicit_fb_match * 242 find_implicit_fb_entry(struct snd_usb_audio *chip, 243 const struct snd_usb_implicit_fb_match *match, 244 const struct usb_host_interface *alts) 245 { 246 for (; match->id; match++) 247 if (match->id == chip->usb_id && 248 (!match->iface_class || 249 (alts->desc.bInterfaceClass == match->iface_class))) 250 return match; 251 252 return NULL; 253 } 254 255 /* Setup an implicit feedback endpoint from a quirk. Returns 0 if no quirk 256 * applies. Returns 1 if a quirk was found. 257 */ 258 static int audioformat_implicit_fb_quirk(struct snd_usb_audio *chip, 259 struct audioformat *fmt, 260 struct usb_host_interface *alts) 261 { 262 const struct snd_usb_implicit_fb_match *p; 263 unsigned int attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE; 264 265 p = find_implicit_fb_entry(chip, playback_implicit_fb_quirks, alts); 266 if (p) { 267 switch (p->type) { 268 case IMPLICIT_FB_GENERIC: 269 return add_generic_implicit_fb(chip, fmt, alts); 270 case IMPLICIT_FB_NONE: 271 return 0; /* No quirk */ 272 case IMPLICIT_FB_FIXED: 273 return add_implicit_fb_sync_ep(chip, fmt, p->ep_num, 0, 274 p->iface, NULL); 275 } 276 } 277 278 /* Generic UAC2 implicit feedback */ 279 if (attr == USB_ENDPOINT_SYNC_ASYNC && 280 alts->desc.bInterfaceClass == USB_CLASS_AUDIO && 281 alts->desc.bInterfaceProtocol == UAC_VERSION_2 && 282 alts->desc.bNumEndpoints == 1) { 283 if (add_generic_uac2_implicit_fb(chip, fmt, 284 alts->desc.bInterfaceNumber + 1, 285 alts->desc.bAlternateSetting)) 286 return 1; 287 } 288 289 /* Roland/BOSS implicit feedback with vendor spec class */ 290 if (attr == USB_ENDPOINT_SYNC_ASYNC && 291 alts->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC && 292 alts->desc.bInterfaceProtocol == 2 && 293 alts->desc.bNumEndpoints == 1 && 294 USB_ID_VENDOR(chip->usb_id) == 0x0582 /* Roland */) { 295 if (add_roland_implicit_fb(chip, fmt, 296 alts->desc.bInterfaceNumber + 1, 297 alts->desc.bAlternateSetting)) 298 return 1; 299 } 300 301 /* Pioneer devices implicit feedback with vendor spec class */ 302 if (attr == USB_ENDPOINT_SYNC_ASYNC && 303 alts->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC && 304 USB_ID_VENDOR(chip->usb_id) == 0x2b73 /* Pioneer */) { 305 if (add_pioneer_implicit_fb(chip, fmt, alts)) 306 return 1; 307 } 308 309 /* Try the generic implicit fb if available */ 310 if (chip->generic_implicit_fb) 311 return add_generic_implicit_fb(chip, fmt, alts); 312 313 /* No quirk */ 314 return 0; 315 } 316 317 /* same for capture, but only handling FIXED entry */ 318 static int audioformat_capture_quirk(struct snd_usb_audio *chip, 319 struct audioformat *fmt, 320 struct usb_host_interface *alts) 321 { 322 const struct snd_usb_implicit_fb_match *p; 323 324 p = find_implicit_fb_entry(chip, capture_implicit_fb_quirks, alts); 325 if (p && p->type == IMPLICIT_FB_FIXED) 326 return add_implicit_fb_sync_ep(chip, fmt, p->ep_num, 0, 327 p->iface, NULL); 328 return 0; 329 } 330 331 /* 332 * Parse altset and set up implicit feedback endpoint on the audioformat 333 */ 334 int snd_usb_parse_implicit_fb_quirk(struct snd_usb_audio *chip, 335 struct audioformat *fmt, 336 struct usb_host_interface *alts) 337 { 338 if (fmt->endpoint & USB_DIR_IN) 339 return audioformat_capture_quirk(chip, fmt, alts); 340 else 341 return audioformat_implicit_fb_quirk(chip, fmt, alts); 342 } 343 344 /* 345 * Return the score of matching two audioformats. 346 * Veto the audioformat if: 347 * - It has no channels for some reason. 348 * - Requested PCM format is not supported. 349 * - Requested sample rate is not supported. 350 */ 351 static int match_endpoint_audioformats(struct snd_usb_substream *subs, 352 const struct audioformat *fp, 353 int rate, int channels, 354 snd_pcm_format_t pcm_format) 355 { 356 int i, score; 357 358 if (fp->channels < 1) 359 return 0; 360 361 if (!(fp->formats & pcm_format_to_bits(pcm_format))) 362 return 0; 363 364 if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) { 365 if (rate < fp->rate_min || rate > fp->rate_max) 366 return 0; 367 } else { 368 for (i = 0; i < fp->nr_rates; i++) { 369 if (fp->rate_table[i] == rate) 370 break; 371 } 372 if (i >= fp->nr_rates) 373 return 0; 374 } 375 376 score = 1; 377 if (fp->channels == channels) 378 score++; 379 380 return score; 381 } 382 383 static struct snd_usb_substream * 384 find_matching_substream(struct snd_usb_audio *chip, int stream, int ep_num, 385 int fmt_type) 386 { 387 struct snd_usb_stream *as; 388 struct snd_usb_substream *subs; 389 390 list_for_each_entry(as, &chip->pcm_list, list) { 391 subs = &as->substream[stream]; 392 if (as->fmt_type == fmt_type && subs->ep_num == ep_num) 393 return subs; 394 } 395 396 return NULL; 397 } 398 399 /* 400 * Return the audioformat that is suitable for the implicit fb 401 */ 402 const struct audioformat * 403 snd_usb_find_implicit_fb_sync_format(struct snd_usb_audio *chip, 404 const struct audioformat *target, 405 const struct snd_pcm_hw_params *params, 406 int stream) 407 { 408 struct snd_usb_substream *subs; 409 const struct audioformat *fp, *sync_fmt = NULL; 410 int score, high_score; 411 412 /* Use the original audioformat as fallback for the shared altset */ 413 if (target->iface == target->sync_iface && 414 target->altsetting == target->sync_altsetting) 415 sync_fmt = target; 416 417 subs = find_matching_substream(chip, stream, target->sync_ep, 418 target->fmt_type); 419 if (!subs) 420 return sync_fmt; 421 422 high_score = 0; 423 list_for_each_entry(fp, &subs->fmt_list, list) { 424 score = match_endpoint_audioformats(subs, fp, 425 params_rate(params), 426 params_channels(params), 427 params_format(params)); 428 if (score > high_score) { 429 sync_fmt = fp; 430 high_score = score; 431 } 432 } 433 434 return sync_fmt; 435 } 436 437