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");
77 static DEFINE_PCI_DEVICE_TABLE(oxygen_ids) = {
78 /* C-Media's reference design */
79 { OXYGEN_PCI_SUBID(0x10b0, 0x0216), .driver_data = MODEL_CMEDIA_REF },
80 { OXYGEN_PCI_SUBID(0x10b0, 0x0218), .driver_data = MODEL_CMEDIA_REF },
81 { OXYGEN_PCI_SUBID(0x10b0, 0x0219), .driver_data = MODEL_CMEDIA_REF },
82 { OXYGEN_PCI_SUBID(0x13f6, 0x0001), .driver_data = MODEL_CMEDIA_REF },
83 { OXYGEN_PCI_SUBID(0x13f6, 0x0010), .driver_data = MODEL_CMEDIA_REF },
84 { OXYGEN_PCI_SUBID(0x13f6, 0x8788), .driver_data = MODEL_CMEDIA_REF },
85 { OXYGEN_PCI_SUBID(0x147a, 0xa017), .driver_data = MODEL_CMEDIA_REF },
86 { OXYGEN_PCI_SUBID(0x1a58, 0x0910), .driver_data = MODEL_CMEDIA_REF },
87 /* Kuroutoshikou CMI8787-HG2PCI */
88 { OXYGEN_PCI_SUBID(0x13f6, 0xffff), .driver_data = MODEL_HG2PCI },
89 /* TempoTec HiFier Fantasia */
90 { OXYGEN_PCI_SUBID(0x14c3, 0x1710), .driver_data = MODEL_HIFIER },
91 { OXYGEN_PCI_SUBID(0x14c3, 0x1711), .driver_data = MODEL_HIFIER },
92 /* AuzenTech X-Meridian */
93 { OXYGEN_PCI_SUBID(0x415a, 0x5431), .driver_data = MODEL_MERIDIAN },
95 { OXYGEN_PCI_SUBID(0x7284, 0x9761), .driver_data = MODEL_CLARO },
96 /* HT-Omega Claro halo */
97 { OXYGEN_PCI_SUBID(0x7284, 0x9781), .driver_data = MODEL_CLARO_HALO },
100 MODULE_DEVICE_TABLE(pci, oxygen_ids);
103 #define GPIO_AK5385_DFS_MASK 0x0003
104 #define GPIO_AK5385_DFS_NORMAL 0x0000
105 #define GPIO_AK5385_DFS_DOUBLE 0x0001
106 #define GPIO_AK5385_DFS_QUAD 0x0002
108 #define GPIO_CLARO_HP 0x0100
110 struct generic_data {
112 u8 ak4396_regs[4][5];
116 static void ak4396_write(struct oxygen *chip, unsigned int codec,
119 /* maps ALSA channel pair number to SPI output */
120 static const u8 codec_spi_map[4] = {
123 struct generic_data *data = chip->model_data;
125 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER |
126 OXYGEN_SPI_DATA_LENGTH_2 |
127 OXYGEN_SPI_CLOCK_160 |
128 (codec_spi_map[codec] << OXYGEN_SPI_CODEC_SHIFT) |
129 OXYGEN_SPI_CEN_LATCH_CLOCK_HI,
130 AK4396_WRITE | (reg << 8) | value);
131 data->ak4396_regs[codec][reg] = value;
134 static void ak4396_write_cached(struct oxygen *chip, unsigned int codec,
137 struct generic_data *data = chip->model_data;
139 if (value != data->ak4396_regs[codec][reg])
140 ak4396_write(chip, codec, reg, value);
143 static void wm8785_write(struct oxygen *chip, u8 reg, unsigned int value)
145 struct generic_data *data = chip->model_data;
147 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER |
148 OXYGEN_SPI_DATA_LENGTH_2 |
149 OXYGEN_SPI_CLOCK_160 |
150 (3 << OXYGEN_SPI_CODEC_SHIFT) |
151 OXYGEN_SPI_CEN_LATCH_CLOCK_LO,
153 if (reg < ARRAY_SIZE(data->wm8785_regs))
154 data->wm8785_regs[reg] = value;
157 static void ak4396_registers_init(struct oxygen *chip)
159 struct generic_data *data = chip->model_data;
162 for (i = 0; i < data->dacs; ++i) {
163 ak4396_write(chip, i, AK4396_CONTROL_1,
164 AK4396_DIF_24_MSB | AK4396_RSTN);
165 ak4396_write(chip, i, AK4396_CONTROL_2,
166 data->ak4396_regs[0][AK4396_CONTROL_2]);
167 ak4396_write(chip, i, AK4396_CONTROL_3,
169 ak4396_write(chip, i, AK4396_LCH_ATT,
170 chip->dac_volume[i * 2]);
171 ak4396_write(chip, i, AK4396_RCH_ATT,
172 chip->dac_volume[i * 2 + 1]);
176 static void ak4396_init(struct oxygen *chip)
178 struct generic_data *data = chip->model_data;
180 data->dacs = chip->model.dac_channels / 2;
181 data->ak4396_regs[0][AK4396_CONTROL_2] =
182 AK4396_SMUTE | AK4396_DEM_OFF | AK4396_DFS_NORMAL;
183 ak4396_registers_init(chip);
184 snd_component_add(chip->card, "AK4396");
187 static void ak5385_init(struct oxygen *chip)
189 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_AK5385_DFS_MASK);
190 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_AK5385_DFS_MASK);
191 snd_component_add(chip->card, "AK5385");
194 static void wm8785_registers_init(struct oxygen *chip)
196 struct generic_data *data = chip->model_data;
198 wm8785_write(chip, WM8785_R7, 0);
199 wm8785_write(chip, WM8785_R0, data->wm8785_regs[0]);
200 wm8785_write(chip, WM8785_R2, data->wm8785_regs[2]);
203 static void wm8785_init(struct oxygen *chip)
205 struct generic_data *data = chip->model_data;
207 data->wm8785_regs[0] =
208 WM8785_MCR_SLAVE | WM8785_OSR_SINGLE | WM8785_FORMAT_LJUST;
209 data->wm8785_regs[2] = WM8785_HPFR | WM8785_HPFL;
210 wm8785_registers_init(chip);
211 snd_component_add(chip->card, "WM8785");
214 static void generic_init(struct oxygen *chip)
220 static void meridian_init(struct oxygen *chip)
226 static void claro_enable_hp(struct oxygen *chip)
229 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_CLARO_HP);
230 oxygen_set_bits16(chip, OXYGEN_GPIO_DATA, GPIO_CLARO_HP);
233 static void claro_init(struct oxygen *chip)
237 claro_enable_hp(chip);
240 static void claro_halo_init(struct oxygen *chip)
244 claro_enable_hp(chip);
247 static void hifier_init(struct oxygen *chip)
250 snd_component_add(chip->card, "CS5340");
253 static void hg2pci_init(struct oxygen *chip)
258 static void generic_cleanup(struct oxygen *chip)
262 static void claro_disable_hp(struct oxygen *chip)
264 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_CLARO_HP);
267 static void claro_cleanup(struct oxygen *chip)
269 claro_disable_hp(chip);
272 static void claro_suspend(struct oxygen *chip)
274 claro_disable_hp(chip);
277 static void generic_resume(struct oxygen *chip)
279 ak4396_registers_init(chip);
280 wm8785_registers_init(chip);
283 static void meridian_resume(struct oxygen *chip)
285 ak4396_registers_init(chip);
288 static void claro_resume(struct oxygen *chip)
290 ak4396_registers_init(chip);
291 claro_enable_hp(chip);
294 static void stereo_resume(struct oxygen *chip)
296 ak4396_registers_init(chip);
299 static void set_ak4396_params(struct oxygen *chip,
300 struct snd_pcm_hw_params *params)
302 struct generic_data *data = chip->model_data;
306 value = data->ak4396_regs[0][AK4396_CONTROL_2] & ~AK4396_DFS_MASK;
307 if (params_rate(params) <= 54000)
308 value |= AK4396_DFS_NORMAL;
309 else if (params_rate(params) <= 108000)
310 value |= AK4396_DFS_DOUBLE;
312 value |= AK4396_DFS_QUAD;
314 msleep(1); /* wait for the new MCLK to become stable */
316 if (value != data->ak4396_regs[0][AK4396_CONTROL_2]) {
317 for (i = 0; i < data->dacs; ++i) {
318 ak4396_write(chip, i, AK4396_CONTROL_1,
320 ak4396_write(chip, i, AK4396_CONTROL_2, value);
321 ak4396_write(chip, i, AK4396_CONTROL_1,
322 AK4396_DIF_24_MSB | AK4396_RSTN);
327 static void update_ak4396_volume(struct oxygen *chip)
329 struct generic_data *data = chip->model_data;
332 for (i = 0; i < data->dacs; ++i) {
333 ak4396_write_cached(chip, i, AK4396_LCH_ATT,
334 chip->dac_volume[i * 2]);
335 ak4396_write_cached(chip, i, AK4396_RCH_ATT,
336 chip->dac_volume[i * 2 + 1]);
340 static void update_ak4396_mute(struct oxygen *chip)
342 struct generic_data *data = chip->model_data;
346 value = data->ak4396_regs[0][AK4396_CONTROL_2] & ~AK4396_SMUTE;
348 value |= AK4396_SMUTE;
349 for (i = 0; i < data->dacs; ++i)
350 ak4396_write_cached(chip, i, AK4396_CONTROL_2, value);
353 static void set_wm8785_params(struct oxygen *chip,
354 struct snd_pcm_hw_params *params)
356 struct generic_data *data = chip->model_data;
359 value = WM8785_MCR_SLAVE | WM8785_FORMAT_LJUST;
360 if (params_rate(params) <= 48000)
361 value |= WM8785_OSR_SINGLE;
362 else if (params_rate(params) <= 96000)
363 value |= WM8785_OSR_DOUBLE;
365 value |= WM8785_OSR_QUAD;
366 if (value != data->wm8785_regs[0]) {
367 wm8785_write(chip, WM8785_R7, 0);
368 wm8785_write(chip, WM8785_R0, value);
369 wm8785_write(chip, WM8785_R2, data->wm8785_regs[2]);
373 static void set_ak5385_params(struct oxygen *chip,
374 struct snd_pcm_hw_params *params)
378 if (params_rate(params) <= 54000)
379 value = GPIO_AK5385_DFS_NORMAL;
380 else if (params_rate(params) <= 108000)
381 value = GPIO_AK5385_DFS_DOUBLE;
383 value = GPIO_AK5385_DFS_QUAD;
384 oxygen_write16_masked(chip, OXYGEN_GPIO_DATA,
385 value, GPIO_AK5385_DFS_MASK);
388 static void set_no_params(struct oxygen *chip, struct snd_pcm_hw_params *params)
392 static int rolloff_info(struct snd_kcontrol *ctl,
393 struct snd_ctl_elem_info *info)
395 static const char *const names[2] = {
396 "Sharp Roll-off", "Slow Roll-off"
399 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
401 info->value.enumerated.items = 2;
402 if (info->value.enumerated.item >= 2)
403 info->value.enumerated.item = 1;
404 strcpy(info->value.enumerated.name, names[info->value.enumerated.item]);
408 static int rolloff_get(struct snd_kcontrol *ctl,
409 struct snd_ctl_elem_value *value)
411 struct oxygen *chip = ctl->private_data;
412 struct generic_data *data = chip->model_data;
414 value->value.enumerated.item[0] =
415 (data->ak4396_regs[0][AK4396_CONTROL_2] & AK4396_SLOW) != 0;
419 static int rolloff_put(struct snd_kcontrol *ctl,
420 struct snd_ctl_elem_value *value)
422 struct oxygen *chip = ctl->private_data;
423 struct generic_data *data = chip->model_data;
428 mutex_lock(&chip->mutex);
429 reg = data->ak4396_regs[0][AK4396_CONTROL_2];
430 if (value->value.enumerated.item[0])
434 changed = reg != data->ak4396_regs[0][AK4396_CONTROL_2];
436 for (i = 0; i < data->dacs; ++i)
437 ak4396_write(chip, i, AK4396_CONTROL_2, reg);
439 mutex_unlock(&chip->mutex);
443 static const struct snd_kcontrol_new rolloff_control = {
444 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
445 .name = "DAC Filter Playback Enum",
446 .info = rolloff_info,
451 static int hpf_info(struct snd_kcontrol *ctl, struct snd_ctl_elem_info *info)
453 static const char *const names[2] = {
454 "None", "High-pass Filter"
457 info->type = SNDRV_CTL_ELEM_TYPE_ENUMERATED;
459 info->value.enumerated.items = 2;
460 if (info->value.enumerated.item >= 2)
461 info->value.enumerated.item = 1;
462 strcpy(info->value.enumerated.name, names[info->value.enumerated.item]);
466 static int hpf_get(struct snd_kcontrol *ctl, struct snd_ctl_elem_value *value)
468 struct oxygen *chip = ctl->private_data;
469 struct generic_data *data = chip->model_data;
471 value->value.enumerated.item[0] =
472 (data->wm8785_regs[WM8785_R2] & WM8785_HPFR) != 0;
476 static int hpf_put(struct snd_kcontrol *ctl, struct snd_ctl_elem_value *value)
478 struct oxygen *chip = ctl->private_data;
479 struct generic_data *data = chip->model_data;
483 mutex_lock(&chip->mutex);
484 reg = data->wm8785_regs[WM8785_R2] & ~(WM8785_HPFR | WM8785_HPFL);
485 if (value->value.enumerated.item[0])
486 reg |= WM8785_HPFR | WM8785_HPFL;
487 changed = reg != data->wm8785_regs[WM8785_R2];
489 wm8785_write(chip, WM8785_R2, reg);
490 mutex_unlock(&chip->mutex);
494 static const struct snd_kcontrol_new hpf_control = {
495 .iface = SNDRV_CTL_ELEM_IFACE_MIXER,
496 .name = "ADC Filter Capture Enum",
502 static int generic_mixer_init(struct oxygen *chip)
504 return snd_ctl_add(chip->card, snd_ctl_new1(&rolloff_control, chip));
507 static int generic_wm8785_mixer_init(struct oxygen *chip)
511 err = generic_mixer_init(chip);
514 err = snd_ctl_add(chip->card, snd_ctl_new1(&hpf_control, chip));
520 static const DECLARE_TLV_DB_LINEAR(ak4396_db_scale, TLV_DB_GAIN_MUTE, 0);
522 static const struct oxygen_model model_generic = {
523 .shortname = "C-Media CMI8788",
524 .longname = "C-Media Oxygen HD Audio",
526 .init = generic_init,
527 .mixer_init = generic_wm8785_mixer_init,
528 .cleanup = generic_cleanup,
529 .resume = generic_resume,
530 .get_i2s_mclk = oxygen_default_i2s_mclk,
531 .set_dac_params = set_ak4396_params,
532 .set_adc_params = set_wm8785_params,
533 .update_dac_volume = update_ak4396_volume,
534 .update_dac_mute = update_ak4396_mute,
535 .dac_tlv = ak4396_db_scale,
536 .model_data_size = sizeof(struct generic_data),
537 .device_config = PLAYBACK_0_TO_I2S |
538 PLAYBACK_1_TO_SPDIF |
539 PLAYBACK_2_TO_AC97_1 |
540 CAPTURE_0_FROM_I2S_1 |
541 CAPTURE_1_FROM_SPDIF |
542 CAPTURE_2_FROM_AC97_1 |
546 .dac_volume_max = 255,
547 .function_flags = OXYGEN_FUNCTION_SPI |
548 OXYGEN_FUNCTION_ENABLE_SPI_4_5,
549 .dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
550 .adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
553 static int __devinit get_oxygen_model(struct oxygen *chip,
554 const struct pci_device_id *id)
556 chip->model = model_generic;
557 switch (id->driver_data) {
559 chip->model.init = meridian_init;
560 chip->model.mixer_init = generic_mixer_init;
561 chip->model.resume = meridian_resume;
562 chip->model.set_adc_params = set_ak5385_params;
563 chip->model.device_config = PLAYBACK_0_TO_I2S |
564 PLAYBACK_1_TO_SPDIF |
565 CAPTURE_0_FROM_I2S_2 |
566 CAPTURE_1_FROM_SPDIF;
569 chip->model.init = claro_init;
570 chip->model.cleanup = claro_cleanup;
571 chip->model.suspend = claro_suspend;
572 chip->model.resume = claro_resume;
574 case MODEL_CLARO_HALO:
575 chip->model.init = claro_halo_init;
576 chip->model.mixer_init = generic_mixer_init;
577 chip->model.cleanup = claro_cleanup;
578 chip->model.suspend = claro_suspend;
579 chip->model.resume = claro_resume;
580 chip->model.set_adc_params = set_ak5385_params;
581 chip->model.device_config = PLAYBACK_0_TO_I2S |
582 PLAYBACK_1_TO_SPDIF |
583 CAPTURE_0_FROM_I2S_2 |
584 CAPTURE_1_FROM_SPDIF;
588 chip->model.shortname = "C-Media CMI8787";
589 chip->model.chip = "CMI8787";
590 if (id->driver_data == MODEL_HIFIER)
591 chip->model.init = hifier_init;
593 chip->model.init = hg2pci_init;
594 chip->model.resume = stereo_resume;
595 chip->model.mixer_init = generic_mixer_init;
596 chip->model.set_adc_params = set_no_params;
597 chip->model.device_config = PLAYBACK_0_TO_I2S |
599 if (id->driver_data == MODEL_HIFIER)
600 chip->model.device_config |= CAPTURE_0_FROM_I2S_1;
601 chip->model.dac_channels = 2;
604 if (id->driver_data == MODEL_MERIDIAN ||
605 id->driver_data == MODEL_CLARO_HALO) {
606 chip->model.misc_flags = OXYGEN_MISC_MIDI;
607 chip->model.device_config |= MIDI_OUTPUT | MIDI_INPUT;
612 static int __devinit generic_oxygen_probe(struct pci_dev *pci,
613 const struct pci_device_id *pci_id)
618 if (dev >= SNDRV_CARDS)
624 err = oxygen_pci_probe(pci, index[dev], id[dev], THIS_MODULE,
625 oxygen_ids, get_oxygen_model);
631 static struct pci_driver oxygen_driver = {
633 .id_table = oxygen_ids,
634 .probe = generic_oxygen_probe,
635 .remove = __devexit_p(oxygen_pci_remove),
637 .suspend = oxygen_pci_suspend,
638 .resume = oxygen_pci_resume,
642 static int __init alsa_card_oxygen_init(void)
644 return pci_register_driver(&oxygen_driver);
647 static void __exit alsa_card_oxygen_exit(void)
649 pci_unregister_driver(&oxygen_driver);
652 module_init(alsa_card_oxygen_init)
653 module_exit(alsa_card_oxygen_exit)