2 * C-Media CMI8788 driver for C-Media's reference design and for the X-Meridian
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
21 * SPI 0 -> 1st AK4396 (front)
22 * SPI 1 -> 2nd AK4396 (surround)
23 * SPI 2 -> 3rd AK4396 (center/LFE)
25 * SPI 4 -> 4th AK4396 (back)
27 * GPIO 0 -> DFS0 of AK5385
28 * GPIO 1 -> DFS1 of AK5385
31 #include <linux/pci.h>
32 #include <sound/control.h>
33 #include <sound/core.h>
34 #include <sound/initval.h>
35 #include <sound/pcm.h>
36 #include <sound/pcm_params.h>
37 #include <sound/tlv.h>
40 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
41 MODULE_DESCRIPTION("C-Media CMI8788 driver");
42 MODULE_LICENSE("GPL");
43 MODULE_SUPPORTED_DEVICE("{{C-Media,CMI8788}}");
45 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
46 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
47 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;
49 module_param_array(index, int, NULL, 0444);
50 MODULE_PARM_DESC(index, "card index");
51 module_param_array(id, charp, NULL, 0444);
52 MODULE_PARM_DESC(id, "ID string");
53 module_param_array(enable, bool, NULL, 0444);
54 MODULE_PARM_DESC(enable, "enable card");
56 static struct pci_device_id oxygen_ids[] __devinitdata = {
57 { OXYGEN_PCI_SUBID(0x10b0, 0x0216) },
58 { OXYGEN_PCI_SUBID(0x10b0, 0x0218) },
59 { OXYGEN_PCI_SUBID(0x10b0, 0x0219) },
60 { OXYGEN_PCI_SUBID(0x13f6, 0x0001) },
61 { OXYGEN_PCI_SUBID(0x13f6, 0x0010) },
62 { OXYGEN_PCI_SUBID(0x13f6, 0x8788) },
63 { OXYGEN_PCI_SUBID(0x147a, 0xa017) },
64 { OXYGEN_PCI_SUBID(0x14c3, 0x1710) },
65 { OXYGEN_PCI_SUBID(0x14c3, 0x1711) },
66 { OXYGEN_PCI_SUBID(0x1a58, 0x0910) },
67 { OXYGEN_PCI_SUBID(0x415a, 0x5431), .driver_data = 1 },
68 { OXYGEN_PCI_SUBID(0x7284, 0x9761) },
71 MODULE_DEVICE_TABLE(pci, oxygen_ids);
73 #define AK4396_WRITE 0x2000
76 #define AK4396_RSTN 0x01
77 #define AK4396_DIF_24_MSB 0x04
79 #define AK4396_SMUTE 0x01
80 #define AK4396_DEM_OFF 0x02
81 #define AK4396_DFS_MASK 0x18
82 #define AK4396_DFS_NORMAL 0x00
83 #define AK4396_DFS_DOUBLE 0x08
84 #define AK4396_DFS_QUAD 0x10
87 #define WM8785_OSR_SINGLE 0x000
88 #define WM8785_OSR_DOUBLE 0x008
89 #define WM8785_OSR_QUAD 0x010
90 #define WM8785_FORMAT_LJUST 0x020
91 #define WM8785_FORMAT_I2S 0x040
93 #define WM8785_WL_16 0x000
94 #define WM8785_WL_20 0x001
95 #define WM8785_WL_24 0x002
96 #define WM8785_WL_32 0x003
98 static void ak4396_write(struct oxygen *chip, unsigned int codec,
101 /* maps ALSA channel pair number to SPI output */
102 static const u8 codec_spi_map[4] = {
105 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER_WRITE |
106 OXYGEN_SPI_DATA_LENGTH_2 |
107 (codec_spi_map[codec] << OXYGEN_SPI_CODEC_SHIFT) |
109 AK4396_WRITE | (reg << 8) | value);
112 static void wm8785_write(struct oxygen *chip, u8 reg, unsigned int value)
114 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER_WRITE |
115 OXYGEN_SPI_DATA_LENGTH_2 |
116 (3 << OXYGEN_SPI_CODEC_SHIFT),
120 static void ak4396_init(struct oxygen *chip)
124 chip->ak4396_reg1 = AK4396_DEM_OFF | AK4396_DFS_NORMAL;
125 for (i = 0; i < 4; ++i) {
126 ak4396_write(chip, i, 0, AK4396_DIF_24_MSB | AK4396_RSTN);
127 ak4396_write(chip, i, 1, chip->ak4396_reg1);
128 ak4396_write(chip, i, 2, 0);
129 ak4396_write(chip, i, 3, 0xff);
130 ak4396_write(chip, i, 4, 0xff);
132 snd_component_add(chip->card, "AK4396");
135 static void ak5385_init(struct oxygen *chip)
137 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, 0x0003);
138 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, 0x0003);
139 snd_component_add(chip->card, "AK5385");
142 static void wm8785_init(struct oxygen *chip)
144 wm8785_write(chip, 7, 0);
145 wm8785_write(chip, 0, WM8785_FORMAT_LJUST | WM8785_OSR_SINGLE);
146 wm8785_write(chip, 1, WM8785_WL_24);
147 snd_component_add(chip->card, "WM8785");
150 static void generic_init(struct oxygen *chip)
156 static void meridian_init(struct oxygen *chip)
162 static void generic_cleanup(struct oxygen *chip)
166 static void generic_pcm_hardware_filter(unsigned int channel,
167 struct snd_pcm_hardware *hardware)
169 if (channel == PCM_A) {
170 hardware->rates = SNDRV_PCM_RATE_44100 |
171 SNDRV_PCM_RATE_48000 |
172 SNDRV_PCM_RATE_96000 |
173 SNDRV_PCM_RATE_192000;
174 hardware->rate_min = 44100;
178 static void set_ak4396_params(struct oxygen *chip,
179 struct snd_pcm_hw_params *params)
184 value = chip->ak4396_reg1 & ~AK4396_DFS_MASK;
185 if (params_rate(params) <= 54000)
186 value |= AK4396_DFS_NORMAL;
187 else if (params_rate(params) < 120000)
188 value |= AK4396_DFS_DOUBLE;
190 value |= AK4396_DFS_QUAD;
191 chip->ak4396_reg1 = value;
192 for (i = 0; i < 4; ++i) {
193 ak4396_write(chip, i, 0, AK4396_DIF_24_MSB);
194 ak4396_write(chip, i, 1, value);
195 ak4396_write(chip, i, 0, AK4396_DIF_24_MSB | AK4396_RSTN);
199 static void update_ak4396_volume(struct oxygen *chip)
203 for (i = 0; i < 4; ++i) {
204 ak4396_write(chip, i, 3, chip->dac_volume[i * 2]);
205 ak4396_write(chip, i, 4, chip->dac_volume[i * 2 + 1]);
209 static void update_ak4396_mute(struct oxygen *chip)
214 value = chip->ak4396_reg1 & ~AK4396_SMUTE;
216 value |= AK4396_SMUTE;
217 for (i = 0; i < 4; ++i)
218 ak4396_write(chip, i, 1, value);
221 static void set_wm8785_params(struct oxygen *chip,
222 struct snd_pcm_hw_params *params)
226 wm8785_write(chip, 7, 0);
228 value = WM8785_FORMAT_LJUST;
229 if (params_rate(params) == 96000)
230 value |= WM8785_OSR_DOUBLE;
231 else if (params_rate(params) == 192000)
232 value |= WM8785_OSR_QUAD;
234 value |= WM8785_OSR_SINGLE;
235 wm8785_write(chip, 0, value);
237 if (snd_pcm_format_width(params_format(params)) <= 16)
238 value = WM8785_WL_16;
240 value = WM8785_WL_24;
241 wm8785_write(chip, 1, value);
244 static void set_ak5385_params(struct oxygen *chip,
245 struct snd_pcm_hw_params *params)
249 if (params_rate(params) <= 54000)
251 else if (params_rate(params) <= 108000)
255 oxygen_write16_masked(chip, OXYGEN_GPIO_DATA, value, 0x0003);
258 static const DECLARE_TLV_DB_LINEAR(ak4396_db_scale, TLV_DB_GAIN_MUTE, 0);
260 static int ak4396_control_filter(struct snd_kcontrol_new *template)
262 if (!strcmp(template->name, "Master Playback Volume")) {
263 template->access |= SNDRV_CTL_ELEM_ACCESS_TLV_READ;
264 template->tlv.p = ak4396_db_scale;
269 static const struct oxygen_model model_generic = {
270 .shortname = "C-Media CMI8788",
271 .longname = "C-Media Oxygen HD Audio",
273 .owner = THIS_MODULE,
274 .init = generic_init,
275 .control_filter = ak4396_control_filter,
276 .cleanup = generic_cleanup,
277 .pcm_hardware_filter = generic_pcm_hardware_filter,
278 .set_dac_params = set_ak4396_params,
279 .set_adc_params = set_wm8785_params,
280 .update_dac_volume = update_ak4396_volume,
281 .update_dac_mute = update_ak4396_mute,
282 .used_channels = OXYGEN_CHANNEL_A |
284 OXYGEN_CHANNEL_SPDIF |
285 OXYGEN_CHANNEL_MULTICH |
287 .function_flags = OXYGEN_FUNCTION_ENABLE_SPI_4_5,
289 static const struct oxygen_model model_meridian = {
290 .shortname = "C-Media CMI8788",
291 .longname = "C-Media Oxygen HD Audio",
293 .owner = THIS_MODULE,
294 .init = meridian_init,
295 .control_filter = ak4396_control_filter,
296 .cleanup = generic_cleanup,
297 .set_dac_params = set_ak4396_params,
298 .set_adc_params = set_ak5385_params,
299 .update_dac_volume = update_ak4396_volume,
300 .update_dac_mute = update_ak4396_mute,
301 .used_channels = OXYGEN_CHANNEL_B |
303 OXYGEN_CHANNEL_SPDIF |
304 OXYGEN_CHANNEL_MULTICH |
306 .function_flags = OXYGEN_FUNCTION_ENABLE_SPI_4_5,
309 static int __devinit generic_oxygen_probe(struct pci_dev *pci,
310 const struct pci_device_id *pci_id)
313 const struct oxygen_model *model;
316 if (dev >= SNDRV_CARDS)
322 model = pci_id->driver_data ? &model_meridian : &model_generic;
323 err = oxygen_pci_probe(pci, index[dev], id[dev], model);
329 static struct pci_driver oxygen_driver = {
331 .id_table = oxygen_ids,
332 .probe = generic_oxygen_probe,
333 .remove = __devexit_p(oxygen_pci_remove),
336 static int __init alsa_card_oxygen_init(void)
338 return pci_register_driver(&oxygen_driver);
341 static void __exit alsa_card_oxygen_exit(void)
343 pci_unregister_driver(&oxygen_driver);
346 module_init(alsa_card_oxygen_init)
347 module_exit(alsa_card_oxygen_exit)