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 * LINE_OUT -> input of ADC
41 * GPO 0 -> route line-in (0) or AC97 output (1) to ADC input
44 #include <linux/delay.h>
45 #include <linux/mutex.h>
46 #include <linux/pci.h>
47 #include <sound/ac97_codec.h>
48 #include <sound/control.h>
49 #include <sound/core.h>
50 #include <sound/info.h>
51 #include <sound/initval.h>
52 #include <sound/pcm.h>
53 #include <sound/pcm_params.h>
54 #include <sound/tlv.h>
59 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
60 MODULE_DESCRIPTION("C-Media CMI8788 driver");
61 MODULE_LICENSE("GPL v2");
62 MODULE_SUPPORTED_DEVICE("{{C-Media,CMI8788}}");
64 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
65 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
66 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
68 module_param_array(index, int, NULL, 0444);
69 MODULE_PARM_DESC(index, "card index");
70 module_param_array(id, charp, NULL, 0444);
71 MODULE_PARM_DESC(id, "ID string");
72 module_param_array(enable, bool, NULL, 0444);
73 MODULE_PARM_DESC(enable, "enable card");
84 static DEFINE_PCI_DEVICE_TABLE(oxygen_ids) = {
85 /* C-Media's reference design */
86 { OXYGEN_PCI_SUBID(0x10b0, 0x0216), .driver_data = MODEL_CMEDIA_REF },
87 { OXYGEN_PCI_SUBID(0x10b0, 0x0218), .driver_data = MODEL_CMEDIA_REF },
88 { OXYGEN_PCI_SUBID(0x10b0, 0x0219), .driver_data = MODEL_CMEDIA_REF },
89 { OXYGEN_PCI_SUBID(0x13f6, 0x0001), .driver_data = MODEL_CMEDIA_REF },
90 { OXYGEN_PCI_SUBID(0x13f6, 0x0010), .driver_data = MODEL_CMEDIA_REF },
91 { OXYGEN_PCI_SUBID(0x13f6, 0x8788), .driver_data = MODEL_CMEDIA_REF },
92 { OXYGEN_PCI_SUBID(0x147a, 0xa017), .driver_data = MODEL_CMEDIA_REF },
93 { OXYGEN_PCI_SUBID(0x1a58, 0x0910), .driver_data = MODEL_CMEDIA_REF },
94 /* Kuroutoshikou CMI8787-HG2PCI */
95 { OXYGEN_PCI_SUBID(0x13f6, 0xffff), .driver_data = MODEL_2CH_OUTPUT },
96 /* TempoTec HiFier Fantasia */
97 { OXYGEN_PCI_SUBID(0x14c3, 0x1710), .driver_data = MODEL_FANTASIA },
98 /* TempoTec HiFier Serenade */
99 { OXYGEN_PCI_SUBID(0x14c3, 0x1711), .driver_data = MODEL_2CH_OUTPUT },
100 /* AuzenTech X-Meridian */
101 { OXYGEN_PCI_SUBID(0x415a, 0x5431), .driver_data = MODEL_MERIDIAN },
103 { OXYGEN_PCI_SUBID(0x7284, 0x9761), .driver_data = MODEL_CLARO },
104 /* HT-Omega Claro halo */
105 { OXYGEN_PCI_SUBID(0x7284, 0x9781), .driver_data = MODEL_CLARO_HALO },
108 MODULE_DEVICE_TABLE(pci, oxygen_ids);
111 #define GPIO_AK5385_DFS_MASK 0x0003
112 #define GPIO_AK5385_DFS_NORMAL 0x0000
113 #define GPIO_AK5385_DFS_DOUBLE 0x0001
114 #define GPIO_AK5385_DFS_QUAD 0x0002
116 #define GPIO_CLARO_HP 0x0100
118 struct generic_data {
120 u8 ak4396_regs[4][5];
124 static void ak4396_write(struct oxygen *chip, unsigned int codec,
127 /* maps ALSA channel pair number to SPI output */
128 static const u8 codec_spi_map[4] = {
131 struct generic_data *data = chip->model_data;
133 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER |
134 OXYGEN_SPI_DATA_LENGTH_2 |
135 OXYGEN_SPI_CLOCK_160 |
136 (codec_spi_map[codec] << OXYGEN_SPI_CODEC_SHIFT) |
137 OXYGEN_SPI_CEN_LATCH_CLOCK_HI,
138 AK4396_WRITE | (reg << 8) | value);
139 data->ak4396_regs[codec][reg] = value;
142 static void ak4396_write_cached(struct oxygen *chip, unsigned int codec,
145 struct generic_data *data = chip->model_data;
147 if (value != data->ak4396_regs[codec][reg])
148 ak4396_write(chip, codec, reg, value);
151 static void wm8785_write(struct oxygen *chip, u8 reg, unsigned int value)
153 struct generic_data *data = chip->model_data;
155 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER |
156 OXYGEN_SPI_DATA_LENGTH_2 |
157 OXYGEN_SPI_CLOCK_160 |
158 (3 << OXYGEN_SPI_CODEC_SHIFT) |
159 OXYGEN_SPI_CEN_LATCH_CLOCK_LO,
161 if (reg < ARRAY_SIZE(data->wm8785_regs))
162 data->wm8785_regs[reg] = value;
165 static void ak4396_registers_init(struct oxygen *chip)
167 struct generic_data *data = chip->model_data;
170 for (i = 0; i < data->dacs; ++i) {
171 ak4396_write(chip, i, AK4396_CONTROL_1,
172 AK4396_DIF_24_MSB | AK4396_RSTN);
173 ak4396_write(chip, i, AK4396_CONTROL_2,
174 data->ak4396_regs[0][AK4396_CONTROL_2]);
175 ak4396_write(chip, i, AK4396_CONTROL_3,
177 ak4396_write(chip, i, AK4396_LCH_ATT,
178 chip->dac_volume[i * 2]);
179 ak4396_write(chip, i, AK4396_RCH_ATT,
180 chip->dac_volume[i * 2 + 1]);
184 static void ak4396_init(struct oxygen *chip)
186 struct generic_data *data = chip->model_data;
188 data->dacs = chip->model.dac_channels / 2;
189 data->ak4396_regs[0][AK4396_CONTROL_2] =
190 AK4396_SMUTE | AK4396_DEM_OFF | AK4396_DFS_NORMAL;
191 ak4396_registers_init(chip);
192 snd_component_add(chip->card, "AK4396");
195 static void ak5385_init(struct oxygen *chip)
197 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_AK5385_DFS_MASK);
198 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_AK5385_DFS_MASK);
199 snd_component_add(chip->card, "AK5385");
202 static void wm8785_registers_init(struct oxygen *chip)
204 struct generic_data *data = chip->model_data;
206 wm8785_write(chip, WM8785_R7, 0);
207 wm8785_write(chip, WM8785_R0, data->wm8785_regs[0]);
208 wm8785_write(chip, WM8785_R2, data->wm8785_regs[2]);
211 static void wm8785_init(struct oxygen *chip)
213 struct generic_data *data = chip->model_data;
215 data->wm8785_regs[0] =
216 WM8785_MCR_SLAVE | WM8785_OSR_SINGLE | WM8785_FORMAT_LJUST;
217 data->wm8785_regs[2] = WM8785_HPFR | WM8785_HPFL;
218 wm8785_registers_init(chip);
219 snd_component_add(chip->card, "WM8785");
222 static void generic_init(struct oxygen *chip)
228 static void meridian_init(struct oxygen *chip)
234 static void claro_enable_hp(struct oxygen *chip)
237 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_CLARO_HP);
238 oxygen_set_bits16(chip, OXYGEN_GPIO_DATA, GPIO_CLARO_HP);
241 static void claro_init(struct oxygen *chip)
245 claro_enable_hp(chip);
248 static void claro_halo_init(struct oxygen *chip)
252 claro_enable_hp(chip);
255 static void fantasia_init(struct oxygen *chip)
258 snd_component_add(chip->card, "CS5340");
261 static void stereo_output_init(struct oxygen *chip)
266 static void generic_cleanup(struct oxygen *chip)
270 static void claro_disable_hp(struct oxygen *chip)
272 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_CLARO_HP);
275 static void claro_cleanup(struct oxygen *chip)
277 claro_disable_hp(chip);
280 static void claro_suspend(struct oxygen *chip)
282 claro_disable_hp(chip);
285 static void generic_resume(struct oxygen *chip)
287 ak4396_registers_init(chip);
288 wm8785_registers_init(chip);
291 static void meridian_resume(struct oxygen *chip)
293 ak4396_registers_init(chip);
296 static void claro_resume(struct oxygen *chip)
298 ak4396_registers_init(chip);
299 claro_enable_hp(chip);
302 static void stereo_resume(struct oxygen *chip)
304 ak4396_registers_init(chip);
307 static void set_ak4396_params(struct oxygen *chip,
308 struct snd_pcm_hw_params *params)
310 struct generic_data *data = chip->model_data;
314 value = data->ak4396_regs[0][AK4396_CONTROL_2] & ~AK4396_DFS_MASK;
315 if (params_rate(params) <= 54000)
316 value |= AK4396_DFS_NORMAL;
317 else if (params_rate(params) <= 108000)
318 value |= AK4396_DFS_DOUBLE;
320 value |= AK4396_DFS_QUAD;
322 msleep(1); /* wait for the new MCLK to become stable */
324 if (value != data->ak4396_regs[0][AK4396_CONTROL_2]) {
325 for (i = 0; i < data->dacs; ++i) {
326 ak4396_write(chip, i, AK4396_CONTROL_1,
328 ak4396_write(chip, i, AK4396_CONTROL_2, value);
329 ak4396_write(chip, i, AK4396_CONTROL_1,
330 AK4396_DIF_24_MSB | AK4396_RSTN);
335 static void update_ak4396_volume(struct oxygen *chip)
337 struct generic_data *data = chip->model_data;
340 for (i = 0; i < data->dacs; ++i) {
341 ak4396_write_cached(chip, i, AK4396_LCH_ATT,
342 chip->dac_volume[i * 2]);
343 ak4396_write_cached(chip, i, AK4396_RCH_ATT,
344 chip->dac_volume[i * 2 + 1]);
348 static void update_ak4396_mute(struct oxygen *chip)
350 struct generic_data *data = chip->model_data;
354 value = data->ak4396_regs[0][AK4396_CONTROL_2] & ~AK4396_SMUTE;
356 value |= AK4396_SMUTE;
357 for (i = 0; i < data->dacs; ++i)
358 ak4396_write_cached(chip, i, AK4396_CONTROL_2, value);
361 static void set_wm8785_params(struct oxygen *chip,
362 struct snd_pcm_hw_params *params)
364 struct generic_data *data = chip->model_data;
367 value = WM8785_MCR_SLAVE | WM8785_FORMAT_LJUST;
368 if (params_rate(params) <= 48000)
369 value |= WM8785_OSR_SINGLE;
370 else if (params_rate(params) <= 96000)
371 value |= WM8785_OSR_DOUBLE;
373 value |= WM8785_OSR_QUAD;
374 if (value != data->wm8785_regs[0]) {
375 wm8785_write(chip, WM8785_R7, 0);
376 wm8785_write(chip, WM8785_R0, value);
377 wm8785_write(chip, WM8785_R2, data->wm8785_regs[2]);
381 static void set_ak5385_params(struct oxygen *chip,
382 struct snd_pcm_hw_params *params)
386 if (params_rate(params) <= 54000)
387 value = GPIO_AK5385_DFS_NORMAL;
388 else if (params_rate(params) <= 108000)
389 value = GPIO_AK5385_DFS_DOUBLE;
391 value = GPIO_AK5385_DFS_QUAD;
392 oxygen_write16_masked(chip, OXYGEN_GPIO_DATA,
393 value, GPIO_AK5385_DFS_MASK);
396 static void set_no_params(struct oxygen *chip, struct snd_pcm_hw_params *params)
400 static int rolloff_info(struct snd_kcontrol *ctl,
401 struct snd_ctl_elem_info *info)
403 static const char *const names[2] = {
404 "Sharp Roll-off", "Slow Roll-off"
407 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
409 info->value.enumerated.items = 2;
410 if (info->value.enumerated.item >= 2)
411 info->value.enumerated.item = 1;
412 strcpy(info->value.enumerated.name, names[info->value.enumerated.item]);
416 static int rolloff_get(struct snd_kcontrol *ctl,
417 struct snd_ctl_elem_value *value)
419 struct oxygen *chip = ctl->private_data;
420 struct generic_data *data = chip->model_data;
422 value->value.enumerated.item[0] =
423 (data->ak4396_regs[0][AK4396_CONTROL_2] & AK4396_SLOW) != 0;
427 static int rolloff_put(struct snd_kcontrol *ctl,
428 struct snd_ctl_elem_value *value)
430 struct oxygen *chip = ctl->private_data;
431 struct generic_data *data = chip->model_data;
436 mutex_lock(&chip->mutex);
437 reg = data->ak4396_regs[0][AK4396_CONTROL_2];
438 if (value->value.enumerated.item[0])
442 changed = reg != data->ak4396_regs[0][AK4396_CONTROL_2];
444 for (i = 0; i < data->dacs; ++i)
445 ak4396_write(chip, i, AK4396_CONTROL_2, reg);
447 mutex_unlock(&chip->mutex);
451 static const struct snd_kcontrol_new rolloff_control = {
452 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
453 .name = "DAC Filter Playback Enum",
454 .info = rolloff_info,
459 static int hpf_info(struct snd_kcontrol *ctl, struct snd_ctl_elem_info *info)
461 static const char *const names[2] = {
462 "None", "High-pass Filter"
465 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
467 info->value.enumerated.items = 2;
468 if (info->value.enumerated.item >= 2)
469 info->value.enumerated.item = 1;
470 strcpy(info->value.enumerated.name, names[info->value.enumerated.item]);
474 static int hpf_get(struct snd_kcontrol *ctl, struct snd_ctl_elem_value *value)
476 struct oxygen *chip = ctl->private_data;
477 struct generic_data *data = chip->model_data;
479 value->value.enumerated.item[0] =
480 (data->wm8785_regs[WM8785_R2] & WM8785_HPFR) != 0;
484 static int hpf_put(struct snd_kcontrol *ctl, struct snd_ctl_elem_value *value)
486 struct oxygen *chip = ctl->private_data;
487 struct generic_data *data = chip->model_data;
491 mutex_lock(&chip->mutex);
492 reg = data->wm8785_regs[WM8785_R2] & ~(WM8785_HPFR | WM8785_HPFL);
493 if (value->value.enumerated.item[0])
494 reg |= WM8785_HPFR | WM8785_HPFL;
495 changed = reg != data->wm8785_regs[WM8785_R2];
497 wm8785_write(chip, WM8785_R2, reg);
498 mutex_unlock(&chip->mutex);
502 static const struct snd_kcontrol_new hpf_control = {
503 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
504 .name = "ADC Filter Capture Enum",
510 static int generic_mixer_init(struct oxygen *chip)
512 return snd_ctl_add(chip->card, snd_ctl_new1(&rolloff_control, chip));
515 static int generic_wm8785_mixer_init(struct oxygen *chip)
519 err = generic_mixer_init(chip);
522 err = snd_ctl_add(chip->card, snd_ctl_new1(&hpf_control, chip));
528 static void dump_ak4396_registers(struct oxygen *chip,
529 struct snd_info_buffer *buffer)
531 struct generic_data *data = chip->model_data;
534 for (dac = 0; dac < data->dacs; ++dac) {
535 snd_iprintf(buffer, "\nAK4396 %u:", dac + 1);
536 for (i = 0; i < 5; ++i)
537 snd_iprintf(buffer, " %02x", data->ak4396_regs[dac][i]);
539 snd_iprintf(buffer, "\n");
542 static void dump_wm8785_registers(struct oxygen *chip,
543 struct snd_info_buffer *buffer)
545 struct generic_data *data = chip->model_data;
548 snd_iprintf(buffer, "\nWM8785:");
549 for (i = 0; i < 3; ++i)
550 snd_iprintf(buffer, " %03x", data->wm8785_regs[i]);
551 snd_iprintf(buffer, "\n");
554 static void dump_oxygen_registers(struct oxygen *chip,
555 struct snd_info_buffer *buffer)
557 dump_ak4396_registers(chip, buffer);
558 dump_wm8785_registers(chip, buffer);
561 static const DECLARE_TLV_DB_LINEAR(ak4396_db_scale, TLV_DB_GAIN_MUTE, 0);
563 static const struct oxygen_model model_generic = {
564 .shortname = "C-Media CMI8788",
565 .longname = "C-Media Oxygen HD Audio",
567 .init = generic_init,
568 .mixer_init = generic_wm8785_mixer_init,
569 .cleanup = generic_cleanup,
570 .resume = generic_resume,
571 .get_i2s_mclk = oxygen_default_i2s_mclk,
572 .set_dac_params = set_ak4396_params,
573 .set_adc_params = set_wm8785_params,
574 .update_dac_volume = update_ak4396_volume,
575 .update_dac_mute = update_ak4396_mute,
576 .dump_registers = dump_oxygen_registers,
577 .dac_tlv = ak4396_db_scale,
578 .model_data_size = sizeof(struct generic_data),
579 .device_config = PLAYBACK_0_TO_I2S |
580 PLAYBACK_1_TO_SPDIF |
581 PLAYBACK_2_TO_AC97_1 |
582 CAPTURE_0_FROM_I2S_1 |
583 CAPTURE_1_FROM_SPDIF |
584 CAPTURE_2_FROM_AC97_1 |
588 .dac_volume_max = 255,
589 .function_flags = OXYGEN_FUNCTION_SPI |
590 OXYGEN_FUNCTION_ENABLE_SPI_4_5,
591 .dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
592 .adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
595 static int __devinit get_oxygen_model(struct oxygen *chip,
596 const struct pci_device_id *id)
598 chip->model = model_generic;
599 switch (id->driver_data) {
601 chip->model.init = meridian_init;
602 chip->model.mixer_init = generic_mixer_init;
603 chip->model.resume = meridian_resume;
604 chip->model.set_adc_params = set_ak5385_params;
605 chip->model.dump_registers = dump_ak4396_registers;
606 chip->model.device_config = PLAYBACK_0_TO_I2S |
607 PLAYBACK_1_TO_SPDIF |
608 CAPTURE_0_FROM_I2S_2 |
609 CAPTURE_1_FROM_SPDIF;
612 chip->model.init = claro_init;
613 chip->model.cleanup = claro_cleanup;
614 chip->model.suspend = claro_suspend;
615 chip->model.resume = claro_resume;
617 case MODEL_CLARO_HALO:
618 chip->model.init = claro_halo_init;
619 chip->model.mixer_init = generic_mixer_init;
620 chip->model.cleanup = claro_cleanup;
621 chip->model.suspend = claro_suspend;
622 chip->model.resume = claro_resume;
623 chip->model.set_adc_params = set_ak5385_params;
624 chip->model.dump_registers = dump_ak4396_registers;
625 chip->model.device_config = PLAYBACK_0_TO_I2S |
626 PLAYBACK_1_TO_SPDIF |
627 CAPTURE_0_FROM_I2S_2 |
628 CAPTURE_1_FROM_SPDIF;
631 case MODEL_2CH_OUTPUT:
632 chip->model.shortname = "C-Media CMI8787";
633 chip->model.chip = "CMI8787";
634 if (id->driver_data == MODEL_FANTASIA)
635 chip->model.init = fantasia_init;
637 chip->model.init = stereo_output_init;
638 chip->model.resume = stereo_resume;
639 chip->model.mixer_init = generic_mixer_init;
640 chip->model.set_adc_params = set_no_params;
641 chip->model.dump_registers = dump_ak4396_registers;
642 chip->model.device_config = PLAYBACK_0_TO_I2S |
644 if (id->driver_data == MODEL_FANTASIA)
645 chip->model.device_config |= CAPTURE_0_FROM_I2S_1;
646 chip->model.dac_channels = 2;
649 if (id->driver_data == MODEL_MERIDIAN ||
650 id->driver_data == MODEL_CLARO_HALO) {
651 chip->model.misc_flags = OXYGEN_MISC_MIDI;
652 chip->model.device_config |= MIDI_OUTPUT | MIDI_INPUT;
657 static int __devinit generic_oxygen_probe(struct pci_dev *pci,
658 const struct pci_device_id *pci_id)
663 if (dev >= SNDRV_CARDS)
669 err = oxygen_pci_probe(pci, index[dev], id[dev], THIS_MODULE,
670 oxygen_ids, get_oxygen_model);
676 static struct pci_driver oxygen_driver = {
678 .id_table = oxygen_ids,
679 .probe = generic_oxygen_probe,
680 .remove = __devexit_p(oxygen_pci_remove),
682 .suspend = oxygen_pci_suspend,
683 .resume = oxygen_pci_resume,
687 static int __init alsa_card_oxygen_init(void)
689 return pci_register_driver(&oxygen_driver);
692 static void __exit alsa_card_oxygen_exit(void)
694 pci_unregister_driver(&oxygen_driver);
697 module_init(alsa_card_oxygen_init)
698 module_exit(alsa_card_oxygen_exit)