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