blob: f494dced3c11e3a662b93d95df9ea53ff2767dfc [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
Takashi Iwai5aeee342014-11-18 11:02:14 +0100139/* ignore the error value if ignore_ctl_error flag is set */
140#define filter_error(cval, err) \
Takashi Iwai3360b842014-11-18 11:47:04 +0100141 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
Takashi Iwai5aeee342014-11-18 11:02:14 +0100142
Linus Torvalds1da177e2005-04-16 15:20:36 -0700143/* check whether the control should be ignored */
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100144static inline int
145check_ignored_ctl(const struct usbmix_name_map *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700146{
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100147 if (!p || p->name || p->dB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700148 return 0;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100149 return 1;
150}
151
152/* dB mapping */
153static inline void check_mapped_dB(const struct usbmix_name_map *p,
154 struct usb_mixer_elem_info *cval)
155{
156 if (p && p->dB) {
157 cval->dBmin = p->dB->min;
158 cval->dBmax = p->dB->max;
Takashi Iwai38b65192011-08-19 07:55:10 +0200159 cval->initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700160 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161}
162
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200163/* get the mapped selector source name */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100164static int check_mapped_selector_name(struct mixer_build *state, int unitid,
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200165 int index, char *buf, int buflen)
166{
167 const struct usbmix_selector_map *p;
168
Daniel Mack6bc170e2014-05-24 10:58:16 +0200169 if (!state->selector_map)
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200170 return 0;
171 for (p = state->selector_map; p->id; p++) {
172 if (p->id == unitid && index < p->count)
173 return strlcpy(buf, p->names[index], buflen);
174 }
175 return 0;
176}
177
Linus Torvalds1da177e2005-04-16 15:20:36 -0700178/*
179 * find an audio control unit with the given unit id
180 */
Daniel Mack6bc170e2014-05-24 10:58:16 +0200181static void *find_audio_control_unit(struct mixer_build *state,
182 unsigned char unit)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700183{
Daniel Mack67e1daa2010-05-31 13:35:43 +0200184 /* we just parse the header */
185 struct uac_feature_unit_descriptor *hdr = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700186
Daniel Mack67e1daa2010-05-31 13:35:43 +0200187 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
188 USB_DT_CS_INTERFACE)) != NULL) {
189 if (hdr->bLength >= 4 &&
190 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
191 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
192 hdr->bUnitID == unit)
193 return hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700194 }
Daniel Mack67e1daa2010-05-31 13:35:43 +0200195
Linus Torvalds1da177e2005-04-16 15:20:36 -0700196 return NULL;
197}
198
Linus Torvalds1da177e2005-04-16 15:20:36 -0700199/*
200 * copy a string with the given id
201 */
Daniel Mack6bc170e2014-05-24 10:58:16 +0200202static int snd_usb_copy_string_desc(struct mixer_build *state,
203 int index, char *buf, int maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700204{
205 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
206 buf[len] = 0;
207 return len;
208}
209
210/*
211 * convert from the byte/word on usb descriptor to the zero-based integer
212 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100213static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700214{
215 switch (cval->val_type) {
216 case USB_MIXER_BOOLEAN:
217 return !!val;
218 case USB_MIXER_INV_BOOLEAN:
219 return !val;
220 case USB_MIXER_U8:
221 val &= 0xff;
222 break;
223 case USB_MIXER_S8:
224 val &= 0xff;
225 if (val >= 0x80)
226 val -= 0x100;
227 break;
228 case USB_MIXER_U16:
229 val &= 0xffff;
230 break;
231 case USB_MIXER_S16:
232 val &= 0xffff;
233 if (val >= 0x8000)
234 val -= 0x10000;
235 break;
236 }
237 return val;
238}
239
240/*
241 * convert from the zero-based int to the byte/word for usb descriptor
242 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100243static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700244{
245 switch (cval->val_type) {
246 case USB_MIXER_BOOLEAN:
247 return !!val;
248 case USB_MIXER_INV_BOOLEAN:
249 return !val;
250 case USB_MIXER_S8:
251 case USB_MIXER_U8:
252 return val & 0xff;
253 case USB_MIXER_S16:
254 case USB_MIXER_U16:
255 return val & 0xffff;
256 }
257 return 0; /* not reached */
258}
259
Takashi Iwai86e07d32005-11-17 15:08:02 +0100260static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700261{
Daniel Mack6bc170e2014-05-24 10:58:16 +0200262 if (!cval->res)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700263 cval->res = 1;
264 if (val < cval->min)
265 return 0;
Takashi Iwai14790f12006-03-28 17:58:28 +0200266 else if (val >= cval->max)
267 return (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700268 else
269 return (val - cval->min) / cval->res;
270}
271
Takashi Iwai86e07d32005-11-17 15:08:02 +0100272static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700273{
274 if (val < 0)
275 return cval->min;
Daniel Mack6bc170e2014-05-24 10:58:16 +0200276 if (!cval->res)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700277 cval->res = 1;
278 val *= cval->res;
279 val += cval->min;
280 if (val > cval->max)
281 return cval->max;
282 return val;
283}
284
Julian Scheelbc18e312015-08-14 16:14:45 +0200285static int uac2_ctl_value_size(int val_type)
286{
287 switch (val_type) {
288 case USB_MIXER_S32:
289 case USB_MIXER_U32:
290 return 4;
291 case USB_MIXER_S16:
292 case USB_MIXER_U16:
293 return 2;
294 default:
295 return 1;
296 }
297 return 0; /* unreachable */
298}
299
Linus Torvalds1da177e2005-04-16 15:20:36 -0700300
301/*
302 * retrieve a mixer value
303 */
304
Daniel Mack6bc170e2014-05-24 10:58:16 +0200305static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
306 int validx, int *value_ret)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700307{
Takashi Iwai3360b842014-11-18 11:47:04 +0100308 struct snd_usb_audio *chip = cval->head.mixer->chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700309 unsigned char buf[2];
310 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
311 int timeout = 10;
Takashi Iwai978520b2012-10-12 15:12:55 +0200312 int idx = 0, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700313
Takashi Iwai47ab1542015-08-25 16:09:00 +0200314 err = snd_usb_lock_shutdown(chip);
Oliver Neukum88a85162011-03-11 14:51:12 +0100315 if (err < 0)
316 return -EIO;
Daniel Mack6bc170e2014-05-24 10:58:16 +0200317
Linus Torvalds1da177e2005-04-16 15:20:36 -0700318 while (timeout-- > 0) {
Takashi Iwai3360b842014-11-18 11:47:04 +0100319 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200320 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700321 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Takashi Iwai978520b2012-10-12 15:12:55 +0200322 validx, idx, buf, val_len) >= val_len) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700323 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
Takashi Iwai978520b2012-10-12 15:12:55 +0200324 err = 0;
325 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700326 }
327 }
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100328 usb_audio_dbg(chip,
329 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
330 request, validx, idx, cval->val_type);
Takashi Iwai978520b2012-10-12 15:12:55 +0200331 err = -EINVAL;
332
333 out:
Takashi Iwai47ab1542015-08-25 16:09:00 +0200334 snd_usb_unlock_shutdown(chip);
Takashi Iwai978520b2012-10-12 15:12:55 +0200335 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700336}
337
Daniel Mack6bc170e2014-05-24 10:58:16 +0200338static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
339 int validx, int *value_ret)
Daniel Mack23caaf12010-03-11 21:13:25 +0100340{
Takashi Iwai3360b842014-11-18 11:47:04 +0100341 struct snd_usb_audio *chip = cval->head.mixer->chip;
Julian Scheelbc18e312015-08-14 16:14:45 +0200342 unsigned char buf[4 + 3 * sizeof(__u32)]; /* enough space for one range */
Daniel Mack23caaf12010-03-11 21:13:25 +0100343 unsigned char *val;
Takashi Iwai978520b2012-10-12 15:12:55 +0200344 int idx = 0, ret, size;
Daniel Mack23caaf12010-03-11 21:13:25 +0100345 __u8 bRequest;
346
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200347 if (request == UAC_GET_CUR) {
348 bRequest = UAC2_CS_CUR;
Julian Scheelbc18e312015-08-14 16:14:45 +0200349 size = uac2_ctl_value_size(cval->val_type);
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200350 } else {
351 bRequest = UAC2_CS_RANGE;
352 size = sizeof(buf);
353 }
354
355 memset(buf, 0, sizeof(buf));
Daniel Mack23caaf12010-03-11 21:13:25 +0100356
Takashi Iwai47ab1542015-08-25 16:09:00 +0200357 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
Oliver Neukum88a85162011-03-11 14:51:12 +0100358 if (ret)
359 goto error;
360
Takashi Iwai47ab1542015-08-25 16:09:00 +0200361 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
362 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
Daniel Mack23caaf12010-03-11 21:13:25 +0100363 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Takashi Iwai978520b2012-10-12 15:12:55 +0200364 validx, idx, buf, size);
Takashi Iwai47ab1542015-08-25 16:09:00 +0200365 snd_usb_unlock_shutdown(chip);
Daniel Mack23caaf12010-03-11 21:13:25 +0100366
367 if (ret < 0) {
Oliver Neukum88a85162011-03-11 14:51:12 +0100368error:
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100369 usb_audio_err(chip,
370 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
371 request, validx, idx, cval->val_type);
Daniel Mack23caaf12010-03-11 21:13:25 +0100372 return ret;
373 }
374
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200375 /* FIXME: how should we handle multiple triplets here? */
376
Daniel Mack23caaf12010-03-11 21:13:25 +0100377 switch (request) {
378 case UAC_GET_CUR:
379 val = buf;
380 break;
381 case UAC_GET_MIN:
382 val = buf + sizeof(__u16);
383 break;
384 case UAC_GET_MAX:
385 val = buf + sizeof(__u16) * 2;
386 break;
387 case UAC_GET_RES:
388 val = buf + sizeof(__u16) * 3;
389 break;
390 default:
391 return -EINVAL;
392 }
393
394 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
395
396 return 0;
397}
398
Daniel Mack6bc170e2014-05-24 10:58:16 +0200399static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
400 int validx, int *value_ret)
Daniel Mack23caaf12010-03-11 21:13:25 +0100401{
Eldad Zack9f814102012-11-28 23:55:35 +0100402 validx += cval->idx_off;
403
Takashi Iwai3360b842014-11-18 11:47:04 +0100404 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
Daniel Mack23caaf12010-03-11 21:13:25 +0100405 get_ctl_value_v1(cval, request, validx, value_ret) :
406 get_ctl_value_v2(cval, request, validx, value_ret);
407}
408
Daniel Mack6bc170e2014-05-24 10:58:16 +0200409static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
410 int validx, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700411{
Daniel Mackde48c7b2010-02-22 23:49:13 +0100412 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700413}
414
415/* channel = 0: master, 1 = first channel */
Takashi Iwai641b4872009-01-15 17:05:24 +0100416static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
417 int channel, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700418{
Daniel Mack6bc170e2014-05-24 10:58:16 +0200419 return get_ctl_value(cval, UAC_GET_CUR,
420 (cval->control << 8) | channel,
421 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700422}
423
Chris J Argeseef90452014-11-12 12:07:01 -0600424int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
Takashi Iwai641b4872009-01-15 17:05:24 +0100425 int channel, int index, int *value)
426{
427 int err;
428
429 if (cval->cached & (1 << channel)) {
430 *value = cval->cache_val[index];
431 return 0;
432 }
433 err = get_cur_mix_raw(cval, channel, value);
434 if (err < 0) {
Takashi Iwai3360b842014-11-18 11:47:04 +0100435 if (!cval->head.mixer->ignore_ctl_error)
436 usb_audio_dbg(cval->head.mixer->chip,
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100437 "cannot get current value for control %d ch %d: err = %d\n",
Daniel Mack6bc170e2014-05-24 10:58:16 +0200438 cval->control, channel, err);
Takashi Iwai641b4872009-01-15 17:05:24 +0100439 return err;
440 }
441 cval->cached |= 1 << channel;
442 cval->cache_val[index] = *value;
443 return 0;
444}
445
Linus Torvalds1da177e2005-04-16 15:20:36 -0700446/*
447 * set a mixer value
448 */
449
Daniel Mack7b1eda22010-03-11 21:13:22 +0100450int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
451 int request, int validx, int value_set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700452{
Takashi Iwai3360b842014-11-18 11:47:04 +0100453 struct snd_usb_audio *chip = cval->head.mixer->chip;
Julian Scheelbc18e312015-08-14 16:14:45 +0200454 unsigned char buf[4];
Takashi Iwai978520b2012-10-12 15:12:55 +0200455 int idx = 0, val_len, err, timeout = 10;
Daniel Mack23caaf12010-03-11 21:13:25 +0100456
Eldad Zack9f814102012-11-28 23:55:35 +0100457 validx += cval->idx_off;
458
Takashi Iwai3360b842014-11-18 11:47:04 +0100459 if (cval->head.mixer->protocol == UAC_VERSION_1) {
Daniel Mack23caaf12010-03-11 21:13:25 +0100460 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
461 } else { /* UAC_VERSION_2 */
Julian Scheelbc18e312015-08-14 16:14:45 +0200462 val_len = uac2_ctl_value_size(cval->val_type);
Daniel Mack23caaf12010-03-11 21:13:25 +0100463
464 /* FIXME */
465 if (request != UAC_SET_CUR) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100466 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
Daniel Mack23caaf12010-03-11 21:13:25 +0100467 return -EINVAL;
468 }
469
470 request = UAC2_CS_CUR;
471 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700472
473 value_set = convert_bytes_value(cval, value_set);
474 buf[0] = value_set & 0xff;
475 buf[1] = (value_set >> 8) & 0xff;
Julian Scheelbc18e312015-08-14 16:14:45 +0200476 buf[2] = (value_set >> 16) & 0xff;
477 buf[3] = (value_set >> 24) & 0xff;
Takashi Iwai47ab1542015-08-25 16:09:00 +0200478
479 err = snd_usb_lock_shutdown(chip);
Oliver Neukum88a85162011-03-11 14:51:12 +0100480 if (err < 0)
481 return -EIO;
Takashi Iwai47ab1542015-08-25 16:09:00 +0200482
Takashi Iwai978520b2012-10-12 15:12:55 +0200483 while (timeout-- > 0) {
Takashi Iwai3360b842014-11-18 11:47:04 +0100484 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200485 if (snd_usb_ctl_msg(chip->dev,
486 usb_sndctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700487 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
Takashi Iwai978520b2012-10-12 15:12:55 +0200488 validx, idx, buf, val_len) >= 0) {
489 err = 0;
490 goto out;
Oliver Neukum88a85162011-03-11 14:51:12 +0100491 }
Takashi Iwai978520b2012-10-12 15:12:55 +0200492 }
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100493 usb_audio_dbg(chip, "cannot set ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d, data = %#x/%#x\n",
Daniel Mack6bc170e2014-05-24 10:58:16 +0200494 request, validx, idx, cval->val_type, buf[0], buf[1]);
Takashi Iwai978520b2012-10-12 15:12:55 +0200495 err = -EINVAL;
496
497 out:
Takashi Iwai47ab1542015-08-25 16:09:00 +0200498 snd_usb_unlock_shutdown(chip);
Takashi Iwai978520b2012-10-12 15:12:55 +0200499 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700500}
501
Daniel Mack6bc170e2014-05-24 10:58:16 +0200502static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
503 int validx, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700504{
Daniel Mack7b1eda22010-03-11 21:13:22 +0100505 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700506}
507
Chris J Argeseef90452014-11-12 12:07:01 -0600508int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
Takashi Iwai641b4872009-01-15 17:05:24 +0100509 int index, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700510{
Takashi Iwai641b4872009-01-15 17:05:24 +0100511 int err;
Daniel Macka6a33252010-05-31 13:35:37 +0200512 unsigned int read_only = (channel == 0) ?
513 cval->master_readonly :
514 cval->ch_readonly & (1 << (channel - 1));
515
516 if (read_only) {
Takashi Iwai3360b842014-11-18 11:47:04 +0100517 usb_audio_dbg(cval->head.mixer->chip,
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100518 "%s(): channel %d of control %d is read_only\n",
Daniel Macka6a33252010-05-31 13:35:37 +0200519 __func__, channel, cval->control);
520 return 0;
521 }
522
Daniel Mack6bc170e2014-05-24 10:58:16 +0200523 err = snd_usb_mixer_set_ctl_value(cval,
524 UAC_SET_CUR, (cval->control << 8) | channel,
525 value);
Takashi Iwai641b4872009-01-15 17:05:24 +0100526 if (err < 0)
527 return err;
528 cval->cached |= 1 << channel;
529 cval->cache_val[index] = value;
530 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700531}
532
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200533/*
534 * TLV callback for mixer volume controls
535 */
Felix Homann285de9c2012-04-23 20:24:24 +0200536int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200537 unsigned int size, unsigned int __user *_tlv)
538{
539 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Takashi Iwaib8e1c732009-06-16 14:04:37 +0200540 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200541
542 if (size < sizeof(scale))
543 return -ENOMEM;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100544 scale[2] = cval->dBmin;
545 scale[3] = cval->dBmax;
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200546 if (copy_to_user(_tlv, scale, sizeof(scale)))
547 return -EFAULT;
548 return 0;
549}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700550
551/*
552 * parser routines begin here...
553 */
554
Takashi Iwai86e07d32005-11-17 15:08:02 +0100555static int parse_audio_unit(struct mixer_build *state, int unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700556
557
558/*
559 * check if the input/output channel routing is enabled on the given bitmap.
560 * used for mixer unit parser
561 */
Daniel Mack6bc170e2014-05-24 10:58:16 +0200562static int check_matrix_bitmap(unsigned char *bmap,
563 int ich, int och, int num_outs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700564{
565 int idx = ich * num_outs + och;
566 return bmap[idx >> 3] & (0x80 >> (idx & 7));
567}
568
Linus Torvalds1da177e2005-04-16 15:20:36 -0700569/*
570 * add an alsa control element
571 * search and increment the index until an empty slot is found.
572 *
573 * if failed, give up and free the control instance.
574 */
575
Takashi Iwai3360b842014-11-18 11:47:04 +0100576int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
Daniel Mackef9d5972011-05-25 09:09:00 +0200577 struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700578{
Takashi Iwai3360b842014-11-18 11:47:04 +0100579 struct usb_mixer_interface *mixer = list->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700580 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +0200581
Daniel Mackef9d5972011-05-25 09:09:00 +0200582 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700583 kctl->id.index++;
Daniel Mackef9d5972011-05-25 09:09:00 +0200584 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
Daniel Mack6bc170e2014-05-24 10:58:16 +0200585 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
586 err);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200587 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700588 }
Takashi Iwai3360b842014-11-18 11:47:04 +0100589 list->kctl = kctl;
590 list->next_id_elem = mixer->id_elems[list->id];
591 mixer->id_elems[list->id] = list;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200592 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700593}
594
Linus Torvalds1da177e2005-04-16 15:20:36 -0700595/*
596 * get a terminal name string
597 */
598
599static struct iterm_name_combo {
600 int type;
601 char *name;
602} iterm_names[] = {
603 { 0x0300, "Output" },
604 { 0x0301, "Speaker" },
605 { 0x0302, "Headphone" },
606 { 0x0303, "HMD Audio" },
607 { 0x0304, "Desktop Speaker" },
608 { 0x0305, "Room Speaker" },
609 { 0x0306, "Com Speaker" },
610 { 0x0307, "LFE" },
611 { 0x0600, "External In" },
612 { 0x0601, "Analog In" },
613 { 0x0602, "Digital In" },
614 { 0x0603, "Line" },
615 { 0x0604, "Legacy In" },
616 { 0x0605, "IEC958 In" },
617 { 0x0606, "1394 DA Stream" },
618 { 0x0607, "1394 DV Stream" },
619 { 0x0700, "Embedded" },
620 { 0x0701, "Noise Source" },
621 { 0x0702, "Equalization Noise" },
622 { 0x0703, "CD" },
623 { 0x0704, "DAT" },
624 { 0x0705, "DCC" },
625 { 0x0706, "MiniDisk" },
626 { 0x0707, "Analog Tape" },
627 { 0x0708, "Phonograph" },
628 { 0x0709, "VCR Audio" },
629 { 0x070a, "Video Disk Audio" },
630 { 0x070b, "DVD Audio" },
631 { 0x070c, "TV Tuner Audio" },
632 { 0x070d, "Satellite Rec Audio" },
633 { 0x070e, "Cable Tuner Audio" },
634 { 0x070f, "DSS Audio" },
635 { 0x0710, "Radio Receiver" },
636 { 0x0711, "Radio Transmitter" },
637 { 0x0712, "Multi-Track Recorder" },
638 { 0x0713, "Synthesizer" },
639 { 0 },
640};
641
Takashi Iwai86e07d32005-11-17 15:08:02 +0100642static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700643 unsigned char *name, int maxlen, int term_only)
644{
645 struct iterm_name_combo *names;
646
647 if (iterm->name)
Daniel Mack6bc170e2014-05-24 10:58:16 +0200648 return snd_usb_copy_string_desc(state, iterm->name,
649 name, maxlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700650
651 /* virtual type - not a real terminal */
652 if (iterm->type >> 16) {
653 if (term_only)
654 return 0;
655 switch (iterm->type >> 16) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100656 case UAC_SELECTOR_UNIT:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200657 strcpy(name, "Selector");
658 return 8;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200659 case UAC1_PROCESSING_UNIT:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200660 strcpy(name, "Process Unit");
661 return 12;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200662 case UAC1_EXTENSION_UNIT:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200663 strcpy(name, "Ext Unit");
664 return 8;
Daniel Mackde48c7b2010-02-22 23:49:13 +0100665 case UAC_MIXER_UNIT:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200666 strcpy(name, "Mixer");
667 return 5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700668 default:
669 return sprintf(name, "Unit %d", iterm->id);
670 }
671 }
672
673 switch (iterm->type & 0xff00) {
674 case 0x0100:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200675 strcpy(name, "PCM");
676 return 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700677 case 0x0200:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200678 strcpy(name, "Mic");
679 return 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700680 case 0x0400:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200681 strcpy(name, "Headset");
682 return 7;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700683 case 0x0500:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200684 strcpy(name, "Phone");
685 return 5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700686 }
687
Daniel Mack6bc170e2014-05-24 10:58:16 +0200688 for (names = iterm_names; names->type; names++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700689 if (names->type == iterm->type) {
690 strcpy(name, names->name);
691 return strlen(names->name);
692 }
Daniel Mack6bc170e2014-05-24 10:58:16 +0200693 }
694
Linus Torvalds1da177e2005-04-16 15:20:36 -0700695 return 0;
696}
697
Linus Torvalds1da177e2005-04-16 15:20:36 -0700698/*
699 * parse the source unit recursively until it reaches to a terminal
700 * or a branched unit.
701 */
Daniel Mack6bc170e2014-05-24 10:58:16 +0200702static int check_input_term(struct mixer_build *state, int id,
703 struct usb_audio_term *term)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700704{
Daniel Mack09414202010-05-31 13:35:44 +0200705 int err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100706 void *p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700707
708 memset(term, 0, sizeof(*term));
709 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +0100710 unsigned char *hdr = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700711 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100712 switch (hdr[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100713 case UAC_INPUT_TERMINAL:
Daniel Mack23caaf12010-03-11 21:13:25 +0100714 if (state->mixer->protocol == UAC_VERSION_1) {
715 struct uac_input_terminal_descriptor *d = p1;
716 term->type = le16_to_cpu(d->wTerminalType);
717 term->channels = d->bNrChannels;
718 term->chconfig = le16_to_cpu(d->wChannelConfig);
719 term->name = d->iTerminal;
720 } else { /* UAC_VERSION_2 */
721 struct uac2_input_terminal_descriptor *d = p1;
Julian Scheel9430e542015-08-19 09:28:09 +0200722
723 /* call recursively to verify that the
724 * referenced clock entity is valid */
725 err = check_input_term(state, d->bCSourceID, term);
726 if (err < 0)
727 return err;
728
729 /* save input term properties after recursion,
730 * to ensure they are not overriden by the
731 * recursion calls */
732 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100733 term->type = le16_to_cpu(d->wTerminalType);
734 term->channels = d->bNrChannels;
735 term->chconfig = le32_to_cpu(d->bmChannelConfig);
736 term->name = d->iTerminal;
737 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700738 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100739 case UAC_FEATURE_UNIT: {
740 /* the header is the same for v1 and v2 */
741 struct uac_feature_unit_descriptor *d = p1;
Daniel Mack5e688882010-05-08 11:24:56 +0200742 id = d->bSourceID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700743 break; /* continue to parse */
Daniel Mack23caaf12010-03-11 21:13:25 +0100744 }
745 case UAC_MIXER_UNIT: {
746 struct uac_mixer_unit_descriptor *d = p1;
747 term->type = d->bDescriptorSubtype << 16; /* virtual type */
748 term->channels = uac_mixer_unit_bNrChannels(d);
749 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
750 term->name = uac_mixer_unit_iMixer(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700751 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100752 }
Daniel Mack09414202010-05-31 13:35:44 +0200753 case UAC_SELECTOR_UNIT:
754 case UAC2_CLOCK_SELECTOR: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100755 struct uac_selector_unit_descriptor *d = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700756 /* call recursively to retrieve the channel info */
Daniel Mack4d7b86c2013-03-19 21:09:24 +0100757 err = check_input_term(state, d->baSourceID[0], term);
758 if (err < 0)
759 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100760 term->type = d->bDescriptorSubtype << 16; /* virtual type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700761 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100762 term->name = uac_selector_unit_iSelector(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700763 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100764 }
Daniel Mack69da9bc2010-06-16 17:57:28 +0200765 case UAC1_PROCESSING_UNIT:
Eldad Zack5dae5fd2012-11-28 23:55:36 +0100766 case UAC1_EXTENSION_UNIT:
767 /* UAC2_PROCESSING_UNIT_V2 */
Torstein Hegge61ac5132013-03-19 17:12:14 +0100768 /* UAC2_EFFECT_UNIT */
769 case UAC2_EXTENSION_UNIT_V2: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100770 struct uac_processing_unit_descriptor *d = p1;
Eldad Zack5dae5fd2012-11-28 23:55:36 +0100771
772 if (state->mixer->protocol == UAC_VERSION_2 &&
773 hdr[2] == UAC2_EFFECT_UNIT) {
774 /* UAC2/UAC1 unit IDs overlap here in an
775 * uncompatible way. Ignore this unit for now.
776 */
777 return 0;
778 }
779
Daniel Mack23caaf12010-03-11 21:13:25 +0100780 if (d->bNrInPins) {
781 id = d->baSourceID[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700782 break; /* continue to parse */
783 }
Daniel Mack23caaf12010-03-11 21:13:25 +0100784 term->type = d->bDescriptorSubtype << 16; /* virtual type */
785 term->channels = uac_processing_unit_bNrChannels(d);
786 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
787 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700788 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100789 }
Daniel Mack09414202010-05-31 13:35:44 +0200790 case UAC2_CLOCK_SOURCE: {
791 struct uac_clock_source_descriptor *d = p1;
792 term->type = d->bDescriptorSubtype << 16; /* virtual type */
793 term->id = id;
794 term->name = d->iClockSource;
795 return 0;
796 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700797 default:
798 return -ENODEV;
799 }
800 }
801 return -ENODEV;
802}
803
Linus Torvalds1da177e2005-04-16 15:20:36 -0700804/*
805 * Feature Unit
806 */
807
808/* feature unit control information */
809struct usb_feature_control_info {
810 const char *name;
Julian Scheelbc18e312015-08-14 16:14:45 +0200811 int type; /* data type for uac1 */
812 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700813};
814
815static struct usb_feature_control_info audio_feature_info[] = {
Julian Scheelbc18e312015-08-14 16:14:45 +0200816 { "Mute", USB_MIXER_INV_BOOLEAN, -1 },
817 { "Volume", USB_MIXER_S16, -1 },
818 { "Tone Control - Bass", USB_MIXER_S8, -1 },
819 { "Tone Control - Mid", USB_MIXER_S8, -1 },
820 { "Tone Control - Treble", USB_MIXER_S8, -1 },
821 { "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemeted yet */
822 { "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
823 { "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
824 { "Bass Boost", USB_MIXER_BOOLEAN, -1 },
825 { "Loudness", USB_MIXER_BOOLEAN, -1 },
Daniel Mack2e0281d2010-05-31 13:35:42 +0200826 /* UAC2 specific */
Julian Scheelbc18e312015-08-14 16:14:45 +0200827 { "Input Gain Control", USB_MIXER_S16, -1 },
828 { "Input Gain Pad Control", USB_MIXER_S16, -1 },
829 { "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700830};
831
Linus Torvalds1da177e2005-04-16 15:20:36 -0700832/* private_free callback */
Chris J Argeseef90452014-11-12 12:07:01 -0600833void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700834{
Jesper Juhl4d572772005-05-30 17:30:32 +0200835 kfree(kctl->private_data);
836 kctl->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700837}
838
Linus Torvalds1da177e2005-04-16 15:20:36 -0700839/*
840 * interface to ALSA control for feature/mixer units
841 */
842
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100843/* volume control quirks */
844static void volume_control_quirks(struct usb_mixer_elem_info *cval,
845 struct snd_kcontrol *kctl)
846{
Takashi Iwai3360b842014-11-18 11:47:04 +0100847 struct snd_usb_audio *chip = cval->head.mixer->chip;
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100848 switch (chip->usb_id) {
Eldad Zackd50ed622012-11-28 23:55:39 +0100849 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
Matt Gruskine9a25e02013-02-09 12:56:35 -0500850 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
Eldad Zackd50ed622012-11-28 23:55:39 +0100851 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
852 cval->min = 0x0000;
853 cval->max = 0xffff;
854 cval->res = 0x00e6;
855 break;
856 }
857 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
858 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
859 cval->min = 0x00;
860 cval->max = 0xff;
861 break;
862 }
863 if (strstr(kctl->id.name, "Effect Return") != NULL) {
864 cval->min = 0xb706;
865 cval->max = 0xff7b;
866 cval->res = 0x0073;
867 break;
868 }
869 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
870 (strstr(kctl->id.name, "Effect Send") != NULL)) {
871 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
872 cval->max = 0xfcfe;
873 cval->res = 0x0073;
874 }
875 break;
876
Felix Homannd34bf142012-04-23 20:24:27 +0200877 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
878 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
879 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100880 usb_audio_info(chip,
881 "set quirk for FTU Effect Duration\n");
Felix Homannd34bf142012-04-23 20:24:27 +0200882 cval->min = 0x0000;
883 cval->max = 0x7f00;
884 cval->res = 0x0100;
885 break;
886 }
887 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
888 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100889 usb_audio_info(chip,
890 "set quirks for FTU Effect Feedback/Volume\n");
Felix Homannd34bf142012-04-23 20:24:27 +0200891 cval->min = 0x00;
892 cval->max = 0x7f;
893 break;
894 }
895 break;
896
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100897 case USB_ID(0x0471, 0x0101):
898 case USB_ID(0x0471, 0x0104):
899 case USB_ID(0x0471, 0x0105):
900 case USB_ID(0x0672, 0x1041):
901 /* quirk for UDA1321/N101.
902 * note that detection between firmware 2.1.1.7 (N101)
903 * and later 2.1.1.21 is not very clear from datasheets.
904 * I hope that the min value is -15360 for newer firmware --jk
905 */
906 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
907 cval->min == -15616) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100908 usb_audio_info(chip,
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100909 "set volume quirk for UDA1321/N101 chip\n");
910 cval->max = -256;
911 }
912 break;
913
914 case USB_ID(0x046d, 0x09a4):
915 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100916 usb_audio_info(chip,
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100917 "set volume quirk for QuickCam E3500\n");
918 cval->min = 6080;
919 cval->max = 8768;
920 cval->res = 192;
921 }
922 break;
923
Takashi Iwaie805ca82014-03-05 12:34:39 +0100924 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100925 case USB_ID(0x046d, 0x0808):
926 case USB_ID(0x046d, 0x0809):
Jason Lee Cragg64559312015-01-17 12:28:29 -0500927 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
Takashi Iwai36691e12013-06-17 10:25:02 +0200928 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
Alexey Fisher55c00082011-11-09 11:39:24 +0100929 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
Takashi Iwai11e70642013-06-05 08:35:26 +0200930 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
Maksim A. Boyko140d37d2013-08-10 12:20:02 +0400931 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
Wolfram Sang1ef9f052015-05-29 19:50:56 +0900932 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100933 case USB_ID(0x046d, 0x0991):
934 /* Most audio usb devices lie about volume resolution.
935 * Most Logitech webcams have res = 384.
936 * Proboly there is some logitech magic behind this number --fishor
937 */
938 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100939 usb_audio_info(chip,
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100940 "set resolution quirk: cval->res = 384\n");
941 cval->res = 384;
942 }
943 break;
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100944 }
945}
946
Linus Torvalds1da177e2005-04-16 15:20:36 -0700947/*
948 * retrieve the minimum and maximum values for the specified control
949 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100950static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
951 int default_min, struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700952{
953 /* for failsafe */
954 cval->min = default_min;
955 cval->max = cval->min + 1;
956 cval->res = 1;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100957 cval->dBmin = cval->dBmax = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700958
959 if (cval->val_type == USB_MIXER_BOOLEAN ||
960 cval->val_type == USB_MIXER_INV_BOOLEAN) {
961 cval->initialized = 1;
962 } else {
963 int minchn = 0;
964 if (cval->cmask) {
965 int i;
966 for (i = 0; i < MAX_CHANNELS; i++)
967 if (cval->cmask & (1 << i)) {
968 minchn = i + 1;
969 break;
970 }
971 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100972 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
973 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
Takashi Iwai3360b842014-11-18 11:47:04 +0100974 usb_audio_err(cval->head.mixer->chip,
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100975 "%d:%d: cannot get min/max values for control %d (id %d)\n",
Takashi Iwai3360b842014-11-18 11:47:04 +0100976 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
977 cval->control, cval->head.id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700978 return -EINVAL;
979 }
Daniel Mack6bc170e2014-05-24 10:58:16 +0200980 if (get_ctl_value(cval, UAC_GET_RES,
981 (cval->control << 8) | minchn,
982 &cval->res) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700983 cval->res = 1;
984 } else {
985 int last_valid_res = cval->res;
986
987 while (cval->res > 1) {
Daniel Mack7b1eda22010-03-11 21:13:22 +0100988 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
Daniel Mack6bc170e2014-05-24 10:58:16 +0200989 (cval->control << 8) | minchn,
990 cval->res / 2) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700991 break;
992 cval->res /= 2;
993 }
Daniel Mack6bc170e2014-05-24 10:58:16 +0200994 if (get_ctl_value(cval, UAC_GET_RES,
995 (cval->control << 8) | minchn, &cval->res) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700996 cval->res = last_valid_res;
997 }
998 if (cval->res == 0)
999 cval->res = 1;
Takashi Iwai14790f12006-03-28 17:58:28 +02001000
1001 /* Additional checks for the proper resolution
1002 *
1003 * Some devices report smaller resolutions than actually
1004 * reacting. They don't return errors but simply clip
1005 * to the lower aligned value.
1006 */
1007 if (cval->min + cval->res < cval->max) {
1008 int last_valid_res = cval->res;
1009 int saved, test, check;
Takashi Iwai641b4872009-01-15 17:05:24 +01001010 get_cur_mix_raw(cval, minchn, &saved);
Takashi Iwai14790f12006-03-28 17:58:28 +02001011 for (;;) {
1012 test = saved;
1013 if (test < cval->max)
1014 test += cval->res;
1015 else
1016 test -= cval->res;
1017 if (test < cval->min || test > cval->max ||
Chris J Argeseef90452014-11-12 12:07:01 -06001018 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
Takashi Iwai641b4872009-01-15 17:05:24 +01001019 get_cur_mix_raw(cval, minchn, &check)) {
Takashi Iwai14790f12006-03-28 17:58:28 +02001020 cval->res = last_valid_res;
1021 break;
1022 }
1023 if (test == check)
1024 break;
1025 cval->res *= 2;
1026 }
Chris J Argeseef90452014-11-12 12:07:01 -06001027 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
Takashi Iwai14790f12006-03-28 17:58:28 +02001028 }
1029
Linus Torvalds1da177e2005-04-16 15:20:36 -07001030 cval->initialized = 1;
1031 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001032
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +01001033 if (kctl)
1034 volume_control_quirks(cval, kctl);
1035
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001036 /* USB descriptions contain the dB scale in 1/256 dB unit
1037 * while ALSA TLV contains in 1/100 dB unit
1038 */
1039 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1040 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1041 if (cval->dBmin > cval->dBmax) {
1042 /* something is wrong; assume it's either from/to 0dB */
1043 if (cval->dBmin < 0)
1044 cval->dBmax = 0;
1045 else if (cval->dBmin > 0)
1046 cval->dBmin = 0;
1047 if (cval->dBmin > cval->dBmax) {
1048 /* totally crap, return an error */
1049 return -EINVAL;
1050 }
1051 }
1052
Linus Torvalds1da177e2005-04-16 15:20:36 -07001053 return 0;
1054}
1055
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +01001056#define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001057
1058/* get a feature/mixer unit info */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001059static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1060 struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001061{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001062 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063
1064 if (cval->val_type == USB_MIXER_BOOLEAN ||
1065 cval->val_type == USB_MIXER_INV_BOOLEAN)
1066 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1067 else
1068 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1069 uinfo->count = cval->channels;
1070 if (cval->val_type == USB_MIXER_BOOLEAN ||
1071 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1072 uinfo->value.integer.min = 0;
1073 uinfo->value.integer.max = 1;
1074 } else {
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +02001075 if (!cval->initialized) {
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +01001076 get_min_max_with_quirks(cval, 0, kcontrol);
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +02001077 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1078 kcontrol->vd[0].access &=
1079 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1080 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
Takashi Iwai3360b842014-11-18 11:47:04 +01001081 snd_ctl_notify(cval->head.mixer->chip->card,
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +02001082 SNDRV_CTL_EVENT_MASK_INFO,
1083 &kcontrol->id);
1084 }
1085 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001086 uinfo->value.integer.min = 0;
Takashi Iwai14790f12006-03-28 17:58:28 +02001087 uinfo->value.integer.max =
1088 (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001089 }
1090 return 0;
1091}
1092
1093/* get the current value from feature/mixer unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001094static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1095 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001096{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001097 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098 int c, cnt, val, err;
1099
Takashi Iwai641b4872009-01-15 17:05:24 +01001100 ucontrol->value.integer.value[0] = cval->min;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001101 if (cval->cmask) {
1102 cnt = 0;
1103 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001104 if (!(cval->cmask & (1 << c)))
1105 continue;
Chris J Argeseef90452014-11-12 12:07:01 -06001106 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
Takashi Iwai641b4872009-01-15 17:05:24 +01001107 if (err < 0)
Takashi Iwai5aeee342014-11-18 11:02:14 +01001108 return filter_error(cval, err);
Takashi Iwai641b4872009-01-15 17:05:24 +01001109 val = get_relative_value(cval, val);
1110 ucontrol->value.integer.value[cnt] = val;
1111 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001112 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001113 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 } else {
1115 /* master channel */
Chris J Argeseef90452014-11-12 12:07:01 -06001116 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
Takashi Iwai641b4872009-01-15 17:05:24 +01001117 if (err < 0)
Takashi Iwai5aeee342014-11-18 11:02:14 +01001118 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001119 val = get_relative_value(cval, val);
1120 ucontrol->value.integer.value[0] = val;
1121 }
1122 return 0;
1123}
1124
1125/* put the current value to feature/mixer unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001126static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1127 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001128{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001129 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130 int c, cnt, val, oval, err;
1131 int changed = 0;
1132
1133 if (cval->cmask) {
1134 cnt = 0;
1135 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001136 if (!(cval->cmask & (1 << c)))
1137 continue;
Chris J Argeseef90452014-11-12 12:07:01 -06001138 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
Takashi Iwai641b4872009-01-15 17:05:24 +01001139 if (err < 0)
Takashi Iwai5aeee342014-11-18 11:02:14 +01001140 return filter_error(cval, err);
Takashi Iwai641b4872009-01-15 17:05:24 +01001141 val = ucontrol->value.integer.value[cnt];
1142 val = get_abs_value(cval, val);
1143 if (oval != val) {
Chris J Argeseef90452014-11-12 12:07:01 -06001144 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
Takashi Iwai641b4872009-01-15 17:05:24 +01001145 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001146 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001147 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 }
1149 } else {
1150 /* master channel */
Chris J Argeseef90452014-11-12 12:07:01 -06001151 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001152 if (err < 0)
Takashi Iwai5aeee342014-11-18 11:02:14 +01001153 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 val = ucontrol->value.integer.value[0];
1155 val = get_abs_value(cval, val);
1156 if (val != oval) {
Chris J Argeseef90452014-11-12 12:07:01 -06001157 snd_usb_set_cur_mix_value(cval, 0, 0, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001158 changed = 1;
1159 }
1160 }
1161 return changed;
1162}
1163
Takashi Iwai86e07d32005-11-17 15:08:02 +01001164static struct snd_kcontrol_new usb_feature_unit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001165 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1166 .name = "", /* will be filled later manually */
1167 .info = mixer_ctl_feature_info,
1168 .get = mixer_ctl_feature_get,
1169 .put = mixer_ctl_feature_put,
1170};
1171
Daniel Mack23caaf12010-03-11 21:13:25 +01001172/* the read-only variant */
1173static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1174 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1175 .name = "", /* will be filled later manually */
1176 .info = mixer_ctl_feature_info,
1177 .get = mixer_ctl_feature_get,
1178 .put = NULL,
1179};
1180
Daniel Mack6bc170e2014-05-24 10:58:16 +02001181/*
1182 * This symbol is exported in order to allow the mixer quirks to
1183 * hook up to the standard feature unit control mechanism
1184 */
Daniel Mack9e386582011-05-25 09:09:01 +02001185struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001186
1187/*
1188 * build a feature control
1189 */
Takashi Iwai08d1e632009-10-02 14:06:08 +02001190static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1191{
1192 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1193}
1194
Daniel Mack6bc170e2014-05-24 10:58:16 +02001195/*
1196 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1197 * rename it to "Headphone". We determine if something is a headphone
1198 * similar to how udev determines form factor.
1199 */
David Henningsson9b4ef972012-11-23 13:48:55 +01001200static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1201 struct snd_card *card)
1202{
1203 const char *names_to_check[] = {
1204 "Headset", "headset", "Headphone", "headphone", NULL};
1205 const char **s;
Peter Senna Tschudine0f17c72013-09-22 20:44:12 +02001206 bool found = false;
David Henningsson9b4ef972012-11-23 13:48:55 +01001207
1208 if (strcmp("Speaker", kctl->id.name))
1209 return;
1210
1211 for (s = names_to_check; *s; s++)
1212 if (strstr(card->shortname, *s)) {
Peter Senna Tschudine0f17c72013-09-22 20:44:12 +02001213 found = true;
David Henningsson9b4ef972012-11-23 13:48:55 +01001214 break;
1215 }
1216
1217 if (!found)
1218 return;
1219
1220 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1221}
1222
Daniel Mack99fc8642010-03-11 21:13:24 +01001223static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001224 unsigned int ctl_mask, int control,
Daniel Mack23caaf12010-03-11 21:13:25 +01001225 struct usb_audio_term *iterm, int unitid,
Daniel Macka6a33252010-05-31 13:35:37 +02001226 int readonly_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001227{
Daniel Mack99fc8642010-03-11 21:13:24 +01001228 struct uac_feature_unit_descriptor *desc = raw_desc;
Julian Scheelbc18e312015-08-14 16:14:45 +02001229 struct usb_feature_control_info *ctl_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001230 unsigned int len = 0;
1231 int mapped_name = 0;
Daniel Mack99fc8642010-03-11 21:13:24 +01001232 int nameid = uac_feature_unit_iFeature(desc);
Takashi Iwai86e07d32005-11-17 15:08:02 +01001233 struct snd_kcontrol *kctl;
1234 struct usb_mixer_elem_info *cval;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001235 const struct usbmix_name_map *map;
Alexey Fisher80aceff2011-03-10 14:53:38 +01001236 unsigned int range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001237
1238 control++; /* change from zero-based to 1-based value */
1239
Daniel Mack65f25da2010-05-31 13:35:41 +02001240 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001241 /* FIXME: not supported yet */
1242 return;
1243 }
1244
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001245 map = find_map(state, unitid, control);
1246 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001247 return;
1248
Takashi Iwai561b2202005-09-09 14:22:34 +02001249 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Daniel Macka860d952014-05-24 10:58:17 +02001250 if (!cval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001251 return;
Takashi Iwai3360b842014-11-18 11:47:04 +01001252 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 cval->control = control;
1254 cval->cmask = ctl_mask;
Julian Scheelbc18e312015-08-14 16:14:45 +02001255 ctl_info = &audio_feature_info[control-1];
1256 if (state->mixer->protocol == UAC_VERSION_1)
1257 cval->val_type = ctl_info->type;
1258 else /* UAC_VERSION_2 */
1259 cval->val_type = ctl_info->type_uac2 >= 0 ?
1260 ctl_info->type_uac2 : ctl_info->type;
1261
Daniel Macka6a33252010-05-31 13:35:37 +02001262 if (ctl_mask == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001263 cval->channels = 1; /* master channel */
Daniel Macka6a33252010-05-31 13:35:37 +02001264 cval->master_readonly = readonly_mask;
1265 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001266 int i, c = 0;
1267 for (i = 0; i < 16; i++)
1268 if (ctl_mask & (1 << i))
1269 c++;
1270 cval->channels = c;
Daniel Macka6a33252010-05-31 13:35:37 +02001271 cval->ch_readonly = readonly_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001272 }
1273
Daniel Mack6bc170e2014-05-24 10:58:16 +02001274 /*
1275 * If all channels in the mask are marked read-only, make the control
Chris J Argeseef90452014-11-12 12:07:01 -06001276 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
Daniel Mack6bc170e2014-05-24 10:58:16 +02001277 * issue write commands to read-only channels.
1278 */
Daniel Macka6a33252010-05-31 13:35:37 +02001279 if (cval->channels == readonly_mask)
Daniel Mack23caaf12010-03-11 21:13:25 +01001280 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1281 else
1282 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1283
Daniel Mack6bc170e2014-05-24 10:58:16 +02001284 if (!kctl) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001285 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001286 kfree(cval);
1287 return;
1288 }
Chris J Argeseef90452014-11-12 12:07:01 -06001289 kctl->private_free = snd_usb_mixer_elem_free;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001290
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001291 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292 mapped_name = len != 0;
Daniel Mack6bc170e2014-05-24 10:58:16 +02001293 if (!len && nameid)
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001294 len = snd_usb_copy_string_desc(state, nameid,
1295 kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001296
1297 switch (control) {
Daniel Mack65f25da2010-05-31 13:35:41 +02001298 case UAC_FU_MUTE:
1299 case UAC_FU_VOLUME:
Daniel Mack6bc170e2014-05-24 10:58:16 +02001300 /*
1301 * determine the control name. the rule is:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001302 * - if a name id is given in descriptor, use it.
1303 * - if the connected input can be determined, then use the name
1304 * of terminal type.
1305 * - if the connected output can be determined, use it.
1306 * - otherwise, anonymous name.
1307 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001308 if (!len) {
1309 len = get_term_name(state, iterm, kctl->id.name,
1310 sizeof(kctl->id.name), 1);
1311 if (!len)
1312 len = get_term_name(state, &state->oterm,
1313 kctl->id.name,
1314 sizeof(kctl->id.name), 1);
1315 if (!len)
Daniel Mack49fd46d2014-10-19 09:11:25 +02001316 snprintf(kctl->id.name, sizeof(kctl->id.name),
1317 "Feature %d", unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001318 }
David Henningsson9b4ef972012-11-23 13:48:55 +01001319
1320 if (!mapped_name)
1321 check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1322
Daniel Mack6bc170e2014-05-24 10:58:16 +02001323 /*
1324 * determine the stream direction:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001325 * if the connected output is USB stream, then it's likely a
1326 * capture stream. otherwise it should be playback (hopefully :)
1327 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001328 if (!mapped_name && !(state->oterm.type >> 16)) {
1329 if ((state->oterm.type & 0xff00) == 0x0100)
Daniel Mack49fd46d2014-10-19 09:11:25 +02001330 append_ctl_name(kctl, " Capture");
Daniel Mack6bc170e2014-05-24 10:58:16 +02001331 else
Daniel Mack49fd46d2014-10-19 09:11:25 +02001332 append_ctl_name(kctl, " Playback");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001333 }
Daniel Mack65f25da2010-05-31 13:35:41 +02001334 append_ctl_name(kctl, control == UAC_FU_MUTE ?
Takashi Iwai08d1e632009-10-02 14:06:08 +02001335 " Switch" : " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001336 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001337 default:
Daniel Mack6bc170e2014-05-24 10:58:16 +02001338 if (!len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1340 sizeof(kctl->id.name));
1341 break;
1342 }
1343
Takashi Iwaie1825342012-05-14 17:11:06 +02001344 /* get min/max values */
1345 get_min_max_with_quirks(cval, 0, kctl);
1346
1347 if (control == UAC_FU_VOLUME) {
1348 check_mapped_dB(map, cval);
1349 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1350 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1351 kctl->vd[0].access |=
1352 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1353 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1354 }
1355 }
1356
Alexey Fisher80aceff2011-03-10 14:53:38 +01001357 range = (cval->max - cval->min) / cval->res;
Daniel Mack6bc170e2014-05-24 10:58:16 +02001358 /*
1359 * Are there devices with volume range more than 255? I use a bit more
Alexey Fisher80aceff2011-03-10 14:53:38 +01001360 * to be sure. 384 is a resolution magic number found on Logitech
1361 * devices. It will definitively catch all buggy Logitech devices.
1362 */
1363 if (range > 384) {
Daniel Mack6bc170e2014-05-24 10:58:16 +02001364 usb_audio_warn(state->chip,
Michał Mirosław82c1cf02014-08-03 15:09:57 +02001365 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
Daniel Mack6bc170e2014-05-24 10:58:16 +02001366 range);
Michał Mirosław82c1cf02014-08-03 15:09:57 +02001367 usb_audio_warn(state->chip,
1368 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
Takashi Iwai3360b842014-11-18 11:47:04 +01001369 cval->head.id, kctl->id.name, cval->channels,
Daniel Mack6bc170e2014-05-24 10:58:16 +02001370 cval->min, cval->max, cval->res);
Alexey Fisher80aceff2011-03-10 14:53:38 +01001371 }
1372
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001373 usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
Takashi Iwai3360b842014-11-18 11:47:04 +01001374 cval->head.id, kctl->id.name, cval->channels,
Daniel Mack6bc170e2014-05-24 10:58:16 +02001375 cval->min, cval->max, cval->res);
Takashi Iwai3360b842014-11-18 11:47:04 +01001376 snd_usb_mixer_add_control(&cval->head, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001377}
1378
Linus Torvalds1da177e2005-04-16 15:20:36 -07001379/*
1380 * parse a feature unit
1381 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001382 * most of controls are defined here.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001383 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001384static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1385 void *_ftr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001386{
1387 int channels, i, j;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001388 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001389 unsigned int master_bits, first_ch_bits;
1390 int err, csize;
Daniel Mack23caaf12010-03-11 21:13:25 +01001391 struct uac_feature_unit_descriptor *hdr = _ftr;
1392 __u8 *bmaControls;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001393
Daniel Mack23caaf12010-03-11 21:13:25 +01001394 if (state->mixer->protocol == UAC_VERSION_1) {
1395 csize = hdr->bControlSize;
Nicolai Krakowiak60c961a92011-08-04 15:56:27 +02001396 if (!csize) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001397 usb_audio_dbg(state->chip,
1398 "unit %u: invalid bControlSize == 0\n",
1399 unitid);
Nicolai Krakowiak60c961a92011-08-04 15:56:27 +02001400 return -EINVAL;
1401 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001402 channels = (hdr->bLength - 7) / csize - 1;
1403 bmaControls = hdr->bmaControls;
Clemens Ladischd56268f2012-11-29 17:04:23 +01001404 if (hdr->bLength < 7 + csize) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001405 usb_audio_err(state->chip,
1406 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1407 unitid);
Clemens Ladischd56268f2012-11-29 17:04:23 +01001408 return -EINVAL;
1409 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001410 } else {
1411 struct uac2_feature_unit_descriptor *ftr = _ftr;
1412 csize = 4;
Daniel Macke8d0fee2010-05-27 20:15:14 +02001413 channels = (hdr->bLength - 6) / 4 - 1;
Daniel Mack23caaf12010-03-11 21:13:25 +01001414 bmaControls = ftr->bmaControls;
Clemens Ladischd56268f2012-11-29 17:04:23 +01001415 if (hdr->bLength < 6 + csize) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001416 usb_audio_err(state->chip,
1417 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1418 unitid);
Clemens Ladischd56268f2012-11-29 17:04:23 +01001419 return -EINVAL;
1420 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001421 }
1422
1423 /* parse the source unit */
Daniel Mack23caaf12010-03-11 21:13:25 +01001424 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001425 return err;
1426
1427 /* determine the input source type and name */
Daniel Mack4d7b86c2013-03-19 21:09:24 +01001428 err = check_input_term(state, hdr->bSourceID, &iterm);
1429 if (err < 0)
1430 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001431
Daniel Mack23caaf12010-03-11 21:13:25 +01001432 master_bits = snd_usb_combine_bytes(bmaControls, csize);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001433 /* master configuration quirks */
1434 switch (state->chip->usb_id) {
1435 case USB_ID(0x08bb, 0x2702):
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001436 usb_audio_info(state->chip,
1437 "usbmixer: master volume quirk for PCM2702 chip\n");
Javier Kohen0c3cee52009-11-17 15:36:13 +01001438 /* disable non-functional volume control */
Daniel Mack65f25da2010-05-31 13:35:41 +02001439 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001440 break;
David Henningssonc1051432012-09-20 10:20:41 +02001441 case USB_ID(0x1130, 0xf211):
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001442 usb_audio_info(state->chip,
1443 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
David Henningssonc1051432012-09-20 10:20:41 +02001444 /* disable non-functional volume control */
1445 channels = 0;
1446 break;
1447
Javier Kohen0c3cee52009-11-17 15:36:13 +01001448 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001449 if (channels > 0)
Daniel Mack23caaf12010-03-11 21:13:25 +01001450 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001451 else
1452 first_ch_bits = 0;
Daniel Mack23caaf12010-03-11 21:13:25 +01001453
1454 if (state->mixer->protocol == UAC_VERSION_1) {
1455 /* check all control types */
1456 for (i = 0; i < 10; i++) {
1457 unsigned int ch_bits = 0;
1458 for (j = 0; j < channels; j++) {
Daniel Mack6bc170e2014-05-24 10:58:16 +02001459 unsigned int mask;
1460
1461 mask = snd_usb_combine_bytes(bmaControls +
1462 csize * (j+1), csize);
Daniel Mack23caaf12010-03-11 21:13:25 +01001463 if (mask & (1 << i))
1464 ch_bits |= (1 << j);
1465 }
1466 /* audio class v1 controls are never read-only */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001467
1468 /*
1469 * The first channel must be set
1470 * (for ease of programming).
1471 */
1472 if (ch_bits & 1)
1473 build_feature_ctl(state, _ftr, ch_bits, i,
1474 &iterm, unitid, 0);
Daniel Mack23caaf12010-03-11 21:13:25 +01001475 if (master_bits & (1 << i))
Daniel Mack6bc170e2014-05-24 10:58:16 +02001476 build_feature_ctl(state, _ftr, 0, i, &iterm,
1477 unitid, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001478 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001479 } else { /* UAC_VERSION_2 */
Takashi Iwaid09c06c2011-10-13 08:19:09 +02001480 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001481 unsigned int ch_bits = 0;
1482 unsigned int ch_read_only = 0;
1483
1484 for (j = 0; j < channels; j++) {
Daniel Mack6bc170e2014-05-24 10:58:16 +02001485 unsigned int mask;
1486
1487 mask = snd_usb_combine_bytes(bmaControls +
1488 csize * (j+1), csize);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001489 if (uac2_control_is_readable(mask, i)) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001490 ch_bits |= (1 << j);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001491 if (!uac2_control_is_writeable(mask, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001492 ch_read_only |= (1 << j);
1493 }
1494 }
1495
Daniel Mack6bc170e2014-05-24 10:58:16 +02001496 /*
1497 * NOTE: build_feature_ctl() will mark the control
1498 * read-only if all channels are marked read-only in
1499 * the descriptors. Otherwise, the control will be
1500 * reported as writeable, but the driver will not
1501 * actually issue a write command for read-only
1502 * channels.
1503 */
1504
1505 /*
1506 * The first channel must be set
1507 * (for ease of programming).
1508 */
1509 if (ch_bits & 1)
1510 build_feature_ctl(state, _ftr, ch_bits, i,
1511 &iterm, unitid, ch_read_only);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001512 if (uac2_control_is_readable(master_bits, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001513 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001514 !uac2_control_is_writeable(master_bits, i));
Daniel Mack23caaf12010-03-11 21:13:25 +01001515 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001516 }
1517
1518 return 0;
1519}
1520
Linus Torvalds1da177e2005-04-16 15:20:36 -07001521/*
1522 * Mixer Unit
1523 */
1524
1525/*
1526 * build a mixer unit control
1527 *
1528 * the callbacks are identical with feature unit.
1529 * input channel number (zero based) is given in control field instead.
1530 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001531static void build_mixer_unit_ctl(struct mixer_build *state,
1532 struct uac_mixer_unit_descriptor *desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001533 int in_pin, int in_ch, int unitid,
Takashi Iwai86e07d32005-11-17 15:08:02 +01001534 struct usb_audio_term *iterm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001535{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001536 struct usb_mixer_elem_info *cval;
Daniel Mack99fc8642010-03-11 21:13:24 +01001537 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001538 unsigned int i, len;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001539 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001540 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001541
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001542 map = find_map(state, unitid, 0);
1543 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001544 return;
1545
Takashi Iwai561b2202005-09-09 14:22:34 +02001546 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Daniel Mack6bc170e2014-05-24 10:58:16 +02001547 if (!cval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001548 return;
1549
Takashi Iwai3360b842014-11-18 11:47:04 +01001550 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001551 cval->control = in_ch + 1; /* based on 1 */
1552 cval->val_type = USB_MIXER_S16;
1553 for (i = 0; i < num_outs; i++) {
Daniel Mack6bc170e2014-05-24 10:58:16 +02001554 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
1555
1556 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001557 cval->cmask |= (1 << i);
1558 cval->channels++;
1559 }
1560 }
1561
1562 /* get min/max values */
1563 get_min_max(cval, 0);
1564
1565 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
Daniel Mack6bc170e2014-05-24 10:58:16 +02001566 if (!kctl) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001567 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001568 kfree(cval);
1569 return;
1570 }
Chris J Argeseef90452014-11-12 12:07:01 -06001571 kctl->private_free = snd_usb_mixer_elem_free;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001572
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001573 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Daniel Mack6bc170e2014-05-24 10:58:16 +02001574 if (!len)
1575 len = get_term_name(state, iterm, kctl->id.name,
1576 sizeof(kctl->id.name), 0);
1577 if (!len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001578 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
Takashi Iwai08d1e632009-10-02 14:06:08 +02001579 append_ctl_name(kctl, " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001580
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001581 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
Takashi Iwai3360b842014-11-18 11:47:04 +01001582 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
1583 snd_usb_mixer_add_control(&cval->head, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001584}
1585
Linus Torvalds1da177e2005-04-16 15:20:36 -07001586/*
1587 * parse a mixer unit
1588 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001589static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
1590 void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001591{
Daniel Mack99fc8642010-03-11 21:13:24 +01001592 struct uac_mixer_unit_descriptor *desc = raw_desc;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001593 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001594 int input_pins, num_ins, num_outs;
1595 int pin, ich, err;
1596
Daniel Mack6bc170e2014-05-24 10:58:16 +02001597 if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
1598 !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
1599 usb_audio_err(state->chip,
1600 "invalid MIXER UNIT descriptor %d\n",
1601 unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 return -EINVAL;
1603 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604
1605 num_ins = 0;
1606 ich = 0;
1607 for (pin = 0; pin < input_pins; pin++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001608 err = parse_audio_unit(state, desc->baSourceID[pin]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001609 if (err < 0)
Mark Hills284a8dd2012-04-14 17:19:23 +01001610 continue;
Clemens Ladischea114fc2015-06-03 11:36:51 +02001611 /* no bmControls field (e.g. Maya44) -> ignore */
1612 if (desc->bLength <= 10 + input_pins)
1613 continue;
Daniel Mack99fc8642010-03-11 21:13:24 +01001614 err = check_input_term(state, desc->baSourceID[pin], &iterm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001615 if (err < 0)
1616 return err;
1617 num_ins += iterm.channels;
Daniel Mack6bc170e2014-05-24 10:58:16 +02001618 for (; ich < num_ins; ich++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001619 int och, ich_has_controls = 0;
1620
Daniel Mack6bc170e2014-05-24 10:58:16 +02001621 for (och = 0; och < num_outs; och++) {
1622 __u8 *c = uac_mixer_unit_bmControls(desc,
1623 state->mixer->protocol);
1624
1625 if (check_matrix_bitmap(c, ich, och, num_outs)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 ich_has_controls = 1;
1627 break;
1628 }
1629 }
1630 if (ich_has_controls)
1631 build_mixer_unit_ctl(state, desc, pin, ich,
1632 unitid, &iterm);
1633 }
1634 }
1635 return 0;
1636}
1637
Linus Torvalds1da177e2005-04-16 15:20:36 -07001638/*
1639 * Processing Unit / Extension Unit
1640 */
1641
1642/* get callback for processing/extension unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001643static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
1644 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001645{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001646 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 int err, val;
1648
1649 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Takashi Iwai5aeee342014-11-18 11:02:14 +01001650 if (err < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001651 ucontrol->value.integer.value[0] = cval->min;
Takashi Iwai5aeee342014-11-18 11:02:14 +01001652 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001654 val = get_relative_value(cval, val);
1655 ucontrol->value.integer.value[0] = val;
1656 return 0;
1657}
1658
1659/* put callback for processing/extension unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001660static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
1661 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001662{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001663 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001664 int val, oval, err;
1665
1666 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
Takashi Iwai5aeee342014-11-18 11:02:14 +01001667 if (err < 0)
1668 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001669 val = ucontrol->value.integer.value[0];
1670 val = get_abs_value(cval, val);
1671 if (val != oval) {
1672 set_cur_ctl_value(cval, cval->control << 8, val);
1673 return 1;
1674 }
1675 return 0;
1676}
1677
1678/* alsa control interface for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001679static struct snd_kcontrol_new mixer_procunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001680 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1681 .name = "", /* will be filled later */
1682 .info = mixer_ctl_feature_info,
1683 .get = mixer_ctl_procunit_get,
1684 .put = mixer_ctl_procunit_put,
1685};
1686
Linus Torvalds1da177e2005-04-16 15:20:36 -07001687/*
1688 * predefined data for processing units
1689 */
1690struct procunit_value_info {
1691 int control;
1692 char *suffix;
1693 int val_type;
1694 int min_value;
1695};
1696
1697struct procunit_info {
1698 int type;
1699 char *name;
1700 struct procunit_value_info *values;
1701};
1702
1703static struct procunit_value_info updown_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001704 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1705 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001706 { 0 }
1707};
1708static struct procunit_value_info prologic_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001709 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1710 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001711 { 0 }
1712};
1713static struct procunit_value_info threed_enh_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001714 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1715 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 { 0 }
1717};
1718static struct procunit_value_info reverb_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001719 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1720 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1721 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1722 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 { 0 }
1724};
1725static struct procunit_value_info chorus_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001726 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1727 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1728 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1729 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001730 { 0 }
1731};
1732static struct procunit_value_info dcr_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001733 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1734 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1735 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1736 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1737 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1738 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001739 { 0 }
1740};
1741
1742static struct procunit_info procunits[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001743 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1744 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1745 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1746 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1747 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1748 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 { 0 },
1750};
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001751/*
1752 * predefined data for extension units
1753 */
1754static struct procunit_value_info clock_rate_xu_info[] = {
Daniel Macke213e9c2010-05-11 18:13:50 +02001755 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1756 { 0 }
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001757};
1758static struct procunit_value_info clock_source_xu_info[] = {
1759 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1760 { 0 }
1761};
1762static struct procunit_value_info spdif_format_xu_info[] = {
1763 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1764 { 0 }
1765};
1766static struct procunit_value_info soft_limit_xu_info[] = {
1767 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1768 { 0 }
1769};
1770static struct procunit_info extunits[] = {
1771 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1772 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1773 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1774 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1775 { 0 }
1776};
Daniel Mack6bc170e2014-05-24 10:58:16 +02001777
Linus Torvalds1da177e2005-04-16 15:20:36 -07001778/*
1779 * build a processing/extension unit
1780 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001781static int build_audio_procunit(struct mixer_build *state, int unitid,
1782 void *raw_desc, struct procunit_info *list,
1783 char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001784{
Daniel Mack99fc8642010-03-11 21:13:24 +01001785 struct uac_processing_unit_descriptor *desc = raw_desc;
1786 int num_ins = desc->bNrInPins;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001787 struct usb_mixer_elem_info *cval;
1788 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001789 int i, err, nameid, type, len;
1790 struct procunit_info *info;
1791 struct procunit_value_info *valinfo;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001792 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001793 static struct procunit_value_info default_value_info[] = {
1794 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1795 { 0 }
1796 };
1797 static struct procunit_info default_info = {
1798 0, NULL, default_value_info
1799 };
1800
Daniel Mack23caaf12010-03-11 21:13:25 +01001801 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1802 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001803 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001804 return -EINVAL;
1805 }
1806
1807 for (i = 0; i < num_ins; i++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001808 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001809 return err;
1810 }
1811
Daniel Mack99fc8642010-03-11 21:13:24 +01001812 type = le16_to_cpu(desc->wProcessType);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001813 for (info = list; info && info->type; info++)
1814 if (info->type == type)
1815 break;
Daniel Mack6bc170e2014-05-24 10:58:16 +02001816 if (!info || !info->type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001817 info = &default_info;
1818
1819 for (valinfo = info->values; valinfo->control; valinfo++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001820 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
Daniel Mack99fc8642010-03-11 21:13:24 +01001821
Daniel Mack6bc170e2014-05-24 10:58:16 +02001822 if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001823 continue;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001824 map = find_map(state, unitid, valinfo->control);
1825 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001826 continue;
Takashi Iwai561b2202005-09-09 14:22:34 +02001827 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Daniel Macka860d952014-05-24 10:58:17 +02001828 if (!cval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001829 return -ENOMEM;
Takashi Iwai3360b842014-11-18 11:47:04 +01001830 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001831 cval->control = valinfo->control;
1832 cval->val_type = valinfo->val_type;
1833 cval->channels = 1;
1834
1835 /* get min/max values */
Daniel Mack65f25da2010-05-31 13:35:41 +02001836 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001837 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001838 /* FIXME: hard-coded */
1839 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001840 cval->max = control_spec[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001841 cval->res = 1;
1842 cval->initialized = 1;
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001843 } else {
1844 if (type == USB_XU_CLOCK_RATE) {
Daniel Mack6bc170e2014-05-24 10:58:16 +02001845 /*
1846 * E-Mu USB 0404/0202/TrackerPre/0204
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001847 * samplerate control quirk
1848 */
1849 cval->min = 0;
1850 cval->max = 5;
1851 cval->res = 1;
1852 cval->initialized = 1;
1853 } else
1854 get_min_max(cval, valinfo->min_value);
1855 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001856
1857 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
Daniel Mack6bc170e2014-05-24 10:58:16 +02001858 if (!kctl) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001859 kfree(cval);
1860 return -ENOMEM;
1861 }
Chris J Argeseef90452014-11-12 12:07:01 -06001862 kctl->private_free = snd_usb_mixer_elem_free;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001863
Daniel Mack6bc170e2014-05-24 10:58:16 +02001864 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001865 /* nothing */ ;
Daniel Mack6bc170e2014-05-24 10:58:16 +02001866 } else if (info->name) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001867 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
Daniel Mack6bc170e2014-05-24 10:58:16 +02001868 } else {
Daniel Mack23caaf12010-03-11 21:13:25 +01001869 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001870 len = 0;
1871 if (nameid)
Daniel Mack6bc170e2014-05-24 10:58:16 +02001872 len = snd_usb_copy_string_desc(state, nameid,
1873 kctl->id.name,
1874 sizeof(kctl->id.name));
1875 if (!len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001876 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1877 }
Takashi Iwai08d1e632009-10-02 14:06:08 +02001878 append_ctl_name(kctl, " ");
1879 append_ctl_name(kctl, valinfo->suffix);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001880
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001881 usb_audio_dbg(state->chip,
Daniel Mack6bc170e2014-05-24 10:58:16 +02001882 "[%d] PU [%s] ch = %d, val = %d/%d\n",
Takashi Iwai3360b842014-11-18 11:47:04 +01001883 cval->head.id, kctl->id.name, cval->channels,
Daniel Mack6bc170e2014-05-24 10:58:16 +02001884 cval->min, cval->max);
1885
Takashi Iwai3360b842014-11-18 11:47:04 +01001886 err = snd_usb_mixer_add_control(&cval->head, kctl);
Daniel Mack6bc170e2014-05-24 10:58:16 +02001887 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001888 return err;
1889 }
1890 return 0;
1891}
1892
Daniel Mack6bc170e2014-05-24 10:58:16 +02001893static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
1894 void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895{
Daniel Mack6bc170e2014-05-24 10:58:16 +02001896 return build_audio_procunit(state, unitid, raw_desc,
1897 procunits, "Processing Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898}
1899
Daniel Mack6bc170e2014-05-24 10:58:16 +02001900static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
1901 void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001902{
Daniel Mack6bc170e2014-05-24 10:58:16 +02001903 /*
1904 * Note that we parse extension units with processing unit descriptors.
1905 * That's ok as the layout is the same.
1906 */
1907 return build_audio_procunit(state, unitid, raw_desc,
1908 extunits, "Extension Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001909}
1910
Linus Torvalds1da177e2005-04-16 15:20:36 -07001911/*
1912 * Selector Unit
1913 */
1914
Daniel Mack6bc170e2014-05-24 10:58:16 +02001915/*
1916 * info callback for selector unit
Linus Torvalds1da177e2005-04-16 15:20:36 -07001917 * use an enumerator type for routing
1918 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001919static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
1920 struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001921{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001922 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001923 const char **itemlist = (const char **)kcontrol->private_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001924
Takashi Iwai5e246b82008-08-08 17:12:47 +02001925 if (snd_BUG_ON(!itemlist))
1926 return -EINVAL;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001927 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928}
1929
1930/* get callback for selector unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001931static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
1932 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001933{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001934 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001935 int val, err;
1936
Daniel Mack09414202010-05-31 13:35:44 +02001937 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001938 if (err < 0) {
Takashi Iwai5aeee342014-11-18 11:02:14 +01001939 ucontrol->value.enumerated.item[0] = 0;
1940 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001941 }
1942 val = get_relative_value(cval, val);
1943 ucontrol->value.enumerated.item[0] = val;
1944 return 0;
1945}
1946
1947/* put callback for selector unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001948static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
1949 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001950{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001951 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001952 int val, oval, err;
1953
Daniel Mack09414202010-05-31 13:35:44 +02001954 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
Takashi Iwai5aeee342014-11-18 11:02:14 +01001955 if (err < 0)
1956 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 val = ucontrol->value.enumerated.item[0];
1958 val = get_abs_value(cval, val);
1959 if (val != oval) {
Daniel Mack09414202010-05-31 13:35:44 +02001960 set_cur_ctl_value(cval, cval->control << 8, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001961 return 1;
1962 }
1963 return 0;
1964}
1965
1966/* alsa control interface for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001967static struct snd_kcontrol_new mixer_selectunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001968 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1969 .name = "", /* will be filled later */
1970 .info = mixer_ctl_selector_info,
1971 .get = mixer_ctl_selector_get,
1972 .put = mixer_ctl_selector_put,
1973};
1974
Daniel Mack6bc170e2014-05-24 10:58:16 +02001975/*
1976 * private free callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001977 * free both private_data and private_value
1978 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001979static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980{
1981 int i, num_ins = 0;
1982
1983 if (kctl->private_data) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01001984 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001985 num_ins = cval->max;
1986 kfree(cval);
1987 kctl->private_data = NULL;
1988 }
1989 if (kctl->private_value) {
1990 char **itemlist = (char **)kctl->private_value;
1991 for (i = 0; i < num_ins; i++)
1992 kfree(itemlist[i]);
1993 kfree(itemlist);
1994 kctl->private_value = 0;
1995 }
1996}
1997
1998/*
1999 * parse a selector unit
2000 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02002001static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2002 void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002003{
Daniel Mack99fc8642010-03-11 21:13:24 +01002004 struct uac_selector_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002005 unsigned int i, nameid, len;
2006 int err;
Takashi Iwai86e07d32005-11-17 15:08:02 +01002007 struct usb_mixer_elem_info *cval;
2008 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01002009 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 char **namelist;
2011
Daniel Mack99fc8642010-03-11 21:13:24 +01002012 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002013 usb_audio_err(state->chip,
2014 "invalid SELECTOR UNIT descriptor %d\n", unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002015 return -EINVAL;
2016 }
2017
Daniel Mack99fc8642010-03-11 21:13:24 +01002018 for (i = 0; i < desc->bNrInPins; i++) {
2019 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002020 return err;
2021 }
2022
Daniel Mack99fc8642010-03-11 21:13:24 +01002023 if (desc->bNrInPins == 1) /* only one ? nonsense! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002024 return 0;
2025
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01002026 map = find_map(state, unitid, 0);
2027 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002028 return 0;
2029
Takashi Iwai561b2202005-09-09 14:22:34 +02002030 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Daniel Macka860d952014-05-24 10:58:17 +02002031 if (!cval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002032 return -ENOMEM;
Takashi Iwai3360b842014-11-18 11:47:04 +01002033 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002034 cval->val_type = USB_MIXER_U8;
2035 cval->channels = 1;
2036 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01002037 cval->max = desc->bNrInPins;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002038 cval->res = 1;
2039 cval->initialized = 1;
2040
Johan Rasténa358a0e2014-11-17 08:39:33 +01002041 if (state->mixer->protocol == UAC_VERSION_1)
Daniel Mack09414202010-05-31 13:35:44 +02002042 cval->control = 0;
Johan Rasténa358a0e2014-11-17 08:39:33 +01002043 else /* UAC_VERSION_2 */
2044 cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
2045 UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
Daniel Mack09414202010-05-31 13:35:44 +02002046
Daniel Mack99fc8642010-03-11 21:13:24 +01002047 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
Daniel Mack6bc170e2014-05-24 10:58:16 +02002048 if (!namelist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049 kfree(cval);
2050 return -ENOMEM;
2051 }
2052#define MAX_ITEM_NAME_LEN 64
Daniel Mack99fc8642010-03-11 21:13:24 +01002053 for (i = 0; i < desc->bNrInPins; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01002054 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002055 len = 0;
2056 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
Daniel Mack6bc170e2014-05-24 10:58:16 +02002057 if (!namelist[i]) {
Mariusz Kozlowski7fbe3ca2007-01-08 11:25:30 +01002058 while (i--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002059 kfree(namelist[i]);
2060 kfree(namelist);
2061 kfree(cval);
2062 return -ENOMEM;
2063 }
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02002064 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2065 MAX_ITEM_NAME_LEN);
Daniel Mack99fc8642010-03-11 21:13:24 +01002066 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002067 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
2068 if (! len)
Masanari Iidaaf831ee2014-04-28 13:08:55 +09002069 sprintf(namelist[i], "Input %u", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002070 }
2071
2072 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2073 if (! kctl) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002074 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
Jesper Juhl878b4782006-03-20 11:27:13 +01002075 kfree(namelist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002076 kfree(cval);
2077 return -ENOMEM;
2078 }
2079 kctl->private_value = (unsigned long)namelist;
2080 kctl->private_free = usb_mixer_selector_elem_free;
2081
Daniel Mack99fc8642010-03-11 21:13:24 +01002082 nameid = uac_selector_unit_iSelector(desc);
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01002083 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 if (len)
2085 ;
2086 else if (nameid)
Daniel Mack6bc170e2014-05-24 10:58:16 +02002087 snd_usb_copy_string_desc(state, nameid, kctl->id.name,
2088 sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 else {
2090 len = get_term_name(state, &state->oterm,
2091 kctl->id.name, sizeof(kctl->id.name), 0);
Daniel Mack6bc170e2014-05-24 10:58:16 +02002092 if (!len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2094
Daniel Mack09414202010-05-31 13:35:44 +02002095 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2096 append_ctl_name(kctl, " Clock Source");
2097 else if ((state->oterm.type & 0xff00) == 0x0100)
Takashi Iwai08d1e632009-10-02 14:06:08 +02002098 append_ctl_name(kctl, " Capture Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002099 else
Takashi Iwai08d1e632009-10-02 14:06:08 +02002100 append_ctl_name(kctl, " Playback Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 }
2102
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002103 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
Takashi Iwai3360b842014-11-18 11:47:04 +01002104 cval->head.id, kctl->id.name, desc->bNrInPins);
2105 return snd_usb_mixer_add_control(&cval->head, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002106}
2107
Linus Torvalds1da177e2005-04-16 15:20:36 -07002108/*
2109 * parse an audio unit recursively
2110 */
2111
Takashi Iwai86e07d32005-11-17 15:08:02 +01002112static int parse_audio_unit(struct mixer_build *state, int unitid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002113{
2114 unsigned char *p1;
2115
2116 if (test_and_set_bit(unitid, state->unitbitmap))
2117 return 0; /* the unit already visited */
2118
2119 p1 = find_audio_control_unit(state, unitid);
2120 if (!p1) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002121 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002122 return -EINVAL;
2123 }
2124
2125 switch (p1[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +01002126 case UAC_INPUT_TERMINAL:
Daniel Mack09414202010-05-31 13:35:44 +02002127 case UAC2_CLOCK_SOURCE:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 return 0; /* NOP */
Daniel Mackde48c7b2010-02-22 23:49:13 +01002129 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002130 return parse_audio_mixer_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01002131 case UAC_SELECTOR_UNIT:
Daniel Mack09414202010-05-31 13:35:44 +02002132 case UAC2_CLOCK_SELECTOR:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002133 return parse_audio_selector_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01002134 case UAC_FEATURE_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002135 return parse_audio_feature_unit(state, unitid, p1);
Daniel Mack69da9bc2010-06-16 17:57:28 +02002136 case UAC1_PROCESSING_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01002137 /* UAC2_EFFECT_UNIT has the same value */
2138 if (state->mixer->protocol == UAC_VERSION_1)
2139 return parse_audio_processing_unit(state, unitid, p1);
2140 else
2141 return 0; /* FIXME - effect units not implemented yet */
Daniel Mack69da9bc2010-06-16 17:57:28 +02002142 case UAC1_EXTENSION_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01002143 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2144 if (state->mixer->protocol == UAC_VERSION_1)
2145 return parse_audio_extension_unit(state, unitid, p1);
2146 else /* UAC_VERSION_2 */
2147 return parse_audio_processing_unit(state, unitid, p1);
Torstein Hegge61ac5132013-03-19 17:12:14 +01002148 case UAC2_EXTENSION_UNIT_V2:
2149 return parse_audio_extension_unit(state, unitid, p1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002150 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002151 usb_audio_err(state->chip,
2152 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 return -EINVAL;
2154 }
2155}
2156
Clemens Ladisch84957a82005-04-29 16:23:13 +02002157static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2158{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002159 kfree(mixer->id_elems);
2160 if (mixer->urb) {
2161 kfree(mixer->urb->transfer_buffer);
2162 usb_free_urb(mixer->urb);
2163 }
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002164 usb_free_urb(mixer->rc_urb);
Clemens Ladischb259b102005-04-29 16:29:28 +02002165 kfree(mixer->rc_setup_packet);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002166 kfree(mixer);
2167}
2168
Takashi Iwai86e07d32005-11-17 15:08:02 +01002169static int snd_usb_mixer_dev_free(struct snd_device *device)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002170{
2171 struct usb_mixer_interface *mixer = device->device_data;
2172 snd_usb_mixer_free(mixer);
2173 return 0;
2174}
2175
Linus Torvalds1da177e2005-04-16 15:20:36 -07002176/*
2177 * create mixer controls
2178 *
Daniel Mackde48c7b2010-02-22 23:49:13 +01002179 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
Linus Torvalds1da177e2005-04-16 15:20:36 -07002180 */
Clemens Ladisch84957a82005-04-29 16:23:13 +02002181static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002183 struct mixer_build state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002184 int err;
2185 const struct usbmix_ctl_map *map;
Daniel Mack23caaf12010-03-11 21:13:25 +01002186 void *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002187
Linus Torvalds1da177e2005-04-16 15:20:36 -07002188 memset(&state, 0, sizeof(state));
Clemens Ladisch84957a82005-04-29 16:23:13 +02002189 state.chip = mixer->chip;
2190 state.mixer = mixer;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002191 state.buffer = mixer->hostif->extra;
2192 state.buflen = mixer->hostif->extralen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002193
2194 /* check the mapping table */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002195 for (map = usbmix_ctl_maps; map->id; map++) {
2196 if (map->id == state.chip->usb_id) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002197 state.map = map->map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02002198 state.selector_map = map->selector_map;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002199 mixer->ignore_ctl_error = map->ignore_ctl_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002200 break;
2201 }
2202 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203
Daniel Mack23caaf12010-03-11 21:13:25 +01002204 p = NULL;
Daniel Mack6bc170e2014-05-24 10:58:16 +02002205 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
2206 mixer->hostif->extralen,
Daniel Mack1faa5d02011-08-04 15:56:28 +02002207 p, UAC_OUTPUT_TERMINAL)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +01002208 if (mixer->protocol == UAC_VERSION_1) {
Daniel Mack69da9bc2010-06-16 17:57:28 +02002209 struct uac1_output_terminal_descriptor *desc = p;
Daniel Mack23caaf12010-03-11 21:13:25 +01002210
2211 if (desc->bLength < sizeof(*desc))
2212 continue; /* invalid descriptor? */
Daniel Mack6bc170e2014-05-24 10:58:16 +02002213 /* mark terminal ID as visited */
2214 set_bit(desc->bTerminalID, state.unitbitmap);
Daniel Mack23caaf12010-03-11 21:13:25 +01002215 state.oterm.id = desc->bTerminalID;
2216 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2217 state.oterm.name = desc->iTerminal;
2218 err = parse_audio_unit(&state, desc->bSourceID);
Daniel Mack83ea5d12013-03-19 21:09:25 +01002219 if (err < 0 && err != -EINVAL)
Daniel Mack23caaf12010-03-11 21:13:25 +01002220 return err;
2221 } else { /* UAC_VERSION_2 */
2222 struct uac2_output_terminal_descriptor *desc = p;
2223
2224 if (desc->bLength < sizeof(*desc))
2225 continue; /* invalid descriptor? */
Daniel Mack6bc170e2014-05-24 10:58:16 +02002226 /* mark terminal ID as visited */
2227 set_bit(desc->bTerminalID, state.unitbitmap);
Daniel Mack23caaf12010-03-11 21:13:25 +01002228 state.oterm.id = desc->bTerminalID;
2229 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2230 state.oterm.name = desc->iTerminal;
2231 err = parse_audio_unit(&state, desc->bSourceID);
Daniel Mack83ea5d12013-03-19 21:09:25 +01002232 if (err < 0 && err != -EINVAL)
Daniel Mack23caaf12010-03-11 21:13:25 +01002233 return err;
Daniel Mack09414202010-05-31 13:35:44 +02002234
Daniel Mack6bc170e2014-05-24 10:58:16 +02002235 /*
2236 * For UAC2, use the same approach to also add the
2237 * clock selectors
2238 */
Daniel Mack09414202010-05-31 13:35:44 +02002239 err = parse_audio_unit(&state, desc->bCSourceID);
Daniel Mack83ea5d12013-03-19 21:09:25 +01002240 if (err < 0 && err != -EINVAL)
Daniel Mack09414202010-05-31 13:35:44 +02002241 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +01002242 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002243 }
Daniel Mack23caaf12010-03-11 21:13:25 +01002244
Linus Torvalds1da177e2005-04-16 15:20:36 -07002245 return 0;
2246}
Clemens Ladisch84957a82005-04-29 16:23:13 +02002247
Daniel Mack7b1eda22010-03-11 21:13:22 +01002248void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002249{
Takashi Iwai3360b842014-11-18 11:47:04 +01002250 struct usb_mixer_elem_list *list;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002251
Takashi Iwai3360b842014-11-18 11:47:04 +01002252 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002253 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
Takashi Iwai3360b842014-11-18 11:47:04 +01002254 &list->kctl->id);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002255}
2256
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002257static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
Takashi Iwai3360b842014-11-18 11:47:04 +01002258 struct usb_mixer_elem_list *list)
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002259{
Takashi Iwai3360b842014-11-18 11:47:04 +01002260 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002261 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2262 "S8", "U8", "S16", "U16"};
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002263 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
Takashi Iwai3360b842014-11-18 11:47:04 +01002264 "channels=%i, type=\"%s\"\n", cval->head.id,
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002265 cval->control, cval->cmask, cval->channels,
2266 val_types[cval->val_type]);
2267 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2268 cval->min, cval->max, cval->dBmin, cval->dBmax);
2269}
2270
2271static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2272 struct snd_info_buffer *buffer)
2273{
2274 struct snd_usb_audio *chip = entry->private_data;
2275 struct usb_mixer_interface *mixer;
Takashi Iwai3360b842014-11-18 11:47:04 +01002276 struct usb_mixer_elem_list *list;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002277 int unitid;
2278
2279 list_for_each_entry(mixer, &chip->mixer_list, list) {
2280 snd_iprintf(buffer,
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002281 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
Daniel Mack3d8d4dc2010-06-16 17:57:31 +02002282 chip->usb_id, snd_usb_ctrl_intf(chip),
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002283 mixer->ignore_ctl_error);
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002284 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2285 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
Takashi Iwai3360b842014-11-18 11:47:04 +01002286 for (list = mixer->id_elems[unitid]; list;
2287 list = list->next_id_elem) {
2288 snd_iprintf(buffer, " Unit: %i\n", list->id);
2289 if (list->kctl)
2290 snd_iprintf(buffer,
2291 " Control: name=\"%s\", index=%i\n",
2292 list->kctl->id.name,
2293 list->kctl->id.index);
2294 if (list->dump)
2295 list->dump(buffer, list);
2296 }
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002297 }
2298 }
2299}
2300
Daniel Macke213e9c2010-05-11 18:13:50 +02002301static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2302 int attribute, int value, int index)
2303{
Takashi Iwai3360b842014-11-18 11:47:04 +01002304 struct usb_mixer_elem_list *list;
Daniel Macke213e9c2010-05-11 18:13:50 +02002305 __u8 unitid = (index >> 8) & 0xff;
2306 __u8 control = (value >> 8) & 0xff;
2307 __u8 channel = value & 0xff;
2308
2309 if (channel >= MAX_CHANNELS) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002310 usb_audio_dbg(mixer->chip,
2311 "%s(): bogus channel number %d\n",
2312 __func__, channel);
Daniel Macke213e9c2010-05-11 18:13:50 +02002313 return;
2314 }
2315
Takashi Iwai3360b842014-11-18 11:47:04 +01002316 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2317 struct usb_mixer_elem_info *info;
2318
2319 if (!list->kctl)
2320 continue;
2321
2322 info = (struct usb_mixer_elem_info *)list;
Daniel Macke213e9c2010-05-11 18:13:50 +02002323 if (info->control != control)
2324 continue;
2325
2326 switch (attribute) {
2327 case UAC2_CS_CUR:
2328 /* invalidate cache, so the value is read from the device */
2329 if (channel)
2330 info->cached &= ~(1 << channel);
2331 else /* master channel */
2332 info->cached = 0;
2333
2334 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
Takashi Iwai3360b842014-11-18 11:47:04 +01002335 &info->head.kctl->id);
Daniel Macke213e9c2010-05-11 18:13:50 +02002336 break;
2337
2338 case UAC2_CS_RANGE:
2339 /* TODO */
2340 break;
2341
2342 case UAC2_CS_MEM:
2343 /* TODO */
2344 break;
2345
2346 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002347 usb_audio_dbg(mixer->chip,
2348 "unknown attribute %d in interrupt\n",
2349 attribute);
Daniel Macke213e9c2010-05-11 18:13:50 +02002350 break;
2351 } /* switch */
2352 }
2353}
2354
2355static void snd_usb_mixer_interrupt(struct urb *urb)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002356{
2357 struct usb_mixer_interface *mixer = urb->context;
Daniel Macke213e9c2010-05-11 18:13:50 +02002358 int len = urb->actual_length;
Oliver Neukumedf7de32011-03-11 13:19:43 +01002359 int ustatus = urb->status;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002360
Oliver Neukumedf7de32011-03-11 13:19:43 +01002361 if (ustatus != 0)
Daniel Macke213e9c2010-05-11 18:13:50 +02002362 goto requeue;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002363
Daniel Macke213e9c2010-05-11 18:13:50 +02002364 if (mixer->protocol == UAC_VERSION_1) {
2365 struct uac1_status_word *status;
2366
2367 for (status = urb->transfer_buffer;
2368 len >= sizeof(*status);
2369 len -= sizeof(*status), status++) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002370 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
Daniel Macke213e9c2010-05-11 18:13:50 +02002371 status->bStatusType,
2372 status->bOriginator);
2373
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002374 /* ignore any notifications not from the control interface */
Daniel Macke213e9c2010-05-11 18:13:50 +02002375 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2376 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002377 continue;
Daniel Macke213e9c2010-05-11 18:13:50 +02002378
2379 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2380 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
Clemens Ladischb259b102005-04-29 16:29:28 +02002381 else
Daniel Macke213e9c2010-05-11 18:13:50 +02002382 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2383 }
2384 } else { /* UAC_VERSION_2 */
2385 struct uac2_interrupt_data_msg *msg;
2386
2387 for (msg = urb->transfer_buffer;
2388 len >= sizeof(*msg);
2389 len -= sizeof(*msg), msg++) {
2390 /* drop vendor specific and endpoint requests */
2391 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2392 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2393 continue;
2394
2395 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2396 le16_to_cpu(msg->wValue),
2397 le16_to_cpu(msg->wIndex));
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002398 }
2399 }
Daniel Macke213e9c2010-05-11 18:13:50 +02002400
2401requeue:
Daniel Mack6bc170e2014-05-24 10:58:16 +02002402 if (ustatus != -ENOENT &&
2403 ustatus != -ECONNRESET &&
2404 ustatus != -ESHUTDOWN) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002405 urb->dev = mixer->chip->dev;
2406 usb_submit_urb(urb, GFP_ATOMIC);
2407 }
2408}
2409
2410/* create the handler for the optional status interrupt endpoint */
2411static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2412{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002413 struct usb_endpoint_descriptor *ep;
2414 void *transfer_buffer;
2415 int buffer_length;
2416 unsigned int epnum;
2417
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002418 /* we need one interrupt input endpoint */
Daniel Mack1faa5d02011-08-04 15:56:28 +02002419 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002420 return 0;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002421 ep = get_endpoint(mixer->hostif, 0);
Julia Lawall913ae5a2009-01-03 17:54:53 +01002422 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002423 return 0;
2424
Julia Lawall42a6e662008-12-29 11:23:02 +01002425 epnum = usb_endpoint_num(ep);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002426 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2427 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2428 if (!transfer_buffer)
2429 return -ENOMEM;
2430 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2431 if (!mixer->urb) {
2432 kfree(transfer_buffer);
2433 return -ENOMEM;
2434 }
2435 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2436 usb_rcvintpipe(mixer->chip->dev, epnum),
2437 transfer_buffer, buffer_length,
Daniel Macke213e9c2010-05-11 18:13:50 +02002438 snd_usb_mixer_interrupt, mixer, ep->bInterval);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002439 usb_submit_urb(mixer->urb, GFP_KERNEL);
2440 return 0;
2441}
2442
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002443int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2444 int ignore_error)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002445{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002446 static struct snd_device_ops dev_ops = {
Clemens Ladisch84957a82005-04-29 16:23:13 +02002447 .dev_free = snd_usb_mixer_dev_free
2448 };
2449 struct usb_mixer_interface *mixer;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002450 struct snd_info_entry *entry;
Daniel Mack23caaf12010-03-11 21:13:25 +01002451 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002452
2453 strcpy(chip->card->mixername, "USB Mixer");
2454
Takashi Iwai561b2202005-09-09 14:22:34 +02002455 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002456 if (!mixer)
2457 return -ENOMEM;
2458 mixer->chip = chip;
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002459 mixer->ignore_ctl_error = ignore_error;
Jaroslav Kysela291186e2010-02-16 11:55:18 +01002460 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2461 GFP_KERNEL);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002462 if (!mixer->id_elems) {
2463 kfree(mixer);
2464 return -ENOMEM;
2465 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02002466
Daniel Mack1faa5d02011-08-04 15:56:28 +02002467 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2468 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +02002469 case UAC_VERSION_1:
2470 default:
2471 mixer->protocol = UAC_VERSION_1;
2472 break;
2473 case UAC_VERSION_2:
2474 mixer->protocol = UAC_VERSION_2;
2475 break;
2476 }
Daniel Mack7b8a0432010-02-22 23:49:12 +01002477
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002478 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002479 (err = snd_usb_mixer_status_create(mixer)) < 0)
2480 goto _error;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002481
Daniel Mack7b1eda22010-03-11 21:13:22 +01002482 snd_usb_mixer_apply_create_quirk(mixer);
Clemens Ladisch468b8fd2009-07-13 11:39:29 +02002483
Takashi Iwai9cbb2802014-02-04 11:15:31 +01002484 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002485 if (err < 0)
2486 goto _error;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002487
2488 if (list_empty(&chip->mixer_list) &&
2489 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2490 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2491
Clemens Ladisch84957a82005-04-29 16:23:13 +02002492 list_add(&mixer->list, &chip->mixer_list);
2493 return 0;
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002494
2495_error:
2496 snd_usb_mixer_free(mixer);
2497 return err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002498}
2499
Takashi Iwaia6cece92014-10-31 11:24:32 +01002500void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002501{
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002502 usb_kill_urb(mixer->urb);
2503 usb_kill_urb(mixer->rc_urb);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002504}
Takashi Iwai400362f2014-01-20 16:51:16 +01002505
2506#ifdef CONFIG_PM
2507/* stop any bus activity of a mixer */
2508static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2509{
2510 usb_kill_urb(mixer->urb);
2511 usb_kill_urb(mixer->rc_urb);
2512}
2513
2514static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2515{
2516 int err;
2517
2518 if (mixer->urb) {
2519 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2520 if (err < 0)
2521 return err;
2522 }
2523
2524 return 0;
2525}
2526
2527int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
2528{
2529 snd_usb_mixer_inactivate(mixer);
2530 return 0;
2531}
2532
Takashi Iwai3360b842014-11-18 11:47:04 +01002533static int restore_mixer_value(struct usb_mixer_elem_list *list)
Takashi Iwai400362f2014-01-20 16:51:16 +01002534{
Takashi Iwai3360b842014-11-18 11:47:04 +01002535 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
Takashi Iwai400362f2014-01-20 16:51:16 +01002536 int c, err, idx;
2537
2538 if (cval->cmask) {
2539 idx = 0;
2540 for (c = 0; c < MAX_CHANNELS; c++) {
2541 if (!(cval->cmask & (1 << c)))
2542 continue;
Yao-Wen Mao6aa69252015-08-28 16:33:25 +08002543 if (cval->cached & (1 << (c + 1))) {
Chris J Argeseef90452014-11-12 12:07:01 -06002544 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
Takashi Iwai400362f2014-01-20 16:51:16 +01002545 cval->cache_val[idx]);
2546 if (err < 0)
2547 return err;
2548 }
2549 idx++;
2550 }
2551 } else {
2552 /* master */
2553 if (cval->cached) {
Chris J Argeseef90452014-11-12 12:07:01 -06002554 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
Takashi Iwai400362f2014-01-20 16:51:16 +01002555 if (err < 0)
2556 return err;
2557 }
2558 }
2559
2560 return 0;
2561}
2562
2563int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
2564{
Takashi Iwai3360b842014-11-18 11:47:04 +01002565 struct usb_mixer_elem_list *list;
Takashi Iwai400362f2014-01-20 16:51:16 +01002566 int id, err;
2567
Takashi Iwai400362f2014-01-20 16:51:16 +01002568 if (reset_resume) {
2569 /* restore cached mixer values */
2570 for (id = 0; id < MAX_ID_ELEMS; id++) {
Takashi Iwai3360b842014-11-18 11:47:04 +01002571 for (list = mixer->id_elems[id]; list;
2572 list = list->next_id_elem) {
2573 if (list->resume) {
2574 err = list->resume(list);
2575 if (err < 0)
2576 return err;
2577 }
Takashi Iwai400362f2014-01-20 16:51:16 +01002578 }
2579 }
2580 }
2581
2582 return snd_usb_mixer_activate(mixer);
2583}
2584#endif
Takashi Iwai3360b842014-11-18 11:47:04 +01002585
2586void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
2587 struct usb_mixer_interface *mixer,
2588 int unitid)
2589{
2590 list->mixer = mixer;
2591 list->id = unitid;
2592 list->dump = snd_usb_mixer_dump_cval;
2593#ifdef CONFIG_PM
2594 list->resume = restore_mixer_value;
2595#endif
2596}