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