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