oxygen.c 11.3 KB
Newer Older
C
Clemens Ladisch 已提交
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
/*
 * C-Media CMI8788 driver for C-Media's reference design and for the X-Meridian
 *
 * Copyright (c) Clemens Ladisch <clemens@ladisch.de>
 *
 *
 *  This driver is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License, version 2.
 *
 *  This driver is distributed in the hope that it will be useful,
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *  GNU General Public License for more details.
 *
 *  You should have received a copy of the GNU General Public License
 *  along with this driver; if not, write to the Free Software
 *  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
 */

/*
 * SPI 0 -> 1st AK4396 (front)
22
 * SPI 1 -> 2nd AK4396 (surround)
C
Clemens Ladisch 已提交
23 24
 * SPI 2 -> 3rd AK4396 (center/LFE)
 * SPI 3 -> WM8785
25
 * SPI 4 -> 4th AK4396 (back)
C
Clemens Ladisch 已提交
26 27 28 29 30 31
 *
 * GPIO 0 -> DFS0 of AK5385
 * GPIO 1 -> DFS1 of AK5385
 */

#include <linux/pci.h>
32
#include <sound/control.h>
C
Clemens Ladisch 已提交
33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72
#include <sound/core.h>
#include <sound/initval.h>
#include <sound/pcm.h>
#include <sound/pcm_params.h>
#include <sound/tlv.h>
#include "oxygen.h"

MODULE_AUTHOR("Clemens Ladisch <clemens@ladisch.de>");
MODULE_DESCRIPTION("C-Media CMI8788 driver");
MODULE_LICENSE("GPL");
MODULE_SUPPORTED_DEVICE("{{C-Media,CMI8788}}");

static int index[SNDRV_CARDS] = SNDRV_DEFAULT_IDX;
static char *id[SNDRV_CARDS] = SNDRV_DEFAULT_STR;
static int enable[SNDRV_CARDS] = SNDRV_DEFAULT_ENABLE_PNP;

module_param_array(index, int, NULL, 0444);
MODULE_PARM_DESC(index, "card index");
module_param_array(id, charp, NULL, 0444);
MODULE_PARM_DESC(id, "ID string");
module_param_array(enable, bool, NULL, 0444);
MODULE_PARM_DESC(enable, "enable card");

static struct pci_device_id oxygen_ids[] __devinitdata = {
	{ OXYGEN_PCI_SUBID(0x10b0, 0x0216) },
	{ OXYGEN_PCI_SUBID(0x10b0, 0x0218) },
	{ OXYGEN_PCI_SUBID(0x10b0, 0x0219) },
	{ OXYGEN_PCI_SUBID(0x13f6, 0x0001) },
	{ OXYGEN_PCI_SUBID(0x13f6, 0x0010) },
	{ OXYGEN_PCI_SUBID(0x13f6, 0x8788) },
	{ OXYGEN_PCI_SUBID(0x147a, 0xa017) },
	{ OXYGEN_PCI_SUBID(0x14c3, 0x1710) },
	{ OXYGEN_PCI_SUBID(0x14c3, 0x1711) },
	{ OXYGEN_PCI_SUBID(0x1a58, 0x0910) },
	{ OXYGEN_PCI_SUBID(0x415a, 0x5431), .driver_data = 1 },
	{ OXYGEN_PCI_SUBID(0x7284, 0x9761) },
	{ }
};
MODULE_DEVICE_TABLE(pci, oxygen_ids);

73 74 75 76 77 78

#define GPIO_AK5385_DFS_MASK	0x0003
#define GPIO_AK5385_DFS_NORMAL	0x0000
#define GPIO_AK5385_DFS_DOUBLE	0x0001
#define GPIO_AK5385_DFS_QUAD	0x0002

C
Clemens Ladisch 已提交
79 80
#define AK4396_WRITE	0x2000

81 82 83 84 85 86 87
#define AK4396_CONTROL_1	0
#define AK4396_CONTROL_2	1
#define AK4396_CONTROL_3	2
#define AK4396_LCH_ATT		3
#define AK4396_RCH_ATT		4

/* control 1 */
C
Clemens Ladisch 已提交
88
#define AK4396_RSTN		0x01
89 90 91
#define AK4396_DIF_MASK		0x0e
#define AK4396_DIF_16_LSB	0x00
#define AK4396_DIF_20_LSB	0x02
C
Clemens Ladisch 已提交
92
#define AK4396_DIF_24_MSB	0x04
93 94 95 96
#define AK4396_DIF_24_I2S	0x06
#define AK4396_DIF_24_LSB	0x08
#define AK4396_ACKS		0x80
/* control 2 */
C
Clemens Ladisch 已提交
97
#define AK4396_SMUTE		0x01
98 99
#define AK4396_DEM_MASK		0x06
#define AK4396_DEM_441		0x00
C
Clemens Ladisch 已提交
100
#define AK4396_DEM_OFF		0x02
101 102
#define AK4396_DEM_48		0x04
#define AK4396_DEM_32		0x06
C
Clemens Ladisch 已提交
103 104 105 106
#define AK4396_DFS_MASK		0x18
#define AK4396_DFS_NORMAL	0x00
#define AK4396_DFS_DOUBLE	0x08
#define AK4396_DFS_QUAD		0x10
107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133
#define AK4396_SLOW		0x20
#define AK4396_DZFM		0x40
#define AK4396_DZFE		0x80
/* control 3 */
#define AK4396_DZFB		0x04
#define AK4396_DCKB		0x10
#define AK4396_DCKS		0x20
#define AK4396_DSDM		0x40
#define AK4396_D_P_MASK		0x80
#define AK4396_PCM		0x00
#define AK4396_DSD		0x80

#define WM8785_R0	0
#define WM8785_R1	1
#define WM8785_R2	2
#define WM8785_R7	7

/* R0 */
#define WM8785_MCR_MASK		0x007
#define WM8785_MCR_SLAVE	0x000
#define WM8785_MCR_MASTER_128	0x001
#define WM8785_MCR_MASTER_192	0x002
#define WM8785_MCR_MASTER_256	0x003
#define WM8785_MCR_MASTER_384	0x004
#define WM8785_MCR_MASTER_512	0x005
#define WM8785_MCR_MASTER_768	0x006
#define WM8785_OSR_MASK		0x018
C
Clemens Ladisch 已提交
134 135 136
#define WM8785_OSR_SINGLE	0x000
#define WM8785_OSR_DOUBLE	0x008
#define WM8785_OSR_QUAD		0x010
137 138
#define WM8785_FORMAT_MASK	0x060
#define WM8785_FORMAT_RJUST	0x000
C
Clemens Ladisch 已提交
139 140
#define WM8785_FORMAT_LJUST	0x020
#define WM8785_FORMAT_I2S	0x040
141 142 143
#define WM8785_FORMAT_DSP	0x060
/* R1 */
#define WM8785_WL_MASK		0x003
C
Clemens Ladisch 已提交
144 145 146 147
#define WM8785_WL_16		0x000
#define WM8785_WL_20		0x001
#define WM8785_WL_24		0x002
#define WM8785_WL_32		0x003
148 149 150 151 152 153 154 155 156 157 158
#define WM8785_LRP		0x004
#define WM8785_BCLKINV		0x008
#define WM8785_LRSWAP		0x010
#define WM8785_DEVNO_MASK	0x0e0
/* R2 */
#define WM8785_HPFR		0x001
#define WM8785_HPFL		0x002
#define WM8785_SDODIS		0x004
#define WM8785_PWRDNR		0x008
#define WM8785_PWRDNL		0x010
#define WM8785_TDM_MASK		0x1c0
C
Clemens Ladisch 已提交
159

160 161 162 163
struct generic_data {
	u8 ak4396_ctl2;
};

C
Clemens Ladisch 已提交
164 165 166 167 168
static void ak4396_write(struct oxygen *chip, unsigned int codec,
			 u8 reg, u8 value)
{
	/* maps ALSA channel pair number to SPI output */
	static const u8 codec_spi_map[4] = {
169
		0, 1, 2, 4
C
Clemens Ladisch 已提交
170
	};
171
	oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER |
C
Clemens Ladisch 已提交
172
			 OXYGEN_SPI_DATA_LENGTH_2 |
173
			 OXYGEN_SPI_CLOCK_320 |
C
Clemens Ladisch 已提交
174
			 (codec_spi_map[codec] << OXYGEN_SPI_CODEC_SHIFT) |
175
			 OXYGEN_SPI_CEN_LATCH_CLOCK_HI,
C
Clemens Ladisch 已提交
176 177 178 179 180
			 AK4396_WRITE | (reg << 8) | value);
}

static void wm8785_write(struct oxygen *chip, u8 reg, unsigned int value)
{
181
	oxygen_write_spi(chip, OXYGEN_SPI_TRIGGER |
C
Clemens Ladisch 已提交
182
			 OXYGEN_SPI_DATA_LENGTH_2 |
183
			 OXYGEN_SPI_CLOCK_320 |
184 185
			 (3 << OXYGEN_SPI_CODEC_SHIFT) |
			 OXYGEN_SPI_CEN_LATCH_CLOCK_LO,
C
Clemens Ladisch 已提交
186 187 188 189 190
			 (reg << 9) | value);
}

static void ak4396_init(struct oxygen *chip)
{
191
	struct generic_data *data = chip->model_data;
C
Clemens Ladisch 已提交
192 193
	unsigned int i;

194
	data->ak4396_ctl2 = AK4396_DEM_OFF | AK4396_DFS_NORMAL;
C
Clemens Ladisch 已提交
195
	for (i = 0; i < 4; ++i) {
196 197 198
		ak4396_write(chip, i,
			     AK4396_CONTROL_1, AK4396_DIF_24_MSB | AK4396_RSTN);
		ak4396_write(chip, i,
199
			     AK4396_CONTROL_2, data->ak4396_ctl2);
200 201 202 203
		ak4396_write(chip, i,
			     AK4396_CONTROL_3, AK4396_PCM);
		ak4396_write(chip, i, AK4396_LCH_ATT, 0xff);
		ak4396_write(chip, i, AK4396_RCH_ATT, 0xff);
C
Clemens Ladisch 已提交
204 205 206 207 208 209
	}
	snd_component_add(chip->card, "AK4396");
}

static void ak5385_init(struct oxygen *chip)
{
210 211
	oxygen_set_bits16(chip, OXYGEN_GPIO_CONTROL, GPIO_AK5385_DFS_MASK);
	oxygen_clear_bits16(chip, OXYGEN_GPIO_DATA, GPIO_AK5385_DFS_MASK);
C
Clemens Ladisch 已提交
212 213 214 215 216
	snd_component_add(chip->card, "AK5385");
}

static void wm8785_init(struct oxygen *chip)
{
217 218 219 220
	wm8785_write(chip, WM8785_R7, 0);
	wm8785_write(chip, WM8785_R0, WM8785_MCR_SLAVE |
		     WM8785_OSR_SINGLE | WM8785_FORMAT_LJUST);
	wm8785_write(chip, WM8785_R1, WM8785_WL_24);
C
Clemens Ladisch 已提交
221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242
	snd_component_add(chip->card, "WM8785");
}

static void generic_init(struct oxygen *chip)
{
	ak4396_init(chip);
	wm8785_init(chip);
}

static void meridian_init(struct oxygen *chip)
{
	ak4396_init(chip);
	ak5385_init(chip);
}

static void generic_cleanup(struct oxygen *chip)
{
}

static void set_ak4396_params(struct oxygen *chip,
			      struct snd_pcm_hw_params *params)
{
243
	struct generic_data *data = chip->model_data;
C
Clemens Ladisch 已提交
244 245 246
	unsigned int i;
	u8 value;

247
	value = data->ak4396_ctl2 & ~AK4396_DFS_MASK;
C
Clemens Ladisch 已提交
248 249 250 251 252 253
	if (params_rate(params) <= 54000)
		value |= AK4396_DFS_NORMAL;
	else if (params_rate(params) < 120000)
		value |= AK4396_DFS_DOUBLE;
	else
		value |= AK4396_DFS_QUAD;
254
	data->ak4396_ctl2 = value;
C
Clemens Ladisch 已提交
255
	for (i = 0; i < 4; ++i) {
256 257 258 259 260 261
		ak4396_write(chip, i,
			     AK4396_CONTROL_1, AK4396_DIF_24_MSB);
		ak4396_write(chip, i,
			     AK4396_CONTROL_2, value);
		ak4396_write(chip, i,
			     AK4396_CONTROL_1, AK4396_DIF_24_MSB | AK4396_RSTN);
C
Clemens Ladisch 已提交
262 263 264 265 266 267 268 269
	}
}

static void update_ak4396_volume(struct oxygen *chip)
{
	unsigned int i;

	for (i = 0; i < 4; ++i) {
270 271 272 273
		ak4396_write(chip, i,
			     AK4396_LCH_ATT, chip->dac_volume[i * 2]);
		ak4396_write(chip, i,
			     AK4396_RCH_ATT, chip->dac_volume[i * 2 + 1]);
C
Clemens Ladisch 已提交
274 275 276 277 278
	}
}

static void update_ak4396_mute(struct oxygen *chip)
{
279
	struct generic_data *data = chip->model_data;
C
Clemens Ladisch 已提交
280 281 282
	unsigned int i;
	u8 value;

283
	value = data->ak4396_ctl2 & ~AK4396_SMUTE;
C
Clemens Ladisch 已提交
284 285
	if (chip->dac_mute)
		value |= AK4396_SMUTE;
286
	data->ak4396_ctl2 = value;
C
Clemens Ladisch 已提交
287
	for (i = 0; i < 4; ++i)
288
		ak4396_write(chip, i, AK4396_CONTROL_2, value);
C
Clemens Ladisch 已提交
289 290 291 292 293 294 295
}

static void set_wm8785_params(struct oxygen *chip,
			      struct snd_pcm_hw_params *params)
{
	unsigned int value;

296
	wm8785_write(chip, WM8785_R7, 0);
C
Clemens Ladisch 已提交
297

298
	value = WM8785_MCR_SLAVE | WM8785_FORMAT_LJUST;
299 300 301
	if (params_rate(params) <= 48000)
		value |= WM8785_OSR_SINGLE;
	else if (params_rate(params) <= 96000)
C
Clemens Ladisch 已提交
302 303
		value |= WM8785_OSR_DOUBLE;
	else
304
		value |= WM8785_OSR_QUAD;
305
	wm8785_write(chip, WM8785_R0, value);
C
Clemens Ladisch 已提交
306 307 308 309 310

	if (snd_pcm_format_width(params_format(params)) <= 16)
		value = WM8785_WL_16;
	else
		value = WM8785_WL_24;
311
	wm8785_write(chip, WM8785_R1, value);
C
Clemens Ladisch 已提交
312 313 314 315 316 317 318 319
}

static void set_ak5385_params(struct oxygen *chip,
			      struct snd_pcm_hw_params *params)
{
	unsigned int value;

	if (params_rate(params) <= 54000)
320
		value = GPIO_AK5385_DFS_NORMAL;
C
Clemens Ladisch 已提交
321
	else if (params_rate(params) <= 108000)
322
		value = GPIO_AK5385_DFS_DOUBLE;
C
Clemens Ladisch 已提交
323
	else
324 325 326
		value = GPIO_AK5385_DFS_QUAD;
	oxygen_write16_masked(chip, OXYGEN_GPIO_DATA,
			      value, GPIO_AK5385_DFS_MASK);
C
Clemens Ladisch 已提交
327 328 329 330
}

static const DECLARE_TLV_DB_LINEAR(ak4396_db_scale, TLV_DB_GAIN_MUTE, 0);

331 332 333 334 335 336 337 338 339
static int ak4396_control_filter(struct snd_kcontrol_new *template)
{
	if (!strcmp(template->name, "Master Playback Volume")) {
		template->access |= SNDRV_CTL_ELEM_ACCESS_TLV_READ;
		template->tlv.p = ak4396_db_scale;
	}
	return 0;
}

C
Clemens Ladisch 已提交
340 341 342 343 344 345
static const struct oxygen_model model_generic = {
	.shortname = "C-Media CMI8788",
	.longname = "C-Media Oxygen HD Audio",
	.chip = "CMI8788",
	.owner = THIS_MODULE,
	.init = generic_init,
346
	.control_filter = ak4396_control_filter,
C
Clemens Ladisch 已提交
347 348 349 350 351
	.cleanup = generic_cleanup,
	.set_dac_params = set_ak4396_params,
	.set_adc_params = set_wm8785_params,
	.update_dac_volume = update_ak4396_volume,
	.update_dac_mute = update_ak4396_mute,
352
	.model_data_size = sizeof(struct generic_data),
353 354 355 356 357
	.used_channels = OXYGEN_CHANNEL_A |
			 OXYGEN_CHANNEL_C |
			 OXYGEN_CHANNEL_SPDIF |
			 OXYGEN_CHANNEL_MULTICH |
			 OXYGEN_CHANNEL_AC97,
358
	.function_flags = OXYGEN_FUNCTION_ENABLE_SPI_4_5,
359 360
	.dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
	.adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
C
Clemens Ladisch 已提交
361 362 363 364 365 366 367
};
static const struct oxygen_model model_meridian = {
	.shortname = "C-Media CMI8788",
	.longname = "C-Media Oxygen HD Audio",
	.chip = "CMI8788",
	.owner = THIS_MODULE,
	.init = meridian_init,
368
	.control_filter = ak4396_control_filter,
C
Clemens Ladisch 已提交
369 370 371 372 373
	.cleanup = generic_cleanup,
	.set_dac_params = set_ak4396_params,
	.set_adc_params = set_ak5385_params,
	.update_dac_volume = update_ak4396_volume,
	.update_dac_mute = update_ak4396_mute,
374
	.model_data_size = sizeof(struct generic_data),
375 376 377 378 379
	.used_channels = OXYGEN_CHANNEL_B |
			 OXYGEN_CHANNEL_C |
			 OXYGEN_CHANNEL_SPDIF |
			 OXYGEN_CHANNEL_MULTICH |
			 OXYGEN_CHANNEL_AC97,
380
	.function_flags = OXYGEN_FUNCTION_ENABLE_SPI_4_5,
381 382
	.dac_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
	.adc_i2s_format = OXYGEN_I2S_FORMAT_LJUST,
C
Clemens Ladisch 已提交
383 384 385 386 387 388
};

static int __devinit generic_oxygen_probe(struct pci_dev *pci,
					  const struct pci_device_id *pci_id)
{
	static int dev;
389
	int is_meridian;
C
Clemens Ladisch 已提交
390 391 392 393 394 395 396 397
	int err;

	if (dev >= SNDRV_CARDS)
		return -ENODEV;
	if (!enable[dev]) {
		++dev;
		return -ENOENT;
	}
398 399 400
	is_meridian = pci_id->driver_data;
	err = oxygen_pci_probe(pci, index[dev], id[dev], is_meridian,
			       is_meridian ? &model_meridian : &model_generic);
C
Clemens Ladisch 已提交
401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424
	if (err >= 0)
		++dev;
	return err;
}

static struct pci_driver oxygen_driver = {
	.name = "CMI8788",
	.id_table = oxygen_ids,
	.probe = generic_oxygen_probe,
	.remove = __devexit_p(oxygen_pci_remove),
};

static int __init alsa_card_oxygen_init(void)
{
	return pci_register_driver(&oxygen_driver);
}

static void __exit alsa_card_oxygen_exit(void)
{
	pci_unregister_driver(&oxygen_driver);
}

module_init(alsa_card_oxygen_init)
module_exit(alsa_card_oxygen_exit)