1/*
2 *   Additional mixer mapping
3 *
4 *   Copyright (c) 2002 by Takashi Iwai <tiwai@suse.de>
5 *
6 *   This program is free software; you can redistribute it and/or modify
7 *   it under the terms of the GNU General Public License as published by
8 *   the Free Software Foundation; either version 2 of the License, or
9 *   (at your option) any later version.
10 *
11 *   This program is distributed in the hope that it will be useful,
12 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
13 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14 *   GNU General Public License for more details.
15 *
16 *   You should have received a copy of the GNU General Public License
17 *   along with this program; if not, write to the Free Software
18 *   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
19 *
20 */
21
22struct usbmix_dB_map {
23	u32 min;
24	u32 max;
25};
26
27struct usbmix_name_map {
28	int id;
29	const char *name;
30	int control;
31	struct usbmix_dB_map *dB;
32};
33
34struct usbmix_selector_map {
35	int id;
36	int count;
37	const char **names;
38};
39
40struct usbmix_ctl_map {
41	u32 id;
42	const struct usbmix_name_map *map;
43	const struct usbmix_selector_map *selector_map;
44	int ignore_ctl_error;
45};
46
47/*
48 * USB control mappers for SB Exitigy
49 */
50
51/*
52 * Topology of SB Extigy (see on the wide screen :)
53
54USB_IN[1] --->FU[2]------------------------------+->MU[16]-->PU[17]-+->FU[18]--+->EU[27]--+->EU[21]-->FU[22]--+->FU[23] > Dig_OUT[24]
55                                                 ^                  |          |          |                   |
56USB_IN[3] -+->SU[5]-->FU[6]--+->MU[14] ->PU[15]->+                  |          |          |                   +->FU[25] > Dig_OUT[26]
57           ^                 ^                   |                  |          |          |
58Dig_IN[4] -+                 |                   |                  |          |          +->FU[28]---------------------> Spk_OUT[19]
59                             |                   |                  |          |
60Lin-IN[7] -+-->FU[8]---------+                   |                  |          +----------------------------------------> Hph_OUT[20]
61           |                                     |                  |
62Mic-IN[9] --+->FU[10]----------------------------+                  |
63           ||                                                       |
64           ||  +----------------------------------------------------+
65           VV  V
66           ++--+->SU[11]-->FU[12] --------------------------------------------------------------------------------------> USB_OUT[13]
67*/
68
69static struct usbmix_name_map extigy_map[] = {
70	/* 1: IT pcm */
71	{ 2, "PCM Playback" }, /* FU */
72	/* 3: IT pcm */
73	/* 4: IT digital in */
74	{ 5, NULL }, /* DISABLED: this seems to be bogus on some firmware */
75	{ 6, "Digital In" }, /* FU */
76	/* 7: IT line */
77	{ 8, "Line Playback" }, /* FU */
78	/* 9: IT mic */
79	{ 10, "Mic Playback" }, /* FU */
80	{ 11, "Capture Source" }, /* SU */
81	{ 12, "Capture" }, /* FU */
82	/* 13: OT pcm capture */
83	/* 14: MU (w/o controls) */
84	/* 15: PU (3D enh) */
85	/* 16: MU (w/o controls) */
86	{ 17, NULL, 1 }, /* DISABLED: PU-switch (any effect?) */
87	{ 17, "Channel Routing", 2 },	/* PU: mode select */
88	{ 18, "Tone Control - Bass", UAC_FU_BASS }, /* FU */
89	{ 18, "Tone Control - Treble", UAC_FU_TREBLE }, /* FU */
90	{ 18, "Master Playback" }, /* FU; others */
91	/* 19: OT speaker */
92	/* 20: OT headphone */
93	{ 21, NULL }, /* DISABLED: EU (for what?) */
94	{ 22, "Digital Out Playback" }, /* FU */
95	{ 23, "Digital Out1 Playback" }, /* FU */  /* FIXME: corresponds to 24 */
96	/* 24: OT digital out */
97	{ 25, "IEC958 Optical Playback" }, /* FU */
98	{ 26, "IEC958 Optical Playback" }, /* OT */
99	{ 27, NULL }, /* DISABLED: EU (for what?) */
100	/* 28: FU speaker (mute) */
101	{ 29, NULL }, /* Digital Input Playback Source? */
102	{ 0 } /* terminator */
103};
104
105/* Sound Blaster MP3+ controls mapping
106 * The default mixer channels have totally misleading names,
107 * e.g. no Master and fake PCM volume
108 *			Pavel Mihaylov <bin@bash.info>
109 */
110static struct usbmix_dB_map mp3plus_dB_1 = {-4781, 0};	/* just guess */
111static struct usbmix_dB_map mp3plus_dB_2 = {-1781, 618}; /* just guess */
112
113static struct usbmix_name_map mp3plus_map[] = {
114	/* 1: IT pcm */
115	/* 2: IT mic */
116	/* 3: IT line */
117	/* 4: IT digital in */
118	/* 5: OT digital out */
119	/* 6: OT speaker */
120	/* 7: OT pcm capture */
121	{ 8, "Capture Source" }, /* FU, default PCM Capture Source */
122		/* (Mic, Input 1 = Line input, Input 2 = Optical input) */
123	{ 9, "Master Playback" }, /* FU, default Speaker 1 */
124	/* { 10, "Mic Capture", 1 }, */ /* FU, Mic Capture */
125	{ 10, /* "Mic Capture", */ NULL, 2, .dB = &mp3plus_dB_2 },
126		/* FU, Mic Capture */
127	{ 10, "Mic Boost", 7 }, /* FU, default Auto Gain Input */
128	{ 11, "Line Capture", .dB = &mp3plus_dB_2 },
129		/* FU, default PCM Capture */
130	{ 12, "Digital In Playback" }, /* FU, default PCM 1 */
131	{ 13, /* "Mic Playback", */ .dB = &mp3plus_dB_1 },
132		/* FU, default Mic Playback */
133	{ 14, "Line Playback", .dB = &mp3plus_dB_1 }, /* FU, default Speaker */
134	/* 15: MU */
135	{ 0 } /* terminator */
136};
137
138/* Topology of SB Audigy 2 NX
139
140          +----------------------------->EU[27]--+
141          |                                      v
142          | +----------------------------------->SU[29]---->FU[22]-->Dig_OUT[24]
143          | |                                    ^
144USB_IN[1]-+------------+              +->EU[17]->+->FU[11]-+
145            |          v              |          v         |
146Dig_IN[4]---+->FU[6]-->MU[16]->FU[18]-+->EU[21]->SU[31]----->FU[30]->Hph_OUT[20]
147            |          ^              |                    |
148Lin_IN[7]-+--->FU[8]---+              +->EU[23]->FU[28]------------->Spk_OUT[19]
149          | |                                              v
150          +--->FU[12]------------------------------------->SU[14]--->USB_OUT[15]
151            |                                              ^
152            +->FU[13]--------------------------------------+
153*/
154static struct usbmix_name_map audigy2nx_map[] = {
155	/* 1: IT pcm playback */
156	/* 4: IT digital in */
157	{ 6, "Digital In Playback" }, /* FU */
158	/* 7: IT line in */
159	{ 8, "Line Playback" }, /* FU */
160	{ 11, "What-U-Hear Capture" }, /* FU */
161	{ 12, "Line Capture" }, /* FU */
162	{ 13, "Digital In Capture" }, /* FU */
163	{ 14, "Capture Source" }, /* SU */
164	/* 15: OT pcm capture */
165	/* 16: MU w/o controls */
166	{ 17, NULL }, /* DISABLED: EU (for what?) */
167	{ 18, "Master Playback" }, /* FU */
168	/* 19: OT speaker */
169	/* 20: OT headphone */
170	{ 21, NULL }, /* DISABLED: EU (for what?) */
171	{ 22, "Digital Out Playback" }, /* FU */
172	{ 23, NULL }, /* DISABLED: EU (for what?) */
173	/* 24: OT digital out */
174	{ 27, NULL }, /* DISABLED: EU (for what?) */
175	{ 28, "Speaker Playback" }, /* FU */
176	{ 29, "Digital Out Source" }, /* SU */
177	{ 30, "Headphone Playback" }, /* FU */
178	{ 31, "Headphone Source" }, /* SU */
179	{ 0 } /* terminator */
180};
181
182static struct usbmix_name_map mbox1_map[] = {
183	{ 1, "Clock" },
184	{ 0 } /* terminator */
185};
186
187static struct usbmix_selector_map c400_selectors[] = {
188	{
189		.id = 0x80,
190		.count = 2,
191		.names = (const char*[]) {"Internal", "SPDIF"}
192	},
193	{ 0 } /* terminator */
194};
195
196static struct usbmix_selector_map audigy2nx_selectors[] = {
197	{
198		.id = 14, /* Capture Source */
199		.count = 3,
200		.names = (const char*[]) {"Line", "Digital In", "What-U-Hear"}
201	},
202	{
203		.id = 29, /* Digital Out Source */
204		.count = 3,
205		.names = (const char*[]) {"Front", "PCM", "Digital In"}
206	},
207	{
208		.id = 31, /* Headphone Source */
209		.count = 2,
210		.names = (const char*[]) {"Front", "Side"}
211	},
212	{ 0 } /* terminator */
213};
214
215/* Creative SoundBlaster Live! 24-bit External */
216static struct usbmix_name_map live24ext_map[] = {
217	/* 2: PCM Playback Volume */
218	{ 5, "Mic Capture" }, /* FU, default PCM Capture Volume */
219	{ 0 } /* terminator */
220};
221
222/* LineX FM Transmitter entry - needed to bypass controls bug */
223static struct usbmix_name_map linex_map[] = {
224	/* 1: IT pcm */
225	/* 2: OT Speaker */
226	{ 3, "Master" }, /* FU: master volume - left / right / mute */
227	{ 0 } /* terminator */
228};
229
230static struct usbmix_name_map maya44_map[] = {
231	/* 1: IT line */
232	{ 2, "Line Playback" }, /* FU */
233	/* 3: IT line */
234	{ 4, "Line Playback" }, /* FU */
235	/* 5: IT pcm playback */
236	/* 6: MU */
237	{ 7, "Master Playback" }, /* FU */
238	/* 8: OT speaker */
239	/* 9: IT line */
240	{ 10, "Line Capture" }, /* FU */
241	/* 11: MU */
242	/* 12: OT pcm capture */
243	{ }
244};
245
246/* Section "justlink_map" below added by James Courtier-Dutton <James@superbug.demon.co.uk>
247 * sourced from Maplin Electronics (http://www.maplin.co.uk), part number A56AK
248 * Part has 2 connectors that act as a single output. (TOSLINK Optical for digital out, and 3.5mm Jack for Analogue out.)
249 * The USB Mixer publishes a Microphone and extra Volume controls for it, but none exist on the device,
250 * so this map removes all unwanted sliders from alsamixer
251 */
252
253static struct usbmix_name_map justlink_map[] = {
254	/* 1: IT pcm playback */
255	/* 2: Not present */
256	{ 3, NULL}, /* IT mic (No mic input on device) */
257	/* 4: Not present */
258	/* 5: OT speacker */
259	/* 6: OT pcm capture */
260	{ 7, "Master Playback" }, /* Mute/volume for speaker */
261	{ 8, NULL }, /* Capture Switch (No capture inputs on device) */
262	{ 9, NULL }, /* Capture Mute/volume (No capture inputs on device */
263	/* 0xa: Not present */
264	/* 0xb: MU (w/o controls) */
265	{ 0xc, NULL }, /* Mic feedback Mute/volume (No capture inputs on device) */
266	{ 0 } /* terminator */
267};
268
269/* TerraTec Aureon 5.1 MkII USB */
270static struct usbmix_name_map aureon_51_2_map[] = {
271	/* 1: IT USB */
272	/* 2: IT Mic */
273	/* 3: IT Line */
274	/* 4: IT SPDIF */
275	/* 5: OT SPDIF */
276	/* 6: OT Speaker */
277	/* 7: OT USB */
278	{ 8, "Capture Source" }, /* SU */
279	{ 9, "Master Playback" }, /* FU */
280	{ 10, "Mic Capture" }, /* FU */
281	{ 11, "Line Capture" }, /* FU */
282	{ 12, "IEC958 In Capture" }, /* FU */
283	{ 13, "Mic Playback" }, /* FU */
284	{ 14, "Line Playback" }, /* FU */
285	/* 15: MU */
286	{} /* terminator */
287};
288
289static struct usbmix_name_map scratch_live_map[] = {
290	/* 1: IT Line 1 (USB streaming) */
291	/* 2: OT Line 1 (Speaker) */
292	/* 3: IT Line 1 (Line connector) */
293	{ 4, "Line 1 In" }, /* FU */
294	/* 5: OT Line 1 (USB streaming) */
295	/* 6: IT Line 2 (USB streaming) */
296	/* 7: OT Line 2 (Speaker) */
297	/* 8: IT Line 2 (Line connector) */
298	{ 9, "Line 2 In" }, /* FU */
299	/* 10: OT Line 2 (USB streaming) */
300	/* 11: IT Mic (Line connector) */
301	/* 12: OT Mic (USB streaming) */
302	{ 0 } /* terminator */
303};
304
305static struct usbmix_name_map ebox44_map[] = {
306	{ 4, NULL }, /* FU */
307	{ 6, NULL }, /* MU */
308	{ 7, NULL }, /* FU */
309	{ 10, NULL }, /* FU */
310	{ 11, NULL }, /* MU */
311	{ 0 }
312};
313
314/* "Gamesurround Muse Pocket LT" looks same like "Sound Blaster MP3+"
315 *  most importand difference is SU[8], it should be set to "Capture Source"
316 *  to make alsamixer and PA working properly.
317 *  FIXME: or mp3plus_map should use "Capture Source" too,
318 *  so this maps can be merget
319 */
320static struct usbmix_name_map hercules_usb51_map[] = {
321	{ 8, "Capture Source" },	/* SU, default "PCM Capture Source" */
322	{ 9, "Master Playback" },	/* FU, default "Speaker Playback" */
323	{ 10, "Mic Boost", 7 },		/* FU, default "Auto Gain Input" */
324	{ 11, "Line Capture" },		/* FU, default "PCM Capture" */
325	{ 13, "Mic Bypass Playback" },	/* FU, default "Mic Playback" */
326	{ 14, "Line Bypass Playback" },	/* FU, default "Line Playback" */
327	{ 0 }				/* terminator */
328};
329
330/* Plantronics Gamecom 780 has a broken volume control, better to disable it */
331static struct usbmix_name_map gamecom780_map[] = {
332	{ 9, NULL }, /* FU, speaker out */
333	{}
334};
335
336/* some (all?) SCMS USB3318 devices are affected by a firmware lock up
337 * when anything attempts to access FU 10 (control)
338 */
339static const struct usbmix_name_map scms_usb3318_map[] = {
340	{ 10, NULL },
341	{ 0 }
342};
343
344/* Bose companion 5, the dB conversion factor is 16 instead of 256 */
345static struct usbmix_dB_map bose_companion5_dB = {-5006, -6};
346static struct usbmix_name_map bose_companion5_map[] = {
347	{ 3, NULL, .dB = &bose_companion5_dB },
348	{ 0 }	/* terminator */
349};
350
351/*
352 * Dell usb dock with ALC4020 codec had a firmware problem where it got
353 * screwed up when zero volume is passed; just skip it as a workaround
354 */
355static const struct usbmix_name_map dell_alc4020_map[] = {
356	{ 16, NULL },
357	{ 19, NULL },
358	{ 0 }
359};
360
361/*
362 * Control map entries
363 */
364
365static struct usbmix_ctl_map usbmix_ctl_maps[] = {
366	{
367		.id = USB_ID(0x041e, 0x3000),
368		.map = extigy_map,
369		.ignore_ctl_error = 1,
370	},
371	{
372		.id = USB_ID(0x041e, 0x3010),
373		.map = mp3plus_map,
374	},
375	{
376		.id = USB_ID(0x041e, 0x3020),
377		.map = audigy2nx_map,
378		.selector_map = audigy2nx_selectors,
379	},
380 	{
381		.id = USB_ID(0x041e, 0x3040),
382		.map = live24ext_map,
383	},
384	{
385		.id = USB_ID(0x041e, 0x3048),
386		.map = audigy2nx_map,
387		.selector_map = audigy2nx_selectors,
388	},
389	{	/* Logitech, Inc. QuickCam Pro for Notebooks */
390		.id = USB_ID(0x046d, 0x0991),
391		.ignore_ctl_error = 1,
392	},
393	{	/* Logitech, Inc. QuickCam E 3500 */
394		.id = USB_ID(0x046d, 0x09a4),
395		.ignore_ctl_error = 1,
396	},
397	{	/* Plantronics GameCom 780 */
398		.id = USB_ID(0x047f, 0xc010),
399		.map = gamecom780_map,
400	},
401	{
402		/* Hercules DJ Console (Windows Edition) */
403		.id = USB_ID(0x06f8, 0xb000),
404		.ignore_ctl_error = 1,
405	},
406	{
407		/* Hercules DJ Console (Macintosh Edition) */
408		.id = USB_ID(0x06f8, 0xd002),
409		.ignore_ctl_error = 1,
410	},
411	{
412		/* Hercules Gamesurround Muse Pocket LT
413		 * (USB 5.1 Channel Audio Adapter)
414		 */
415		.id = USB_ID(0x06f8, 0xc000),
416		.map = hercules_usb51_map,
417	},
418	{
419		.id = USB_ID(0x0763, 0x2030),
420		.selector_map = c400_selectors,
421	},
422	{
423		.id = USB_ID(0x0763, 0x2031),
424		.selector_map = c400_selectors,
425	},
426	{
427		.id = USB_ID(0x08bb, 0x2702),
428		.map = linex_map,
429		.ignore_ctl_error = 1,
430	},
431	{
432		.id = USB_ID(0x0a92, 0x0091),
433		.map = maya44_map,
434	},
435	{
436		.id = USB_ID(0x0c45, 0x1158),
437		.map = justlink_map,
438	},
439	{
440		.id = USB_ID(0x0ccd, 0x0028),
441		.map = aureon_51_2_map,
442	},
443	{
444		.id = USB_ID(0x0bda, 0x4014),
445		.map = dell_alc4020_map,
446	},
447	{
448		.id = USB_ID(0x0dba, 0x1000),
449		.map = mbox1_map,
450	},
451	{
452		.id = USB_ID(0x13e5, 0x0001),
453		.map = scratch_live_map,
454		.ignore_ctl_error = 1,
455	},
456	{
457		.id = USB_ID(0x200c, 0x1018),
458		.map = ebox44_map,
459	},
460	{
461		/* MAYA44 USB+ */
462		.id = USB_ID(0x2573, 0x0008),
463		.map = maya44_map,
464	},
465	{
466		/* KEF X300A */
467		.id = USB_ID(0x27ac, 0x1000),
468		.map = scms_usb3318_map,
469	},
470	{
471		/* Arcam rPAC */
472		.id = USB_ID(0x25c4, 0x0003),
473		.map = scms_usb3318_map,
474	},
475	{
476		/* Bose Companion 5 */
477		.id = USB_ID(0x05a7, 0x1020),
478		.map = bose_companion5_map,
479	},
480	{ 0 } /* terminator */
481};
482
483