linux/sound/usb/mixer.c
<<
>>
Prefs
   1/*
   2 *   (Tentative) USB Audio Driver for ALSA
   3 *
   4 *   Mixer control part
   5 *
   6 *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
   7 *
   8 *   Many codes borrowed from audio.c by
   9 *          Alan Cox (alan@lxorguk.ukuu.org.uk)
  10 *          Thomas Sailer (sailer@ife.ee.ethz.ch)
  11 *
  12 *
  13 *   This program is free software; you can redistribute it and/or modify
  14 *   it under the terms of the GNU General Public License as published by
  15 *   the Free Software Foundation; either version 2 of the License, or
  16 *   (at your option) any later version.
  17 *
  18 *   This program is distributed in the hope that it will be useful,
  19 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
  20 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  21 *   GNU General Public License for more details.
  22 *
  23 *   You should have received a copy of the GNU General Public License
  24 *   along with this program; if not, write to the Free Software
  25 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
  26 *
  27 */
  28
  29#include <linux/bitops.h>
  30#include <linux/init.h>
  31#include <linux/list.h>
  32#include <linux/slab.h>
  33#include <linux/string.h>
  34#include <linux/usb.h>
  35#include <linux/usb/audio.h>
  36#include <linux/usb/audio-v2.h>
  37
  38#include <sound/core.h>
  39#include <sound/control.h>
  40#include <sound/hwdep.h>
  41#include <sound/info.h>
  42#include <sound/tlv.h>
  43
  44#include "usbaudio.h"
  45#include "mixer.h"
  46#include "helper.h"
  47#include "mixer_quirks.h"
  48
  49#define MAX_ID_ELEMS    256
  50
  51struct usb_audio_term {
  52        int id;
  53        int type;
  54        int channels;
  55        unsigned int chconfig;
  56        int name;
  57};
  58
  59struct usbmix_name_map;
  60
  61struct mixer_build {
  62        struct snd_usb_audio *chip;
  63        struct usb_mixer_interface *mixer;
  64        unsigned char *buffer;
  65        unsigned int buflen;
  66        DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
  67        struct usb_audio_term oterm;
  68        const struct usbmix_name_map *map;
  69        const struct usbmix_selector_map *selector_map;
  70};
  71
  72enum {
  73        USB_MIXER_BOOLEAN,
  74        USB_MIXER_INV_BOOLEAN,
  75        USB_MIXER_S8,
  76        USB_MIXER_U8,
  77        USB_MIXER_S16,
  78        USB_MIXER_U16,
  79};
  80
  81
  82/*E-mu 0202(0404) eXtension Unit(XU) control*/
  83enum {
  84        USB_XU_CLOCK_RATE               = 0xe301,
  85        USB_XU_CLOCK_SOURCE             = 0xe302,
  86        USB_XU_DIGITAL_IO_STATUS        = 0xe303,
  87        USB_XU_DEVICE_OPTIONS           = 0xe304,
  88        USB_XU_DIRECT_MONITORING        = 0xe305,
  89        USB_XU_METERING                 = 0xe306
  90};
  91enum {
  92        USB_XU_CLOCK_SOURCE_SELECTOR = 0x02,    /* clock source*/
  93        USB_XU_CLOCK_RATE_SELECTOR = 0x03,      /* clock rate */
  94        USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01,  /* the spdif format */
  95        USB_XU_SOFT_LIMIT_SELECTOR = 0x03       /* soft limiter */
  96};
  97
  98/*
  99 * manual mapping of mixer names
 100 * if the mixer topology is too complicated and the parsed names are
 101 * ambiguous, add the entries in usbmixer_maps.c.
 102 */
 103#include "mixer_maps.c"
 104
 105static const struct usbmix_name_map *
 106find_map(struct mixer_build *state, int unitid, int control)
 107{
 108        const struct usbmix_name_map *p = state->map;
 109
 110        if (!p)
 111                return NULL;
 112
 113        for (p = state->map; p->id; p++) {
 114                if (p->id == unitid &&
 115                    (!control || !p->control || control == p->control))
 116                        return p;
 117        }
 118        return NULL;
 119}
 120
 121/* get the mapped name if the unit matches */
 122static int
 123check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
 124{
 125        if (!p || !p->name)
 126                return 0;
 127
 128        buflen--;
 129        return strlcpy(buf, p->name, buflen);
 130}
 131
 132/* check whether the control should be ignored */
 133static inline int
 134check_ignored_ctl(const struct usbmix_name_map *p)
 135{
 136        if (!p || p->name || p->dB)
 137                return 0;
 138        return 1;
 139}
 140
 141/* dB mapping */
 142static inline void check_mapped_dB(const struct usbmix_name_map *p,
 143                                   struct usb_mixer_elem_info *cval)
 144{
 145        if (p && p->dB) {
 146                cval->dBmin = p->dB->min;
 147                cval->dBmax = p->dB->max;
 148        }
 149}
 150
 151/* get the mapped selector source name */
 152static int check_mapped_selector_name(struct mixer_build *state, int unitid,
 153                                      int index, char *buf, int buflen)
 154{
 155        const struct usbmix_selector_map *p;
 156
 157        if (! state->selector_map)
 158                return 0;
 159        for (p = state->selector_map; p->id; p++) {
 160                if (p->id == unitid && index < p->count)
 161                        return strlcpy(buf, p->names[index], buflen);
 162        }
 163        return 0;
 164}
 165
 166/*
 167 * find an audio control unit with the given unit id
 168 */
 169static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit)
 170{
 171        /* we just parse the header */
 172        struct uac_feature_unit_descriptor *hdr = NULL;
 173
 174        while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
 175                                        USB_DT_CS_INTERFACE)) != NULL) {
 176                if (hdr->bLength >= 4 &&
 177                    hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
 178                    hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
 179                    hdr->bUnitID == unit)
 180                        return hdr;
 181        }
 182
 183        return NULL;
 184}
 185
 186/*
 187 * copy a string with the given id
 188 */
 189static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen)
 190{
 191        int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
 192        buf[len] = 0;
 193        return len;
 194}
 195
 196/*
 197 * convert from the byte/word on usb descriptor to the zero-based integer
 198 */
 199static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
 200{
 201        switch (cval->val_type) {
 202        case USB_MIXER_BOOLEAN:
 203                return !!val;
 204        case USB_MIXER_INV_BOOLEAN:
 205                return !val;
 206        case USB_MIXER_U8:
 207                val &= 0xff;
 208                break;
 209        case USB_MIXER_S8:
 210                val &= 0xff;
 211                if (val >= 0x80)
 212                        val -= 0x100;
 213                break;
 214        case USB_MIXER_U16:
 215                val &= 0xffff;
 216                break;
 217        case USB_MIXER_S16:
 218                val &= 0xffff;
 219                if (val >= 0x8000)
 220                        val -= 0x10000;
 221                break;
 222        }
 223        return val;
 224}
 225
 226/*
 227 * convert from the zero-based int to the byte/word for usb descriptor
 228 */
 229static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
 230{
 231        switch (cval->val_type) {
 232        case USB_MIXER_BOOLEAN:
 233                return !!val;
 234        case USB_MIXER_INV_BOOLEAN:
 235                return !val;
 236        case USB_MIXER_S8:
 237        case USB_MIXER_U8:
 238                return val & 0xff;
 239        case USB_MIXER_S16:
 240        case USB_MIXER_U16:
 241                return val & 0xffff;
 242        }
 243        return 0; /* not reached */
 244}
 245
 246static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
 247{
 248        if (! cval->res)
 249                cval->res = 1;
 250        if (val < cval->min)
 251                return 0;
 252        else if (val >= cval->max)
 253                return (cval->max - cval->min + cval->res - 1) / cval->res;
 254        else
 255                return (val - cval->min) / cval->res;
 256}
 257
 258static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
 259{
 260        if (val < 0)
 261                return cval->min;
 262        if (! cval->res)
 263                cval->res = 1;
 264        val *= cval->res;
 265        val += cval->min;
 266        if (val > cval->max)
 267                return cval->max;
 268        return val;
 269}
 270
 271
 272/*
 273 * retrieve a mixer value
 274 */
 275
 276static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
 277{
 278        unsigned char buf[2];
 279        int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
 280        int timeout = 10;
 281
 282        while (timeout-- > 0) {
 283                if (snd_usb_ctl_msg(cval->mixer->chip->dev,
 284                                    usb_rcvctrlpipe(cval->mixer->chip->dev, 0),
 285                                    request,
 286                                    USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
 287                                    validx, cval->mixer->ctrlif | (cval->id << 8),
 288                                    buf, val_len, 100) >= val_len) {
 289                        *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
 290                        return 0;
 291                }
 292        }
 293        snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
 294                    request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type);
 295        return -EINVAL;
 296}
 297
 298static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
 299{
 300        unsigned char buf[2 + 3*sizeof(__u16)]; /* enough space for one range */
 301        unsigned char *val;
 302        int ret, size;
 303        __u8 bRequest;
 304
 305        if (request == UAC_GET_CUR) {
 306                bRequest = UAC2_CS_CUR;
 307                size = sizeof(__u16);
 308        } else {
 309                bRequest = UAC2_CS_RANGE;
 310                size = sizeof(buf);
 311        }
 312
 313        memset(buf, 0, sizeof(buf));
 314
 315        ret = snd_usb_ctl_msg(cval->mixer->chip->dev,
 316                              usb_rcvctrlpipe(cval->mixer->chip->dev, 0),
 317                              bRequest,
 318                              USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
 319                              validx, cval->mixer->ctrlif | (cval->id << 8),
 320                              buf, size, 1000);
 321
 322        if (ret < 0) {
 323                snd_printk(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
 324                           request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type);
 325                return ret;
 326        }
 327
 328        /* FIXME: how should we handle multiple triplets here? */
 329
 330        switch (request) {
 331        case UAC_GET_CUR:
 332                val = buf;
 333                break;
 334        case UAC_GET_MIN:
 335                val = buf + sizeof(__u16);
 336                break;
 337        case UAC_GET_MAX:
 338                val = buf + sizeof(__u16) * 2;
 339                break;
 340        case UAC_GET_RES:
 341                val = buf + sizeof(__u16) * 3;
 342                break;
 343        default:
 344                return -EINVAL;
 345        }
 346
 347        *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
 348
 349        return 0;
 350}
 351
 352static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
 353{
 354        return (cval->mixer->protocol == UAC_VERSION_1) ?
 355                get_ctl_value_v1(cval, request, validx, value_ret) :
 356                get_ctl_value_v2(cval, request, validx, value_ret);
 357}
 358
 359static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
 360{
 361        return get_ctl_value(cval, UAC_GET_CUR, validx, value);
 362}
 363
 364/* channel = 0: master, 1 = first channel */
 365static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
 366                                  int channel, int *value)
 367{
 368        return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value);
 369}
 370
 371static int get_cur_mix_value(struct usb_mixer_elem_info *cval,
 372                             int channel, int index, int *value)
 373{
 374        int err;
 375
 376        if (cval->cached & (1 << channel)) {
 377                *value = cval->cache_val[index];
 378                return 0;
 379        }
 380        err = get_cur_mix_raw(cval, channel, value);
 381        if (err < 0) {
 382                if (!cval->mixer->ignore_ctl_error)
 383                        snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n",
 384                                   cval->control, channel, err);
 385                return err;
 386        }
 387        cval->cached |= 1 << channel;
 388        cval->cache_val[index] = *value;
 389        return 0;
 390}
 391
 392
 393/*
 394 * set a mixer value
 395 */
 396
 397int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
 398                                int request, int validx, int value_set)
 399{
 400        unsigned char buf[2];
 401        int val_len, timeout = 10;
 402
 403        if (cval->mixer->protocol == UAC_VERSION_1) {
 404                val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
 405        } else { /* UAC_VERSION_2 */
 406                /* audio class v2 controls are always 2 bytes in size */
 407                val_len = sizeof(__u16);
 408
 409                /* FIXME */
 410                if (request != UAC_SET_CUR) {
 411                        snd_printdd(KERN_WARNING "RANGE setting not yet supported\n");
 412                        return -EINVAL;
 413                }
 414
 415                request = UAC2_CS_CUR;
 416        }
 417
 418        value_set = convert_bytes_value(cval, value_set);
 419        buf[0] = value_set & 0xff;
 420        buf[1] = (value_set >> 8) & 0xff;
 421        while (timeout-- > 0)
 422                if (snd_usb_ctl_msg(cval->mixer->chip->dev,
 423                                    usb_sndctrlpipe(cval->mixer->chip->dev, 0),
 424                                    request,
 425                                    USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
 426                                    validx, cval->mixer->ctrlif | (cval->id << 8),
 427                                    buf, val_len, 100) >= 0)
 428                        return 0;
 429        snd_printdd(KERN_ERR "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
 430                    request, validx, cval->mixer->ctrlif | (cval->id << 8), cval->val_type, buf[0], buf[1]);
 431        return -EINVAL;
 432}
 433
 434static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
 435{
 436        return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
 437}
 438
 439static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
 440                             int index, int value)
 441{
 442        int err;
 443        unsigned int read_only = (channel == 0) ?
 444                cval->master_readonly :
 445                cval->ch_readonly & (1 << (channel - 1));
 446
 447        if (read_only) {
 448                snd_printdd(KERN_INFO "%s(): channel %d of control %d is read_only\n",
 449                            __func__, channel, cval->control);
 450                return 0;
 451        }
 452
 453        err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel,
 454                            value);
 455        if (err < 0)
 456                return err;
 457        cval->cached |= 1 << channel;
 458        cval->cache_val[index] = value;
 459        return 0;
 460}
 461
 462/*
 463 * TLV callback for mixer volume controls
 464 */
 465static int mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
 466                         unsigned int size, unsigned int __user *_tlv)
 467{
 468        struct usb_mixer_elem_info *cval = kcontrol->private_data;
 469        DECLARE_TLV_DB_MINMAX(scale, 0, 0);
 470
 471        if (size < sizeof(scale))
 472                return -ENOMEM;
 473        scale[2] = cval->dBmin;
 474        scale[3] = cval->dBmax;
 475        if (copy_to_user(_tlv, scale, sizeof(scale)))
 476                return -EFAULT;
 477        return 0;
 478}
 479
 480/*
 481 * parser routines begin here...
 482 */
 483
 484static int parse_audio_unit(struct mixer_build *state, int unitid);
 485
 486
 487/*
 488 * check if the input/output channel routing is enabled on the given bitmap.
 489 * used for mixer unit parser
 490 */
 491static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
 492{
 493        int idx = ich * num_outs + och;
 494        return bmap[idx >> 3] & (0x80 >> (idx & 7));
 495}
 496
 497
 498/*
 499 * add an alsa control element
 500 * search and increment the index until an empty slot is found.
 501 *
 502 * if failed, give up and free the control instance.
 503 */
 504
 505static int add_control_to_empty(struct mixer_build *state, struct snd_kcontrol *kctl)
 506{
 507        struct usb_mixer_elem_info *cval = kctl->private_data;
 508        int err;
 509
 510        while (snd_ctl_find_id(state->chip->card, &kctl->id))
 511                kctl->id.index++;
 512        if ((err = snd_ctl_add(state->chip->card, kctl)) < 0) {
 513                snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
 514                return err;
 515        }
 516        cval->elem_id = &kctl->id;
 517        cval->next_id_elem = state->mixer->id_elems[cval->id];
 518        state->mixer->id_elems[cval->id] = cval;
 519        return 0;
 520}
 521
 522
 523/*
 524 * get a terminal name string
 525 */
 526
 527static struct iterm_name_combo {
 528        int type;
 529        char *name;
 530} iterm_names[] = {
 531        { 0x0300, "Output" },
 532        { 0x0301, "Speaker" },
 533        { 0x0302, "Headphone" },
 534        { 0x0303, "HMD Audio" },
 535        { 0x0304, "Desktop Speaker" },
 536        { 0x0305, "Room Speaker" },
 537        { 0x0306, "Com Speaker" },
 538        { 0x0307, "LFE" },
 539        { 0x0600, "External In" },
 540        { 0x0601, "Analog In" },
 541        { 0x0602, "Digital In" },
 542        { 0x0603, "Line" },
 543        { 0x0604, "Legacy In" },
 544        { 0x0605, "IEC958 In" },
 545        { 0x0606, "1394 DA Stream" },
 546        { 0x0607, "1394 DV Stream" },
 547        { 0x0700, "Embedded" },
 548        { 0x0701, "Noise Source" },
 549        { 0x0702, "Equalization Noise" },
 550        { 0x0703, "CD" },
 551        { 0x0704, "DAT" },
 552        { 0x0705, "DCC" },
 553        { 0x0706, "MiniDisk" },
 554        { 0x0707, "Analog Tape" },
 555        { 0x0708, "Phonograph" },
 556        { 0x0709, "VCR Audio" },
 557        { 0x070a, "Video Disk Audio" },
 558        { 0x070b, "DVD Audio" },
 559        { 0x070c, "TV Tuner Audio" },
 560        { 0x070d, "Satellite Rec Audio" },
 561        { 0x070e, "Cable Tuner Audio" },
 562        { 0x070f, "DSS Audio" },
 563        { 0x0710, "Radio Receiver" },
 564        { 0x0711, "Radio Transmitter" },
 565        { 0x0712, "Multi-Track Recorder" },
 566        { 0x0713, "Synthesizer" },
 567        { 0 },
 568};
 569
 570static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
 571                         unsigned char *name, int maxlen, int term_only)
 572{
 573        struct iterm_name_combo *names;
 574
 575        if (iterm->name)
 576                return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);
 577
 578        /* virtual type - not a real terminal */
 579        if (iterm->type >> 16) {
 580                if (term_only)
 581                        return 0;
 582                switch (iterm->type >> 16) {
 583                case UAC_SELECTOR_UNIT:
 584                        strcpy(name, "Selector"); return 8;
 585                case UAC_PROCESSING_UNIT_V1:
 586                        strcpy(name, "Process Unit"); return 12;
 587                case UAC_EXTENSION_UNIT_V1:
 588                        strcpy(name, "Ext Unit"); return 8;
 589                case UAC_MIXER_UNIT:
 590                        strcpy(name, "Mixer"); return 5;
 591                default:
 592                        return sprintf(name, "Unit %d", iterm->id);
 593                }
 594        }
 595
 596        switch (iterm->type & 0xff00) {
 597        case 0x0100:
 598                strcpy(name, "PCM"); return 3;
 599        case 0x0200:
 600                strcpy(name, "Mic"); return 3;
 601        case 0x0400:
 602                strcpy(name, "Headset"); return 7;
 603        case 0x0500:
 604                strcpy(name, "Phone"); return 5;
 605        }
 606
 607        for (names = iterm_names; names->type; names++)
 608                if (names->type == iterm->type) {
 609                        strcpy(name, names->name);
 610                        return strlen(names->name);
 611                }
 612        return 0;
 613}
 614
 615
 616/*
 617 * parse the source unit recursively until it reaches to a terminal
 618 * or a branched unit.
 619 */
 620static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
 621{
 622        int err;
 623        void *p1;
 624
 625        memset(term, 0, sizeof(*term));
 626        while ((p1 = find_audio_control_unit(state, id)) != NULL) {
 627                unsigned char *hdr = p1;
 628                term->id = id;
 629                switch (hdr[2]) {
 630                case UAC_INPUT_TERMINAL:
 631                        if (state->mixer->protocol == UAC_VERSION_1) {
 632                                struct uac_input_terminal_descriptor *d = p1;
 633                                term->type = le16_to_cpu(d->wTerminalType);
 634                                term->channels = d->bNrChannels;
 635                                term->chconfig = le16_to_cpu(d->wChannelConfig);
 636                                term->name = d->iTerminal;
 637                        } else { /* UAC_VERSION_2 */
 638                                struct uac2_input_terminal_descriptor *d = p1;
 639                                term->type = le16_to_cpu(d->wTerminalType);
 640                                term->channels = d->bNrChannels;
 641                                term->chconfig = le32_to_cpu(d->bmChannelConfig);
 642                                term->name = d->iTerminal;
 643
 644                                /* call recursively to get the clock selectors */
 645                                err = check_input_term(state, d->bCSourceID, term);
 646                                if (err < 0)
 647                                        return err;
 648                        }
 649                        return 0;
 650                case UAC_FEATURE_UNIT: {
 651                        /* the header is the same for v1 and v2 */
 652                        struct uac_feature_unit_descriptor *d = p1;
 653                        id = d->bSourceID;
 654                        break; /* continue to parse */
 655                }
 656                case UAC_MIXER_UNIT: {
 657                        struct uac_mixer_unit_descriptor *d = p1;
 658                        term->type = d->bDescriptorSubtype << 16; /* virtual type */
 659                        term->channels = uac_mixer_unit_bNrChannels(d);
 660                        term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
 661                        term->name = uac_mixer_unit_iMixer(d);
 662                        return 0;
 663                }
 664                case UAC_SELECTOR_UNIT:
 665                case UAC2_CLOCK_SELECTOR: {
 666                        struct uac_selector_unit_descriptor *d = p1;
 667                        /* call recursively to retrieve the channel info */
 668                        if (check_input_term(state, d->baSourceID[0], term) < 0)
 669                                return -ENODEV;
 670                        term->type = d->bDescriptorSubtype << 16; /* virtual type */
 671                        term->id = id;
 672                        term->name = uac_selector_unit_iSelector(d);
 673                        return 0;
 674                }
 675                case UAC_PROCESSING_UNIT_V1:
 676                case UAC_EXTENSION_UNIT_V1: {
 677                        struct uac_processing_unit_descriptor *d = p1;
 678                        if (d->bNrInPins) {
 679                                id = d->baSourceID[0];
 680                                break; /* continue to parse */
 681                        }
 682                        term->type = d->bDescriptorSubtype << 16; /* virtual type */
 683                        term->channels = uac_processing_unit_bNrChannels(d);
 684                        term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
 685                        term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
 686                        return 0;
 687                }
 688                case UAC2_CLOCK_SOURCE: {
 689                        struct uac_clock_source_descriptor *d = p1;
 690                        term->type = d->bDescriptorSubtype << 16; /* virtual type */
 691                        term->id = id;
 692                        term->name = d->iClockSource;
 693                        return 0;
 694                }
 695                default:
 696                        return -ENODEV;
 697                }
 698        }
 699        return -ENODEV;
 700}
 701
 702
 703/*
 704 * Feature Unit
 705 */
 706
 707/* feature unit control information */
 708struct usb_feature_control_info {
 709        const char *name;
 710        unsigned int type;      /* control type (mute, volume, etc.) */
 711};
 712
 713static struct usb_feature_control_info audio_feature_info[] = {
 714        { "Mute",                       USB_MIXER_INV_BOOLEAN },
 715        { "Volume",                     USB_MIXER_S16 },
 716        { "Tone Control - Bass",        USB_MIXER_S8 },
 717        { "Tone Control - Mid",         USB_MIXER_S8 },
 718        { "Tone Control - Treble",      USB_MIXER_S8 },
 719        { "Graphic Equalizer",          USB_MIXER_S8 }, /* FIXME: not implemeted yet */
 720        { "Auto Gain Control",          USB_MIXER_BOOLEAN },
 721        { "Delay Control",              USB_MIXER_U16 },
 722        { "Bass Boost",                 USB_MIXER_BOOLEAN },
 723        { "Loudness",                   USB_MIXER_BOOLEAN },
 724        /* UAC2 specific */
 725        { "Input Gain Control",         USB_MIXER_U16 },
 726        { "Input Gain Pad Control",     USB_MIXER_BOOLEAN },
 727        { "Phase Inverter Control",     USB_MIXER_BOOLEAN },
 728};
 729
 730
 731/* private_free callback */
 732static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
 733{
 734        kfree(kctl->private_data);
 735        kctl->private_data = NULL;
 736}
 737
 738
 739/*
 740 * interface to ALSA control for feature/mixer units
 741 */
 742
 743/*
 744 * retrieve the minimum and maximum values for the specified control
 745 */
 746static int get_min_max(struct usb_mixer_elem_info *cval, int default_min)
 747{
 748        /* for failsafe */
 749        cval->min = default_min;
 750        cval->max = cval->min + 1;
 751        cval->res = 1;
 752        cval->dBmin = cval->dBmax = 0;
 753
 754        if (cval->val_type == USB_MIXER_BOOLEAN ||
 755            cval->val_type == USB_MIXER_INV_BOOLEAN) {
 756                cval->initialized = 1;
 757        } else {
 758                int minchn = 0;
 759                if (cval->cmask) {
 760                        int i;
 761                        for (i = 0; i < MAX_CHANNELS; i++)
 762                                if (cval->cmask & (1 << i)) {
 763                                        minchn = i + 1;
 764                                        break;
 765                                }
 766                }
 767                if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
 768                    get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
 769                        snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
 770                                   cval->id, cval->mixer->ctrlif, cval->control, cval->id);
 771                        return -EINVAL;
 772                }
 773                if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
 774                        cval->res = 1;
 775                } else {
 776                        int last_valid_res = cval->res;
 777
 778                        while (cval->res > 1) {
 779                                if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
 780                                                                (cval->control << 8) | minchn, cval->res / 2) < 0)
 781                                        break;
 782                                cval->res /= 2;
 783                        }
 784                        if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
 785                                cval->res = last_valid_res;
 786                }
 787                if (cval->res == 0)
 788                        cval->res = 1;
 789
 790                /* Additional checks for the proper resolution
 791                 *
 792                 * Some devices report smaller resolutions than actually
 793                 * reacting.  They don't return errors but simply clip
 794                 * to the lower aligned value.
 795                 */
 796                if (cval->min + cval->res < cval->max) {
 797                        int last_valid_res = cval->res;
 798                        int saved, test, check;
 799                        get_cur_mix_raw(cval, minchn, &saved);
 800                        for (;;) {
 801                                test = saved;
 802                                if (test < cval->max)
 803                                        test += cval->res;
 804                                else
 805                                        test -= cval->res;
 806                                if (test < cval->min || test > cval->max ||
 807                                    set_cur_mix_value(cval, minchn, 0, test) ||
 808                                    get_cur_mix_raw(cval, minchn, &check)) {
 809                                        cval->res = last_valid_res;
 810                                        break;
 811                                }
 812                                if (test == check)
 813                                        break;
 814                                cval->res *= 2;
 815                        }
 816                        set_cur_mix_value(cval, minchn, 0, saved);
 817                }
 818
 819                cval->initialized = 1;
 820        }
 821
 822        /* USB descriptions contain the dB scale in 1/256 dB unit
 823         * while ALSA TLV contains in 1/100 dB unit
 824         */
 825        cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
 826        cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
 827        if (cval->dBmin > cval->dBmax) {
 828                /* something is wrong; assume it's either from/to 0dB */
 829                if (cval->dBmin < 0)
 830                        cval->dBmax = 0;
 831                else if (cval->dBmin > 0)
 832                        cval->dBmin = 0;
 833                if (cval->dBmin > cval->dBmax) {
 834                        /* totally crap, return an error */
 835                        return -EINVAL;
 836                }
 837        }
 838
 839        return 0;
 840}
 841
 842
 843/* get a feature/mixer unit info */
 844static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
 845{
 846        struct usb_mixer_elem_info *cval = kcontrol->private_data;
 847
 848        if (cval->val_type == USB_MIXER_BOOLEAN ||
 849            cval->val_type == USB_MIXER_INV_BOOLEAN)
 850                uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
 851        else
 852                uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
 853        uinfo->count = cval->channels;
 854        if (cval->val_type == USB_MIXER_BOOLEAN ||
 855            cval->val_type == USB_MIXER_INV_BOOLEAN) {
 856                uinfo->value.integer.min = 0;
 857                uinfo->value.integer.max = 1;
 858        } else {
 859                if (! cval->initialized)
 860                        get_min_max(cval,  0);
 861                uinfo->value.integer.min = 0;
 862                uinfo->value.integer.max =
 863                        (cval->max - cval->min + cval->res - 1) / cval->res;
 864        }
 865        return 0;
 866}
 867
 868/* get the current value from feature/mixer unit */
 869static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 870{
 871        struct usb_mixer_elem_info *cval = kcontrol->private_data;
 872        int c, cnt, val, err;
 873
 874        ucontrol->value.integer.value[0] = cval->min;
 875        if (cval->cmask) {
 876                cnt = 0;
 877                for (c = 0; c < MAX_CHANNELS; c++) {
 878                        if (!(cval->cmask & (1 << c)))
 879                                continue;
 880                        err = get_cur_mix_value(cval, c + 1, cnt, &val);
 881                        if (err < 0)
 882                                return cval->mixer->ignore_ctl_error ? 0 : err;
 883                        val = get_relative_value(cval, val);
 884                        ucontrol->value.integer.value[cnt] = val;
 885                        cnt++;
 886                }
 887                return 0;
 888        } else {
 889                /* master channel */
 890                err = get_cur_mix_value(cval, 0, 0, &val);
 891                if (err < 0)
 892                        return cval->mixer->ignore_ctl_error ? 0 : err;
 893                val = get_relative_value(cval, val);
 894                ucontrol->value.integer.value[0] = val;
 895        }
 896        return 0;
 897}
 898
 899/* put the current value to feature/mixer unit */
 900static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
 901{
 902        struct usb_mixer_elem_info *cval = kcontrol->private_data;
 903        int c, cnt, val, oval, err;
 904        int changed = 0;
 905
 906        if (cval->cmask) {
 907                cnt = 0;
 908                for (c = 0; c < MAX_CHANNELS; c++) {
 909                        if (!(cval->cmask & (1 << c)))
 910                                continue;
 911                        err = get_cur_mix_value(cval, c + 1, cnt, &oval);
 912                        if (err < 0)
 913                                return cval->mixer->ignore_ctl_error ? 0 : err;
 914                        val = ucontrol->value.integer.value[cnt];
 915                        val = get_abs_value(cval, val);
 916                        if (oval != val) {
 917                                set_cur_mix_value(cval, c + 1, cnt, val);
 918                                changed = 1;
 919                        }
 920                        cnt++;
 921                }
 922        } else {
 923                /* master channel */
 924                err = get_cur_mix_value(cval, 0, 0, &oval);
 925                if (err < 0)
 926                        return cval->mixer->ignore_ctl_error ? 0 : err;
 927                val = ucontrol->value.integer.value[0];
 928                val = get_abs_value(cval, val);
 929                if (val != oval) {
 930                        set_cur_mix_value(cval, 0, 0, val);
 931                        changed = 1;
 932                }
 933        }
 934        return changed;
 935}
 936
 937static struct snd_kcontrol_new usb_feature_unit_ctl = {
 938        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
 939        .name = "", /* will be filled later manually */
 940        .info = mixer_ctl_feature_info,
 941        .get = mixer_ctl_feature_get,
 942        .put = mixer_ctl_feature_put,
 943};
 944
 945/* the read-only variant */
 946static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
 947        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
 948        .name = "", /* will be filled later manually */
 949        .info = mixer_ctl_feature_info,
 950        .get = mixer_ctl_feature_get,
 951        .put = NULL,
 952};
 953
 954
 955/*
 956 * build a feature control
 957 */
 958
 959static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
 960{
 961        return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
 962}
 963
 964static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
 965                              unsigned int ctl_mask, int control,
 966                              struct usb_audio_term *iterm, int unitid,
 967                              int readonly_mask)
 968{
 969        struct uac_feature_unit_descriptor *desc = raw_desc;
 970        unsigned int len = 0;
 971        int mapped_name = 0;
 972        int nameid = uac_feature_unit_iFeature(desc);
 973        struct snd_kcontrol *kctl;
 974        struct usb_mixer_elem_info *cval;
 975        const struct usbmix_name_map *map;
 976
 977        control++; /* change from zero-based to 1-based value */
 978
 979        if (control == UAC_FU_GRAPHIC_EQUALIZER) {
 980                /* FIXME: not supported yet */
 981                return;
 982        }
 983
 984        map = find_map(state, unitid, control);
 985        if (check_ignored_ctl(map))
 986                return;
 987
 988        cval = kzalloc(sizeof(*cval), GFP_KERNEL);
 989        if (! cval) {
 990                snd_printk(KERN_ERR "cannot malloc kcontrol\n");
 991                return;
 992        }
 993        cval->mixer = state->mixer;
 994        cval->id = unitid;
 995        cval->control = control;
 996        cval->cmask = ctl_mask;
 997        cval->val_type = audio_feature_info[control-1].type;
 998        if (ctl_mask == 0) {
 999                cval->channels = 1;     /* master channel */
1000                cval->master_readonly = readonly_mask;
1001        } else {
1002                int i, c = 0;
1003                for (i = 0; i < 16; i++)
1004                        if (ctl_mask & (1 << i))
1005                                c++;
1006                cval->channels = c;
1007                cval->ch_readonly = readonly_mask;
1008        }
1009
1010        /* get min/max values */
1011        get_min_max(cval, 0);
1012
1013        /* if all channels in the mask are marked read-only, make the control
1014         * read-only. set_cur_mix_value() will check the mask again and won't
1015         * issue write commands to read-only channels. */
1016        if (cval->channels == readonly_mask)
1017                kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1018        else
1019                kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1020
1021        if (! kctl) {
1022                snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1023                kfree(cval);
1024                return;
1025        }
1026        kctl->private_free = usb_mixer_elem_free;
1027
1028        len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1029        mapped_name = len != 0;
1030        if (! len && nameid)
1031                len = snd_usb_copy_string_desc(state, nameid,
1032                                kctl->id.name, sizeof(kctl->id.name));
1033
1034        switch (control) {
1035        case UAC_FU_MUTE:
1036        case UAC_FU_VOLUME:
1037                /* determine the control name.  the rule is:
1038                 * - if a name id is given in descriptor, use it.
1039                 * - if the connected input can be determined, then use the name
1040                 *   of terminal type.
1041                 * - if the connected output can be determined, use it.
1042                 * - otherwise, anonymous name.
1043                 */
1044                if (! len) {
1045                        len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
1046                        if (! len)
1047                                len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
1048                        if (! len)
1049                                len = snprintf(kctl->id.name, sizeof(kctl->id.name),
1050                                               "Feature %d", unitid);
1051                }
1052                /* determine the stream direction:
1053                 * if the connected output is USB stream, then it's likely a
1054                 * capture stream.  otherwise it should be playback (hopefully :)
1055                 */
1056                if (! mapped_name && ! (state->oterm.type >> 16)) {
1057                        if ((state->oterm.type & 0xff00) == 0x0100) {
1058                                len = append_ctl_name(kctl, " Capture");
1059                        } else {
1060                                len = append_ctl_name(kctl, " Playback");
1061                        }
1062                }
1063                append_ctl_name(kctl, control == UAC_FU_MUTE ?
1064                                " Switch" : " Volume");
1065                if (control == UAC_FU_VOLUME) {
1066                        kctl->tlv.c = mixer_vol_tlv;
1067                        kctl->vd[0].access |= 
1068                                SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1069                                SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1070                        check_mapped_dB(map, cval);
1071                }
1072                break;
1073
1074        default:
1075                if (! len)
1076                        strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1077                                sizeof(kctl->id.name));
1078                break;
1079        }
1080
1081        /* volume control quirks */
1082        switch (state->chip->usb_id) {
1083        case USB_ID(0x0471, 0x0101):
1084        case USB_ID(0x0471, 0x0104):
1085        case USB_ID(0x0471, 0x0105):
1086        case USB_ID(0x0672, 0x1041):
1087        /* quirk for UDA1321/N101.
1088         * note that detection between firmware 2.1.1.7 (N101)
1089         * and later 2.1.1.21 is not very clear from datasheets.
1090         * I hope that the min value is -15360 for newer firmware --jk
1091         */
1092                if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
1093                    cval->min == -15616) {
1094                        snd_printk(KERN_INFO
1095                                 "set volume quirk for UDA1321/N101 chip\n");
1096                        cval->max = -256;
1097                }
1098                break;
1099
1100        case USB_ID(0x046d, 0x09a4):
1101                if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1102                        snd_printk(KERN_INFO
1103                                "set volume quirk for QuickCam E3500\n");
1104                        cval->min = 6080;
1105                        cval->max = 8768;
1106                        cval->res = 192;
1107                }
1108                break;
1109
1110        case USB_ID(0x046d, 0x0809):
1111        case USB_ID(0x046d, 0x0991):
1112        /* Most audio usb devices lie about volume resolution.
1113         * Most Logitech webcams have res = 384.
1114         * Proboly there is some logitech magic behind this number --fishor
1115         */
1116                if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
1117                        snd_printk(KERN_INFO
1118                                "set resolution quirk: cval->res = 384\n");
1119                        cval->res = 384;
1120                }
1121                break;
1122
1123        }
1124
1125        snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1126                    cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
1127        add_control_to_empty(state, kctl);
1128}
1129
1130
1131
1132/*
1133 * parse a feature unit
1134 *
1135 * most of controlls are defined here.
1136 */
1137static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
1138{
1139        int channels, i, j;
1140        struct usb_audio_term iterm;
1141        unsigned int master_bits, first_ch_bits;
1142        int err, csize;
1143        struct uac_feature_unit_descriptor *hdr = _ftr;
1144        __u8 *bmaControls;
1145
1146        if (state->mixer->protocol == UAC_VERSION_1) {
1147                csize = hdr->bControlSize;
1148                channels = (hdr->bLength - 7) / csize - 1;
1149                bmaControls = hdr->bmaControls;
1150        } else {
1151                struct uac2_feature_unit_descriptor *ftr = _ftr;
1152                csize = 4;
1153                channels = (hdr->bLength - 6) / 4 - 1;
1154                bmaControls = ftr->bmaControls;
1155        }
1156
1157        if (hdr->bLength < 7 || !csize || hdr->bLength < 7 + csize) {
1158                snd_printk(KERN_ERR "usbaudio: unit %u: invalid UAC_FEATURE_UNIT descriptor\n", unitid);
1159                return -EINVAL;
1160        }
1161
1162        /* parse the source unit */
1163        if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
1164                return err;
1165
1166        /* determine the input source type and name */
1167        if (check_input_term(state, hdr->bSourceID, &iterm) < 0)
1168                return -EINVAL;
1169
1170        master_bits = snd_usb_combine_bytes(bmaControls, csize);
1171        /* master configuration quirks */
1172        switch (state->chip->usb_id) {
1173        case USB_ID(0x08bb, 0x2702):
1174                snd_printk(KERN_INFO
1175                           "usbmixer: master volume quirk for PCM2702 chip\n");
1176                /* disable non-functional volume control */
1177                master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
1178                break;
1179        }
1180        if (channels > 0)
1181                first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
1182        else
1183                first_ch_bits = 0;
1184
1185        if (state->mixer->protocol == UAC_VERSION_1) {
1186                /* check all control types */
1187                for (i = 0; i < 10; i++) {
1188                        unsigned int ch_bits = 0;
1189                        for (j = 0; j < channels; j++) {
1190                                unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1191                                if (mask & (1 << i))
1192                                        ch_bits |= (1 << j);
1193                        }
1194                        /* audio class v1 controls are never read-only */
1195                        if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1196                                build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
1197                        if (master_bits & (1 << i))
1198                                build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
1199                }
1200        } else { /* UAC_VERSION_2 */
1201                for (i = 0; i < 30/2; i++) {
1202                        /* From the USB Audio spec v2.0:
1203                           bmaControls() is a (ch+1)-element array of 4-byte bitmaps,
1204                           each containing a set of bit pairs. If a Control is present,
1205                           it must be Host readable. If a certain Control is not
1206                           present then the bit pair must be set to 0b00.
1207                           If a Control is present but read-only, the bit pair must be
1208                           set to 0b01. If a Control is also Host programmable, the bit
1209                           pair must be set to 0b11. The value 0b10 is not allowed. */
1210                        unsigned int ch_bits = 0;
1211                        unsigned int ch_read_only = 0;
1212
1213                        for (j = 0; j < channels; j++) {
1214                                unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1215                                if (uac2_control_is_readable(mask, i)) {
1216                                        ch_bits |= (1 << j);
1217                                        if (!uac2_control_is_writeable(mask, i))
1218                                                ch_read_only |= (1 << j);
1219                                }
1220                        }
1221
1222                        /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1223                         * are marked read-only in the descriptors. Otherwise, the control will be
1224                         * reported as writeable, but the driver will not actually issue a write
1225                         * command for read-only channels */
1226                        if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1227                                build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
1228                        if (uac2_control_is_readable(master_bits, i))
1229                                build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
1230                                                  !uac2_control_is_writeable(master_bits, i));
1231                }
1232        }
1233
1234        return 0;
1235}
1236
1237
1238/*
1239 * Mixer Unit
1240 */
1241
1242/*
1243 * build a mixer unit control
1244 *
1245 * the callbacks are identical with feature unit.
1246 * input channel number (zero based) is given in control field instead.
1247 */
1248
1249static void build_mixer_unit_ctl(struct mixer_build *state,
1250                                 struct uac_mixer_unit_descriptor *desc,
1251                                 int in_pin, int in_ch, int unitid,
1252                                 struct usb_audio_term *iterm)
1253{
1254        struct usb_mixer_elem_info *cval;
1255        unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
1256        unsigned int i, len;
1257        struct snd_kcontrol *kctl;
1258        const struct usbmix_name_map *map;
1259
1260        map = find_map(state, unitid, 0);
1261        if (check_ignored_ctl(map))
1262                return;
1263
1264        cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1265        if (! cval)
1266                return;
1267
1268        cval->mixer = state->mixer;
1269        cval->id = unitid;
1270        cval->control = in_ch + 1; /* based on 1 */
1271        cval->val_type = USB_MIXER_S16;
1272        for (i = 0; i < num_outs; i++) {
1273                if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
1274                        cval->cmask |= (1 << i);
1275                        cval->channels++;
1276                }
1277        }
1278
1279        /* get min/max values */
1280        get_min_max(cval, 0);
1281
1282        kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1283        if (! kctl) {
1284                snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1285                kfree(cval);
1286                return;
1287        }
1288        kctl->private_free = usb_mixer_elem_free;
1289
1290        len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1291        if (! len)
1292                len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1293        if (! len)
1294                len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
1295        append_ctl_name(kctl, " Volume");
1296
1297        snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1298                    cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1299        add_control_to_empty(state, kctl);
1300}
1301
1302
1303/*
1304 * parse a mixer unit
1305 */
1306static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
1307{
1308        struct uac_mixer_unit_descriptor *desc = raw_desc;
1309        struct usb_audio_term iterm;
1310        int input_pins, num_ins, num_outs;
1311        int pin, ich, err;
1312
1313        if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
1314                snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1315                return -EINVAL;
1316        }
1317        /* no bmControls field (e.g. Maya44) -> ignore */
1318        if (desc->bLength <= 10 + input_pins) {
1319                snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1320                return 0;
1321        }
1322
1323        num_ins = 0;
1324        ich = 0;
1325        for (pin = 0; pin < input_pins; pin++) {
1326                err = parse_audio_unit(state, desc->baSourceID[pin]);
1327                if (err < 0)
1328                        return err;
1329                err = check_input_term(state, desc->baSourceID[pin], &iterm);
1330                if (err < 0)
1331                        return err;
1332                num_ins += iterm.channels;
1333                for (; ich < num_ins; ++ich) {
1334                        int och, ich_has_controls = 0;
1335
1336                        for (och = 0; och < num_outs; ++och) {
1337                                if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
1338                                                        ich, och, num_outs)) {
1339                                        ich_has_controls = 1;
1340                                        break;
1341                                }
1342                        }
1343                        if (ich_has_controls)
1344                                build_mixer_unit_ctl(state, desc, pin, ich,
1345                                                     unitid, &iterm);
1346                }
1347        }
1348        return 0;
1349}
1350
1351
1352/*
1353 * Processing Unit / Extension Unit
1354 */
1355
1356/* get callback for processing/extension unit */
1357static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1358{
1359        struct usb_mixer_elem_info *cval = kcontrol->private_data;
1360        int err, val;
1361
1362        err = get_cur_ctl_value(cval, cval->control << 8, &val);
1363        if (err < 0 && cval->mixer->ignore_ctl_error) {
1364                ucontrol->value.integer.value[0] = cval->min;
1365                return 0;
1366        }
1367        if (err < 0)
1368                return err;
1369        val = get_relative_value(cval, val);
1370        ucontrol->value.integer.value[0] = val;
1371        return 0;
1372}
1373
1374/* put callback for processing/extension unit */
1375static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1376{
1377        struct usb_mixer_elem_info *cval = kcontrol->private_data;
1378        int val, oval, err;
1379
1380        err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1381        if (err < 0) {
1382                if (cval->mixer->ignore_ctl_error)
1383                        return 0;
1384                return err;
1385        }
1386        val = ucontrol->value.integer.value[0];
1387        val = get_abs_value(cval, val);
1388        if (val != oval) {
1389                set_cur_ctl_value(cval, cval->control << 8, val);
1390                return 1;
1391        }
1392        return 0;
1393}
1394
1395/* alsa control interface for processing/extension unit */
1396static struct snd_kcontrol_new mixer_procunit_ctl = {
1397        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1398        .name = "", /* will be filled later */
1399        .info = mixer_ctl_feature_info,
1400        .get = mixer_ctl_procunit_get,
1401        .put = mixer_ctl_procunit_put,
1402};
1403
1404
1405/*
1406 * predefined data for processing units
1407 */
1408struct procunit_value_info {
1409        int control;
1410        char *suffix;
1411        int val_type;
1412        int min_value;
1413};
1414
1415struct procunit_info {
1416        int type;
1417        char *name;
1418        struct procunit_value_info *values;
1419};
1420
1421static struct procunit_value_info updown_proc_info[] = {
1422        { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1423        { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1424        { 0 }
1425};
1426static struct procunit_value_info prologic_proc_info[] = {
1427        { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1428        { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
1429        { 0 }
1430};
1431static struct procunit_value_info threed_enh_proc_info[] = {
1432        { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1433        { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
1434        { 0 }
1435};
1436static struct procunit_value_info reverb_proc_info[] = {
1437        { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1438        { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1439        { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1440        { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
1441        { 0 }
1442};
1443static struct procunit_value_info chorus_proc_info[] = {
1444        { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1445        { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1446        { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1447        { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
1448        { 0 }
1449};
1450static struct procunit_value_info dcr_proc_info[] = {
1451        { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1452        { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1453        { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1454        { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1455        { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1456        { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
1457        { 0 }
1458};
1459
1460static struct procunit_info procunits[] = {
1461        { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1462        { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1463        { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1464        { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1465        { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1466        { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
1467        { 0 },
1468};
1469/*
1470 * predefined data for extension units
1471 */
1472static struct procunit_value_info clock_rate_xu_info[] = {
1473        { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1474        { 0 }
1475};
1476static struct procunit_value_info clock_source_xu_info[] = {
1477        { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1478        { 0 }
1479};
1480static struct procunit_value_info spdif_format_xu_info[] = {
1481        { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1482        { 0 }
1483};
1484static struct procunit_value_info soft_limit_xu_info[] = {
1485        { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1486        { 0 }
1487};
1488static struct procunit_info extunits[] = {
1489        { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1490        { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1491        { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1492        { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1493        { 0 }
1494};
1495/*
1496 * build a processing/extension unit
1497 */
1498static int build_audio_procunit(struct mixer_build *state, int unitid, void *raw_desc, struct procunit_info *list, char *name)
1499{
1500        struct uac_processing_unit_descriptor *desc = raw_desc;
1501        int num_ins = desc->bNrInPins;
1502        struct usb_mixer_elem_info *cval;
1503        struct snd_kcontrol *kctl;
1504        int i, err, nameid, type, len;
1505        struct procunit_info *info;
1506        struct procunit_value_info *valinfo;
1507        const struct usbmix_name_map *map;
1508        static struct procunit_value_info default_value_info[] = {
1509                { 0x01, "Switch", USB_MIXER_BOOLEAN },
1510                { 0 }
1511        };
1512        static struct procunit_info default_info = {
1513                0, NULL, default_value_info
1514        };
1515
1516        if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1517            desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
1518                snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1519                return -EINVAL;
1520        }
1521
1522        for (i = 0; i < num_ins; i++) {
1523                if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1524                        return err;
1525        }
1526
1527        type = le16_to_cpu(desc->wProcessType);
1528        for (info = list; info && info->type; info++)
1529                if (info->type == type)
1530                        break;
1531        if (! info || ! info->type)
1532                info = &default_info;
1533
1534        for (valinfo = info->values; valinfo->control; valinfo++) {
1535                __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
1536
1537                if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
1538                        continue;
1539                map = find_map(state, unitid, valinfo->control);
1540                if (check_ignored_ctl(map))
1541                        continue;
1542                cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1543                if (! cval) {
1544                        snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1545                        return -ENOMEM;
1546                }
1547                cval->mixer = state->mixer;
1548                cval->id = unitid;
1549                cval->control = valinfo->control;
1550                cval->val_type = valinfo->val_type;
1551                cval->channels = 1;
1552
1553                /* get min/max values */
1554                if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
1555                        __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
1556                        /* FIXME: hard-coded */
1557                        cval->min = 1;
1558                        cval->max = control_spec[0];
1559                        cval->res = 1;
1560                        cval->initialized = 1;
1561                } else {
1562                        if (type == USB_XU_CLOCK_RATE) {
1563                                /* E-Mu USB 0404/0202/TrackerPre
1564                                 * samplerate control quirk
1565                                 */
1566                                cval->min = 0;
1567                                cval->max = 5;
1568                                cval->res = 1;
1569                                cval->initialized = 1;
1570                        } else
1571                                get_min_max(cval, valinfo->min_value);
1572                }
1573
1574                kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1575                if (! kctl) {
1576                        snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1577                        kfree(cval);
1578                        return -ENOMEM;
1579                }
1580                kctl->private_free = usb_mixer_elem_free;
1581
1582                if (check_mapped_name(map, kctl->id.name,
1583                                                sizeof(kctl->id.name)))
1584                        /* nothing */ ;
1585                else if (info->name)
1586                        strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1587                else {
1588                        nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
1589                        len = 0;
1590                        if (nameid)
1591                                len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1592                        if (! len)
1593                                strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1594                }
1595                append_ctl_name(kctl, " ");
1596                append_ctl_name(kctl, valinfo->suffix);
1597
1598                snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1599                            cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
1600                if ((err = add_control_to_empty(state, kctl)) < 0)
1601                        return err;
1602        }
1603        return 0;
1604}
1605
1606
1607static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
1608{
1609        return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
1610}
1611
1612static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
1613{
1614        /* Note that we parse extension units with processing unit descriptors.
1615         * That's ok as the layout is the same */
1616        return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit");
1617}
1618
1619
1620/*
1621 * Selector Unit
1622 */
1623
1624/* info callback for selector unit
1625 * use an enumerator type for routing
1626 */
1627static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
1628{
1629        struct usb_mixer_elem_info *cval = kcontrol->private_data;
1630        char **itemlist = (char **)kcontrol->private_value;
1631
1632        if (snd_BUG_ON(!itemlist))
1633                return -EINVAL;
1634        uinfo->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
1635        uinfo->count = 1;
1636        uinfo->value.enumerated.items = cval->max;
1637        if ((int)uinfo->value.enumerated.item >= cval->max)
1638                uinfo->value.enumerated.item = cval->max - 1;
1639        strcpy(uinfo->value.enumerated.name, itemlist[uinfo->value.enumerated.item]);
1640        return 0;
1641}
1642
1643/* get callback for selector unit */
1644static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1645{
1646        struct usb_mixer_elem_info *cval = kcontrol->private_data;
1647        int val, err;
1648
1649        err = get_cur_ctl_value(cval, cval->control << 8, &val);
1650        if (err < 0) {
1651                if (cval->mixer->ignore_ctl_error) {
1652                        ucontrol->value.enumerated.item[0] = 0;
1653                        return 0;
1654                }
1655                return err;
1656        }
1657        val = get_relative_value(cval, val);
1658        ucontrol->value.enumerated.item[0] = val;
1659        return 0;
1660}
1661
1662/* put callback for selector unit */
1663static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
1664{
1665        struct usb_mixer_elem_info *cval = kcontrol->private_data;
1666        int val, oval, err;
1667
1668        err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1669        if (err < 0) {
1670                if (cval->mixer->ignore_ctl_error)
1671                        return 0;
1672                return err;
1673        }
1674        val = ucontrol->value.enumerated.item[0];
1675        val = get_abs_value(cval, val);
1676        if (val != oval) {
1677                set_cur_ctl_value(cval, cval->control << 8, val);
1678                return 1;
1679        }
1680        return 0;
1681}
1682
1683/* alsa control interface for selector unit */
1684static struct snd_kcontrol_new mixer_selectunit_ctl = {
1685        .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1686        .name = "", /* will be filled later */
1687        .info = mixer_ctl_selector_info,
1688        .get = mixer_ctl_selector_get,
1689        .put = mixer_ctl_selector_put,
1690};
1691
1692
1693/* private free callback.
1694 * free both private_data and private_value
1695 */
1696static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
1697{
1698        int i, num_ins = 0;
1699
1700        if (kctl->private_data) {
1701                struct usb_mixer_elem_info *cval = kctl->private_data;
1702                num_ins = cval->max;
1703                kfree(cval);
1704                kctl->private_data = NULL;
1705        }
1706        if (kctl->private_value) {
1707                char **itemlist = (char **)kctl->private_value;
1708                for (i = 0; i < num_ins; i++)
1709                        kfree(itemlist[i]);
1710                kfree(itemlist);
1711                kctl->private_value = 0;
1712        }
1713}
1714
1715/*
1716 * parse a selector unit
1717 */
1718static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
1719{
1720        struct uac_selector_unit_descriptor *desc = raw_desc;
1721        unsigned int i, nameid, len;
1722        int err;
1723        struct usb_mixer_elem_info *cval;
1724        struct snd_kcontrol *kctl;
1725        const struct usbmix_name_map *map;
1726        char **namelist;
1727
1728        if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
1729                snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1730                return -EINVAL;
1731        }
1732
1733        for (i = 0; i < desc->bNrInPins; i++) {
1734                if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
1735                        return err;
1736        }
1737
1738        if (desc->bNrInPins == 1) /* only one ? nonsense! */
1739                return 0;
1740
1741        map = find_map(state, unitid, 0);
1742        if (check_ignored_ctl(map))
1743                return 0;
1744
1745        cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1746        if (! cval) {
1747                snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1748                return -ENOMEM;
1749        }
1750        cval->mixer = state->mixer;
1751        cval->id = unitid;
1752        cval->val_type = USB_MIXER_U8;
1753        cval->channels = 1;
1754        cval->min = 1;
1755        cval->max = desc->bNrInPins;
1756        cval->res = 1;
1757        cval->initialized = 1;
1758
1759        if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1760                cval->control = UAC2_CX_CLOCK_SELECTOR;
1761        else
1762                cval->control = 0;
1763
1764        namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
1765        if (! namelist) {
1766                snd_printk(KERN_ERR "cannot malloc\n");
1767                kfree(cval);
1768                return -ENOMEM;
1769        }
1770#define MAX_ITEM_NAME_LEN       64
1771        for (i = 0; i < desc->bNrInPins; i++) {
1772                struct usb_audio_term iterm;
1773                len = 0;
1774                namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1775                if (! namelist[i]) {
1776                        snd_printk(KERN_ERR "cannot malloc\n");
1777                        while (i--)
1778                                kfree(namelist[i]);
1779                        kfree(namelist);
1780                        kfree(cval);
1781                        return -ENOMEM;
1782                }
1783                len = check_mapped_selector_name(state, unitid, i, namelist[i],
1784                                                 MAX_ITEM_NAME_LEN);
1785                if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
1786                        len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1787                if (! len)
1788                        sprintf(namelist[i], "Input %d", i);
1789        }
1790
1791        kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1792        if (! kctl) {
1793                snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1794                kfree(namelist);
1795                kfree(cval);
1796                return -ENOMEM;
1797        }
1798        kctl->private_value = (unsigned long)namelist;
1799        kctl->private_free = usb_mixer_selector_elem_free;
1800
1801        nameid = uac_selector_unit_iSelector(desc);
1802        len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
1803        if (len)
1804                ;
1805        else if (nameid)
1806                snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1807        else {
1808                len = get_term_name(state, &state->oterm,
1809                                    kctl->id.name, sizeof(kctl->id.name), 0);
1810                if (! len)
1811                        strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
1812
1813                if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1814                        append_ctl_name(kctl, " Clock Source");
1815                else if ((state->oterm.type & 0xff00) == 0x0100)
1816                        append_ctl_name(kctl, " Capture Source");
1817                else
1818                        append_ctl_name(kctl, " Playback Source");
1819        }
1820
1821        snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
1822                    cval->id, kctl->id.name, desc->bNrInPins);
1823        if ((err = add_control_to_empty(state, kctl)) < 0)
1824                return err;
1825
1826        return 0;
1827}
1828
1829
1830/*
1831 * parse an audio unit recursively
1832 */
1833
1834static int parse_audio_unit(struct mixer_build *state, int unitid)
1835{
1836        unsigned char *p1;
1837
1838        if (test_and_set_bit(unitid, state->unitbitmap))
1839                return 0; /* the unit already visited */
1840
1841        p1 = find_audio_control_unit(state, unitid);
1842        if (!p1) {
1843                snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
1844                return -EINVAL;
1845        }
1846
1847        switch (p1[2]) {
1848        case UAC_INPUT_TERMINAL:
1849        case UAC2_CLOCK_SOURCE:
1850                return 0; /* NOP */
1851        case UAC_MIXER_UNIT:
1852                return parse_audio_mixer_unit(state, unitid, p1);
1853        case UAC_SELECTOR_UNIT:
1854        case UAC2_CLOCK_SELECTOR:
1855                return parse_audio_selector_unit(state, unitid, p1);
1856        case UAC_FEATURE_UNIT:
1857                return parse_audio_feature_unit(state, unitid, p1);
1858        case UAC_PROCESSING_UNIT_V1:
1859        /*   UAC2_EFFECT_UNIT has the same value */
1860                if (state->mixer->protocol == UAC_VERSION_1)
1861                        return parse_audio_processing_unit(state, unitid, p1);
1862                else
1863                        return 0; /* FIXME - effect units not implemented yet */
1864        case UAC_EXTENSION_UNIT_V1:
1865        /*   UAC2_PROCESSING_UNIT_V2 has the same value */
1866                if (state->mixer->protocol == UAC_VERSION_1)
1867                        return parse_audio_extension_unit(state, unitid, p1);
1868                else /* UAC_VERSION_2 */
1869                        return parse_audio_processing_unit(state, unitid, p1);
1870        default:
1871                snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
1872                return -EINVAL;
1873        }
1874}
1875
1876static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
1877{
1878        kfree(mixer->id_elems);
1879        if (mixer->urb) {
1880                kfree(mixer->urb->transfer_buffer);
1881                usb_free_urb(mixer->urb);
1882        }
1883        usb_free_urb(mixer->rc_urb);
1884        kfree(mixer->rc_setup_packet);
1885        kfree(mixer);
1886}
1887
1888static int snd_usb_mixer_dev_free(struct snd_device *device)
1889{
1890        struct usb_mixer_interface *mixer = device->device_data;
1891        snd_usb_mixer_free(mixer);
1892        return 0;
1893}
1894
1895/*
1896 * create mixer controls
1897 *
1898 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
1899 */
1900static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
1901{
1902        struct mixer_build state;
1903        int err;
1904        const struct usbmix_ctl_map *map;
1905        struct usb_host_interface *hostif;
1906        void *p;
1907
1908        hostif = &usb_ifnum_to_if(mixer->chip->dev, mixer->ctrlif)->altsetting[0];
1909        memset(&state, 0, sizeof(state));
1910        state.chip = mixer->chip;
1911        state.mixer = mixer;
1912        state.buffer = hostif->extra;
1913        state.buflen = hostif->extralen;
1914
1915        /* check the mapping table */
1916        for (map = usbmix_ctl_maps; map->id; map++) {
1917                if (map->id == state.chip->usb_id) {
1918                        state.map = map->map;
1919                        state.selector_map = map->selector_map;
1920                        mixer->ignore_ctl_error = map->ignore_ctl_error;
1921                        break;
1922                }
1923        }
1924
1925        p = NULL;
1926        while ((p = snd_usb_find_csint_desc(hostif->extra, hostif->extralen, p, UAC_OUTPUT_TERMINAL)) != NULL) {
1927                if (mixer->protocol == UAC_VERSION_1) {
1928                        struct uac_output_terminal_descriptor_v1 *desc = p;
1929
1930                        if (desc->bLength < sizeof(*desc))
1931                                continue; /* invalid descriptor? */
1932                        set_bit(desc->bTerminalID, state.unitbitmap);  /* mark terminal ID as visited */
1933                        state.oterm.id = desc->bTerminalID;
1934                        state.oterm.type = le16_to_cpu(desc->wTerminalType);
1935                        state.oterm.name = desc->iTerminal;
1936                        err = parse_audio_unit(&state, desc->bSourceID);
1937                        if (err < 0)
1938                                return err;
1939                } else { /* UAC_VERSION_2 */
1940                        struct uac2_output_terminal_descriptor *desc = p;
1941
1942                        if (desc->bLength < sizeof(*desc))
1943                                continue; /* invalid descriptor? */
1944                        set_bit(desc->bTerminalID, state.unitbitmap);  /* mark terminal ID as visited */
1945                        state.oterm.id = desc->bTerminalID;
1946                        state.oterm.type = le16_to_cpu(desc->wTerminalType);
1947                        state.oterm.name = desc->iTerminal;
1948                        err = parse_audio_unit(&state, desc->bSourceID);
1949                        if (err < 0)
1950                                return err;
1951
1952                        /* for UAC2, use the same approach to also add the clock selectors */
1953                        err = parse_audio_unit(&state, desc->bCSourceID);
1954                        if (err < 0)
1955                                return err;
1956                }
1957        }
1958
1959        return 0;
1960}
1961
1962void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
1963{
1964        struct usb_mixer_elem_info *info;
1965
1966        for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
1967                snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
1968                               info->elem_id);
1969}
1970
1971static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
1972                                    int unitid,
1973                                    struct usb_mixer_elem_info *cval)
1974{
1975        static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
1976                                    "S8", "U8", "S16", "U16"};
1977        snd_iprintf(buffer, "  Unit: %i\n", unitid);
1978        if (cval->elem_id)
1979                snd_iprintf(buffer, "    Control: name=\"%s\", index=%i\n",
1980                                cval->elem_id->name, cval->elem_id->index);
1981        snd_iprintf(buffer, "    Info: id=%i, control=%i, cmask=0x%x, "
1982                            "channels=%i, type=\"%s\"\n", cval->id,
1983                            cval->control, cval->cmask, cval->channels,
1984                            val_types[cval->val_type]);
1985        snd_iprintf(buffer, "    Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
1986                            cval->min, cval->max, cval->dBmin, cval->dBmax);
1987}
1988
1989static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
1990                                    struct snd_info_buffer *buffer)
1991{
1992        struct snd_usb_audio *chip = entry->private_data;
1993        struct usb_mixer_interface *mixer;
1994        struct usb_mixer_elem_info *cval;
1995        int unitid;
1996
1997        list_for_each_entry(mixer, &chip->mixer_list, list) {
1998                snd_iprintf(buffer,
1999                        "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
2000                                chip->usb_id, mixer->ctrlif,
2001                                mixer->ignore_ctl_error);
2002                snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2003                for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2004                        for (cval = mixer->id_elems[unitid]; cval;
2005                                                cval = cval->next_id_elem)
2006                                snd_usb_mixer_dump_cval(buffer, unitid, cval);
2007                }
2008        }
2009}
2010
2011static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2012                                       int attribute, int value, int index)
2013{
2014        struct usb_mixer_elem_info *info;
2015        __u8 unitid = (index >> 8) & 0xff;
2016        __u8 control = (value >> 8) & 0xff;
2017        __u8 channel = value & 0xff;
2018
2019        if (channel >= MAX_CHANNELS) {
2020                snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
2021                                __func__, channel);
2022                return;
2023        }
2024
2025        for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
2026                if (info->control != control)
2027                        continue;
2028
2029                switch (attribute) {
2030                case UAC2_CS_CUR:
2031                        /* invalidate cache, so the value is read from the device */
2032                        if (channel)
2033                                info->cached &= ~(1 << channel);
2034                        else /* master channel */
2035                                info->cached = 0;
2036
2037                        snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2038                                        info->elem_id);
2039                        break;
2040
2041                case UAC2_CS_RANGE:
2042                        /* TODO */
2043                        break;
2044
2045                case UAC2_CS_MEM:
2046                        /* TODO */
2047                        break;
2048
2049                default:
2050                        snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
2051                                                attribute);
2052                        break;
2053                } /* switch */
2054        }
2055}
2056
2057static void snd_usb_mixer_interrupt(struct urb *urb)
2058{
2059        struct usb_mixer_interface *mixer = urb->context;
2060        int len = urb->actual_length;
2061
2062        if (urb->status != 0)
2063                goto requeue;
2064
2065        if (mixer->protocol == UAC_VERSION_1) {
2066                struct uac1_status_word *status;
2067
2068                for (status = urb->transfer_buffer;
2069                     len >= sizeof(*status);
2070                     len -= sizeof(*status), status++) {
2071                        snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
2072                                                status->bStatusType,
2073                                                status->bOriginator);
2074
2075                        /* ignore any notifications not from the control interface */
2076                        if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2077                                UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
2078                                continue;
2079
2080                        if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2081                                snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
2082                        else
2083                                snd_usb_mixer_notify_id(mixer, status->bOriginator);
2084                }
2085        } else { /* UAC_VERSION_2 */
2086                struct uac2_interrupt_data_msg *msg;
2087
2088                for (msg = urb->transfer_buffer;
2089                     len >= sizeof(*msg);
2090                     len -= sizeof(*msg), msg++) {
2091                        /* drop vendor specific and endpoint requests */
2092                        if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2093                            (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2094                                continue;
2095
2096                        snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2097                                                   le16_to_cpu(msg->wValue),
2098                                                   le16_to_cpu(msg->wIndex));
2099                }
2100        }
2101
2102requeue:
2103        if (urb->status != -ENOENT && urb->status != -ECONNRESET) {
2104                urb->dev = mixer->chip->dev;
2105                usb_submit_urb(urb, GFP_ATOMIC);
2106        }
2107}
2108
2109/* create the handler for the optional status interrupt endpoint */
2110static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2111{
2112        struct usb_host_interface *hostif;
2113        struct usb_endpoint_descriptor *ep;
2114        void *transfer_buffer;
2115        int buffer_length;
2116        unsigned int epnum;
2117
2118        hostif = &usb_ifnum_to_if(mixer->chip->dev, mixer->ctrlif)->altsetting[0];
2119        /* we need one interrupt input endpoint */
2120        if (get_iface_desc(hostif)->bNumEndpoints < 1)
2121                return 0;
2122        ep = get_endpoint(hostif, 0);
2123        if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
2124                return 0;
2125
2126        epnum = usb_endpoint_num(ep);
2127        buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2128        transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2129        if (!transfer_buffer)
2130                return -ENOMEM;
2131        mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2132        if (!mixer->urb) {
2133                kfree(transfer_buffer);
2134                return -ENOMEM;
2135        }
2136        usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2137                         usb_rcvintpipe(mixer->chip->dev, epnum),
2138                         transfer_buffer, buffer_length,
2139                         snd_usb_mixer_interrupt, mixer, ep->bInterval);
2140        usb_submit_urb(mixer->urb, GFP_KERNEL);
2141        return 0;
2142}
2143
2144int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2145                         int ignore_error)
2146{
2147        static struct snd_device_ops dev_ops = {
2148                .dev_free = snd_usb_mixer_dev_free
2149        };
2150        struct usb_mixer_interface *mixer;
2151        struct snd_info_entry *entry;
2152        struct usb_host_interface *host_iface;
2153        int err;
2154
2155        strcpy(chip->card->mixername, "USB Mixer");
2156
2157        mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
2158        if (!mixer)
2159                return -ENOMEM;
2160        mixer->chip = chip;
2161        mixer->ctrlif = ctrlif;
2162        mixer->ignore_ctl_error = ignore_error;
2163        mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2164                                  GFP_KERNEL);
2165        if (!mixer->id_elems) {
2166                kfree(mixer);
2167                return -ENOMEM;
2168        }
2169
2170        host_iface = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2171        mixer->protocol = get_iface_desc(host_iface)->bInterfaceProtocol;
2172
2173        if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
2174            (err = snd_usb_mixer_status_create(mixer)) < 0)
2175                goto _error;
2176
2177        snd_usb_mixer_apply_create_quirk(mixer);
2178
2179        err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
2180        if (err < 0)
2181                goto _error;
2182
2183        if (list_empty(&chip->mixer_list) &&
2184            !snd_card_proc_new(chip->card, "usbmixer", &entry))
2185                snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2186
2187        list_add(&mixer->list, &chip->mixer_list);
2188        return 0;
2189
2190_error:
2191        snd_usb_mixer_free(mixer);
2192        return err;
2193}
2194
2195void snd_usb_mixer_disconnect(struct list_head *p)
2196{
2197        struct usb_mixer_interface *mixer;
2198
2199        mixer = list_entry(p, struct usb_mixer_interface, list);
2200        usb_kill_urb(mixer->urb);
2201        usb_kill_urb(mixer->rc_urb);
2202}
2203
lxr.linux.no kindly hosted by Redpill Linpro AS, provider of Linux consulting and operations services since 1995.