2 * C-Media CMI8788 driver for C-Media's reference design and similar models
4 * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
7 * This driver is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License, version 2.
10 * This driver is distributed in the hope that it will be useful,
11 * but WITHOUT ANY WARRANTY; without even the implied warranty of
12 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13 * GNU General Public License for more details.
15 * You should have received a copy of the GNU General Public License
16 * along with this driver; if not, write to the Free Software
17 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 * SPI 0 -> 1st AK4396 (front)
24 * SPI 1 -> 2nd AK4396 (surround)
25 * SPI 2 -> 3rd AK4396 (center/LFE)
27 * SPI 4 -> 4th AK4396 (back)
29 * GPIO 0 -> DFS0 of AK5385
30 * GPIO 1 -> DFS1 of AK5385
31 * GPIO 8 -> enable headphone amplifier on HT-Omega models
35 * GPO 0 -> route line-in (0) or AC97 output (1) to ADC input
38 #include <linux/delay.h>
39 #include <linux/mutex.h>
40 #include <linux/pci.h>
41 #include <sound/ac97_codec.h>
42 #include <sound/control.h>
43 #include <sound/core.h>
44 #include <sound/info.h>
45 #include <sound/initval.h>
46 #include <sound/pcm.h>
47 #include <sound/pcm_params.h>
48 #include <sound/tlv.h>
53 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
54 MODULE_DESCRIPTION("C-Media CMI8788 driver");
55 MODULE_LICENSE("GPL v2");
56 MODULE_SUPPORTED_DEVICE("{{C-Media,CMI8788}}");
58 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
59 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
60 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
62 module_param_array(index, int, NULL, 0444);
63 MODULE_PARM_DESC(index, "card index");
64 module_param_array(id, charp, NULL, 0444);
65 MODULE_PARM_DESC(id, "ID string");
66 module_param_array(enable, bool, NULL, 0444);
67 MODULE_PARM_DESC(enable, "enable card");
78 static DEFINE_PCI_DEVICE_TABLE(oxygen_ids) = {
79 /* C-Media's reference design */
80 { OXYGEN_PCI_SUBID(0x10b0, 0x0216), .driver_data = MODEL_CMEDIA_REF },
81 { OXYGEN_PCI_SUBID(0x10b0, 0x0218), .driver_data = MODEL_CMEDIA_REF },
82 { OXYGEN_PCI_SUBID(0x10b0, 0x0219), .driver_data = MODEL_CMEDIA_REF },
83 { OXYGEN_PCI_SUBID(0x13f6, 0x0001), .driver_data = MODEL_CMEDIA_REF },
84 { OXYGEN_PCI_SUBID(0x13f6, 0x0010), .driver_data = MODEL_CMEDIA_REF },
85 { OXYGEN_PCI_SUBID(0x13f6, 0x8788), .driver_data = MODEL_CMEDIA_REF },
86 { OXYGEN_PCI_SUBID(0x147a, 0xa017), .driver_data = MODEL_CMEDIA_REF },
87 { OXYGEN_PCI_SUBID(0x1a58, 0x0910), .driver_data = MODEL_CMEDIA_REF },
88 /* Kuroutoshikou CMI8787-HG2PCI */
89 { OXYGEN_PCI_SUBID(0x13f6, 0xffff), .driver_data = MODEL_2CH_OUTPUT },
90 /* TempoTec HiFier Fantasia */
91 { OXYGEN_PCI_SUBID(0x14c3, 0x1710), .driver_data = MODEL_FANTASIA },
92 /* TempoTec HiFier Serenade */
93 { OXYGEN_PCI_SUBID(0x14c3, 0x1711), .driver_data = MODEL_2CH_OUTPUT },
94 /* AuzenTech X-Meridian */
95 { OXYGEN_PCI_SUBID(0x415a, 0x5431), .driver_data = MODEL_MERIDIAN },
97 { OXYGEN_PCI_SUBID(0x7284, 0x9761), .driver_data = MODEL_CLARO },
98 /* HT-Omega Claro halo */
99 { OXYGEN_PCI_SUBID(0x7284, 0x9781), .driver_data = MODEL_CLARO_HALO },
102 MODULE_DEVICE_TABLE(pci, oxygen_ids);
105 #define GPIO_AK5385_DFS_MASK 0x0003
106 #define GPIO_AK5385_DFS_NORMAL 0x0000
107 #define GPIO_AK5385_DFS_DOUBLE 0x0001
108 #define GPIO_AK5385_DFS_QUAD 0x0002
110 #define GPIO_CLARO_HP 0x0100
112 struct generic_data {
114 u8 ak4396_regs[4][5];
118 static void ak4396_write(struct oxygen *chip, unsigned int codec,
121 /* maps ALSA channel pair number to SPI output */
122 static const u8 codec_spi_map[4] = {
125 struct generic_data *data = chip->model_data;
127 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER |
128 OXYGEN_SPI_DATA_LENGTH_2 |
129 OXYGEN_SPI_CLOCK_160 |
130 (codec_spi_map[codec] << OXYGEN_SPI_CODEC_SHIFT) |
131 OXYGEN_SPI_CEN_LATCH_CLOCK_HI,
132 AK4396_WRITE | (reg << 8) | value);
133 data->ak4396_regs[codec][reg] = value;
136 static void ak4396_write_cached(struct oxygen *chip, unsigned int codec,
139 struct generic_data *data = chip->model_data;
141 if (value != data->ak4396_regs[codec][reg])
142 ak4396_write(chip, codec, reg, value);
145 static void wm8785_write(struct oxygen *chip, u8 reg, unsigned int value)
147 struct generic_data *data = chip->model_data;
149 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER |
150 OXYGEN_SPI_DATA_LENGTH_2 |
151 OXYGEN_SPI_CLOCK_160 |
152 (3 << OXYGEN_SPI_CODEC_SHIFT) |
153 OXYGEN_SPI_CEN_LATCH_CLOCK_LO,
155 if (reg < ARRAY_SIZE(data->wm8785_regs))
156 data->wm8785_regs[reg] = value;
159 static void ak4396_registers_init(struct oxygen *chip)
161 struct generic_data *data = chip->model_data;
164 for (i = 0; i < data->dacs; ++i) {
165 ak4396_write(chip, i, AK4396_CONTROL_1,
166 AK4396_DIF_24_MSB | AK4396_RSTN);
167 ak4396_write(chip, i, AK4396_CONTROL_2,
168 data->ak4396_regs[0][AK4396_CONTROL_2]);
169 ak4396_write(chip, i, AK4396_CONTROL_3,
171 ak4396_write(chip, i, AK4396_LCH_ATT,
172 chip->dac_volume[i * 2]);
173 ak4396_write(chip, i, AK4396_RCH_ATT,
174 chip->dac_volume[i * 2 + 1]);
178 static void ak4396_init(struct oxygen *chip)
180 struct generic_data *data = chip->model_data;
182 data->dacs = chip->model.dac_channels / 2;
183 data->ak4396_regs[0][AK4396_CONTROL_2] =
184 AK4396_SMUTE | AK4396_DEM_OFF | AK4396_DFS_NORMAL;
185 ak4396_registers_init(chip);
186 snd_component_add(chip->card, "AK4396");
189 static void ak5385_init(struct oxygen *chip)
191 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_AK5385_DFS_MASK);
192 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_AK5385_DFS_MASK);
193 snd_component_add(chip->card, "AK5385");
196 static void wm8785_registers_init(struct oxygen *chip)
198 struct generic_data *data = chip->model_data;
200 wm8785_write(chip, WM8785_R7, 0);
201 wm8785_write(chip, WM8785_R0, data->wm8785_regs[0]);
202 wm8785_write(chip, WM8785_R2, data->wm8785_regs[2]);
205 static void wm8785_init(struct oxygen *chip)
207 struct generic_data *data = chip->model_data;
209 data->wm8785_regs[0] =
210 WM8785_MCR_SLAVE | WM8785_OSR_SINGLE | WM8785_FORMAT_LJUST;
211 data->wm8785_regs[2] = WM8785_HPFR | WM8785_HPFL;
212 wm8785_registers_init(chip);
213 snd_component_add(chip->card, "WM8785");
216 static void generic_init(struct oxygen *chip)
222 static void meridian_init(struct oxygen *chip)
228 static void claro_enable_hp(struct oxygen *chip)
231 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_CLARO_HP);
232 oxygen_set_bits16(chip, OXYGEN_GPIO_DATA, GPIO_CLARO_HP);
235 static void claro_init(struct oxygen *chip)
239 claro_enable_hp(chip);
242 static void claro_halo_init(struct oxygen *chip)
246 claro_enable_hp(chip);
249 static void fantasia_init(struct oxygen *chip)
252 snd_component_add(chip->card, "CS5340");
255 static void stereo_output_init(struct oxygen *chip)
260 static void generic_cleanup(struct oxygen *chip)
264 static void claro_disable_hp(struct oxygen *chip)
266 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_CLARO_HP);
269 static void claro_cleanup(struct oxygen *chip)
271 claro_disable_hp(chip);
274 static void claro_suspend(struct oxygen *chip)
276 claro_disable_hp(chip);
279 static void generic_resume(struct oxygen *chip)
281 ak4396_registers_init(chip);
282 wm8785_registers_init(chip);
285 static void meridian_resume(struct oxygen *chip)
287 ak4396_registers_init(chip);
290 static void claro_resume(struct oxygen *chip)
292 ak4396_registers_init(chip);
293 claro_enable_hp(chip);
296 static void stereo_resume(struct oxygen *chip)
298 ak4396_registers_init(chip);
301 static void set_ak4396_params(struct oxygen *chip,
302 struct snd_pcm_hw_params *params)
304 struct generic_data *data = chip->model_data;
308 value = data->ak4396_regs[0][AK4396_CONTROL_2] & ~AK4396_DFS_MASK;
309 if (params_rate(params) <= 54000)
310 value |= AK4396_DFS_NORMAL;
311 else if (params_rate(params) <= 108000)
312 value |= AK4396_DFS_DOUBLE;
314 value |= AK4396_DFS_QUAD;
316 msleep(1); /* wait for the new MCLK to become stable */
318 if (value != data->ak4396_regs[0][AK4396_CONTROL_2]) {
319 for (i = 0; i < data->dacs; ++i) {
320 ak4396_write(chip, i, AK4396_CONTROL_1,
322 ak4396_write(chip, i, AK4396_CONTROL_2, value);
323 ak4396_write(chip, i, AK4396_CONTROL_1,
324 AK4396_DIF_24_MSB | AK4396_RSTN);
329 static void update_ak4396_volume(struct oxygen *chip)
331 struct generic_data *data = chip->model_data;
334 for (i = 0; i < data->dacs; ++i) {
335 ak4396_write_cached(chip, i, AK4396_LCH_ATT,
336 chip->dac_volume[i * 2]);
337 ak4396_write_cached(chip, i, AK4396_RCH_ATT,
338 chip->dac_volume[i * 2 + 1]);
342 static void update_ak4396_mute(struct oxygen *chip)
344 struct generic_data *data = chip->model_data;
348 value = data->ak4396_regs[0][AK4396_CONTROL_2] & ~AK4396_SMUTE;
350 value |= AK4396_SMUTE;
351 for (i = 0; i < data->dacs; ++i)
352 ak4396_write_cached(chip, i, AK4396_CONTROL_2, value);
355 static void set_wm8785_params(struct oxygen *chip,
356 struct snd_pcm_hw_params *params)
358 struct generic_data *data = chip->model_data;
361 value = WM8785_MCR_SLAVE | WM8785_FORMAT_LJUST;
362 if (params_rate(params) <= 48000)
363 value |= WM8785_OSR_SINGLE;
364 else if (params_rate(params) <= 96000)
365 value |= WM8785_OSR_DOUBLE;
367 value |= WM8785_OSR_QUAD;
368 if (value != data->wm8785_regs[0]) {
369 wm8785_write(chip, WM8785_R7, 0);
370 wm8785_write(chip, WM8785_R0, value);
371 wm8785_write(chip, WM8785_R2, data->wm8785_regs[2]);
375 static void set_ak5385_params(struct oxygen *chip,
376 struct snd_pcm_hw_params *params)
380 if (params_rate(params) <= 54000)
381 value = GPIO_AK5385_DFS_NORMAL;
382 else if (params_rate(params) <= 108000)
383 value = GPIO_AK5385_DFS_DOUBLE;
385 value = GPIO_AK5385_DFS_QUAD;
386 oxygen_write16_masked(chip, OXYGEN_GPIO_DATA,
387 value, GPIO_AK5385_DFS_MASK);
390 static void set_no_params(struct oxygen *chip, struct snd_pcm_hw_params *params)
394 static int rolloff_info(struct snd_kcontrol *ctl,
395 struct snd_ctl_elem_info *info)
397 static const char *const names[2] = {
398 "Sharp Roll-off", "Slow Roll-off"
401 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
403 info->value.enumerated.items = 2;
404 if (info->value.enumerated.item >= 2)
405 info->value.enumerated.item = 1;
406 strcpy(info->value.enumerated.name, names[info->value.enumerated.item]);
410 static int rolloff_get(struct snd_kcontrol *ctl,
411 struct snd_ctl_elem_value *value)
413 struct oxygen *chip = ctl->private_data;
414 struct generic_data *data = chip->model_data;
416 value->value.enumerated.item[0] =
417 (data->ak4396_regs[0][AK4396_CONTROL_2] & AK4396_SLOW) != 0;
421 static int rolloff_put(struct snd_kcontrol *ctl,
422 struct snd_ctl_elem_value *value)
424 struct oxygen *chip = ctl->private_data;
425 struct generic_data *data = chip->model_data;
430 mutex_lock(&chip->mutex);
431 reg = data->ak4396_regs[0][AK4396_CONTROL_2];
432 if (value->value.enumerated.item[0])
436 changed = reg != data->ak4396_regs[0][AK4396_CONTROL_2];
438 for (i = 0; i < data->dacs; ++i)
439 ak4396_write(chip, i, AK4396_CONTROL_2, reg);
441 mutex_unlock(&chip->mutex);
445 static const struct snd_kcontrol_new rolloff_control = {
446 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
447 .name = "DAC Filter Playback Enum",
448 .info = rolloff_info,
453 static int hpf_info(struct snd_kcontrol *ctl, struct snd_ctl_elem_info *info)
455 static const char *const names[2] = {
456 "None", "High-pass Filter"
459 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
461 info->value.enumerated.items = 2;
462 if (info->value.enumerated.item >= 2)
463 info->value.enumerated.item = 1;
464 strcpy(info->value.enumerated.name, names[info->value.enumerated.item]);
468 static int hpf_get(struct snd_kcontrol *ctl, struct snd_ctl_elem_value *value)
470 struct oxygen *chip = ctl->private_data;
471 struct generic_data *data = chip->model_data;
473 value->value.enumerated.item[0] =
474 (data->wm8785_regs[WM8785_R2] & WM8785_HPFR) != 0;
478 static int hpf_put(struct snd_kcontrol *ctl, struct snd_ctl_elem_value *value)
480 struct oxygen *chip = ctl->private_data;
481 struct generic_data *data = chip->model_data;
485 mutex_lock(&chip->mutex);
486 reg = data->wm8785_regs[WM8785_R2] & ~(WM8785_HPFR | WM8785_HPFL);
487 if (value->value.enumerated.item[0])
488 reg |= WM8785_HPFR | WM8785_HPFL;
489 changed = reg != data->wm8785_regs[WM8785_R2];
491 wm8785_write(chip, WM8785_R2, reg);
492 mutex_unlock(&chip->mutex);
496 static const struct snd_kcontrol_new hpf_control = {
497 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
498 .name = "ADC Filter Capture Enum",
504 static int generic_mixer_init(struct oxygen *chip)
506 return snd_ctl_add(chip->card, snd_ctl_new1(&rolloff_control, chip));
509 static int generic_wm8785_mixer_init(struct oxygen *chip)
513 err = generic_mixer_init(chip);
516 err = snd_ctl_add(chip->card, snd_ctl_new1(&hpf_control, chip));
522 static void dump_ak4396_registers(struct oxygen *chip,
523 struct snd_info_buffer *buffer)
525 struct generic_data *data = chip->model_data;
528 for (dac = 0; dac < data->dacs; ++dac) {
529 snd_iprintf(buffer, "\nAK4396 %u:", dac + 1);
530 for (i = 0; i < 5; ++i)
531 snd_iprintf(buffer, " %02x", data->ak4396_regs[dac][i]);
533 snd_iprintf(buffer, "\n");
536 static void dump_wm8785_registers(struct oxygen *chip,
537 struct snd_info_buffer *buffer)
539 struct generic_data *data = chip->model_data;
542 snd_iprintf(buffer, "\nWM8785:");
543 for (i = 0; i < 3; ++i)
544 snd_iprintf(buffer, " %03x", data->wm8785_regs[i]);
545 snd_iprintf(buffer, "\n");
548 static void dump_oxygen_registers(struct oxygen *chip,
549 struct snd_info_buffer *buffer)
551 dump_ak4396_registers(chip, buffer);
552 dump_wm8785_registers(chip, buffer);
555 static const DECLARE_TLV_DB_LINEAR(ak4396_db_scale, TLV_DB_GAIN_MUTE, 0);
557 static const struct oxygen_model model_generic = {
558 .shortname = "C-Media CMI8788",
559 .longname = "C-Media Oxygen HD Audio",
561 .init = generic_init,
562 .mixer_init = generic_wm8785_mixer_init,
563 .cleanup = generic_cleanup,
564 .resume = generic_resume,
565 .get_i2s_mclk = oxygen_default_i2s_mclk,
566 .set_dac_params = set_ak4396_params,
567 .set_adc_params = set_wm8785_params,
568 .update_dac_volume = update_ak4396_volume,
569 .update_dac_mute = update_ak4396_mute,
570 .dump_registers = dump_oxygen_registers,
571 .dac_tlv = ak4396_db_scale,
572 .model_data_size = sizeof(struct generic_data),
573 .device_config = PLAYBACK_0_TO_I2S |
574 PLAYBACK_1_TO_SPDIF |
575 PLAYBACK_2_TO_AC97_1 |
576 CAPTURE_0_FROM_I2S_1 |
577 CAPTURE_1_FROM_SPDIF |
578 CAPTURE_2_FROM_AC97_1 |
582 .dac_volume_max = 255,
583 .function_flags = OXYGEN_FUNCTION_SPI |
584 OXYGEN_FUNCTION_ENABLE_SPI_4_5,
585 .dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
586 .adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
589 static int __devinit get_oxygen_model(struct oxygen *chip,
590 const struct pci_device_id *id)
592 chip->model = model_generic;
593 switch (id->driver_data) {
595 chip->model.init = meridian_init;
596 chip->model.mixer_init = generic_mixer_init;
597 chip->model.resume = meridian_resume;
598 chip->model.set_adc_params = set_ak5385_params;
599 chip->model.dump_registers = dump_ak4396_registers;
600 chip->model.device_config = PLAYBACK_0_TO_I2S |
601 PLAYBACK_1_TO_SPDIF |
602 CAPTURE_0_FROM_I2S_2 |
603 CAPTURE_1_FROM_SPDIF;
606 chip->model.init = claro_init;
607 chip->model.cleanup = claro_cleanup;
608 chip->model.suspend = claro_suspend;
609 chip->model.resume = claro_resume;
611 case MODEL_CLARO_HALO:
612 chip->model.init = claro_halo_init;
613 chip->model.mixer_init = generic_mixer_init;
614 chip->model.cleanup = claro_cleanup;
615 chip->model.suspend = claro_suspend;
616 chip->model.resume = claro_resume;
617 chip->model.set_adc_params = set_ak5385_params;
618 chip->model.dump_registers = dump_ak4396_registers;
619 chip->model.device_config = PLAYBACK_0_TO_I2S |
620 PLAYBACK_1_TO_SPDIF |
621 CAPTURE_0_FROM_I2S_2 |
622 CAPTURE_1_FROM_SPDIF;
625 case MODEL_2CH_OUTPUT:
626 chip->model.shortname = "C-Media CMI8787";
627 chip->model.chip = "CMI8787";
628 if (id->driver_data == MODEL_FANTASIA)
629 chip->model.init = fantasia_init;
631 chip->model.init = stereo_output_init;
632 chip->model.resume = stereo_resume;
633 chip->model.mixer_init = generic_mixer_init;
634 chip->model.set_adc_params = set_no_params;
635 chip->model.dump_registers = dump_ak4396_registers;
636 chip->model.device_config = PLAYBACK_0_TO_I2S |
638 if (id->driver_data == MODEL_FANTASIA)
639 chip->model.device_config |= CAPTURE_0_FROM_I2S_1;
640 chip->model.dac_channels = 2;
643 if (id->driver_data == MODEL_MERIDIAN ||
644 id->driver_data == MODEL_CLARO_HALO) {
645 chip->model.misc_flags = OXYGEN_MISC_MIDI;
646 chip->model.device_config |= MIDI_OUTPUT | MIDI_INPUT;
651 static int __devinit generic_oxygen_probe(struct pci_dev *pci,
652 const struct pci_device_id *pci_id)
657 if (dev >= SNDRV_CARDS)
663 err = oxygen_pci_probe(pci, index[dev], id[dev], THIS_MODULE,
664 oxygen_ids, get_oxygen_model);
670 static struct pci_driver oxygen_driver = {
672 .id_table = oxygen_ids,
673 .probe = generic_oxygen_probe,
674 .remove = __devexit_p(oxygen_pci_remove),
676 .suspend = oxygen_pci_suspend,
677 .resume = oxygen_pci_resume,
681 static int __init alsa_card_oxygen_init(void)
683 return pci_register_driver(&oxygen_driver);
686 static void __exit alsa_card_oxygen_exit(void)
688 pci_unregister_driver(&oxygen_driver);
691 module_init(alsa_card_oxygen_init)
692 module_exit(alsa_card_oxygen_exit)