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 enum { 62 MODEL_CMEDIA_REF, /* C-Media's reference design */ 63 MODEL_MERIDIAN, /* AuzenTech X-Meridian */ 64 MODEL_HALO, /* HT-Omega Claro halo */ 65 }; 66 67 static struct pci_device_id oxygen_ids[] __devinitdata = { 68 { OXYGEN_PCI_SUBID(0x10b0, 0x0216), .driver_data = MODEL_CMEDIA_REF }, 69 { OXYGEN_PCI_SUBID(0x10b0, 0x0218), .driver_data = MODEL_CMEDIA_REF }, 70 { OXYGEN_PCI_SUBID(0x10b0, 0x0219), .driver_data = MODEL_CMEDIA_REF }, 71 { OXYGEN_PCI_SUBID(0x13f6, 0x0001), .driver_data = MODEL_CMEDIA_REF }, 72 { OXYGEN_PCI_SUBID(0x13f6, 0x0010), .driver_data = MODEL_CMEDIA_REF }, 73 { OXYGEN_PCI_SUBID(0x13f6, 0x8788), .driver_data = MODEL_CMEDIA_REF }, 74 { OXYGEN_PCI_SUBID(0x147a, 0xa017), .driver_data = MODEL_CMEDIA_REF }, 75 { OXYGEN_PCI_SUBID(0x1a58, 0x0910), .driver_data = MODEL_CMEDIA_REF }, 76 { OXYGEN_PCI_SUBID(0x415a, 0x5431), .driver_data = MODEL_MERIDIAN }, 77 { OXYGEN_PCI_SUBID(0x7284, 0x9761), .driver_data = MODEL_CMEDIA_REF }, 78 { OXYGEN_PCI_SUBID(0x7284, 0x9781), .driver_data = MODEL_HALO }, 79 { } 80 }; 81 MODULE_DEVICE_TABLE(pci, oxygen_ids); 82 83 84 #define GPIO_AK5385_DFS_MASK 0x0003 85 #define GPIO_AK5385_DFS_NORMAL 0x0000 86 #define GPIO_AK5385_DFS_DOUBLE 0x0001 87 #define GPIO_AK5385_DFS_QUAD 0x0002 88 89 struct generic_data { 90 u8 ak4396_ctl2; 91 u16 saved_wm8785_registers[2]; 92 }; 93 94 static void ak4396_write(struct oxygen *chip, unsigned int codec, 95 u8 reg, u8 value) 96 { 97 /* maps ALSA channel pair number to SPI output */ 98 static const u8 codec_spi_map[4] = { 99 0, 1, 2, 4 100 }; 101 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER | 102 OXYGEN_SPI_DATA_LENGTH_2 | 103 OXYGEN_SPI_CLOCK_160 | 104 (codec_spi_map[codec] << OXYGEN_SPI_CODEC_SHIFT) | 105 OXYGEN_SPI_CEN_LATCH_CLOCK_HI, 106 AK4396_WRITE | (reg << 8) | value); 107 } 108 109 static void wm8785_write(struct oxygen *chip, u8 reg, unsigned int value) 110 { 111 struct generic_data *data = chip->model_data; 112 113 oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER | 114 OXYGEN_SPI_DATA_LENGTH_2 | 115 OXYGEN_SPI_CLOCK_160 | 116 (3 << OXYGEN_SPI_CODEC_SHIFT) | 117 OXYGEN_SPI_CEN_LATCH_CLOCK_LO, 118 (reg << 9) | value); 119 if (reg < ARRAY_SIZE(data->saved_wm8785_registers)) 120 data->saved_wm8785_registers[reg] = value; 121 } 122 123 static void update_ak4396_volume(struct oxygen *chip) 124 { 125 unsigned int i; 126 127 for (i = 0; i < 4; ++i) { 128 ak4396_write(chip, i, 129 AK4396_LCH_ATT, chip->dac_volume[i * 2]); 130 ak4396_write(chip, i, 131 AK4396_RCH_ATT, chip->dac_volume[i * 2 + 1]); 132 } 133 } 134 135 static void ak4396_registers_init(struct oxygen *chip) 136 { 137 struct generic_data *data = chip->model_data; 138 unsigned int i; 139 140 for (i = 0; i < 4; ++i) { 141 ak4396_write(chip, i, 142 AK4396_CONTROL_1, AK4396_DIF_24_MSB | AK4396_RSTN); 143 ak4396_write(chip, i, 144 AK4396_CONTROL_2, data->ak4396_ctl2); 145 ak4396_write(chip, i, 146 AK4396_CONTROL_3, AK4396_PCM); 147 } 148 update_ak4396_volume(chip); 149 } 150 151 static void ak4396_init(struct oxygen *chip) 152 { 153 struct generic_data *data = chip->model_data; 154 155 data->ak4396_ctl2 = AK4396_SMUTE | AK4396_DEM_OFF | AK4396_DFS_NORMAL; 156 ak4396_registers_init(chip); 157 snd_component_add(chip->card, "AK4396"); 158 } 159 160 static void ak5385_init(struct oxygen *chip) 161 { 162 oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_AK5385_DFS_MASK); 163 oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_AK5385_DFS_MASK); 164 snd_component_add(chip->card, "AK5385"); 165 } 166 167 static void wm8785_registers_init(struct oxygen *chip) 168 { 169 struct generic_data *data = chip->model_data; 170 171 wm8785_write(chip, WM8785_R7, 0); 172 wm8785_write(chip, WM8785_R0, data->saved_wm8785_registers[0]); 173 wm8785_write(chip, WM8785_R1, data->saved_wm8785_registers[1]); 174 } 175 176 static void wm8785_init(struct oxygen *chip) 177 { 178 struct generic_data *data = chip->model_data; 179 180 data->saved_wm8785_registers[0] = WM8785_MCR_SLAVE | 181 WM8785_OSR_SINGLE | WM8785_FORMAT_LJUST; 182 data->saved_wm8785_registers[1] = WM8785_WL_24; 183 wm8785_registers_init(chip); 184 snd_component_add(chip->card, "WM8785"); 185 } 186 187 static void generic_init(struct oxygen *chip) 188 { 189 ak4396_init(chip); 190 wm8785_init(chip); 191 } 192 193 static void meridian_init(struct oxygen *chip) 194 { 195 ak4396_init(chip); 196 ak5385_init(chip); 197 } 198 199 static void generic_cleanup(struct oxygen *chip) 200 { 201 } 202 203 static void generic_resume(struct oxygen *chip) 204 { 205 ak4396_registers_init(chip); 206 wm8785_registers_init(chip); 207 } 208 209 static void meridian_resume(struct oxygen *chip) 210 { 211 ak4396_registers_init(chip); 212 } 213 214 static void set_ak4396_params(struct oxygen *chip, 215 struct snd_pcm_hw_params *params) 216 { 217 struct generic_data *data = chip->model_data; 218 unsigned int i; 219 u8 value; 220 221 value = data->ak4396_ctl2 & ~AK4396_DFS_MASK; 222 if (params_rate(params) <= 54000) 223 value |= AK4396_DFS_NORMAL; 224 else if (params_rate(params) <= 108000) 225 value |= AK4396_DFS_DOUBLE; 226 else 227 value |= AK4396_DFS_QUAD; 228 data->ak4396_ctl2 = value; 229 230 msleep(1); /* wait for the new MCLK to become stable */ 231 232 for (i = 0; i < 4; ++i) { 233 ak4396_write(chip, i, 234 AK4396_CONTROL_1, AK4396_DIF_24_MSB); 235 ak4396_write(chip, i, 236 AK4396_CONTROL_2, value); 237 ak4396_write(chip, i, 238 AK4396_CONTROL_1, AK4396_DIF_24_MSB | AK4396_RSTN); 239 } 240 } 241 242 static void update_ak4396_mute(struct oxygen *chip) 243 { 244 struct generic_data *data = chip->model_data; 245 unsigned int i; 246 u8 value; 247 248 value = data->ak4396_ctl2 & ~AK4396_SMUTE; 249 if (chip->dac_mute) 250 value |= AK4396_SMUTE; 251 data->ak4396_ctl2 = value; 252 for (i = 0; i < 4; ++i) 253 ak4396_write(chip, i, AK4396_CONTROL_2, value); 254 } 255 256 static void set_wm8785_params(struct oxygen *chip, 257 struct snd_pcm_hw_params *params) 258 { 259 unsigned int value; 260 261 wm8785_write(chip, WM8785_R7, 0); 262 263 value = WM8785_MCR_SLAVE | WM8785_FORMAT_LJUST; 264 if (params_rate(params) <= 48000) 265 value |= WM8785_OSR_SINGLE; 266 else if (params_rate(params) <= 96000) 267 value |= WM8785_OSR_DOUBLE; 268 else 269 value |= WM8785_OSR_QUAD; 270 wm8785_write(chip, WM8785_R0, value); 271 272 if (snd_pcm_format_width(params_format(params)) <= 16) 273 value = WM8785_WL_16; 274 else 275 value = WM8785_WL_24; 276 wm8785_write(chip, WM8785_R1, value); 277 } 278 279 static void set_ak5385_params(struct oxygen *chip, 280 struct snd_pcm_hw_params *params) 281 { 282 unsigned int value; 283 284 if (params_rate(params) <= 54000) 285 value = GPIO_AK5385_DFS_NORMAL; 286 else if (params_rate(params) <= 108000) 287 value = GPIO_AK5385_DFS_DOUBLE; 288 else 289 value = GPIO_AK5385_DFS_QUAD; 290 oxygen_write16_masked(chip, OXYGEN_GPIO_DATA, 291 value, GPIO_AK5385_DFS_MASK); 292 } 293 294 static const DECLARE_TLV_DB_LINEAR(ak4396_db_scale, TLV_DB_GAIN_MUTE, 0); 295 296 static int generic_probe(struct oxygen *chip, unsigned long driver_data) 297 { 298 if (driver_data == MODEL_MERIDIAN) { 299 chip->model.init = meridian_init; 300 chip->model.resume = meridian_resume; 301 chip->model.set_adc_params = set_ak5385_params; 302 chip->model.device_config = PLAYBACK_0_TO_I2S | 303 PLAYBACK_1_TO_SPDIF | 304 CAPTURE_0_FROM_I2S_2 | 305 CAPTURE_1_FROM_SPDIF; 306 } 307 if (driver_data == MODEL_MERIDIAN || driver_data == MODEL_HALO) { 308 chip->model.misc_flags = OXYGEN_MISC_MIDI; 309 chip->model.device_config |= MIDI_OUTPUT | MIDI_INPUT; 310 } 311 return 0; 312 } 313 314 static const struct oxygen_model model_generic = { 315 .shortname = "C-Media CMI8788", 316 .longname = "C-Media Oxygen HD Audio", 317 .chip = "CMI8788", 318 .owner = THIS_MODULE, 319 .probe = generic_probe, 320 .init = generic_init, 321 .cleanup = generic_cleanup, 322 .resume = generic_resume, 323 .set_dac_params = set_ak4396_params, 324 .set_adc_params = set_wm8785_params, 325 .update_dac_volume = update_ak4396_volume, 326 .update_dac_mute = update_ak4396_mute, 327 .dac_tlv = ak4396_db_scale, 328 .model_data_size = sizeof(struct generic_data), 329 .device_config = PLAYBACK_0_TO_I2S | 330 PLAYBACK_1_TO_SPDIF | 331 PLAYBACK_2_TO_AC97_1 | 332 CAPTURE_0_FROM_I2S_1 | 333 CAPTURE_1_FROM_SPDIF | 334 CAPTURE_2_FROM_AC97_1, 335 .dac_channels = 8, 336 .dac_volume_min = 0, 337 .dac_volume_max = 255, 338 .function_flags = OXYGEN_FUNCTION_SPI | 339 OXYGEN_FUNCTION_ENABLE_SPI_4_5, 340 .dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST, 341 .adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST, 342 }; 343 344 static int __devinit generic_oxygen_probe(struct pci_dev *pci, 345 const struct pci_device_id *pci_id) 346 { 347 static int dev; 348 int err; 349 350 if (dev >= SNDRV_CARDS) 351 return -ENODEV; 352 if (!enable[dev]) { 353 ++dev; 354 return -ENOENT; 355 } 356 err = oxygen_pci_probe(pci, index[dev], id[dev], 357 &model_generic, pci_id->driver_data); 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