sound/usb/implicit.c

   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 /* Playback and capture EPs on Pioneer devices share the same iface/altset,
 179  * but they don't seem working with the implicit fb mode well, hence we
 180  * just return as if the sync were already set up.
 181  */
 182 static int skip_pioneer_sync_ep(struct snd_usb_audio *chip,
 183                                 struct audioformat *fmt,
 184                                 struct usb_host_interface *alts)
 185 {
 186         struct usb_endpoint_descriptor *epd;
 187
 188         if (alts->desc.bNumEndpoints != 2)
 189                 return 0;
 190
 191         epd = get_endpoint(alts, 1);
 192         if (!usb_endpoint_is_isoc_in(epd) ||
 193             (epd->bmAttributes & USB_ENDPOINT_SYNCTYPE) != USB_ENDPOINT_SYNC_ASYNC ||
 194             ((epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) !=
 195              USB_ENDPOINT_USAGE_DATA &&
 196              (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) !=
 197              USB_ENDPOINT_USAGE_IMPLICIT_FB))
 198                 return 0;
 199         return 1; /* don't handle with the implicit fb, just skip sync EP */
 200 }
 201
 202 static int __add_generic_implicit_fb(struct snd_usb_audio *chip,
 203                                      struct audioformat *fmt,
 204                                      int iface, int altset)
 205 {
 206         struct usb_host_interface *alts;
 207         struct usb_endpoint_descriptor *epd;
 208
 209         alts = snd_usb_get_host_interface(chip, iface, altset);
 210         if (!alts)
 211                 return 0;
 212
 213         if ((alts->desc.bInterfaceClass != USB_CLASS_VENDOR_SPEC &&
 214              alts->desc.bInterfaceClass != USB_CLASS_AUDIO) ||
 215             alts->desc.bNumEndpoints < 1)
 216                 return 0;
 217         epd = get_endpoint(alts, 0);
 218         if (!usb_endpoint_is_isoc_in(epd) ||
 219             (epd->bmAttributes & USB_ENDPOINT_SYNCTYPE) != USB_ENDPOINT_SYNC_ASYNC)
 220                 return 0;
 221         return add_implicit_fb_sync_ep(chip, fmt, epd->bEndpointAddress, 0,
 222                                        iface, alts);
 223 }
 224
 225 /* More generic quirk: look for the sync EP next to the data EP */
 226 static int add_generic_implicit_fb(struct snd_usb_audio *chip,
 227                                    struct audioformat *fmt,
 228                                    struct usb_host_interface *alts)
 229 {
 230         if ((fmt->ep_attr & USB_ENDPOINT_SYNCTYPE) != USB_ENDPOINT_SYNC_ASYNC)
 231                 return 0;
 232
 233         if (__add_generic_implicit_fb(chip, fmt,
 234                                       alts->desc.bInterfaceNumber + 1,
 235                                       alts->desc.bAlternateSetting))
 236                 return 1;
 237         return __add_generic_implicit_fb(chip, fmt,
 238                                          alts->desc.bInterfaceNumber - 1,
 239                                          alts->desc.bAlternateSetting);
 240 }
 241
 242 static const struct snd_usb_implicit_fb_match *
 243 find_implicit_fb_entry(struct snd_usb_audio *chip,
 244                        const struct snd_usb_implicit_fb_match *match,
 245                        const struct usb_host_interface *alts)
 246 {
 247         for (; match->id; match++)
 248                 if (match->id == chip->usb_id &&
 249                     (!match->iface_class ||
 250                      (alts->desc.bInterfaceClass == match->iface_class)))
 251                         return match;
 252
 253         return NULL;
 254 }
 255
 256 /* Setup an implicit feedback endpoint from a quirk. Returns 0 if no quirk
 257  * applies. Returns 1 if a quirk was found.
 258  */
 259 static int audioformat_implicit_fb_quirk(struct snd_usb_audio *chip,
 260                                          struct audioformat *fmt,
 261                                          struct usb_host_interface *alts)
 262 {
 263         const struct snd_usb_implicit_fb_match *p;
 264         unsigned int attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
 265
 266         p = find_implicit_fb_entry(chip, playback_implicit_fb_quirks, alts);
 267         if (p) {
 268                 switch (p->type) {
 269                 case IMPLICIT_FB_GENERIC:
 270                         return add_generic_implicit_fb(chip, fmt, alts);
 271                 case IMPLICIT_FB_NONE:
 272                         return 0; /* No quirk */
 273                 case IMPLICIT_FB_FIXED:
 274                         return add_implicit_fb_sync_ep(chip, fmt, p->ep_num, 0,
 275                                                        p->iface, NULL);
 276                 }
 277         }
 278
 279         /* Generic UAC2 implicit feedback */
 280         if (attr == USB_ENDPOINT_SYNC_ASYNC &&
 281             alts->desc.bInterfaceClass == USB_CLASS_AUDIO &&
 282             alts->desc.bInterfaceProtocol == UAC_VERSION_2 &&
 283             alts->desc.bNumEndpoints == 1) {
 284                 if (add_generic_uac2_implicit_fb(chip, fmt,
 285                                                  alts->desc.bInterfaceNumber + 1,
 286                                                  alts->desc.bAlternateSetting))
 287                         return 1;
 288         }
 289
 290         /* Roland/BOSS implicit feedback with vendor spec class */
 291         if (attr == USB_ENDPOINT_SYNC_ASYNC &&
 292             alts->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
 293             alts->desc.bInterfaceProtocol == 2 &&
 294             alts->desc.bNumEndpoints == 1 &&
 295             USB_ID_VENDOR(chip->usb_id) == 0x0582 /* Roland */) {
 296                 if (add_roland_implicit_fb(chip, fmt,
 297                                            alts->desc.bInterfaceNumber + 1,
 298                                            alts->desc.bAlternateSetting))
 299                         return 1;
 300         }
 301
 302         /* Pioneer devices with vendor spec class */
 303         if (attr == USB_ENDPOINT_SYNC_ASYNC &&
 304             alts->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
 305             (USB_ID_VENDOR(chip->usb_id) == 0x2b73 || /* Pioneer */
 306              USB_ID_VENDOR(chip->usb_id) == 0x08e4    /* Pioneer */)) {
 307                 if (skip_pioneer_sync_ep(chip, fmt, alts))
 308                         return 1;
 309         }
 310
 311         /* Try the generic implicit fb if available */
 312         if (chip->generic_implicit_fb)
 313                 return add_generic_implicit_fb(chip, fmt, alts);
 314
 315         /* No quirk */
 316         return 0;
 317 }
 318
 319 /* same for capture, but only handling FIXED entry */
 320 static int audioformat_capture_quirk(struct snd_usb_audio *chip,
 321                                      struct audioformat *fmt,
 322                                      struct usb_host_interface *alts)
 323 {
 324         const struct snd_usb_implicit_fb_match *p;
 325
 326         p = find_implicit_fb_entry(chip, capture_implicit_fb_quirks, alts);
 327         if (p && p->type == IMPLICIT_FB_FIXED)
 328                 return add_implicit_fb_sync_ep(chip, fmt, p->ep_num, 0,
 329                                                p->iface, NULL);
 330         return 0;
 331 }
 332
 333 /*
 334  * Parse altset and set up implicit feedback endpoint on the audioformat
 335  */
 336 int snd_usb_parse_implicit_fb_quirk(struct snd_usb_audio *chip,
 337                                     struct audioformat *fmt,
 338                                     struct usb_host_interface *alts)
 339 {
 340         if (fmt->endpoint & USB_DIR_IN)
 341                 return audioformat_capture_quirk(chip, fmt, alts);
 342         else
 343                 return audioformat_implicit_fb_quirk(chip, fmt, alts);
 344 }
 345
 346 /*
 347  * Return the score of matching two audioformats.
 348  * Veto the audioformat if:
 349  * - It has no channels for some reason.
 350  * - Requested PCM format is not supported.
 351  * - Requested sample rate is not supported.
 352  */
 353 static int match_endpoint_audioformats(struct snd_usb_substream *subs,
 354                                        const struct audioformat *fp,
 355                                        int rate, int channels,
 356                                        snd_pcm_format_t pcm_format)
 357 {
 358         int i, score;
 359
 360         if (fp->channels < 1)
 361                 return 0;
 362
 363         if (!(fp->formats & pcm_format_to_bits(pcm_format)))
 364                 return 0;
 365
 366         if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
 367                 if (rate < fp->rate_min || rate > fp->rate_max)
 368                         return 0;
 369         } else {
 370                 for (i = 0; i < fp->nr_rates; i++) {
 371                         if (fp->rate_table[i] == rate)
 372                                 break;
 373                 }
 374                 if (i >= fp->nr_rates)
 375                         return 0;
 376         }
 377
 378         score = 1;
 379         if (fp->channels == channels)
 380                 score++;
 381
 382         return score;
 383 }
 384
 385 static struct snd_usb_substream *
 386 find_matching_substream(struct snd_usb_audio *chip, int stream, int ep_num,
 387                         int fmt_type)
 388 {
 389         struct snd_usb_stream *as;
 390         struct snd_usb_substream *subs;
 391
 392         list_for_each_entry(as, &chip->pcm_list, list) {
 393                 subs = &as->substream[stream];
 394                 if (as->fmt_type == fmt_type && subs->ep_num == ep_num)
 395                         return subs;
 396         }
 397
 398         return NULL;
 399 }
 400
 401 /*
 402  * Return the audioformat that is suitable for the implicit fb
 403  */
 404 const struct audioformat *
 405 snd_usb_find_implicit_fb_sync_format(struct snd_usb_audio *chip,
 406                                      const struct audioformat *target,
 407                                      const struct snd_pcm_hw_params *params,
 408                                      int stream)
 409 {
 410         struct snd_usb_substream *subs;
 411         const struct audioformat *fp, *sync_fmt = NULL;
 412         int score, high_score;
 413
 414         /* Use the original audioformat as fallback for the shared altset */
 415         if (target->iface == target->sync_iface &&
 416             target->altsetting == target->sync_altsetting)
 417                 sync_fmt = target;
 418
 419         subs = find_matching_substream(chip, stream, target->sync_ep,
 420                                        target->fmt_type);
 421         if (!subs)
 422                 return sync_fmt;
 423
 424         high_score = 0;
 425         list_for_each_entry(fp, &subs->fmt_list, list) {
 426                 score = match_endpoint_audioformats(subs, fp,
 427                                                     params_rate(params),
 428                                                     params_channels(params),
 429                                                     params_format(params));
 430                 if (score > high_score) {
 431                         sync_fmt = fp;
 432                         high_score = score;
 433                 }
 434         }
 435
 436         return sync_fmt;
 437 }
 438