1 /* 2 * C-Media CMI8788 driver for C-Media's reference design and for the X-Meridian 3 * 4 * Copyright (c) Clemens Ladisch <clemens@ladisch.de> 5 * 6 * 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. 9 * 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. 14 * 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 18 */ 19 20 /* 21 * SPI 0 -> 1st AK4396 (front) 22 * SPI 1 -> 2nd AK4396 (surround) 23 * SPI 2 -> 3rd AK4396 (center/LFE) 24 * SPI 3 -> WM8785 25 * SPI 4 -> 4th AK4396 (back) 26 * 27 * GPIO 0 -> DFS0 of AK5385 28 * GPIO 1 -> DFS1 of AK5385 29 */ 30 31 #include <linux/delay.h> 32 #include <linux/mutex.h> 33 #include <linux/pci.h> 34 #include <sound/ac97_codec.h> 35 #include <sound/control.h> 36 #include <sound/core.h> 37 #include <sound/initval.h> 38 #include <sound/pcm.h> 39 #include <sound/pcm_params.h> 40 #include <sound/tlv.h> 41 #include "oxygen.h" 42 #include "ak4396.h" 43 #include "wm8785.h" 44 45 MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>"); 46 MODULE_DESCRIPTION("C-Media CMI8788 driver"); 47 MODULE_LICENSE("GPL v2"); 48 MODULE_SUPPORTED_DEVICE("{{C-Media,CMI8788}}"); 49 50 static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX; 51 static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR; 52 static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP; 53 54 module_param_array(index, int, NULL, 0444); 55 MODULE_PARM_DESC(index, "card index"); 56 module_param_array(id, charp, NULL, 0444); 57 MODULE_PARM_DESC(id, "ID string"); 58 module_param_array(enable, bool, NULL, 0444); 59 MODULE_PARM_DESC(enable, "enable card"); 60 61 static struct pci_device_id oxygen_ids[] __devinitdata = { 62 { OXYGEN_PCI_SUBID(0x10b0, 0x0216) }, 63 { OXYGEN_PCI_SUBID(0x10b0, 0x0218) }, 64 { OXYGEN_PCI_SUBID(0x10b0, 0x0219) }, 65 { OXYGEN_PCI_SUBID(0x13f6, 0x0001) }, 66 { OXYGEN_PCI_SUBID(0x13f6, 0x0010) }, 67 { OXYGEN_PCI_SUBID(0x13f6, 0x8788) }, 68 { OXYGEN_PCI_SUBID(0x147a, 0xa017) }, 69 { OXYGEN_PCI_SUBID(0x1a58, 0x0910) }, 70 { OXYGEN_PCI_SUBID(0x415a, 0x5431), .driver_data = 1 }, 71 { OXYGEN_PCI_SUBID(0x7284, 0x9761) }, 72 { } 73 }; 74 MODULE_DEVICE_TABLE(pci, oxygen_ids); 75 76 77 #define GPIO_AK5385_DFS_MASK 0x0003 78 #define GPIO_AK5385_DFS_NORMAL 0x0000 79 #define GPIO_AK5385_DFS_DOUBLE 0x0001 80 #define GPIO_AK5385_DFS_QUAD 0x0002 81 82 struct generic_data { 83 u8 ak4396_ctl2; 84 u16 saved_wm8785_registers[2]; 85 }; 86 87 static void ak4396_write(struct oxygen *chip, unsigned int codec, 88 u8 reg, u8 value) 89 { 90 /* maps ALSA channel pair number to SPI output */ 91 static const u8 codec_spi_map[4] = { 92 0, 1, 2, 4 93 }; 94 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER | 95 OXYGEN_SPI_DATA_LENGTH_2 | 96 OXYGEN_SPI_CLOCK_160 | 97 (codec_spi_map[codec] << OXYGEN_SPI_CODEC_SHIFT) | 98 OXYGEN_SPI_CEN_LATCH_CLOCK_HI, 99 AK4396_WRITE | (reg << 8) | value); 100 } 101 102 static void wm8785_write(struct oxygen *chip, u8 reg, unsigned int value) 103 { 104 struct generic_data *data = chip->model_data; 105 106 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER | 107 OXYGEN_SPI_DATA_LENGTH_2 | 108 OXYGEN_SPI_CLOCK_160 | 109 (3 << OXYGEN_SPI_CODEC_SHIFT) | 110 OXYGEN_SPI_CEN_LATCH_CLOCK_LO, 111 (reg << 9) | value); 112 if (reg < ARRAY_SIZE(data->saved_wm8785_registers)) 113 data->saved_wm8785_registers[reg] = value; 114 } 115 116 static void update_ak4396_volume(struct oxygen *chip) 117 { 118 unsigned int i; 119 120 for (i = 0; i < 4; ++i) { 121 ak4396_write(chip, i, 122 AK4396_LCH_ATT, chip->dac_volume[i * 2]); 123 ak4396_write(chip, i, 124 AK4396_RCH_ATT, chip->dac_volume[i * 2 + 1]); 125 } 126 } 127 128 static void ak4396_registers_init(struct oxygen *chip) 129 { 130 struct generic_data *data = chip->model_data; 131 unsigned int i; 132 133 for (i = 0; i < 4; ++i) { 134 ak4396_write(chip, i, 135 AK4396_CONTROL_1, AK4396_DIF_24_MSB | AK4396_RSTN); 136 ak4396_write(chip, i, 137 AK4396_CONTROL_2, data->ak4396_ctl2); 138 ak4396_write(chip, i, 139 AK4396_CONTROL_3, AK4396_PCM); 140 } 141 update_ak4396_volume(chip); 142 } 143 144 static void ak4396_init(struct oxygen *chip) 145 { 146 struct generic_data *data = chip->model_data; 147 148 data->ak4396_ctl2 = AK4396_SMUTE | AK4396_DEM_OFF | AK4396_DFS_NORMAL; 149 ak4396_registers_init(chip); 150 snd_component_add(chip->card, "AK4396"); 151 } 152 153 static void ak5385_init(struct oxygen *chip) 154 { 155 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_AK5385_DFS_MASK); 156 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_AK5385_DFS_MASK); 157 snd_component_add(chip->card, "AK5385"); 158 } 159 160 static void wm8785_registers_init(struct oxygen *chip) 161 { 162 struct generic_data *data = chip->model_data; 163 164 wm8785_write(chip, WM8785_R7, 0); 165 wm8785_write(chip, WM8785_R0, data->saved_wm8785_registers[0]); 166 wm8785_write(chip, WM8785_R1, data->saved_wm8785_registers[1]); 167 } 168 169 static void wm8785_init(struct oxygen *chip) 170 { 171 struct generic_data *data = chip->model_data; 172 173 data->saved_wm8785_registers[0] = WM8785_MCR_SLAVE | 174 WM8785_OSR_SINGLE | WM8785_FORMAT_LJUST; 175 data->saved_wm8785_registers[1] = WM8785_WL_24; 176 wm8785_registers_init(chip); 177 snd_component_add(chip->card, "WM8785"); 178 } 179 180 static void generic_init(struct oxygen *chip) 181 { 182 ak4396_init(chip); 183 wm8785_init(chip); 184 } 185 186 static void meridian_init(struct oxygen *chip) 187 { 188 ak4396_init(chip); 189 ak5385_init(chip); 190 } 191 192 static void generic_cleanup(struct oxygen *chip) 193 { 194 } 195 196 static void generic_resume(struct oxygen *chip) 197 { 198 ak4396_registers_init(chip); 199 wm8785_registers_init(chip); 200 } 201 202 static void set_ak4396_params(struct oxygen *chip, 203 struct snd_pcm_hw_params *params) 204 { 205 struct generic_data *data = chip->model_data; 206 unsigned int i; 207 u8 value; 208 209 value = data->ak4396_ctl2 & ~AK4396_DFS_MASK; 210 if (params_rate(params) <= 54000) 211 value |= AK4396_DFS_NORMAL; 212 else if (params_rate(params) <= 108000) 213 value |= AK4396_DFS_DOUBLE; 214 else 215 value |= AK4396_DFS_QUAD; 216 data->ak4396_ctl2 = value; 217 218 msleep(1); /* wait for the new MCLK to become stable */ 219 220 for (i = 0; i < 4; ++i) { 221 ak4396_write(chip, i, 222 AK4396_CONTROL_1, AK4396_DIF_24_MSB); 223 ak4396_write(chip, i, 224 AK4396_CONTROL_2, value); 225 ak4396_write(chip, i, 226 AK4396_CONTROL_1, AK4396_DIF_24_MSB | AK4396_RSTN); 227 } 228 } 229 230 static void update_ak4396_mute(struct oxygen *chip) 231 { 232 struct generic_data *data = chip->model_data; 233 unsigned int i; 234 u8 value; 235 236 value = data->ak4396_ctl2 & ~AK4396_SMUTE; 237 if (chip->dac_mute) 238 value |= AK4396_SMUTE; 239 data->ak4396_ctl2 = value; 240 for (i = 0; i < 4; ++i) 241 ak4396_write(chip, i, AK4396_CONTROL_2, value); 242 } 243 244 static void set_wm8785_params(struct oxygen *chip, 245 struct snd_pcm_hw_params *params) 246 { 247 unsigned int value; 248 249 wm8785_write(chip, WM8785_R7, 0); 250 251 value = WM8785_MCR_SLAVE | WM8785_FORMAT_LJUST; 252 if (params_rate(params) <= 48000) 253 value |= WM8785_OSR_SINGLE; 254 else if (params_rate(params) <= 96000) 255 value |= WM8785_OSR_DOUBLE; 256 else 257 value |= WM8785_OSR_QUAD; 258 wm8785_write(chip, WM8785_R0, value); 259 260 if (snd_pcm_format_width(params_format(params)) <= 16) 261 value = WM8785_WL_16; 262 else 263 value = WM8785_WL_24; 264 wm8785_write(chip, WM8785_R1, value); 265 } 266 267 static void set_ak5385_params(struct oxygen *chip, 268 struct snd_pcm_hw_params *params) 269 { 270 unsigned int value; 271 272 if (params_rate(params) <= 54000) 273 value = GPIO_AK5385_DFS_NORMAL; 274 else if (params_rate(params) <= 108000) 275 value = GPIO_AK5385_DFS_DOUBLE; 276 else 277 value = GPIO_AK5385_DFS_QUAD; 278 oxygen_write16_masked(chip, OXYGEN_GPIO_DATA, 279 value, GPIO_AK5385_DFS_MASK); 280 } 281 282 static const DECLARE_TLV_DB_LINEAR(ak4396_db_scale, TLV_DB_GAIN_MUTE, 0); 283 284 static const struct oxygen_model model_generic = { 285 .shortname = "C-Media CMI8788", 286 .longname = "C-Media Oxygen HD Audio", 287 .chip = "CMI8788", 288 .owner = THIS_MODULE, 289 .init = generic_init, 290 .cleanup = generic_cleanup, 291 .resume = generic_resume, 292 .set_dac_params = set_ak4396_params, 293 .set_adc_params = set_wm8785_params, 294 .update_dac_volume = update_ak4396_volume, 295 .update_dac_mute = update_ak4396_mute, 296 .dac_tlv = ak4396_db_scale, 297 .model_data_size = sizeof(struct generic_data), 298 .pcm_dev_cfg = PLAYBACK_0_TO_I2S | 299 PLAYBACK_1_TO_SPDIF | 300 PLAYBACK_2_TO_AC97_1 | 301 CAPTURE_0_FROM_I2S_1 | 302 CAPTURE_1_FROM_SPDIF | 303 CAPTURE_2_FROM_AC97_1, 304 .dac_channels = 8, 305 .dac_volume_min = 0, 306 .dac_volume_max = 255, 307 .function_flags = OXYGEN_FUNCTION_SPI | 308 OXYGEN_FUNCTION_ENABLE_SPI_4_5, 309 .dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST, 310 .adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST, 311 }; 312 static const struct oxygen_model model_meridian = { 313 .shortname = "C-Media CMI8788", 314 .longname = "C-Media Oxygen HD Audio", 315 .chip = "CMI8788", 316 .owner = THIS_MODULE, 317 .init = meridian_init, 318 .cleanup = generic_cleanup, 319 .resume = ak4396_registers_init, 320 .set_dac_params = set_ak4396_params, 321 .set_adc_params = set_ak5385_params, 322 .update_dac_volume = update_ak4396_volume, 323 .update_dac_mute = update_ak4396_mute, 324 .dac_tlv = ak4396_db_scale, 325 .model_data_size = sizeof(struct generic_data), 326 .pcm_dev_cfg = PLAYBACK_0_TO_I2S | 327 PLAYBACK_1_TO_SPDIF | 328 PLAYBACK_2_TO_AC97_1 | 329 CAPTURE_0_FROM_I2S_2 | 330 CAPTURE_1_FROM_SPDIF | 331 CAPTURE_2_FROM_AC97_1, 332 .dac_channels = 8, 333 .dac_volume_min = 0, 334 .dac_volume_max = 255, 335 .misc_flags = OXYGEN_MISC_MIDI, 336 .function_flags = OXYGEN_FUNCTION_SPI | 337 OXYGEN_FUNCTION_ENABLE_SPI_4_5, 338 .dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST, 339 .adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST, 340 }; 341 342 static int __devinit generic_oxygen_probe(struct pci_dev *pci, 343 const struct pci_device_id *pci_id) 344 { 345 static int dev; 346 int is_meridian; 347 int err; 348 349 if (dev >= SNDRV_CARDS) 350 return -ENODEV; 351 if (!enable[dev]) { 352 ++dev; 353 return -ENOENT; 354 } 355 is_meridian = pci_id->driver_data; 356 err = oxygen_pci_probe(pci, index[dev], id[dev], 357 is_meridian ? &model_meridian : &model_generic); 358 if (err >= 0) 359 ++dev; 360 return err; 361 } 362 363 static struct pci_driver oxygen_driver = { 364 .name = "CMI8788", 365 .id_table = oxygen_ids, 366 .probe = generic_oxygen_probe, 367 .remove = __devexit_p(oxygen_pci_remove), 368 #ifdef CONFIG_PM 369 .suspend = oxygen_pci_suspend, 370 .resume = oxygen_pci_resume, 371 #endif 372 }; 373 374 static int __init alsa_card_oxygen_init(void) 375 { 376 return pci_register_driver(&oxygen_driver); 377 } 378 379 static void __exit alsa_card_oxygen_exit(void) 380 { 381 pci_unregister_driver(&oxygen_driver); 382 } 383 384 module_init(alsa_card_oxygen_init) 385 module_exit(alsa_card_oxygen_exit) 386