blob: 4703caea56b2f600417c8a961bd1d73ec1ab2e15 [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>
Daniel Mackcddaafb2016-04-09 11:21:46 +020048#include <linux/log2.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070049#include <linux/slab.h>
50#include <linux/string.h>
51#include <linux/usb.h>
Daniel Mack28e1b772010-02-22 23:49:09 +010052#include <linux/usb/audio.h>
Daniel Mack23caaf12010-03-11 21:13:25 +010053#include <linux/usb/audio-v2.h>
Daniel Mack28e1b772010-02-22 23:49:09 +010054
Linus Torvalds1da177e2005-04-16 15:20:36 -070055#include <sound/core.h>
56#include <sound/control.h>
Clemens Ladischb259b102005-04-29 16:29:28 +020057#include <sound/hwdep.h>
Clemens Ladischaafad562005-05-10 14:47:38 +020058#include <sound/info.h>
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +020059#include <sound/tlv.h>
Linus Torvalds1da177e2005-04-16 15:20:36 -070060
61#include "usbaudio.h"
Daniel Mackf0b5e632010-03-11 21:13:23 +010062#include "mixer.h"
Daniel Macke5779992010-03-04 19:46:13 +010063#include "helper.h"
Daniel Mack7b1eda22010-03-11 21:13:22 +010064#include "mixer_quirks.h"
Oliver Neukum88a85162011-03-11 14:51:12 +010065#include "power.h"
Raimonds Cicans4d1a70d2006-05-05 09:49:53 +020066
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +010067#define MAX_ID_ELEMS 256
68
Linus Torvalds1da177e2005-04-16 15:20:36 -070069struct usb_audio_term {
70 int id;
71 int type;
72 int channels;
73 unsigned int chconfig;
74 int name;
75};
76
77struct usbmix_name_map;
78
Takashi Iwai86e07d32005-11-17 15:08:02 +010079struct mixer_build {
80 struct snd_usb_audio *chip;
Clemens Ladisch84957a82005-04-29 16:23:13 +020081 struct usb_mixer_interface *mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -070082 unsigned char *buffer;
83 unsigned int buflen;
Jaroslav Kysela291186e2010-02-16 11:55:18 +010084 DECLARE_BITMAP(unitbitmap, MAX_ID_ELEMS);
Takashi Iwai86e07d32005-11-17 15:08:02 +010085 struct usb_audio_term oterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -070086 const struct usbmix_name_map *map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +020087 const struct usbmix_selector_map *selector_map;
Linus Torvalds1da177e2005-04-16 15:20:36 -070088};
89
Joseph Teichman1cdfa9f2011-02-08 01:22:36 -050090/*E-mu 0202/0404/0204 eXtension Unit(XU) control*/
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -080091enum {
92 USB_XU_CLOCK_RATE = 0xe301,
93 USB_XU_CLOCK_SOURCE = 0xe302,
94 USB_XU_DIGITAL_IO_STATUS = 0xe303,
95 USB_XU_DEVICE_OPTIONS = 0xe304,
96 USB_XU_DIRECT_MONITORING = 0xe305,
97 USB_XU_METERING = 0xe306
98};
99enum {
100 USB_XU_CLOCK_SOURCE_SELECTOR = 0x02, /* clock source*/
101 USB_XU_CLOCK_RATE_SELECTOR = 0x03, /* clock rate */
102 USB_XU_DIGITAL_FORMAT_SELECTOR = 0x01, /* the spdif format */
103 USB_XU_SOFT_LIMIT_SELECTOR = 0x03 /* soft limiter */
104};
Linus Torvalds1da177e2005-04-16 15:20:36 -0700105
106/*
107 * manual mapping of mixer names
108 * if the mixer topology is too complicated and the parsed names are
109 * ambiguous, add the entries in usbmixer_maps.c.
110 */
Daniel Mackf0b5e632010-03-11 21:13:23 +0100111#include "mixer_maps.c"
Linus Torvalds1da177e2005-04-16 15:20:36 -0700112
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100113static const struct usbmix_name_map *
114find_map(struct mixer_build *state, int unitid, int control)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700115{
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100116 const struct usbmix_name_map *p = state->map;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700117
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100118 if (!p)
119 return NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700120
121 for (p = state->map; p->id; p++) {
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100122 if (p->id == unitid &&
123 (!control || !p->control || control == p->control))
124 return p;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700125 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100126 return NULL;
127}
128
129/* get the mapped name if the unit matches */
130static int
131check_mapped_name(const struct usbmix_name_map *p, char *buf, int buflen)
132{
133 if (!p || !p->name)
134 return 0;
135
136 buflen--;
137 return strlcpy(buf, p->name, buflen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700138}
139
Takashi Iwai5aeee342014-11-18 11:02:14 +0100140/* ignore the error value if ignore_ctl_error flag is set */
141#define filter_error(cval, err) \
Takashi Iwai3360b842014-11-18 11:47:04 +0100142 ((cval)->head.mixer->ignore_ctl_error ? 0 : (err))
Takashi Iwai5aeee342014-11-18 11:02:14 +0100143
Linus Torvalds1da177e2005-04-16 15:20:36 -0700144/* check whether the control should be ignored */
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100145static inline int
146check_ignored_ctl(const struct usbmix_name_map *p)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700147{
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100148 if (!p || p->name || p->dB)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700149 return 0;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100150 return 1;
151}
152
153/* dB mapping */
154static inline void check_mapped_dB(const struct usbmix_name_map *p,
155 struct usb_mixer_elem_info *cval)
156{
157 if (p && p->dB) {
158 cval->dBmin = p->dB->min;
159 cval->dBmax = p->dB->max;
Takashi Iwai38b65192011-08-19 07:55:10 +0200160 cval->initialized = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700161 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700162}
163
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200164/* get the mapped selector source name */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100165static int check_mapped_selector_name(struct mixer_build *state, int unitid,
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200166 int index, char *buf, int buflen)
167{
168 const struct usbmix_selector_map *p;
169
Daniel Mack6bc170e2014-05-24 10:58:16 +0200170 if (!state->selector_map)
Clemens Ladisch8e062ec2005-04-22 15:49:52 +0200171 return 0;
172 for (p = state->selector_map; p->id; p++) {
173 if (p->id == unitid && index < p->count)
174 return strlcpy(buf, p->names[index], buflen);
175 }
176 return 0;
177}
178
Linus Torvalds1da177e2005-04-16 15:20:36 -0700179/*
180 * find an audio control unit with the given unit id
181 */
Daniel Mack6bc170e2014-05-24 10:58:16 +0200182static void *find_audio_control_unit(struct mixer_build *state,
183 unsigned char unit)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700184{
Daniel Mack67e1daa2010-05-31 13:35:43 +0200185 /* we just parse the header */
186 struct uac_feature_unit_descriptor *hdr = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700187
Daniel Mack67e1daa2010-05-31 13:35:43 +0200188 while ((hdr = snd_usb_find_desc(state->buffer, state->buflen, hdr,
189 USB_DT_CS_INTERFACE)) != NULL) {
190 if (hdr->bLength >= 4 &&
191 hdr->bDescriptorSubtype >= UAC_INPUT_TERMINAL &&
192 hdr->bDescriptorSubtype <= UAC2_SAMPLE_RATE_CONVERTER &&
193 hdr->bUnitID == unit)
194 return hdr;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700195 }
Daniel Mack67e1daa2010-05-31 13:35:43 +0200196
Linus Torvalds1da177e2005-04-16 15:20:36 -0700197 return NULL;
198}
199
Linus Torvalds1da177e2005-04-16 15:20:36 -0700200/*
201 * copy a string with the given id
202 */
Daniel Mack6bc170e2014-05-24 10:58:16 +0200203static int snd_usb_copy_string_desc(struct mixer_build *state,
204 int index, char *buf, int maxlen)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700205{
206 int len = usb_string(state->chip->dev, index, buf, maxlen - 1);
207 buf[len] = 0;
208 return len;
209}
210
211/*
212 * convert from the byte/word on usb descriptor to the zero-based integer
213 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100214static int convert_signed_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700215{
216 switch (cval->val_type) {
217 case USB_MIXER_BOOLEAN:
218 return !!val;
219 case USB_MIXER_INV_BOOLEAN:
220 return !val;
221 case USB_MIXER_U8:
222 val &= 0xff;
223 break;
224 case USB_MIXER_S8:
225 val &= 0xff;
226 if (val >= 0x80)
227 val -= 0x100;
228 break;
229 case USB_MIXER_U16:
230 val &= 0xffff;
231 break;
232 case USB_MIXER_S16:
233 val &= 0xffff;
234 if (val >= 0x8000)
235 val -= 0x10000;
236 break;
237 }
238 return val;
239}
240
241/*
242 * convert from the zero-based int to the byte/word for usb descriptor
243 */
Takashi Iwai86e07d32005-11-17 15:08:02 +0100244static int convert_bytes_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700245{
246 switch (cval->val_type) {
247 case USB_MIXER_BOOLEAN:
248 return !!val;
249 case USB_MIXER_INV_BOOLEAN:
250 return !val;
251 case USB_MIXER_S8:
252 case USB_MIXER_U8:
253 return val & 0xff;
254 case USB_MIXER_S16:
255 case USB_MIXER_U16:
256 return val & 0xffff;
257 }
258 return 0; /* not reached */
259}
260
Takashi Iwai86e07d32005-11-17 15:08:02 +0100261static int get_relative_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700262{
Daniel Mack6bc170e2014-05-24 10:58:16 +0200263 if (!cval->res)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700264 cval->res = 1;
265 if (val < cval->min)
266 return 0;
Takashi Iwai14790f12006-03-28 17:58:28 +0200267 else if (val >= cval->max)
268 return (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700269 else
270 return (val - cval->min) / cval->res;
271}
272
Takashi Iwai86e07d32005-11-17 15:08:02 +0100273static int get_abs_value(struct usb_mixer_elem_info *cval, int val)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700274{
275 if (val < 0)
276 return cval->min;
Daniel Mack6bc170e2014-05-24 10:58:16 +0200277 if (!cval->res)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700278 cval->res = 1;
279 val *= cval->res;
280 val += cval->min;
281 if (val > cval->max)
282 return cval->max;
283 return val;
284}
285
Julian Scheelbc18e312015-08-14 16:14:45 +0200286static int uac2_ctl_value_size(int val_type)
287{
288 switch (val_type) {
289 case USB_MIXER_S32:
290 case USB_MIXER_U32:
291 return 4;
292 case USB_MIXER_S16:
293 case USB_MIXER_U16:
294 return 2;
295 default:
296 return 1;
297 }
298 return 0; /* unreachable */
299}
300
Linus Torvalds1da177e2005-04-16 15:20:36 -0700301
302/*
303 * retrieve a mixer value
304 */
305
Daniel Mack6bc170e2014-05-24 10:58:16 +0200306static int get_ctl_value_v1(struct usb_mixer_elem_info *cval, int request,
307 int validx, int *value_ret)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700308{
Takashi Iwai3360b842014-11-18 11:47:04 +0100309 struct snd_usb_audio *chip = cval->head.mixer->chip;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700310 unsigned char buf[2];
311 int val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
312 int timeout = 10;
Takashi Iwai978520b2012-10-12 15:12:55 +0200313 int idx = 0, err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700314
Takashi Iwai47ab1542015-08-25 16:09:00 +0200315 err = snd_usb_lock_shutdown(chip);
Oliver Neukum88a85162011-03-11 14:51:12 +0100316 if (err < 0)
317 return -EIO;
Daniel Mack6bc170e2014-05-24 10:58:16 +0200318
Linus Torvalds1da177e2005-04-16 15:20:36 -0700319 while (timeout-- > 0) {
Takashi Iwai3360b842014-11-18 11:47:04 +0100320 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200321 if (snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700322 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Takashi Iwai978520b2012-10-12 15:12:55 +0200323 validx, idx, buf, val_len) >= val_len) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700324 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(buf, val_len));
Takashi Iwai978520b2012-10-12 15:12:55 +0200325 err = 0;
326 goto out;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700327 }
328 }
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100329 usb_audio_dbg(chip,
330 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
331 request, validx, idx, cval->val_type);
Takashi Iwai978520b2012-10-12 15:12:55 +0200332 err = -EINVAL;
333
334 out:
Takashi Iwai47ab1542015-08-25 16:09:00 +0200335 snd_usb_unlock_shutdown(chip);
Takashi Iwai978520b2012-10-12 15:12:55 +0200336 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700337}
338
Daniel Mack6bc170e2014-05-24 10:58:16 +0200339static int get_ctl_value_v2(struct usb_mixer_elem_info *cval, int request,
340 int validx, int *value_ret)
Daniel Mack23caaf12010-03-11 21:13:25 +0100341{
Takashi Iwai3360b842014-11-18 11:47:04 +0100342 struct snd_usb_audio *chip = cval->head.mixer->chip;
Julian Scheelbc18e312015-08-14 16:14:45 +0200343 unsigned char buf[4 + 3 * sizeof(__u32)]; /* enough space for one range */
Daniel Mack23caaf12010-03-11 21:13:25 +0100344 unsigned char *val;
Takashi Iwai978520b2012-10-12 15:12:55 +0200345 int idx = 0, ret, size;
Daniel Mack23caaf12010-03-11 21:13:25 +0100346 __u8 bRequest;
347
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200348 if (request == UAC_GET_CUR) {
349 bRequest = UAC2_CS_CUR;
Julian Scheelbc18e312015-08-14 16:14:45 +0200350 size = uac2_ctl_value_size(cval->val_type);
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200351 } else {
352 bRequest = UAC2_CS_RANGE;
353 size = sizeof(buf);
354 }
355
356 memset(buf, 0, sizeof(buf));
Daniel Mack23caaf12010-03-11 21:13:25 +0100357
Takashi Iwai47ab1542015-08-25 16:09:00 +0200358 ret = snd_usb_lock_shutdown(chip) ? -EIO : 0;
Oliver Neukum88a85162011-03-11 14:51:12 +0100359 if (ret)
360 goto error;
361
Takashi Iwai47ab1542015-08-25 16:09:00 +0200362 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
363 ret = snd_usb_ctl_msg(chip->dev, usb_rcvctrlpipe(chip->dev, 0), bRequest,
Daniel Mack23caaf12010-03-11 21:13:25 +0100364 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_IN,
Takashi Iwai978520b2012-10-12 15:12:55 +0200365 validx, idx, buf, size);
Takashi Iwai47ab1542015-08-25 16:09:00 +0200366 snd_usb_unlock_shutdown(chip);
Daniel Mack23caaf12010-03-11 21:13:25 +0100367
368 if (ret < 0) {
Oliver Neukum88a85162011-03-11 14:51:12 +0100369error:
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100370 usb_audio_err(chip,
371 "cannot get ctl value: req = %#x, wValue = %#x, wIndex = %#x, type = %d\n",
372 request, validx, idx, cval->val_type);
Daniel Mack23caaf12010-03-11 21:13:25 +0100373 return ret;
374 }
375
Daniel Macke8bdb6b2010-06-11 17:34:22 +0200376 /* FIXME: how should we handle multiple triplets here? */
377
Daniel Mack23caaf12010-03-11 21:13:25 +0100378 switch (request) {
379 case UAC_GET_CUR:
380 val = buf;
381 break;
382 case UAC_GET_MIN:
383 val = buf + sizeof(__u16);
384 break;
385 case UAC_GET_MAX:
386 val = buf + sizeof(__u16) * 2;
387 break;
388 case UAC_GET_RES:
389 val = buf + sizeof(__u16) * 3;
390 break;
391 default:
392 return -EINVAL;
393 }
394
395 *value_ret = convert_signed_value(cval, snd_usb_combine_bytes(val, sizeof(__u16)));
396
397 return 0;
398}
399
Daniel Mack6bc170e2014-05-24 10:58:16 +0200400static int get_ctl_value(struct usb_mixer_elem_info *cval, int request,
401 int validx, int *value_ret)
Daniel Mack23caaf12010-03-11 21:13:25 +0100402{
Eldad Zack9f814102012-11-28 23:55:35 +0100403 validx += cval->idx_off;
404
Takashi Iwai3360b842014-11-18 11:47:04 +0100405 return (cval->head.mixer->protocol == UAC_VERSION_1) ?
Daniel Mack23caaf12010-03-11 21:13:25 +0100406 get_ctl_value_v1(cval, request, validx, value_ret) :
407 get_ctl_value_v2(cval, request, validx, value_ret);
408}
409
Daniel Mack6bc170e2014-05-24 10:58:16 +0200410static int get_cur_ctl_value(struct usb_mixer_elem_info *cval,
411 int validx, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700412{
Daniel Mackde48c7b2010-02-22 23:49:13 +0100413 return get_ctl_value(cval, UAC_GET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700414}
415
416/* channel = 0: master, 1 = first channel */
Takashi Iwai641b4872009-01-15 17:05:24 +0100417static inline int get_cur_mix_raw(struct usb_mixer_elem_info *cval,
418 int channel, int *value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700419{
Daniel Mack6bc170e2014-05-24 10:58:16 +0200420 return get_ctl_value(cval, UAC_GET_CUR,
421 (cval->control << 8) | channel,
422 value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700423}
424
Chris J Argeseef90452014-11-12 12:07:01 -0600425int snd_usb_get_cur_mix_value(struct usb_mixer_elem_info *cval,
Takashi Iwai641b4872009-01-15 17:05:24 +0100426 int channel, int index, int *value)
427{
428 int err;
429
430 if (cval->cached & (1 << channel)) {
431 *value = cval->cache_val[index];
432 return 0;
433 }
434 err = get_cur_mix_raw(cval, channel, value);
435 if (err < 0) {
Takashi Iwai3360b842014-11-18 11:47:04 +0100436 if (!cval->head.mixer->ignore_ctl_error)
437 usb_audio_dbg(cval->head.mixer->chip,
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100438 "cannot get current value for control %d ch %d: err = %d\n",
Daniel Mack6bc170e2014-05-24 10:58:16 +0200439 cval->control, channel, err);
Takashi Iwai641b4872009-01-15 17:05:24 +0100440 return err;
441 }
442 cval->cached |= 1 << channel;
443 cval->cache_val[index] = *value;
444 return 0;
445}
446
Linus Torvalds1da177e2005-04-16 15:20:36 -0700447/*
448 * set a mixer value
449 */
450
Daniel Mack7b1eda22010-03-11 21:13:22 +0100451int snd_usb_mixer_set_ctl_value(struct usb_mixer_elem_info *cval,
452 int request, int validx, int value_set)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700453{
Takashi Iwai3360b842014-11-18 11:47:04 +0100454 struct snd_usb_audio *chip = cval->head.mixer->chip;
Julian Scheelbc18e312015-08-14 16:14:45 +0200455 unsigned char buf[4];
Takashi Iwai978520b2012-10-12 15:12:55 +0200456 int idx = 0, val_len, err, timeout = 10;
Daniel Mack23caaf12010-03-11 21:13:25 +0100457
Eldad Zack9f814102012-11-28 23:55:35 +0100458 validx += cval->idx_off;
459
Takashi Iwai3360b842014-11-18 11:47:04 +0100460 if (cval->head.mixer->protocol == UAC_VERSION_1) {
Daniel Mack23caaf12010-03-11 21:13:25 +0100461 val_len = cval->val_type >= USB_MIXER_S16 ? 2 : 1;
462 } else { /* UAC_VERSION_2 */
Julian Scheelbc18e312015-08-14 16:14:45 +0200463 val_len = uac2_ctl_value_size(cval->val_type);
Daniel Mack23caaf12010-03-11 21:13:25 +0100464
465 /* FIXME */
466 if (request != UAC_SET_CUR) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100467 usb_audio_dbg(chip, "RANGE setting not yet supported\n");
Daniel Mack23caaf12010-03-11 21:13:25 +0100468 return -EINVAL;
469 }
470
471 request = UAC2_CS_CUR;
472 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700473
474 value_set = convert_bytes_value(cval, value_set);
475 buf[0] = value_set & 0xff;
476 buf[1] = (value_set >> 8) & 0xff;
Julian Scheelbc18e312015-08-14 16:14:45 +0200477 buf[2] = (value_set >> 16) & 0xff;
478 buf[3] = (value_set >> 24) & 0xff;
Takashi Iwai47ab1542015-08-25 16:09:00 +0200479
480 err = snd_usb_lock_shutdown(chip);
Oliver Neukum88a85162011-03-11 14:51:12 +0100481 if (err < 0)
482 return -EIO;
Takashi Iwai47ab1542015-08-25 16:09:00 +0200483
Takashi Iwai978520b2012-10-12 15:12:55 +0200484 while (timeout-- > 0) {
Takashi Iwai3360b842014-11-18 11:47:04 +0100485 idx = snd_usb_ctrl_intf(chip) | (cval->head.id << 8);
Daniel Mack3d8d4dc2010-06-16 17:57:31 +0200486 if (snd_usb_ctl_msg(chip->dev,
487 usb_sndctrlpipe(chip->dev, 0), request,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700488 USB_RECIP_INTERFACE | USB_TYPE_CLASS | USB_DIR_OUT,
Takashi Iwai978520b2012-10-12 15:12:55 +0200489 validx, idx, buf, val_len) >= 0) {
490 err = 0;
491 goto out;
Oliver Neukum88a85162011-03-11 14:51:12 +0100492 }
Takashi Iwai978520b2012-10-12 15:12:55 +0200493 }
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100494 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 +0200495 request, validx, idx, cval->val_type, buf[0], buf[1]);
Takashi Iwai978520b2012-10-12 15:12:55 +0200496 err = -EINVAL;
497
498 out:
Takashi Iwai47ab1542015-08-25 16:09:00 +0200499 snd_usb_unlock_shutdown(chip);
Takashi Iwai978520b2012-10-12 15:12:55 +0200500 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700501}
502
Daniel Mack6bc170e2014-05-24 10:58:16 +0200503static int set_cur_ctl_value(struct usb_mixer_elem_info *cval,
504 int validx, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700505{
Daniel Mack7b1eda22010-03-11 21:13:22 +0100506 return snd_usb_mixer_set_ctl_value(cval, UAC_SET_CUR, validx, value);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700507}
508
Chris J Argeseef90452014-11-12 12:07:01 -0600509int snd_usb_set_cur_mix_value(struct usb_mixer_elem_info *cval, int channel,
Takashi Iwai641b4872009-01-15 17:05:24 +0100510 int index, int value)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700511{
Takashi Iwai641b4872009-01-15 17:05:24 +0100512 int err;
Daniel Macka6a33252010-05-31 13:35:37 +0200513 unsigned int read_only = (channel == 0) ?
514 cval->master_readonly :
515 cval->ch_readonly & (1 << (channel - 1));
516
517 if (read_only) {
Takashi Iwai3360b842014-11-18 11:47:04 +0100518 usb_audio_dbg(cval->head.mixer->chip,
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100519 "%s(): channel %d of control %d is read_only\n",
Daniel Macka6a33252010-05-31 13:35:37 +0200520 __func__, channel, cval->control);
521 return 0;
522 }
523
Daniel Mack6bc170e2014-05-24 10:58:16 +0200524 err = snd_usb_mixer_set_ctl_value(cval,
525 UAC_SET_CUR, (cval->control << 8) | channel,
526 value);
Takashi Iwai641b4872009-01-15 17:05:24 +0100527 if (err < 0)
528 return err;
529 cval->cached |= 1 << channel;
530 cval->cache_val[index] = value;
531 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700532}
533
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200534/*
535 * TLV callback for mixer volume controls
536 */
Felix Homann285de9c2012-04-23 20:24:24 +0200537int snd_usb_mixer_vol_tlv(struct snd_kcontrol *kcontrol, int op_flag,
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200538 unsigned int size, unsigned int __user *_tlv)
539{
540 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Takashi Iwaib8e1c732009-06-16 14:04:37 +0200541 DECLARE_TLV_DB_MINMAX(scale, 0, 0);
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200542
543 if (size < sizeof(scale))
544 return -ENOMEM;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100545 scale[2] = cval->dBmin;
546 scale[3] = cval->dBmax;
Takashi Iwai7bc5ba7e2006-07-14 15:18:19 +0200547 if (copy_to_user(_tlv, scale, sizeof(scale)))
548 return -EFAULT;
549 return 0;
550}
Linus Torvalds1da177e2005-04-16 15:20:36 -0700551
552/*
553 * parser routines begin here...
554 */
555
Takashi Iwai86e07d32005-11-17 15:08:02 +0100556static int parse_audio_unit(struct mixer_build *state, int unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700557
558
559/*
560 * check if the input/output channel routing is enabled on the given bitmap.
561 * used for mixer unit parser
562 */
Daniel Mack6bc170e2014-05-24 10:58:16 +0200563static int check_matrix_bitmap(unsigned char *bmap,
564 int ich, int och, int num_outs)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700565{
566 int idx = ich * num_outs + och;
567 return bmap[idx >> 3] & (0x80 >> (idx & 7));
568}
569
Linus Torvalds1da177e2005-04-16 15:20:36 -0700570/*
571 * add an alsa control element
572 * search and increment the index until an empty slot is found.
573 *
574 * if failed, give up and free the control instance.
575 */
576
Takashi Iwai3360b842014-11-18 11:47:04 +0100577int snd_usb_mixer_add_control(struct usb_mixer_elem_list *list,
Daniel Mackef9d5972011-05-25 09:09:00 +0200578 struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700579{
Takashi Iwai3360b842014-11-18 11:47:04 +0100580 struct usb_mixer_interface *mixer = list->mixer;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700581 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +0200582
Daniel Mackef9d5972011-05-25 09:09:00 +0200583 while (snd_ctl_find_id(mixer->chip->card, &kctl->id))
Linus Torvalds1da177e2005-04-16 15:20:36 -0700584 kctl->id.index++;
Daniel Mackef9d5972011-05-25 09:09:00 +0200585 if ((err = snd_ctl_add(mixer->chip->card, kctl)) < 0) {
Daniel Mack6bc170e2014-05-24 10:58:16 +0200586 usb_audio_dbg(mixer->chip, "cannot add control (err = %d)\n",
587 err);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200588 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700589 }
Takashi Iwai3360b842014-11-18 11:47:04 +0100590 list->kctl = kctl;
591 list->next_id_elem = mixer->id_elems[list->id];
592 mixer->id_elems[list->id] = list;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +0200593 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700594}
595
Linus Torvalds1da177e2005-04-16 15:20:36 -0700596/*
597 * get a terminal name string
598 */
599
600static struct iterm_name_combo {
601 int type;
602 char *name;
603} iterm_names[] = {
604 { 0x0300, "Output" },
605 { 0x0301, "Speaker" },
606 { 0x0302, "Headphone" },
607 { 0x0303, "HMD Audio" },
608 { 0x0304, "Desktop Speaker" },
609 { 0x0305, "Room Speaker" },
610 { 0x0306, "Com Speaker" },
611 { 0x0307, "LFE" },
612 { 0x0600, "External In" },
613 { 0x0601, "Analog In" },
614 { 0x0602, "Digital In" },
615 { 0x0603, "Line" },
616 { 0x0604, "Legacy In" },
617 { 0x0605, "IEC958 In" },
618 { 0x0606, "1394 DA Stream" },
619 { 0x0607, "1394 DV Stream" },
620 { 0x0700, "Embedded" },
621 { 0x0701, "Noise Source" },
622 { 0x0702, "Equalization Noise" },
623 { 0x0703, "CD" },
624 { 0x0704, "DAT" },
625 { 0x0705, "DCC" },
626 { 0x0706, "MiniDisk" },
627 { 0x0707, "Analog Tape" },
628 { 0x0708, "Phonograph" },
629 { 0x0709, "VCR Audio" },
630 { 0x070a, "Video Disk Audio" },
631 { 0x070b, "DVD Audio" },
632 { 0x070c, "TV Tuner Audio" },
633 { 0x070d, "Satellite Rec Audio" },
634 { 0x070e, "Cable Tuner Audio" },
635 { 0x070f, "DSS Audio" },
636 { 0x0710, "Radio Receiver" },
637 { 0x0711, "Radio Transmitter" },
638 { 0x0712, "Multi-Track Recorder" },
639 { 0x0713, "Synthesizer" },
640 { 0 },
641};
642
Takashi Iwai86e07d32005-11-17 15:08:02 +0100643static int get_term_name(struct mixer_build *state, struct usb_audio_term *iterm,
Linus Torvalds1da177e2005-04-16 15:20:36 -0700644 unsigned char *name, int maxlen, int term_only)
645{
646 struct iterm_name_combo *names;
647
648 if (iterm->name)
Daniel Mack6bc170e2014-05-24 10:58:16 +0200649 return snd_usb_copy_string_desc(state, iterm->name,
650 name, maxlen);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700651
652 /* virtual type - not a real terminal */
653 if (iterm->type >> 16) {
654 if (term_only)
655 return 0;
656 switch (iterm->type >> 16) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100657 case UAC_SELECTOR_UNIT:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200658 strcpy(name, "Selector");
659 return 8;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200660 case UAC1_PROCESSING_UNIT:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200661 strcpy(name, "Process Unit");
662 return 12;
Daniel Mack69da9bc2010-06-16 17:57:28 +0200663 case UAC1_EXTENSION_UNIT:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200664 strcpy(name, "Ext Unit");
665 return 8;
Daniel Mackde48c7b2010-02-22 23:49:13 +0100666 case UAC_MIXER_UNIT:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200667 strcpy(name, "Mixer");
668 return 5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700669 default:
670 return sprintf(name, "Unit %d", iterm->id);
671 }
672 }
673
674 switch (iterm->type & 0xff00) {
675 case 0x0100:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200676 strcpy(name, "PCM");
677 return 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700678 case 0x0200:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200679 strcpy(name, "Mic");
680 return 3;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700681 case 0x0400:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200682 strcpy(name, "Headset");
683 return 7;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700684 case 0x0500:
Daniel Mack6bc170e2014-05-24 10:58:16 +0200685 strcpy(name, "Phone");
686 return 5;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700687 }
688
Daniel Mack6bc170e2014-05-24 10:58:16 +0200689 for (names = iterm_names; names->type; names++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700690 if (names->type == iterm->type) {
691 strcpy(name, names->name);
692 return strlen(names->name);
693 }
Daniel Mack6bc170e2014-05-24 10:58:16 +0200694 }
695
Linus Torvalds1da177e2005-04-16 15:20:36 -0700696 return 0;
697}
698
Linus Torvalds1da177e2005-04-16 15:20:36 -0700699/*
700 * parse the source unit recursively until it reaches to a terminal
701 * or a branched unit.
702 */
Daniel Mack6bc170e2014-05-24 10:58:16 +0200703static int check_input_term(struct mixer_build *state, int id,
704 struct usb_audio_term *term)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700705{
Daniel Mack09414202010-05-31 13:35:44 +0200706 int err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100707 void *p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700708
709 memset(term, 0, sizeof(*term));
710 while ((p1 = find_audio_control_unit(state, id)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +0100711 unsigned char *hdr = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700712 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100713 switch (hdr[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +0100714 case UAC_INPUT_TERMINAL:
Daniel Mack23caaf12010-03-11 21:13:25 +0100715 if (state->mixer->protocol == UAC_VERSION_1) {
716 struct uac_input_terminal_descriptor *d = p1;
717 term->type = le16_to_cpu(d->wTerminalType);
718 term->channels = d->bNrChannels;
719 term->chconfig = le16_to_cpu(d->wChannelConfig);
720 term->name = d->iTerminal;
721 } else { /* UAC_VERSION_2 */
722 struct uac2_input_terminal_descriptor *d = p1;
Julian Scheel9430e542015-08-19 09:28:09 +0200723
724 /* call recursively to verify that the
725 * referenced clock entity is valid */
726 err = check_input_term(state, d->bCSourceID, term);
727 if (err < 0)
728 return err;
729
730 /* save input term properties after recursion,
731 * to ensure they are not overriden by the
732 * recursion calls */
733 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100734 term->type = le16_to_cpu(d->wTerminalType);
735 term->channels = d->bNrChannels;
736 term->chconfig = le32_to_cpu(d->bmChannelConfig);
737 term->name = d->iTerminal;
738 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700739 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100740 case UAC_FEATURE_UNIT: {
741 /* the header is the same for v1 and v2 */
742 struct uac_feature_unit_descriptor *d = p1;
Daniel Mack5e688882010-05-08 11:24:56 +0200743 id = d->bSourceID;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700744 break; /* continue to parse */
Daniel Mack23caaf12010-03-11 21:13:25 +0100745 }
746 case UAC_MIXER_UNIT: {
747 struct uac_mixer_unit_descriptor *d = p1;
748 term->type = d->bDescriptorSubtype << 16; /* virtual type */
749 term->channels = uac_mixer_unit_bNrChannels(d);
750 term->chconfig = uac_mixer_unit_wChannelConfig(d, state->mixer->protocol);
751 term->name = uac_mixer_unit_iMixer(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700752 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100753 }
Daniel Mack09414202010-05-31 13:35:44 +0200754 case UAC_SELECTOR_UNIT:
755 case UAC2_CLOCK_SELECTOR: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100756 struct uac_selector_unit_descriptor *d = p1;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700757 /* call recursively to retrieve the channel info */
Daniel Mack4d7b86c2013-03-19 21:09:24 +0100758 err = check_input_term(state, d->baSourceID[0], term);
759 if (err < 0)
760 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +0100761 term->type = d->bDescriptorSubtype << 16; /* virtual type */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700762 term->id = id;
Daniel Mack23caaf12010-03-11 21:13:25 +0100763 term->name = uac_selector_unit_iSelector(d);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700764 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100765 }
Daniel Mack69da9bc2010-06-16 17:57:28 +0200766 case UAC1_PROCESSING_UNIT:
Eldad Zack5dae5fd2012-11-28 23:55:36 +0100767 case UAC1_EXTENSION_UNIT:
768 /* UAC2_PROCESSING_UNIT_V2 */
Torstein Hegge61ac5132013-03-19 17:12:14 +0100769 /* UAC2_EFFECT_UNIT */
770 case UAC2_EXTENSION_UNIT_V2: {
Daniel Mack23caaf12010-03-11 21:13:25 +0100771 struct uac_processing_unit_descriptor *d = p1;
Eldad Zack5dae5fd2012-11-28 23:55:36 +0100772
773 if (state->mixer->protocol == UAC_VERSION_2 &&
774 hdr[2] == UAC2_EFFECT_UNIT) {
775 /* UAC2/UAC1 unit IDs overlap here in an
776 * uncompatible way. Ignore this unit for now.
777 */
778 return 0;
779 }
780
Daniel Mack23caaf12010-03-11 21:13:25 +0100781 if (d->bNrInPins) {
782 id = d->baSourceID[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -0700783 break; /* continue to parse */
784 }
Daniel Mack23caaf12010-03-11 21:13:25 +0100785 term->type = d->bDescriptorSubtype << 16; /* virtual type */
786 term->channels = uac_processing_unit_bNrChannels(d);
787 term->chconfig = uac_processing_unit_wChannelConfig(d, state->mixer->protocol);
788 term->name = uac_processing_unit_iProcessing(d, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700789 return 0;
Daniel Mack23caaf12010-03-11 21:13:25 +0100790 }
Daniel Mack09414202010-05-31 13:35:44 +0200791 case UAC2_CLOCK_SOURCE: {
792 struct uac_clock_source_descriptor *d = p1;
793 term->type = d->bDescriptorSubtype << 16; /* virtual type */
794 term->id = id;
795 term->name = d->iClockSource;
796 return 0;
797 }
Linus Torvalds1da177e2005-04-16 15:20:36 -0700798 default:
799 return -ENODEV;
800 }
801 }
802 return -ENODEV;
803}
804
Linus Torvalds1da177e2005-04-16 15:20:36 -0700805/*
806 * Feature Unit
807 */
808
809/* feature unit control information */
810struct usb_feature_control_info {
811 const char *name;
Julian Scheelbc18e312015-08-14 16:14:45 +0200812 int type; /* data type for uac1 */
813 int type_uac2; /* data type for uac2 if different from uac1, else -1 */
Linus Torvalds1da177e2005-04-16 15:20:36 -0700814};
815
816static struct usb_feature_control_info audio_feature_info[] = {
Julian Scheelbc18e312015-08-14 16:14:45 +0200817 { "Mute", USB_MIXER_INV_BOOLEAN, -1 },
818 { "Volume", USB_MIXER_S16, -1 },
819 { "Tone Control - Bass", USB_MIXER_S8, -1 },
820 { "Tone Control - Mid", USB_MIXER_S8, -1 },
821 { "Tone Control - Treble", USB_MIXER_S8, -1 },
822 { "Graphic Equalizer", USB_MIXER_S8, -1 }, /* FIXME: not implemeted yet */
823 { "Auto Gain Control", USB_MIXER_BOOLEAN, -1 },
824 { "Delay Control", USB_MIXER_U16, USB_MIXER_U32 },
825 { "Bass Boost", USB_MIXER_BOOLEAN, -1 },
826 { "Loudness", USB_MIXER_BOOLEAN, -1 },
Daniel Mack2e0281d2010-05-31 13:35:42 +0200827 /* UAC2 specific */
Julian Scheelbc18e312015-08-14 16:14:45 +0200828 { "Input Gain Control", USB_MIXER_S16, -1 },
829 { "Input Gain Pad Control", USB_MIXER_S16, -1 },
830 { "Phase Inverter Control", USB_MIXER_BOOLEAN, -1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -0700831};
832
Linus Torvalds1da177e2005-04-16 15:20:36 -0700833/* private_free callback */
Chris J Argeseef90452014-11-12 12:07:01 -0600834void snd_usb_mixer_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700835{
Jesper Juhl4d572772005-05-30 17:30:32 +0200836 kfree(kctl->private_data);
837 kctl->private_data = NULL;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700838}
839
Linus Torvalds1da177e2005-04-16 15:20:36 -0700840/*
841 * interface to ALSA control for feature/mixer units
842 */
843
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100844/* volume control quirks */
845static void volume_control_quirks(struct usb_mixer_elem_info *cval,
846 struct snd_kcontrol *kctl)
847{
Takashi Iwai3360b842014-11-18 11:47:04 +0100848 struct snd_usb_audio *chip = cval->head.mixer->chip;
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100849 switch (chip->usb_id) {
Eldad Zackd50ed622012-11-28 23:55:39 +0100850 case USB_ID(0x0763, 0x2030): /* M-Audio Fast Track C400 */
Matt Gruskine9a25e02013-02-09 12:56:35 -0500851 case USB_ID(0x0763, 0x2031): /* M-Audio Fast Track C600 */
Eldad Zackd50ed622012-11-28 23:55:39 +0100852 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
853 cval->min = 0x0000;
854 cval->max = 0xffff;
855 cval->res = 0x00e6;
856 break;
857 }
858 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
859 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
860 cval->min = 0x00;
861 cval->max = 0xff;
862 break;
863 }
864 if (strstr(kctl->id.name, "Effect Return") != NULL) {
865 cval->min = 0xb706;
866 cval->max = 0xff7b;
867 cval->res = 0x0073;
868 break;
869 }
870 if ((strstr(kctl->id.name, "Playback Volume") != NULL) ||
871 (strstr(kctl->id.name, "Effect Send") != NULL)) {
872 cval->min = 0xb5fb; /* -73 dB = 0xb6ff */
873 cval->max = 0xfcfe;
874 cval->res = 0x0073;
875 }
876 break;
877
Felix Homannd34bf142012-04-23 20:24:27 +0200878 case USB_ID(0x0763, 0x2081): /* M-Audio Fast Track Ultra 8R */
879 case USB_ID(0x0763, 0x2080): /* M-Audio Fast Track Ultra */
880 if (strcmp(kctl->id.name, "Effect Duration") == 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100881 usb_audio_info(chip,
882 "set quirk for FTU Effect Duration\n");
Felix Homannd34bf142012-04-23 20:24:27 +0200883 cval->min = 0x0000;
884 cval->max = 0x7f00;
885 cval->res = 0x0100;
886 break;
887 }
888 if (strcmp(kctl->id.name, "Effect Volume") == 0 ||
889 strcmp(kctl->id.name, "Effect Feedback Volume") == 0) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100890 usb_audio_info(chip,
891 "set quirks for FTU Effect Feedback/Volume\n");
Felix Homannd34bf142012-04-23 20:24:27 +0200892 cval->min = 0x00;
893 cval->max = 0x7f;
894 break;
895 }
896 break;
897
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100898 case USB_ID(0x0471, 0x0101):
899 case USB_ID(0x0471, 0x0104):
900 case USB_ID(0x0471, 0x0105):
901 case USB_ID(0x0672, 0x1041):
902 /* quirk for UDA1321/N101.
903 * note that detection between firmware 2.1.1.7 (N101)
904 * and later 2.1.1.21 is not very clear from datasheets.
905 * I hope that the min value is -15360 for newer firmware --jk
906 */
907 if (!strcmp(kctl->id.name, "PCM Playback Volume") &&
908 cval->min == -15616) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100909 usb_audio_info(chip,
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100910 "set volume quirk for UDA1321/N101 chip\n");
911 cval->max = -256;
912 }
913 break;
914
915 case USB_ID(0x046d, 0x09a4):
916 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100917 usb_audio_info(chip,
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100918 "set volume quirk for QuickCam E3500\n");
919 cval->min = 6080;
920 cval->max = 8768;
921 cval->res = 192;
922 }
923 break;
924
Takashi Iwaie805ca82014-03-05 12:34:39 +0100925 case USB_ID(0x046d, 0x0807): /* Logitech Webcam C500 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100926 case USB_ID(0x046d, 0x0808):
927 case USB_ID(0x046d, 0x0809):
Jason Lee Cragg64559312015-01-17 12:28:29 -0500928 case USB_ID(0x046d, 0x0819): /* Logitech Webcam C210 */
Takashi Iwai36691e12013-06-17 10:25:02 +0200929 case USB_ID(0x046d, 0x081b): /* HD Webcam c310 */
Alexey Fisher55c00082011-11-09 11:39:24 +0100930 case USB_ID(0x046d, 0x081d): /* HD Webcam c510 */
Takashi Iwai11e70642013-06-05 08:35:26 +0200931 case USB_ID(0x046d, 0x0825): /* HD Webcam c270 */
Maksim A. Boyko140d37d2013-08-10 12:20:02 +0400932 case USB_ID(0x046d, 0x0826): /* HD Webcam c525 */
Wolfram Sang1ef9f052015-05-29 19:50:56 +0900933 case USB_ID(0x046d, 0x08ca): /* Logitech Quickcam Fusion */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100934 case USB_ID(0x046d, 0x0991):
Con Kolivas205d3de2016-12-09 15:15:57 +1100935 case USB_ID(0x046d, 0x09a2): /* QuickCam Communicate Deluxe/S7500 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100936 /* Most audio usb devices lie about volume resolution.
937 * Most Logitech webcams have res = 384.
Con Kolivas205d3de2016-12-09 15:15:57 +1100938 * Probably there is some logitech magic behind this number --fishor
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100939 */
940 if (!strcmp(kctl->id.name, "Mic Capture Volume")) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100941 usb_audio_info(chip,
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100942 "set resolution quirk: cval->res = 384\n");
943 cval->res = 384;
944 }
945 break;
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100946 }
947}
948
Linus Torvalds1da177e2005-04-16 15:20:36 -0700949/*
950 * retrieve the minimum and maximum values for the specified control
951 */
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +0100952static int get_min_max_with_quirks(struct usb_mixer_elem_info *cval,
953 int default_min, struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700954{
955 /* for failsafe */
956 cval->min = default_min;
957 cval->max = cval->min + 1;
958 cval->res = 1;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +0100959 cval->dBmin = cval->dBmax = 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -0700960
961 if (cval->val_type == USB_MIXER_BOOLEAN ||
962 cval->val_type == USB_MIXER_INV_BOOLEAN) {
963 cval->initialized = 1;
964 } else {
965 int minchn = 0;
966 if (cval->cmask) {
967 int i;
968 for (i = 0; i < MAX_CHANNELS; i++)
969 if (cval->cmask & (1 << i)) {
970 minchn = i + 1;
971 break;
972 }
973 }
Daniel Mackde48c7b2010-02-22 23:49:13 +0100974 if (get_ctl_value(cval, UAC_GET_MAX, (cval->control << 8) | minchn, &cval->max) < 0 ||
975 get_ctl_value(cval, UAC_GET_MIN, (cval->control << 8) | minchn, &cval->min) < 0) {
Takashi Iwai3360b842014-11-18 11:47:04 +0100976 usb_audio_err(cval->head.mixer->chip,
Takashi Iwai0ba41d92014-02-26 13:02:17 +0100977 "%d:%d: cannot get min/max values for control %d (id %d)\n",
Takashi Iwai3360b842014-11-18 11:47:04 +0100978 cval->head.id, snd_usb_ctrl_intf(cval->head.mixer->chip),
979 cval->control, cval->head.id);
Linus Torvalds1da177e2005-04-16 15:20:36 -0700980 return -EINVAL;
981 }
Daniel Mack6bc170e2014-05-24 10:58:16 +0200982 if (get_ctl_value(cval, UAC_GET_RES,
983 (cval->control << 8) | minchn,
984 &cval->res) < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -0700985 cval->res = 1;
986 } else {
987 int last_valid_res = cval->res;
988
989 while (cval->res > 1) {
Daniel Mack7b1eda22010-03-11 21:13:22 +0100990 if (snd_usb_mixer_set_ctl_value(cval, UAC_SET_RES,
Daniel Mack6bc170e2014-05-24 10:58:16 +0200991 (cval->control << 8) | minchn,
992 cval->res / 2) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700993 break;
994 cval->res /= 2;
995 }
Daniel Mack6bc170e2014-05-24 10:58:16 +0200996 if (get_ctl_value(cval, UAC_GET_RES,
997 (cval->control << 8) | minchn, &cval->res) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -0700998 cval->res = last_valid_res;
999 }
1000 if (cval->res == 0)
1001 cval->res = 1;
Takashi Iwai14790f12006-03-28 17:58:28 +02001002
1003 /* Additional checks for the proper resolution
1004 *
1005 * Some devices report smaller resolutions than actually
1006 * reacting. They don't return errors but simply clip
1007 * to the lower aligned value.
1008 */
1009 if (cval->min + cval->res < cval->max) {
1010 int last_valid_res = cval->res;
1011 int saved, test, check;
Takashi Iwai641b4872009-01-15 17:05:24 +01001012 get_cur_mix_raw(cval, minchn, &saved);
Takashi Iwai14790f12006-03-28 17:58:28 +02001013 for (;;) {
1014 test = saved;
1015 if (test < cval->max)
1016 test += cval->res;
1017 else
1018 test -= cval->res;
1019 if (test < cval->min || test > cval->max ||
Chris J Argeseef90452014-11-12 12:07:01 -06001020 snd_usb_set_cur_mix_value(cval, minchn, 0, test) ||
Takashi Iwai641b4872009-01-15 17:05:24 +01001021 get_cur_mix_raw(cval, minchn, &check)) {
Takashi Iwai14790f12006-03-28 17:58:28 +02001022 cval->res = last_valid_res;
1023 break;
1024 }
1025 if (test == check)
1026 break;
1027 cval->res *= 2;
1028 }
Chris J Argeseef90452014-11-12 12:07:01 -06001029 snd_usb_set_cur_mix_value(cval, minchn, 0, saved);
Takashi Iwai14790f12006-03-28 17:58:28 +02001030 }
1031
Linus Torvalds1da177e2005-04-16 15:20:36 -07001032 cval->initialized = 1;
1033 }
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001034
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +01001035 if (kctl)
1036 volume_control_quirks(cval, kctl);
1037
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001038 /* USB descriptions contain the dB scale in 1/256 dB unit
1039 * while ALSA TLV contains in 1/100 dB unit
1040 */
1041 cval->dBmin = (convert_signed_value(cval, cval->min) * 100) / 256;
1042 cval->dBmax = (convert_signed_value(cval, cval->max) * 100) / 256;
1043 if (cval->dBmin > cval->dBmax) {
1044 /* something is wrong; assume it's either from/to 0dB */
1045 if (cval->dBmin < 0)
1046 cval->dBmax = 0;
1047 else if (cval->dBmin > 0)
1048 cval->dBmin = 0;
1049 if (cval->dBmin > cval->dBmax) {
1050 /* totally crap, return an error */
1051 return -EINVAL;
1052 }
1053 }
1054
Linus Torvalds1da177e2005-04-16 15:20:36 -07001055 return 0;
1056}
1057
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +01001058#define get_min_max(cval, def) get_min_max_with_quirks(cval, def, NULL)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001059
1060/* get a feature/mixer unit info */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001061static int mixer_ctl_feature_info(struct snd_kcontrol *kcontrol,
1062 struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001063{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001064 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001065
1066 if (cval->val_type == USB_MIXER_BOOLEAN ||
1067 cval->val_type == USB_MIXER_INV_BOOLEAN)
1068 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
1069 else
1070 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
1071 uinfo->count = cval->channels;
1072 if (cval->val_type == USB_MIXER_BOOLEAN ||
1073 cval->val_type == USB_MIXER_INV_BOOLEAN) {
1074 uinfo->value.integer.min = 0;
1075 uinfo->value.integer.max = 1;
1076 } else {
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +02001077 if (!cval->initialized) {
Takashi Iwaidcaaf9f2011-11-08 17:50:27 +01001078 get_min_max_with_quirks(cval, 0, kcontrol);
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +02001079 if (cval->initialized && cval->dBmin >= cval->dBmax) {
1080 kcontrol->vd[0].access &=
1081 ~(SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1082 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK);
Takashi Iwai3360b842014-11-18 11:47:04 +01001083 snd_ctl_notify(cval->head.mixer->chip->card,
Takashi Iwai9fcd0ab2011-08-19 08:30:53 +02001084 SNDRV_CTL_EVENT_MASK_INFO,
1085 &kcontrol->id);
1086 }
1087 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001088 uinfo->value.integer.min = 0;
Takashi Iwai14790f12006-03-28 17:58:28 +02001089 uinfo->value.integer.max =
1090 (cval->max - cval->min + cval->res - 1) / cval->res;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001091 }
1092 return 0;
1093}
1094
1095/* get the current value from feature/mixer unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001096static int mixer_ctl_feature_get(struct snd_kcontrol *kcontrol,
1097 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001098{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001099 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001100 int c, cnt, val, err;
1101
Takashi Iwai641b4872009-01-15 17:05:24 +01001102 ucontrol->value.integer.value[0] = cval->min;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001103 if (cval->cmask) {
1104 cnt = 0;
1105 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001106 if (!(cval->cmask & (1 << c)))
1107 continue;
Chris J Argeseef90452014-11-12 12:07:01 -06001108 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &val);
Takashi Iwai641b4872009-01-15 17:05:24 +01001109 if (err < 0)
Takashi Iwai5aeee342014-11-18 11:02:14 +01001110 return filter_error(cval, err);
Takashi Iwai641b4872009-01-15 17:05:24 +01001111 val = get_relative_value(cval, val);
1112 ucontrol->value.integer.value[cnt] = val;
1113 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001114 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001115 return 0;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001116 } else {
1117 /* master channel */
Chris J Argeseef90452014-11-12 12:07:01 -06001118 err = snd_usb_get_cur_mix_value(cval, 0, 0, &val);
Takashi Iwai641b4872009-01-15 17:05:24 +01001119 if (err < 0)
Takashi Iwai5aeee342014-11-18 11:02:14 +01001120 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001121 val = get_relative_value(cval, val);
1122 ucontrol->value.integer.value[0] = val;
1123 }
1124 return 0;
1125}
1126
1127/* put the current value to feature/mixer unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001128static int mixer_ctl_feature_put(struct snd_kcontrol *kcontrol,
1129 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001130{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001131 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001132 int c, cnt, val, oval, err;
1133 int changed = 0;
1134
1135 if (cval->cmask) {
1136 cnt = 0;
1137 for (c = 0; c < MAX_CHANNELS; c++) {
Takashi Iwai641b4872009-01-15 17:05:24 +01001138 if (!(cval->cmask & (1 << c)))
1139 continue;
Chris J Argeseef90452014-11-12 12:07:01 -06001140 err = snd_usb_get_cur_mix_value(cval, c + 1, cnt, &oval);
Takashi Iwai641b4872009-01-15 17:05:24 +01001141 if (err < 0)
Takashi Iwai5aeee342014-11-18 11:02:14 +01001142 return filter_error(cval, err);
Takashi Iwai641b4872009-01-15 17:05:24 +01001143 val = ucontrol->value.integer.value[cnt];
1144 val = get_abs_value(cval, val);
1145 if (oval != val) {
Chris J Argeseef90452014-11-12 12:07:01 -06001146 snd_usb_set_cur_mix_value(cval, c + 1, cnt, val);
Takashi Iwai641b4872009-01-15 17:05:24 +01001147 changed = 1;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001148 }
Takashi Iwai641b4872009-01-15 17:05:24 +01001149 cnt++;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001150 }
1151 } else {
1152 /* master channel */
Chris J Argeseef90452014-11-12 12:07:01 -06001153 err = snd_usb_get_cur_mix_value(cval, 0, 0, &oval);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001154 if (err < 0)
Takashi Iwai5aeee342014-11-18 11:02:14 +01001155 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001156 val = ucontrol->value.integer.value[0];
1157 val = get_abs_value(cval, val);
1158 if (val != oval) {
Chris J Argeseef90452014-11-12 12:07:01 -06001159 snd_usb_set_cur_mix_value(cval, 0, 0, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001160 changed = 1;
1161 }
1162 }
1163 return changed;
1164}
1165
Takashi Iwai86e07d32005-11-17 15:08:02 +01001166static struct snd_kcontrol_new usb_feature_unit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001167 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1168 .name = "", /* will be filled later manually */
1169 .info = mixer_ctl_feature_info,
1170 .get = mixer_ctl_feature_get,
1171 .put = mixer_ctl_feature_put,
1172};
1173
Daniel Mack23caaf12010-03-11 21:13:25 +01001174/* the read-only variant */
1175static struct snd_kcontrol_new usb_feature_unit_ctl_ro = {
1176 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1177 .name = "", /* will be filled later manually */
1178 .info = mixer_ctl_feature_info,
1179 .get = mixer_ctl_feature_get,
1180 .put = NULL,
1181};
1182
Daniel Mack6bc170e2014-05-24 10:58:16 +02001183/*
1184 * This symbol is exported in order to allow the mixer quirks to
1185 * hook up to the standard feature unit control mechanism
1186 */
Daniel Mack9e386582011-05-25 09:09:01 +02001187struct snd_kcontrol_new *snd_usb_feature_unit_ctl = &usb_feature_unit_ctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001188
1189/*
1190 * build a feature control
1191 */
Takashi Iwai08d1e632009-10-02 14:06:08 +02001192static size_t append_ctl_name(struct snd_kcontrol *kctl, const char *str)
1193{
1194 return strlcat(kctl->id.name, str, sizeof(kctl->id.name));
1195}
1196
Daniel Mack6bc170e2014-05-24 10:58:16 +02001197/*
1198 * A lot of headsets/headphones have a "Speaker" mixer. Make sure we
1199 * rename it to "Headphone". We determine if something is a headphone
1200 * similar to how udev determines form factor.
1201 */
David Henningsson9b4ef972012-11-23 13:48:55 +01001202static void check_no_speaker_on_headset(struct snd_kcontrol *kctl,
1203 struct snd_card *card)
1204{
1205 const char *names_to_check[] = {
1206 "Headset", "headset", "Headphone", "headphone", NULL};
1207 const char **s;
Peter Senna Tschudine0f17c72013-09-22 20:44:12 +02001208 bool found = false;
David Henningsson9b4ef972012-11-23 13:48:55 +01001209
1210 if (strcmp("Speaker", kctl->id.name))
1211 return;
1212
1213 for (s = names_to_check; *s; s++)
1214 if (strstr(card->shortname, *s)) {
Peter Senna Tschudine0f17c72013-09-22 20:44:12 +02001215 found = true;
David Henningsson9b4ef972012-11-23 13:48:55 +01001216 break;
1217 }
1218
1219 if (!found)
1220 return;
1221
1222 strlcpy(kctl->id.name, "Headphone", sizeof(kctl->id.name));
1223}
1224
Daniel Mack99fc8642010-03-11 21:13:24 +01001225static void build_feature_ctl(struct mixer_build *state, void *raw_desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001226 unsigned int ctl_mask, int control,
Daniel Mack23caaf12010-03-11 21:13:25 +01001227 struct usb_audio_term *iterm, int unitid,
Daniel Macka6a33252010-05-31 13:35:37 +02001228 int readonly_mask)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001229{
Daniel Mack99fc8642010-03-11 21:13:24 +01001230 struct uac_feature_unit_descriptor *desc = raw_desc;
Julian Scheelbc18e312015-08-14 16:14:45 +02001231 struct usb_feature_control_info *ctl_info;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001232 unsigned int len = 0;
1233 int mapped_name = 0;
Daniel Mack99fc8642010-03-11 21:13:24 +01001234 int nameid = uac_feature_unit_iFeature(desc);
Takashi Iwai86e07d32005-11-17 15:08:02 +01001235 struct snd_kcontrol *kctl;
1236 struct usb_mixer_elem_info *cval;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001237 const struct usbmix_name_map *map;
Alexey Fisher80aceff2011-03-10 14:53:38 +01001238 unsigned int range;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001239
1240 control++; /* change from zero-based to 1-based value */
1241
Daniel Mack65f25da2010-05-31 13:35:41 +02001242 if (control == UAC_FU_GRAPHIC_EQUALIZER) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001243 /* FIXME: not supported yet */
1244 return;
1245 }
1246
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001247 map = find_map(state, unitid, control);
1248 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001249 return;
1250
Takashi Iwai561b2202005-09-09 14:22:34 +02001251 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Daniel Macka860d952014-05-24 10:58:17 +02001252 if (!cval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001253 return;
Takashi Iwai3360b842014-11-18 11:47:04 +01001254 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001255 cval->control = control;
1256 cval->cmask = ctl_mask;
Julian Scheelbc18e312015-08-14 16:14:45 +02001257 ctl_info = &audio_feature_info[control-1];
1258 if (state->mixer->protocol == UAC_VERSION_1)
1259 cval->val_type = ctl_info->type;
1260 else /* UAC_VERSION_2 */
1261 cval->val_type = ctl_info->type_uac2 >= 0 ?
1262 ctl_info->type_uac2 : ctl_info->type;
1263
Daniel Macka6a33252010-05-31 13:35:37 +02001264 if (ctl_mask == 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001265 cval->channels = 1; /* master channel */
Daniel Macka6a33252010-05-31 13:35:37 +02001266 cval->master_readonly = readonly_mask;
1267 } else {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001268 int i, c = 0;
1269 for (i = 0; i < 16; i++)
1270 if (ctl_mask & (1 << i))
1271 c++;
1272 cval->channels = c;
Daniel Macka6a33252010-05-31 13:35:37 +02001273 cval->ch_readonly = readonly_mask;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001274 }
1275
Daniel Mack6bc170e2014-05-24 10:58:16 +02001276 /*
1277 * If all channels in the mask are marked read-only, make the control
Chris J Argeseef90452014-11-12 12:07:01 -06001278 * read-only. snd_usb_set_cur_mix_value() will check the mask again and won't
Daniel Mack6bc170e2014-05-24 10:58:16 +02001279 * issue write commands to read-only channels.
1280 */
Daniel Macka6a33252010-05-31 13:35:37 +02001281 if (cval->channels == readonly_mask)
Daniel Mack23caaf12010-03-11 21:13:25 +01001282 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1283 else
1284 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1285
Daniel Mack6bc170e2014-05-24 10:58:16 +02001286 if (!kctl) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001287 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001288 kfree(cval);
1289 return;
1290 }
Chris J Argeseef90452014-11-12 12:07:01 -06001291 kctl->private_free = snd_usb_mixer_elem_free;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001292
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001293 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001294 mapped_name = len != 0;
Daniel Mack6bc170e2014-05-24 10:58:16 +02001295 if (!len && nameid)
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001296 len = snd_usb_copy_string_desc(state, nameid,
1297 kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07001298
1299 switch (control) {
Daniel Mack65f25da2010-05-31 13:35:41 +02001300 case UAC_FU_MUTE:
1301 case UAC_FU_VOLUME:
Daniel Mack6bc170e2014-05-24 10:58:16 +02001302 /*
1303 * determine the control name. the rule is:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001304 * - if a name id is given in descriptor, use it.
1305 * - if the connected input can be determined, then use the name
1306 * of terminal type.
1307 * - if the connected output can be determined, use it.
1308 * - otherwise, anonymous name.
1309 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001310 if (!len) {
1311 len = get_term_name(state, iterm, kctl->id.name,
1312 sizeof(kctl->id.name), 1);
1313 if (!len)
1314 len = get_term_name(state, &state->oterm,
1315 kctl->id.name,
1316 sizeof(kctl->id.name), 1);
1317 if (!len)
Daniel Mack49fd46d2014-10-19 09:11:25 +02001318 snprintf(kctl->id.name, sizeof(kctl->id.name),
1319 "Feature %d", unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001320 }
David Henningsson9b4ef972012-11-23 13:48:55 +01001321
1322 if (!mapped_name)
1323 check_no_speaker_on_headset(kctl, state->mixer->chip->card);
1324
Daniel Mack6bc170e2014-05-24 10:58:16 +02001325 /*
1326 * determine the stream direction:
Linus Torvalds1da177e2005-04-16 15:20:36 -07001327 * if the connected output is USB stream, then it's likely a
1328 * capture stream. otherwise it should be playback (hopefully :)
1329 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001330 if (!mapped_name && !(state->oterm.type >> 16)) {
1331 if ((state->oterm.type & 0xff00) == 0x0100)
Daniel Mack49fd46d2014-10-19 09:11:25 +02001332 append_ctl_name(kctl, " Capture");
Daniel Mack6bc170e2014-05-24 10:58:16 +02001333 else
Daniel Mack49fd46d2014-10-19 09:11:25 +02001334 append_ctl_name(kctl, " Playback");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001335 }
Daniel Mack65f25da2010-05-31 13:35:41 +02001336 append_ctl_name(kctl, control == UAC_FU_MUTE ?
Takashi Iwai08d1e632009-10-02 14:06:08 +02001337 " Switch" : " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001338 break;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001339 default:
Daniel Mack6bc170e2014-05-24 10:58:16 +02001340 if (!len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001341 strlcpy(kctl->id.name, audio_feature_info[control-1].name,
1342 sizeof(kctl->id.name));
1343 break;
1344 }
1345
Takashi Iwaie1825342012-05-14 17:11:06 +02001346 /* get min/max values */
1347 get_min_max_with_quirks(cval, 0, kctl);
1348
1349 if (control == UAC_FU_VOLUME) {
1350 check_mapped_dB(map, cval);
1351 if (cval->dBmin < cval->dBmax || !cval->initialized) {
1352 kctl->tlv.c = snd_usb_mixer_vol_tlv;
1353 kctl->vd[0].access |=
1354 SNDRV_CTL_ELEM_ACCESS_TLV_READ |
1355 SNDRV_CTL_ELEM_ACCESS_TLV_CALLBACK;
1356 }
1357 }
1358
Anssi Hannula42e31212015-12-13 20:49:58 +02001359 snd_usb_mixer_fu_apply_quirk(state->mixer, cval, unitid, kctl);
1360
Alexey Fisher80aceff2011-03-10 14:53:38 +01001361 range = (cval->max - cval->min) / cval->res;
Daniel Mack6bc170e2014-05-24 10:58:16 +02001362 /*
1363 * Are there devices with volume range more than 255? I use a bit more
Alexey Fisher80aceff2011-03-10 14:53:38 +01001364 * to be sure. 384 is a resolution magic number found on Logitech
1365 * devices. It will definitively catch all buggy Logitech devices.
1366 */
1367 if (range > 384) {
Daniel Mack6bc170e2014-05-24 10:58:16 +02001368 usb_audio_warn(state->chip,
Michał Mirosław82c1cf02014-08-03 15:09:57 +02001369 "Warning! Unlikely big volume range (=%u), cval->res is probably wrong.",
Daniel Mack6bc170e2014-05-24 10:58:16 +02001370 range);
Michał Mirosław82c1cf02014-08-03 15:09:57 +02001371 usb_audio_warn(state->chip,
1372 "[%d] FU [%s] ch = %d, val = %d/%d/%d",
Takashi Iwai3360b842014-11-18 11:47:04 +01001373 cval->head.id, kctl->id.name, cval->channels,
Daniel Mack6bc170e2014-05-24 10:58:16 +02001374 cval->min, cval->max, cval->res);
Alexey Fisher80aceff2011-03-10 14:53:38 +01001375 }
1376
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001377 usb_audio_dbg(state->chip, "[%d] FU [%s] ch = %d, val = %d/%d/%d\n",
Takashi Iwai3360b842014-11-18 11:47:04 +01001378 cval->head.id, kctl->id.name, cval->channels,
Daniel Mack6bc170e2014-05-24 10:58:16 +02001379 cval->min, cval->max, cval->res);
Takashi Iwai3360b842014-11-18 11:47:04 +01001380 snd_usb_mixer_add_control(&cval->head, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001381}
1382
Daniel Mackcddaafb2016-04-09 11:21:46 +02001383static int parse_clock_source_unit(struct mixer_build *state, int unitid,
1384 void *_ftr)
1385{
1386 struct uac_clock_source_descriptor *hdr = _ftr;
1387 struct usb_mixer_elem_info *cval;
1388 struct snd_kcontrol *kctl;
1389 char name[SNDRV_CTL_ELEM_ID_NAME_MAXLEN];
1390 int ret;
1391
1392 if (state->mixer->protocol != UAC_VERSION_2)
1393 return -EINVAL;
1394
1395 if (hdr->bLength != sizeof(*hdr)) {
1396 usb_audio_dbg(state->chip,
1397 "Bogus clock source descriptor length of %d, ignoring.\n",
1398 hdr->bLength);
1399 return 0;
1400 }
1401
1402 /*
1403 * The only property of this unit we are interested in is the
1404 * clock source validity. If that isn't readable, just bail out.
1405 */
1406 if (!uac2_control_is_readable(hdr->bmControls,
1407 ilog2(UAC2_CS_CONTROL_CLOCK_VALID)))
1408 return 0;
1409
1410 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
1411 if (!cval)
1412 return -ENOMEM;
1413
1414 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, hdr->bClockID);
1415
1416 cval->min = 0;
1417 cval->max = 1;
1418 cval->channels = 1;
1419 cval->val_type = USB_MIXER_BOOLEAN;
1420 cval->control = UAC2_CS_CONTROL_CLOCK_VALID;
1421
1422 if (uac2_control_is_writeable(hdr->bmControls,
1423 ilog2(UAC2_CS_CONTROL_CLOCK_VALID)))
1424 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
1425 else {
1426 cval->master_readonly = 1;
1427 kctl = snd_ctl_new1(&usb_feature_unit_ctl_ro, cval);
1428 }
1429
1430 if (!kctl) {
1431 kfree(cval);
1432 return -ENOMEM;
1433 }
1434
1435 kctl->private_free = snd_usb_mixer_elem_free;
1436 ret = snd_usb_copy_string_desc(state, hdr->iClockSource,
1437 name, sizeof(name));
1438 if (ret > 0)
1439 snprintf(kctl->id.name, sizeof(kctl->id.name),
1440 "%s Validity", name);
1441 else
1442 snprintf(kctl->id.name, sizeof(kctl->id.name),
1443 "Clock Source %d Validity", hdr->bClockID);
1444
1445 return snd_usb_mixer_add_control(&cval->head, kctl);
1446}
1447
Linus Torvalds1da177e2005-04-16 15:20:36 -07001448/*
1449 * parse a feature unit
1450 *
Lucas De Marchi25985ed2011-03-30 22:57:33 -03001451 * most of controls are defined here.
Linus Torvalds1da177e2005-04-16 15:20:36 -07001452 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001453static int parse_audio_feature_unit(struct mixer_build *state, int unitid,
1454 void *_ftr)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001455{
1456 int channels, i, j;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001457 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001458 unsigned int master_bits, first_ch_bits;
1459 int err, csize;
Daniel Mack23caaf12010-03-11 21:13:25 +01001460 struct uac_feature_unit_descriptor *hdr = _ftr;
1461 __u8 *bmaControls;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001462
Daniel Mack23caaf12010-03-11 21:13:25 +01001463 if (state->mixer->protocol == UAC_VERSION_1) {
1464 csize = hdr->bControlSize;
Nicolai Krakowiak60c961a92011-08-04 15:56:27 +02001465 if (!csize) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001466 usb_audio_dbg(state->chip,
1467 "unit %u: invalid bControlSize == 0\n",
1468 unitid);
Nicolai Krakowiak60c961a92011-08-04 15:56:27 +02001469 return -EINVAL;
1470 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001471 channels = (hdr->bLength - 7) / csize - 1;
1472 bmaControls = hdr->bmaControls;
Clemens Ladischd56268f2012-11-29 17:04:23 +01001473 if (hdr->bLength < 7 + csize) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001474 usb_audio_err(state->chip,
1475 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1476 unitid);
Clemens Ladischd56268f2012-11-29 17:04:23 +01001477 return -EINVAL;
1478 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001479 } else {
1480 struct uac2_feature_unit_descriptor *ftr = _ftr;
1481 csize = 4;
Daniel Macke8d0fee2010-05-27 20:15:14 +02001482 channels = (hdr->bLength - 6) / 4 - 1;
Daniel Mack23caaf12010-03-11 21:13:25 +01001483 bmaControls = ftr->bmaControls;
Clemens Ladischd56268f2012-11-29 17:04:23 +01001484 if (hdr->bLength < 6 + csize) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001485 usb_audio_err(state->chip,
1486 "unit %u: invalid UAC_FEATURE_UNIT descriptor\n",
1487 unitid);
Clemens Ladischd56268f2012-11-29 17:04:23 +01001488 return -EINVAL;
1489 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001490 }
1491
1492 /* parse the source unit */
Daniel Mack23caaf12010-03-11 21:13:25 +01001493 if ((err = parse_audio_unit(state, hdr->bSourceID)) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001494 return err;
1495
1496 /* determine the input source type and name */
Daniel Mack4d7b86c2013-03-19 21:09:24 +01001497 err = check_input_term(state, hdr->bSourceID, &iterm);
1498 if (err < 0)
1499 return err;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001500
Daniel Mack23caaf12010-03-11 21:13:25 +01001501 master_bits = snd_usb_combine_bytes(bmaControls, csize);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001502 /* master configuration quirks */
1503 switch (state->chip->usb_id) {
1504 case USB_ID(0x08bb, 0x2702):
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001505 usb_audio_info(state->chip,
1506 "usbmixer: master volume quirk for PCM2702 chip\n");
Javier Kohen0c3cee52009-11-17 15:36:13 +01001507 /* disable non-functional volume control */
Daniel Mack65f25da2010-05-31 13:35:41 +02001508 master_bits &= ~UAC_CONTROL_BIT(UAC_FU_VOLUME);
Javier Kohen0c3cee52009-11-17 15:36:13 +01001509 break;
David Henningssonc1051432012-09-20 10:20:41 +02001510 case USB_ID(0x1130, 0xf211):
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001511 usb_audio_info(state->chip,
1512 "usbmixer: volume control quirk for Tenx TP6911 Audio Headset\n");
David Henningssonc1051432012-09-20 10:20:41 +02001513 /* disable non-functional volume control */
1514 channels = 0;
1515 break;
1516
Javier Kohen0c3cee52009-11-17 15:36:13 +01001517 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001518 if (channels > 0)
Daniel Mack23caaf12010-03-11 21:13:25 +01001519 first_ch_bits = snd_usb_combine_bytes(bmaControls + csize, csize);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001520 else
1521 first_ch_bits = 0;
Daniel Mack23caaf12010-03-11 21:13:25 +01001522
1523 if (state->mixer->protocol == UAC_VERSION_1) {
1524 /* check all control types */
1525 for (i = 0; i < 10; i++) {
1526 unsigned int ch_bits = 0;
1527 for (j = 0; j < channels; j++) {
Daniel Mack6bc170e2014-05-24 10:58:16 +02001528 unsigned int mask;
1529
1530 mask = snd_usb_combine_bytes(bmaControls +
1531 csize * (j+1), csize);
Daniel Mack23caaf12010-03-11 21:13:25 +01001532 if (mask & (1 << i))
1533 ch_bits |= (1 << j);
1534 }
1535 /* audio class v1 controls are never read-only */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001536
1537 /*
1538 * The first channel must be set
1539 * (for ease of programming).
1540 */
1541 if (ch_bits & 1)
1542 build_feature_ctl(state, _ftr, ch_bits, i,
1543 &iterm, unitid, 0);
Daniel Mack23caaf12010-03-11 21:13:25 +01001544 if (master_bits & (1 << i))
Daniel Mack6bc170e2014-05-24 10:58:16 +02001545 build_feature_ctl(state, _ftr, 0, i, &iterm,
1546 unitid, 0);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001547 }
Daniel Mack23caaf12010-03-11 21:13:25 +01001548 } else { /* UAC_VERSION_2 */
Takashi Iwaid09c06c2011-10-13 08:19:09 +02001549 for (i = 0; i < ARRAY_SIZE(audio_feature_info); i++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001550 unsigned int ch_bits = 0;
1551 unsigned int ch_read_only = 0;
1552
1553 for (j = 0; j < channels; j++) {
Daniel Mack6bc170e2014-05-24 10:58:16 +02001554 unsigned int mask;
1555
1556 mask = snd_usb_combine_bytes(bmaControls +
1557 csize * (j+1), csize);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001558 if (uac2_control_is_readable(mask, i)) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001559 ch_bits |= (1 << j);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001560 if (!uac2_control_is_writeable(mask, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001561 ch_read_only |= (1 << j);
1562 }
1563 }
1564
Daniel Mack6bc170e2014-05-24 10:58:16 +02001565 /*
1566 * NOTE: build_feature_ctl() will mark the control
1567 * read-only if all channels are marked read-only in
1568 * the descriptors. Otherwise, the control will be
1569 * reported as writeable, but the driver will not
1570 * actually issue a write command for read-only
1571 * channels.
1572 */
1573
1574 /*
1575 * The first channel must be set
1576 * (for ease of programming).
1577 */
1578 if (ch_bits & 1)
1579 build_feature_ctl(state, _ftr, ch_bits, i,
1580 &iterm, unitid, ch_read_only);
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001581 if (uac2_control_is_readable(master_bits, i))
Daniel Mack23caaf12010-03-11 21:13:25 +01001582 build_feature_ctl(state, _ftr, 0, i, &iterm, unitid,
Daniel Mackdcbe7bc2010-05-31 13:35:36 +02001583 !uac2_control_is_writeable(master_bits, i));
Daniel Mack23caaf12010-03-11 21:13:25 +01001584 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001585 }
1586
1587 return 0;
1588}
1589
Linus Torvalds1da177e2005-04-16 15:20:36 -07001590/*
1591 * Mixer Unit
1592 */
1593
1594/*
1595 * build a mixer unit control
1596 *
1597 * the callbacks are identical with feature unit.
1598 * input channel number (zero based) is given in control field instead.
1599 */
Daniel Mack99fc8642010-03-11 21:13:24 +01001600static void build_mixer_unit_ctl(struct mixer_build *state,
1601 struct uac_mixer_unit_descriptor *desc,
Linus Torvalds1da177e2005-04-16 15:20:36 -07001602 int in_pin, int in_ch, int unitid,
Takashi Iwai86e07d32005-11-17 15:08:02 +01001603 struct usb_audio_term *iterm)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001604{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001605 struct usb_mixer_elem_info *cval;
Daniel Mack99fc8642010-03-11 21:13:24 +01001606 unsigned int num_outs = uac_mixer_unit_bNrChannels(desc);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001607 unsigned int i, len;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001608 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001609 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001610
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001611 map = find_map(state, unitid, 0);
1612 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001613 return;
1614
Takashi Iwai561b2202005-09-09 14:22:34 +02001615 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Daniel Mack6bc170e2014-05-24 10:58:16 +02001616 if (!cval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001617 return;
1618
Takashi Iwai3360b842014-11-18 11:47:04 +01001619 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001620 cval->control = in_ch + 1; /* based on 1 */
1621 cval->val_type = USB_MIXER_S16;
1622 for (i = 0; i < num_outs; i++) {
Daniel Mack6bc170e2014-05-24 10:58:16 +02001623 __u8 *c = uac_mixer_unit_bmControls(desc, state->mixer->protocol);
1624
1625 if (check_matrix_bitmap(c, in_ch, i, num_outs)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001626 cval->cmask |= (1 << i);
1627 cval->channels++;
1628 }
1629 }
1630
1631 /* get min/max values */
1632 get_min_max(cval, 0);
1633
1634 kctl = snd_ctl_new1(&usb_feature_unit_ctl, cval);
Daniel Mack6bc170e2014-05-24 10:58:16 +02001635 if (!kctl) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001636 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001637 kfree(cval);
1638 return;
1639 }
Chris J Argeseef90452014-11-12 12:07:01 -06001640 kctl->private_free = snd_usb_mixer_elem_free;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001641
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001642 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Daniel Mack6bc170e2014-05-24 10:58:16 +02001643 if (!len)
1644 len = get_term_name(state, iterm, kctl->id.name,
1645 sizeof(kctl->id.name), 0);
1646 if (!len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001647 len = sprintf(kctl->id.name, "Mixer Source %d", in_ch + 1);
Takashi Iwai08d1e632009-10-02 14:06:08 +02001648 append_ctl_name(kctl, " Volume");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001649
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001650 usb_audio_dbg(state->chip, "[%d] MU [%s] ch = %d, val = %d/%d\n",
Takashi Iwai3360b842014-11-18 11:47:04 +01001651 cval->head.id, kctl->id.name, cval->channels, cval->min, cval->max);
1652 snd_usb_mixer_add_control(&cval->head, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001653}
1654
Linus Torvalds1da177e2005-04-16 15:20:36 -07001655/*
1656 * parse a mixer unit
1657 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001658static int parse_audio_mixer_unit(struct mixer_build *state, int unitid,
1659 void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001660{
Daniel Mack99fc8642010-03-11 21:13:24 +01001661 struct uac_mixer_unit_descriptor *desc = raw_desc;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001662 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001663 int input_pins, num_ins, num_outs;
1664 int pin, ich, err;
1665
Daniel Mack6bc170e2014-05-24 10:58:16 +02001666 if (desc->bLength < 11 || !(input_pins = desc->bNrInPins) ||
1667 !(num_outs = uac_mixer_unit_bNrChannels(desc))) {
1668 usb_audio_err(state->chip,
1669 "invalid MIXER UNIT descriptor %d\n",
1670 unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001671 return -EINVAL;
1672 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001673
1674 num_ins = 0;
1675 ich = 0;
1676 for (pin = 0; pin < input_pins; pin++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001677 err = parse_audio_unit(state, desc->baSourceID[pin]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001678 if (err < 0)
Mark Hills284a8dd2012-04-14 17:19:23 +01001679 continue;
Clemens Ladischea114fc2015-06-03 11:36:51 +02001680 /* no bmControls field (e.g. Maya44) -> ignore */
1681 if (desc->bLength <= 10 + input_pins)
1682 continue;
Daniel Mack99fc8642010-03-11 21:13:24 +01001683 err = check_input_term(state, desc->baSourceID[pin], &iterm);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001684 if (err < 0)
1685 return err;
1686 num_ins += iterm.channels;
Daniel Mack6bc170e2014-05-24 10:58:16 +02001687 for (; ich < num_ins; ich++) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001688 int och, ich_has_controls = 0;
1689
Daniel Mack6bc170e2014-05-24 10:58:16 +02001690 for (och = 0; och < num_outs; och++) {
1691 __u8 *c = uac_mixer_unit_bmControls(desc,
1692 state->mixer->protocol);
1693
1694 if (check_matrix_bitmap(c, ich, och, num_outs)) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001695 ich_has_controls = 1;
1696 break;
1697 }
1698 }
1699 if (ich_has_controls)
1700 build_mixer_unit_ctl(state, desc, pin, ich,
1701 unitid, &iterm);
1702 }
1703 }
1704 return 0;
1705}
1706
Linus Torvalds1da177e2005-04-16 15:20:36 -07001707/*
1708 * Processing Unit / Extension Unit
1709 */
1710
1711/* get callback for processing/extension unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001712static int mixer_ctl_procunit_get(struct snd_kcontrol *kcontrol,
1713 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001714{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001715 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001716 int err, val;
1717
1718 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Takashi Iwai5aeee342014-11-18 11:02:14 +01001719 if (err < 0) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001720 ucontrol->value.integer.value[0] = cval->min;
Takashi Iwai5aeee342014-11-18 11:02:14 +01001721 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001722 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001723 val = get_relative_value(cval, val);
1724 ucontrol->value.integer.value[0] = val;
1725 return 0;
1726}
1727
1728/* put callback for processing/extension unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001729static int mixer_ctl_procunit_put(struct snd_kcontrol *kcontrol,
1730 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001731{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001732 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001733 int val, oval, err;
1734
1735 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
Takashi Iwai5aeee342014-11-18 11:02:14 +01001736 if (err < 0)
1737 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001738 val = ucontrol->value.integer.value[0];
1739 val = get_abs_value(cval, val);
1740 if (val != oval) {
1741 set_cur_ctl_value(cval, cval->control << 8, val);
1742 return 1;
1743 }
1744 return 0;
1745}
1746
1747/* alsa control interface for processing/extension unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01001748static struct snd_kcontrol_new mixer_procunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001749 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
1750 .name = "", /* will be filled later */
1751 .info = mixer_ctl_feature_info,
1752 .get = mixer_ctl_procunit_get,
1753 .put = mixer_ctl_procunit_put,
1754};
1755
Linus Torvalds1da177e2005-04-16 15:20:36 -07001756/*
1757 * predefined data for processing units
1758 */
1759struct procunit_value_info {
1760 int control;
1761 char *suffix;
1762 int val_type;
1763 int min_value;
1764};
1765
1766struct procunit_info {
1767 int type;
1768 char *name;
1769 struct procunit_value_info *values;
1770};
1771
1772static struct procunit_value_info updown_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001773 { UAC_UD_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1774 { UAC_UD_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001775 { 0 }
1776};
1777static struct procunit_value_info prologic_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001778 { UAC_DP_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1779 { UAC_DP_MODE_SELECT, "Mode Select", USB_MIXER_U8, 1 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001780 { 0 }
1781};
1782static struct procunit_value_info threed_enh_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001783 { UAC_3D_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1784 { UAC_3D_SPACE, "Spaciousness", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001785 { 0 }
1786};
1787static struct procunit_value_info reverb_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001788 { UAC_REVERB_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1789 { UAC_REVERB_LEVEL, "Level", USB_MIXER_U8 },
1790 { UAC_REVERB_TIME, "Time", USB_MIXER_U16 },
1791 { UAC_REVERB_FEEDBACK, "Feedback", USB_MIXER_U8 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001792 { 0 }
1793};
1794static struct procunit_value_info chorus_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001795 { UAC_CHORUS_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1796 { UAC_CHORUS_LEVEL, "Level", USB_MIXER_U8 },
1797 { UAC_CHORUS_RATE, "Rate", USB_MIXER_U16 },
1798 { UAC_CHORUS_DEPTH, "Depth", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001799 { 0 }
1800};
1801static struct procunit_value_info dcr_proc_info[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001802 { UAC_DCR_ENABLE, "Switch", USB_MIXER_BOOLEAN },
1803 { UAC_DCR_RATE, "Ratio", USB_MIXER_U16 },
1804 { UAC_DCR_MAXAMPL, "Max Amp", USB_MIXER_S16 },
1805 { UAC_DCR_THRESHOLD, "Threshold", USB_MIXER_S16 },
1806 { UAC_DCR_ATTACK_TIME, "Attack Time", USB_MIXER_U16 },
1807 { UAC_DCR_RELEASE_TIME, "Release Time", USB_MIXER_U16 },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001808 { 0 }
1809};
1810
1811static struct procunit_info procunits[] = {
Daniel Mack65f25da2010-05-31 13:35:41 +02001812 { UAC_PROCESS_UP_DOWNMIX, "Up Down", updown_proc_info },
1813 { UAC_PROCESS_DOLBY_PROLOGIC, "Dolby Prologic", prologic_proc_info },
1814 { UAC_PROCESS_STEREO_EXTENDER, "3D Stereo Extender", threed_enh_proc_info },
1815 { UAC_PROCESS_REVERB, "Reverb", reverb_proc_info },
1816 { UAC_PROCESS_CHORUS, "Chorus", chorus_proc_info },
1817 { UAC_PROCESS_DYN_RANGE_COMP, "DCR", dcr_proc_info },
Linus Torvalds1da177e2005-04-16 15:20:36 -07001818 { 0 },
1819};
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001820/*
1821 * predefined data for extension units
1822 */
1823static struct procunit_value_info clock_rate_xu_info[] = {
Daniel Macke213e9c2010-05-11 18:13:50 +02001824 { USB_XU_CLOCK_RATE_SELECTOR, "Selector", USB_MIXER_U8, 0 },
1825 { 0 }
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001826};
1827static struct procunit_value_info clock_source_xu_info[] = {
1828 { USB_XU_CLOCK_SOURCE_SELECTOR, "External", USB_MIXER_BOOLEAN },
1829 { 0 }
1830};
1831static struct procunit_value_info spdif_format_xu_info[] = {
1832 { USB_XU_DIGITAL_FORMAT_SELECTOR, "SPDIF/AC3", USB_MIXER_BOOLEAN },
1833 { 0 }
1834};
1835static struct procunit_value_info soft_limit_xu_info[] = {
1836 { USB_XU_SOFT_LIMIT_SELECTOR, " ", USB_MIXER_BOOLEAN },
1837 { 0 }
1838};
1839static struct procunit_info extunits[] = {
1840 { USB_XU_CLOCK_RATE, "Clock rate", clock_rate_xu_info },
1841 { USB_XU_CLOCK_SOURCE, "DigitalIn CLK source", clock_source_xu_info },
1842 { USB_XU_DIGITAL_IO_STATUS, "DigitalOut format:", spdif_format_xu_info },
1843 { USB_XU_DEVICE_OPTIONS, "AnalogueIn Soft Limit", soft_limit_xu_info },
1844 { 0 }
1845};
Daniel Mack6bc170e2014-05-24 10:58:16 +02001846
Linus Torvalds1da177e2005-04-16 15:20:36 -07001847/*
1848 * build a processing/extension unit
1849 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001850static int build_audio_procunit(struct mixer_build *state, int unitid,
1851 void *raw_desc, struct procunit_info *list,
1852 char *name)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001853{
Daniel Mack99fc8642010-03-11 21:13:24 +01001854 struct uac_processing_unit_descriptor *desc = raw_desc;
1855 int num_ins = desc->bNrInPins;
Takashi Iwai86e07d32005-11-17 15:08:02 +01001856 struct usb_mixer_elem_info *cval;
1857 struct snd_kcontrol *kctl;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001858 int i, err, nameid, type, len;
1859 struct procunit_info *info;
1860 struct procunit_value_info *valinfo;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001861 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001862 static struct procunit_value_info default_value_info[] = {
1863 { 0x01, "Switch", USB_MIXER_BOOLEAN },
1864 { 0 }
1865 };
1866 static struct procunit_info default_info = {
1867 0, NULL, default_value_info
1868 };
1869
Daniel Mack23caaf12010-03-11 21:13:25 +01001870 if (desc->bLength < 13 || desc->bLength < 13 + num_ins ||
1871 desc->bLength < num_ins + uac_processing_unit_bControlSize(desc, state->mixer->protocol)) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001872 usb_audio_err(state->chip, "invalid %s descriptor (id %d)\n", name, unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001873 return -EINVAL;
1874 }
1875
1876 for (i = 0; i < num_ins; i++) {
Daniel Mack99fc8642010-03-11 21:13:24 +01001877 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001878 return err;
1879 }
1880
Daniel Mack99fc8642010-03-11 21:13:24 +01001881 type = le16_to_cpu(desc->wProcessType);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001882 for (info = list; info && info->type; info++)
1883 if (info->type == type)
1884 break;
Daniel Mack6bc170e2014-05-24 10:58:16 +02001885 if (!info || !info->type)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001886 info = &default_info;
1887
1888 for (valinfo = info->values; valinfo->control; valinfo++) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001889 __u8 *controls = uac_processing_unit_bmControls(desc, state->mixer->protocol);
Daniel Mack99fc8642010-03-11 21:13:24 +01001890
Daniel Mack6bc170e2014-05-24 10:58:16 +02001891 if (!(controls[valinfo->control / 8] & (1 << ((valinfo->control % 8) - 1))))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001892 continue;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001893 map = find_map(state, unitid, valinfo->control);
1894 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07001895 continue;
Takashi Iwai561b2202005-09-09 14:22:34 +02001896 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Daniel Macka860d952014-05-24 10:58:17 +02001897 if (!cval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001898 return -ENOMEM;
Takashi Iwai3360b842014-11-18 11:47:04 +01001899 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001900 cval->control = valinfo->control;
1901 cval->val_type = valinfo->val_type;
1902 cval->channels = 1;
1903
1904 /* get min/max values */
Daniel Mack65f25da2010-05-31 13:35:41 +02001905 if (type == UAC_PROCESS_UP_DOWNMIX && cval->control == UAC_UD_MODE_SELECT) {
Daniel Mack23caaf12010-03-11 21:13:25 +01001906 __u8 *control_spec = uac_processing_unit_specific(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001907 /* FIXME: hard-coded */
1908 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01001909 cval->max = control_spec[0];
Linus Torvalds1da177e2005-04-16 15:20:36 -07001910 cval->res = 1;
1911 cval->initialized = 1;
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001912 } else {
1913 if (type == USB_XU_CLOCK_RATE) {
Daniel Mack6bc170e2014-05-24 10:58:16 +02001914 /*
1915 * E-Mu USB 0404/0202/TrackerPre/0204
Sergiy Kovalchuk7d2b4512009-12-27 09:13:41 -08001916 * samplerate control quirk
1917 */
1918 cval->min = 0;
1919 cval->max = 5;
1920 cval->res = 1;
1921 cval->initialized = 1;
1922 } else
1923 get_min_max(cval, valinfo->min_value);
1924 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07001925
1926 kctl = snd_ctl_new1(&mixer_procunit_ctl, cval);
Daniel Mack6bc170e2014-05-24 10:58:16 +02001927 if (!kctl) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001928 kfree(cval);
1929 return -ENOMEM;
1930 }
Chris J Argeseef90452014-11-12 12:07:01 -06001931 kctl->private_free = snd_usb_mixer_elem_free;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001932
Daniel Mack6bc170e2014-05-24 10:58:16 +02001933 if (check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name))) {
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01001934 /* nothing */ ;
Daniel Mack6bc170e2014-05-24 10:58:16 +02001935 } else if (info->name) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07001936 strlcpy(kctl->id.name, info->name, sizeof(kctl->id.name));
Daniel Mack6bc170e2014-05-24 10:58:16 +02001937 } else {
Daniel Mack23caaf12010-03-11 21:13:25 +01001938 nameid = uac_processing_unit_iProcessing(desc, state->mixer->protocol);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001939 len = 0;
1940 if (nameid)
Daniel Mack6bc170e2014-05-24 10:58:16 +02001941 len = snd_usb_copy_string_desc(state, nameid,
1942 kctl->id.name,
1943 sizeof(kctl->id.name));
1944 if (!len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001945 strlcpy(kctl->id.name, name, sizeof(kctl->id.name));
1946 }
Takashi Iwai08d1e632009-10-02 14:06:08 +02001947 append_ctl_name(kctl, " ");
1948 append_ctl_name(kctl, valinfo->suffix);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001949
Takashi Iwai0ba41d92014-02-26 13:02:17 +01001950 usb_audio_dbg(state->chip,
Daniel Mack6bc170e2014-05-24 10:58:16 +02001951 "[%d] PU [%s] ch = %d, val = %d/%d\n",
Takashi Iwai3360b842014-11-18 11:47:04 +01001952 cval->head.id, kctl->id.name, cval->channels,
Daniel Mack6bc170e2014-05-24 10:58:16 +02001953 cval->min, cval->max);
1954
Takashi Iwai3360b842014-11-18 11:47:04 +01001955 err = snd_usb_mixer_add_control(&cval->head, kctl);
Daniel Mack6bc170e2014-05-24 10:58:16 +02001956 if (err < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001957 return err;
1958 }
1959 return 0;
1960}
1961
Daniel Mack6bc170e2014-05-24 10:58:16 +02001962static int parse_audio_processing_unit(struct mixer_build *state, int unitid,
1963 void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001964{
Daniel Mack6bc170e2014-05-24 10:58:16 +02001965 return build_audio_procunit(state, unitid, raw_desc,
1966 procunits, "Processing Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001967}
1968
Daniel Mack6bc170e2014-05-24 10:58:16 +02001969static int parse_audio_extension_unit(struct mixer_build *state, int unitid,
1970 void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001971{
Daniel Mack6bc170e2014-05-24 10:58:16 +02001972 /*
1973 * Note that we parse extension units with processing unit descriptors.
1974 * That's ok as the layout is the same.
1975 */
1976 return build_audio_procunit(state, unitid, raw_desc,
1977 extunits, "Extension Unit");
Linus Torvalds1da177e2005-04-16 15:20:36 -07001978}
1979
Linus Torvalds1da177e2005-04-16 15:20:36 -07001980/*
1981 * Selector Unit
1982 */
1983
Daniel Mack6bc170e2014-05-24 10:58:16 +02001984/*
1985 * info callback for selector unit
Linus Torvalds1da177e2005-04-16 15:20:36 -07001986 * use an enumerator type for routing
1987 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02001988static int mixer_ctl_selector_info(struct snd_kcontrol *kcontrol,
1989 struct snd_ctl_elem_info *uinfo)
Linus Torvalds1da177e2005-04-16 15:20:36 -07001990{
Takashi Iwai86e07d32005-11-17 15:08:02 +01001991 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001992 const char **itemlist = (const char **)kcontrol->private_value;
Linus Torvalds1da177e2005-04-16 15:20:36 -07001993
Takashi Iwai5e246b82008-08-08 17:12:47 +02001994 if (snd_BUG_ON(!itemlist))
1995 return -EINVAL;
Clemens Ladisch2a1803a2011-01-10 16:30:13 +01001996 return snd_ctl_enum_info(uinfo, 1, cval->max, itemlist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07001997}
1998
1999/* get callback for selector unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02002000static int mixer_ctl_selector_get(struct snd_kcontrol *kcontrol,
2001 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002002{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002003 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002004 int val, err;
2005
Daniel Mack09414202010-05-31 13:35:44 +02002006 err = get_cur_ctl_value(cval, cval->control << 8, &val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002007 if (err < 0) {
Takashi Iwai5aeee342014-11-18 11:02:14 +01002008 ucontrol->value.enumerated.item[0] = 0;
2009 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002010 }
2011 val = get_relative_value(cval, val);
2012 ucontrol->value.enumerated.item[0] = val;
2013 return 0;
2014}
2015
2016/* put callback for selector unit */
Daniel Mack6bc170e2014-05-24 10:58:16 +02002017static int mixer_ctl_selector_put(struct snd_kcontrol *kcontrol,
2018 struct snd_ctl_elem_value *ucontrol)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002019{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002020 struct usb_mixer_elem_info *cval = kcontrol->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002021 int val, oval, err;
2022
Daniel Mack09414202010-05-31 13:35:44 +02002023 err = get_cur_ctl_value(cval, cval->control << 8, &oval);
Takashi Iwai5aeee342014-11-18 11:02:14 +01002024 if (err < 0)
2025 return filter_error(cval, err);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002026 val = ucontrol->value.enumerated.item[0];
2027 val = get_abs_value(cval, val);
2028 if (val != oval) {
Daniel Mack09414202010-05-31 13:35:44 +02002029 set_cur_ctl_value(cval, cval->control << 8, val);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002030 return 1;
2031 }
2032 return 0;
2033}
2034
2035/* alsa control interface for selector unit */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002036static struct snd_kcontrol_new mixer_selectunit_ctl = {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002037 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
2038 .name = "", /* will be filled later */
2039 .info = mixer_ctl_selector_info,
2040 .get = mixer_ctl_selector_get,
2041 .put = mixer_ctl_selector_put,
2042};
2043
Daniel Mack6bc170e2014-05-24 10:58:16 +02002044/*
2045 * private free callback.
Linus Torvalds1da177e2005-04-16 15:20:36 -07002046 * free both private_data and private_value
2047 */
Takashi Iwai86e07d32005-11-17 15:08:02 +01002048static void usb_mixer_selector_elem_free(struct snd_kcontrol *kctl)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002049{
2050 int i, num_ins = 0;
2051
2052 if (kctl->private_data) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01002053 struct usb_mixer_elem_info *cval = kctl->private_data;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002054 num_ins = cval->max;
2055 kfree(cval);
2056 kctl->private_data = NULL;
2057 }
2058 if (kctl->private_value) {
2059 char **itemlist = (char **)kctl->private_value;
2060 for (i = 0; i < num_ins; i++)
2061 kfree(itemlist[i]);
2062 kfree(itemlist);
2063 kctl->private_value = 0;
2064 }
2065}
2066
2067/*
2068 * parse a selector unit
2069 */
Daniel Mack6bc170e2014-05-24 10:58:16 +02002070static int parse_audio_selector_unit(struct mixer_build *state, int unitid,
2071 void *raw_desc)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002072{
Daniel Mack99fc8642010-03-11 21:13:24 +01002073 struct uac_selector_unit_descriptor *desc = raw_desc;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002074 unsigned int i, nameid, len;
2075 int err;
Takashi Iwai86e07d32005-11-17 15:08:02 +01002076 struct usb_mixer_elem_info *cval;
2077 struct snd_kcontrol *kctl;
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01002078 const struct usbmix_name_map *map;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002079 char **namelist;
2080
Daniel Mack99fc8642010-03-11 21:13:24 +01002081 if (!desc->bNrInPins || desc->bLength < 5 + desc->bNrInPins) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002082 usb_audio_err(state->chip,
2083 "invalid SELECTOR UNIT descriptor %d\n", unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002084 return -EINVAL;
2085 }
2086
Daniel Mack99fc8642010-03-11 21:13:24 +01002087 for (i = 0; i < desc->bNrInPins; i++) {
2088 if ((err = parse_audio_unit(state, desc->baSourceID[i])) < 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002089 return err;
2090 }
2091
Daniel Mack99fc8642010-03-11 21:13:24 +01002092 if (desc->bNrInPins == 1) /* only one ? nonsense! */
Linus Torvalds1da177e2005-04-16 15:20:36 -07002093 return 0;
2094
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01002095 map = find_map(state, unitid, 0);
2096 if (check_ignored_ctl(map))
Linus Torvalds1da177e2005-04-16 15:20:36 -07002097 return 0;
2098
Takashi Iwai561b2202005-09-09 14:22:34 +02002099 cval = kzalloc(sizeof(*cval), GFP_KERNEL);
Daniel Macka860d952014-05-24 10:58:17 +02002100 if (!cval)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002101 return -ENOMEM;
Takashi Iwai3360b842014-11-18 11:47:04 +01002102 snd_usb_mixer_elem_init_std(&cval->head, state->mixer, unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002103 cval->val_type = USB_MIXER_U8;
2104 cval->channels = 1;
2105 cval->min = 1;
Daniel Mack99fc8642010-03-11 21:13:24 +01002106 cval->max = desc->bNrInPins;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002107 cval->res = 1;
2108 cval->initialized = 1;
2109
Johan Rasténa358a0e2014-11-17 08:39:33 +01002110 if (state->mixer->protocol == UAC_VERSION_1)
Daniel Mack09414202010-05-31 13:35:44 +02002111 cval->control = 0;
Johan Rasténa358a0e2014-11-17 08:39:33 +01002112 else /* UAC_VERSION_2 */
2113 cval->control = (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR) ?
2114 UAC2_CX_CLOCK_SELECTOR : UAC2_SU_SELECTOR;
Daniel Mack09414202010-05-31 13:35:44 +02002115
Daniel Mack99fc8642010-03-11 21:13:24 +01002116 namelist = kmalloc(sizeof(char *) * desc->bNrInPins, GFP_KERNEL);
Daniel Mack6bc170e2014-05-24 10:58:16 +02002117 if (!namelist) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002118 kfree(cval);
2119 return -ENOMEM;
2120 }
2121#define MAX_ITEM_NAME_LEN 64
Daniel Mack99fc8642010-03-11 21:13:24 +01002122 for (i = 0; i < desc->bNrInPins; i++) {
Takashi Iwai86e07d32005-11-17 15:08:02 +01002123 struct usb_audio_term iterm;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002124 len = 0;
2125 namelist[i] = kmalloc(MAX_ITEM_NAME_LEN, GFP_KERNEL);
Daniel Mack6bc170e2014-05-24 10:58:16 +02002126 if (!namelist[i]) {
Mariusz Kozlowski7fbe3ca2007-01-08 11:25:30 +01002127 while (i--)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002128 kfree(namelist[i]);
2129 kfree(namelist);
2130 kfree(cval);
2131 return -ENOMEM;
2132 }
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02002133 len = check_mapped_selector_name(state, unitid, i, namelist[i],
2134 MAX_ITEM_NAME_LEN);
Daniel Mack99fc8642010-03-11 21:13:24 +01002135 if (! len && check_input_term(state, desc->baSourceID[i], &iterm) >= 0)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002136 len = get_term_name(state, &iterm, namelist[i], MAX_ITEM_NAME_LEN, 0);
2137 if (! len)
Masanari Iidaaf831ee2014-04-28 13:08:55 +09002138 sprintf(namelist[i], "Input %u", i);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002139 }
2140
2141 kctl = snd_ctl_new1(&mixer_selectunit_ctl, cval);
2142 if (! kctl) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002143 usb_audio_err(state->chip, "cannot malloc kcontrol\n");
Jesper Juhl878b4782006-03-20 11:27:13 +01002144 kfree(namelist);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002145 kfree(cval);
2146 return -ENOMEM;
2147 }
2148 kctl->private_value = (unsigned long)namelist;
2149 kctl->private_free = usb_mixer_selector_elem_free;
2150
Daniel Mack99fc8642010-03-11 21:13:24 +01002151 nameid = uac_selector_unit_iSelector(desc);
Jaroslav Kyselac3a3e042010-02-11 17:50:44 +01002152 len = check_mapped_name(map, kctl->id.name, sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002153 if (len)
2154 ;
2155 else if (nameid)
Daniel Mack6bc170e2014-05-24 10:58:16 +02002156 snd_usb_copy_string_desc(state, nameid, kctl->id.name,
2157 sizeof(kctl->id.name));
Linus Torvalds1da177e2005-04-16 15:20:36 -07002158 else {
2159 len = get_term_name(state, &state->oterm,
2160 kctl->id.name, sizeof(kctl->id.name), 0);
Daniel Mack6bc170e2014-05-24 10:58:16 +02002161 if (!len)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002162 strlcpy(kctl->id.name, "USB", sizeof(kctl->id.name));
2163
Daniel Mack09414202010-05-31 13:35:44 +02002164 if (desc->bDescriptorSubtype == UAC2_CLOCK_SELECTOR)
2165 append_ctl_name(kctl, " Clock Source");
2166 else if ((state->oterm.type & 0xff00) == 0x0100)
Takashi Iwai08d1e632009-10-02 14:06:08 +02002167 append_ctl_name(kctl, " Capture Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002168 else
Takashi Iwai08d1e632009-10-02 14:06:08 +02002169 append_ctl_name(kctl, " Playback Source");
Linus Torvalds1da177e2005-04-16 15:20:36 -07002170 }
2171
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002172 usb_audio_dbg(state->chip, "[%d] SU [%s] items = %d\n",
Takashi Iwai3360b842014-11-18 11:47:04 +01002173 cval->head.id, kctl->id.name, desc->bNrInPins);
2174 return snd_usb_mixer_add_control(&cval->head, kctl);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002175}
2176
Linus Torvalds1da177e2005-04-16 15:20:36 -07002177/*
2178 * parse an audio unit recursively
2179 */
2180
Takashi Iwai86e07d32005-11-17 15:08:02 +01002181static int parse_audio_unit(struct mixer_build *state, int unitid)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002182{
2183 unsigned char *p1;
2184
2185 if (test_and_set_bit(unitid, state->unitbitmap))
2186 return 0; /* the unit already visited */
2187
2188 p1 = find_audio_control_unit(state, unitid);
2189 if (!p1) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002190 usb_audio_err(state->chip, "unit %d not found!\n", unitid);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002191 return -EINVAL;
2192 }
2193
2194 switch (p1[2]) {
Daniel Mackde48c7b2010-02-22 23:49:13 +01002195 case UAC_INPUT_TERMINAL:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002196 return 0; /* NOP */
Daniel Mackde48c7b2010-02-22 23:49:13 +01002197 case UAC_MIXER_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002198 return parse_audio_mixer_unit(state, unitid, p1);
Daniel Mackcddaafb2016-04-09 11:21:46 +02002199 case UAC2_CLOCK_SOURCE:
2200 return parse_clock_source_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01002201 case UAC_SELECTOR_UNIT:
Daniel Mack09414202010-05-31 13:35:44 +02002202 case UAC2_CLOCK_SELECTOR:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002203 return parse_audio_selector_unit(state, unitid, p1);
Daniel Mackde48c7b2010-02-22 23:49:13 +01002204 case UAC_FEATURE_UNIT:
Linus Torvalds1da177e2005-04-16 15:20:36 -07002205 return parse_audio_feature_unit(state, unitid, p1);
Daniel Mack69da9bc2010-06-16 17:57:28 +02002206 case UAC1_PROCESSING_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01002207 /* UAC2_EFFECT_UNIT has the same value */
2208 if (state->mixer->protocol == UAC_VERSION_1)
2209 return parse_audio_processing_unit(state, unitid, p1);
2210 else
2211 return 0; /* FIXME - effect units not implemented yet */
Daniel Mack69da9bc2010-06-16 17:57:28 +02002212 case UAC1_EXTENSION_UNIT:
Daniel Mack23caaf12010-03-11 21:13:25 +01002213 /* UAC2_PROCESSING_UNIT_V2 has the same value */
2214 if (state->mixer->protocol == UAC_VERSION_1)
2215 return parse_audio_extension_unit(state, unitid, p1);
2216 else /* UAC_VERSION_2 */
2217 return parse_audio_processing_unit(state, unitid, p1);
Torstein Hegge61ac5132013-03-19 17:12:14 +01002218 case UAC2_EXTENSION_UNIT_V2:
2219 return parse_audio_extension_unit(state, unitid, p1);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002220 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002221 usb_audio_err(state->chip,
2222 "unit %u: unexpected type 0x%02x\n", unitid, p1[2]);
Linus Torvalds1da177e2005-04-16 15:20:36 -07002223 return -EINVAL;
2224 }
2225}
2226
Clemens Ladisch84957a82005-04-29 16:23:13 +02002227static void snd_usb_mixer_free(struct usb_mixer_interface *mixer)
2228{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002229 kfree(mixer->id_elems);
2230 if (mixer->urb) {
2231 kfree(mixer->urb->transfer_buffer);
2232 usb_free_urb(mixer->urb);
2233 }
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002234 usb_free_urb(mixer->rc_urb);
Clemens Ladischb259b102005-04-29 16:29:28 +02002235 kfree(mixer->rc_setup_packet);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002236 kfree(mixer);
2237}
2238
Takashi Iwai86e07d32005-11-17 15:08:02 +01002239static int snd_usb_mixer_dev_free(struct snd_device *device)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002240{
2241 struct usb_mixer_interface *mixer = device->device_data;
2242 snd_usb_mixer_free(mixer);
2243 return 0;
2244}
2245
Linus Torvalds1da177e2005-04-16 15:20:36 -07002246/*
2247 * create mixer controls
2248 *
Daniel Mackde48c7b2010-02-22 23:49:13 +01002249 * walk through all UAC_OUTPUT_TERMINAL descriptors to search for mixers
Linus Torvalds1da177e2005-04-16 15:20:36 -07002250 */
Clemens Ladisch84957a82005-04-29 16:23:13 +02002251static int snd_usb_mixer_controls(struct usb_mixer_interface *mixer)
Linus Torvalds1da177e2005-04-16 15:20:36 -07002252{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002253 struct mixer_build state;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002254 int err;
2255 const struct usbmix_ctl_map *map;
Daniel Mack23caaf12010-03-11 21:13:25 +01002256 void *p;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002257
Linus Torvalds1da177e2005-04-16 15:20:36 -07002258 memset(&state, 0, sizeof(state));
Clemens Ladisch84957a82005-04-29 16:23:13 +02002259 state.chip = mixer->chip;
2260 state.mixer = mixer;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002261 state.buffer = mixer->hostif->extra;
2262 state.buflen = mixer->hostif->extralen;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002263
2264 /* check the mapping table */
Clemens Ladisch27d10f52005-05-02 08:51:26 +02002265 for (map = usbmix_ctl_maps; map->id; map++) {
2266 if (map->id == state.chip->usb_id) {
Linus Torvalds1da177e2005-04-16 15:20:36 -07002267 state.map = map->map;
Clemens Ladisch8e062ec2005-04-22 15:49:52 +02002268 state.selector_map = map->selector_map;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002269 mixer->ignore_ctl_error = map->ignore_ctl_error;
Linus Torvalds1da177e2005-04-16 15:20:36 -07002270 break;
2271 }
2272 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002273
Daniel Mack23caaf12010-03-11 21:13:25 +01002274 p = NULL;
Daniel Mack6bc170e2014-05-24 10:58:16 +02002275 while ((p = snd_usb_find_csint_desc(mixer->hostif->extra,
2276 mixer->hostif->extralen,
Daniel Mack1faa5d02011-08-04 15:56:28 +02002277 p, UAC_OUTPUT_TERMINAL)) != NULL) {
Daniel Mack23caaf12010-03-11 21:13:25 +01002278 if (mixer->protocol == UAC_VERSION_1) {
Daniel Mack69da9bc2010-06-16 17:57:28 +02002279 struct uac1_output_terminal_descriptor *desc = p;
Daniel Mack23caaf12010-03-11 21:13:25 +01002280
2281 if (desc->bLength < sizeof(*desc))
2282 continue; /* invalid descriptor? */
Daniel Mack6bc170e2014-05-24 10:58:16 +02002283 /* mark terminal ID as visited */
2284 set_bit(desc->bTerminalID, state.unitbitmap);
Daniel Mack23caaf12010-03-11 21:13:25 +01002285 state.oterm.id = desc->bTerminalID;
2286 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2287 state.oterm.name = desc->iTerminal;
2288 err = parse_audio_unit(&state, desc->bSourceID);
Daniel Mack83ea5d12013-03-19 21:09:25 +01002289 if (err < 0 && err != -EINVAL)
Daniel Mack23caaf12010-03-11 21:13:25 +01002290 return err;
2291 } else { /* UAC_VERSION_2 */
2292 struct uac2_output_terminal_descriptor *desc = p;
2293
2294 if (desc->bLength < sizeof(*desc))
2295 continue; /* invalid descriptor? */
Daniel Mack6bc170e2014-05-24 10:58:16 +02002296 /* mark terminal ID as visited */
2297 set_bit(desc->bTerminalID, state.unitbitmap);
Daniel Mack23caaf12010-03-11 21:13:25 +01002298 state.oterm.id = desc->bTerminalID;
2299 state.oterm.type = le16_to_cpu(desc->wTerminalType);
2300 state.oterm.name = desc->iTerminal;
2301 err = parse_audio_unit(&state, desc->bSourceID);
Daniel Mack83ea5d12013-03-19 21:09:25 +01002302 if (err < 0 && err != -EINVAL)
Daniel Mack23caaf12010-03-11 21:13:25 +01002303 return err;
Daniel Mack09414202010-05-31 13:35:44 +02002304
Daniel Mack6bc170e2014-05-24 10:58:16 +02002305 /*
2306 * For UAC2, use the same approach to also add the
2307 * clock selectors
2308 */
Daniel Mack09414202010-05-31 13:35:44 +02002309 err = parse_audio_unit(&state, desc->bCSourceID);
Daniel Mack83ea5d12013-03-19 21:09:25 +01002310 if (err < 0 && err != -EINVAL)
Daniel Mack09414202010-05-31 13:35:44 +02002311 return err;
Daniel Mack23caaf12010-03-11 21:13:25 +01002312 }
Linus Torvalds1da177e2005-04-16 15:20:36 -07002313 }
Daniel Mack23caaf12010-03-11 21:13:25 +01002314
Linus Torvalds1da177e2005-04-16 15:20:36 -07002315 return 0;
2316}
Clemens Ladisch84957a82005-04-29 16:23:13 +02002317
Daniel Mack7b1eda22010-03-11 21:13:22 +01002318void snd_usb_mixer_notify_id(struct usb_mixer_interface *mixer, int unitid)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002319{
Takashi Iwai3360b842014-11-18 11:47:04 +01002320 struct usb_mixer_elem_list *list;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002321
Takashi Iwai3360b842014-11-18 11:47:04 +01002322 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002323 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
Takashi Iwai3360b842014-11-18 11:47:04 +01002324 &list->kctl->id);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002325}
2326
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002327static void snd_usb_mixer_dump_cval(struct snd_info_buffer *buffer,
Takashi Iwai3360b842014-11-18 11:47:04 +01002328 struct usb_mixer_elem_list *list)
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002329{
Takashi Iwai3360b842014-11-18 11:47:04 +01002330 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002331 static char *val_types[] = {"BOOLEAN", "INV_BOOLEAN",
2332 "S8", "U8", "S16", "U16"};
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002333 snd_iprintf(buffer, " Info: id=%i, control=%i, cmask=0x%x, "
Takashi Iwai3360b842014-11-18 11:47:04 +01002334 "channels=%i, type=\"%s\"\n", cval->head.id,
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002335 cval->control, cval->cmask, cval->channels,
2336 val_types[cval->val_type]);
2337 snd_iprintf(buffer, " Volume: min=%i, max=%i, dBmin=%i, dBmax=%i\n",
2338 cval->min, cval->max, cval->dBmin, cval->dBmax);
2339}
2340
2341static void snd_usb_mixer_proc_read(struct snd_info_entry *entry,
2342 struct snd_info_buffer *buffer)
2343{
2344 struct snd_usb_audio *chip = entry->private_data;
2345 struct usb_mixer_interface *mixer;
Takashi Iwai3360b842014-11-18 11:47:04 +01002346 struct usb_mixer_elem_list *list;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002347 int unitid;
2348
2349 list_for_each_entry(mixer, &chip->mixer_list, list) {
2350 snd_iprintf(buffer,
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002351 "USB Mixer: usb_id=0x%08x, ctrlif=%i, ctlerr=%i\n",
Daniel Mack3d8d4dc2010-06-16 17:57:31 +02002352 chip->usb_id, snd_usb_ctrl_intf(chip),
Jaroslav Kysela7affdc12010-02-16 11:52:27 +01002353 mixer->ignore_ctl_error);
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002354 snd_iprintf(buffer, "Card: %s\n", chip->card->longname);
2355 for (unitid = 0; unitid < MAX_ID_ELEMS; unitid++) {
Takashi Iwai3360b842014-11-18 11:47:04 +01002356 for (list = mixer->id_elems[unitid]; list;
2357 list = list->next_id_elem) {
2358 snd_iprintf(buffer, " Unit: %i\n", list->id);
2359 if (list->kctl)
2360 snd_iprintf(buffer,
2361 " Control: name=\"%s\", index=%i\n",
2362 list->kctl->id.name,
2363 list->kctl->id.index);
2364 if (list->dump)
2365 list->dump(buffer, list);
2366 }
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002367 }
2368 }
2369}
2370
Daniel Macke213e9c2010-05-11 18:13:50 +02002371static void snd_usb_mixer_interrupt_v2(struct usb_mixer_interface *mixer,
2372 int attribute, int value, int index)
2373{
Takashi Iwai3360b842014-11-18 11:47:04 +01002374 struct usb_mixer_elem_list *list;
Daniel Macke213e9c2010-05-11 18:13:50 +02002375 __u8 unitid = (index >> 8) & 0xff;
2376 __u8 control = (value >> 8) & 0xff;
2377 __u8 channel = value & 0xff;
Daniel Mack191227d2016-04-08 19:52:02 +02002378 unsigned int count = 0;
Daniel Macke213e9c2010-05-11 18:13:50 +02002379
2380 if (channel >= MAX_CHANNELS) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002381 usb_audio_dbg(mixer->chip,
2382 "%s(): bogus channel number %d\n",
2383 __func__, channel);
Daniel Macke213e9c2010-05-11 18:13:50 +02002384 return;
2385 }
2386
Daniel Mack191227d2016-04-08 19:52:02 +02002387 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem)
2388 count++;
2389
2390 if (count == 0)
2391 return;
2392
Takashi Iwai3360b842014-11-18 11:47:04 +01002393 for (list = mixer->id_elems[unitid]; list; list = list->next_id_elem) {
2394 struct usb_mixer_elem_info *info;
2395
2396 if (!list->kctl)
2397 continue;
2398
2399 info = (struct usb_mixer_elem_info *)list;
Daniel Mack191227d2016-04-08 19:52:02 +02002400 if (count > 1 && info->control != control)
Daniel Macke213e9c2010-05-11 18:13:50 +02002401 continue;
2402
2403 switch (attribute) {
2404 case UAC2_CS_CUR:
2405 /* invalidate cache, so the value is read from the device */
2406 if (channel)
2407 info->cached &= ~(1 << channel);
2408 else /* master channel */
2409 info->cached = 0;
2410
2411 snd_ctl_notify(mixer->chip->card, SNDRV_CTL_EVENT_MASK_VALUE,
Takashi Iwai3360b842014-11-18 11:47:04 +01002412 &info->head.kctl->id);
Daniel Macke213e9c2010-05-11 18:13:50 +02002413 break;
2414
2415 case UAC2_CS_RANGE:
2416 /* TODO */
2417 break;
2418
2419 case UAC2_CS_MEM:
2420 /* TODO */
2421 break;
2422
2423 default:
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002424 usb_audio_dbg(mixer->chip,
2425 "unknown attribute %d in interrupt\n",
2426 attribute);
Daniel Macke213e9c2010-05-11 18:13:50 +02002427 break;
2428 } /* switch */
2429 }
2430}
2431
2432static void snd_usb_mixer_interrupt(struct urb *urb)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002433{
2434 struct usb_mixer_interface *mixer = urb->context;
Daniel Macke213e9c2010-05-11 18:13:50 +02002435 int len = urb->actual_length;
Oliver Neukumedf7de32011-03-11 13:19:43 +01002436 int ustatus = urb->status;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002437
Oliver Neukumedf7de32011-03-11 13:19:43 +01002438 if (ustatus != 0)
Daniel Macke213e9c2010-05-11 18:13:50 +02002439 goto requeue;
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002440
Daniel Macke213e9c2010-05-11 18:13:50 +02002441 if (mixer->protocol == UAC_VERSION_1) {
2442 struct uac1_status_word *status;
2443
2444 for (status = urb->transfer_buffer;
2445 len >= sizeof(*status);
2446 len -= sizeof(*status), status++) {
Takashi Iwai0ba41d92014-02-26 13:02:17 +01002447 dev_dbg(&urb->dev->dev, "status interrupt: %02x %02x\n",
Daniel Macke213e9c2010-05-11 18:13:50 +02002448 status->bStatusType,
2449 status->bOriginator);
2450
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002451 /* ignore any notifications not from the control interface */
Daniel Macke213e9c2010-05-11 18:13:50 +02002452 if ((status->bStatusType & UAC1_STATUS_TYPE_ORIG_MASK) !=
2453 UAC1_STATUS_TYPE_ORIG_AUDIO_CONTROL_IF)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002454 continue;
Daniel Macke213e9c2010-05-11 18:13:50 +02002455
2456 if (status->bStatusType & UAC1_STATUS_TYPE_MEM_CHANGED)
2457 snd_usb_mixer_rc_memory_change(mixer, status->bOriginator);
Clemens Ladischb259b102005-04-29 16:29:28 +02002458 else
Daniel Macke213e9c2010-05-11 18:13:50 +02002459 snd_usb_mixer_notify_id(mixer, status->bOriginator);
2460 }
2461 } else { /* UAC_VERSION_2 */
2462 struct uac2_interrupt_data_msg *msg;
2463
2464 for (msg = urb->transfer_buffer;
2465 len >= sizeof(*msg);
2466 len -= sizeof(*msg), msg++) {
2467 /* drop vendor specific and endpoint requests */
2468 if ((msg->bInfo & UAC2_INTERRUPT_DATA_MSG_VENDOR) ||
2469 (msg->bInfo & UAC2_INTERRUPT_DATA_MSG_EP))
2470 continue;
2471
2472 snd_usb_mixer_interrupt_v2(mixer, msg->bAttribute,
2473 le16_to_cpu(msg->wValue),
2474 le16_to_cpu(msg->wIndex));
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002475 }
2476 }
Daniel Macke213e9c2010-05-11 18:13:50 +02002477
2478requeue:
Daniel Mack6bc170e2014-05-24 10:58:16 +02002479 if (ustatus != -ENOENT &&
2480 ustatus != -ECONNRESET &&
2481 ustatus != -ESHUTDOWN) {
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002482 urb->dev = mixer->chip->dev;
2483 usb_submit_urb(urb, GFP_ATOMIC);
2484 }
2485}
2486
2487/* create the handler for the optional status interrupt endpoint */
2488static int snd_usb_mixer_status_create(struct usb_mixer_interface *mixer)
2489{
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002490 struct usb_endpoint_descriptor *ep;
2491 void *transfer_buffer;
2492 int buffer_length;
2493 unsigned int epnum;
2494
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002495 /* we need one interrupt input endpoint */
Daniel Mack1faa5d02011-08-04 15:56:28 +02002496 if (get_iface_desc(mixer->hostif)->bNumEndpoints < 1)
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002497 return 0;
Daniel Mack1faa5d02011-08-04 15:56:28 +02002498 ep = get_endpoint(mixer->hostif, 0);
Julia Lawall913ae5a2009-01-03 17:54:53 +01002499 if (!usb_endpoint_dir_in(ep) || !usb_endpoint_xfer_int(ep))
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002500 return 0;
2501
Julia Lawall42a6e662008-12-29 11:23:02 +01002502 epnum = usb_endpoint_num(ep);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002503 buffer_length = le16_to_cpu(ep->wMaxPacketSize);
2504 transfer_buffer = kmalloc(buffer_length, GFP_KERNEL);
2505 if (!transfer_buffer)
2506 return -ENOMEM;
2507 mixer->urb = usb_alloc_urb(0, GFP_KERNEL);
2508 if (!mixer->urb) {
2509 kfree(transfer_buffer);
2510 return -ENOMEM;
2511 }
2512 usb_fill_int_urb(mixer->urb, mixer->chip->dev,
2513 usb_rcvintpipe(mixer->chip->dev, epnum),
2514 transfer_buffer, buffer_length,
Daniel Macke213e9c2010-05-11 18:13:50 +02002515 snd_usb_mixer_interrupt, mixer, ep->bInterval);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002516 usb_submit_urb(mixer->urb, GFP_KERNEL);
2517 return 0;
2518}
2519
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002520int snd_usb_create_mixer(struct snd_usb_audio *chip, int ctrlif,
2521 int ignore_error)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002522{
Takashi Iwai86e07d32005-11-17 15:08:02 +01002523 static struct snd_device_ops dev_ops = {
Clemens Ladisch84957a82005-04-29 16:23:13 +02002524 .dev_free = snd_usb_mixer_dev_free
2525 };
2526 struct usb_mixer_interface *mixer;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002527 struct snd_info_entry *entry;
Daniel Mack23caaf12010-03-11 21:13:25 +01002528 int err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002529
2530 strcpy(chip->card->mixername, "USB Mixer");
2531
Takashi Iwai561b2202005-09-09 14:22:34 +02002532 mixer = kzalloc(sizeof(*mixer), GFP_KERNEL);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002533 if (!mixer)
2534 return -ENOMEM;
2535 mixer->chip = chip;
Takashi Iwai7a9b8062008-08-13 15:40:53 +02002536 mixer->ignore_ctl_error = ignore_error;
Jaroslav Kysela291186e2010-02-16 11:55:18 +01002537 mixer->id_elems = kcalloc(MAX_ID_ELEMS, sizeof(*mixer->id_elems),
2538 GFP_KERNEL);
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002539 if (!mixer->id_elems) {
2540 kfree(mixer);
2541 return -ENOMEM;
2542 }
Clemens Ladisch84957a82005-04-29 16:23:13 +02002543
Daniel Mack1faa5d02011-08-04 15:56:28 +02002544 mixer->hostif = &usb_ifnum_to_if(chip->dev, ctrlif)->altsetting[0];
2545 switch (get_iface_desc(mixer->hostif)->bInterfaceProtocol) {
Clemens Ladischa2acad82010-09-03 10:53:11 +02002546 case UAC_VERSION_1:
2547 default:
2548 mixer->protocol = UAC_VERSION_1;
2549 break;
2550 case UAC_VERSION_2:
2551 mixer->protocol = UAC_VERSION_2;
2552 break;
2553 }
Daniel Mack7b8a0432010-02-22 23:49:12 +01002554
Clemens Ladisch6639b6c2005-04-29 16:26:14 +02002555 if ((err = snd_usb_mixer_controls(mixer)) < 0 ||
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002556 (err = snd_usb_mixer_status_create(mixer)) < 0)
2557 goto _error;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002558
Daniel Mack7b1eda22010-03-11 21:13:22 +01002559 snd_usb_mixer_apply_create_quirk(mixer);
Clemens Ladisch468b8fd2009-07-13 11:39:29 +02002560
Takashi Iwai9cbb2802014-02-04 11:15:31 +01002561 err = snd_device_new(chip->card, SNDRV_DEV_CODEC, mixer, &dev_ops);
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002562 if (err < 0)
2563 goto _error;
Jaroslav Kyselaebfdeea2010-02-16 11:17:09 +01002564
2565 if (list_empty(&chip->mixer_list) &&
2566 !snd_card_proc_new(chip->card, "usbmixer", &entry))
2567 snd_info_set_text_ops(entry, chip, snd_usb_mixer_proc_read);
2568
Clemens Ladisch84957a82005-04-29 16:23:13 +02002569 list_add(&mixer->list, &chip->mixer_list);
2570 return 0;
Clemens Ladisch93446ed2005-05-03 08:02:40 +02002571
2572_error:
2573 snd_usb_mixer_free(mixer);
2574 return err;
Clemens Ladisch84957a82005-04-29 16:23:13 +02002575}
2576
Takashi Iwaia6cece92014-10-31 11:24:32 +01002577void snd_usb_mixer_disconnect(struct usb_mixer_interface *mixer)
Clemens Ladisch84957a82005-04-29 16:23:13 +02002578{
Mariusz Kozlowski68df9de2006-11-08 15:37:04 +01002579 usb_kill_urb(mixer->urb);
2580 usb_kill_urb(mixer->rc_urb);
Clemens Ladisch84957a82005-04-29 16:23:13 +02002581}
Takashi Iwai400362f2014-01-20 16:51:16 +01002582
2583#ifdef CONFIG_PM
2584/* stop any bus activity of a mixer */
2585static void snd_usb_mixer_inactivate(struct usb_mixer_interface *mixer)
2586{
2587 usb_kill_urb(mixer->urb);
2588 usb_kill_urb(mixer->rc_urb);
2589}
2590
2591static int snd_usb_mixer_activate(struct usb_mixer_interface *mixer)
2592{
2593 int err;
2594
2595 if (mixer->urb) {
2596 err = usb_submit_urb(mixer->urb, GFP_NOIO);
2597 if (err < 0)
2598 return err;
2599 }
2600
2601 return 0;
2602}
2603
2604int snd_usb_mixer_suspend(struct usb_mixer_interface *mixer)
2605{
2606 snd_usb_mixer_inactivate(mixer);
2607 return 0;
2608}
2609
Takashi Iwai3360b842014-11-18 11:47:04 +01002610static int restore_mixer_value(struct usb_mixer_elem_list *list)
Takashi Iwai400362f2014-01-20 16:51:16 +01002611{
Takashi Iwai3360b842014-11-18 11:47:04 +01002612 struct usb_mixer_elem_info *cval = (struct usb_mixer_elem_info *)list;
Takashi Iwai400362f2014-01-20 16:51:16 +01002613 int c, err, idx;
2614
2615 if (cval->cmask) {
2616 idx = 0;
2617 for (c = 0; c < MAX_CHANNELS; c++) {
2618 if (!(cval->cmask & (1 << c)))
2619 continue;
Yao-Wen Mao6aa69252015-08-28 16:33:25 +08002620 if (cval->cached & (1 << (c + 1))) {
Chris J Argeseef90452014-11-12 12:07:01 -06002621 err = snd_usb_set_cur_mix_value(cval, c + 1, idx,
Takashi Iwai400362f2014-01-20 16:51:16 +01002622 cval->cache_val[idx]);
2623 if (err < 0)
2624 return err;
2625 }
2626 idx++;
2627 }
2628 } else {
2629 /* master */
2630 if (cval->cached) {
Chris J Argeseef90452014-11-12 12:07:01 -06002631 err = snd_usb_set_cur_mix_value(cval, 0, 0, *cval->cache_val);
Takashi Iwai400362f2014-01-20 16:51:16 +01002632 if (err < 0)
2633 return err;
2634 }
2635 }
2636
2637 return 0;
2638}
2639
2640int snd_usb_mixer_resume(struct usb_mixer_interface *mixer, bool reset_resume)
2641{
Takashi Iwai3360b842014-11-18 11:47:04 +01002642 struct usb_mixer_elem_list *list;
Takashi Iwai400362f2014-01-20 16:51:16 +01002643 int id, err;
2644
Takashi Iwai400362f2014-01-20 16:51:16 +01002645 if (reset_resume) {
2646 /* restore cached mixer values */
2647 for (id = 0; id < MAX_ID_ELEMS; id++) {
Takashi Iwai3360b842014-11-18 11:47:04 +01002648 for (list = mixer->id_elems[id]; list;
2649 list = list->next_id_elem) {
2650 if (list->resume) {
2651 err = list->resume(list);
2652 if (err < 0)
2653 return err;
2654 }
Takashi Iwai400362f2014-01-20 16:51:16 +01002655 }
2656 }
2657 }
2658
2659 return snd_usb_mixer_activate(mixer);
2660}
2661#endif
Takashi Iwai3360b842014-11-18 11:47:04 +01002662
2663void snd_usb_mixer_elem_init_std(struct usb_mixer_elem_list *list,
2664 struct usb_mixer_interface *mixer,
2665 int unitid)
2666{
2667 list->mixer = mixer;
2668 list->id = unitid;
2669 list->dump = snd_usb_mixer_dump_cval;
2670#ifdef CONFIG_PM
2671 list->resume = restore_mixer_value;
2672#endif
2673}