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