2
* ALSA driver for ICEnsemble VT1724 (Envy24HT)
4
* Lowlevel functions for ESI Juli@ cards
6
* Copyright (c) 2004 Jaroslav Kysela <perex@perex.cz>
7
* 2008 Pavel Hofman <dustin@seznam.cz>
10
* This program is free software; you can redistribute it and/or modify
11
* it under the terms of the GNU General Public License as published by
12
* the Free Software Foundation; either version 2 of the License, or
13
* (at your option) any later version.
15
* This program is distributed in the hope that it will be useful,
16
* but WITHOUT ANY WARRANTY; without even the implied warranty of
17
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
18
* GNU General Public License for more details.
20
* You should have received a copy of the GNU General Public License
21
* along with this program; if not, write to the Free Software
22
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
27
#include <linux/delay.h>
28
#include <linux/interrupt.h>
29
#include <linux/init.h>
30
#include <linux/slab.h>
31
#include <sound/core.h>
32
#include <sound/tlv.h>
39
struct ak4114 *ak4114;
40
unsigned int analog:1;
44
* chip addresses on I2C bus
46
#define AK4114_ADDR 0x20 /* S/PDIF receiver */
47
#define AK4358_ADDR 0x22 /* DAC */
50
* Juli does not use the standard ICE1724 clock scheme. Juli's ice1724 chip is
51
* supplied by external clock provided by Xilinx array and MK73-1 PLL frequency
52
* multiplier. Actual frequency is set by ice1724 GPIOs hooked to the Xilinx.
54
* The clock circuitry is supplied by the two ice1724 crystals. This
55
* arrangement allows to generate independent clock signal for AK4114's input
56
* rate detection circuit. As a result, Juli, unlike most other
57
* ice1724+ak4114-based cards, detects spdif input rate correctly.
58
* This fact is applied in the driver, allowing to modify PCM stream rate
59
* parameter according to the actual input rate.
61
* Juli uses the remaining three stereo-channels of its DAC to optionally
62
* monitor analog input, digital input, and digital output. The corresponding
63
* I2S signals are routed by Xilinx, controlled by GPIOs.
65
* The master mute is implemented using output muting transistors (GPIO) in
66
* combination with smuting the DAC.
68
* The card itself has no HW master volume control, implemented using the
72
* researching and fixing the input monitors
78
#define GPIO_FREQ_MASK (3<<0)
79
#define GPIO_FREQ_32KHZ (0<<0)
80
#define GPIO_FREQ_44KHZ (1<<0)
81
#define GPIO_FREQ_48KHZ (2<<0)
82
#define GPIO_MULTI_MASK (3<<2)
83
#define GPIO_MULTI_4X (0<<2)
84
#define GPIO_MULTI_2X (1<<2)
85
#define GPIO_MULTI_1X (2<<2) /* also external */
86
#define GPIO_MULTI_HALF (3<<2)
87
#define GPIO_INTERNAL_CLOCK (1<<4) /* 0 = external, 1 = internal */
88
#define GPIO_CLOCK_MASK (1<<4)
89
#define GPIO_ANALOG_PRESENT (1<<5) /* RO only: 0 = present */
90
#define GPIO_RXMCLK_SEL (1<<7) /* must be 0 */
91
#define GPIO_AK5385A_CKS0 (1<<8)
92
#define GPIO_AK5385A_DFS1 (1<<9)
93
#define GPIO_AK5385A_DFS0 (1<<10)
94
#define GPIO_DIGOUT_MONITOR (1<<11) /* 1 = active */
95
#define GPIO_DIGIN_MONITOR (1<<12) /* 1 = active */
96
#define GPIO_ANAIN_MONITOR (1<<13) /* 1 = active */
97
#define GPIO_AK5385A_CKS1 (1<<14) /* must be 0 */
98
#define GPIO_MUTE_CONTROL (1<<15) /* output mute, 1 = muted */
100
#define GPIO_RATE_MASK (GPIO_FREQ_MASK | GPIO_MULTI_MASK | \
102
#define GPIO_AK5385A_MASK (GPIO_AK5385A_CKS0 | GPIO_AK5385A_DFS0 | \
103
GPIO_AK5385A_DFS1 | GPIO_AK5385A_CKS1)
105
#define JULI_PCM_RATE (SNDRV_PCM_RATE_16000 | SNDRV_PCM_RATE_22050 | \
106
SNDRV_PCM_RATE_32000 | SNDRV_PCM_RATE_44100 | \
107
SNDRV_PCM_RATE_48000 | SNDRV_PCM_RATE_64000 | \
108
SNDRV_PCM_RATE_88200 | SNDRV_PCM_RATE_96000 | \
109
SNDRV_PCM_RATE_176400 | SNDRV_PCM_RATE_192000)
111
#define GPIO_RATE_16000 (GPIO_FREQ_32KHZ | GPIO_MULTI_HALF | \
113
#define GPIO_RATE_22050 (GPIO_FREQ_44KHZ | GPIO_MULTI_HALF | \
115
#define GPIO_RATE_24000 (GPIO_FREQ_48KHZ | GPIO_MULTI_HALF | \
117
#define GPIO_RATE_32000 (GPIO_FREQ_32KHZ | GPIO_MULTI_1X | \
119
#define GPIO_RATE_44100 (GPIO_FREQ_44KHZ | GPIO_MULTI_1X | \
121
#define GPIO_RATE_48000 (GPIO_FREQ_48KHZ | GPIO_MULTI_1X | \
123
#define GPIO_RATE_64000 (GPIO_FREQ_32KHZ | GPIO_MULTI_2X | \
125
#define GPIO_RATE_88200 (GPIO_FREQ_44KHZ | GPIO_MULTI_2X | \
127
#define GPIO_RATE_96000 (GPIO_FREQ_48KHZ | GPIO_MULTI_2X | \
129
#define GPIO_RATE_176400 (GPIO_FREQ_44KHZ | GPIO_MULTI_4X | \
131
#define GPIO_RATE_192000 (GPIO_FREQ_48KHZ | GPIO_MULTI_4X | \
135
* Initial setup of the conversion array GPIO <-> rate
137
static unsigned int juli_rates[] = {
138
16000, 22050, 24000, 32000,
139
44100, 48000, 64000, 88200,
140
96000, 176400, 192000,
143
static unsigned int gpio_vals[] = {
144
GPIO_RATE_16000, GPIO_RATE_22050, GPIO_RATE_24000, GPIO_RATE_32000,
145
GPIO_RATE_44100, GPIO_RATE_48000, GPIO_RATE_64000, GPIO_RATE_88200,
146
GPIO_RATE_96000, GPIO_RATE_176400, GPIO_RATE_192000,
149
static struct snd_pcm_hw_constraint_list juli_rates_info = {
150
.count = ARRAY_SIZE(juli_rates),
155
static int get_gpio_val(int rate)
158
for (i = 0; i < ARRAY_SIZE(juli_rates); i++)
159
if (juli_rates[i] == rate)
164
static void juli_ak4114_write(void *private_data, unsigned char reg,
167
snd_vt1724_write_i2c((struct snd_ice1712 *)private_data, AK4114_ADDR,
171
static unsigned char juli_ak4114_read(void *private_data, unsigned char reg)
173
return snd_vt1724_read_i2c((struct snd_ice1712 *)private_data,
178
* If SPDIF capture and slaved to SPDIF-IN, setting runtime rate
179
* to the external rate
181
static void juli_spdif_in_open(struct snd_ice1712 *ice,
182
struct snd_pcm_substream *substream)
184
struct juli_spec *spec = ice->spec;
185
struct snd_pcm_runtime *runtime = substream->runtime;
188
if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK ||
189
!ice->is_spdif_master(ice))
191
rate = snd_ak4114_external_rate(spec->ak4114);
192
if (rate >= runtime->hw.rate_min && rate <= runtime->hw.rate_max) {
193
runtime->hw.rate_min = rate;
194
runtime->hw.rate_max = rate;
202
static void juli_akm_lock(struct snd_akm4xxx *ak, int chip)
206
static void juli_akm_unlock(struct snd_akm4xxx *ak, int chip)
210
static void juli_akm_write(struct snd_akm4xxx *ak, int chip,
211
unsigned char addr, unsigned char data)
213
struct snd_ice1712 *ice = ak->private_data[0];
215
if (snd_BUG_ON(chip))
217
snd_vt1724_write_i2c(ice, AK4358_ADDR, addr, data);
221
* change the rate of envy24HT, AK4358, AK5385
223
static void juli_akm_set_rate_val(struct snd_akm4xxx *ak, unsigned int rate)
225
unsigned char old, tmp, ak4358_dfs;
226
unsigned int ak5385_pins, old_gpio, new_gpio;
227
struct snd_ice1712 *ice = ak->private_data[0];
228
struct juli_spec *spec = ice->spec;
230
if (rate == 0) /* no hint - S/PDIF input is master or the new spdif
231
input rate undetected, simply return */
234
/* adjust DFS on codecs */
237
ak5385_pins = GPIO_AK5385A_DFS1 | GPIO_AK5385A_CKS0;
238
} else if (rate > 48000) {
240
ak5385_pins = GPIO_AK5385A_DFS0;
245
/* AK5385 first, since it requires cold reset affecting both codecs */
246
old_gpio = ice->gpio.get_data(ice);
247
new_gpio = (old_gpio & ~GPIO_AK5385A_MASK) | ak5385_pins;
248
/* printk(KERN_DEBUG "JULI - ak5385 set_rate_val: new gpio 0x%x\n",
250
ice->gpio.set_data(ice, new_gpio);
253
old = inb(ICEMT1724(ice, AC97_CMD));
254
outb(old | VT1724_AC97_COLD, ICEMT1724(ice, AC97_CMD));
256
outb(old & ~VT1724_AC97_COLD, ICEMT1724(ice, AC97_CMD));
259
/* set new value, reset DFS */
260
tmp = snd_akm4xxx_get(ak, 0, 2);
261
snd_akm4xxx_reset(ak, 1);
262
tmp = snd_akm4xxx_get(ak, 0, 2);
264
tmp |= ak4358_dfs << 4;
265
snd_akm4xxx_set(ak, 0, 2, tmp);
266
snd_akm4xxx_reset(ak, 0);
269
snd_ak4114_reinit(spec->ak4114);
272
#define AK_DAC(xname, xch) { .name = xname, .num_channels = xch }
273
#define PCM_VOLUME "PCM Playback Volume"
274
#define MONITOR_AN_IN_VOLUME "Monitor Analog In Volume"
275
#define MONITOR_DIG_IN_VOLUME "Monitor Digital In Volume"
276
#define MONITOR_DIG_OUT_VOLUME "Monitor Digital Out Volume"
278
static const struct snd_akm4xxx_dac_channel juli_dac[] = {
279
AK_DAC(PCM_VOLUME, 2),
280
AK_DAC(MONITOR_AN_IN_VOLUME, 2),
281
AK_DAC(MONITOR_DIG_OUT_VOLUME, 2),
282
AK_DAC(MONITOR_DIG_IN_VOLUME, 2),
286
static struct snd_akm4xxx akm_juli_dac __devinitdata = {
288
.num_dacs = 8, /* DAC1 - analog out
289
DAC2 - analog in monitor
290
DAC3 - digital out monitor
291
DAC4 - digital in monitor
294
.lock = juli_akm_lock,
295
.unlock = juli_akm_unlock,
296
.write = juli_akm_write,
297
.set_rate_val = juli_akm_set_rate_val
299
.dac_info = juli_dac,
302
#define juli_mute_info snd_ctl_boolean_mono_info
304
static int juli_mute_get(struct snd_kcontrol *kcontrol,
305
struct snd_ctl_elem_value *ucontrol)
307
struct snd_ice1712 *ice = snd_kcontrol_chip(kcontrol);
309
val = ice->gpio.get_data(ice) & (unsigned int) kcontrol->private_value;
310
if (kcontrol->private_value == GPIO_MUTE_CONTROL)
311
/* val 0 = signal on */
312
ucontrol->value.integer.value[0] = (val) ? 0 : 1;
314
/* val 1 = signal on */
315
ucontrol->value.integer.value[0] = (val) ? 1 : 0;
319
static int juli_mute_put(struct snd_kcontrol *kcontrol,
320
struct snd_ctl_elem_value *ucontrol)
322
struct snd_ice1712 *ice = snd_kcontrol_chip(kcontrol);
323
unsigned int old_gpio, new_gpio;
324
old_gpio = ice->gpio.get_data(ice);
325
if (ucontrol->value.integer.value[0]) {
327
if (kcontrol->private_value == GPIO_MUTE_CONTROL) {
329
new_gpio = old_gpio & ~GPIO_MUTE_CONTROL;
331
snd_akm4xxx_write(ice->akm, 0, 0x01, 0x01);
334
new_gpio = old_gpio |
335
(unsigned int) kcontrol->private_value;
338
if (kcontrol->private_value == GPIO_MUTE_CONTROL) {
340
new_gpio = old_gpio | GPIO_MUTE_CONTROL;
342
snd_akm4xxx_write(ice->akm, 0, 0x01, 0x03);
345
new_gpio = old_gpio &
346
~((unsigned int) kcontrol->private_value);
349
"JULI - mute/unmute: control_value: 0x%x, old_gpio: 0x%x, "
351
(unsigned int)ucontrol->value.integer.value[0], old_gpio,
353
if (old_gpio != new_gpio) {
354
ice->gpio.set_data(ice, new_gpio);
361
static struct snd_kcontrol_new juli_mute_controls[] __devinitdata = {
363
.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
364
.name = "Master Playback Switch",
365
.info = juli_mute_info,
366
.get = juli_mute_get,
367
.put = juli_mute_put,
368
.private_value = GPIO_MUTE_CONTROL,
370
/* Although the following functionality respects the succint NDA'd
371
* documentation from the card manufacturer, and the same way of
372
* operation is coded in OSS Juli driver, only Digital Out monitor
373
* seems to work. Surprisingly, Analog input monitor outputs Digital
374
* output data. The two are independent, as enabling both doubles
375
* volume of the monitor sound.
377
* Checking traces on the board suggests the functionality described
378
* by the manufacturer is correct - I2S from ADC and AK4114
379
* go to ICE as well as to Xilinx, I2S inputs of DAC2,3,4 (the monitor
380
* inputs) are fed from Xilinx.
382
* I even checked traces on board and coded a support in driver for
383
* an alternative possibility - the unused I2S ICE output channels
384
* switched to HW-IN/SPDIF-IN and providing the monitoring signal to
385
* the DAC - to no avail. The I2S outputs seem to be unconnected.
387
* The windows driver supports the monitoring correctly.
390
.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
391
.name = "Monitor Analog In Switch",
392
.info = juli_mute_info,
393
.get = juli_mute_get,
394
.put = juli_mute_put,
395
.private_value = GPIO_ANAIN_MONITOR,
398
.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
399
.name = "Monitor Digital Out Switch",
400
.info = juli_mute_info,
401
.get = juli_mute_get,
402
.put = juli_mute_put,
403
.private_value = GPIO_DIGOUT_MONITOR,
406
.iface = SNDRV_CTL_ELEM_IFACE_MIXER,
407
.name = "Monitor Digital In Switch",
408
.info = juli_mute_info,
409
.get = juli_mute_get,
410
.put = juli_mute_put,
411
.private_value = GPIO_DIGIN_MONITOR,
415
static char *slave_vols[] __devinitdata = {
417
MONITOR_AN_IN_VOLUME,
418
MONITOR_DIG_IN_VOLUME,
419
MONITOR_DIG_OUT_VOLUME,
424
DECLARE_TLV_DB_SCALE(juli_master_db_scale, -6350, 50, 1);
426
static struct snd_kcontrol __devinit *ctl_find(struct snd_card *card,
429
struct snd_ctl_elem_id sid;
430
memset(&sid, 0, sizeof(sid));
431
/* FIXME: strcpy is bad. */
432
strcpy(sid.name, name);
433
sid.iface = SNDRV_CTL_ELEM_IFACE_MIXER;
434
return snd_ctl_find_id(card, &sid);
437
static void __devinit add_slaves(struct snd_card *card,
438
struct snd_kcontrol *master, char **list)
440
for (; *list; list++) {
441
struct snd_kcontrol *slave = ctl_find(card, *list);
442
/* printk(KERN_DEBUG "add_slaves - %s\n", *list); */
444
/* printk(KERN_DEBUG "slave %s found\n", *list); */
445
snd_ctl_add_slave(master, slave);
450
static int __devinit juli_add_controls(struct snd_ice1712 *ice)
452
struct juli_spec *spec = ice->spec;
455
struct snd_kcontrol *vmaster;
457
err = snd_ice1712_akm4xxx_build_controls(ice);
461
for (i = 0; i < ARRAY_SIZE(juli_mute_controls); i++) {
462
err = snd_ctl_add(ice->card,
463
snd_ctl_new1(&juli_mute_controls[i], ice));
467
/* Create virtual master control */
468
vmaster = snd_ctl_make_virtual_master("Master Playback Volume",
469
juli_master_db_scale);
472
add_slaves(ice->card, vmaster, slave_vols);
473
err = snd_ctl_add(ice->card, vmaster);
477
/* only capture SPDIF over AK4114 */
478
err = snd_ak4114_build(spec->ak4114, NULL,
479
ice->pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream);
490
static int juli_resume(struct snd_ice1712 *ice)
492
struct snd_akm4xxx *ak = ice->akm;
493
struct juli_spec *spec = ice->spec;
494
/* akm4358 un-reset, un-mute */
495
snd_akm4xxx_reset(ak, 0);
497
snd_ak4114_reinit(spec->ak4114);
501
static int juli_suspend(struct snd_ice1712 *ice)
503
struct snd_akm4xxx *ak = ice->akm;
504
/* akm4358 reset and soft-mute */
505
snd_akm4xxx_reset(ak, 1);
511
* initialize the chip
514
static inline int juli_is_spdif_master(struct snd_ice1712 *ice)
516
return (ice->gpio.get_data(ice) & GPIO_INTERNAL_CLOCK) ? 0 : 1;
519
static unsigned int juli_get_rate(struct snd_ice1712 *ice)
522
unsigned char result;
524
result = ice->gpio.get_data(ice) & GPIO_RATE_MASK;
525
for (i = 0; i < ARRAY_SIZE(gpio_vals); i++)
526
if (gpio_vals[i] == result)
527
return juli_rates[i];
531
/* setting new rate */
532
static void juli_set_rate(struct snd_ice1712 *ice, unsigned int rate)
534
unsigned int old, new;
537
old = ice->gpio.get_data(ice);
538
new = (old & ~GPIO_RATE_MASK) | get_gpio_val(rate);
539
/* printk(KERN_DEBUG "JULI - set_rate: old %x, new %x\n",
540
old & GPIO_RATE_MASK,
541
new & GPIO_RATE_MASK); */
543
ice->gpio.set_data(ice, new);
544
/* switching to external clock - supplied by external circuits */
545
val = inb(ICEMT1724(ice, RATE));
546
outb(val | VT1724_SPDIF_MASTER, ICEMT1724(ice, RATE));
549
static inline unsigned char juli_set_mclk(struct snd_ice1712 *ice,
552
/* no change in master clock */
556
/* setting clock to external - SPDIF */
557
static int juli_set_spdif_clock(struct snd_ice1712 *ice, int type)
560
old = ice->gpio.get_data(ice);
561
/* external clock (= 0), multiply 1x, 48kHz */
562
ice->gpio.set_data(ice, (old & ~GPIO_RATE_MASK) | GPIO_MULTI_1X |
567
/* Called when ak4114 detects change in the input SPDIF stream */
568
static void juli_ak4114_change(struct ak4114 *ak4114, unsigned char c0,
571
struct snd_ice1712 *ice = ak4114->change_callback_private;
573
if (ice->is_spdif_master(ice) && c1) {
574
/* only for SPDIF master mode, rate was changed */
575
rate = snd_ak4114_external_rate(ak4114);
576
/* printk(KERN_DEBUG "ak4114 - input rate changed to %d\n",
578
juli_akm_set_rate_val(ice->akm, rate);
582
static int __devinit juli_init(struct snd_ice1712 *ice)
584
static const unsigned char ak4114_init_vals[] = {
585
/* AK4117_REG_PWRDN */ AK4114_RST | AK4114_PWN |
586
AK4114_OCKS0 | AK4114_OCKS1,
587
/* AK4114_REQ_FORMAT */ AK4114_DIF_I24I2S,
588
/* AK4114_REG_IO0 */ AK4114_TX1E,
589
/* AK4114_REG_IO1 */ AK4114_EFH_1024 | AK4114_DIT |
591
/* AK4114_REG_INT0_MASK */ 0,
592
/* AK4114_REG_INT1_MASK */ 0
594
static const unsigned char ak4114_init_txcsb[] = {
595
0x41, 0x02, 0x2c, 0x00, 0x00
598
struct juli_spec *spec;
599
struct snd_akm4xxx *ak;
601
spec = kzalloc(sizeof(*spec), GFP_KERNEL);
606
err = snd_ak4114_create(ice->card,
609
ak4114_init_vals, ak4114_init_txcsb,
613
/* callback for codecs rate setting */
614
spec->ak4114->change_callback = juli_ak4114_change;
615
spec->ak4114->change_callback_private = ice;
616
/* AK4114 in Juli can detect external rate correctly */
617
spec->ak4114->check_flags = 0;
621
* it seems that the analog doughter board detection does not work reliably, so
622
* force the analog flag; it should be very rare (if ever) to come at Juli@
623
* used without the analog daughter board
625
spec->analog = (ice->gpio.get_data(ice) & GPIO_ANALOG_PRESENT) ? 0 : 1;
631
printk(KERN_INFO "juli@: analog I/O detected\n");
632
ice->num_total_dacs = 2;
633
ice->num_total_adcs = 2;
635
ice->akm = kzalloc(sizeof(struct snd_akm4xxx), GFP_KERNEL);
640
err = snd_ice1712_akm4xxx_init(ak, &akm_juli_dac, NULL, ice);
645
/* juli is clocked by Xilinx array */
646
ice->hw_rates = &juli_rates_info;
647
ice->is_spdif_master = juli_is_spdif_master;
648
ice->get_rate = juli_get_rate;
649
ice->set_rate = juli_set_rate;
650
ice->set_mclk = juli_set_mclk;
651
ice->set_spdif_clock = juli_set_spdif_clock;
653
ice->spdif.ops.open = juli_spdif_in_open;
656
ice->pm_resume = juli_resume;
657
ice->pm_suspend = juli_suspend;
658
ice->pm_suspend_enabled = 1;
666
* Juli@ boards don't provide the EEPROM data except for the vendor IDs.
667
* hence the driver needs to sets up it properly.
670
static unsigned char juli_eeprom[] __devinitdata = {
671
[ICE_EEP2_SYSCONF] = 0x2b, /* clock 512, mpu401, 1xADC, 1xDACs,
673
[ICE_EEP2_ACLINK] = 0x80, /* I2S */
674
[ICE_EEP2_I2S] = 0xf8, /* vol, 96k, 24bit, 192k */
675
[ICE_EEP2_SPDIF] = 0xc3, /* out-en, out-int, spdif-in */
676
[ICE_EEP2_GPIO_DIR] = 0x9f, /* 5, 6:inputs; 7, 4-0 outputs*/
677
[ICE_EEP2_GPIO_DIR1] = 0xff,
678
[ICE_EEP2_GPIO_DIR2] = 0x7f,
679
[ICE_EEP2_GPIO_MASK] = 0x60, /* 5, 6: locked; 7, 4-0 writable */
680
[ICE_EEP2_GPIO_MASK1] = 0x00, /* 0-7 writable */
681
[ICE_EEP2_GPIO_MASK2] = 0x7f,
682
[ICE_EEP2_GPIO_STATE] = GPIO_FREQ_48KHZ | GPIO_MULTI_1X |
683
GPIO_INTERNAL_CLOCK, /* internal clock, multiple 1x, 48kHz*/
684
[ICE_EEP2_GPIO_STATE1] = 0x00, /* unmuted */
685
[ICE_EEP2_GPIO_STATE2] = 0x00,
689
struct snd_ice1712_card_info snd_vt1724_juli_cards[] __devinitdata = {
691
.subvendor = VT1724_SUBDEVICE_JULI,
694
.chip_init = juli_init,
695
.build_controls = juli_add_controls,
696
.eeprom_size = sizeof(juli_eeprom),
697
.eeprom_data = juli_eeprom,