sound/usb/mixer_maps.c

   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
  22 struct usbmix_dB_map {
  23         u32 min;
  24         u32 max;
  25 };
  26
  27 struct usbmix_name_map {
  28         int id;
  29         const char *name;
  30         int control;
  31         struct usbmix_dB_map *dB;
  32 };
  33
  34 struct usbmix_selector_map {
  35         int id;
  36         int count;
  37         const char **names;
  38 };
  39
  40 struct 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
  54 USB_IN[1] --->FU[2]------------------------------+->MU[16]-->PU[17]-+->FU[18]--+->EU[27]--+->EU[21]-->FU[22]--+->FU[23] > Dig_OUT[24]
  55                                                  ^                  |          |          |                   |
  56 USB_IN[3] -+->SU[5]-->FU[6]--+->MU[14] ->PU[15]->+                  |          |          |                   +->FU[25] > Dig_OUT[26]
  57            ^                 ^                   |                  |          |          |
  58 Dig_IN[4] -+                 |                   |                  |          |          +->FU[28]---------------------> Spk_OUT[19]
  59                              |                   |                  |          |
  60 Lin-IN[7] -+-->FU[8]---------+                   |                  |          +----------------------------------------> Hph_OUT[20]
  61            |                                     |                  |
  62 Mic-IN[9] --+->FU[10]----------------------------+                  |
  63            ||                                                       |
  64            ||  +----------------------------------------------------+
  65            VV  V
  66            ++--+->SU[11]-->FU[12] --------------------------------------------------------------------------------------> USB_OUT[13]
  67 */
  68
  69 static 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  */
 110 static struct usbmix_dB_map mp3plus_dB_1 = {.min = -4781, .max = 0};
 111                                                 /* just guess */
 112 static struct usbmix_dB_map mp3plus_dB_2 = {.min = -1781, .max = 618};
 113                                                 /* just guess */
 114
 115 static struct usbmix_name_map mp3plus_map[] = {
 116         /* 1: IT pcm */
 117         /* 2: IT mic */
 118         /* 3: IT line */
 119         /* 4: IT digital in */
 120         /* 5: OT digital out */
 121         /* 6: OT speaker */
 122         /* 7: OT pcm capture */
 123         { 8, "Capture Source" }, /* FU, default PCM Capture Source */
 124                 /* (Mic, Input 1 = Line input, Input 2 = Optical input) */
 125         { 9, "Master Playback" }, /* FU, default Speaker 1 */
 126         /* { 10, "Mic Capture", 1 }, */ /* FU, Mic Capture */
 127         { 10, /* "Mic Capture", */ NULL, 2, .dB = &mp3plus_dB_2 },
 128                 /* FU, Mic Capture */
 129         { 10, "Mic Boost", 7 }, /* FU, default Auto Gain Input */
 130         { 11, "Line Capture", .dB = &mp3plus_dB_2 },
 131                 /* FU, default PCM Capture */
 132         { 12, "Digital In Playback" }, /* FU, default PCM 1 */
 133         { 13, /* "Mic Playback", */ .dB = &mp3plus_dB_1 },
 134                 /* FU, default Mic Playback */
 135         { 14, "Line Playback", .dB = &mp3plus_dB_1 }, /* FU, default Speaker */
 136         /* 15: MU */
 137         { 0 } /* terminator */
 138 };
 139
 140 /* Topology of SB Audigy 2 NX
 141
 142           +----------------------------->EU[27]--+
 143           |                                      v
 144           | +----------------------------------->SU[29]---->FU[22]-->Dig_OUT[24]
 145           | |                                    ^
 146 USB_IN[1]-+------------+              +->EU[17]->+->FU[11]-+
 147             |          v              |          v         |
 148 Dig_IN[4]---+->FU[6]-->MU[16]->FU[18]-+->EU[21]->SU[31]----->FU[30]->Hph_OUT[20]
 149             |          ^              |                    |
 150 Lin_IN[7]-+--->FU[8]---+              +->EU[23]->FU[28]------------->Spk_OUT[19]
 151           | |                                              v
 152           +--->FU[12]------------------------------------->SU[14]--->USB_OUT[15]
 153             |                                              ^
 154             +->FU[13]--------------------------------------+
 155 */
 156 static struct usbmix_name_map audigy2nx_map[] = {
 157         /* 1: IT pcm playback */
 158         /* 4: IT digital in */
 159         { 6, "Digital In Playback" }, /* FU */
 160         /* 7: IT line in */
 161         { 8, "Line Playback" }, /* FU */
 162         { 11, "What-U-Hear Capture" }, /* FU */
 163         { 12, "Line Capture" }, /* FU */
 164         { 13, "Digital In Capture" }, /* FU */
 165         { 14, "Capture Source" }, /* SU */
 166         /* 15: OT pcm capture */
 167         /* 16: MU w/o controls */
 168         { 17, NULL }, /* DISABLED: EU (for what?) */
 169         { 18, "Master Playback" }, /* FU */
 170         /* 19: OT speaker */
 171         /* 20: OT headphone */
 172         { 21, NULL }, /* DISABLED: EU (for what?) */
 173         { 22, "Digital Out Playback" }, /* FU */
 174         { 23, NULL }, /* DISABLED: EU (for what?) */
 175         /* 24: OT digital out */
 176         { 27, NULL }, /* DISABLED: EU (for what?) */
 177         { 28, "Speaker Playback" }, /* FU */
 178         { 29, "Digital Out Source" }, /* SU */
 179         { 30, "Headphone Playback" }, /* FU */
 180         { 31, "Headphone Source" }, /* SU */
 181         { 0 } /* terminator */
 182 };
 183
 184 static struct usbmix_name_map mbox1_map[] = {
 185         { 1, "Clock" },
 186         { 0 } /* terminator */
 187 };
 188
 189 static struct usbmix_selector_map c400_selectors[] = {
 190         {
 191                 .id = 0x80,
 192                 .count = 2,
 193                 .names = (const char*[]) {"Internal", "SPDIF"}
 194         },
 195         { 0 } /* terminator */
 196 };
 197
 198 static struct usbmix_selector_map audigy2nx_selectors[] = {
 199         {
 200                 .id = 14, /* Capture Source */
 201                 .count = 3,
 202                 .names = (const char*[]) {"Line", "Digital In", "What-U-Hear"}
 203         },
 204         {
 205                 .id = 29, /* Digital Out Source */
 206                 .count = 3,
 207                 .names = (const char*[]) {"Front", "PCM", "Digital In"}
 208         },
 209         {
 210                 .id = 31, /* Headphone Source */
 211                 .count = 2,
 212                 .names = (const char*[]) {"Front", "Side"}
 213         },
 214         { 0 } /* terminator */
 215 };
 216
 217 /* Creative SoundBlaster Live! 24-bit External */
 218 static struct usbmix_name_map live24ext_map[] = {
 219         /* 2: PCM Playback Volume */
 220         { 5, "Mic Capture" }, /* FU, default PCM Capture Volume */
 221         { 0 } /* terminator */
 222 };
 223
 224 /* LineX FM Transmitter entry - needed to bypass controls bug */
 225 static struct usbmix_name_map linex_map[] = {
 226         /* 1: IT pcm */
 227         /* 2: OT Speaker */
 228         { 3, "Master" }, /* FU: master volume - left / right / mute */
 229         { 0 } /* terminator */
 230 };
 231
 232 static struct usbmix_name_map maya44_map[] = {
 233         /* 1: IT line */
 234         { 2, "Line Playback" }, /* FU */
 235         /* 3: IT line */
 236         { 4, "Line Playback" }, /* FU */
 237         /* 5: IT pcm playback */
 238         /* 6: MU */
 239         { 7, "Master Playback" }, /* FU */
 240         /* 8: OT speaker */
 241         /* 9: IT line */
 242         { 10, "Line Capture" }, /* FU */
 243         /* 11: MU */
 244         /* 12: OT pcm capture */
 245         { }
 246 };
 247
 248 /* Section "justlink_map" below added by James Courtier-Dutton <James@superbug.demon.co.uk>
 249  * sourced from Maplin Electronics (http://www.maplin.co.uk), part number A56AK
 250  * Part has 2 connectors that act as a single output. (TOSLINK Optical for digital out, and 3.5mm Jack for Analogue out.)
 251  * The USB Mixer publishes a Microphone and extra Volume controls for it, but none exist on the device,
 252  * so this map removes all unwanted sliders from alsamixer
 253  */
 254
 255 static struct usbmix_name_map justlink_map[] = {
 256         /* 1: IT pcm playback */
 257         /* 2: Not present */
 258         { 3, NULL}, /* IT mic (No mic input on device) */
 259         /* 4: Not present */
 260         /* 5: OT speacker */
 261         /* 6: OT pcm capture */
 262         { 7, "Master Playback" }, /* Mute/volume for speaker */
 263         { 8, NULL }, /* Capture Switch (No capture inputs on device) */
 264         { 9, NULL }, /* Capture Mute/volume (No capture inputs on device */
 265         /* 0xa: Not present */
 266         /* 0xb: MU (w/o controls) */
 267         { 0xc, NULL }, /* Mic feedback Mute/volume (No capture inputs on device) */
 268         { 0 } /* terminator */
 269 };
 270
 271 /* TerraTec Aureon 5.1 MkII USB */
 272 static struct usbmix_name_map aureon_51_2_map[] = {
 273         /* 1: IT USB */
 274         /* 2: IT Mic */
 275         /* 3: IT Line */
 276         /* 4: IT SPDIF */
 277         /* 5: OT SPDIF */
 278         /* 6: OT Speaker */
 279         /* 7: OT USB */
 280         { 8, "Capture Source" }, /* SU */
 281         { 9, "Master Playback" }, /* FU */
 282         { 10, "Mic Capture" }, /* FU */
 283         { 11, "Line Capture" }, /* FU */
 284         { 12, "IEC958 In Capture" }, /* FU */
 285         { 13, "Mic Playback" }, /* FU */
 286         { 14, "Line Playback" }, /* FU */
 287         /* 15: MU */
 288         {} /* terminator */
 289 };
 290
 291 static struct usbmix_name_map scratch_live_map[] = {
 292         /* 1: IT Line 1 (USB streaming) */
 293         /* 2: OT Line 1 (Speaker) */
 294         /* 3: IT Line 1 (Line connector) */
 295         { 4, "Line 1 In" }, /* FU */
 296         /* 5: OT Line 1 (USB streaming) */
 297         /* 6: IT Line 2 (USB streaming) */
 298         /* 7: OT Line 2 (Speaker) */
 299         /* 8: IT Line 2 (Line connector) */
 300         { 9, "Line 2 In" }, /* FU */
 301         /* 10: OT Line 2 (USB streaming) */
 302         /* 11: IT Mic (Line connector) */
 303         /* 12: OT Mic (USB streaming) */
 304         { 0 } /* terminator */
 305 };
 306
 307 static struct usbmix_name_map ebox44_map[] = {
 308         { 4, NULL }, /* FU */
 309         { 6, NULL }, /* MU */
 310         { 7, NULL }, /* FU */
 311         { 10, NULL }, /* FU */
 312         { 11, NULL }, /* MU */
 313         { 0 }
 314 };
 315
 316 /* "Gamesurround Muse Pocket LT" looks same like "Sound Blaster MP3+"
 317  *  most importand difference is SU[8], it should be set to "Capture Source"
 318  *  to make alsamixer and PA working properly.
 319  *  FIXME: or mp3plus_map should use "Capture Source" too,
 320  *  so this maps can be merget
 321  */
 322 static struct usbmix_name_map hercules_usb51_map[] = {
 323         { 8, "Capture Source" },        /* SU, default "PCM Capture Source" */
 324         { 9, "Master Playback" },       /* FU, default "Speaker Playback" */
 325         { 10, "Mic Boost", 7 },         /* FU, default "Auto Gain Input" */
 326         { 11, "Line Capture" },         /* FU, default "PCM Capture" */
 327         { 13, "Mic Bypass Playback" },  /* FU, default "Mic Playback" */
 328         { 14, "Line Bypass Playback" }, /* FU, default "Line Playback" */
 329         { 0 }                           /* terminator */
 330 };
 331
 332 /* Plantronics Gamecom 780 has a broken volume control, better to disable it */
 333 static struct usbmix_name_map gamecom780_map[] = {
 334         { 9, NULL }, /* FU, speaker out */
 335         {}
 336 };
 337
 338 /* some (all?) SCMS USB3318 devices are affected by a firmware lock up
 339  * when anything attempts to access FU 10 (control)
 340  */
 341 static const struct usbmix_name_map scms_usb3318_map[] = {
 342         { 10, NULL },
 343         { 0 }
 344 };
 345
 346 /* Bose companion 5, the dB conversion factor is 16 instead of 256 */
 347 static struct usbmix_dB_map bose_companion5_dB = {-5006, -6};
 348 static struct usbmix_name_map bose_companion5_map[] = {
 349         { 3, NULL, .dB = &bose_companion5_dB },
 350         { 0 }   /* terminator */
 351 };
 352
 353 /*
 354  * Dell usb dock with ALC4020 codec had a firmware problem where it got
 355  * screwed up when zero volume is passed; just skip it as a workaround
 356  *
 357  * Also the extension unit gives an access error, so skip it as well.
 358  */
 359 static const struct usbmix_name_map dell_alc4020_map[] = {
 360         { 4, NULL },    /* extension unit */
 361         { 16, NULL },
 362         { 19, NULL },
 363         { 0 }
 364 };
 365
 366 /*
 367  * Control map entries
 368  */
 369
 370 static struct usbmix_ctl_map usbmix_ctl_maps[] = {
 371         {
 372                 .id = USB_ID(0x041e, 0x3000),
 373                 .map = extigy_map,
 374                 .ignore_ctl_error = 1,
 375         },
 376         {
 377                 .id = USB_ID(0x041e, 0x3010),
 378                 .map = mp3plus_map,
 379         },
 380         {
 381                 .id = USB_ID(0x041e, 0x3020),
 382                 .map = audigy2nx_map,
 383                 .selector_map = audigy2nx_selectors,
 384         },
 385         {
 386                 .id = USB_ID(0x041e, 0x3040),
 387                 .map = live24ext_map,
 388         },
 389         {
 390                 .id = USB_ID(0x041e, 0x3048),
 391                 .map = audigy2nx_map,
 392                 .selector_map = audigy2nx_selectors,
 393         },
 394         {       /* Logitech, Inc. QuickCam Pro for Notebooks */
 395                 .id = USB_ID(0x046d, 0x0991),
 396                 .ignore_ctl_error = 1,
 397         },
 398         {       /* Logitech, Inc. QuickCam E 3500 */
 399                 .id = USB_ID(0x046d, 0x09a4),
 400                 .ignore_ctl_error = 1,
 401         },
 402         {       /* Plantronics GameCom 780 */
 403                 .id = USB_ID(0x047f, 0xc010),
 404                 .map = gamecom780_map,
 405         },
 406         {
 407                 /* Hercules DJ Console (Windows Edition) */
 408                 .id = USB_ID(0x06f8, 0xb000),
 409                 .ignore_ctl_error = 1,
 410         },
 411         {
 412                 /* Hercules DJ Console (Macintosh Edition) */
 413                 .id = USB_ID(0x06f8, 0xd002),
 414                 .ignore_ctl_error = 1,
 415         },
 416         {
 417                 /* Hercules Gamesurround Muse Pocket LT
 418                  * (USB 5.1 Channel Audio Adapter)
 419                  */
 420                 .id = USB_ID(0x06f8, 0xc000),
 421                 .map = hercules_usb51_map,
 422         },
 423         {
 424                 .id = USB_ID(0x0763, 0x2030),
 425                 .selector_map = c400_selectors,
 426         },
 427         {
 428                 .id = USB_ID(0x0763, 0x2031),
 429                 .selector_map = c400_selectors,
 430         },
 431         {
 432                 .id = USB_ID(0x08bb, 0x2702),
 433                 .map = linex_map,
 434                 .ignore_ctl_error = 1,
 435         },
 436         {
 437                 .id = USB_ID(0x0a92, 0x0091),
 438                 .map = maya44_map,
 439         },
 440         {
 441                 .id = USB_ID(0x0c45, 0x1158),
 442                 .map = justlink_map,
 443         },
 444         {
 445                 .id = USB_ID(0x0ccd, 0x0028),
 446                 .map = aureon_51_2_map,
 447         },
 448         {
 449                 .id = USB_ID(0x0bda, 0x4014),
 450                 .map = dell_alc4020_map,
 451         },
 452         {
 453                 .id = USB_ID(0x0dba, 0x1000),
 454                 .map = mbox1_map,
 455         },
 456         {
 457                 .id = USB_ID(0x13e5, 0x0001),
 458                 .map = scratch_live_map,
 459                 .ignore_ctl_error = 1,
 460         },
 461         {
 462                 .id = USB_ID(0x200c, 0x1018),
 463                 .map = ebox44_map,
 464         },
 465         {
 466                 /* MAYA44 USB+ */
 467                 .id = USB_ID(0x2573, 0x0008),
 468                 .map = maya44_map,
 469         },
 470         {
 471                 /* KEF X300A */
 472                 .id = USB_ID(0x27ac, 0x1000),
 473                 .map = scms_usb3318_map,
 474         },
 475         {
 476                 /* Arcam rPAC */
 477                 .id = USB_ID(0x25c4, 0x0003),
 478                 .map = scms_usb3318_map,
 479         },
 480         {
 481                 /* Bose Companion 5 */
 482                 .id = USB_ID(0x05a7, 0x1020),
 483                 .map = bose_companion5_map,
 484         },
 485         { 0 } /* terminator */
 486 };
 487
 488 /*
 489  * Control map entries for UAC3 BADD profiles
 490  */
 491
 492 static struct usbmix_name_map uac3_badd_generic_io_map[] = {
 493         { UAC3_BADD_FU_ID2, "Generic Out Playback" },
 494         { UAC3_BADD_FU_ID5, "Generic In Capture" },
 495         { 0 }                                   /* terminator */
 496 };
 497 static struct usbmix_name_map uac3_badd_headphone_map[] = {
 498         { UAC3_BADD_FU_ID2, "Headphone Playback" },
 499         { 0 }                                   /* terminator */
 500 };
 501 static struct usbmix_name_map uac3_badd_speaker_map[] = {
 502         { UAC3_BADD_FU_ID2, "Speaker Playback" },
 503         { 0 }                                   /* terminator */
 504 };
 505 static struct usbmix_name_map uac3_badd_microphone_map[] = {
 506         { UAC3_BADD_FU_ID5, "Mic Capture" },
 507         { 0 }                                   /* terminator */
 508 };
 509 /* Covers also 'headset adapter' profile */
 510 static struct usbmix_name_map uac3_badd_headset_map[] = {
 511         { UAC3_BADD_FU_ID2, "Headset Playback" },
 512         { UAC3_BADD_FU_ID5, "Headset Capture" },
 513         { UAC3_BADD_FU_ID7, "Sidetone Mixing" },
 514         { 0 }                                   /* terminator */
 515 };
 516 static struct usbmix_name_map uac3_badd_speakerphone_map[] = {
 517         { UAC3_BADD_FU_ID2, "Speaker Playback" },
 518         { UAC3_BADD_FU_ID5, "Mic Capture" },
 519         { 0 }                                   /* terminator */
 520 };
 521
 522 static struct usbmix_ctl_map uac3_badd_usbmix_ctl_maps[] = {
 523         {
 524                 .id = UAC3_FUNCTION_SUBCLASS_GENERIC_IO,
 525                 .map = uac3_badd_generic_io_map,
 526         },
 527         {
 528                 .id = UAC3_FUNCTION_SUBCLASS_HEADPHONE,
 529                 .map = uac3_badd_headphone_map,
 530         },
 531         {
 532                 .id = UAC3_FUNCTION_SUBCLASS_SPEAKER,
 533                 .map = uac3_badd_speaker_map,
 534         },
 535         {
 536                 .id = UAC3_FUNCTION_SUBCLASS_MICROPHONE,
 537                 .map = uac3_badd_microphone_map,
 538         },
 539         {
 540                 .id = UAC3_FUNCTION_SUBCLASS_HEADSET,
 541                 .map = uac3_badd_headset_map,
 542         },
 543         {
 544                 .id = UAC3_FUNCTION_SUBCLASS_HEADSET_ADAPTER,
 545                 .map = uac3_badd_headset_map,
 546         },
 547         {
 548                 .id = UAC3_FUNCTION_SUBCLASS_SPEAKERPHONE,
 549                 .map = uac3_badd_speakerphone_map,
 550         },
 551         { 0 } /* terminator */
 552 };