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