blob: 44b0ba4feab3bd1b43100feb457e82e290ea26dc [file] [log] [blame]
Linus Torvalds1da177e2005-04-16 15:20:36 -07001/*
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
Daniel Mack157a57b2010-06-16 17:57:30 +020029/*
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
Linus Torvalds1da177e2005-04-16 15:20:36 -070045#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>
Daniel Mack28e1b772010-02-22 23:49:09 +010051#include <linux/usb/audio.h>
Daniel Mack23caaf12010-03-11 21:13:25 +010052#include <linux/usb/audio-v2.h>
Daniel Mack28e1b772010-02-22 23:49:09 +010053
Linus Torvalds1da177e2005-04-16 15:20:36 -070054#include <sound/core.h>
55#include <sound/control.h>
Clemens Ladischb259b102005-04-29 16:29:28 +020056#include <sound/hwdep.h>
Clemens Ladischaafad562005-05-10 14:47:38 +020057#include <sound/info.h>
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +020058#include <sound/tlv.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070059
60#include "usbaudio.h"
Daniel Mackf0b5e632010-03-11 21:13:23 +010061#include "mixer.h"
Daniel Macke5779992010-03-04 19:46:13 +010062#include "helper.h"
Daniel Mack7b1eda22010-03-11 21:13:22 +010063#include "mixer_quirks.h"
Oliver Neukum88a85162011-03-11 14:51:12 +010064#include "power.h"
Raimonds Cicans4d1a70d2006-05-05 09:49:53 +020065
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +010066#define MAX_ID_ELEMS 256
67
Linus Torvalds1da177e2005-04-16 15:20:36 -070068struct usb_audio_term {
69 int id;
70 int type;
71 int channels;
72 unsigned int chconfig;
73 int name;
74};
75
76struct usbmix_name_map;
77
Takashi Iwai86e07d32005-11-17 15:08:02 +010078struct mixer_build {
79 struct snd_usb_audio *chip;
Clemens Ladisch84957a82005-04-29 16:23:13 +020080 struct usb_mixer_interface *mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -070081 unsigned char *buffer;
82 unsigned int buflen;
Jaroslav Kysela291186e2010-02-16 11:55:18 +010083 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
Takashi Iwai86e07d32005-11-17 15:08:02 +010084 struct usb_audio_term oterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -070085 const struct usbmix_name_map *map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +020086 const struct usbmix_selector_map *selector_map;
Linus Torvalds1da177e2005-04-16 15:20:36 -070087};
88
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -050089/*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -080090enum {
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};
98enum {
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};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700104
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 */
Daniel Mackf0b5e632010-03-11 21:13:23 +0100110#include "mixer_maps.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700111
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100112static const struct usbmix_name_map *
113find_map(struct mixer_build *state, int unitid, int control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700114{
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100115 const struct usbmix_name_map *p = state->map;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700116
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100117 if (!p)
118 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700119
120 for (p = state->map; p->id; p++) {
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100121 if (p->id == unitid &&
122 (!control || !p->control || control == p->control))
123 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700124 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100125 return NULL;
126}
127
128/* get the mapped name if the unit matches */
129static int
130check_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);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700137}
138
139/* check whether the control should be ignored */
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100140static inline int
141check_ignored_ctl(const struct usbmix_name_map *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700142{
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100143 if (!p || p->name || p->dB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144 return 0;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100145 return 1;
146}
147
148/* dB mapping */
149static inline void check_mapped_dB(const struct usbmix_name_map *p,
150 struct usb_mixer_elem_info *cval)
151{
152 if (p && p->dB) {
153 cval->dBmin = p->dB->min;
154 cval->dBmax = p->dB->max;
Takashi Iwai38b65192011-08-19 07:55:10 +0200155 cval->initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700156 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700157}
158
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200159/* get the mapped selector source name */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100160static int check_mapped_selector_name(struct mixer_build *state, int unitid,
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200161 int index, char *buf, int buflen)
162{
163 const struct usbmix_selector_map *p;
164
165 if (! state->selector_map)
166 return 0;
167 for (p = state->selector_map; p->id; p++) {
168 if (p->id == unitid && index < p->count)
169 return strlcpy(buf, p->names[index], buflen);
170 }
171 return 0;
172}
173
Linus Torvalds1da177e2005-04-16 15:20:36 -0700174/*
175 * find an audio control unit with the given unit id
176 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100177static void *find_audio_control_unit(struct mixer_build *state, unsigned char unit)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178{
Daniel Mack67e1daa2010-05-31 13:35:43 +0200179 /* we just parse the header */
180 struct uac_feature_unit_descriptor *hdr = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700181
Daniel Mack67e1daa2010-05-31 13:35:43 +0200182 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
183 USB_DT_CS_INTERFACE)) != NULL) {
184 if (hdr->bLength >= 4 &&
185 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
186 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
187 hdr->bUnitID == unit)
188 return hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700189 }
Daniel Mack67e1daa2010-05-31 13:35:43 +0200190
Linus Torvalds1da177e2005-04-16 15:20:36 -0700191 return NULL;
192}
193
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194/*
195 * copy a string with the given id
196 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100197static int snd_usb_copy_string_desc(struct mixer_build *state, int index, char *buf, int maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700198{
199 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
200 buf[len] = 0;
201 return len;
202}
203
204/*
205 * convert from the byte/word on usb descriptor to the zero-based integer
206 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100207static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700208{
209 switch (cval->val_type) {
210 case USB_MIXER_BOOLEAN:
211 return !!val;
212 case USB_MIXER_INV_BOOLEAN:
213 return !val;
214 case USB_MIXER_U8:
215 val &= 0xff;
216 break;
217 case USB_MIXER_S8:
218 val &= 0xff;
219 if (val >= 0x80)
220 val -= 0x100;
221 break;
222 case USB_MIXER_U16:
223 val &= 0xffff;
224 break;
225 case USB_MIXER_S16:
226 val &= 0xffff;
227 if (val >= 0x8000)
228 val -= 0x10000;
229 break;
230 }
231 return val;
232}
233
234/*
235 * convert from the zero-based int to the byte/word for usb descriptor
236 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100237static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700238{
239 switch (cval->val_type) {
240 case USB_MIXER_BOOLEAN:
241 return !!val;
242 case USB_MIXER_INV_BOOLEAN:
243 return !val;
244 case USB_MIXER_S8:
245 case USB_MIXER_U8:
246 return val & 0xff;
247 case USB_MIXER_S16:
248 case USB_MIXER_U16:
249 return val & 0xffff;
250 }
251 return 0; /* not reached */
252}
253
Takashi Iwai86e07d32005-11-17 15:08:02 +0100254static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700255{
256 if (! cval->res)
257 cval->res = 1;
258 if (val < cval->min)
259 return 0;
Takashi Iwai14790f12006-03-28 17:58:28 +0200260 else if (val >= cval->max)
261 return (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262 else
263 return (val - cval->min) / cval->res;
264}
265
Takashi Iwai86e07d32005-11-17 15:08:02 +0100266static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700267{
268 if (val < 0)
269 return cval->min;
270 if (! cval->res)
271 cval->res = 1;
272 val *= cval->res;
273 val += cval->min;
274 if (val > cval->max)
275 return cval->max;
276 return val;
277}
278
279
280/*
281 * retrieve a mixer value
282 */
283
Daniel Mack23caaf12010-03-11 21:13:25 +0100284static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700285{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200286 struct snd_usb_audio *chip = cval->mixer->chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700287 unsigned char buf[2];
288 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
289 int timeout = 10;
Takashi Iwai978520b2012-10-12 15:12:55 +0200290 int idx = 0, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700291
Oliver Neukum88a85162011-03-11 14:51:12 +0100292 err = snd_usb_autoresume(cval->mixer->chip);
293 if (err < 0)
294 return -EIO;
Takashi Iwai34f3c892012-10-15 12:16:02 +0200295 down_read(&chip->shutdown_rwsem);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700296 while (timeout-- > 0) {
Takashi Iwai978520b2012-10-12 15:12:55 +0200297 if (chip->shutdown)
298 break;
299 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200300 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Takashi Iwai978520b2012-10-12 15:12:55 +0200302 validx, idx, buf, val_len) >= val_len) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700303 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
Takashi Iwai978520b2012-10-12 15:12:55 +0200304 err = 0;
305 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700306 }
307 }
Clemens Ladisch84957a82005-04-29 16:23:13 +0200308 snd_printdd(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
Takashi Iwai978520b2012-10-12 15:12:55 +0200309 request, validx, idx, cval->val_type);
310 err = -EINVAL;
311
312 out:
Takashi Iwai34f3c892012-10-15 12:16:02 +0200313 up_read(&chip->shutdown_rwsem);
Takashi Iwai978520b2012-10-12 15:12:55 +0200314 snd_usb_autosuspend(cval->mixer->chip);
315 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700316}
317
Daniel Mack23caaf12010-03-11 21:13:25 +0100318static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
319{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200320 struct snd_usb_audio *chip = cval->mixer->chip;
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200321 unsigned char buf[2 + 3*sizeof(__u16)]; /* enough space for one range */
Daniel Mack23caaf12010-03-11 21:13:25 +0100322 unsigned char *val;
Takashi Iwai978520b2012-10-12 15:12:55 +0200323 int idx = 0, ret, size;
Daniel Mack23caaf12010-03-11 21:13:25 +0100324 __u8 bRequest;
325
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200326 if (request == UAC_GET_CUR) {
327 bRequest = UAC2_CS_CUR;
328 size = sizeof(__u16);
329 } else {
330 bRequest = UAC2_CS_RANGE;
331 size = sizeof(buf);
332 }
333
334 memset(buf, 0, sizeof(buf));
Daniel Mack23caaf12010-03-11 21:13:25 +0100335
Oliver Neukum88a85162011-03-11 14:51:12 +0100336 ret = snd_usb_autoresume(chip) ? -EIO : 0;
337 if (ret)
338 goto error;
339
Takashi Iwai34f3c892012-10-15 12:16:02 +0200340 down_read(&chip->shutdown_rwsem);
Takashi Iwai978520b2012-10-12 15:12:55 +0200341 if (chip->shutdown)
342 ret = -ENODEV;
343 else {
344 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
345 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
Daniel Mack23caaf12010-03-11 21:13:25 +0100346 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Takashi Iwai978520b2012-10-12 15:12:55 +0200347 validx, idx, buf, size);
348 }
Takashi Iwai34f3c892012-10-15 12:16:02 +0200349 up_read(&chip->shutdown_rwsem);
Oliver Neukum88a85162011-03-11 14:51:12 +0100350 snd_usb_autosuspend(chip);
Daniel Mack23caaf12010-03-11 21:13:25 +0100351
352 if (ret < 0) {
Oliver Neukum88a85162011-03-11 14:51:12 +0100353error:
Daniel Mack09414202010-05-31 13:35:44 +0200354 snd_printk(KERN_ERR "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
Takashi Iwai978520b2012-10-12 15:12:55 +0200355 request, validx, idx, cval->val_type);
Daniel Mack23caaf12010-03-11 21:13:25 +0100356 return ret;
357 }
358
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200359 /* FIXME: how should we handle multiple triplets here? */
360
Daniel Mack23caaf12010-03-11 21:13:25 +0100361 switch (request) {
362 case UAC_GET_CUR:
363 val = buf;
364 break;
365 case UAC_GET_MIN:
366 val = buf + sizeof(__u16);
367 break;
368 case UAC_GET_MAX:
369 val = buf + sizeof(__u16) * 2;
370 break;
371 case UAC_GET_RES:
372 val = buf + sizeof(__u16) * 3;
373 break;
374 default:
375 return -EINVAL;
376 }
377
378 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
379
380 return 0;
381}
382
383static int get_ctl_value(struct usb_mixer_elem_info *cval, int request, int validx, int *value_ret)
384{
Eldad Zack9f814102012-11-28 23:55:35 +0100385 validx += cval->idx_off;
386
Daniel Mack23caaf12010-03-11 21:13:25 +0100387 return (cval->mixer->protocol == UAC_VERSION_1) ?
388 get_ctl_value_v1(cval, request, validx, value_ret) :
389 get_ctl_value_v2(cval, request, validx, value_ret);
390}
391
Takashi Iwai86e07d32005-11-17 15:08:02 +0100392static int get_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700393{
Daniel Mackde48c7b2010-02-22 23:49:13 +0100394 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700395}
396
397/* channel = 0: master, 1 = first channel */
Takashi Iwai641b4872009-01-15 17:05:24 +0100398static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
399 int channel, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700400{
Daniel Mackde48c7b2010-02-22 23:49:13 +0100401 return get_ctl_value(cval, UAC_GET_CUR, (cval->control << 8) | channel, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700402}
403
Takashi Iwai641b4872009-01-15 17:05:24 +0100404static int get_cur_mix_value(struct usb_mixer_elem_info *cval,
405 int channel, int index, int *value)
406{
407 int err;
408
409 if (cval->cached & (1 << channel)) {
410 *value = cval->cache_val[index];
411 return 0;
412 }
413 err = get_cur_mix_raw(cval, channel, value);
414 if (err < 0) {
415 if (!cval->mixer->ignore_ctl_error)
Daniel Mack23caaf12010-03-11 21:13:25 +0100416 snd_printd(KERN_ERR "cannot get current value for control %d ch %d: err = %d\n",
Takashi Iwai641b4872009-01-15 17:05:24 +0100417 cval->control, channel, err);
418 return err;
419 }
420 cval->cached |= 1 << channel;
421 cval->cache_val[index] = *value;
422 return 0;
423}
424
425
Linus Torvalds1da177e2005-04-16 15:20:36 -0700426/*
427 * set a mixer value
428 */
429
Daniel Mack7b1eda22010-03-11 21:13:22 +0100430int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
431 int request, int validx, int value_set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700432{
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200433 struct snd_usb_audio *chip = cval->mixer->chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700434 unsigned char buf[2];
Takashi Iwai978520b2012-10-12 15:12:55 +0200435 int idx = 0, val_len, err, timeout = 10;
Daniel Mack23caaf12010-03-11 21:13:25 +0100436
Eldad Zack9f814102012-11-28 23:55:35 +0100437 validx += cval->idx_off;
438
Daniel Mack23caaf12010-03-11 21:13:25 +0100439 if (cval->mixer->protocol == UAC_VERSION_1) {
440 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
441 } else { /* UAC_VERSION_2 */
442 /* audio class v2 controls are always 2 bytes in size */
443 val_len = sizeof(__u16);
444
445 /* FIXME */
446 if (request != UAC_SET_CUR) {
447 snd_printdd(KERN_WARNING "RANGE setting not yet supported\n");
448 return -EINVAL;
449 }
450
451 request = UAC2_CS_CUR;
452 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453
454 value_set = convert_bytes_value(cval, value_set);
455 buf[0] = value_set & 0xff;
456 buf[1] = (value_set >> 8) & 0xff;
Oliver Neukum88a85162011-03-11 14:51:12 +0100457 err = snd_usb_autoresume(chip);
458 if (err < 0)
459 return -EIO;
Takashi Iwai34f3c892012-10-15 12:16:02 +0200460 down_read(&chip->shutdown_rwsem);
Takashi Iwai978520b2012-10-12 15:12:55 +0200461 while (timeout-- > 0) {
462 if (chip->shutdown)
463 break;
464 idx = snd_usb_ctrl_intf(chip) | (cval->id << 8);
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200465 if (snd_usb_ctl_msg(chip->dev,
466 usb_sndctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700467 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
Takashi Iwai978520b2012-10-12 15:12:55 +0200468 validx, idx, buf, val_len) >= 0) {
469 err = 0;
470 goto out;
Oliver Neukum88a85162011-03-11 14:51:12 +0100471 }
Takashi Iwai978520b2012-10-12 15:12:55 +0200472 }
Clemens Ladisch84957a82005-04-29 16:23:13 +0200473 snd_printdd(KERN_ERR "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
Takashi Iwai978520b2012-10-12 15:12:55 +0200474 request, validx, idx, cval->val_type, buf[0], buf[1]);
475 err = -EINVAL;
476
477 out:
Takashi Iwai34f3c892012-10-15 12:16:02 +0200478 up_read(&chip->shutdown_rwsem);
Takashi Iwai978520b2012-10-12 15:12:55 +0200479 snd_usb_autosuspend(chip);
480 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700481}
482
Takashi Iwai86e07d32005-11-17 15:08:02 +0100483static int set_cur_ctl_value(struct usb_mixer_elem_info *cval, int validx, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700484{
Daniel Mack7b1eda22010-03-11 21:13:22 +0100485 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700486}
487
Takashi Iwai641b4872009-01-15 17:05:24 +0100488static int set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
489 int index, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700490{
Takashi Iwai641b4872009-01-15 17:05:24 +0100491 int err;
Daniel Macka6a33252010-05-31 13:35:37 +0200492 unsigned int read_only = (channel == 0) ?
493 cval->master_readonly :
494 cval->ch_readonly & (1 << (channel - 1));
495
496 if (read_only) {
497 snd_printdd(KERN_INFO "%s(): channel %d of control %d is read_only\n",
498 __func__, channel, cval->control);
499 return 0;
500 }
501
Daniel Mack7b1eda22010-03-11 21:13:22 +0100502 err = snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, (cval->control << 8) | channel,
Takashi Iwai641b4872009-01-15 17:05:24 +0100503 value);
504 if (err < 0)
505 return err;
506 cval->cached |= 1 << channel;
507 cval->cache_val[index] = value;
508 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700509}
510
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200511/*
512 * TLV callback for mixer volume controls
513 */
Felix Homann285de9c2012-04-23 20:24:24 +0200514int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200515 unsigned int size, unsigned int __user *_tlv)
516{
517 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Takashi Iwaib8e1c732009-06-16 14:04:37 +0200518 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200519
520 if (size < sizeof(scale))
521 return -ENOMEM;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100522 scale[2] = cval->dBmin;
523 scale[3] = cval->dBmax;
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200524 if (copy_to_user(_tlv, scale, sizeof(scale)))
525 return -EFAULT;
526 return 0;
527}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700528
529/*
530 * parser routines begin here...
531 */
532
Takashi Iwai86e07d32005-11-17 15:08:02 +0100533static int parse_audio_unit(struct mixer_build *state, int unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700534
535
536/*
537 * check if the input/output channel routing is enabled on the given bitmap.
538 * used for mixer unit parser
539 */
540static int check_matrix_bitmap(unsigned char *bmap, int ich, int och, int num_outs)
541{
542 int idx = ich * num_outs + och;
543 return bmap[idx >> 3] & (0x80 >> (idx & 7));
544}
545
546
547/*
548 * add an alsa control element
549 * search and increment the index until an empty slot is found.
550 *
551 * if failed, give up and free the control instance.
552 */
553
Daniel Mackef9d5972011-05-25 09:09:00 +0200554int snd_usb_mixer_add_control(struct usb_mixer_interface *mixer,
555 struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556{
Takashi Iwai86e07d32005-11-17 15:08:02 +0100557 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700558 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +0200559
Daniel Mackef9d5972011-05-25 09:09:00 +0200560 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700561 kctl->id.index++;
Daniel Mackef9d5972011-05-25 09:09:00 +0200562 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700563 snd_printd(KERN_ERR "cannot add control (err = %d)\n", err);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200564 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565 }
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200566 cval->elem_id = &kctl->id;
Daniel Mackef9d5972011-05-25 09:09:00 +0200567 cval->next_id_elem = mixer->id_elems[cval->id];
568 mixer->id_elems[cval->id] = cval;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200569 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570}
571
572
573/*
574 * get a terminal name string
575 */
576
577static struct iterm_name_combo {
578 int type;
579 char *name;
580} iterm_names[] = {
581 { 0x0300, "Output" },
582 { 0x0301, "Speaker" },
583 { 0x0302, "Headphone" },
584 { 0x0303, "HMD Audio" },
585 { 0x0304, "Desktop Speaker" },
586 { 0x0305, "Room Speaker" },
587 { 0x0306, "Com Speaker" },
588 { 0x0307, "LFE" },
589 { 0x0600, "External In" },
590 { 0x0601, "Analog In" },
591 { 0x0602, "Digital In" },
592 { 0x0603, "Line" },
593 { 0x0604, "Legacy In" },
594 { 0x0605, "IEC958 In" },
595 { 0x0606, "1394 DA Stream" },
596 { 0x0607, "1394 DV Stream" },
597 { 0x0700, "Embedded" },
598 { 0x0701, "Noise Source" },
599 { 0x0702, "Equalization Noise" },
600 { 0x0703, "CD" },
601 { 0x0704, "DAT" },
602 { 0x0705, "DCC" },
603 { 0x0706, "MiniDisk" },
604 { 0x0707, "Analog Tape" },
605 { 0x0708, "Phonograph" },
606 { 0x0709, "VCR Audio" },
607 { 0x070a, "Video Disk Audio" },
608 { 0x070b, "DVD Audio" },
609 { 0x070c, "TV Tuner Audio" },
610 { 0x070d, "Satellite Rec Audio" },
611 { 0x070e, "Cable Tuner Audio" },
612 { 0x070f, "DSS Audio" },
613 { 0x0710, "Radio Receiver" },
614 { 0x0711, "Radio Transmitter" },
615 { 0x0712, "Multi-Track Recorder" },
616 { 0x0713, "Synthesizer" },
617 { 0 },
618};
619
Takashi Iwai86e07d32005-11-17 15:08:02 +0100620static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700621 unsigned char *name, int maxlen, int term_only)
622{
623 struct iterm_name_combo *names;
624
625 if (iterm->name)
626 return snd_usb_copy_string_desc(state, iterm->name, name, maxlen);
627
628 /* virtual type - not a real terminal */
629 if (iterm->type >> 16) {
630 if (term_only)
631 return 0;
632 switch (iterm->type >> 16) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100633 case UAC_SELECTOR_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700634 strcpy(name, "Selector"); return 8;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200635 case UAC1_PROCESSING_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700636 strcpy(name, "Process Unit"); return 12;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200637 case UAC1_EXTENSION_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700638 strcpy(name, "Ext Unit"); return 8;
Daniel Mackde48c7b2010-02-22 23:49:13 +0100639 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -0700640 strcpy(name, "Mixer"); return 5;
641 default:
642 return sprintf(name, "Unit %d", iterm->id);
643 }
644 }
645
646 switch (iterm->type & 0xff00) {
647 case 0x0100:
648 strcpy(name, "PCM"); return 3;
649 case 0x0200:
650 strcpy(name, "Mic"); return 3;
651 case 0x0400:
652 strcpy(name, "Headset"); return 7;
653 case 0x0500:
654 strcpy(name, "Phone"); return 5;
655 }
656
657 for (names = iterm_names; names->type; names++)
658 if (names->type == iterm->type) {
659 strcpy(name, names->name);
660 return strlen(names->name);
661 }
662 return 0;
663}
664
665
666/*
667 * parse the source unit recursively until it reaches to a terminal
668 * or a branched unit.
669 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100670static int check_input_term(struct mixer_build *state, int id, struct usb_audio_term *term)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700671{
Daniel Mack09414202010-05-31 13:35:44 +0200672 int err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100673 void *p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700674
675 memset(term, 0, sizeof(*term));
676 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +0100677 unsigned char *hdr = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100679 switch (hdr[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100680 case UAC_INPUT_TERMINAL:
Daniel Mack23caaf12010-03-11 21:13:25 +0100681 if (state->mixer->protocol == UAC_VERSION_1) {
682 struct uac_input_terminal_descriptor *d = p1;
683 term->type = le16_to_cpu(d->wTerminalType);
684 term->channels = d->bNrChannels;
685 term->chconfig = le16_to_cpu(d->wChannelConfig);
686 term->name = d->iTerminal;
687 } else { /* UAC_VERSION_2 */
688 struct uac2_input_terminal_descriptor *d = p1;
689 term->type = le16_to_cpu(d->wTerminalType);
690 term->channels = d->bNrChannels;
691 term->chconfig = le32_to_cpu(d->bmChannelConfig);
692 term->name = d->iTerminal;
Daniel Mack09414202010-05-31 13:35:44 +0200693
694 /* call recursively to get the clock selectors */
695 err = check_input_term(state, d->bCSourceID, term);
696 if (err < 0)
697 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100698 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100700 case UAC_FEATURE_UNIT: {
701 /* the header is the same for v1 and v2 */
702 struct uac_feature_unit_descriptor *d = p1;
Daniel Mack5e688882010-05-08 11:24:56 +0200703 id = d->bSourceID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704 break; /* continue to parse */
Daniel Mack23caaf12010-03-11 21:13:25 +0100705 }
706 case UAC_MIXER_UNIT: {
707 struct uac_mixer_unit_descriptor *d = p1;
708 term->type = d->bDescriptorSubtype << 16; /* virtual type */
709 term->channels = uac_mixer_unit_bNrChannels(d);
710 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
711 term->name = uac_mixer_unit_iMixer(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100713 }
Daniel Mack09414202010-05-31 13:35:44 +0200714 case UAC_SELECTOR_UNIT:
715 case UAC2_CLOCK_SELECTOR: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100716 struct uac_selector_unit_descriptor *d = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700717 /* call recursively to retrieve the channel info */
Daniel Mack4d7b86c2013-03-19 21:09:24 +0100718 err = check_input_term(state, d->baSourceID[0], term);
719 if (err < 0)
720 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100721 term->type = d->bDescriptorSubtype << 16; /* virtual type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700722 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100723 term->name = uac_selector_unit_iSelector(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700724 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100725 }
Daniel Mack69da9bc2010-06-16 17:57:28 +0200726 case UAC1_PROCESSING_UNIT:
Eldad Zack5dae5fd2012-11-28 23:55:36 +0100727 case UAC1_EXTENSION_UNIT:
728 /* UAC2_PROCESSING_UNIT_V2 */
Torstein Hegge61ac5132013-03-19 17:12:14 +0100729 /* UAC2_EFFECT_UNIT */
730 case UAC2_EXTENSION_UNIT_V2: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100731 struct uac_processing_unit_descriptor *d = p1;
Eldad Zack5dae5fd2012-11-28 23:55:36 +0100732
733 if (state->mixer->protocol == UAC_VERSION_2 &&
734 hdr[2] == UAC2_EFFECT_UNIT) {
735 /* UAC2/UAC1 unit IDs overlap here in an
736 * uncompatible way. Ignore this unit for now.
737 */
738 return 0;
739 }
740
Daniel Mack23caaf12010-03-11 21:13:25 +0100741 if (d->bNrInPins) {
742 id = d->baSourceID[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 break; /* continue to parse */
744 }
Daniel Mack23caaf12010-03-11 21:13:25 +0100745 term->type = d->bDescriptorSubtype << 16; /* virtual type */
746 term->channels = uac_processing_unit_bNrChannels(d);
747 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
748 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700749 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100750 }
Daniel Mack09414202010-05-31 13:35:44 +0200751 case UAC2_CLOCK_SOURCE: {
752 struct uac_clock_source_descriptor *d = p1;
753 term->type = d->bDescriptorSubtype << 16; /* virtual type */
754 term->id = id;
755 term->name = d->iClockSource;
756 return 0;
757 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700758 default:
759 return -ENODEV;
760 }
761 }
762 return -ENODEV;
763}
764
765
766/*
767 * Feature Unit
768 */
769
770/* feature unit control information */
771struct usb_feature_control_info {
772 const char *name;
773 unsigned int type; /* control type (mute, volume, etc.) */
774};
775
776static struct usb_feature_control_info audio_feature_info[] = {
Daniel Mack2e0281d2010-05-31 13:35:42 +0200777 { "Mute", USB_MIXER_INV_BOOLEAN },
778 { "Volume", USB_MIXER_S16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700779 { "Tone Control - Bass", USB_MIXER_S8 },
780 { "Tone Control - Mid", USB_MIXER_S8 },
781 { "Tone Control - Treble", USB_MIXER_S8 },
782 { "Graphic Equalizer", USB_MIXER_S8 }, /* FIXME: not implemeted yet */
Daniel Mack2e0281d2010-05-31 13:35:42 +0200783 { "Auto Gain Control", USB_MIXER_BOOLEAN },
784 { "Delay Control", USB_MIXER_U16 },
785 { "Bass Boost", USB_MIXER_BOOLEAN },
786 { "Loudness", USB_MIXER_BOOLEAN },
787 /* UAC2 specific */
788 { "Input Gain Control", USB_MIXER_U16 },
789 { "Input Gain Pad Control", USB_MIXER_BOOLEAN },
790 { "Phase Inverter Control", USB_MIXER_BOOLEAN },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700791};
792
793
794/* private_free callback */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100795static void usb_mixer_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700796{
Jesper Juhl4d572772005-05-30 17:30:32 +0200797 kfree(kctl->private_data);
798 kctl->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700799}
800
801
802/*
803 * interface to ALSA control for feature/mixer units
804 */
805
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100806/* volume control quirks */
807static void volume_control_quirks(struct usb_mixer_elem_info *cval,
808 struct snd_kcontrol *kctl)
809{
810 switch (cval->mixer->chip->usb_id) {
Eldad Zackd50ed622012-11-28 23:55:39 +0100811 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
Matt Gruskine9a25e02013-02-09 12:56:35 -0500812 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
Eldad Zackd50ed622012-11-28 23:55:39 +0100813 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
814 cval->min = 0x0000;
815 cval->max = 0xffff;
816 cval->res = 0x00e6;
817 break;
818 }
819 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
820 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
821 cval->min = 0x00;
822 cval->max = 0xff;
823 break;
824 }
825 if (strstr(kctl->id.name, "Effect Return") != NULL) {
826 cval->min = 0xb706;
827 cval->max = 0xff7b;
828 cval->res = 0x0073;
829 break;
830 }
831 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
832 (strstr(kctl->id.name, "Effect Send") != NULL)) {
833 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
834 cval->max = 0xfcfe;
835 cval->res = 0x0073;
836 }
837 break;
838
Felix Homannd34bf142012-04-23 20:24:27 +0200839 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
840 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
841 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
842 snd_printk(KERN_INFO
843 "usb-audio: set quirk for FTU Effect Duration\n");
844 cval->min = 0x0000;
845 cval->max = 0x7f00;
846 cval->res = 0x0100;
847 break;
848 }
849 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
850 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
851 snd_printk(KERN_INFO
852 "usb-audio: set quirks for FTU Effect Feedback/Volume\n");
853 cval->min = 0x00;
854 cval->max = 0x7f;
855 break;
856 }
857 break;
858
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100859 case USB_ID(0x0471, 0x0101):
860 case USB_ID(0x0471, 0x0104):
861 case USB_ID(0x0471, 0x0105):
862 case USB_ID(0x0672, 0x1041):
863 /* quirk for UDA1321/N101.
864 * note that detection between firmware 2.1.1.7 (N101)
865 * and later 2.1.1.21 is not very clear from datasheets.
866 * I hope that the min value is -15360 for newer firmware --jk
867 */
868 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
869 cval->min == -15616) {
870 snd_printk(KERN_INFO
871 "set volume quirk for UDA1321/N101 chip\n");
872 cval->max = -256;
873 }
874 break;
875
876 case USB_ID(0x046d, 0x09a4):
877 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
878 snd_printk(KERN_INFO
879 "set volume quirk for QuickCam E3500\n");
880 cval->min = 6080;
881 cval->max = 8768;
882 cval->res = 192;
883 }
884 break;
885
886 case USB_ID(0x046d, 0x0808):
887 case USB_ID(0x046d, 0x0809):
Takashi Iwai36691e12013-06-17 10:25:02 +0200888 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
Alexey Fisher55c00082011-11-09 11:39:24 +0100889 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
Takashi Iwai11e70642013-06-05 08:35:26 +0200890 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
Maksim A. Boyko140d37d2013-08-10 12:20:02 +0400891 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100892 case USB_ID(0x046d, 0x0991):
893 /* Most audio usb devices lie about volume resolution.
894 * Most Logitech webcams have res = 384.
895 * Proboly there is some logitech magic behind this number --fishor
896 */
897 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
898 snd_printk(KERN_INFO
899 "set resolution quirk: cval->res = 384\n");
900 cval->res = 384;
901 }
902 break;
903
904 }
905}
906
Linus Torvalds1da177e2005-04-16 15:20:36 -0700907/*
908 * retrieve the minimum and maximum values for the specified control
909 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100910static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
911 int default_min, struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700912{
913 /* for failsafe */
914 cval->min = default_min;
915 cval->max = cval->min + 1;
916 cval->res = 1;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100917 cval->dBmin = cval->dBmax = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700918
919 if (cval->val_type == USB_MIXER_BOOLEAN ||
920 cval->val_type == USB_MIXER_INV_BOOLEAN) {
921 cval->initialized = 1;
922 } else {
923 int minchn = 0;
924 if (cval->cmask) {
925 int i;
926 for (i = 0; i < MAX_CHANNELS; i++)
927 if (cval->cmask & (1 << i)) {
928 minchn = i + 1;
929 break;
930 }
931 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100932 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
933 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +0200934 snd_printd(KERN_ERR "%d:%d: cannot get min/max values for control %d (id %d)\n",
Takashi Iwai1a4e34e2010-09-16 07:42:34 +0200935 cval->id, snd_usb_ctrl_intf(cval->mixer->chip), cval->control, cval->id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700936 return -EINVAL;
937 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100938 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700939 cval->res = 1;
940 } else {
941 int last_valid_res = cval->res;
942
943 while (cval->res > 1) {
Daniel Mack7b1eda22010-03-11 21:13:22 +0100944 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
945 (cval->control << 8) | minchn, cval->res / 2) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700946 break;
947 cval->res /= 2;
948 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100949 if (get_ctl_value(cval, UAC_GET_RES, (cval->control << 8) | minchn, &cval->res) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700950 cval->res = last_valid_res;
951 }
952 if (cval->res == 0)
953 cval->res = 1;
Takashi Iwai14790f12006-03-28 17:58:28 +0200954
955 /* Additional checks for the proper resolution
956 *
957 * Some devices report smaller resolutions than actually
958 * reacting. They don't return errors but simply clip
959 * to the lower aligned value.
960 */
961 if (cval->min + cval->res < cval->max) {
962 int last_valid_res = cval->res;
963 int saved, test, check;
Takashi Iwai641b4872009-01-15 17:05:24 +0100964 get_cur_mix_raw(cval, minchn, &saved);
Takashi Iwai14790f12006-03-28 17:58:28 +0200965 for (;;) {
966 test = saved;
967 if (test < cval->max)
968 test += cval->res;
969 else
970 test -= cval->res;
971 if (test < cval->min || test > cval->max ||
Takashi Iwai641b4872009-01-15 17:05:24 +0100972 set_cur_mix_value(cval, minchn, 0, test) ||
973 get_cur_mix_raw(cval, minchn, &check)) {
Takashi Iwai14790f12006-03-28 17:58:28 +0200974 cval->res = last_valid_res;
975 break;
976 }
977 if (test == check)
978 break;
979 cval->res *= 2;
980 }
Takashi Iwai641b4872009-01-15 17:05:24 +0100981 set_cur_mix_value(cval, minchn, 0, saved);
Takashi Iwai14790f12006-03-28 17:58:28 +0200982 }
983
Linus Torvalds1da177e2005-04-16 15:20:36 -0700984 cval->initialized = 1;
985 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100986
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100987 if (kctl)
988 volume_control_quirks(cval, kctl);
989
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100990 /* USB descriptions contain the dB scale in 1/256 dB unit
991 * while ALSA TLV contains in 1/100 dB unit
992 */
993 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
994 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
995 if (cval->dBmin > cval->dBmax) {
996 /* something is wrong; assume it's either from/to 0dB */
997 if (cval->dBmin < 0)
998 cval->dBmax = 0;
999 else if (cval->dBmin > 0)
1000 cval->dBmin = 0;
1001 if (cval->dBmin > cval->dBmax) {
1002 /* totally crap, return an error */
1003 return -EINVAL;
1004 }
1005 }
1006
Linus Torvalds1da177e2005-04-16 15:20:36 -07001007 return 0;
1008}
1009
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +01001010#define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001011
1012/* get a feature/mixer unit info */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001013static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001014{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001015 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001016
1017 if (cval->val_type == USB_MIXER_BOOLEAN ||
1018 cval->val_type == USB_MIXER_INV_BOOLEAN)
1019 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1020 else
1021 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1022 uinfo->count = cval->channels;
1023 if (cval->val_type == USB_MIXER_BOOLEAN ||
1024 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1025 uinfo->value.integer.min = 0;
1026 uinfo->value.integer.max = 1;
1027 } else {
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +02001028 if (!cval->initialized) {
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +01001029 get_min_max_with_quirks(cval, 0, kcontrol);
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +02001030 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1031 kcontrol->vd[0].access &=
1032 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1033 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
1034 snd_ctl_notify(cval->mixer->chip->card,
1035 SNDRV_CTL_EVENT_MASK_INFO,
1036 &kcontrol->id);
1037 }
1038 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001039 uinfo->value.integer.min = 0;
Takashi Iwai14790f12006-03-28 17:58:28 +02001040 uinfo->value.integer.max =
1041 (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001042 }
1043 return 0;
1044}
1045
1046/* get the current value from feature/mixer unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001047static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001048{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001049 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001050 int c, cnt, val, err;
1051
Takashi Iwai641b4872009-01-15 17:05:24 +01001052 ucontrol->value.integer.value[0] = cval->min;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 if (cval->cmask) {
1054 cnt = 0;
1055 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001056 if (!(cval->cmask & (1 << c)))
1057 continue;
1058 err = get_cur_mix_value(cval, c + 1, cnt, &val);
1059 if (err < 0)
1060 return cval->mixer->ignore_ctl_error ? 0 : err;
1061 val = get_relative_value(cval, val);
1062 ucontrol->value.integer.value[cnt] = val;
1063 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001064 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001065 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001066 } else {
1067 /* master channel */
Takashi Iwai641b4872009-01-15 17:05:24 +01001068 err = get_cur_mix_value(cval, 0, 0, &val);
1069 if (err < 0)
1070 return cval->mixer->ignore_ctl_error ? 0 : err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001071 val = get_relative_value(cval, val);
1072 ucontrol->value.integer.value[0] = val;
1073 }
1074 return 0;
1075}
1076
1077/* put the current value to feature/mixer unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001078static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001079{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001080 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001081 int c, cnt, val, oval, err;
1082 int changed = 0;
1083
1084 if (cval->cmask) {
1085 cnt = 0;
1086 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001087 if (!(cval->cmask & (1 << c)))
1088 continue;
1089 err = get_cur_mix_value(cval, c + 1, cnt, &oval);
1090 if (err < 0)
1091 return cval->mixer->ignore_ctl_error ? 0 : err;
1092 val = ucontrol->value.integer.value[cnt];
1093 val = get_abs_value(cval, val);
1094 if (oval != val) {
1095 set_cur_mix_value(cval, c + 1, cnt, val);
1096 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001097 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001098 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001099 }
1100 } else {
1101 /* master channel */
Takashi Iwai641b4872009-01-15 17:05:24 +01001102 err = get_cur_mix_value(cval, 0, 0, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 if (err < 0)
Takashi Iwai641b4872009-01-15 17:05:24 +01001104 return cval->mixer->ignore_ctl_error ? 0 : err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001105 val = ucontrol->value.integer.value[0];
1106 val = get_abs_value(cval, val);
1107 if (val != oval) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001108 set_cur_mix_value(cval, 0, 0, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001109 changed = 1;
1110 }
1111 }
1112 return changed;
1113}
1114
Takashi Iwai86e07d32005-11-17 15:08:02 +01001115static struct snd_kcontrol_new usb_feature_unit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1117 .name = "", /* will be filled later manually */
1118 .info = mixer_ctl_feature_info,
1119 .get = mixer_ctl_feature_get,
1120 .put = mixer_ctl_feature_put,
1121};
1122
Daniel Mack23caaf12010-03-11 21:13:25 +01001123/* the read-only variant */
1124static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1125 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1126 .name = "", /* will be filled later manually */
1127 .info = mixer_ctl_feature_info,
1128 .get = mixer_ctl_feature_get,
1129 .put = NULL,
1130};
1131
Daniel Mack9e386582011-05-25 09:09:01 +02001132/* This symbol is exported in order to allow the mixer quirks to
1133 * hook up to the standard feature unit control mechanism */
1134struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001135
1136/*
1137 * build a feature control
1138 */
1139
Takashi Iwai08d1e632009-10-02 14:06:08 +02001140static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1141{
1142 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1143}
1144
David Henningsson9b4ef972012-11-23 13:48:55 +01001145/* A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1146 rename it to "Headphone". We determine if something is a headphone
1147 similar to how udev determines form factor. */
1148static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1149 struct snd_card *card)
1150{
1151 const char *names_to_check[] = {
1152 "Headset", "headset", "Headphone", "headphone", NULL};
1153 const char **s;
Peter Senna Tschudine0f17c72013-09-22 20:44:12 +02001154 bool found = false;
David Henningsson9b4ef972012-11-23 13:48:55 +01001155
1156 if (strcmp("Speaker", kctl->id.name))
1157 return;
1158
1159 for (s = names_to_check; *s; s++)
1160 if (strstr(card->shortname, *s)) {
Peter Senna Tschudine0f17c72013-09-22 20:44:12 +02001161 found = true;
David Henningsson9b4ef972012-11-23 13:48:55 +01001162 break;
1163 }
1164
1165 if (!found)
1166 return;
1167
1168 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1169}
1170
Daniel Mack99fc8642010-03-11 21:13:24 +01001171static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001172 unsigned int ctl_mask, int control,
Daniel Mack23caaf12010-03-11 21:13:25 +01001173 struct usb_audio_term *iterm, int unitid,
Daniel Macka6a33252010-05-31 13:35:37 +02001174 int readonly_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001175{
Daniel Mack99fc8642010-03-11 21:13:24 +01001176 struct uac_feature_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001177 unsigned int len = 0;
1178 int mapped_name = 0;
Daniel Mack99fc8642010-03-11 21:13:24 +01001179 int nameid = uac_feature_unit_iFeature(desc);
Takashi Iwai86e07d32005-11-17 15:08:02 +01001180 struct snd_kcontrol *kctl;
1181 struct usb_mixer_elem_info *cval;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001182 const struct usbmix_name_map *map;
Alexey Fisher80aceff2011-03-10 14:53:38 +01001183 unsigned int range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001184
1185 control++; /* change from zero-based to 1-based value */
1186
Daniel Mack65f25da2010-05-31 13:35:41 +02001187 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188 /* FIXME: not supported yet */
1189 return;
1190 }
1191
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001192 map = find_map(state, unitid, control);
1193 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001194 return;
1195
Takashi Iwai561b2202005-09-09 14:22:34 +02001196 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001197 if (! cval) {
1198 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1199 return;
1200 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001201 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001202 cval->id = unitid;
1203 cval->control = control;
1204 cval->cmask = ctl_mask;
1205 cval->val_type = audio_feature_info[control-1].type;
Daniel Macka6a33252010-05-31 13:35:37 +02001206 if (ctl_mask == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001207 cval->channels = 1; /* master channel */
Daniel Macka6a33252010-05-31 13:35:37 +02001208 cval->master_readonly = readonly_mask;
1209 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001210 int i, c = 0;
1211 for (i = 0; i < 16; i++)
1212 if (ctl_mask & (1 << i))
1213 c++;
1214 cval->channels = c;
Daniel Macka6a33252010-05-31 13:35:37 +02001215 cval->ch_readonly = readonly_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001216 }
1217
Daniel Macka6a33252010-05-31 13:35:37 +02001218 /* if all channels in the mask are marked read-only, make the control
1219 * read-only. set_cur_mix_value() will check the mask again and won't
1220 * issue write commands to read-only channels. */
1221 if (cval->channels == readonly_mask)
Daniel Mack23caaf12010-03-11 21:13:25 +01001222 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1223 else
1224 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1225
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 if (! kctl) {
1227 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1228 kfree(cval);
1229 return;
1230 }
1231 kctl->private_free = usb_mixer_elem_free;
1232
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001233 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001234 mapped_name = len != 0;
1235 if (! len && nameid)
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001236 len = snd_usb_copy_string_desc(state, nameid,
1237 kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001238
1239 switch (control) {
Daniel Mack65f25da2010-05-31 13:35:41 +02001240 case UAC_FU_MUTE:
1241 case UAC_FU_VOLUME:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001242 /* determine the control name. the rule is:
1243 * - if a name id is given in descriptor, use it.
1244 * - if the connected input can be determined, then use the name
1245 * of terminal type.
1246 * - if the connected output can be determined, use it.
1247 * - otherwise, anonymous name.
1248 */
1249 if (! len) {
1250 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 1);
1251 if (! len)
1252 len = get_term_name(state, &state->oterm, kctl->id.name, sizeof(kctl->id.name), 1);
1253 if (! len)
1254 len = snprintf(kctl->id.name, sizeof(kctl->id.name),
1255 "Feature %d", unitid);
1256 }
David Henningsson9b4ef972012-11-23 13:48:55 +01001257
1258 if (!mapped_name)
1259 check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1260
Linus Torvalds1da177e2005-04-16 15:20:36 -07001261 /* determine the stream direction:
1262 * if the connected output is USB stream, then it's likely a
1263 * capture stream. otherwise it should be playback (hopefully :)
1264 */
1265 if (! mapped_name && ! (state->oterm.type >> 16)) {
1266 if ((state->oterm.type & 0xff00) == 0x0100) {
Takashi Iwai08d1e632009-10-02 14:06:08 +02001267 len = append_ctl_name(kctl, " Capture");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 } else {
Takashi Iwai08d1e632009-10-02 14:06:08 +02001269 len = append_ctl_name(kctl, " Playback");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001270 }
1271 }
Daniel Mack65f25da2010-05-31 13:35:41 +02001272 append_ctl_name(kctl, control == UAC_FU_MUTE ?
Takashi Iwai08d1e632009-10-02 14:06:08 +02001273 " Switch" : " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001275 default:
1276 if (! len)
1277 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1278 sizeof(kctl->id.name));
1279 break;
1280 }
1281
Takashi Iwaie1825342012-05-14 17:11:06 +02001282 /* get min/max values */
1283 get_min_max_with_quirks(cval, 0, kctl);
1284
1285 if (control == UAC_FU_VOLUME) {
1286 check_mapped_dB(map, cval);
1287 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1288 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1289 kctl->vd[0].access |=
1290 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1291 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1292 }
1293 }
1294
Alexey Fisher80aceff2011-03-10 14:53:38 +01001295 range = (cval->max - cval->min) / cval->res;
1296 /* Are there devices with volume range more than 255? I use a bit more
1297 * to be sure. 384 is a resolution magic number found on Logitech
1298 * devices. It will definitively catch all buggy Logitech devices.
1299 */
1300 if (range > 384) {
1301 snd_printk(KERN_WARNING "usb_audio: Warning! Unlikely big "
1302 "volume range (=%u), cval->res is probably wrong.",
1303 range);
1304 snd_printk(KERN_WARNING "usb_audio: [%d] FU [%s] ch = %d, "
1305 "val = %d/%d/%d", cval->id,
1306 kctl->id.name, cval->channels,
1307 cval->min, cval->max, cval->res);
1308 }
1309
Linus Torvalds1da177e2005-04-16 15:20:36 -07001310 snd_printdd(KERN_INFO "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
1311 cval->id, kctl->id.name, cval->channels, cval->min, cval->max, cval->res);
Daniel Mackef9d5972011-05-25 09:09:00 +02001312 snd_usb_mixer_add_control(state->mixer, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001313}
1314
1315
1316
1317/*
1318 * parse a feature unit
1319 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001320 * most of controls are defined here.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001321 */
Daniel Mack28e1b772010-02-22 23:49:09 +01001322static int parse_audio_feature_unit(struct mixer_build *state, int unitid, void *_ftr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001323{
1324 int channels, i, j;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001325 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001326 unsigned int master_bits, first_ch_bits;
1327 int err, csize;
Daniel Mack23caaf12010-03-11 21:13:25 +01001328 struct uac_feature_unit_descriptor *hdr = _ftr;
1329 __u8 *bmaControls;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001330
Daniel Mack23caaf12010-03-11 21:13:25 +01001331 if (state->mixer->protocol == UAC_VERSION_1) {
1332 csize = hdr->bControlSize;
Nicolai Krakowiak60c961a92011-08-04 15:56:27 +02001333 if (!csize) {
1334 snd_printdd(KERN_ERR "usbaudio: unit %u: "
1335 "invalid bControlSize == 0\n", unitid);
1336 return -EINVAL;
1337 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001338 channels = (hdr->bLength - 7) / csize - 1;
1339 bmaControls = hdr->bmaControls;
Clemens Ladischd56268f2012-11-29 17:04:23 +01001340 if (hdr->bLength < 7 + csize) {
1341 snd_printk(KERN_ERR "usbaudio: unit %u: "
1342 "invalid UAC_FEATURE_UNIT descriptor\n",
1343 unitid);
1344 return -EINVAL;
1345 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001346 } else {
1347 struct uac2_feature_unit_descriptor *ftr = _ftr;
1348 csize = 4;
Daniel Macke8d0fee2010-05-27 20:15:14 +02001349 channels = (hdr->bLength - 6) / 4 - 1;
Daniel Mack23caaf12010-03-11 21:13:25 +01001350 bmaControls = ftr->bmaControls;
Clemens Ladischd56268f2012-11-29 17:04:23 +01001351 if (hdr->bLength < 6 + csize) {
1352 snd_printk(KERN_ERR "usbaudio: unit %u: "
1353 "invalid UAC_FEATURE_UNIT descriptor\n",
1354 unitid);
1355 return -EINVAL;
1356 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001357 }
1358
1359 /* parse the source unit */
Daniel Mack23caaf12010-03-11 21:13:25 +01001360 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001361 return err;
1362
1363 /* determine the input source type and name */
Daniel Mack4d7b86c2013-03-19 21:09:24 +01001364 err = check_input_term(state, hdr->bSourceID, &iterm);
1365 if (err < 0)
1366 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001367
Daniel Mack23caaf12010-03-11 21:13:25 +01001368 master_bits = snd_usb_combine_bytes(bmaControls, csize);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001369 /* master configuration quirks */
1370 switch (state->chip->usb_id) {
1371 case USB_ID(0x08bb, 0x2702):
1372 snd_printk(KERN_INFO
1373 "usbmixer: master volume quirk for PCM2702 chip\n");
1374 /* disable non-functional volume control */
Daniel Mack65f25da2010-05-31 13:35:41 +02001375 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001376 break;
David Henningssonc1051432012-09-20 10:20:41 +02001377 case USB_ID(0x1130, 0xf211):
1378 snd_printk(KERN_INFO
1379 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
1380 /* disable non-functional volume control */
1381 channels = 0;
1382 break;
1383
Javier Kohen0c3cee52009-11-17 15:36:13 +01001384 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001385 if (channels > 0)
Daniel Mack23caaf12010-03-11 21:13:25 +01001386 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001387 else
1388 first_ch_bits = 0;
Daniel Mack23caaf12010-03-11 21:13:25 +01001389
1390 if (state->mixer->protocol == UAC_VERSION_1) {
1391 /* check all control types */
1392 for (i = 0; i < 10; i++) {
1393 unsigned int ch_bits = 0;
1394 for (j = 0; j < channels; j++) {
1395 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
1396 if (mask & (1 << i))
1397 ch_bits |= (1 << j);
1398 }
1399 /* audio class v1 controls are never read-only */
1400 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
1401 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, 0);
1402 if (master_bits & (1 << i))
1403 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001404 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001405 } else { /* UAC_VERSION_2 */
Takashi Iwaid09c06c2011-10-13 08:19:09 +02001406 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001407 unsigned int ch_bits = 0;
1408 unsigned int ch_read_only = 0;
1409
1410 for (j = 0; j < channels; j++) {
1411 unsigned int mask = snd_usb_combine_bytes(bmaControls + csize * (j+1), csize);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001412 if (uac2_control_is_readable(mask, i)) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001413 ch_bits |= (1 << j);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001414 if (!uac2_control_is_writeable(mask, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001415 ch_read_only |= (1 << j);
1416 }
1417 }
1418
Daniel Macka6a33252010-05-31 13:35:37 +02001419 /* NOTE: build_feature_ctl() will mark the control read-only if all channels
1420 * are marked read-only in the descriptors. Otherwise, the control will be
1421 * reported as writeable, but the driver will not actually issue a write
1422 * command for read-only channels */
Daniel Mack23caaf12010-03-11 21:13:25 +01001423 if (ch_bits & 1) /* the first channel must be set (for ease of programming) */
Daniel Macka6a33252010-05-31 13:35:37 +02001424 build_feature_ctl(state, _ftr, ch_bits, i, &iterm, unitid, ch_read_only);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001425 if (uac2_control_is_readable(master_bits, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001426 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001427 !uac2_control_is_writeable(master_bits, i));
Daniel Mack23caaf12010-03-11 21:13:25 +01001428 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001429 }
1430
1431 return 0;
1432}
1433
1434
1435/*
1436 * Mixer Unit
1437 */
1438
1439/*
1440 * build a mixer unit control
1441 *
1442 * the callbacks are identical with feature unit.
1443 * input channel number (zero based) is given in control field instead.
1444 */
1445
Daniel Mack99fc8642010-03-11 21:13:24 +01001446static void build_mixer_unit_ctl(struct mixer_build *state,
1447 struct uac_mixer_unit_descriptor *desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448 int in_pin, int in_ch, int unitid,
Takashi Iwai86e07d32005-11-17 15:08:02 +01001449 struct usb_audio_term *iterm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001450{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001451 struct usb_mixer_elem_info *cval;
Daniel Mack99fc8642010-03-11 21:13:24 +01001452 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001453 unsigned int i, len;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001454 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001455 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001456
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001457 map = find_map(state, unitid, 0);
1458 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001459 return;
1460
Takashi Iwai561b2202005-09-09 14:22:34 +02001461 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462 if (! cval)
1463 return;
1464
Clemens Ladisch84957a82005-04-29 16:23:13 +02001465 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001466 cval->id = unitid;
1467 cval->control = in_ch + 1; /* based on 1 */
1468 cval->val_type = USB_MIXER_S16;
1469 for (i = 0; i < num_outs; i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001470 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol), in_ch, i, num_outs)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001471 cval->cmask |= (1 << i);
1472 cval->channels++;
1473 }
1474 }
1475
1476 /* get min/max values */
1477 get_min_max(cval, 0);
1478
1479 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1480 if (! kctl) {
1481 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1482 kfree(cval);
1483 return;
1484 }
1485 kctl->private_free = usb_mixer_elem_free;
1486
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001487 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001488 if (! len)
1489 len = get_term_name(state, iterm, kctl->id.name, sizeof(kctl->id.name), 0);
1490 if (! len)
1491 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
Takashi Iwai08d1e632009-10-02 14:06:08 +02001492 append_ctl_name(kctl, " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001493
1494 snd_printdd(KERN_INFO "[%d] MU [%s] ch = %d, val = %d/%d\n",
1495 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
Daniel Mackef9d5972011-05-25 09:09:00 +02001496 snd_usb_mixer_add_control(state->mixer, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001497}
1498
1499
1500/*
1501 * parse a mixer unit
1502 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001503static int parse_audio_mixer_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001504{
Daniel Mack99fc8642010-03-11 21:13:24 +01001505 struct uac_mixer_unit_descriptor *desc = raw_desc;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001506 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001507 int input_pins, num_ins, num_outs;
1508 int pin, ich, err;
1509
Daniel Mack99fc8642010-03-11 21:13:24 +01001510 if (desc->bLength < 11 || ! (input_pins = desc->bNrInPins) || ! (num_outs = uac_mixer_unit_bNrChannels(desc))) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001511 snd_printk(KERN_ERR "invalid MIXER UNIT descriptor %d\n", unitid);
1512 return -EINVAL;
1513 }
1514 /* no bmControls field (e.g. Maya44) -> ignore */
Daniel Mack99fc8642010-03-11 21:13:24 +01001515 if (desc->bLength <= 10 + input_pins) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 snd_printdd(KERN_INFO "MU %d has no bmControls field\n", unitid);
1517 return 0;
1518 }
1519
1520 num_ins = 0;
1521 ich = 0;
1522 for (pin = 0; pin < input_pins; pin++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001523 err = parse_audio_unit(state, desc->baSourceID[pin]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001524 if (err < 0)
Mark Hills284a8dd2012-04-14 17:19:23 +01001525 continue;
Daniel Mack99fc8642010-03-11 21:13:24 +01001526 err = check_input_term(state, desc->baSourceID[pin], &iterm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001527 if (err < 0)
1528 return err;
1529 num_ins += iterm.channels;
1530 for (; ich < num_ins; ++ich) {
1531 int och, ich_has_controls = 0;
1532
1533 for (och = 0; och < num_outs; ++och) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001534 if (check_matrix_bitmap(uac_mixer_unit_bmControls(desc, state->mixer->protocol),
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535 ich, och, num_outs)) {
1536 ich_has_controls = 1;
1537 break;
1538 }
1539 }
1540 if (ich_has_controls)
1541 build_mixer_unit_ctl(state, desc, pin, ich,
1542 unitid, &iterm);
1543 }
1544 }
1545 return 0;
1546}
1547
1548
1549/*
1550 * Processing Unit / Extension Unit
1551 */
1552
1553/* get callback for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001554static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001555{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001556 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 int err, val;
1558
1559 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Clemens Ladisch84957a82005-04-29 16:23:13 +02001560 if (err < 0 && cval->mixer->ignore_ctl_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001561 ucontrol->value.integer.value[0] = cval->min;
1562 return 0;
1563 }
1564 if (err < 0)
1565 return err;
1566 val = get_relative_value(cval, val);
1567 ucontrol->value.integer.value[0] = val;
1568 return 0;
1569}
1570
1571/* put callback for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001572static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001573{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001574 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001575 int val, oval, err;
1576
1577 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
1578 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001579 if (cval->mixer->ignore_ctl_error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580 return 0;
1581 return err;
1582 }
1583 val = ucontrol->value.integer.value[0];
1584 val = get_abs_value(cval, val);
1585 if (val != oval) {
1586 set_cur_ctl_value(cval, cval->control << 8, val);
1587 return 1;
1588 }
1589 return 0;
1590}
1591
1592/* alsa control interface for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001593static struct snd_kcontrol_new mixer_procunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1595 .name = "", /* will be filled later */
1596 .info = mixer_ctl_feature_info,
1597 .get = mixer_ctl_procunit_get,
1598 .put = mixer_ctl_procunit_put,
1599};
1600
1601
1602/*
1603 * predefined data for processing units
1604 */
1605struct procunit_value_info {
1606 int control;
1607 char *suffix;
1608 int val_type;
1609 int min_value;
1610};
1611
1612struct procunit_info {
1613 int type;
1614 char *name;
1615 struct procunit_value_info *values;
1616};
1617
1618static struct procunit_value_info updown_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001619 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1620 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001621 { 0 }
1622};
1623static struct procunit_value_info prologic_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001624 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1625 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 { 0 }
1627};
1628static struct procunit_value_info threed_enh_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001629 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1630 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001631 { 0 }
1632};
1633static struct procunit_value_info reverb_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001634 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1635 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1636 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1637 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638 { 0 }
1639};
1640static struct procunit_value_info chorus_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001641 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1642 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1643 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1644 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645 { 0 }
1646};
1647static struct procunit_value_info dcr_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001648 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1649 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1650 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1651 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1652 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1653 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 { 0 }
1655};
1656
1657static struct procunit_info procunits[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001658 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1659 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1660 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1661 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1662 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1663 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 { 0 },
1665};
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001666/*
1667 * predefined data for extension units
1668 */
1669static struct procunit_value_info clock_rate_xu_info[] = {
Daniel Macke213e9c2010-05-11 18:13:50 +02001670 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1671 { 0 }
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001672};
1673static struct procunit_value_info clock_source_xu_info[] = {
1674 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1675 { 0 }
1676};
1677static struct procunit_value_info spdif_format_xu_info[] = {
1678 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1679 { 0 }
1680};
1681static struct procunit_value_info soft_limit_xu_info[] = {
1682 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1683 { 0 }
1684};
1685static struct procunit_info extunits[] = {
1686 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1687 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1688 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1689 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1690 { 0 }
1691};
Linus Torvalds1da177e2005-04-16 15:20:36 -07001692/*
1693 * build a processing/extension unit
1694 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001695static int build_audio_procunit(struct mixer_build *state, int unitid, void *raw_desc, struct procunit_info *list, char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001696{
Daniel Mack99fc8642010-03-11 21:13:24 +01001697 struct uac_processing_unit_descriptor *desc = raw_desc;
1698 int num_ins = desc->bNrInPins;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001699 struct usb_mixer_elem_info *cval;
1700 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001701 int i, err, nameid, type, len;
1702 struct procunit_info *info;
1703 struct procunit_value_info *valinfo;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001704 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001705 static struct procunit_value_info default_value_info[] = {
1706 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1707 { 0 }
1708 };
1709 static struct procunit_info default_info = {
1710 0, NULL, default_value_info
1711 };
1712
Daniel Mack23caaf12010-03-11 21:13:25 +01001713 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1714 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001715 snd_printk(KERN_ERR "invalid %s descriptor (id %d)\n", name, unitid);
1716 return -EINVAL;
1717 }
1718
1719 for (i = 0; i < num_ins; i++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001720 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001721 return err;
1722 }
1723
Daniel Mack99fc8642010-03-11 21:13:24 +01001724 type = le16_to_cpu(desc->wProcessType);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001725 for (info = list; info && info->type; info++)
1726 if (info->type == type)
1727 break;
1728 if (! info || ! info->type)
1729 info = &default_info;
1730
1731 for (valinfo = info->values; valinfo->control; valinfo++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001732 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
Daniel Mack99fc8642010-03-11 21:13:24 +01001733
1734 if (! (controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001735 continue;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001736 map = find_map(state, unitid, valinfo->control);
1737 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 continue;
Takashi Iwai561b2202005-09-09 14:22:34 +02001739 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001740 if (! cval) {
1741 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1742 return -ENOMEM;
1743 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001744 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001745 cval->id = unitid;
1746 cval->control = valinfo->control;
1747 cval->val_type = valinfo->val_type;
1748 cval->channels = 1;
1749
1750 /* get min/max values */
Daniel Mack65f25da2010-05-31 13:35:41 +02001751 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001752 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001753 /* FIXME: hard-coded */
1754 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001755 cval->max = control_spec[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756 cval->res = 1;
1757 cval->initialized = 1;
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001758 } else {
1759 if (type == USB_XU_CLOCK_RATE) {
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -05001760 /* E-Mu USB 0404/0202/TrackerPre/0204
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001761 * samplerate control quirk
1762 */
1763 cval->min = 0;
1764 cval->max = 5;
1765 cval->res = 1;
1766 cval->initialized = 1;
1767 } else
1768 get_min_max(cval, valinfo->min_value);
1769 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001770
1771 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
1772 if (! kctl) {
1773 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1774 kfree(cval);
1775 return -ENOMEM;
1776 }
1777 kctl->private_free = usb_mixer_elem_free;
1778
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001779 if (check_mapped_name(map, kctl->id.name,
1780 sizeof(kctl->id.name)))
1781 /* nothing */ ;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001782 else if (info->name)
1783 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
1784 else {
Daniel Mack23caaf12010-03-11 21:13:25 +01001785 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001786 len = 0;
1787 if (nameid)
1788 len = snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1789 if (! len)
1790 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1791 }
Takashi Iwai08d1e632009-10-02 14:06:08 +02001792 append_ctl_name(kctl, " ");
1793 append_ctl_name(kctl, valinfo->suffix);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001794
1795 snd_printdd(KERN_INFO "[%d] PU [%s] ch = %d, val = %d/%d\n",
1796 cval->id, kctl->id.name, cval->channels, cval->min, cval->max);
Daniel Mackef9d5972011-05-25 09:09:00 +02001797 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001798 return err;
1799 }
1800 return 0;
1801}
1802
1803
Daniel Mack99fc8642010-03-11 21:13:24 +01001804static int parse_audio_processing_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001805{
Daniel Mack99fc8642010-03-11 21:13:24 +01001806 return build_audio_procunit(state, unitid, raw_desc, procunits, "Processing Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001807}
1808
Daniel Mack99fc8642010-03-11 21:13:24 +01001809static int parse_audio_extension_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001810{
Daniel Mack99fc8642010-03-11 21:13:24 +01001811 /* Note that we parse extension units with processing unit descriptors.
1812 * That's ok as the layout is the same */
1813 return build_audio_procunit(state, unitid, raw_desc, extunits, "Extension Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001814}
1815
1816
1817/*
1818 * Selector Unit
1819 */
1820
1821/* info callback for selector unit
1822 * use an enumerator type for routing
1823 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001824static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001825{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001826 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001827 const char **itemlist = (const char **)kcontrol->private_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001828
Takashi Iwai5e246b82008-08-08 17:12:47 +02001829 if (snd_BUG_ON(!itemlist))
1830 return -EINVAL;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001831 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001832}
1833
1834/* get callback for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001835static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001836{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001837 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 int val, err;
1839
Daniel Mack09414202010-05-31 13:35:44 +02001840 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001842 if (cval->mixer->ignore_ctl_error) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001843 ucontrol->value.enumerated.item[0] = 0;
1844 return 0;
1845 }
1846 return err;
1847 }
1848 val = get_relative_value(cval, val);
1849 ucontrol->value.enumerated.item[0] = val;
1850 return 0;
1851}
1852
1853/* put callback for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001854static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001855{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001856 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001857 int val, oval, err;
1858
Daniel Mack09414202010-05-31 13:35:44 +02001859 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001860 if (err < 0) {
Clemens Ladisch84957a82005-04-29 16:23:13 +02001861 if (cval->mixer->ignore_ctl_error)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 return 0;
1863 return err;
1864 }
1865 val = ucontrol->value.enumerated.item[0];
1866 val = get_abs_value(cval, val);
1867 if (val != oval) {
Daniel Mack09414202010-05-31 13:35:44 +02001868 set_cur_ctl_value(cval, cval->control << 8, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001869 return 1;
1870 }
1871 return 0;
1872}
1873
1874/* alsa control interface for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001875static struct snd_kcontrol_new mixer_selectunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1877 .name = "", /* will be filled later */
1878 .info = mixer_ctl_selector_info,
1879 .get = mixer_ctl_selector_get,
1880 .put = mixer_ctl_selector_put,
1881};
1882
1883
1884/* private free callback.
1885 * free both private_data and private_value
1886 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001887static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888{
1889 int i, num_ins = 0;
1890
1891 if (kctl->private_data) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001892 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001893 num_ins = cval->max;
1894 kfree(cval);
1895 kctl->private_data = NULL;
1896 }
1897 if (kctl->private_value) {
1898 char **itemlist = (char **)kctl->private_value;
1899 for (i = 0; i < num_ins; i++)
1900 kfree(itemlist[i]);
1901 kfree(itemlist);
1902 kctl->private_value = 0;
1903 }
1904}
1905
1906/*
1907 * parse a selector unit
1908 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001909static int parse_audio_selector_unit(struct mixer_build *state, int unitid, void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910{
Daniel Mack99fc8642010-03-11 21:13:24 +01001911 struct uac_selector_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001912 unsigned int i, nameid, len;
1913 int err;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001914 struct usb_mixer_elem_info *cval;
1915 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001916 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 char **namelist;
1918
Daniel Mack99fc8642010-03-11 21:13:24 +01001919 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001920 snd_printk(KERN_ERR "invalid SELECTOR UNIT descriptor %d\n", unitid);
1921 return -EINVAL;
1922 }
1923
Daniel Mack99fc8642010-03-11 21:13:24 +01001924 for (i = 0; i < desc->bNrInPins; i++) {
1925 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001926 return err;
1927 }
1928
Daniel Mack99fc8642010-03-11 21:13:24 +01001929 if (desc->bNrInPins == 1) /* only one ? nonsense! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07001930 return 0;
1931
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001932 map = find_map(state, unitid, 0);
1933 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001934 return 0;
1935
Takashi Iwai561b2202005-09-09 14:22:34 +02001936 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001937 if (! cval) {
1938 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
1939 return -ENOMEM;
1940 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02001941 cval->mixer = state->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001942 cval->id = unitid;
1943 cval->val_type = USB_MIXER_U8;
1944 cval->channels = 1;
1945 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001946 cval->max = desc->bNrInPins;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001947 cval->res = 1;
1948 cval->initialized = 1;
1949
Daniel Mack09414202010-05-31 13:35:44 +02001950 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
1951 cval->control = UAC2_CX_CLOCK_SELECTOR;
1952 else
1953 cval->control = 0;
1954
Daniel Mack99fc8642010-03-11 21:13:24 +01001955 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001956 if (! namelist) {
1957 snd_printk(KERN_ERR "cannot malloc\n");
1958 kfree(cval);
1959 return -ENOMEM;
1960 }
1961#define MAX_ITEM_NAME_LEN 64
Daniel Mack99fc8642010-03-11 21:13:24 +01001962 for (i = 0; i < desc->bNrInPins; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001963 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964 len = 0;
1965 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
1966 if (! namelist[i]) {
1967 snd_printk(KERN_ERR "cannot malloc\n");
Mariusz Kozlowski7fbe3ca2007-01-08 11:25:30 +01001968 while (i--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001969 kfree(namelist[i]);
1970 kfree(namelist);
1971 kfree(cval);
1972 return -ENOMEM;
1973 }
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02001974 len = check_mapped_selector_name(state, unitid, i, namelist[i],
1975 MAX_ITEM_NAME_LEN);
Daniel Mack99fc8642010-03-11 21:13:24 +01001976 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
1978 if (! len)
1979 sprintf(namelist[i], "Input %d", i);
1980 }
1981
1982 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
1983 if (! kctl) {
1984 snd_printk(KERN_ERR "cannot malloc kcontrol\n");
Jesper Juhl878b4782006-03-20 11:27:13 +01001985 kfree(namelist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 kfree(cval);
1987 return -ENOMEM;
1988 }
1989 kctl->private_value = (unsigned long)namelist;
1990 kctl->private_free = usb_mixer_selector_elem_free;
1991
Daniel Mack99fc8642010-03-11 21:13:24 +01001992 nameid = uac_selector_unit_iSelector(desc);
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001993 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001994 if (len)
1995 ;
1996 else if (nameid)
1997 snd_usb_copy_string_desc(state, nameid, kctl->id.name, sizeof(kctl->id.name));
1998 else {
1999 len = get_term_name(state, &state->oterm,
2000 kctl->id.name, sizeof(kctl->id.name), 0);
2001 if (! len)
2002 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2003
Daniel Mack09414202010-05-31 13:35:44 +02002004 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2005 append_ctl_name(kctl, " Clock Source");
2006 else if ((state->oterm.type & 0xff00) == 0x0100)
Takashi Iwai08d1e632009-10-02 14:06:08 +02002007 append_ctl_name(kctl, " Capture Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002008 else
Takashi Iwai08d1e632009-10-02 14:06:08 +02002009 append_ctl_name(kctl, " Playback Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 }
2011
2012 snd_printdd(KERN_INFO "[%d] SU [%s] items = %d\n",
Daniel Mack99fc8642010-03-11 21:13:24 +01002013 cval->id, kctl->id.name, desc->bNrInPins);
Daniel Mackef9d5972011-05-25 09:09:00 +02002014 if ((err = snd_usb_mixer_add_control(state->mixer, kctl)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 return err;
2016
2017 return 0;
2018}
2019
2020
2021/*
2022 * parse an audio unit recursively
2023 */
2024
Takashi Iwai86e07d32005-11-17 15:08:02 +01002025static int parse_audio_unit(struct mixer_build *state, int unitid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026{
2027 unsigned char *p1;
2028
2029 if (test_and_set_bit(unitid, state->unitbitmap))
2030 return 0; /* the unit already visited */
2031
2032 p1 = find_audio_control_unit(state, unitid);
2033 if (!p1) {
2034 snd_printk(KERN_ERR "usbaudio: unit %d not found!\n", unitid);
2035 return -EINVAL;
2036 }
2037
2038 switch (p1[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +01002039 case UAC_INPUT_TERMINAL:
Daniel Mack09414202010-05-31 13:35:44 +02002040 case UAC2_CLOCK_SOURCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002041 return 0; /* NOP */
Daniel Mackde48c7b2010-02-22 23:49:13 +01002042 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002043 return parse_audio_mixer_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01002044 case UAC_SELECTOR_UNIT:
Daniel Mack09414202010-05-31 13:35:44 +02002045 case UAC2_CLOCK_SELECTOR:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 return parse_audio_selector_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01002047 case UAC_FEATURE_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002048 return parse_audio_feature_unit(state, unitid, p1);
Daniel Mack69da9bc2010-06-16 17:57:28 +02002049 case UAC1_PROCESSING_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01002050 /* UAC2_EFFECT_UNIT has the same value */
2051 if (state->mixer->protocol == UAC_VERSION_1)
2052 return parse_audio_processing_unit(state, unitid, p1);
2053 else
2054 return 0; /* FIXME - effect units not implemented yet */
Daniel Mack69da9bc2010-06-16 17:57:28 +02002055 case UAC1_EXTENSION_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01002056 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2057 if (state->mixer->protocol == UAC_VERSION_1)
2058 return parse_audio_extension_unit(state, unitid, p1);
2059 else /* UAC_VERSION_2 */
2060 return parse_audio_processing_unit(state, unitid, p1);
Torstein Hegge61ac5132013-03-19 17:12:14 +01002061 case UAC2_EXTENSION_UNIT_V2:
2062 return parse_audio_extension_unit(state, unitid, p1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002063 default:
2064 snd_printk(KERN_ERR "usbaudio: unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
2065 return -EINVAL;
2066 }
2067}
2068
Clemens Ladisch84957a82005-04-29 16:23:13 +02002069static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2070{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002071 kfree(mixer->id_elems);
2072 if (mixer->urb) {
2073 kfree(mixer->urb->transfer_buffer);
2074 usb_free_urb(mixer->urb);
2075 }
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002076 usb_free_urb(mixer->rc_urb);
Clemens Ladischb259b102005-04-29 16:29:28 +02002077 kfree(mixer->rc_setup_packet);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002078 kfree(mixer);
2079}
2080
Takashi Iwai86e07d32005-11-17 15:08:02 +01002081static int snd_usb_mixer_dev_free(struct snd_device *device)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002082{
2083 struct usb_mixer_interface *mixer = device->device_data;
2084 snd_usb_mixer_free(mixer);
2085 return 0;
2086}
2087
Linus Torvalds1da177e2005-04-16 15:20:36 -07002088/*
2089 * create mixer controls
2090 *
Daniel Mackde48c7b2010-02-22 23:49:13 +01002091 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
Linus Torvalds1da177e2005-04-16 15:20:36 -07002092 */
Clemens Ladisch84957a82005-04-29 16:23:13 +02002093static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002094{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002095 struct mixer_build state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002096 int err;
2097 const struct usbmix_ctl_map *map;
Daniel Mack23caaf12010-03-11 21:13:25 +01002098 void *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099
Linus Torvalds1da177e2005-04-16 15:20:36 -07002100 memset(&state, 0, sizeof(state));
Clemens Ladisch84957a82005-04-29 16:23:13 +02002101 state.chip = mixer->chip;
2102 state.mixer = mixer;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002103 state.buffer = mixer->hostif->extra;
2104 state.buflen = mixer->hostif->extralen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002105
2106 /* check the mapping table */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002107 for (map = usbmix_ctl_maps; map->id; map++) {
2108 if (map->id == state.chip->usb_id) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002109 state.map = map->map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02002110 state.selector_map = map->selector_map;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002111 mixer->ignore_ctl_error = map->ignore_ctl_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002112 break;
2113 }
2114 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002115
Daniel Mack23caaf12010-03-11 21:13:25 +01002116 p = NULL;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002117 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra, mixer->hostif->extralen,
2118 p, UAC_OUTPUT_TERMINAL)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +01002119 if (mixer->protocol == UAC_VERSION_1) {
Daniel Mack69da9bc2010-06-16 17:57:28 +02002120 struct uac1_output_terminal_descriptor *desc = p;
Daniel Mack23caaf12010-03-11 21:13:25 +01002121
2122 if (desc->bLength < sizeof(*desc))
2123 continue; /* invalid descriptor? */
2124 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
2125 state.oterm.id = desc->bTerminalID;
2126 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2127 state.oterm.name = desc->iTerminal;
2128 err = parse_audio_unit(&state, desc->bSourceID);
Daniel Mack83ea5d12013-03-19 21:09:25 +01002129 if (err < 0 && err != -EINVAL)
Daniel Mack23caaf12010-03-11 21:13:25 +01002130 return err;
2131 } else { /* UAC_VERSION_2 */
2132 struct uac2_output_terminal_descriptor *desc = p;
2133
2134 if (desc->bLength < sizeof(*desc))
2135 continue; /* invalid descriptor? */
2136 set_bit(desc->bTerminalID, state.unitbitmap); /* mark terminal ID as visited */
2137 state.oterm.id = desc->bTerminalID;
2138 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2139 state.oterm.name = desc->iTerminal;
2140 err = parse_audio_unit(&state, desc->bSourceID);
Daniel Mack83ea5d12013-03-19 21:09:25 +01002141 if (err < 0 && err != -EINVAL)
Daniel Mack23caaf12010-03-11 21:13:25 +01002142 return err;
Daniel Mack09414202010-05-31 13:35:44 +02002143
2144 /* for UAC2, use the same approach to also add the clock selectors */
2145 err = parse_audio_unit(&state, desc->bCSourceID);
Daniel Mack83ea5d12013-03-19 21:09:25 +01002146 if (err < 0 && err != -EINVAL)
Daniel Mack09414202010-05-31 13:35:44 +02002147 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +01002148 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002149 }
Daniel Mack23caaf12010-03-11 21:13:25 +01002150
Linus Torvalds1da177e2005-04-16 15:20:36 -07002151 return 0;
2152}
Clemens Ladisch84957a82005-04-29 16:23:13 +02002153
Daniel Mack7b1eda22010-03-11 21:13:22 +01002154void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002155{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002156 struct usb_mixer_elem_info *info;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002157
2158 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem)
2159 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2160 info->elem_id);
2161}
2162
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002163static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
2164 int unitid,
2165 struct usb_mixer_elem_info *cval)
2166{
2167 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2168 "S8", "U8", "S16", "U16"};
2169 snd_iprintf(buffer, " Unit: %i\n", unitid);
2170 if (cval->elem_id)
2171 snd_iprintf(buffer, " Control: name=\"%s\", index=%i\n",
2172 cval->elem_id->name, cval->elem_id->index);
2173 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
2174 "channels=%i, type=\"%s\"\n", cval->id,
2175 cval->control, cval->cmask, cval->channels,
2176 val_types[cval->val_type]);
2177 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2178 cval->min, cval->max, cval->dBmin, cval->dBmax);
2179}
2180
2181static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2182 struct snd_info_buffer *buffer)
2183{
2184 struct snd_usb_audio *chip = entry->private_data;
2185 struct usb_mixer_interface *mixer;
2186 struct usb_mixer_elem_info *cval;
2187 int unitid;
2188
2189 list_for_each_entry(mixer, &chip->mixer_list, list) {
2190 snd_iprintf(buffer,
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002191 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
Daniel Mack3d8d4dc2010-06-16 17:57:31 +02002192 chip->usb_id, snd_usb_ctrl_intf(chip),
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002193 mixer->ignore_ctl_error);
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002194 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2195 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
2196 for (cval = mixer->id_elems[unitid]; cval;
2197 cval = cval->next_id_elem)
2198 snd_usb_mixer_dump_cval(buffer, unitid, cval);
2199 }
2200 }
2201}
2202
Daniel Macke213e9c2010-05-11 18:13:50 +02002203static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2204 int attribute, int value, int index)
2205{
2206 struct usb_mixer_elem_info *info;
2207 __u8 unitid = (index >> 8) & 0xff;
2208 __u8 control = (value >> 8) & 0xff;
2209 __u8 channel = value & 0xff;
2210
2211 if (channel >= MAX_CHANNELS) {
2212 snd_printk(KERN_DEBUG "%s(): bogus channel number %d\n",
2213 __func__, channel);
2214 return;
2215 }
2216
2217 for (info = mixer->id_elems[unitid]; info; info = info->next_id_elem) {
2218 if (info->control != control)
2219 continue;
2220
2221 switch (attribute) {
2222 case UAC2_CS_CUR:
2223 /* invalidate cache, so the value is read from the device */
2224 if (channel)
2225 info->cached &= ~(1 << channel);
2226 else /* master channel */
2227 info->cached = 0;
2228
2229 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
2230 info->elem_id);
2231 break;
2232
2233 case UAC2_CS_RANGE:
2234 /* TODO */
2235 break;
2236
2237 case UAC2_CS_MEM:
2238 /* TODO */
2239 break;
2240
2241 default:
2242 snd_printk(KERN_DEBUG "unknown attribute %d in interrupt\n",
2243 attribute);
2244 break;
2245 } /* switch */
2246 }
2247}
2248
2249static void snd_usb_mixer_interrupt(struct urb *urb)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002250{
2251 struct usb_mixer_interface *mixer = urb->context;
Daniel Macke213e9c2010-05-11 18:13:50 +02002252 int len = urb->actual_length;
Oliver Neukumedf7de32011-03-11 13:19:43 +01002253 int ustatus = urb->status;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002254
Oliver Neukumedf7de32011-03-11 13:19:43 +01002255 if (ustatus != 0)
Daniel Macke213e9c2010-05-11 18:13:50 +02002256 goto requeue;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002257
Daniel Macke213e9c2010-05-11 18:13:50 +02002258 if (mixer->protocol == UAC_VERSION_1) {
2259 struct uac1_status_word *status;
2260
2261 for (status = urb->transfer_buffer;
2262 len >= sizeof(*status);
2263 len -= sizeof(*status), status++) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002264 snd_printd(KERN_DEBUG "status interrupt: %02x %02x\n",
Daniel Macke213e9c2010-05-11 18:13:50 +02002265 status->bStatusType,
2266 status->bOriginator);
2267
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002268 /* ignore any notifications not from the control interface */
Daniel Macke213e9c2010-05-11 18:13:50 +02002269 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2270 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002271 continue;
Daniel Macke213e9c2010-05-11 18:13:50 +02002272
2273 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2274 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
Clemens Ladischb259b102005-04-29 16:29:28 +02002275 else
Daniel Macke213e9c2010-05-11 18:13:50 +02002276 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2277 }
2278 } else { /* UAC_VERSION_2 */
2279 struct uac2_interrupt_data_msg *msg;
2280
2281 for (msg = urb->transfer_buffer;
2282 len >= sizeof(*msg);
2283 len -= sizeof(*msg), msg++) {
2284 /* drop vendor specific and endpoint requests */
2285 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2286 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2287 continue;
2288
2289 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2290 le16_to_cpu(msg->wValue),
2291 le16_to_cpu(msg->wIndex));
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002292 }
2293 }
Daniel Macke213e9c2010-05-11 18:13:50 +02002294
2295requeue:
Oliver Neukumedf7de32011-03-11 13:19:43 +01002296 if (ustatus != -ENOENT && ustatus != -ECONNRESET && ustatus != -ESHUTDOWN) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002297 urb->dev = mixer->chip->dev;
2298 usb_submit_urb(urb, GFP_ATOMIC);
2299 }
2300}
2301
Oliver Neukumedf7de32011-03-11 13:19:43 +01002302/* stop any bus activity of a mixer */
2303void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2304{
2305 usb_kill_urb(mixer->urb);
2306 usb_kill_urb(mixer->rc_urb);
2307}
2308
2309int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2310{
2311 int err;
2312
2313 if (mixer->urb) {
2314 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2315 if (err < 0)
2316 return err;
2317 }
2318
2319 return 0;
2320}
2321
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002322/* create the handler for the optional status interrupt endpoint */
2323static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2324{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002325 struct usb_endpoint_descriptor *ep;
2326 void *transfer_buffer;
2327 int buffer_length;
2328 unsigned int epnum;
2329
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002330 /* we need one interrupt input endpoint */
Daniel Mack1faa5d02011-08-04 15:56:28 +02002331 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002332 return 0;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002333 ep = get_endpoint(mixer->hostif, 0);
Julia Lawall913ae5a2009-01-03 17:54:53 +01002334 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002335 return 0;
2336
Julia Lawall42a6e662008-12-29 11:23:02 +01002337 epnum = usb_endpoint_num(ep);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002338 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2339 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2340 if (!transfer_buffer)
2341 return -ENOMEM;
2342 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2343 if (!mixer->urb) {
2344 kfree(transfer_buffer);
2345 return -ENOMEM;
2346 }
2347 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2348 usb_rcvintpipe(mixer->chip->dev, epnum),
2349 transfer_buffer, buffer_length,
Daniel Macke213e9c2010-05-11 18:13:50 +02002350 snd_usb_mixer_interrupt, mixer, ep->bInterval);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002351 usb_submit_urb(mixer->urb, GFP_KERNEL);
2352 return 0;
2353}
2354
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002355int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2356 int ignore_error)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002357{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002358 static struct snd_device_ops dev_ops = {
Clemens Ladisch84957a82005-04-29 16:23:13 +02002359 .dev_free = snd_usb_mixer_dev_free
2360 };
2361 struct usb_mixer_interface *mixer;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002362 struct snd_info_entry *entry;
Daniel Mack23caaf12010-03-11 21:13:25 +01002363 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002364
2365 strcpy(chip->card->mixername, "USB Mixer");
2366
Takashi Iwai561b2202005-09-09 14:22:34 +02002367 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002368 if (!mixer)
2369 return -ENOMEM;
2370 mixer->chip = chip;
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002371 mixer->ignore_ctl_error = ignore_error;
Jaroslav Kysela291186e2010-02-16 11:55:18 +01002372 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2373 GFP_KERNEL);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002374 if (!mixer->id_elems) {
2375 kfree(mixer);
2376 return -ENOMEM;
2377 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02002378
Daniel Mack1faa5d02011-08-04 15:56:28 +02002379 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2380 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +02002381 case UAC_VERSION_1:
2382 default:
2383 mixer->protocol = UAC_VERSION_1;
2384 break;
2385 case UAC_VERSION_2:
2386 mixer->protocol = UAC_VERSION_2;
2387 break;
2388 }
Daniel Mack7b8a0432010-02-22 23:49:12 +01002389
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002390 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002391 (err = snd_usb_mixer_status_create(mixer)) < 0)
2392 goto _error;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002393
Daniel Mack7b1eda22010-03-11 21:13:22 +01002394 snd_usb_mixer_apply_create_quirk(mixer);
Clemens Ladisch468b8fd2009-07-13 11:39:29 +02002395
Clemens Ladisch84957a82005-04-29 16:23:13 +02002396 err = snd_device_new(chip->card, SNDRV_DEV_LOWLEVEL, mixer, &dev_ops);
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002397 if (err < 0)
2398 goto _error;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002399
2400 if (list_empty(&chip->mixer_list) &&
2401 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2402 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2403
Clemens Ladisch84957a82005-04-29 16:23:13 +02002404 list_add(&mixer->list, &chip->mixer_list);
2405 return 0;
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002406
2407_error:
2408 snd_usb_mixer_free(mixer);
2409 return err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002410}
2411
2412void snd_usb_mixer_disconnect(struct list_head *p)
2413{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002414 struct usb_mixer_interface *mixer;
Daniel Mack7b1eda22010-03-11 21:13:22 +01002415
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002416 mixer = list_entry(p, struct usb_mixer_interface, list);
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002417 usb_kill_urb(mixer->urb);
2418 usb_kill_urb(mixer->rc_urb);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002419}