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(0x2b73, 0x000a, 0x82, 0), /* Pioneer DJ DJM-900NXS2 */
  62         IMPLICIT_FB_FIXED_DEV(0x2b73, 0x0017, 0x82, 0), /* Pioneer DJ DJM-250MK2 */
  63         IMPLICIT_FB_FIXED_DEV(0x1686, 0xf029, 0x82, 2), /* Zoom UAC-2 */
  64         IMPLICIT_FB_FIXED_DEV(0x2466, 0x8003, 0x86, 2), /* Fractal Audio Axe-Fx II */
  65         IMPLICIT_FB_FIXED_DEV(0x0499, 0x172a, 0x86, 2), /* Yamaha MODX */
  66
  67         /* Special matching */
  68         { .id = USB_ID(0x07fd, 0x0004), .iface_class = USB_CLASS_AUDIO,
  69           .type = IMPLICIT_FB_NONE },           /* MicroBook IIc */
  70         /* ep = 0x84, ifnum = 0 */
  71         { .id = USB_ID(0x07fd, 0x0004), .iface_class = USB_CLASS_VENDOR_SPEC,
  72           .type = IMPLICIT_FB_FIXED,
  73           .ep_num = 0x84, .iface = 0 },         /* MOTU MicroBook II */
  74
  75         /* No quirk for playback but with capture quirk (see below) */
  76         IMPLICIT_FB_SKIP_DEV(0x0582, 0x0130),   /* BOSS BR-80 */
  77         IMPLICIT_FB_SKIP_DEV(0x0582, 0x0189),   /* BOSS GT-100v2 */
  78         IMPLICIT_FB_SKIP_DEV(0x0582, 0x01d6),   /* BOSS GT-1 */
  79         IMPLICIT_FB_SKIP_DEV(0x0582, 0x01d8),   /* BOSS Katana */
  80         IMPLICIT_FB_SKIP_DEV(0x0582, 0x01e5),   /* BOSS GT-001 */
  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, 0x0189, 0x0d, 0x01), /* BOSS GT-100v2 */
  89         IMPLICIT_FB_FIXED_DEV(0x0582, 0x01d6, 0x0d, 0x01), /* BOSS GT-1 */
  90         IMPLICIT_FB_FIXED_DEV(0x0582, 0x01d8, 0x0d, 0x01), /* BOSS Katana */
  91         IMPLICIT_FB_FIXED_DEV(0x0582, 0x01e5, 0x0d, 0x01), /* BOSS GT-001 */
  92
  93         {} /* terminator */
  94 };
  95
  96 /* set up sync EP information on the audioformat */
  97 static int add_implicit_fb_sync_ep(struct snd_usb_audio *chip,
  98                                    struct audioformat *fmt,
  99                                    int ep, int ifnum,
 100                                    const struct usb_host_interface *alts)
 101 {
 102         struct usb_interface *iface;
 103
 104         if (!alts) {
 105                 iface = usb_ifnum_to_if(chip->dev, ifnum);
 106                 if (!iface || iface->num_altsetting < 2)
 107                         return 0;
 108                 alts = &iface->altsetting[1];
 109         }
 110
 111         fmt->sync_ep = ep;
 112         fmt->sync_iface = ifnum;
 113         fmt->sync_altsetting = alts->desc.bAlternateSetting;
 114         fmt->sync_ep_idx = 0;
 115         fmt->implicit_fb = 1;
 116         usb_audio_dbg(chip,
 117                       "%d:%d: added %s implicit_fb sync_ep %x, iface %d:%d\n",
 118                       fmt->iface, fmt->altsetting,
 119                       (ep & USB_DIR_IN) ? "playback" : "capture",
 120                       fmt->sync_ep, fmt->sync_iface, fmt->sync_altsetting);
 121         return 1;
 122 }
 123
 124 /* Check whether the given UAC2 iface:altset points to an implicit fb source */
 125 static int add_generic_uac2_implicit_fb(struct snd_usb_audio *chip,
 126                                         struct audioformat *fmt,
 127                                         unsigned int ifnum,
 128                                         unsigned int altsetting)
 129 {
 130         struct usb_host_interface *alts;
 131         struct usb_endpoint_descriptor *epd;
 132
 133         alts = snd_usb_get_host_interface(chip, ifnum, altsetting);
 134         if (!alts)
 135                 return 0;
 136         if (alts->desc.bInterfaceClass != USB_CLASS_AUDIO ||
 137             alts->desc.bInterfaceSubClass != USB_SUBCLASS_AUDIOSTREAMING ||
 138             alts->desc.bInterfaceProtocol != UAC_VERSION_2 ||
 139             alts->desc.bNumEndpoints < 1)
 140                 return 0;
 141         epd = get_endpoint(alts, 0);
 142         if (!usb_endpoint_is_isoc_in(epd) ||
 143             (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) !=
 144                                         USB_ENDPOINT_USAGE_IMPLICIT_FB)
 145                 return 0;
 146         return add_implicit_fb_sync_ep(chip, fmt, epd->bEndpointAddress,
 147                                        ifnum, alts);
 148 }
 149
 150 /* Like the function above, but specific to Roland with vendor class and hack */
 151 static int add_roland_implicit_fb(struct snd_usb_audio *chip,
 152                                   struct audioformat *fmt,
 153                                   unsigned int ifnum,
 154                                   unsigned int altsetting)
 155 {
 156         struct usb_host_interface *alts;
 157         struct usb_endpoint_descriptor *epd;
 158
 159         alts = snd_usb_get_host_interface(chip, ifnum, altsetting);
 160         if (!alts)
 161                 return 0;
 162         if (alts->desc.bInterfaceClass != USB_CLASS_VENDOR_SPEC ||
 163             (alts->desc.bInterfaceSubClass != 2 &&
 164              alts->desc.bInterfaceProtocol != 2) ||
 165             alts->desc.bNumEndpoints < 1)
 166                 return 0;
 167         epd = get_endpoint(alts, 0);
 168         if (!usb_endpoint_is_isoc_in(epd) ||
 169             (epd->bmAttributes & USB_ENDPOINT_USAGE_MASK) !=
 170                                         USB_ENDPOINT_USAGE_IMPLICIT_FB)
 171                 return 0;
 172         return add_implicit_fb_sync_ep(chip, fmt, epd->bEndpointAddress,
 173                                        ifnum, alts);
 174 }
 175
 176
 177 static int __add_generic_implicit_fb(struct snd_usb_audio *chip,
 178                                      struct audioformat *fmt,
 179                                      int iface, int altset)
 180 {
 181         struct usb_host_interface *alts;
 182         struct usb_endpoint_descriptor *epd;
 183
 184         alts = snd_usb_get_host_interface(chip, iface, altset);
 185         if (!alts)
 186                 return 0;
 187
 188         if ((alts->desc.bInterfaceClass != USB_CLASS_VENDOR_SPEC &&
 189              alts->desc.bInterfaceClass != USB_CLASS_AUDIO) ||
 190             alts->desc.bNumEndpoints < 1)
 191                 return 0;
 192         epd = get_endpoint(alts, 0);
 193         if (!usb_endpoint_is_isoc_in(epd) ||
 194             (epd->bmAttributes & USB_ENDPOINT_SYNCTYPE) != USB_ENDPOINT_SYNC_ASYNC)
 195                 return 0;
 196         return add_implicit_fb_sync_ep(chip, fmt, epd->bEndpointAddress,
 197                                        iface, alts);
 198 }
 199
 200 /* More generic quirk: look for the sync EP next to the data EP */
 201 static int add_generic_implicit_fb(struct snd_usb_audio *chip,
 202                                    struct audioformat *fmt,
 203                                    struct usb_host_interface *alts)
 204 {
 205         if ((fmt->ep_attr & USB_ENDPOINT_SYNCTYPE) != USB_ENDPOINT_SYNC_ASYNC)
 206                 return 0;
 207
 208         if (__add_generic_implicit_fb(chip, fmt,
 209                                       alts->desc.bInterfaceNumber + 1,
 210                                       alts->desc.bAlternateSetting))
 211                 return 1;
 212         return __add_generic_implicit_fb(chip, fmt,
 213                                          alts->desc.bInterfaceNumber - 1,
 214                                          alts->desc.bAlternateSetting);
 215 }
 216
 217 static const struct snd_usb_implicit_fb_match *
 218 find_implicit_fb_entry(struct snd_usb_audio *chip,
 219                        const struct snd_usb_implicit_fb_match *match,
 220                        const struct usb_host_interface *alts)
 221 {
 222         for (; match->id; match++)
 223                 if (match->id == chip->usb_id &&
 224                     (!match->iface_class ||
 225                      (alts->desc.bInterfaceClass == match->iface_class)))
 226                         return match;
 227
 228         return NULL;
 229 }
 230
 231 /* Setup an implicit feedback endpoint from a quirk. Returns 0 if no quirk
 232  * applies. Returns 1 if a quirk was found.
 233  */
 234 static int audioformat_implicit_fb_quirk(struct snd_usb_audio *chip,
 235                                          struct audioformat *fmt,
 236                                          struct usb_host_interface *alts)
 237 {
 238         const struct snd_usb_implicit_fb_match *p;
 239         unsigned int attr = fmt->ep_attr & USB_ENDPOINT_SYNCTYPE;
 240
 241         p = find_implicit_fb_entry(chip, playback_implicit_fb_quirks, alts);
 242         if (p) {
 243                 switch (p->type) {
 244                 case IMPLICIT_FB_GENERIC:
 245                         return add_generic_implicit_fb(chip, fmt, alts);
 246                 case IMPLICIT_FB_NONE:
 247                         return 0; /* No quirk */
 248                 case IMPLICIT_FB_FIXED:
 249                         return add_implicit_fb_sync_ep(chip, fmt, p->ep_num,
 250                                                        p->iface, NULL);
 251                 }
 252         }
 253
 254         /* Generic UAC2 implicit feedback */
 255         if (attr == USB_ENDPOINT_SYNC_ASYNC &&
 256             alts->desc.bInterfaceClass == USB_CLASS_AUDIO &&
 257             alts->desc.bInterfaceProtocol == UAC_VERSION_2 &&
 258             alts->desc.bNumEndpoints == 1) {
 259                 if (add_generic_uac2_implicit_fb(chip, fmt,
 260                                                  alts->desc.bInterfaceNumber + 1,
 261                                                  alts->desc.bAlternateSetting))
 262                         return 1;
 263         }
 264
 265         /* Roland/BOSS implicit feedback with vendor spec class */
 266         if (attr == USB_ENDPOINT_SYNC_ASYNC &&
 267             alts->desc.bInterfaceClass == USB_CLASS_VENDOR_SPEC &&
 268             alts->desc.bInterfaceProtocol == 2 &&
 269             alts->desc.bNumEndpoints == 1 &&
 270             USB_ID_VENDOR(chip->usb_id) == 0x0582 /* Roland */) {
 271                 if (add_roland_implicit_fb(chip, fmt,
 272                                            alts->desc.bInterfaceNumber + 1,
 273                                            alts->desc.bAlternateSetting))
 274                         return 1;
 275         }
 276
 277         /* Try the generic implicit fb if available */
 278         if (chip->generic_implicit_fb)
 279                 return add_generic_implicit_fb(chip, fmt, alts);
 280
 281         /* No quirk */
 282         return 0;
 283 }
 284
 285 /* same for capture, but only handling FIXED entry */
 286 static int audioformat_capture_quirk(struct snd_usb_audio *chip,
 287                                      struct audioformat *fmt,
 288                                      struct usb_host_interface *alts)
 289 {
 290         const struct snd_usb_implicit_fb_match *p;
 291
 292         p = find_implicit_fb_entry(chip, capture_implicit_fb_quirks, alts);
 293         if (p && p->type == IMPLICIT_FB_FIXED)
 294                 return add_implicit_fb_sync_ep(chip, fmt, p->ep_num, p->iface,
 295                                                NULL);
 296         return 0;
 297 }
 298
 299 /*
 300  * Parse altset and set up implicit feedback endpoint on the audioformat
 301  */
 302 int snd_usb_parse_implicit_fb_quirk(struct snd_usb_audio *chip,
 303                                     struct audioformat *fmt,
 304                                     struct usb_host_interface *alts)
 305 {
 306         if (fmt->endpoint & USB_DIR_IN)
 307                 return audioformat_capture_quirk(chip, fmt, alts);
 308         else
 309                 return audioformat_implicit_fb_quirk(chip, fmt, alts);
 310 }
 311
 312 /*
 313  * Return the score of matching two audioformats.
 314  * Veto the audioformat if:
 315  * - It has no channels for some reason.
 316  * - Requested PCM format is not supported.
 317  * - Requested sample rate is not supported.
 318  */
 319 static int match_endpoint_audioformats(struct snd_usb_substream *subs,
 320                                        const struct audioformat *fp,
 321                                        int rate, int channels,
 322                                        snd_pcm_format_t pcm_format)
 323 {
 324         int i, score;
 325
 326         if (fp->channels < 1)
 327                 return 0;
 328
 329         if (!(fp->formats & pcm_format_to_bits(pcm_format)))
 330                 return 0;
 331
 332         if (fp->rates & SNDRV_PCM_RATE_CONTINUOUS) {
 333                 if (rate < fp->rate_min || rate > fp->rate_max)
 334                         return 0;
 335         } else {
 336                 for (i = 0; i < fp->nr_rates; i++) {
 337                         if (fp->rate_table[i] == rate)
 338                                 break;
 339                 }
 340                 if (i >= fp->nr_rates)
 341                         return 0;
 342         }
 343
 344         score = 1;
 345         if (fp->channels == channels)
 346                 score++;
 347
 348         return score;
 349 }
 350
 351 static struct snd_usb_substream *
 352 find_matching_substream(struct snd_usb_audio *chip, int stream, int ep_num,
 353                         int fmt_type)
 354 {
 355         struct snd_usb_stream *as;
 356         struct snd_usb_substream *subs;
 357
 358         list_for_each_entry(as, &chip->pcm_list, list) {
 359                 subs = &as->substream[stream];
 360                 if (as->fmt_type == fmt_type && subs->ep_num == ep_num)
 361                         return subs;
 362         }
 363
 364         return NULL;
 365 }
 366
 367 /*
 368  * Return the audioformat that is suitable for the implicit fb
 369  */
 370 const struct audioformat *
 371 snd_usb_find_implicit_fb_sync_format(struct snd_usb_audio *chip,
 372                                      const struct audioformat *target,
 373                                      const struct snd_pcm_hw_params *params,
 374                                      int stream)
 375 {
 376         struct snd_usb_substream *subs;
 377         const struct audioformat *fp, *sync_fmt;
 378         int score, high_score;
 379
 380         /* When sharing the same altset, use the original audioformat */
 381         if (target->iface == target->sync_iface &&
 382             target->altsetting == target->sync_altsetting)
 383                 return target;
 384
 385         subs = find_matching_substream(chip, stream, target->sync_ep,
 386                                        target->fmt_type);
 387         if (!subs)
 388                 return NULL;
 389
 390         sync_fmt = NULL;
 391         high_score = 0;
 392         list_for_each_entry(fp, &subs->fmt_list, list) {
 393                 score = match_endpoint_audioformats(subs, fp,
 394                                                     params_rate(params),
 395                                                     params_channels(params),
 396                                                     params_format(params));
 397                 if (score > high_score) {
 398                         sync_fmt = fp;
 399                         high_score = score;
 400                 }
 401         }
 402
 403         return sync_fmt;
 404 }
 405