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