linux/sound/usb/mixer.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0-or-later
   2/*
   3 *   (Tentative) USB Audio Driver for ALSA
   4 *
   5 *   Mixer control part
   6 *
   7 *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
   8 *
   9 *   Many codes borrowed from audio.c by
  10 *          Alan Cox (alan@lxorguk.ukuu.org.uk)
  11 *          Thomas Sailer (sailer@ife.ee.ethz.ch)
  12 */
  13
  14/*
  15 * TODOs, for both the mixer and the streaming interfaces:
  16 *
  17 *  - support for UAC2 effect units
  18 *  - support for graphical equalizers
  19 *  - RANGE and MEM set commands (UAC2)
  20 *  - RANGE and MEM interrupt dispatchers (UAC2)
  21 *  - audio channel clustering (UAC2)
  22 *  - audio sample rate converter units (UAC2)
  23 *  - proper handling of clock multipliers (UAC2)
  24 *  - dispatch clock change notifications (UAC2)
  25 *      - stop PCM streams which use a clock that became invalid
  26 *      - stop PCM streams which use a clock selector that has changed
  27 *      - parse available sample rates again when clock sources changed
  28 */
  29
  30#include <linux/bitops.h>
  31#include <linux/init.h>
  32#include <linux/list.h>
  33#include <linux/log2.h>
  34#include <linux/slab.h>
  35#include <linux/string.h>
  36#include <linux/usb.h>
  37#include <linux/usb/audio.h>
  38#include <linux/usb/audio-v2.h>
  39#include <linux/usb/audio-v3.h>
  40
  41#include <sound/core.h>
  42#include <sound/control.h>
  43#include <sound/hwdep.h>
  44#include <sound/info.h>
  45#include <sound/tlv.h>
  46
  47#include "usbaudio.h"
  48#include "mixer.h"
  49#include "helper.h"
  50#include "mixer_quirks.h"
  51#include "power.h"
  52
  53#define MAX_ID_ELEMS    256
  54
  55struct usb_audio_term {
  56        int id;
  57        int type;
  58        int channels;
  59        unsigned int chconfig;
  60        int name;
  61};
  62
  63struct usbmix_name_map;
  64
  65struct mixer_build {
  66        struct snd_usb_audio *chip;
  67        struct usb_mixer_interface *mixer;
  68        unsigned char *buffer;
  69        unsigned int buflen;
  70        DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
  71        DECLARE_BITMAP(termbitmap, MAX_ID_ELEMS);
  72        struct usb_audio_term oterm;
  73        const struct usbmix_name_map *map;
  74        const struct usbmix_selector_map *selector_map;
  75};
  76
  77/*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
  78enum {
  79        USB_XU_CLOCK_RATE               = 0xe301,
  80        USB_XU_CLOCK_SOURCE             = 0xe302,
  81        USB_XU_DIGITAL_IO_STATUS        = 0xe303,
  82        USB_XU_DEVICE_OPTIONS           = 0xe304,
  83        USB_XU_DIRECT_MONITORING        = 0xe305,
  84        USB_XU_METERING                 = 0xe306
  85};
  86enum {
  87        USB_XU_CLOCK_SOURCE_SELECTOR = 0x02,    /* clock source*/
  88        USB_XU_CLOCK_RATE_SELECTOR = 0x03,      /* clock rate */
  89        USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01,  /* the spdif format */
  90        USB_XU_SOFT_LIMIT_SELECTOR = 0x03       /* soft limiter */
  91};
  92
  93/*
  94 * manual mapping of mixer names
  95 * if the mixer topology is too complicated and the parsed names are
  96 * ambiguous, add the entries in usbmixer_maps.c.
  97 */
  98#include "mixer_maps.c"
  99
 100static const struct usbmix_name_map *
 101find_map(const struct usbmix_name_map *p, int unitid, int control)
 102{
 103        if (!p)
 104                return NULL;
 105
 106        for (; p->id; p++) {
 107                if (p->id == unitid &&
 108                    (!control || !p->control || control == p->control))
 109                        return p;
 110        }
 111        return NULL;
 112}
 113
 114/* get the mapped name if the unit matches */
 115static int
 116check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
 117{
 118        if (!p || !p->name)
 119                return 0;
 120
 121        buflen--;
 122        return strlcpy(buf, p->name, buflen);
 123}
 124
 125/* ignore the error value if ignore_ctl_error flag is set */
 126#define filter_error(cval, err) \
 127        ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
 128
 129/* check whether the control should be ignored */
 130static inline int
 131check_ignored_ctl(const struct usbmix_name_map *p)
 132{
 133        if (!p || p->name || p->dB)
 134                return 0;
 135        return 1;
 136}
 137
 138/* dB mapping */
 139static inline void check_mapped_dB(const struct usbmix_name_map *p,
 140                                   struct usb_mixer_elem_info *cval)
 141{
 142        if (p && p->dB) {
 143                cval->dBmin = p->dB->min;
 144                cval->dBmax = p->dB->max;
 145                cval->initialized = 1;
 146        }
 147}
 148
 149/* get the mapped selector source name */
 150static int check_mapped_selector_name(struct mixer_build *state, int unitid,
 151                                      int index, char *buf, int buflen)
 152{
 153        const struct usbmix_selector_map *p;
 154
 155        if (!state->selector_map)
 156                return 0;
 157        for (p = state->selector_map; p->id; p++) {
 158                if (p->id == unitid && index < p->count)
 159                        return strlcpy(buf, p->names[index], buflen);
 160        }
 161        return 0;
 162}
 163
 164/*
 165 * find an audio control unit with the given unit id
 166 */
 167static void *find_audio_control_unit(struct mixer_build *state,
 168                                     unsigned char unit)
 169{
 170        /* we just parse the header */
 171        struct uac_feature_unit_descriptor *hdr = NULL;
 172
 173        while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
 174                                        USB_DT_CS_INTERFACE)) != NULL) {
 175                if (hdr->bLength >= 4 &&
 176                    hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
 177                    hdr->bDescriptorSubtype <= UAC3_SAMPLE_RATE_CONVERTER &&
 178                    hdr->bUnitID == unit)
 179                        return hdr;
 180        }
 181
 182        return NULL;
 183}
 184
 185/*
 186 * copy a string with the given id
 187 */
 188static int snd_usb_copy_string_desc(struct snd_usb_audio *chip,
 189                                    int index, char *buf, int maxlen)
 190{
 191        int len = usb_string(chip->dev, index, buf, maxlen - 1);
 192
 193        if (len < 0)
 194                return 0;
 195
 196        buf[len] = 0;
 197        return len;
 198}
 199
 200/*
 201 * convert from the byte/word on usb descriptor to the zero-based integer
 202 */
 203static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
 204{
 205        switch (cval->val_type) {
 206        case USB_MIXER_BOOLEAN:
 207                return !!val;
 208        case USB_MIXER_INV_BOOLEAN:
 209                return !val;
 210        case USB_MIXER_U8:
 211                val &= 0xff;
 212                break;
 213        case USB_MIXER_S8:
 214                val &= 0xff;
 215                if (val >= 0x80)
 216                        val -= 0x100;
 217                break;
 218        case USB_MIXER_U16:
 219                val &= 0xffff;
 220                break;
 221        case USB_MIXER_S16:
 222                val &= 0xffff;
 223                if (val >= 0x8000)
 224                        val -= 0x10000;
 225                break;
 226        }
 227        return val;
 228}
 229
 230/*
 231 * convert from the zero-based int to the byte/word for usb descriptor
 232 */
 233static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
 234{
 235        switch (cval->val_type) {
 236        case USB_MIXER_BOOLEAN:
 237                return !!val;
 238        case USB_MIXER_INV_BOOLEAN:
 239                return !val;
 240        case USB_MIXER_S8:
 241        case USB_MIXER_U8:
 242                return val & 0xff;
 243        case USB_MIXER_S16:
 244        case USB_MIXER_U16:
 245                return val & 0xffff;
 246        }
 247        return 0; /* not reached */
 248}
 249
 250static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
 251{
 252        if (!cval->res)
 253                cval->res = 1;
 254        if (val < cval->min)
 255                return 0;
 256        else if (val >= cval->max)
 257                return (cval->max - cval->min + cval->res - 1) / cval->res;
 258        else
 259                return (val - cval->min) / cval->res;
 260}
 261
 262static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
 263{
 264        if (val < 0)
 265                return cval->min;
 266        if (!cval->res)
 267                cval->res = 1;
 268        val *= cval->res;
 269        val += cval->min;
 270        if (val > cval->max)
 271                return cval->max;
 272        return val;
 273}
 274
 275static int uac2_ctl_value_size(int val_type)
 276{
 277        switch (val_type) {
 278        case USB_MIXER_S32:
 279        case USB_MIXER_U32:
 280                return 4;
 281        case USB_MIXER_S16:
 282        case USB_MIXER_U16:
 283                return 2;
 284        default:
 285                return 1;
 286        }
 287        return 0; /* unreachable */
 288}
 289
 290
 291/*
 292 * retrieve a mixer value
 293 */
 294
 295static inline int mixer_ctrl_intf(struct usb_mixer_interface *mixer)
 296{
 297        return get_iface_desc(mixer->hostif)->bInterfaceNumber;
 298}
 299
 300static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
 301                            int validx, int *value_ret)
 302{
 303        struct snd_usb_audio *chip = cval->head.mixer->chip;
 304        unsigned char buf[2];
 305        int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
 306        int timeout = 10;
 307        int idx = 0, err;
 308
 309        err = snd_usb_lock_shutdown(chip);
 310        if (err < 0)
 311                return -EIO;
 312
 313        while (timeout-- > 0) {
 314                idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
 315                err = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
 316                                      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
 317                                      validx, idx, buf, val_len);
 318                if (err >= val_len) {
 319                        *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
 320                        err = 0;
 321                        goto out;
 322                } else if (err == -ETIMEDOUT) {
 323                        goto out;
 324                }
 325        }
 326        usb_audio_dbg(chip,
 327                "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
 328                request, validx, idx, cval->val_type);
 329        err = -EINVAL;
 330
 331 out:
 332        snd_usb_unlock_shutdown(chip);
 333        return err;
 334}
 335
 336static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
 337                            int validx, int *value_ret)
 338{
 339        struct snd_usb_audio *chip = cval->head.mixer->chip;
 340        /* enough space for one range */
 341        unsigned char buf[sizeof(__u16) + 3 * sizeof(__u32)];
 342        unsigned char *val;
 343        int idx = 0, ret, val_size, size;
 344        __u8 bRequest;
 345
 346        val_size = uac2_ctl_value_size(cval->val_type);
 347
 348        if (request == UAC_GET_CUR) {
 349                bRequest = UAC2_CS_CUR;
 350                size = val_size;
 351        } else {
 352                bRequest = UAC2_CS_RANGE;
 353                size = sizeof(__u16) + 3 * val_size;
 354        }
 355
 356        memset(buf, 0, sizeof(buf));
 357
 358        ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
 359        if (ret)
 360                goto error;
 361
 362        idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
 363        ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
 364                              USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
 365                              validx, idx, buf, size);
 366        snd_usb_unlock_shutdown(chip);
 367
 368        if (ret < 0) {
 369error:
 370                usb_audio_err(chip,
 371                        "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
 372                        request, validx, idx, cval->val_type);
 373                return ret;
 374        }
 375
 376        /* FIXME: how should we handle multiple triplets here? */
 377
 378        switch (request) {
 379        case UAC_GET_CUR:
 380                val = buf;
 381                break;
 382        case UAC_GET_MIN:
 383                val = buf + sizeof(__u16);
 384                break;
 385        case UAC_GET_MAX:
 386                val = buf + sizeof(__u16) + val_size;
 387                break;
 388        case UAC_GET_RES:
 389                val = buf + sizeof(__u16) + val_size * 2;
 390                break;
 391        default:
 392                return -EINVAL;
 393        }
 394
 395        *value_ret = convert_signed_value(cval,
 396                                          snd_usb_combine_bytes(val, val_size));
 397
 398        return 0;
 399}
 400
 401static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
 402                         int validx, int *value_ret)
 403{
 404        validx += cval->idx_off;
 405
 406        return (cval->head.mixer->protocol == UAC_VERSION_1) ?
 407                get_ctl_value_v1(cval, request, validx, value_ret) :
 408                get_ctl_value_v2(cval, request, validx, value_ret);
 409}
 410
 411static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
 412                             int validx, int *value)
 413{
 414        return get_ctl_value(cval, UAC_GET_CUR, validx, value);
 415}
 416
 417/* channel = 0: master, 1 = first channel */
 418static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
 419                                  int channel, int *value)
 420{
 421        return get_ctl_value(cval, UAC_GET_CUR,
 422                             (cval->control << 8) | channel,
 423                             value);
 424}
 425
 426int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
 427                             int channel, int index, int *value)
 428{
 429        int err;
 430
 431        if (cval->cached & (1 << channel)) {
 432                *value = cval->cache_val[index];
 433                return 0;
 434        }
 435        err = get_cur_mix_raw(cval, channel, value);
 436        if (err < 0) {
 437                if (!cval->head.mixer->ignore_ctl_error)
 438                        usb_audio_dbg(cval->head.mixer->chip,
 439                                "cannot get current value for control %d ch %d: err = %d\n",
 440                                      cval->control, channel, err);
 441                return err;
 442        }
 443        cval->cached |= 1 << channel;
 444        cval->cache_val[index] = *value;
 445        return 0;
 446}
 447
 448/*
 449 * set a mixer value
 450 */
 451
 452int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
 453                                int request, int validx, int value_set)
 454{
 455        struct snd_usb_audio *chip = cval->head.mixer->chip;
 456        unsigned char buf[4];
 457        int idx = 0, val_len, err, timeout = 10;
 458
 459        validx += cval->idx_off;
 460
 461
 462        if (cval->head.mixer->protocol == UAC_VERSION_1) {
 463                val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
 464        } else { /* UAC_VERSION_2/3 */
 465                val_len = uac2_ctl_value_size(cval->val_type);
 466
 467                /* FIXME */
 468                if (request != UAC_SET_CUR) {
 469                        usb_audio_dbg(chip, "RANGE setting not yet supported\n");
 470                        return -EINVAL;
 471                }
 472
 473                request = UAC2_CS_CUR;
 474        }
 475
 476        value_set = convert_bytes_value(cval, value_set);
 477        buf[0] = value_set & 0xff;
 478        buf[1] = (value_set >> 8) & 0xff;
 479        buf[2] = (value_set >> 16) & 0xff;
 480        buf[3] = (value_set >> 24) & 0xff;
 481
 482        err = snd_usb_lock_shutdown(chip);
 483        if (err < 0)
 484                return -EIO;
 485
 486        while (timeout-- > 0) {
 487                idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
 488                err = snd_usb_ctl_msg(chip->dev,
 489                                      usb_sndctrlpipe(chip->dev, 0), request,
 490                                      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
 491                                      validx, idx, buf, val_len);
 492                if (err >= 0) {
 493                        err = 0;
 494                        goto out;
 495                } else if (err == -ETIMEDOUT) {
 496                        goto out;
 497                }
 498        }
 499        usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
 500                      request, validx, idx, cval->val_type, buf[0], buf[1]);
 501        err = -EINVAL;
 502
 503 out:
 504        snd_usb_unlock_shutdown(chip);
 505        return err;
 506}
 507
 508static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
 509                             int validx, int value)
 510{
 511        return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
 512}
 513
 514int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
 515                             int index, int value)
 516{
 517        int err;
 518        unsigned int read_only = (channel == 0) ?
 519                cval->master_readonly :
 520                cval->ch_readonly & (1 << (channel - 1));
 521
 522        if (read_only) {
 523                usb_audio_dbg(cval->head.mixer->chip,
 524                              "%s(): channel %d of control %d is read_only\n",
 525                            __func__, channel, cval->control);
 526                return 0;
 527        }
 528
 529        err = snd_usb_mixer_set_ctl_value(cval,
 530                                          UAC_SET_CUR, (cval->control << 8) | channel,
 531                                          value);
 532        if (err < 0)
 533                return err;
 534        cval->cached |= 1 << channel;
 535        cval->cache_val[index] = value;
 536        return 0;
 537}
 538
 539/*
 540 * TLV callback for mixer volume controls
 541 */
 542int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
 543                         unsigned int size, unsigned int __user *_tlv)
 544{
 545        struct usb_mixer_elem_info *cval = kcontrol->private_data;
 546        DECLARE_TLV_DB_MINMAX(scale, 0, 0);
 547
 548        if (size < sizeof(scale))
 549                return -ENOMEM;
 550        if (cval->min_mute)
 551                scale[0] = SNDRV_CTL_TLVT_DB_MINMAX_MUTE;
 552        scale[2] = cval->dBmin;
 553        scale[3] = cval->dBmax;
 554        if (copy_to_user(_tlv, scale, sizeof(scale)))
 555                return -EFAULT;
 556        return 0;
 557}
 558
 559/*
 560 * parser routines begin here...
 561 */
 562
 563static int parse_audio_unit(struct mixer_build *state, int unitid);
 564
 565
 566/*
 567 * check if the input/output channel routing is enabled on the given bitmap.
 568 * used for mixer unit parser
 569 */
 570static int check_matrix_bitmap(unsigned char *bmap,
 571                               int ich, int och, int num_outs)
 572{
 573        int idx = ich * num_outs + och;
 574        return bmap[idx >> 3] & (0x80 >> (idx & 7));
 575}
 576
 577/*
 578 * add an alsa control element
 579 * search and increment the index until an empty slot is found.
 580 *
 581 * if failed, give up and free the control instance.
 582 */
 583
 584int snd_usb_mixer_add_list(struct usb_mixer_elem_list *list,
 585                           struct snd_kcontrol *kctl,
 586                           bool is_std_info)
 587{
 588        struct usb_mixer_interface *mixer = list->mixer;
 589        int err;
 590
 591        while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
 592                kctl->id.index++;
 593        err = snd_ctl_add(mixer->chip->card, kctl);
 594        if (err < 0) {
 595                usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
 596                              err);
 597                return err;
 598        }
 599        list->kctl = kctl;
 600        list->is_std_info = is_std_info;
 601        list->next_id_elem = mixer->id_elems[list->id];
 602        mixer->id_elems[list->id] = list;
 603        return 0;
 604}
 605
 606/*
 607 * get a terminal name string
 608 */
 609
 610static struct iterm_name_combo {
 611        int type;
 612        char *name;
 613} iterm_names[] = {
 614        { 0x0300, "Output" },
 615        { 0x0301, "Speaker" },
 616        { 0x0302, "Headphone" },
 617        { 0x0303, "HMD Audio" },
 618        { 0x0304, "Desktop Speaker" },
 619        { 0x0305, "Room Speaker" },
 620        { 0x0306, "Com Speaker" },
 621        { 0x0307, "LFE" },
 622        { 0x0600, "External In" },
 623        { 0x0601, "Analog In" },
 624        { 0x0602, "Digital In" },
 625        { 0x0603, "Line" },
 626        { 0x0604, "Legacy In" },
 627        { 0x0605, "IEC958 In" },
 628        { 0x0606, "1394 DA Stream" },
 629        { 0x0607, "1394 DV Stream" },
 630        { 0x0700, "Embedded" },
 631        { 0x0701, "Noise Source" },
 632        { 0x0702, "Equalization Noise" },
 633        { 0x0703, "CD" },
 634        { 0x0704, "DAT" },
 635        { 0x0705, "DCC" },
 636        { 0x0706, "MiniDisk" },
 637        { 0x0707, "Analog Tape" },
 638        { 0x0708, "Phonograph" },
 639        { 0x0709, "VCR Audio" },
 640        { 0x070a, "Video Disk Audio" },
 641        { 0x070b, "DVD Audio" },
 642        { 0x070c, "TV Tuner Audio" },
 643        { 0x070d, "Satellite Rec Audio" },
 644        { 0x070e, "Cable Tuner Audio" },
 645        { 0x070f, "DSS Audio" },
 646        { 0x0710, "Radio Receiver" },
 647        { 0x0711, "Radio Transmitter" },
 648        { 0x0712, "Multi-Track Recorder" },
 649        { 0x0713, "Synthesizer" },
 650        { 0 },
 651};
 652
 653static int get_term_name(struct snd_usb_audio *chip, struct usb_audio_term *iterm,
 654                         unsigned char *name, int maxlen, int term_only)
 655{
 656        struct iterm_name_combo *names;
 657        int len;
 658
 659        if (iterm->name) {
 660                len = snd_usb_copy_string_desc(chip, iterm->name,
 661                                                name, maxlen);
 662                if (len)
 663                        return len;
 664        }
 665
 666        /* virtual type - not a real terminal */
 667        if (iterm->type >> 16) {
 668                if (term_only)
 669                        return 0;
 670                switch (iterm->type >> 16) {
 671                case UAC3_SELECTOR_UNIT:
 672                        strcpy(name, "Selector");
 673                        return 8;
 674                case UAC3_PROCESSING_UNIT:
 675                        strcpy(name, "Process Unit");
 676                        return 12;
 677                case UAC3_EXTENSION_UNIT:
 678                        strcpy(name, "Ext Unit");
 679                        return 8;
 680                case UAC3_MIXER_UNIT:
 681                        strcpy(name, "Mixer");
 682                        return 5;
 683                default:
 684                        return sprintf(name, "Unit %d", iterm->id);
 685                }
 686        }
 687
 688        switch (iterm->type & 0xff00) {
 689        case 0x0100:
 690                strcpy(name, "PCM");
 691                return 3;
 692        case 0x0200:
 693                strcpy(name, "Mic");
 694                return 3;
 695        case 0x0400:
 696                strcpy(name, "Headset");
 697                return 7;
 698        case 0x0500:
 699                strcpy(name, "Phone");
 700                return 5;
 701        }
 702
 703        for (names = iterm_names; names->type; names++) {
 704                if (names->type == iterm->type) {
 705                        strcpy(name, names->name);
 706                        return strlen(names->name);
 707                }
 708        }
 709
 710        return 0;
 711}
 712
 713/*
 714 * Get logical cluster information for UAC3 devices.
 715 */
 716static int get_cluster_channels_v3(struct mixer_build *state, unsigned int cluster_id)
 717{
 718        struct uac3_cluster_header_descriptor c_header;
 719        int err;
 720
 721        err = snd_usb_ctl_msg(state->chip->dev,
 722                        usb_rcvctrlpipe(state->chip->dev, 0),
 723                        UAC3_CS_REQ_HIGH_CAPABILITY_DESCRIPTOR,
 724                        USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
 725                        cluster_id,
 726                        snd_usb_ctrl_intf(state->chip),
 727                        &c_header, sizeof(c_header));
 728        if (err < 0)
 729                goto error;
 730        if (err != sizeof(c_header)) {
 731                err = -EIO;
 732                goto error;
 733        }
 734
 735        return c_header.bNrChannels;
 736
 737error:
 738        usb_audio_err(state->chip, "cannot request logical cluster ID: %d (err: %d)\n", cluster_id, err);
 739        return err;
 740}
 741
 742/*
 743 * Get number of channels for a Mixer Unit.
 744 */
 745static int uac_mixer_unit_get_channels(struct mixer_build *state,
 746                                       struct uac_mixer_unit_descriptor *desc)
 747{
 748        int mu_channels;
 749
 750        switch (state->mixer->protocol) {
 751        case UAC_VERSION_1:
 752        case UAC_VERSION_2:
 753        default:
 754                if (desc->bLength < sizeof(*desc) + desc->bNrInPins + 1)
 755                        return 0; /* no bmControls -> skip */
 756                mu_channels = uac_mixer_unit_bNrChannels(desc);
 757                break;
 758        case UAC_VERSION_3:
 759                mu_channels = get_cluster_channels_v3(state,
 760                                uac3_mixer_unit_wClusterDescrID(desc));
 761                break;
 762        }
 763
 764        return mu_channels;
 765}
 766
 767/*
 768 * Parse Input Terminal Unit
 769 */
 770static int __check_input_term(struct mixer_build *state, int id,
 771                              struct usb_audio_term *term);
 772
 773static int parse_term_uac1_iterm_unit(struct mixer_build *state,
 774                                      struct usb_audio_term *term,
 775                                      void *p1, int id)
 776{
 777        struct uac_input_terminal_descriptor *d = p1;
 778
 779        term->type = le16_to_cpu(d->wTerminalType);
 780        term->channels = d->bNrChannels;
 781        term->chconfig = le16_to_cpu(d->wChannelConfig);
 782        term->name = d->iTerminal;
 783        return 0;
 784}
 785
 786static int parse_term_uac2_iterm_unit(struct mixer_build *state,
 787                                      struct usb_audio_term *term,
 788                                      void *p1, int id)
 789{
 790        struct uac2_input_terminal_descriptor *d = p1;
 791        int err;
 792
 793        /* call recursively to verify the referenced clock entity */
 794        err = __check_input_term(state, d->bCSourceID, term);
 795        if (err < 0)
 796                return err;
 797
 798        /* save input term properties after recursion,
 799         * to ensure they are not overriden by the recursion calls
 800         */
 801        term->id = id;
 802        term->type = le16_to_cpu(d->wTerminalType);
 803        term->channels = d->bNrChannels;
 804        term->chconfig = le32_to_cpu(d->bmChannelConfig);
 805        term->name = d->iTerminal;
 806        return 0;
 807}
 808
 809static int parse_term_uac3_iterm_unit(struct mixer_build *state,
 810                                      struct usb_audio_term *term,
 811                                      void *p1, int id)
 812{
 813        struct uac3_input_terminal_descriptor *d = p1;
 814        int err;
 815
 816        /* call recursively to verify the referenced clock entity */
 817        err = __check_input_term(state, d->bCSourceID, term);
 818        if (err < 0)
 819                return err;
 820
 821        /* save input term properties after recursion,
 822         * to ensure they are not overriden by the recursion calls
 823         */
 824        term->id = id;
 825        term->type = le16_to_cpu(d->wTerminalType);
 826
 827        err = get_cluster_channels_v3(state, le16_to_cpu(d->wClusterDescrID));
 828        if (err < 0)
 829                return err;
 830        term->channels = err;
 831
 832        /* REVISIT: UAC3 IT doesn't have channels cfg */
 833        term->chconfig = 0;
 834
 835        term->name = le16_to_cpu(d->wTerminalDescrStr);
 836        return 0;
 837}
 838
 839static int parse_term_mixer_unit(struct mixer_build *state,
 840                                 struct usb_audio_term *term,
 841                                 void *p1, int id)
 842{
 843        struct uac_mixer_unit_descriptor *d = p1;
 844        int protocol = state->mixer->protocol;
 845        int err;
 846
 847        err = uac_mixer_unit_get_channels(state, d);
 848        if (err <= 0)
 849                return err;
 850
 851        term->type = UAC3_MIXER_UNIT << 16; /* virtual type */
 852        term->channels = err;
 853        if (protocol != UAC_VERSION_3) {
 854                term->chconfig = uac_mixer_unit_wChannelConfig(d, protocol);
 855                term->name = uac_mixer_unit_iMixer(d);
 856        }
 857        return 0;
 858}
 859
 860static int parse_term_selector_unit(struct mixer_build *state,
 861                                    struct usb_audio_term *term,
 862                                    void *p1, int id)
 863{
 864        struct uac_selector_unit_descriptor *d = p1;
 865        int err;
 866
 867        /* call recursively to retrieve the channel info */
 868        err = __check_input_term(state, d->baSourceID[0], term);
 869        if (err < 0)
 870                return err;
 871        term->type = UAC3_SELECTOR_UNIT << 16; /* virtual type */
 872        term->id = id;
 873        if (state->mixer->protocol != UAC_VERSION_3)
 874                term->name = uac_selector_unit_iSelector(d);
 875        return 0;
 876}
 877
 878static int parse_term_proc_unit(struct mixer_build *state,
 879                                struct usb_audio_term *term,
 880                                void *p1, int id, int vtype)
 881{
 882        struct uac_processing_unit_descriptor *d = p1;
 883        int protocol = state->mixer->protocol;
 884        int err;
 885
 886        if (d->bNrInPins) {
 887                /* call recursively to retrieve the channel info */
 888                err = __check_input_term(state, d->baSourceID[0], term);
 889                if (err < 0)
 890                        return err;
 891        }
 892
 893        term->type = vtype << 16; /* virtual type */
 894        term->id = id;
 895
 896        if (protocol == UAC_VERSION_3)
 897                return 0;
 898
 899        if (!term->channels) {
 900                term->channels = uac_processing_unit_bNrChannels(d);
 901                term->chconfig = uac_processing_unit_wChannelConfig(d, protocol);
 902        }
 903        term->name = uac_processing_unit_iProcessing(d, protocol);
 904        return 0;
 905}
 906
 907static int parse_term_effect_unit(struct mixer_build *state,
 908                                  struct usb_audio_term *term,
 909                                  void *p1, int id)
 910{
 911        struct uac2_effect_unit_descriptor *d = p1;
 912        int err;
 913
 914        err = __check_input_term(state, d->bSourceID, term);
 915        if (err < 0)
 916                return err;
 917        term->type = UAC3_EFFECT_UNIT << 16; /* virtual type */
 918        term->id = id;
 919        return 0;
 920}
 921
 922static int parse_term_uac2_clock_source(struct mixer_build *state,
 923                                        struct usb_audio_term *term,
 924                                        void *p1, int id)
 925{
 926        struct uac_clock_source_descriptor *d = p1;
 927
 928        term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
 929        term->id = id;
 930        term->name = d->iClockSource;
 931        return 0;
 932}
 933
 934static int parse_term_uac3_clock_source(struct mixer_build *state,
 935                                        struct usb_audio_term *term,
 936                                        void *p1, int id)
 937{
 938        struct uac3_clock_source_descriptor *d = p1;
 939
 940        term->type = UAC3_CLOCK_SOURCE << 16; /* virtual type */
 941        term->id = id;
 942        term->name = le16_to_cpu(d->wClockSourceStr);
 943        return 0;
 944}
 945
 946#define PTYPE(a, b)     ((a) << 8 | (b))
 947
 948/*
 949 * parse the source unit recursively until it reaches to a terminal
 950 * or a branched unit.
 951 */
 952static int __check_input_term(struct mixer_build *state, int id,
 953                              struct usb_audio_term *term)
 954{
 955        int protocol = state->mixer->protocol;
 956        void *p1;
 957        unsigned char *hdr;
 958
 959        for (;;) {
 960                /* a loop in the terminal chain? */
 961                if (test_and_set_bit(id, state->termbitmap))
 962                        return -EINVAL;
 963
 964                p1 = find_audio_control_unit(state, id);
 965                if (!p1)
 966                        break;
 967                if (!snd_usb_validate_audio_desc(p1, protocol))
 968                        break; /* bad descriptor */
 969
 970                hdr = p1;
 971                term->id = id;
 972
 973                switch (PTYPE(protocol, hdr[2])) {
 974                case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
 975                case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
 976                case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT): {
 977                        /* the header is the same for all versions */
 978                        struct uac_feature_unit_descriptor *d = p1;
 979
 980                        id = d->bSourceID;
 981                        break; /* continue to parse */
 982                }
 983                case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
 984                        return parse_term_uac1_iterm_unit(state, term, p1, id);
 985                case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
 986                        return parse_term_uac2_iterm_unit(state, term, p1, id);
 987                case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
 988                        return parse_term_uac3_iterm_unit(state, term, p1, id);
 989                case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
 990                case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
 991                case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
 992                        return parse_term_mixer_unit(state, term, p1, id);
 993                case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
 994                case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
 995                case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
 996                case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
 997                case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
 998                        return parse_term_selector_unit(state, term, p1, id);
 999                case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
1000                case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
1001                case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
1002                        return parse_term_proc_unit(state, term, p1, id,
1003                                                    UAC3_PROCESSING_UNIT);
1004                case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
1005                case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
1006                        return parse_term_effect_unit(state, term, p1, id);
1007                case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
1008                case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
1009                case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
1010                        return parse_term_proc_unit(state, term, p1, id,
1011                                                    UAC3_EXTENSION_UNIT);
1012                case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
1013                        return parse_term_uac2_clock_source(state, term, p1, id);
1014                case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
1015                        return parse_term_uac3_clock_source(state, term, p1, id);
1016                default:
1017                        return -ENODEV;
1018                }
1019        }
1020        return -ENODEV;
1021}
1022
1023
1024static int check_input_term(struct mixer_build *state, int id,
1025                            struct usb_audio_term *term)
1026{
1027        memset(term, 0, sizeof(*term));
1028        memset(state->termbitmap, 0, sizeof(state->termbitmap));
1029        return __check_input_term(state, id, term);
1030}
1031
1032/*
1033 * Feature Unit
1034 */
1035
1036/* feature unit control information */
1037struct usb_feature_control_info {
1038        int control;
1039        const char *name;
1040        int type;       /* data type for uac1 */
1041        int type_uac2;  /* data type for uac2 if different from uac1, else -1 */
1042};
1043
1044static const struct usb_feature_control_info audio_feature_info[] = {
1045        { UAC_FU_MUTE,                  "Mute",                 USB_MIXER_INV_BOOLEAN, -1 },
1046        { UAC_FU_VOLUME,                "Volume",               USB_MIXER_S16, -1 },
1047        { UAC_FU_BASS,                  "Tone Control - Bass",  USB_MIXER_S8, -1 },
1048        { UAC_FU_MID,                   "Tone Control - Mid",   USB_MIXER_S8, -1 },
1049        { UAC_FU_TREBLE,                "Tone Control - Treble", USB_MIXER_S8, -1 },
1050        { UAC_FU_GRAPHIC_EQUALIZER,     "Graphic Equalizer",    USB_MIXER_S8, -1 }, /* FIXME: not implemented yet */
1051        { UAC_FU_AUTOMATIC_GAIN,        "Auto Gain Control",    USB_MIXER_BOOLEAN, -1 },
1052        { UAC_FU_DELAY,                 "Delay Control",        USB_MIXER_U16, USB_MIXER_U32 },
1053        { UAC_FU_BASS_BOOST,            "Bass Boost",           USB_MIXER_BOOLEAN, -1 },
1054        { UAC_FU_LOUDNESS,              "Loudness",             USB_MIXER_BOOLEAN, -1 },
1055        /* UAC2 specific */
1056        { UAC2_FU_INPUT_GAIN,           "Input Gain Control",   USB_MIXER_S16, -1 },
1057        { UAC2_FU_INPUT_GAIN_PAD,       "Input Gain Pad Control", USB_MIXER_S16, -1 },
1058        { UAC2_FU_PHASE_INVERTER,        "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
1059};
1060
1061static void usb_mixer_elem_info_free(struct usb_mixer_elem_info *cval)
1062{
1063        kfree(cval);
1064}
1065
1066/* private_free callback */
1067void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
1068{
1069        usb_mixer_elem_info_free(kctl->private_data);
1070        kctl->private_data = NULL;
1071}
1072
1073/*
1074 * interface to ALSA control for feature/mixer units
1075 */
1076
1077/* volume control quirks */
1078static void volume_control_quirks(struct usb_mixer_elem_info *cval,
1079                                  struct snd_kcontrol *kctl)
1080{
1081        struct snd_usb_audio *chip = cval->head.mixer->chip;
1082        switch (chip->usb_id) {
1083        case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
1084        case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
1085                if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1086                        cval->min = 0x0000;
1087                        cval->max = 0xffff;
1088                        cval->res = 0x00e6;
1089                        break;
1090                }
1091                if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1092                    strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1093                        cval->min = 0x00;
1094                        cval->max = 0xff;
1095                        break;
1096                }
1097                if (strstr(kctl->id.name, "Effect Return") != NULL) {
1098                        cval->min = 0xb706;
1099                        cval->max = 0xff7b;
1100                        cval->res = 0x0073;
1101                        break;
1102                }
1103                if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1104                        (strstr(kctl->id.name, "Effect Send") != NULL)) {
1105                        cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
1106                        cval->max = 0xfcfe;
1107                        cval->res = 0x0073;
1108                }
1109                break;
1110
1111        case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
1112        case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
1113                if (strcmp(kctl->id.name, "Effect Duration") == 0) {
1114                        usb_audio_info(chip,
1115                                       "set quirk for FTU Effect Duration\n");
1116                        cval->min = 0x0000;
1117                        cval->max = 0x7f00;
1118                        cval->res = 0x0100;
1119                        break;
1120                }
1121                if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
1122                    strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
1123                        usb_audio_info(chip,
1124                                       "set quirks for FTU Effect Feedback/Volume\n");
1125                        cval->min = 0x00;
1126                        cval->max = 0x7f;
1127                        break;
1128                }
1129                break;
1130
1131        case USB_ID(0x0d8c, 0x0103):
1132                if (!strcmp(kctl->id.name, "PCM Playback Volume")) {
1133                        usb_audio_info(chip,
1134                                 "set volume quirk for CM102-A+/102S+\n");
1135                        cval->min = -256;
1136                }
1137                break;
1138
1139        case USB_ID(0x0471, 0x0101):
1140        case USB_ID(0x0471, 0x0104):
1141        case USB_ID(0x0471, 0x0105):
1142        case USB_ID(0x0672, 0x1041):
1143        /* quirk for UDA1321/N101.
1144         * note that detection between firmware 2.1.1.7 (N101)
1145         * and later 2.1.1.21 is not very clear from datasheets.
1146         * I hope that the min value is -15360 for newer firmware --jk
1147         */
1148                if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1149                    cval->min == -15616) {
1150                        usb_audio_info(chip,
1151                                 "set volume quirk for UDA1321/N101 chip\n");
1152                        cval->max = -256;
1153                }
1154                break;
1155
1156        case USB_ID(0x046d, 0x09a4):
1157                if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1158                        usb_audio_info(chip,
1159                                "set volume quirk for QuickCam E3500\n");
1160                        cval->min = 6080;
1161                        cval->max = 8768;
1162                        cval->res = 192;
1163                }
1164                break;
1165
1166        case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
1167        case USB_ID(0x046d, 0x0808):
1168        case USB_ID(0x046d, 0x0809):
1169        case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
1170        case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
1171        case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
1172        case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
1173        case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
1174        case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
1175        case USB_ID(0x046d, 0x0991):
1176        case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
1177        /* Most audio usb devices lie about volume resolution.
1178         * Most Logitech webcams have res = 384.
1179         * Probably there is some logitech magic behind this number --fishor
1180         */
1181                if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1182                        usb_audio_info(chip,
1183                                "set resolution quirk: cval->res = 384\n");
1184                        cval->res = 384;
1185                }
1186                break;
1187        case USB_ID(0x0495, 0x3042): /* ESS Technology Asus USB DAC */
1188                if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
1189                        strstr(kctl->id.name, "Capture Volume") != NULL) {
1190                        cval->min >>= 8;
1191                        cval->max = 0;
1192                        cval->res = 1;
1193                }
1194                break;
1195        }
1196}
1197
1198/*
1199 * retrieve the minimum and maximum values for the specified control
1200 */
1201static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
1202                                   int default_min, struct snd_kcontrol *kctl)
1203{
1204        /* for failsafe */
1205        cval->min = default_min;
1206        cval->max = cval->min + 1;
1207        cval->res = 1;
1208        cval->dBmin = cval->dBmax = 0;
1209
1210        if (cval->val_type == USB_MIXER_BOOLEAN ||
1211            cval->val_type == USB_MIXER_INV_BOOLEAN) {
1212                cval->initialized = 1;
1213        } else {
1214                int minchn = 0;
1215                if (cval->cmask) {
1216                        int i;
1217                        for (i = 0; i < MAX_CHANNELS; i++)
1218                                if (cval->cmask & (1 << i)) {
1219                                        minchn = i + 1;
1220                                        break;
1221                                }
1222                }
1223                if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
1224                    get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
1225                        usb_audio_err(cval->head.mixer->chip,
1226                                      "%d:%d: cannot get min/max values for control %d (id %d)\n",
1227                                   cval->head.id, mixer_ctrl_intf(cval->head.mixer),
1228                                                               cval->control, cval->head.id);
1229                        return -EINVAL;
1230                }
1231                if (get_ctl_value(cval, UAC_GET_RES,
1232                                  (cval->control << 8) | minchn,
1233                                  &cval->res) < 0) {
1234                        cval->res = 1;
1235                } else {
1236                        int last_valid_res = cval->res;
1237
1238                        while (cval->res > 1) {
1239                                if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
1240                                                                (cval->control << 8) | minchn,
1241                                                                cval->res / 2) < 0)
1242                                        break;
1243                                cval->res /= 2;
1244                        }
1245                        if (get_ctl_value(cval, UAC_GET_RES,
1246                                          (cval->control << 8) | minchn, &cval->res) < 0)
1247                                cval->res = last_valid_res;
1248                }
1249                if (cval->res == 0)
1250                        cval->res = 1;
1251
1252                /* Additional checks for the proper resolution
1253                 *
1254                 * Some devices report smaller resolutions than actually
1255                 * reacting.  They don't return errors but simply clip
1256                 * to the lower aligned value.
1257                 */
1258                if (cval->min + cval->res < cval->max) {
1259                        int last_valid_res = cval->res;
1260                        int saved, test, check;
1261                        if (get_cur_mix_raw(cval, minchn, &saved) < 0)
1262                                goto no_res_check;
1263                        for (;;) {
1264                                test = saved;
1265                                if (test < cval->max)
1266                                        test += cval->res;
1267                                else
1268                                        test -= cval->res;
1269                                if (test < cval->min || test > cval->max ||
1270                                    snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
1271                                    get_cur_mix_raw(cval, minchn, &check)) {
1272                                        cval->res = last_valid_res;
1273                                        break;
1274                                }
1275                                if (test == check)
1276                                        break;
1277                                cval->res *= 2;
1278                        }
1279                        snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
1280                }
1281
1282no_res_check:
1283                cval->initialized = 1;
1284        }
1285
1286        if (kctl)
1287                volume_control_quirks(cval, kctl);
1288
1289        /* USB descriptions contain the dB scale in 1/256 dB unit
1290         * while ALSA TLV contains in 1/100 dB unit
1291         */
1292        cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1293        cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1294        if (cval->dBmin > cval->dBmax) {
1295                /* something is wrong; assume it's either from/to 0dB */
1296                if (cval->dBmin < 0)
1297                        cval->dBmax = 0;
1298                else if (cval->dBmin > 0)
1299                        cval->dBmin = 0;
1300                if (cval->dBmin > cval->dBmax) {
1301                        /* totally crap, return an error */
1302                        return -EINVAL;
1303                }
1304        }
1305
1306        return 0;
1307}
1308
1309#define get_min_max(cval, def)  get_min_max_with_quirks(cval, def, NULL)
1310
1311/* get a feature/mixer unit info */
1312static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1313                                  struct snd_ctl_elem_info *uinfo)
1314{
1315        struct usb_mixer_elem_info *cval = kcontrol->private_data;
1316
1317        if (cval->val_type == USB_MIXER_BOOLEAN ||
1318            cval->val_type == USB_MIXER_INV_BOOLEAN)
1319                uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1320        else
1321                uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1322        uinfo->count = cval->channels;
1323        if (cval->val_type == USB_MIXER_BOOLEAN ||
1324            cval->val_type == USB_MIXER_INV_BOOLEAN) {
1325                uinfo->value.integer.min = 0;
1326                uinfo->value.integer.max = 1;
1327        } else {
1328                if (!cval->initialized) {
1329                        get_min_max_with_quirks(cval, 0, kcontrol);
1330                        if (cval->initialized && cval->dBmin >= cval->dBmax) {
1331                                kcontrol->vd[0].access &= 
1332                                        ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1333                                          SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1334                                snd_ctl_notify(cval->head.mixer->chip->card,
1335                                               SNDRV_CTL_EVENT_MASK_INFO,
1336                                               &kcontrol->id);
1337                        }
1338                }
1339                uinfo->value.integer.min = 0;
1340                uinfo->value.integer.max =
1341                        (cval->max - cval->min + cval->res - 1) / cval->res;
1342        }
1343        return 0;
1344}
1345
1346/* get the current value from feature/mixer unit */
1347static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1348                                 struct snd_ctl_elem_value *ucontrol)
1349{
1350        struct usb_mixer_elem_info *cval = kcontrol->private_data;
1351        int c, cnt, val, err;
1352
1353        ucontrol->value.integer.value[0] = cval->min;
1354        if (cval->cmask) {
1355                cnt = 0;
1356                for (c = 0; c < MAX_CHANNELS; c++) {
1357                        if (!(cval->cmask & (1 << c)))
1358                                continue;
1359                        err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
1360                        if (err < 0)
1361                                return filter_error(cval, err);
1362                        val = get_relative_value(cval, val);
1363                        ucontrol->value.integer.value[cnt] = val;
1364                        cnt++;
1365                }
1366                return 0;
1367        } else {
1368                /* master channel */
1369                err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1370                if (err < 0)
1371                        return filter_error(cval, err);
1372                val = get_relative_value(cval, val);
1373                ucontrol->value.integer.value[0] = val;
1374        }
1375        return 0;
1376}
1377
1378/* put the current value to feature/mixer unit */
1379static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1380                                 struct snd_ctl_elem_value *ucontrol)
1381{
1382        struct usb_mixer_elem_info *cval = kcontrol->private_data;
1383        int c, cnt, val, oval, err;
1384        int changed = 0;
1385
1386        if (cval->cmask) {
1387                cnt = 0;
1388                for (c = 0; c < MAX_CHANNELS; c++) {
1389                        if (!(cval->cmask & (1 << c)))
1390                                continue;
1391                        err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
1392                        if (err < 0)
1393                                return filter_error(cval, err);
1394                        val = ucontrol->value.integer.value[cnt];
1395                        val = get_abs_value(cval, val);
1396                        if (oval != val) {
1397                                snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
1398                                changed = 1;
1399                        }
1400                        cnt++;
1401                }
1402        } else {
1403                /* master channel */
1404                err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
1405                if (err < 0)
1406                        return filter_error(cval, err);
1407                val = ucontrol->value.integer.value[0];
1408                val = get_abs_value(cval, val);
1409                if (val != oval) {
1410                        snd_usb_set_cur_mix_value(cval, 0, 0, val);
1411                        changed = 1;
1412                }
1413        }
1414        return changed;
1415}
1416
1417/* get the boolean value from the master channel of a UAC control */
1418static int mixer_ctl_master_bool_get(struct snd_kcontrol *kcontrol,
1419                                     struct snd_ctl_elem_value *ucontrol)
1420{
1421        struct usb_mixer_elem_info *cval = kcontrol->private_data;
1422        int val, err;
1423
1424        err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
1425        if (err < 0)
1426                return filter_error(cval, err);
1427        val = (val != 0);
1428        ucontrol->value.integer.value[0] = val;
1429        return 0;
1430}
1431
1432/* get the connectors status and report it as boolean type */
1433static int mixer_ctl_connector_get(struct snd_kcontrol *kcontrol,
1434                                   struct snd_ctl_elem_value *ucontrol)
1435{
1436        struct usb_mixer_elem_info *cval = kcontrol->private_data;
1437        struct snd_usb_audio *chip = cval->head.mixer->chip;
1438        int idx = 0, validx, ret, val;
1439
1440        validx = cval->control << 8 | 0;
1441
1442        ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
1443        if (ret)
1444                goto error;
1445
1446        idx = mixer_ctrl_intf(cval->head.mixer) | (cval->head.id << 8);
1447        if (cval->head.mixer->protocol == UAC_VERSION_2) {
1448                struct uac2_connectors_ctl_blk uac2_conn;
1449
1450                ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1451                                      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1452                                      validx, idx, &uac2_conn, sizeof(uac2_conn));
1453                val = !!uac2_conn.bNrChannels;
1454        } else { /* UAC_VERSION_3 */
1455                struct uac3_insertion_ctl_blk uac3_conn;
1456
1457                ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), UAC2_CS_CUR,
1458                                      USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
1459                                      validx, idx, &uac3_conn, sizeof(uac3_conn));
1460                val = !!uac3_conn.bmConInserted;
1461        }
1462
1463        snd_usb_unlock_shutdown(chip);
1464
1465        if (ret < 0) {
1466                if (strstr(kcontrol->id.name, "Speaker")) {
1467                        ucontrol->value.integer.value[0] = 1;
1468                        return 0;
1469                }
1470error:
1471                usb_audio_err(chip,
1472                        "cannot get connectors status: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
1473                        UAC_GET_CUR, validx, idx, cval->val_type);
1474                return filter_error(cval, ret);
1475        }
1476
1477        ucontrol->value.integer.value[0] = val;
1478        return 0;
1479}
1480
1481static const struct snd_kcontrol_new usb_feature_unit_ctl = {
1482        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1483        .name = "", /* will be filled later manually */
1484        .info = mixer_ctl_feature_info,
1485        .get = mixer_ctl_feature_get,
1486        .put = mixer_ctl_feature_put,
1487};
1488
1489/* the read-only variant */
1490static const struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1491        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1492        .name = "", /* will be filled later manually */
1493        .info = mixer_ctl_feature_info,
1494        .get = mixer_ctl_feature_get,
1495        .put = NULL,
1496};
1497
1498/*
1499 * A control which shows the boolean value from reading a UAC control on
1500 * the master channel.
1501 */
1502static const struct snd_kcontrol_new usb_bool_master_control_ctl_ro = {
1503        .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1504        .name = "", /* will be filled later manually */
1505        .access = SNDRV_CTL_ELEM_ACCESS_READ,
1506        .info = snd_ctl_boolean_mono_info,
1507        .get = mixer_ctl_master_bool_get,
1508        .put = NULL,
1509};
1510
1511static const struct snd_kcontrol_new usb_connector_ctl_ro = {
1512        .iface = SNDRV_CTL_ELEM_IFACE_CARD,
1513        .name = "", /* will be filled later manually */
1514        .access = SNDRV_CTL_ELEM_ACCESS_READ,
1515        .info = snd_ctl_boolean_mono_info,
1516        .get = mixer_ctl_connector_get,
1517        .put = NULL,
1518};
1519
1520/*
1521 * This symbol is exported in order to allow the mixer quirks to
1522 * hook up to the standard feature unit control mechanism
1523 */
1524const struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
1525
1526/*
1527 * build a feature control
1528 */
1529static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1530{
1531        return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1532}
1533
1534/*
1535 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1536 * rename it to "Headphone". We determine if something is a headphone
1537 * similar to how udev determines form factor.
1538 */
1539static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1540                                        struct snd_card *card)
1541{
1542        const char *names_to_check[] = {
1543                "Headset", "headset", "Headphone", "headphone", NULL};
1544        const char **s;
1545        bool found = false;
1546
1547        if (strcmp("Speaker", kctl->id.name))
1548                return;
1549
1550        for (s = names_to_check; *s; s++)
1551                if (strstr(card->shortname, *s)) {
1552                        found = true;
1553                        break;
1554                }
1555
1556        if (!found)
1557                return;
1558
1559        strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1560}
1561
1562static const struct usb_feature_control_info *get_feature_control_info(int control)
1563{
1564        int i;
1565
1566        for (i = 0; i < ARRAY_SIZE(audio_feature_info); ++i) {
1567                if (audio_feature_info[i].control == control)
1568                        return &audio_feature_info[i];
1569        }
1570        return NULL;
1571}
1572
1573static void __build_feature_ctl(struct usb_mixer_interface *mixer,
1574                                const struct usbmix_name_map *imap,
1575                                unsigned int ctl_mask, int control,
1576                                struct usb_audio_term *iterm,
1577                                struct usb_audio_term *oterm,
1578                                int unitid, int nameid, int readonly_mask)
1579{
1580        const struct usb_feature_control_info *ctl_info;
1581        unsigned int len = 0;
1582        int mapped_name = 0;
1583        struct snd_kcontrol *kctl;
1584        struct usb_mixer_elem_info *cval;
1585        const struct usbmix_name_map *map;
1586        unsigned int range;
1587
1588        if (control == UAC_FU_GRAPHIC_EQUALIZER) {
1589                /* FIXME: not supported yet */
1590                return;
1591        }
1592
1593        map = find_map(imap, unitid, control);
1594        if (check_ignored_ctl(map))
1595                return;
1596
1597        cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1598        if (!cval)
1599                return;
1600        snd_usb_mixer_elem_init_std(&cval->head, mixer, unitid);
1601        cval->control = control;
1602        cval->cmask = ctl_mask;
1603
1604        ctl_info = get_feature_control_info(control);
1605        if (!ctl_info) {
1606                usb_mixer_elem_info_free(cval);
1607                return;
1608        }
1609        if (mixer->protocol == UAC_VERSION_1)
1610                cval->val_type = ctl_info->type;
1611        else /* UAC_VERSION_2 */
1612                cval->val_type = ctl_info->type_uac2 >= 0 ?
1613                        ctl_info->type_uac2 : ctl_info->type;
1614
1615        if (ctl_mask == 0) {
1616                cval->channels = 1;     /* master channel */
1617                cval->master_readonly = readonly_mask;
1618        } else {
1619                int i, c = 0;
1620                for (i = 0; i < 16; i++)
1621                        if (ctl_mask & (1 << i))
1622                                c++;
1623                cval->channels = c;
1624                cval->ch_readonly = readonly_mask;
1625        }
1626
1627        /*
1628         * If all channels in the mask are marked read-only, make the control
1629         * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
1630         * issue write commands to read-only channels.
1631         */
1632        if (cval->channels == readonly_mask)
1633                kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1634        else
1635                kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1636
1637        if (!kctl) {
1638                usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1639                usb_mixer_elem_info_free(cval);
1640                return;
1641        }
1642        kctl->private_free = snd_usb_mixer_elem_free;
1643
1644        len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1645        mapped_name = len != 0;
1646        if (!len && nameid)
1647                len = snd_usb_copy_string_desc(mixer->chip, nameid,
1648                                kctl->id.name, sizeof(kctl->id.name));
1649
1650        switch (control) {
1651        case UAC_FU_MUTE:
1652        case UAC_FU_VOLUME:
1653                /*
1654                 * determine the control name.  the rule is:
1655                 * - if a name id is given in descriptor, use it.
1656                 * - if the connected input can be determined, then use the name
1657                 *   of terminal type.
1658                 * - if the connected output can be determined, use it.
1659                 * - otherwise, anonymous name.
1660                 */
1661                if (!len) {
1662                        if (iterm)
1663                                len = get_term_name(mixer->chip, iterm,
1664                                                    kctl->id.name,
1665                                                    sizeof(kctl->id.name), 1);
1666                        if (!len && oterm)
1667                                len = get_term_name(mixer->chip, oterm,
1668                                                    kctl->id.name,
1669                                                    sizeof(kctl->id.name), 1);
1670                        if (!len)
1671                                snprintf(kctl->id.name, sizeof(kctl->id.name),
1672                                         "Feature %d", unitid);
1673                }
1674
1675                if (!mapped_name)
1676                        check_no_speaker_on_headset(kctl, mixer->chip->card);
1677
1678                /*
1679                 * determine the stream direction:
1680                 * if the connected output is USB stream, then it's likely a
1681                 * capture stream.  otherwise it should be playback (hopefully :)
1682                 */
1683                if (!mapped_name && oterm && !(oterm->type >> 16)) {
1684                        if ((oterm->type & 0xff00) == 0x0100)
1685                                append_ctl_name(kctl, " Capture");
1686                        else
1687                                append_ctl_name(kctl, " Playback");
1688                }
1689                append_ctl_name(kctl, control == UAC_FU_MUTE ?
1690                                " Switch" : " Volume");
1691                break;
1692        default:
1693                if (!len)
1694                        strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1695                                sizeof(kctl->id.name));
1696                break;
1697        }
1698
1699        /* get min/max values */
1700        get_min_max_with_quirks(cval, 0, kctl);
1701
1702        /* skip a bogus volume range */
1703        if (cval->max <= cval->min) {
1704                usb_audio_dbg(mixer->chip,
1705                              "[%d] FU [%s] skipped due to invalid volume\n",
1706                              cval->head.id, kctl->id.name);
1707                snd_ctl_free_one(kctl);
1708                return;
1709        }
1710
1711
1712        if (control == UAC_FU_VOLUME) {
1713                check_mapped_dB(map, cval);
1714                if (cval->dBmin < cval->dBmax || !cval->initialized) {
1715                        kctl->tlv.c = snd_usb_mixer_vol_tlv;
1716                        kctl->vd[0].access |=
1717                                SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1718                                SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1719                }
1720        }
1721
1722        snd_usb_mixer_fu_apply_quirk(mixer, cval, unitid, kctl);
1723
1724        range = (cval->max - cval->min) / cval->res;
1725        /*
1726         * Are there devices with volume range more than 255? I use a bit more
1727         * to be sure. 384 is a resolution magic number found on Logitech
1728         * devices. It will definitively catch all buggy Logitech devices.
1729         */
1730        if (range > 384) {
1731                usb_audio_warn(mixer->chip,
1732                               "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
1733                               range);
1734                usb_audio_warn(mixer->chip,
1735                               "[%d] FU [%s] ch = %d, val = %d/%d/%d",
1736                               cval->head.id, kctl->id.name, cval->channels,
1737                               cval->min, cval->max, cval->res);
1738        }
1739
1740        usb_audio_dbg(mixer->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1741                      cval->head.id, kctl->id.name, cval->channels,
1742                      cval->min, cval->max, cval->res);
1743        snd_usb_mixer_add_control(&cval->head, kctl);
1744}
1745
1746static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
1747                              unsigned int ctl_mask, int control,
1748                              struct usb_audio_term *iterm, int unitid,
1749                              int readonly_mask)
1750{
1751        struct uac_feature_unit_descriptor *desc = raw_desc;
1752        int nameid = uac_feature_unit_iFeature(desc);
1753
1754        __build_feature_ctl(state->mixer, state->map, ctl_mask, control,
1755                        iterm, &state->oterm, unitid, nameid, readonly_mask);
1756}
1757
1758static void build_feature_ctl_badd(struct usb_mixer_interface *mixer,
1759                              unsigned int ctl_mask, int control, int unitid,
1760                              const struct usbmix_name_map *badd_map)
1761{
1762        __build_feature_ctl(mixer, badd_map, ctl_mask, control,
1763                        NULL, NULL, unitid, 0, 0);
1764}
1765
1766static void get_connector_control_name(struct usb_mixer_interface *mixer,
1767                                       struct usb_audio_term *term,
1768                                       bool is_input, char *name, int name_size)
1769{
1770        int name_len = get_term_name(mixer->chip, term, name, name_size, 0);
1771
1772        if (name_len == 0)
1773                strlcpy(name, "Unknown", name_size);
1774
1775        /*
1776         *  sound/core/ctljack.c has a convention of naming jack controls
1777         * by ending in " Jack".  Make it slightly more useful by
1778         * indicating Input or Output after the terminal name.
1779         */
1780        if (is_input)
1781                strlcat(name, " - Input Jack", name_size);
1782        else
1783                strlcat(name, " - Output Jack", name_size);
1784}
1785
1786/* Build a mixer control for a UAC connector control (jack-detect) */
1787static void build_connector_control(struct usb_mixer_interface *mixer,
1788                                    const struct usbmix_name_map *imap,
1789                                    struct usb_audio_term *term, bool is_input)
1790{
1791        struct snd_kcontrol *kctl;
1792        struct usb_mixer_elem_info *cval;
1793        const struct usbmix_name_map *map;
1794
1795        map = find_map(imap, term->id, 0);
1796        if (check_ignored_ctl(map))
1797                return;
1798
1799        cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1800        if (!cval)
1801                return;
1802        snd_usb_mixer_elem_init_std(&cval->head, mixer, term->id);
1803        /*
1804         * UAC2: The first byte from reading the UAC2_TE_CONNECTOR control returns the
1805         * number of channels connected.
1806         *
1807         * UAC3: The first byte specifies size of bitmap for the inserted controls. The
1808         * following byte(s) specifies which connectors are inserted.
1809         *
1810         * This boolean ctl will simply report if any channels are connected
1811         * or not.
1812         */
1813        if (mixer->protocol == UAC_VERSION_2)
1814                cval->control = UAC2_TE_CONNECTOR;
1815        else /* UAC_VERSION_3 */
1816                cval->control = UAC3_TE_INSERTION;
1817
1818        cval->val_type = USB_MIXER_BOOLEAN;
1819        cval->channels = 1; /* report true if any channel is connected */
1820        cval->min = 0;
1821        cval->max = 1;
1822        kctl = snd_ctl_new1(&usb_connector_ctl_ro, cval);
1823        if (!kctl) {
1824                usb_audio_err(mixer->chip, "cannot malloc kcontrol\n");
1825                usb_mixer_elem_info_free(cval);
1826                return;
1827        }
1828
1829        if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name)))
1830                strlcat(kctl->id.name, " Jack", sizeof(kctl->id.name));
1831        else
1832                get_connector_control_name(mixer, term, is_input, kctl->id.name,
1833                                           sizeof(kctl->id.name));
1834        kctl->private_free = snd_usb_mixer_elem_free;
1835        snd_usb_mixer_add_control(&cval->head, kctl);
1836}
1837
1838static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1839                                   void *_ftr)
1840{
1841        struct uac_clock_source_descriptor *hdr = _ftr;
1842        struct usb_mixer_elem_info *cval;
1843        struct snd_kcontrol *kctl;
1844        char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1845        int ret;
1846
1847        if (state->mixer->protocol != UAC_VERSION_2)
1848                return -EINVAL;
1849
1850        /*
1851         * The only property of this unit we are interested in is the
1852         * clock source validity. If that isn't readable, just bail out.
1853         */
1854        if (!uac_v2v3_control_is_readable(hdr->bmControls,
1855                                      UAC2_CS_CONTROL_CLOCK_VALID))
1856                return 0;
1857
1858        cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1859        if (!cval)
1860                return -ENOMEM;
1861
1862        snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1863
1864        cval->min = 0;
1865        cval->max = 1;
1866        cval->channels = 1;
1867        cval->val_type = USB_MIXER_BOOLEAN;
1868        cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1869
1870        cval->master_readonly = 1;
1871        /* From UAC2 5.2.5.1.2 "Only the get request is supported." */
1872        kctl = snd_ctl_new1(&usb_bool_master_control_ctl_ro, cval);
1873
1874        if (!kctl) {
1875                usb_mixer_elem_info_free(cval);
1876                return -ENOMEM;
1877        }
1878
1879        kctl->private_free = snd_usb_mixer_elem_free;
1880        ret = snd_usb_copy_string_desc(state->chip, hdr->iClockSource,
1881                                       name, sizeof(name));
1882        if (ret > 0)
1883                snprintf(kctl->id.name, sizeof(kctl->id.name),
1884                         "%s Validity", name);
1885        else
1886                snprintf(kctl->id.name, sizeof(kctl->id.name),
1887                         "Clock Source %d Validity", hdr->bClockID);
1888
1889        return snd_usb_mixer_add_control(&cval->head, kctl);
1890}
1891
1892/*
1893 * parse a feature unit
1894 *
1895 * most of controls are defined here.
1896 */
1897static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1898                                    void *_ftr)
1899{
1900        int channels, i, j;
1901        struct usb_audio_term iterm;
1902        unsigned int master_bits;
1903        int err, csize;
1904        struct uac_feature_unit_descriptor *hdr = _ftr;
1905        __u8 *bmaControls;
1906
1907        if (state->mixer->protocol == UAC_VERSION_1) {
1908                csize = hdr->bControlSize;
1909                channels = (hdr->bLength - 7) / csize - 1;
1910                bmaControls = hdr->bmaControls;
1911        } else if (state->mixer->protocol == UAC_VERSION_2) {
1912                struct uac2_feature_unit_descriptor *ftr = _ftr;
1913                csize = 4;
1914                channels = (hdr->bLength - 6) / 4 - 1;
1915                bmaControls = ftr->bmaControls;
1916        } else { /* UAC_VERSION_3 */
1917                struct uac3_feature_unit_descriptor *ftr = _ftr;
1918
1919                csize = 4;
1920                channels = (ftr->bLength - 7) / 4 - 1;
1921                bmaControls = ftr->bmaControls;
1922        }
1923
1924        /* parse the source unit */
1925        err = parse_audio_unit(state, hdr->bSourceID);
1926        if (err < 0)
1927                return err;
1928
1929        /* determine the input source type and name */
1930        err = check_input_term(state, hdr->bSourceID, &iterm);
1931        if (err < 0)
1932                return err;
1933
1934        master_bits = snd_usb_combine_bytes(bmaControls, csize);
1935        /* master configuration quirks */
1936        switch (state->chip->usb_id) {
1937        case USB_ID(0x08bb, 0x2702):
1938                usb_audio_info(state->chip,
1939                               "usbmixer: master volume quirk for PCM2702 chip\n");
1940                /* disable non-functional volume control */
1941                master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1942                break;
1943        case USB_ID(0x1130, 0xf211):
1944                usb_audio_info(state->chip,
1945                               "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1946                /* disable non-functional volume control */
1947                channels = 0;
1948                break;
1949
1950        }
1951
1952        if (state->mixer->protocol == UAC_VERSION_1) {
1953                /* check all control types */
1954                for (i = 0; i < 10; i++) {
1955                        unsigned int ch_bits = 0;
1956                        int control = audio_feature_info[i].control;
1957
1958                        for (j = 0; j < channels; j++) {
1959                                unsigned int mask;
1960
1961                                mask = snd_usb_combine_bytes(bmaControls +
1962                                                             csize * (j+1), csize);
1963                                if (mask & (1 << i))
1964                                        ch_bits |= (1 << j);
1965                        }
1966                        /* audio class v1 controls are never read-only */
1967
1968                        /*
1969                         * The first channel must be set
1970                         * (for ease of programming).
1971                         */
1972                        if (ch_bits & 1)
1973                                build_feature_ctl(state, _ftr, ch_bits, control,
1974                                                  &iterm, unitid, 0);
1975                        if (master_bits & (1 << i))
1976                                build_feature_ctl(state, _ftr, 0, control,
1977                                                  &iterm, unitid, 0);
1978                }
1979        } else { /* UAC_VERSION_2/3 */
1980                for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
1981                        unsigned int ch_bits = 0;
1982                        unsigned int ch_read_only = 0;
1983                        int control = audio_feature_info[i].control;
1984
1985                        for (j = 0; j < channels; j++) {
1986                                unsigned int mask;
1987
1988                                mask = snd_usb_combine_bytes(bmaControls +
1989                                                             csize * (j+1), csize);
1990                                if (uac_v2v3_control_is_readable(mask, control)) {
1991                                        ch_bits |= (1 << j);
1992                                        if (!uac_v2v3_control_is_writeable(mask, control))
1993                                                ch_read_only |= (1 << j);
1994                                }
1995                        }
1996
1997                        /*
1998                         * NOTE: build_feature_ctl() will mark the control
1999                         * read-only if all channels are marked read-only in
2000                         * the descriptors. Otherwise, the control will be
2001                         * reported as writeable, but the driver will not
2002                         * actually issue a write command for read-only
2003                         * channels.
2004                         */
2005
2006                        /*
2007                         * The first channel must be set
2008                         * (for ease of programming).
2009                         */
2010                        if (ch_bits & 1)
2011                                build_feature_ctl(state, _ftr, ch_bits, control,
2012                                                  &iterm, unitid, ch_read_only);
2013                        if (uac_v2v3_control_is_readable(master_bits, control))
2014                                build_feature_ctl(state, _ftr, 0, control,
2015                                                  &iterm, unitid,
2016                                                  !uac_v2v3_control_is_writeable(master_bits,
2017                                                                                 control));
2018                }
2019        }
2020
2021        return 0;
2022}
2023
2024/*
2025 * Mixer Unit
2026 */
2027
2028/* check whether the given in/out overflows bmMixerControls matrix */
2029static bool mixer_bitmap_overflow(struct uac_mixer_unit_descriptor *desc,
2030                                  int protocol, int num_ins, int num_outs)
2031{
2032        u8 *hdr = (u8 *)desc;
2033        u8 *c = uac_mixer_unit_bmControls(desc, protocol);
2034        size_t rest; /* remaining bytes after bmMixerControls */
2035
2036        switch (protocol) {
2037        case UAC_VERSION_1:
2038        default:
2039                rest = 1; /* iMixer */
2040                break;
2041        case UAC_VERSION_2:
2042                rest = 2; /* bmControls + iMixer */
2043                break;
2044        case UAC_VERSION_3:
2045                rest = 6; /* bmControls + wMixerDescrStr */
2046                break;
2047        }
2048
2049        /* overflow? */
2050        return c + (num_ins * num_outs + 7) / 8 + rest > hdr + hdr[0];
2051}
2052
2053/*
2054 * build a mixer unit control
2055 *
2056 * the callbacks are identical with feature unit.
2057 * input channel number (zero based) is given in control field instead.
2058 */
2059static void build_mixer_unit_ctl(struct mixer_build *state,
2060                                 struct uac_mixer_unit_descriptor *desc,
2061                                 int in_pin, int in_ch, int num_outs,
2062                                 int unitid, struct usb_audio_term *iterm)
2063{
2064        struct usb_mixer_elem_info *cval;
2065        unsigned int i, len;
2066        struct snd_kcontrol *kctl;
2067        const struct usbmix_name_map *map;
2068
2069        map = find_map(state->map, unitid, 0);
2070        if (check_ignored_ctl(map))
2071                return;
2072
2073        cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2074        if (!cval)
2075                return;
2076
2077        snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2078        cval->control = in_ch + 1; /* based on 1 */
2079        cval->val_type = USB_MIXER_S16;
2080        for (i = 0; i < num_outs; i++) {
2081                __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
2082
2083                if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
2084                        cval->cmask |= (1 << i);
2085                        cval->channels++;
2086                }
2087        }
2088
2089        /* get min/max values */
2090        get_min_max(cval, 0);
2091
2092        kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
2093        if (!kctl) {
2094                usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2095                usb_mixer_elem_info_free(cval);
2096                return;
2097        }
2098        kctl->private_free = snd_usb_mixer_elem_free;
2099
2100        len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2101        if (!len)
2102                len = get_term_name(state->chip, iterm, kctl->id.name,
2103                                    sizeof(kctl->id.name), 0);
2104        if (!len)
2105                len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
2106        append_ctl_name(kctl, " Volume");
2107
2108        usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
2109                    cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
2110        snd_usb_mixer_add_control(&cval->head, kctl);
2111}
2112
2113static int parse_audio_input_terminal(struct mixer_build *state, int unitid,
2114                                      void *raw_desc)
2115{
2116        struct usb_audio_term iterm;
2117        unsigned int control, bmctls, term_id;
2118
2119        if (state->mixer->protocol == UAC_VERSION_2) {
2120                struct uac2_input_terminal_descriptor *d_v2 = raw_desc;
2121                control = UAC2_TE_CONNECTOR;
2122                term_id = d_v2->bTerminalID;
2123                bmctls = le16_to_cpu(d_v2->bmControls);
2124        } else if (state->mixer->protocol == UAC_VERSION_3) {
2125                struct uac3_input_terminal_descriptor *d_v3 = raw_desc;
2126                control = UAC3_TE_INSERTION;
2127                term_id = d_v3->bTerminalID;
2128                bmctls = le32_to_cpu(d_v3->bmControls);
2129        } else {
2130                return 0; /* UAC1. No Insertion control */
2131        }
2132
2133        check_input_term(state, term_id, &iterm);
2134
2135        /* Check for jack detection. */
2136        if ((iterm.type & 0xff00) != 0x0100 &&
2137            uac_v2v3_control_is_readable(bmctls, control))
2138                build_connector_control(state->mixer, state->map, &iterm, true);
2139
2140        return 0;
2141}
2142
2143/*
2144 * parse a mixer unit
2145 */
2146static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
2147                                  void *raw_desc)
2148{
2149        struct uac_mixer_unit_descriptor *desc = raw_desc;
2150        struct usb_audio_term iterm;
2151        int input_pins, num_ins, num_outs;
2152        int pin, ich, err;
2153
2154        err = uac_mixer_unit_get_channels(state, desc);
2155        if (err < 0) {
2156                usb_audio_err(state->chip,
2157                              "invalid MIXER UNIT descriptor %d\n",
2158                              unitid);
2159                return err;
2160        }
2161
2162        num_outs = err;
2163        input_pins = desc->bNrInPins;
2164
2165        num_ins = 0;
2166        ich = 0;
2167        for (pin = 0; pin < input_pins; pin++) {
2168                err = parse_audio_unit(state, desc->baSourceID[pin]);
2169                if (err < 0)
2170                        continue;
2171                /* no bmControls field (e.g. Maya44) -> ignore */
2172                if (!num_outs)
2173                        continue;
2174                err = check_input_term(state, desc->baSourceID[pin], &iterm);
2175                if (err < 0)
2176                        return err;
2177                num_ins += iterm.channels;
2178                if (mixer_bitmap_overflow(desc, state->mixer->protocol,
2179                                          num_ins, num_outs))
2180                        break;
2181                for (; ich < num_ins; ich++) {
2182                        int och, ich_has_controls = 0;
2183
2184                        for (och = 0; och < num_outs; och++) {
2185                                __u8 *c = uac_mixer_unit_bmControls(desc,
2186                                                state->mixer->protocol);
2187
2188                                if (check_matrix_bitmap(c, ich, och, num_outs)) {
2189                                        ich_has_controls = 1;
2190                                        break;
2191                                }
2192                        }
2193                        if (ich_has_controls)
2194                                build_mixer_unit_ctl(state, desc, pin, ich, num_outs,
2195                                                     unitid, &iterm);
2196                }
2197        }
2198        return 0;
2199}
2200
2201/*
2202 * Processing Unit / Extension Unit
2203 */
2204
2205/* get callback for processing/extension unit */
2206static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
2207                                  struct snd_ctl_elem_value *ucontrol)
2208{
2209        struct usb_mixer_elem_info *cval = kcontrol->private_data;
2210        int err, val;
2211
2212        err = get_cur_ctl_value(cval, cval->control << 8, &val);
2213        if (err < 0) {
2214                ucontrol->value.integer.value[0] = cval->min;
2215                return filter_error(cval, err);
2216        }
2217        val = get_relative_value(cval, val);
2218        ucontrol->value.integer.value[0] = val;
2219        return 0;
2220}
2221
2222/* put callback for processing/extension unit */
2223static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
2224                                  struct snd_ctl_elem_value *ucontrol)
2225{
2226        struct usb_mixer_elem_info *cval = kcontrol->private_data;
2227        int val, oval, err;
2228
2229        err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2230        if (err < 0)
2231                return filter_error(cval, err);
2232        val = ucontrol->value.integer.value[0];
2233        val = get_abs_value(cval, val);
2234        if (val != oval) {
2235                set_cur_ctl_value(cval, cval->control << 8, val);
2236                return 1;
2237        }
2238        return 0;
2239}
2240
2241/* alsa control interface for processing/extension unit */
2242static const struct snd_kcontrol_new mixer_procunit_ctl = {
2243        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2244        .name = "", /* will be filled later */
2245        .info = mixer_ctl_feature_info,
2246        .get = mixer_ctl_procunit_get,
2247        .put = mixer_ctl_procunit_put,
2248};
2249
2250/*
2251 * predefined data for processing units
2252 */
2253struct procunit_value_info {
2254        int control;
2255        const char *suffix;
2256        int val_type;
2257        int min_value;
2258};
2259
2260struct procunit_info {
2261        int type;
2262        char *name;
2263        const struct procunit_value_info *values;
2264};
2265
2266static const struct procunit_value_info undefined_proc_info[] = {
2267        { 0x00, "Control Undefined", 0 },
2268        { 0 }
2269};
2270
2271static const struct procunit_value_info updown_proc_info[] = {
2272        { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2273        { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2274        { 0 }
2275};
2276static const struct procunit_value_info prologic_proc_info[] = {
2277        { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2278        { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2279        { 0 }
2280};
2281static const struct procunit_value_info threed_enh_proc_info[] = {
2282        { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2283        { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
2284        { 0 }
2285};
2286static const struct procunit_value_info reverb_proc_info[] = {
2287        { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2288        { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
2289        { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
2290        { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
2291        { 0 }
2292};
2293static const struct procunit_value_info chorus_proc_info[] = {
2294        { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2295        { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
2296        { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
2297        { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
2298        { 0 }
2299};
2300static const struct procunit_value_info dcr_proc_info[] = {
2301        { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
2302        { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
2303        { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
2304        { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
2305        { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
2306        { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
2307        { 0 }
2308};
2309
2310static const struct procunit_info procunits[] = {
2311        { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
2312        { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
2313        { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
2314        { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
2315        { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
2316        { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
2317        { 0 },
2318};
2319
2320static const struct procunit_value_info uac3_updown_proc_info[] = {
2321        { UAC3_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
2322        { 0 }
2323};
2324static const struct procunit_value_info uac3_stereo_ext_proc_info[] = {
2325        { UAC3_EXT_WIDTH_CONTROL, "Width Control", USB_MIXER_U8 },
2326        { 0 }
2327};
2328
2329static const struct procunit_info uac3_procunits[] = {
2330        { UAC3_PROCESS_UP_DOWNMIX, "Up Down", uac3_updown_proc_info },
2331        { UAC3_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", uac3_stereo_ext_proc_info },
2332        { UAC3_PROCESS_MULTI_FUNCTION, "Multi-Function", undefined_proc_info },
2333        { 0 },
2334};
2335
2336/*
2337 * predefined data for extension units
2338 */
2339static const struct procunit_value_info clock_rate_xu_info[] = {
2340        { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
2341        { 0 }
2342};
2343static const struct procunit_value_info clock_source_xu_info[] = {
2344        { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
2345        { 0 }
2346};
2347static const struct procunit_value_info spdif_format_xu_info[] = {
2348        { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
2349        { 0 }
2350};
2351static const struct procunit_value_info soft_limit_xu_info[] = {
2352        { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
2353        { 0 }
2354};
2355static const struct procunit_info extunits[] = {
2356        { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
2357        { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
2358        { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
2359        { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
2360        { 0 }
2361};
2362
2363/*
2364 * build a processing/extension unit
2365 */
2366static int build_audio_procunit(struct mixer_build *state, int unitid,
2367                                void *raw_desc, const struct procunit_info *list,
2368                                bool extension_unit)
2369{
2370        struct uac_processing_unit_descriptor *desc = raw_desc;
2371        int num_ins;
2372        struct usb_mixer_elem_info *cval;
2373        struct snd_kcontrol *kctl;
2374        int i, err, nameid, type, len, val;
2375        const struct procunit_info *info;
2376        const struct procunit_value_info *valinfo;
2377        const struct usbmix_name_map *map;
2378        static const struct procunit_value_info default_value_info[] = {
2379                { 0x01, "Switch", USB_MIXER_BOOLEAN },
2380                { 0 }
2381        };
2382        static const struct procunit_info default_info = {
2383                0, NULL, default_value_info
2384        };
2385        const char *name = extension_unit ?
2386                "Extension Unit" : "Processing Unit";
2387
2388        num_ins = desc->bNrInPins;
2389        for (i = 0; i < num_ins; i++) {
2390                err = parse_audio_unit(state, desc->baSourceID[i]);
2391                if (err < 0)
2392                        return err;
2393        }
2394
2395        type = le16_to_cpu(desc->wProcessType);
2396        for (info = list; info && info->type; info++)
2397                if (info->type == type)
2398                        break;
2399        if (!info || !info->type)
2400                info = &default_info;
2401
2402        for (valinfo = info->values; valinfo->control; valinfo++) {
2403                __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
2404
2405                if (state->mixer->protocol == UAC_VERSION_1) {
2406                        if (!(controls[valinfo->control / 8] &
2407                                        (1 << ((valinfo->control % 8) - 1))))
2408                                continue;
2409                } else { /* UAC_VERSION_2/3 */
2410                        if (!uac_v2v3_control_is_readable(controls[valinfo->control / 8],
2411                                                          valinfo->control))
2412                                continue;
2413                }
2414
2415                map = find_map(state->map, unitid, valinfo->control);
2416                if (check_ignored_ctl(map))
2417                        continue;
2418                cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2419                if (!cval)
2420                        return -ENOMEM;
2421                snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2422                cval->control = valinfo->control;
2423                cval->val_type = valinfo->val_type;
2424                cval->channels = 1;
2425
2426                if (state->mixer->protocol > UAC_VERSION_1 &&
2427                    !uac_v2v3_control_is_writeable(controls[valinfo->control / 8],
2428                                                   valinfo->control))
2429                        cval->master_readonly = 1;
2430
2431                /* get min/max values */
2432                switch (type) {
2433                case UAC_PROCESS_UP_DOWNMIX: {
2434                        bool mode_sel = false;
2435
2436                        switch (state->mixer->protocol) {
2437                        case UAC_VERSION_1:
2438                        case UAC_VERSION_2:
2439                        default:
2440                                if (cval->control == UAC_UD_MODE_SELECT)
2441                                        mode_sel = true;
2442                                break;
2443                        case UAC_VERSION_3:
2444                                if (cval->control == UAC3_UD_MODE_SELECT)
2445                                        mode_sel = true;
2446                                break;
2447                        }
2448
2449                        if (mode_sel) {
2450                                __u8 *control_spec = uac_processing_unit_specific(desc,
2451                                                                state->mixer->protocol);
2452                                cval->min = 1;
2453                                cval->max = control_spec[0];
2454                                cval->res = 1;
2455                                cval->initialized = 1;
2456                                break;
2457                        }
2458
2459                        get_min_max(cval, valinfo->min_value);
2460                        break;
2461                }
2462                case USB_XU_CLOCK_RATE:
2463                        /*
2464                         * E-Mu USB 0404/0202/TrackerPre/0204
2465                         * samplerate control quirk
2466                         */
2467                        cval->min = 0;
2468                        cval->max = 5;
2469                        cval->res = 1;
2470                        cval->initialized = 1;
2471                        break;
2472                default:
2473                        get_min_max(cval, valinfo->min_value);
2474                        break;
2475                }
2476
2477                err = get_cur_ctl_value(cval, cval->control << 8, &val);
2478                if (err < 0) {
2479                        usb_mixer_elem_info_free(cval);
2480                        return -EINVAL;
2481                }
2482
2483                kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
2484                if (!kctl) {
2485                        usb_mixer_elem_info_free(cval);
2486                        return -ENOMEM;
2487                }
2488                kctl->private_free = snd_usb_mixer_elem_free;
2489
2490                if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
2491                        /* nothing */ ;
2492                } else if (info->name) {
2493                        strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
2494                } else {
2495                        if (extension_unit)
2496                                nameid = uac_extension_unit_iExtension(desc, state->mixer->protocol);
2497                        else
2498                                nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
2499                        len = 0;
2500                        if (nameid)
2501                                len = snd_usb_copy_string_desc(state->chip,
2502                                                               nameid,
2503                                                               kctl->id.name,
2504                                                               sizeof(kctl->id.name));
2505                        if (!len)
2506                                strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
2507                }
2508                append_ctl_name(kctl, " ");
2509                append_ctl_name(kctl, valinfo->suffix);
2510
2511                usb_audio_dbg(state->chip,
2512                              "[%d] PU [%s] ch = %d, val = %d/%d\n",
2513                              cval->head.id, kctl->id.name, cval->channels,
2514                              cval->min, cval->max);
2515
2516                err = snd_usb_mixer_add_control(&cval->head, kctl);
2517                if (err < 0)
2518                        return err;
2519        }
2520        return 0;
2521}
2522
2523static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
2524                                       void *raw_desc)
2525{
2526        switch (state->mixer->protocol) {
2527        case UAC_VERSION_1:
2528        case UAC_VERSION_2:
2529        default:
2530                return build_audio_procunit(state, unitid, raw_desc,
2531                                            procunits, false);
2532        case UAC_VERSION_3:
2533                return build_audio_procunit(state, unitid, raw_desc,
2534                                            uac3_procunits, false);
2535        }
2536}
2537
2538static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
2539                                      void *raw_desc)
2540{
2541        /*
2542         * Note that we parse extension units with processing unit descriptors.
2543         * That's ok as the layout is the same.
2544         */
2545        return build_audio_procunit(state, unitid, raw_desc, extunits, true);
2546}
2547
2548/*
2549 * Selector Unit
2550 */
2551
2552/*
2553 * info callback for selector unit
2554 * use an enumerator type for routing
2555 */
2556static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
2557                                   struct snd_ctl_elem_info *uinfo)
2558{
2559        struct usb_mixer_elem_info *cval = kcontrol->private_data;
2560        const char **itemlist = (const char **)kcontrol->private_value;
2561
2562        if (snd_BUG_ON(!itemlist))
2563                return -EINVAL;
2564        return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
2565}
2566
2567/* get callback for selector unit */
2568static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2569                                  struct snd_ctl_elem_value *ucontrol)
2570{
2571        struct usb_mixer_elem_info *cval = kcontrol->private_data;
2572        int val, err;
2573
2574        err = get_cur_ctl_value(cval, cval->control << 8, &val);
2575        if (err < 0) {
2576                ucontrol->value.enumerated.item[0] = 0;
2577                return filter_error(cval, err);
2578        }
2579        val = get_relative_value(cval, val);
2580        ucontrol->value.enumerated.item[0] = val;
2581        return 0;
2582}
2583
2584/* put callback for selector unit */
2585static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2586                                  struct snd_ctl_elem_value *ucontrol)
2587{
2588        struct usb_mixer_elem_info *cval = kcontrol->private_data;
2589        int val, oval, err;
2590
2591        err = get_cur_ctl_value(cval, cval->control << 8, &oval);
2592        if (err < 0)
2593                return filter_error(cval, err);
2594        val = ucontrol->value.enumerated.item[0];
2595        val = get_abs_value(cval, val);
2596        if (val != oval) {
2597                set_cur_ctl_value(cval, cval->control << 8, val);
2598                return 1;
2599        }
2600        return 0;
2601}
2602
2603/* alsa control interface for selector unit */
2604static const struct snd_kcontrol_new mixer_selectunit_ctl = {
2605        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2606        .name = "", /* will be filled later */
2607        .info = mixer_ctl_selector_info,
2608        .get = mixer_ctl_selector_get,
2609        .put = mixer_ctl_selector_put,
2610};
2611
2612/*
2613 * private free callback.
2614 * free both private_data and private_value
2615 */
2616static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
2617{
2618        int i, num_ins = 0;
2619
2620        if (kctl->private_data) {
2621                struct usb_mixer_elem_info *cval = kctl->private_data;
2622                num_ins = cval->max;
2623                usb_mixer_elem_info_free(cval);
2624                kctl->private_data = NULL;
2625        }
2626        if (kctl->private_value) {
2627                char **itemlist = (char **)kctl->private_value;
2628                for (i = 0; i < num_ins; i++)
2629                        kfree(itemlist[i]);
2630                kfree(itemlist);
2631                kctl->private_value = 0;
2632        }
2633}
2634
2635/*
2636 * parse a selector unit
2637 */
2638static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2639                                     void *raw_desc)
2640{
2641        struct uac_selector_unit_descriptor *desc = raw_desc;
2642        unsigned int i, nameid, len;
2643        int err;
2644        struct usb_mixer_elem_info *cval;
2645        struct snd_kcontrol *kctl;
2646        const struct usbmix_name_map *map;
2647        char **namelist;
2648
2649        for (i = 0; i < desc->bNrInPins; i++) {
2650                err = parse_audio_unit(state, desc->baSourceID[i]);
2651                if (err < 0)
2652                        return err;
2653        }
2654
2655        if (desc->bNrInPins == 1) /* only one ? nonsense! */
2656                return 0;
2657
2658        map = find_map(state->map, unitid, 0);
2659        if (check_ignored_ctl(map))
2660                return 0;
2661
2662        cval = kzalloc(sizeof(*cval), GFP_KERNEL);
2663        if (!cval)
2664                return -ENOMEM;
2665        snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
2666        cval->val_type = USB_MIXER_U8;
2667        cval->channels = 1;
2668        cval->min = 1;
2669        cval->max = desc->bNrInPins;
2670        cval->res = 1;
2671        cval->initialized = 1;
2672
2673        switch (state->mixer->protocol) {
2674        case UAC_VERSION_1:
2675        default:
2676                cval->control = 0;
2677                break;
2678        case UAC_VERSION_2:
2679        case UAC_VERSION_3:
2680                if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2681                    desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2682                        cval->control = UAC2_CX_CLOCK_SELECTOR;
2683                else /* UAC2/3_SELECTOR_UNIT */
2684                        cval->control = UAC2_SU_SELECTOR;
2685                break;
2686        }
2687
2688        namelist = kcalloc(desc->bNrInPins, sizeof(char *), GFP_KERNEL);
2689        if (!namelist) {
2690                err = -ENOMEM;
2691                goto error_cval;
2692        }
2693#define MAX_ITEM_NAME_LEN       64
2694        for (i = 0; i < desc->bNrInPins; i++) {
2695                struct usb_audio_term iterm;
2696                len = 0;
2697                namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
2698                if (!namelist[i]) {
2699                        err = -ENOMEM;
2700                        goto error_name;
2701                }
2702                len = check_mapped_selector_name(state, unitid, i, namelist[i],
2703                                                 MAX_ITEM_NAME_LEN);
2704                if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
2705                        len = get_term_name(state->chip, &iterm, namelist[i],
2706                                            MAX_ITEM_NAME_LEN, 0);
2707                if (! len)
2708                        sprintf(namelist[i], "Input %u", i);
2709        }
2710
2711        kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2712        if (! kctl) {
2713                usb_audio_err(state->chip, "cannot malloc kcontrol\n");
2714                err = -ENOMEM;
2715                goto error_name;
2716        }
2717        kctl->private_value = (unsigned long)namelist;
2718        kctl->private_free = usb_mixer_selector_elem_free;
2719
2720        /* check the static mapping table at first */
2721        len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
2722        if (!len) {
2723                /* no mapping ? */
2724                switch (state->mixer->protocol) {
2725                case UAC_VERSION_1:
2726                case UAC_VERSION_2:
2727                default:
2728                /* if iSelector is given, use it */
2729                        nameid = uac_selector_unit_iSelector(desc);
2730                        if (nameid)
2731                                len = snd_usb_copy_string_desc(state->chip,
2732                                                        nameid, kctl->id.name,
2733                                                        sizeof(kctl->id.name));
2734                        break;
2735                case UAC_VERSION_3:
2736                        /* TODO: Class-Specific strings not yet supported */
2737                        break;
2738                }
2739
2740                /* ... or pick up the terminal name at next */
2741                if (!len)
2742                        len = get_term_name(state->chip, &state->oterm,
2743                                    kctl->id.name, sizeof(kctl->id.name), 0);
2744                /* ... or use the fixed string "USB" as the last resort */
2745                if (!len)
2746                        strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2747
2748                /* and add the proper suffix */
2749                if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR ||
2750                    desc->bDescriptorSubtype == UAC3_CLOCK_SELECTOR)
2751                        append_ctl_name(kctl, " Clock Source");
2752                else if ((state->oterm.type & 0xff00) == 0x0100)
2753                        append_ctl_name(kctl, " Capture Source");
2754                else
2755                        append_ctl_name(kctl, " Playback Source");
2756        }
2757
2758        usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
2759                    cval->head.id, kctl->id.name, desc->bNrInPins);
2760        return snd_usb_mixer_add_control(&cval->head, kctl);
2761
2762 error_name:
2763        for (i = 0; i < desc->bNrInPins; i++)
2764                kfree(namelist[i]);
2765        kfree(namelist);
2766 error_cval:
2767        usb_mixer_elem_info_free(cval);
2768        return err;
2769}
2770
2771/*
2772 * parse an audio unit recursively
2773 */
2774
2775static int parse_audio_unit(struct mixer_build *state, int unitid)
2776{
2777        unsigned char *p1;
2778        int protocol = state->mixer->protocol;
2779
2780        if (test_and_set_bit(unitid, state->unitbitmap))
2781                return 0; /* the unit already visited */
2782
2783        p1 = find_audio_control_unit(state, unitid);
2784        if (!p1) {
2785                usb_audio_err(state->chip, "unit %d not found!\n", unitid);
2786                return -EINVAL;
2787        }
2788
2789        if (!snd_usb_validate_audio_desc(p1, protocol)) {
2790                usb_audio_dbg(state->chip, "invalid unit %d\n", unitid);
2791                return 0; /* skip invalid unit */
2792        }
2793
2794        switch (PTYPE(protocol, p1[2])) {
2795        case PTYPE(UAC_VERSION_1, UAC_INPUT_TERMINAL):
2796        case PTYPE(UAC_VERSION_2, UAC_INPUT_TERMINAL):
2797        case PTYPE(UAC_VERSION_3, UAC_INPUT_TERMINAL):
2798                return parse_audio_input_terminal(state, unitid, p1);
2799        case PTYPE(UAC_VERSION_1, UAC_MIXER_UNIT):
2800        case PTYPE(UAC_VERSION_2, UAC_MIXER_UNIT):
2801        case PTYPE(UAC_VERSION_3, UAC3_MIXER_UNIT):
2802                return parse_audio_mixer_unit(state, unitid, p1);
2803        case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SOURCE):
2804        case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SOURCE):
2805                return parse_clock_source_unit(state, unitid, p1);
2806        case PTYPE(UAC_VERSION_1, UAC_SELECTOR_UNIT):
2807        case PTYPE(UAC_VERSION_2, UAC_SELECTOR_UNIT):
2808        case PTYPE(UAC_VERSION_3, UAC3_SELECTOR_UNIT):
2809        case PTYPE(UAC_VERSION_2, UAC2_CLOCK_SELECTOR):
2810        case PTYPE(UAC_VERSION_3, UAC3_CLOCK_SELECTOR):
2811                return parse_audio_selector_unit(state, unitid, p1);
2812        case PTYPE(UAC_VERSION_1, UAC_FEATURE_UNIT):
2813        case PTYPE(UAC_VERSION_2, UAC_FEATURE_UNIT):
2814        case PTYPE(UAC_VERSION_3, UAC3_FEATURE_UNIT):
2815                return parse_audio_feature_unit(state, unitid, p1);
2816        case PTYPE(UAC_VERSION_1, UAC1_PROCESSING_UNIT):
2817        case PTYPE(UAC_VERSION_2, UAC2_PROCESSING_UNIT_V2):
2818        case PTYPE(UAC_VERSION_3, UAC3_PROCESSING_UNIT):
2819                return parse_audio_processing_unit(state, unitid, p1);
2820        case PTYPE(UAC_VERSION_1, UAC1_EXTENSION_UNIT):
2821        case PTYPE(UAC_VERSION_2, UAC2_EXTENSION_UNIT_V2):
2822        case PTYPE(UAC_VERSION_3, UAC3_EXTENSION_UNIT):
2823                return parse_audio_extension_unit(state, unitid, p1);
2824        case PTYPE(UAC_VERSION_2, UAC2_EFFECT_UNIT):
2825        case PTYPE(UAC_VERSION_3, UAC3_EFFECT_UNIT):
2826                return 0; /* FIXME - effect units not implemented yet */
2827        default:
2828                usb_audio_err(state->chip,
2829                              "unit %u: unexpected type 0x%02x\n",
2830                              unitid, p1[2]);
2831                return -EINVAL;
2832        }
2833}
2834
2835static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2836{
2837        /* kill pending URBs */
2838        snd_usb_mixer_disconnect(mixer);
2839
2840        kfree(mixer->id_elems);
2841        if (mixer->urb) {
2842                kfree(mixer->urb->transfer_buffer);
2843                usb_free_urb(mixer->urb);
2844        }
2845        usb_free_urb(mixer->rc_urb);
2846        kfree(mixer->rc_setup_packet);
2847        kfree(mixer);
2848}
2849
2850static int snd_usb_mixer_dev_free(struct snd_device *device)
2851{
2852        struct usb_mixer_interface *mixer = device->device_data;
2853        snd_usb_mixer_free(mixer);
2854        return 0;
2855}
2856
2857/* UAC3 predefined channels configuration */
2858struct uac3_badd_profile {
2859        int subclass;
2860        const char *name;
2861        int c_chmask;   /* capture channels mask */
2862        int p_chmask;   /* playback channels mask */
2863        int st_chmask;  /* side tone mixing channel mask */
2864};
2865
2866static const struct uac3_badd_profile uac3_badd_profiles[] = {
2867        {
2868                /*
2869                 * BAIF, BAOF or combination of both
2870                 * IN: Mono or Stereo cfg, Mono alt possible
2871                 * OUT: Mono or Stereo cfg, Mono alt possible
2872                 */
2873                .subclass = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
2874                .name = "GENERIC IO",
2875                .c_chmask = -1,         /* dynamic channels */
2876                .p_chmask = -1,         /* dynamic channels */
2877        },
2878        {
2879                /* BAOF; Stereo only cfg, Mono alt possible */
2880                .subclass = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
2881                .name = "HEADPHONE",
2882                .p_chmask = 3,
2883        },
2884        {
2885                /* BAOF; Mono or Stereo cfg, Mono alt possible */
2886                .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKER,
2887                .name = "SPEAKER",
2888                .p_chmask = -1,         /* dynamic channels */
2889        },
2890        {
2891                /* BAIF; Mono or Stereo cfg, Mono alt possible */
2892                .subclass = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
2893                .name = "MICROPHONE",
2894                .c_chmask = -1,         /* dynamic channels */
2895        },
2896        {
2897                /*
2898                 * BAIOF topology
2899                 * IN: Mono only
2900                 * OUT: Mono or Stereo cfg, Mono alt possible
2901                 */
2902                .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET,
2903                .name = "HEADSET",
2904                .c_chmask = 1,
2905                .p_chmask = -1,         /* dynamic channels */
2906                .st_chmask = 1,
2907        },
2908        {
2909                /* BAIOF; IN: Mono only; OUT: Stereo only, Mono alt possible */
2910                .subclass = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
2911                .name = "HEADSET ADAPTER",
2912                .c_chmask = 1,
2913                .p_chmask = 3,
2914                .st_chmask = 1,
2915        },
2916        {
2917                /* BAIF + BAOF; IN: Mono only; OUT: Mono only */
2918                .subclass = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
2919                .name = "SPEAKERPHONE",
2920                .c_chmask = 1,
2921                .p_chmask = 1,
2922        },
2923        { 0 } /* terminator */
2924};
2925
2926static bool uac3_badd_func_has_valid_channels(struct usb_mixer_interface *mixer,
2927                                              const struct uac3_badd_profile *f,
2928                                              int c_chmask, int p_chmask)
2929{
2930        /*
2931         * If both playback/capture channels are dynamic, make sure
2932         * at least one channel is present
2933         */
2934        if (f->c_chmask < 0 && f->p_chmask < 0) {
2935                if (!c_chmask && !p_chmask) {
2936                        usb_audio_warn(mixer->chip, "BAAD %s: no channels?",
2937                                       f->name);
2938                        return false;
2939                }
2940                return true;
2941        }
2942
2943        if ((f->c_chmask < 0 && !c_chmask) ||
2944            (f->c_chmask >= 0 && f->c_chmask != c_chmask)) {
2945                usb_audio_warn(mixer->chip, "BAAD %s c_chmask mismatch",
2946                               f->name);
2947                return false;
2948        }
2949        if ((f->p_chmask < 0 && !p_chmask) ||
2950            (f->p_chmask >= 0 && f->p_chmask != p_chmask)) {
2951                usb_audio_warn(mixer->chip, "BAAD %s p_chmask mismatch",
2952                               f->name);
2953                return false;
2954        }
2955        return true;
2956}
2957
2958/*
2959 * create mixer controls for UAC3 BADD profiles
2960 *
2961 * UAC3 BADD device doesn't contain CS descriptors thus we will guess everything
2962 *
2963 * BADD device may contain Mixer Unit, which doesn't have any controls, skip it
2964 */
2965static int snd_usb_mixer_controls_badd(struct usb_mixer_interface *mixer,
2966                                       int ctrlif)
2967{
2968        struct usb_device *dev = mixer->chip->dev;
2969        struct usb_interface_assoc_descriptor *assoc;
2970        int badd_profile = mixer->chip->badd_profile;
2971        const struct uac3_badd_profile *f;
2972        const struct usbmix_ctl_map *map;
2973        int p_chmask = 0, c_chmask = 0, st_chmask = 0;
2974        int i;
2975
2976        assoc = usb_ifnum_to_if(dev, ctrlif)->intf_assoc;
2977
2978        /* Detect BADD capture/playback channels from AS EP descriptors */
2979        for (i = 0; i < assoc->bInterfaceCount; i++) {
2980                int intf = assoc->bFirstInterface + i;
2981
2982                struct usb_interface *iface;
2983                struct usb_host_interface *alts;
2984                struct usb_interface_descriptor *altsd;
2985                unsigned int maxpacksize;
2986                char dir_in;
2987                int chmask, num;
2988
2989                if (intf == ctrlif)
2990                        continue;
2991
2992                iface = usb_ifnum_to_if(dev, intf);
2993                if (!iface)
2994                        continue;
2995
2996                num = iface->num_altsetting;
2997
2998                if (num < 2)
2999                        return -EINVAL;
3000
3001                /*
3002                 * The number of Channels in an AudioStreaming interface
3003                 * and the audio sample bit resolution (16 bits or 24
3004                 * bits) can be derived from the wMaxPacketSize field in
3005                 * the Standard AS Audio Data Endpoint descriptor in
3006                 * Alternate Setting 1
3007                 */
3008                alts = &iface->altsetting[1];
3009                altsd = get_iface_desc(alts);
3010
3011                if (altsd->bNumEndpoints < 1)
3012                        return -EINVAL;
3013
3014                /* check direction */
3015                dir_in = (get_endpoint(alts, 0)->bEndpointAddress & USB_DIR_IN);
3016                maxpacksize = le16_to_cpu(get_endpoint(alts, 0)->wMaxPacketSize);
3017
3018                switch (maxpacksize) {
3019                default:
3020                        usb_audio_err(mixer->chip,
3021                                "incorrect wMaxPacketSize 0x%x for BADD profile\n",
3022                                maxpacksize);
3023                        return -EINVAL;
3024                case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_16:
3025                case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_16:
3026                case UAC3_BADD_EP_MAXPSIZE_SYNC_MONO_24:
3027                case UAC3_BADD_EP_MAXPSIZE_ASYNC_MONO_24:
3028                        chmask = 1;
3029                        break;
3030                case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_16:
3031                case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_16:
3032                case UAC3_BADD_EP_MAXPSIZE_SYNC_STEREO_24:
3033                case UAC3_BADD_EP_MAXPSIZE_ASYNC_STEREO_24:
3034                        chmask = 3;
3035                        break;
3036                }
3037
3038                if (dir_in)
3039                        c_chmask = chmask;
3040                else
3041                        p_chmask = chmask;
3042        }
3043
3044        usb_audio_dbg(mixer->chip,
3045                "UAC3 BADD profile 0x%x: detected c_chmask=%d p_chmask=%d\n",
3046                badd_profile, c_chmask, p_chmask);
3047
3048        /* check the mapping table */
3049        for (map = uac3_badd_usbmix_ctl_maps; map->id; map++) {
3050                if (map->id == badd_profile)
3051                        break;
3052        }
3053
3054        if (!map->id)
3055                return -EINVAL;
3056
3057        for (f = uac3_badd_profiles; f->name; f++) {
3058                if (badd_profile == f->subclass)
3059                        break;
3060        }
3061        if (!f->name)
3062                return -EINVAL;
3063        if (!uac3_badd_func_has_valid_channels(mixer, f, c_chmask, p_chmask))
3064                return -EINVAL;
3065        st_chmask = f->st_chmask;
3066
3067        /* Playback */
3068        if (p_chmask) {
3069                /* Master channel, always writable */
3070                build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3071                                       UAC3_BADD_FU_ID2, map->map);
3072                /* Mono/Stereo volume channels, always writable */
3073                build_feature_ctl_badd(mixer, p_chmask, UAC_FU_VOLUME,
3074                                       UAC3_BADD_FU_ID2, map->map);
3075        }
3076
3077        /* Capture */
3078        if (c_chmask) {
3079                /* Master channel, always writable */
3080                build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3081                                       UAC3_BADD_FU_ID5, map->map);
3082                /* Mono/Stereo volume channels, always writable */
3083                build_feature_ctl_badd(mixer, c_chmask, UAC_FU_VOLUME,
3084                                       UAC3_BADD_FU_ID5, map->map);
3085        }
3086
3087        /* Side tone-mixing */
3088        if (st_chmask) {
3089                /* Master channel, always writable */
3090                build_feature_ctl_badd(mixer, 0, UAC_FU_MUTE,
3091                                       UAC3_BADD_FU_ID7, map->map);
3092                /* Mono volume channel, always writable */
3093                build_feature_ctl_badd(mixer, 1, UAC_FU_VOLUME,
3094                                       UAC3_BADD_FU_ID7, map->map);
3095        }
3096
3097        /* Insertion Control */
3098        if (f->subclass == UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER) {
3099                struct usb_audio_term iterm, oterm;
3100
3101                /* Input Term - Insertion control */
3102                memset(&iterm, 0, sizeof(iterm));
3103                iterm.id = UAC3_BADD_IT_ID4;
3104                iterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3105                build_connector_control(mixer, map->map, &iterm, true);
3106
3107                /* Output Term - Insertion control */
3108                memset(&oterm, 0, sizeof(oterm));
3109                oterm.id = UAC3_BADD_OT_ID3;
3110                oterm.type = UAC_BIDIR_TERMINAL_HEADSET;
3111                build_connector_control(mixer, map->map, &oterm, false);
3112        }
3113
3114        return 0;
3115}
3116
3117/*
3118 * create mixer controls
3119 *
3120 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
3121 */
3122static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
3123{
3124        struct mixer_build state;
3125        int err;
3126        const struct usbmix_ctl_map *map;
3127        void *p;
3128
3129        memset(&state, 0, sizeof(state));
3130        state.chip = mixer->chip;
3131        state.mixer = mixer;
3132        state.buffer = mixer->hostif->extra;
3133        state.buflen = mixer->hostif->extralen;
3134
3135        /* check the mapping table */
3136        for (map = usbmix_ctl_maps; map->id; map++) {
3137                if (map->id == state.chip->usb_id) {
3138                        state.map = map->map;
3139                        state.selector_map = map->selector_map;
3140                        mixer->connector_map = map->connector_map;
3141                        mixer->ignore_ctl_error |= map->ignore_ctl_error;
3142                        break;
3143                }
3144        }
3145
3146        p = NULL;
3147        while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
3148                                            mixer->hostif->extralen,
3149                                            p, UAC_OUTPUT_TERMINAL)) != NULL) {
3150                if (!snd_usb_validate_audio_desc(p, mixer->protocol))
3151                        continue; /* skip invalid descriptor */
3152
3153                if (mixer->protocol == UAC_VERSION_1) {
3154                        struct uac1_output_terminal_descriptor *desc = p;
3155
3156                        /* mark terminal ID as visited */
3157                        set_bit(desc->bTerminalID, state.unitbitmap);
3158                        state.oterm.id = desc->bTerminalID;
3159                        state.oterm.type = le16_to_cpu(desc->wTerminalType);
3160                        state.oterm.name = desc->iTerminal;
3161                        err = parse_audio_unit(&state, desc->bSourceID);
3162                        if (err < 0 && err != -EINVAL)
3163                                return err;
3164                } else if (mixer->protocol == UAC_VERSION_2) {
3165                        struct uac2_output_terminal_descriptor *desc = p;
3166
3167                        /* mark terminal ID as visited */
3168                        set_bit(desc->bTerminalID, state.unitbitmap);
3169                        state.oterm.id = desc->bTerminalID;
3170                        state.oterm.type = le16_to_cpu(desc->wTerminalType);
3171                        state.oterm.name = desc->iTerminal;
3172                        err = parse_audio_unit(&state, desc->bSourceID);
3173                        if (err < 0 && err != -EINVAL)
3174                                return err;
3175
3176                        /*
3177                         * For UAC2, use the same approach to also add the
3178                         * clock selectors
3179                         */
3180                        err = parse_audio_unit(&state, desc->bCSourceID);
3181                        if (err < 0 && err != -EINVAL)
3182                                return err;
3183
3184                        if ((state.oterm.type & 0xff00) != 0x0100 &&
3185                            uac_v2v3_control_is_readable(le16_to_cpu(desc->bmControls),
3186                                                         UAC2_TE_CONNECTOR)) {
3187                                build_connector_control(state.mixer, state.map,
3188                                                        &state.oterm, false);
3189                        }
3190                } else {  /* UAC_VERSION_3 */
3191                        struct uac3_output_terminal_descriptor *desc = p;
3192
3193                        /* mark terminal ID as visited */
3194                        set_bit(desc->bTerminalID, state.unitbitmap);
3195                        state.oterm.id = desc->bTerminalID;
3196                        state.oterm.type = le16_to_cpu(desc->wTerminalType);
3197                        state.oterm.name = le16_to_cpu(desc->wTerminalDescrStr);
3198                        err = parse_audio_unit(&state, desc->bSourceID);
3199                        if (err < 0 && err != -EINVAL)
3200                                return err;
3201
3202                        /*
3203                         * For UAC3, use the same approach to also add the
3204                         * clock selectors
3205                         */
3206                        err = parse_audio_unit(&state, desc->bCSourceID);
3207                        if (err < 0 && err != -EINVAL)
3208                                return err;
3209
3210                        if ((state.oterm.type & 0xff00) != 0x0100 &&
3211                            uac_v2v3_control_is_readable(le32_to_cpu(desc->bmControls),
3212                                                         UAC3_TE_INSERTION)) {
3213                                build_connector_control(state.mixer, state.map,
3214                                                        &state.oterm, false);
3215                        }
3216                }
3217        }
3218
3219        return 0;
3220}
3221
3222static int delegate_notify(struct usb_mixer_interface *mixer, int unitid,
3223                           u8 *control, u8 *channel)
3224{
3225        const struct usbmix_connector_map *map = mixer->connector_map;
3226
3227        if (!map)
3228                return unitid;
3229
3230        for (; map->id; map++) {
3231                if (map->id == unitid) {
3232                        if (control && map->control)
3233                                *control = map->control;
3234                        if (channel && map->channel)
3235                                *channel = map->channel;
3236                        return map->delegated_id;
3237                }
3238        }
3239        return unitid;
3240}
3241
3242void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
3243{
3244        struct usb_mixer_elem_list *list;
3245
3246        unitid = delegate_notify(mixer, unitid, NULL, NULL);
3247
3248        for_each_mixer_elem(list, mixer, unitid) {
3249                struct usb_mixer_elem_info *info;
3250
3251                if (!list->is_std_info)
3252                        continue;
3253                info = mixer_elem_list_to_info(list);
3254                /* invalidate cache, so the value is read from the device */
3255                info->cached = 0;
3256                snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3257                               &list->kctl->id);
3258        }
3259}
3260
3261static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
3262                                    struct usb_mixer_elem_list *list)
3263{
3264        struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3265        static const char * const val_types[] = {"BOOLEAN", "INV_BOOLEAN",
3266                                    "S8", "U8", "S16", "U16"};
3267        snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
3268                            "channels=%i, type=\"%s\"\n", cval->head.id,
3269                            cval->control, cval->cmask, cval->channels,
3270                            val_types[cval->val_type]);
3271        snd_iprintf(buffer, "    Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
3272                            cval->min, cval->max, cval->dBmin, cval->dBmax);
3273}
3274
3275static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
3276                                    struct snd_info_buffer *buffer)
3277{
3278        struct snd_usb_audio *chip = entry->private_data;
3279        struct usb_mixer_interface *mixer;
3280        struct usb_mixer_elem_list *list;
3281        int unitid;
3282
3283        list_for_each_entry(mixer, &chip->mixer_list, list) {
3284                snd_iprintf(buffer,
3285                        "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
3286                                chip->usb_id, mixer_ctrl_intf(mixer),
3287                                mixer->ignore_ctl_error);
3288                snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
3289                for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
3290                        for_each_mixer_elem(list, mixer, unitid) {
3291                                snd_iprintf(buffer, "  Unit: %i\n", list->id);
3292                                if (list->kctl)
3293                                        snd_iprintf(buffer,
3294                                                    "    Control: name=\"%s\", index=%i\n",
3295                                                    list->kctl->id.name,
3296                                                    list->kctl->id.index);
3297                                if (list->dump)
3298                                        list->dump(buffer, list);
3299                        }
3300                }
3301        }
3302}
3303
3304static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
3305                                       int attribute, int value, int index)
3306{
3307        struct usb_mixer_elem_list *list;
3308        __u8 unitid = (index >> 8) & 0xff;
3309        __u8 control = (value >> 8) & 0xff;
3310        __u8 channel = value & 0xff;
3311        unsigned int count = 0;
3312
3313        if (channel >= MAX_CHANNELS) {
3314                usb_audio_dbg(mixer->chip,
3315                        "%s(): bogus channel number %d\n",
3316                        __func__, channel);
3317                return;
3318        }
3319
3320        unitid = delegate_notify(mixer, unitid, &control, &channel);
3321
3322        for_each_mixer_elem(list, mixer, unitid)
3323                count++;
3324
3325        if (count == 0)
3326                return;
3327
3328        for_each_mixer_elem(list, mixer, unitid) {
3329                struct usb_mixer_elem_info *info;
3330
3331                if (!list->kctl)
3332                        continue;
3333                if (!list->is_std_info)
3334                        continue;
3335
3336                info = mixer_elem_list_to_info(list);
3337                if (count > 1 && info->control != control)
3338                        continue;
3339
3340                switch (attribute) {
3341                case UAC2_CS_CUR:
3342                        /* invalidate cache, so the value is read from the device */
3343                        if (channel)
3344                                info->cached &= ~(1 << channel);
3345                        else /* master channel */
3346                                info->cached = 0;
3347
3348                        snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
3349                                       &info->head.kctl->id);
3350                        break;
3351
3352                case UAC2_CS_RANGE:
3353                        /* TODO */
3354                        break;
3355
3356                case UAC2_CS_MEM:
3357                        /* TODO */
3358                        break;
3359
3360                default:
3361                        usb_audio_dbg(mixer->chip,
3362                                "unknown attribute %d in interrupt\n",
3363                                attribute);
3364                        break;
3365                } /* switch */
3366        }
3367}
3368
3369static void snd_usb_mixer_interrupt(struct urb *urb)
3370{
3371        struct usb_mixer_interface *mixer = urb->context;
3372        int len = urb->actual_length;
3373        int ustatus = urb->status;
3374
3375        if (ustatus != 0)
3376                goto requeue;
3377
3378        if (mixer->protocol == UAC_VERSION_1) {
3379                struct uac1_status_word *status;
3380
3381                for (status = urb->transfer_buffer;
3382                     len >= sizeof(*status);
3383                     len -= sizeof(*status), status++) {
3384                        dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
3385                                                status->bStatusType,
3386                                                status->bOriginator);
3387
3388                        /* ignore any notifications not from the control interface */
3389                        if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
3390                                UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
3391                                continue;
3392
3393                        if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
3394                                snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
3395                        else
3396                                snd_usb_mixer_notify_id(mixer, status->bOriginator);
3397                }
3398        } else { /* UAC_VERSION_2 */
3399                struct uac2_interrupt_data_msg *msg;
3400
3401                for (msg = urb->transfer_buffer;
3402                     len >= sizeof(*msg);
3403                     len -= sizeof(*msg), msg++) {
3404                        /* drop vendor specific and endpoint requests */
3405                        if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
3406                            (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
3407                                continue;
3408
3409                        snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
3410                                                   le16_to_cpu(msg->wValue),
3411                                                   le16_to_cpu(msg->wIndex));
3412                }
3413        }
3414
3415requeue:
3416        if (ustatus != -ENOENT &&
3417            ustatus != -ECONNRESET &&
3418            ustatus != -ESHUTDOWN) {
3419                urb->dev = mixer->chip->dev;
3420                usb_submit_urb(urb, GFP_ATOMIC);
3421        }
3422}
3423
3424/* create the handler for the optional status interrupt endpoint */
3425static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
3426{
3427        struct usb_endpoint_descriptor *ep;
3428        void *transfer_buffer;
3429        int buffer_length;
3430        unsigned int epnum;
3431
3432        /* we need one interrupt input endpoint */
3433        if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
3434                return 0;
3435        ep = get_endpoint(mixer->hostif, 0);
3436        if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
3437                return 0;
3438
3439        epnum = usb_endpoint_num(ep);
3440        buffer_length = le16_to_cpu(ep->wMaxPacketSize);
3441        transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
3442        if (!transfer_buffer)
3443                return -ENOMEM;
3444        mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
3445        if (!mixer->urb) {
3446                kfree(transfer_buffer);
3447                return -ENOMEM;
3448        }
3449        usb_fill_int_urb(mixer->urb, mixer->chip->dev,
3450                         usb_rcvintpipe(mixer->chip->dev, epnum),
3451                         transfer_buffer, buffer_length,
3452                         snd_usb_mixer_interrupt, mixer, ep->bInterval);
3453        usb_submit_urb(mixer->urb, GFP_KERNEL);
3454        return 0;
3455}
3456
3457static int keep_iface_ctl_get(struct snd_kcontrol *kcontrol,
3458                              struct snd_ctl_elem_value *ucontrol)
3459{
3460        struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3461
3462        ucontrol->value.integer.value[0] = mixer->chip->keep_iface;
3463        return 0;
3464}
3465
3466static int keep_iface_ctl_put(struct snd_kcontrol *kcontrol,
3467                              struct snd_ctl_elem_value *ucontrol)
3468{
3469        struct usb_mixer_interface *mixer = snd_kcontrol_chip(kcontrol);
3470        bool keep_iface = !!ucontrol->value.integer.value[0];
3471
3472        if (mixer->chip->keep_iface == keep_iface)
3473                return 0;
3474        mixer->chip->keep_iface = keep_iface;
3475        return 1;
3476}
3477
3478static const struct snd_kcontrol_new keep_iface_ctl = {
3479        .iface = SNDRV_CTL_ELEM_IFACE_CARD,
3480        .name = "Keep Interface",
3481        .info = snd_ctl_boolean_mono_info,
3482        .get = keep_iface_ctl_get,
3483        .put = keep_iface_ctl_put,
3484};
3485
3486static int create_keep_iface_ctl(struct usb_mixer_interface *mixer)
3487{
3488        struct snd_kcontrol *kctl = snd_ctl_new1(&keep_iface_ctl, mixer);
3489
3490        /* need only one control per card */
3491        if (snd_ctl_find_id(mixer->chip->card, &kctl->id)) {
3492                snd_ctl_free_one(kctl);
3493                return 0;
3494        }
3495
3496        return snd_ctl_add(mixer->chip->card, kctl);
3497}
3498
3499int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
3500                         int ignore_error)
3501{
3502        static const struct snd_device_ops dev_ops = {
3503                .dev_free = snd_usb_mixer_dev_free
3504        };
3505        struct usb_mixer_interface *mixer;
3506        int err;
3507
3508        strcpy(chip->card->mixername, "USB Mixer");
3509
3510        mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
3511        if (!mixer)
3512                return -ENOMEM;
3513        mixer->chip = chip;
3514        mixer->ignore_ctl_error = ignore_error;
3515        mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
3516                                  GFP_KERNEL);
3517        if (!mixer->id_elems) {
3518                kfree(mixer);
3519                return -ENOMEM;
3520        }
3521
3522        mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
3523        switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
3524        case UAC_VERSION_1:
3525        default:
3526                mixer->protocol = UAC_VERSION_1;
3527                break;
3528        case UAC_VERSION_2:
3529                mixer->protocol = UAC_VERSION_2;
3530                break;
3531        case UAC_VERSION_3:
3532                mixer->protocol = UAC_VERSION_3;
3533                break;
3534        }
3535
3536        if (mixer->protocol == UAC_VERSION_3 &&
3537                        chip->badd_profile >= UAC3_FUNCTION_SUBCLASS_GENERIC_IO) {
3538                err = snd_usb_mixer_controls_badd(mixer, ctrlif);
3539                if (err < 0)
3540                        goto _error;
3541        } else {
3542                err = snd_usb_mixer_controls(mixer);
3543                if (err < 0)
3544                        goto _error;
3545        }
3546
3547        err = snd_usb_mixer_status_create(mixer);
3548        if (err < 0)
3549                goto _error;
3550
3551        err = create_keep_iface_ctl(mixer);
3552        if (err < 0)
3553                goto _error;
3554
3555        err = snd_usb_mixer_apply_create_quirk(mixer);
3556        if (err < 0)
3557                goto _error;
3558
3559        err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
3560        if (err < 0)
3561                goto _error;
3562
3563        if (list_empty(&chip->mixer_list))
3564                snd_card_ro_proc_new(chip->card, "usbmixer", chip,
3565                                     snd_usb_mixer_proc_read);
3566
3567        list_add(&mixer->list, &chip->mixer_list);
3568        return 0;
3569
3570_error:
3571        snd_usb_mixer_free(mixer);
3572        return err;
3573}
3574
3575void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
3576{
3577        if (mixer->disconnected)
3578                return;
3579        if (mixer->urb)
3580                usb_kill_urb(mixer->urb);
3581        if (mixer->rc_urb)
3582                usb_kill_urb(mixer->rc_urb);
3583        if (mixer->private_free)
3584                mixer->private_free(mixer);
3585        mixer->disconnected = true;
3586}
3587
3588#ifdef CONFIG_PM
3589/* stop any bus activity of a mixer */
3590static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
3591{
3592        usb_kill_urb(mixer->urb);
3593        usb_kill_urb(mixer->rc_urb);
3594}
3595
3596static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
3597{
3598        int err;
3599
3600        if (mixer->urb) {
3601                err = usb_submit_urb(mixer->urb, GFP_NOIO);
3602                if (err < 0)
3603                        return err;
3604        }
3605
3606        return 0;
3607}
3608
3609int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
3610{
3611        snd_usb_mixer_inactivate(mixer);
3612        if (mixer->private_suspend)
3613                mixer->private_suspend(mixer);
3614        return 0;
3615}
3616
3617static int restore_mixer_value(struct usb_mixer_elem_list *list)
3618{
3619        struct usb_mixer_elem_info *cval = mixer_elem_list_to_info(list);
3620        int c, err, idx;
3621
3622        if (cval->cmask) {
3623                idx = 0;
3624                for (c = 0; c < MAX_CHANNELS; c++) {
3625                        if (!(cval->cmask & (1 << c)))
3626                                continue;
3627                        if (cval->cached & (1 << (c + 1))) {
3628                                err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
3629                                                        cval->cache_val[idx]);
3630                                if (err < 0)
3631                                        return err;
3632                        }
3633                        idx++;
3634                }
3635        } else {
3636                /* master */
3637                if (cval->cached) {
3638                        err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
3639                        if (err < 0)
3640                                return err;
3641                }
3642        }
3643
3644        return 0;
3645}
3646
3647int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
3648{
3649        struct usb_mixer_elem_list *list;
3650        int id, err;
3651
3652        if (reset_resume) {
3653                /* restore cached mixer values */
3654                for (id = 0; id < MAX_ID_ELEMS; id++) {
3655                        for_each_mixer_elem(list, mixer, id) {
3656                                if (list->resume) {
3657                                        err = list->resume(list);
3658                                        if (err < 0)
3659                                                return err;
3660                                }
3661                        }
3662                }
3663        }
3664
3665        snd_usb_mixer_resume_quirk(mixer);
3666
3667        return snd_usb_mixer_activate(mixer);
3668}
3669#endif
3670
3671void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
3672                                 struct usb_mixer_interface *mixer,
3673                                 int unitid)
3674{
3675        list->mixer = mixer;
3676        list->id = unitid;
3677        list->dump = snd_usb_mixer_dump_cval;
3678#ifdef CONFIG_PM
3679        list->resume = restore_mixer_value;
3680#endif
3681}
3682