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/initval.h>
45 #include <sound/pcm.h>
46 #include <sound/pcm_params.h>
47 #include <sound/tlv.h>
52 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
53 MODULE_DESCRIPTION("C-Media CMI8788 driver");
54 MODULE_LICENSE("GPL v2");
55 MODULE_SUPPORTED_DEVICE("{{C-Media,CMI8788}}");
57 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
58 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
59 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
61 module_param_array(index, int, NULL, 0444);
62 MODULE_PARM_DESC(index, "card index");
63 module_param_array(id, charp, NULL, 0444);
64 MODULE_PARM_DESC(id, "ID string");
65 module_param_array(enable, bool, NULL, 0444);
66 MODULE_PARM_DESC(enable, "enable card");
69 MODEL_CMEDIA_REF, /* C-Media's reference design */
70 MODEL_MERIDIAN, /* AuzenTech X-Meridian */
71 MODEL_CLARO, /* HT-Omega Claro */
72 MODEL_CLARO_HALO, /* HT-Omega Claro halo */
73 MODEL_HIFIER, /* TempoTec HiFier Fantasia */
74 MODEL_HG2PCI, /* Kuroutoshikou CMI8787-HG2PCI */
77 static DEFINE_PCI_DEVICE_TABLE(oxygen_ids) = {
78 { OXYGEN_PCI_SUBID(0x10b0, 0x0216), .driver_data = MODEL_CMEDIA_REF },
79 { OXYGEN_PCI_SUBID(0x10b0, 0x0218), .driver_data = MODEL_CMEDIA_REF },
80 { OXYGEN_PCI_SUBID(0x10b0, 0x0219), .driver_data = MODEL_CMEDIA_REF },
81 { OXYGEN_PCI_SUBID(0x13f6, 0x0001), .driver_data = MODEL_CMEDIA_REF },
82 { OXYGEN_PCI_SUBID(0x13f6, 0x0010), .driver_data = MODEL_CMEDIA_REF },
83 { OXYGEN_PCI_SUBID(0x13f6, 0x8788), .driver_data = MODEL_CMEDIA_REF },
84 { OXYGEN_PCI_SUBID(0x13f6, 0xffff), .driver_data = MODEL_HG2PCI },
85 { OXYGEN_PCI_SUBID(0x147a, 0xa017), .driver_data = MODEL_CMEDIA_REF },
86 { OXYGEN_PCI_SUBID(0x14c3, 0x1710), .driver_data = MODEL_HIFIER },
87 { OXYGEN_PCI_SUBID(0x14c3, 0x1711), .driver_data = MODEL_HIFIER },
88 { OXYGEN_PCI_SUBID(0x1a58, 0x0910), .driver_data = MODEL_CMEDIA_REF },
89 { OXYGEN_PCI_SUBID(0x415a, 0x5431), .driver_data = MODEL_MERIDIAN },
90 { OXYGEN_PCI_SUBID(0x7284, 0x9761), .driver_data = MODEL_CLARO },
91 { OXYGEN_PCI_SUBID(0x7284, 0x9781), .driver_data = MODEL_CLARO_HALO },
94 MODULE_DEVICE_TABLE(pci, oxygen_ids);
97 #define GPIO_AK5385_DFS_MASK 0x0003
98 #define GPIO_AK5385_DFS_NORMAL 0x0000
99 #define GPIO_AK5385_DFS_DOUBLE 0x0001
100 #define GPIO_AK5385_DFS_QUAD 0x0002
102 #define GPIO_CLARO_HP 0x0100
104 struct generic_data {
106 u8 ak4396_regs[4][5];
110 static void ak4396_write(struct oxygen *chip, unsigned int codec,
113 /* maps ALSA channel pair number to SPI output */
114 static const u8 codec_spi_map[4] = {
117 struct generic_data *data = chip->model_data;
119 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER |
120 OXYGEN_SPI_DATA_LENGTH_2 |
121 OXYGEN_SPI_CLOCK_160 |
122 (codec_spi_map[codec] << OXYGEN_SPI_CODEC_SHIFT) |
123 OXYGEN_SPI_CEN_LATCH_CLOCK_HI,
124 AK4396_WRITE | (reg << 8) | value);
125 data->ak4396_regs[codec][reg] = value;
128 static void ak4396_write_cached(struct oxygen *chip, unsigned int codec,
131 struct generic_data *data = chip->model_data;
133 if (value != data->ak4396_regs[codec][reg])
134 ak4396_write(chip, codec, reg, value);
137 static void wm8785_write(struct oxygen *chip, u8 reg, unsigned int value)
139 struct generic_data *data = chip->model_data;
141 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER |
142 OXYGEN_SPI_DATA_LENGTH_2 |
143 OXYGEN_SPI_CLOCK_160 |
144 (3 << OXYGEN_SPI_CODEC_SHIFT) |
145 OXYGEN_SPI_CEN_LATCH_CLOCK_LO,
147 if (reg < ARRAY_SIZE(data->wm8785_regs))
148 data->wm8785_regs[reg] = value;
151 static void ak4396_registers_init(struct oxygen *chip)
153 struct generic_data *data = chip->model_data;
156 for (i = 0; i < data->dacs; ++i) {
157 ak4396_write(chip, i, AK4396_CONTROL_1,
158 AK4396_DIF_24_MSB | AK4396_RSTN);
159 ak4396_write(chip, i, AK4396_CONTROL_2,
160 data->ak4396_regs[0][AK4396_CONTROL_2]);
161 ak4396_write(chip, i, AK4396_CONTROL_3,
163 ak4396_write(chip, i, AK4396_LCH_ATT,
164 chip->dac_volume[i * 2]);
165 ak4396_write(chip, i, AK4396_RCH_ATT,
166 chip->dac_volume[i * 2 + 1]);
170 static void ak4396_init(struct oxygen *chip)
172 struct generic_data *data = chip->model_data;
174 data->dacs = chip->model.dac_channels / 2;
175 data->ak4396_regs[0][AK4396_CONTROL_2] =
176 AK4396_SMUTE | AK4396_DEM_OFF | AK4396_DFS_NORMAL;
177 ak4396_registers_init(chip);
178 snd_component_add(chip->card, "AK4396");
181 static void ak5385_init(struct oxygen *chip)
183 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_AK5385_DFS_MASK);
184 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_AK5385_DFS_MASK);
185 snd_component_add(chip->card, "AK5385");
188 static void wm8785_registers_init(struct oxygen *chip)
190 struct generic_data *data = chip->model_data;
192 wm8785_write(chip, WM8785_R7, 0);
193 wm8785_write(chip, WM8785_R0, data->wm8785_regs[0]);
194 wm8785_write(chip, WM8785_R2, data->wm8785_regs[2]);
197 static void wm8785_init(struct oxygen *chip)
199 struct generic_data *data = chip->model_data;
201 data->wm8785_regs[0] =
202 WM8785_MCR_SLAVE | WM8785_OSR_SINGLE | WM8785_FORMAT_LJUST;
203 data->wm8785_regs[2] = WM8785_HPFR | WM8785_HPFL;
204 wm8785_registers_init(chip);
205 snd_component_add(chip->card, "WM8785");
208 static void generic_init(struct oxygen *chip)
214 static void meridian_init(struct oxygen *chip)
220 static void claro_enable_hp(struct oxygen *chip)
223 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_CLARO_HP);
224 oxygen_set_bits16(chip, OXYGEN_GPIO_DATA, GPIO_CLARO_HP);
227 static void claro_init(struct oxygen *chip)
231 claro_enable_hp(chip);
234 static void claro_halo_init(struct oxygen *chip)
238 claro_enable_hp(chip);
241 static void hifier_init(struct oxygen *chip)
244 snd_component_add(chip->card, "CS5340");
247 static void hg2pci_init(struct oxygen *chip)
252 static void generic_cleanup(struct oxygen *chip)
256 static void claro_disable_hp(struct oxygen *chip)
258 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_CLARO_HP);
261 static void claro_cleanup(struct oxygen *chip)
263 claro_disable_hp(chip);
266 static void claro_suspend(struct oxygen *chip)
268 claro_disable_hp(chip);
271 static void generic_resume(struct oxygen *chip)
273 ak4396_registers_init(chip);
274 wm8785_registers_init(chip);
277 static void meridian_resume(struct oxygen *chip)
279 ak4396_registers_init(chip);
282 static void claro_resume(struct oxygen *chip)
284 ak4396_registers_init(chip);
285 claro_enable_hp(chip);
288 static void stereo_resume(struct oxygen *chip)
290 ak4396_registers_init(chip);
293 static void set_ak4396_params(struct oxygen *chip,
294 struct snd_pcm_hw_params *params)
296 struct generic_data *data = chip->model_data;
300 value = data->ak4396_regs[0][AK4396_CONTROL_2] & ~AK4396_DFS_MASK;
301 if (params_rate(params) <= 54000)
302 value |= AK4396_DFS_NORMAL;
303 else if (params_rate(params) <= 108000)
304 value |= AK4396_DFS_DOUBLE;
306 value |= AK4396_DFS_QUAD;
308 msleep(1); /* wait for the new MCLK to become stable */
310 if (value != data->ak4396_regs[0][AK4396_CONTROL_2]) {
311 for (i = 0; i < data->dacs; ++i) {
312 ak4396_write(chip, i, AK4396_CONTROL_1,
314 ak4396_write(chip, i, AK4396_CONTROL_2, value);
315 ak4396_write(chip, i, AK4396_CONTROL_1,
316 AK4396_DIF_24_MSB | AK4396_RSTN);
321 static void update_ak4396_volume(struct oxygen *chip)
323 struct generic_data *data = chip->model_data;
326 for (i = 0; i < data->dacs; ++i) {
327 ak4396_write_cached(chip, i, AK4396_LCH_ATT,
328 chip->dac_volume[i * 2]);
329 ak4396_write_cached(chip, i, AK4396_RCH_ATT,
330 chip->dac_volume[i * 2 + 1]);
334 static void update_ak4396_mute(struct oxygen *chip)
336 struct generic_data *data = chip->model_data;
340 value = data->ak4396_regs[0][AK4396_CONTROL_2] & ~AK4396_SMUTE;
342 value |= AK4396_SMUTE;
343 for (i = 0; i < data->dacs; ++i)
344 ak4396_write_cached(chip, i, AK4396_CONTROL_2, value);
347 static void set_wm8785_params(struct oxygen *chip,
348 struct snd_pcm_hw_params *params)
350 struct generic_data *data = chip->model_data;
353 value = WM8785_MCR_SLAVE | WM8785_FORMAT_LJUST;
354 if (params_rate(params) <= 48000)
355 value |= WM8785_OSR_SINGLE;
356 else if (params_rate(params) <= 96000)
357 value |= WM8785_OSR_DOUBLE;
359 value |= WM8785_OSR_QUAD;
360 if (value != data->wm8785_regs[0]) {
361 wm8785_write(chip, WM8785_R7, 0);
362 wm8785_write(chip, WM8785_R0, value);
363 wm8785_write(chip, WM8785_R2, data->wm8785_regs[2]);
367 static void set_ak5385_params(struct oxygen *chip,
368 struct snd_pcm_hw_params *params)
372 if (params_rate(params) <= 54000)
373 value = GPIO_AK5385_DFS_NORMAL;
374 else if (params_rate(params) <= 108000)
375 value = GPIO_AK5385_DFS_DOUBLE;
377 value = GPIO_AK5385_DFS_QUAD;
378 oxygen_write16_masked(chip, OXYGEN_GPIO_DATA,
379 value, GPIO_AK5385_DFS_MASK);
382 static void set_no_params(struct oxygen *chip, struct snd_pcm_hw_params *params)
386 static int rolloff_info(struct snd_kcontrol *ctl,
387 struct snd_ctl_elem_info *info)
389 static const char *const names[2] = {
390 "Sharp Roll-off", "Slow Roll-off"
393 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
395 info->value.enumerated.items = 2;
396 if (info->value.enumerated.item >= 2)
397 info->value.enumerated.item = 1;
398 strcpy(info->value.enumerated.name, names[info->value.enumerated.item]);
402 static int rolloff_get(struct snd_kcontrol *ctl,
403 struct snd_ctl_elem_value *value)
405 struct oxygen *chip = ctl->private_data;
406 struct generic_data *data = chip->model_data;
408 value->value.enumerated.item[0] =
409 (data->ak4396_regs[0][AK4396_CONTROL_2] & AK4396_SLOW) != 0;
413 static int rolloff_put(struct snd_kcontrol *ctl,
414 struct snd_ctl_elem_value *value)
416 struct oxygen *chip = ctl->private_data;
417 struct generic_data *data = chip->model_data;
422 mutex_lock(&chip->mutex);
423 reg = data->ak4396_regs[0][AK4396_CONTROL_2];
424 if (value->value.enumerated.item[0])
428 changed = reg != data->ak4396_regs[0][AK4396_CONTROL_2];
430 for (i = 0; i < data->dacs; ++i)
431 ak4396_write(chip, i, AK4396_CONTROL_2, reg);
433 mutex_unlock(&chip->mutex);
437 static const struct snd_kcontrol_new rolloff_control = {
438 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
439 .name = "DAC Filter Playback Enum",
440 .info = rolloff_info,
445 static int hpf_info(struct snd_kcontrol *ctl, struct snd_ctl_elem_info *info)
447 static const char *const names[2] = {
448 "None", "High-pass Filter"
451 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
453 info->value.enumerated.items = 2;
454 if (info->value.enumerated.item >= 2)
455 info->value.enumerated.item = 1;
456 strcpy(info->value.enumerated.name, names[info->value.enumerated.item]);
460 static int hpf_get(struct snd_kcontrol *ctl, struct snd_ctl_elem_value *value)
462 struct oxygen *chip = ctl->private_data;
463 struct generic_data *data = chip->model_data;
465 value->value.enumerated.item[0] =
466 (data->wm8785_regs[WM8785_R2] & WM8785_HPFR) != 0;
470 static int hpf_put(struct snd_kcontrol *ctl, struct snd_ctl_elem_value *value)
472 struct oxygen *chip = ctl->private_data;
473 struct generic_data *data = chip->model_data;
477 mutex_lock(&chip->mutex);
478 reg = data->wm8785_regs[WM8785_R2] & ~(WM8785_HPFR | WM8785_HPFL);
479 if (value->value.enumerated.item[0])
480 reg |= WM8785_HPFR | WM8785_HPFL;
481 changed = reg != data->wm8785_regs[WM8785_R2];
483 wm8785_write(chip, WM8785_R2, reg);
484 mutex_unlock(&chip->mutex);
488 static const struct snd_kcontrol_new hpf_control = {
489 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
490 .name = "ADC Filter Capture Enum",
496 static int generic_mixer_init(struct oxygen *chip)
498 return snd_ctl_add(chip->card, snd_ctl_new1(&rolloff_control, chip));
501 static int generic_wm8785_mixer_init(struct oxygen *chip)
505 err = generic_mixer_init(chip);
508 err = snd_ctl_add(chip->card, snd_ctl_new1(&hpf_control, chip));
514 static const DECLARE_TLV_DB_LINEAR(ak4396_db_scale, TLV_DB_GAIN_MUTE, 0);
516 static const struct oxygen_model model_generic = {
517 .shortname = "C-Media CMI8788",
518 .longname = "C-Media Oxygen HD Audio",
520 .init = generic_init,
521 .mixer_init = generic_wm8785_mixer_init,
522 .cleanup = generic_cleanup,
523 .resume = generic_resume,
524 .get_i2s_mclk = oxygen_default_i2s_mclk,
525 .set_dac_params = set_ak4396_params,
526 .set_adc_params = set_wm8785_params,
527 .update_dac_volume = update_ak4396_volume,
528 .update_dac_mute = update_ak4396_mute,
529 .dac_tlv = ak4396_db_scale,
530 .model_data_size = sizeof(struct generic_data),
531 .device_config = PLAYBACK_0_TO_I2S |
532 PLAYBACK_1_TO_SPDIF |
533 PLAYBACK_2_TO_AC97_1 |
534 CAPTURE_0_FROM_I2S_1 |
535 CAPTURE_1_FROM_SPDIF |
536 CAPTURE_2_FROM_AC97_1 |
540 .dac_volume_max = 255,
541 .function_flags = OXYGEN_FUNCTION_SPI |
542 OXYGEN_FUNCTION_ENABLE_SPI_4_5,
543 .dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
544 .adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
547 static int __devinit get_oxygen_model(struct oxygen *chip,
548 const struct pci_device_id *id)
550 chip->model = model_generic;
551 switch (id->driver_data) {
553 chip->model.init = meridian_init;
554 chip->model.mixer_init = generic_mixer_init;
555 chip->model.resume = meridian_resume;
556 chip->model.set_adc_params = set_ak5385_params;
557 chip->model.device_config = PLAYBACK_0_TO_I2S |
558 PLAYBACK_1_TO_SPDIF |
559 CAPTURE_0_FROM_I2S_2 |
560 CAPTURE_1_FROM_SPDIF;
563 chip->model.init = claro_init;
564 chip->model.cleanup = claro_cleanup;
565 chip->model.suspend = claro_suspend;
566 chip->model.resume = claro_resume;
568 case MODEL_CLARO_HALO:
569 chip->model.init = claro_halo_init;
570 chip->model.mixer_init = generic_mixer_init;
571 chip->model.cleanup = claro_cleanup;
572 chip->model.suspend = claro_suspend;
573 chip->model.resume = claro_resume;
574 chip->model.set_adc_params = set_ak5385_params;
575 chip->model.device_config = PLAYBACK_0_TO_I2S |
576 PLAYBACK_1_TO_SPDIF |
577 CAPTURE_0_FROM_I2S_2 |
578 CAPTURE_1_FROM_SPDIF;
582 chip->model.shortname = "C-Media CMI8787";
583 chip->model.chip = "CMI8787";
584 if (id->driver_data == MODEL_HIFIER)
585 chip->model.init = hifier_init;
587 chip->model.init = hg2pci_init;
588 chip->model.resume = stereo_resume;
589 chip->model.mixer_init = generic_mixer_init;
590 chip->model.set_adc_params = set_no_params;
591 chip->model.device_config = PLAYBACK_0_TO_I2S |
593 if (id->driver_data == MODEL_HIFIER)
594 chip->model.device_config |= CAPTURE_0_FROM_I2S_1;
595 chip->model.dac_channels = 2;
598 if (id->driver_data == MODEL_MERIDIAN ||
599 id->driver_data == MODEL_CLARO_HALO) {
600 chip->model.misc_flags = OXYGEN_MISC_MIDI;
601 chip->model.device_config |= MIDI_OUTPUT | MIDI_INPUT;
606 static int __devinit generic_oxygen_probe(struct pci_dev *pci,
607 const struct pci_device_id *pci_id)
612 if (dev >= SNDRV_CARDS)
618 err = oxygen_pci_probe(pci, index[dev], id[dev], THIS_MODULE,
619 oxygen_ids, get_oxygen_model);
625 static struct pci_driver oxygen_driver = {
627 .id_table = oxygen_ids,
628 .probe = generic_oxygen_probe,
629 .remove = __devexit_p(oxygen_pci_remove),
631 .suspend = oxygen_pci_suspend,
632 .resume = oxygen_pci_resume,
636 static int __init alsa_card_oxygen_init(void)
638 return pci_register_driver(&oxygen_driver);
641 static void __exit alsa_card_oxygen_exit(void)
643 pci_unregister_driver(&oxygen_driver);
646 module_init(alsa_card_oxygen_init)
647 module_exit(alsa_card_oxygen_exit)