firmware: Update information in linux.git about adding firmware
[linux/fpc-iii.git] / sound / pci / ice1712 / revo.c
blob1d81ae67757328df9764162b0b92495158ccf89e
1 /*
2 * ALSA driver for ICEnsemble ICE1712 (Envy24)
4 * Lowlevel functions for M-Audio Audiophile 192, Revolution 7.1 and 5.1
6 * Copyright (c) 2003 Takashi Iwai <tiwai@suse.de>
8 * This program is free software; you can redistribute it and/or modify
9 * it under the terms of the GNU General Public License as published by
10 * the Free Software Foundation; either version 2 of the License, or
11 * (at your option) any later version.
13 * This program is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 * GNU General Public License for more details.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, write to the Free Software
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
22 */
24 #include <linux/delay.h>
25 #include <linux/interrupt.h>
26 #include <linux/init.h>
27 #include <linux/slab.h>
28 #include <sound/core.h>
30 #include "ice1712.h"
31 #include "envy24ht.h"
32 #include "revo.h"
34 /* a non-standard I2C device for revo51 */
35 struct revo51_spec {
36 struct snd_i2c_device *dev;
37 struct snd_pt2258 *pt2258;
38 struct ak4114 *ak4114;
41 static void revo_i2s_mclk_changed(struct snd_ice1712 *ice)
43 /* assert PRST# to converters; MT05 bit 7 */
44 outb(inb(ICEMT1724(ice, AC97_CMD)) | 0x80, ICEMT1724(ice, AC97_CMD));
45 mdelay(5);
46 /* deassert PRST# */
47 outb(inb(ICEMT1724(ice, AC97_CMD)) & ~0x80, ICEMT1724(ice, AC97_CMD));
51 * change the rate of Envy24HT, AK4355 and AK4381
53 static void revo_set_rate_val(struct snd_akm4xxx *ak, unsigned int rate)
55 unsigned char old, tmp, dfs;
56 int reg, shift;
58 if (rate == 0) /* no hint - S/PDIF input is master, simply return */
59 return;
61 /* adjust DFS on codecs */
62 if (rate > 96000)
63 dfs = 2;
64 else if (rate > 48000)
65 dfs = 1;
66 else
67 dfs = 0;
69 if (ak->type == SND_AK4355 || ak->type == SND_AK4358) {
70 reg = 2;
71 shift = 4;
72 } else {
73 reg = 1;
74 shift = 3;
76 tmp = snd_akm4xxx_get(ak, 0, reg);
77 old = (tmp >> shift) & 0x03;
78 if (old == dfs)
79 return;
81 /* reset DFS */
82 snd_akm4xxx_reset(ak, 1);
83 tmp = snd_akm4xxx_get(ak, 0, reg);
84 tmp &= ~(0x03 << shift);
85 tmp |= dfs << shift;
86 /* snd_akm4xxx_write(ak, 0, reg, tmp); */
87 snd_akm4xxx_set(ak, 0, reg, tmp); /* value is written in reset(0) */
88 snd_akm4xxx_reset(ak, 0);
92 * I2C access to the PT2258 volume controller on GPIO 6/7 (Revolution 5.1)
95 static void revo_i2c_start(struct snd_i2c_bus *bus)
97 struct snd_ice1712 *ice = bus->private_data;
98 snd_ice1712_save_gpio_status(ice);
101 static void revo_i2c_stop(struct snd_i2c_bus *bus)
103 struct snd_ice1712 *ice = bus->private_data;
104 snd_ice1712_restore_gpio_status(ice);
107 static void revo_i2c_direction(struct snd_i2c_bus *bus, int clock, int data)
109 struct snd_ice1712 *ice = bus->private_data;
110 unsigned int mask, val;
112 val = 0;
113 if (clock)
114 val |= VT1724_REVO_I2C_CLOCK; /* write SCL */
115 if (data)
116 val |= VT1724_REVO_I2C_DATA; /* write SDA */
117 mask = VT1724_REVO_I2C_CLOCK | VT1724_REVO_I2C_DATA;
118 ice->gpio.direction &= ~mask;
119 ice->gpio.direction |= val;
120 snd_ice1712_gpio_set_dir(ice, ice->gpio.direction);
121 snd_ice1712_gpio_set_mask(ice, ~mask);
124 static void revo_i2c_setlines(struct snd_i2c_bus *bus, int clk, int data)
126 struct snd_ice1712 *ice = bus->private_data;
127 unsigned int val = 0;
129 if (clk)
130 val |= VT1724_REVO_I2C_CLOCK;
131 if (data)
132 val |= VT1724_REVO_I2C_DATA;
133 snd_ice1712_gpio_write_bits(ice,
134 VT1724_REVO_I2C_DATA |
135 VT1724_REVO_I2C_CLOCK, val);
136 udelay(5);
139 static int revo_i2c_getdata(struct snd_i2c_bus *bus, int ack)
141 struct snd_ice1712 *ice = bus->private_data;
142 int bit;
144 if (ack)
145 udelay(5);
146 bit = snd_ice1712_gpio_read_bits(ice, VT1724_REVO_I2C_DATA) ? 1 : 0;
147 return bit;
150 static struct snd_i2c_bit_ops revo51_bit_ops = {
151 .start = revo_i2c_start,
152 .stop = revo_i2c_stop,
153 .direction = revo_i2c_direction,
154 .setlines = revo_i2c_setlines,
155 .getdata = revo_i2c_getdata,
158 static int revo51_i2c_init(struct snd_ice1712 *ice,
159 struct snd_pt2258 *pt)
161 struct revo51_spec *spec;
162 int err;
164 spec = kzalloc(sizeof(*spec), GFP_KERNEL);
165 if (!spec)
166 return -ENOMEM;
167 ice->spec = spec;
169 /* create the I2C bus */
170 err = snd_i2c_bus_create(ice->card, "ICE1724 GPIO6", NULL, &ice->i2c);
171 if (err < 0)
172 return err;
174 ice->i2c->private_data = ice;
175 ice->i2c->hw_ops.bit = &revo51_bit_ops;
177 /* create the I2C device */
178 err = snd_i2c_device_create(ice->i2c, "PT2258", 0x40, &spec->dev);
179 if (err < 0)
180 return err;
182 pt->card = ice->card;
183 pt->i2c_bus = ice->i2c;
184 pt->i2c_dev = spec->dev;
185 spec->pt2258 = pt;
187 snd_pt2258_reset(pt);
189 return 0;
193 * initialize the chips on M-Audio Revolution cards
196 #define AK_DAC(xname,xch) { .name = xname, .num_channels = xch }
198 static const struct snd_akm4xxx_dac_channel revo71_front[] = {
200 .name = "PCM Playback Volume",
201 .num_channels = 2,
202 /* front channels DAC supports muting */
203 .switch_name = "PCM Playback Switch",
207 static const struct snd_akm4xxx_dac_channel revo71_surround[] = {
208 AK_DAC("PCM Center Playback Volume", 1),
209 AK_DAC("PCM LFE Playback Volume", 1),
210 AK_DAC("PCM Side Playback Volume", 2),
211 AK_DAC("PCM Rear Playback Volume", 2),
214 static const struct snd_akm4xxx_dac_channel revo51_dac[] = {
215 AK_DAC("PCM Playback Volume", 2),
216 AK_DAC("PCM Center Playback Volume", 1),
217 AK_DAC("PCM LFE Playback Volume", 1),
218 AK_DAC("PCM Rear Playback Volume", 2),
219 AK_DAC("PCM Headphone Volume", 2),
222 static const char *revo51_adc_input_names[] = {
223 "Mic",
224 "Line",
225 "CD",
226 NULL
229 static const struct snd_akm4xxx_adc_channel revo51_adc[] = {
231 .name = "PCM Capture Volume",
232 .switch_name = "PCM Capture Switch",
233 .num_channels = 2,
234 .input_names = revo51_adc_input_names
238 static struct snd_akm4xxx akm_revo_front = {
239 .type = SND_AK4381,
240 .num_dacs = 2,
241 .ops = {
242 .set_rate_val = revo_set_rate_val
244 .dac_info = revo71_front,
247 static struct snd_ak4xxx_private akm_revo_front_priv = {
248 .caddr = 1,
249 .cif = 0,
250 .data_mask = VT1724_REVO_CDOUT,
251 .clk_mask = VT1724_REVO_CCLK,
252 .cs_mask = VT1724_REVO_CS0 | VT1724_REVO_CS1 | VT1724_REVO_CS2,
253 .cs_addr = VT1724_REVO_CS0 | VT1724_REVO_CS2,
254 .cs_none = VT1724_REVO_CS0 | VT1724_REVO_CS1 | VT1724_REVO_CS2,
255 .add_flags = VT1724_REVO_CCLK, /* high at init */
256 .mask_flags = 0,
259 static struct snd_akm4xxx akm_revo_surround = {
260 .type = SND_AK4355,
261 .idx_offset = 1,
262 .num_dacs = 6,
263 .ops = {
264 .set_rate_val = revo_set_rate_val
266 .dac_info = revo71_surround,
269 static struct snd_ak4xxx_private akm_revo_surround_priv = {
270 .caddr = 3,
271 .cif = 0,
272 .data_mask = VT1724_REVO_CDOUT,
273 .clk_mask = VT1724_REVO_CCLK,
274 .cs_mask = VT1724_REVO_CS0 | VT1724_REVO_CS1 | VT1724_REVO_CS2,
275 .cs_addr = VT1724_REVO_CS0 | VT1724_REVO_CS1,
276 .cs_none = VT1724_REVO_CS0 | VT1724_REVO_CS1 | VT1724_REVO_CS2,
277 .add_flags = VT1724_REVO_CCLK, /* high at init */
278 .mask_flags = 0,
281 static struct snd_akm4xxx akm_revo51 = {
282 .type = SND_AK4358,
283 .num_dacs = 8,
284 .ops = {
285 .set_rate_val = revo_set_rate_val
287 .dac_info = revo51_dac,
290 static struct snd_ak4xxx_private akm_revo51_priv = {
291 .caddr = 2,
292 .cif = 0,
293 .data_mask = VT1724_REVO_CDOUT,
294 .clk_mask = VT1724_REVO_CCLK,
295 .cs_mask = VT1724_REVO_CS0 | VT1724_REVO_CS1,
296 .cs_addr = VT1724_REVO_CS1,
297 .cs_none = VT1724_REVO_CS0 | VT1724_REVO_CS1,
298 .add_flags = VT1724_REVO_CCLK, /* high at init */
299 .mask_flags = 0,
302 static struct snd_akm4xxx akm_revo51_adc = {
303 .type = SND_AK5365,
304 .num_adcs = 2,
305 .adc_info = revo51_adc,
308 static struct snd_ak4xxx_private akm_revo51_adc_priv = {
309 .caddr = 2,
310 .cif = 0,
311 .data_mask = VT1724_REVO_CDOUT,
312 .clk_mask = VT1724_REVO_CCLK,
313 .cs_mask = VT1724_REVO_CS0 | VT1724_REVO_CS1,
314 .cs_addr = VT1724_REVO_CS0,
315 .cs_none = VT1724_REVO_CS0 | VT1724_REVO_CS1,
316 .add_flags = VT1724_REVO_CCLK, /* high at init */
317 .mask_flags = 0,
320 static struct snd_pt2258 ptc_revo51_volume;
322 /* AK4358 for AP192 DAC, AK5385A for ADC */
323 static void ap192_set_rate_val(struct snd_akm4xxx *ak, unsigned int rate)
325 struct snd_ice1712 *ice = ak->private_data[0];
326 int dfs;
328 revo_set_rate_val(ak, rate);
330 /* reset CKS */
331 snd_ice1712_gpio_write_bits(ice, 1 << 8, rate > 96000 ? 1 << 8 : 0);
332 /* reset DFS pins of AK5385A for ADC, too */
333 if (rate > 96000)
334 dfs = 2;
335 else if (rate > 48000)
336 dfs = 1;
337 else
338 dfs = 0;
339 snd_ice1712_gpio_write_bits(ice, 3 << 9, dfs << 9);
340 /* reset ADC */
341 snd_ice1712_gpio_write_bits(ice, 1 << 11, 0);
342 snd_ice1712_gpio_write_bits(ice, 1 << 11, 1 << 11);
345 static const struct snd_akm4xxx_dac_channel ap192_dac[] = {
346 AK_DAC("PCM Playback Volume", 2)
349 static struct snd_akm4xxx akm_ap192 = {
350 .type = SND_AK4358,
351 .num_dacs = 2,
352 .ops = {
353 .set_rate_val = ap192_set_rate_val
355 .dac_info = ap192_dac,
358 static struct snd_ak4xxx_private akm_ap192_priv = {
359 .caddr = 2,
360 .cif = 0,
361 .data_mask = VT1724_REVO_CDOUT,
362 .clk_mask = VT1724_REVO_CCLK,
363 .cs_mask = VT1724_REVO_CS0 | VT1724_REVO_CS3,
364 .cs_addr = VT1724_REVO_CS3,
365 .cs_none = VT1724_REVO_CS0 | VT1724_REVO_CS3,
366 .add_flags = VT1724_REVO_CCLK, /* high at init */
367 .mask_flags = 0,
370 /* AK4114 support on Audiophile 192 */
371 /* CDTO (pin 32) -- GPIO2 pin 52
372 * CDTI (pin 33) -- GPIO3 pin 53 (shared with AK4358)
373 * CCLK (pin 34) -- GPIO1 pin 51 (shared with AK4358)
374 * CSN (pin 35) -- GPIO7 pin 59
376 #define AK4114_ADDR 0x00
378 static void write_data(struct snd_ice1712 *ice, unsigned int gpio,
379 unsigned int data, int idx)
381 for (; idx >= 0; idx--) {
382 /* drop clock */
383 gpio &= ~VT1724_REVO_CCLK;
384 snd_ice1712_gpio_write(ice, gpio);
385 udelay(1);
386 /* set data */
387 if (data & (1 << idx))
388 gpio |= VT1724_REVO_CDOUT;
389 else
390 gpio &= ~VT1724_REVO_CDOUT;
391 snd_ice1712_gpio_write(ice, gpio);
392 udelay(1);
393 /* raise clock */
394 gpio |= VT1724_REVO_CCLK;
395 snd_ice1712_gpio_write(ice, gpio);
396 udelay(1);
400 static unsigned char read_data(struct snd_ice1712 *ice, unsigned int gpio,
401 int idx)
403 unsigned char data = 0;
405 for (; idx >= 0; idx--) {
406 /* drop clock */
407 gpio &= ~VT1724_REVO_CCLK;
408 snd_ice1712_gpio_write(ice, gpio);
409 udelay(1);
410 /* read data */
411 if (snd_ice1712_gpio_read(ice) & VT1724_REVO_CDIN)
412 data |= (1 << idx);
413 udelay(1);
414 /* raise clock */
415 gpio |= VT1724_REVO_CCLK;
416 snd_ice1712_gpio_write(ice, gpio);
417 udelay(1);
419 return data;
422 static unsigned int ap192_4wire_start(struct snd_ice1712 *ice)
424 unsigned int tmp;
426 snd_ice1712_save_gpio_status(ice);
427 tmp = snd_ice1712_gpio_read(ice);
428 tmp |= VT1724_REVO_CCLK; /* high at init */
429 tmp |= VT1724_REVO_CS0;
430 tmp &= ~VT1724_REVO_CS3;
431 snd_ice1712_gpio_write(ice, tmp);
432 udelay(1);
433 return tmp;
436 static void ap192_4wire_finish(struct snd_ice1712 *ice, unsigned int tmp)
438 tmp |= VT1724_REVO_CS3;
439 tmp |= VT1724_REVO_CS0;
440 snd_ice1712_gpio_write(ice, tmp);
441 udelay(1);
442 snd_ice1712_restore_gpio_status(ice);
445 static void ap192_ak4114_write(void *private_data, unsigned char addr,
446 unsigned char data)
448 struct snd_ice1712 *ice = private_data;
449 unsigned int tmp, addrdata;
451 tmp = ap192_4wire_start(ice);
452 addrdata = (AK4114_ADDR << 6) | 0x20 | (addr & 0x1f);
453 addrdata = (addrdata << 8) | data;
454 write_data(ice, tmp, addrdata, 15);
455 ap192_4wire_finish(ice, tmp);
458 static unsigned char ap192_ak4114_read(void *private_data, unsigned char addr)
460 struct snd_ice1712 *ice = private_data;
461 unsigned int tmp;
462 unsigned char data;
464 tmp = ap192_4wire_start(ice);
465 write_data(ice, tmp, (AK4114_ADDR << 6) | (addr & 0x1f), 7);
466 data = read_data(ice, tmp, 7);
467 ap192_4wire_finish(ice, tmp);
468 return data;
471 static int ap192_ak4114_init(struct snd_ice1712 *ice)
473 static const unsigned char ak4114_init_vals[] = {
474 AK4114_RST | AK4114_PWN | AK4114_OCKS0,
475 AK4114_DIF_I24I2S,
476 AK4114_TX1E,
477 AK4114_EFH_1024 | AK4114_DIT | AK4114_IPS(0),
481 static const unsigned char ak4114_init_txcsb[] = {
482 0x41, 0x02, 0x2c, 0x00, 0x00
484 int err;
486 struct revo51_spec *spec;
487 spec = kzalloc(sizeof(*spec), GFP_KERNEL);
488 if (!spec)
489 return -ENOMEM;
490 ice->spec = spec;
492 err = snd_ak4114_create(ice->card,
493 ap192_ak4114_read,
494 ap192_ak4114_write,
495 ak4114_init_vals, ak4114_init_txcsb,
496 ice, &spec->ak4114);
497 if (err < 0)
498 return err;
499 /* AK4114 in Revo cannot detect external rate correctly.
500 * No reason to stop capture stream due to incorrect checks */
501 spec->ak4114->check_flags = AK4114_CHECK_NO_RATE;
503 return 0;
506 static int revo_init(struct snd_ice1712 *ice)
508 struct snd_akm4xxx *ak;
509 int err;
511 /* determine I2C, DACs and ADCs */
512 switch (ice->eeprom.subvendor) {
513 case VT1724_SUBDEVICE_REVOLUTION71:
514 ice->num_total_dacs = 8;
515 ice->num_total_adcs = 2;
516 ice->gpio.i2s_mclk_changed = revo_i2s_mclk_changed;
517 break;
518 case VT1724_SUBDEVICE_REVOLUTION51:
519 ice->num_total_dacs = 8;
520 ice->num_total_adcs = 2;
521 break;
522 case VT1724_SUBDEVICE_AUDIOPHILE192:
523 ice->num_total_dacs = 2;
524 ice->num_total_adcs = 2;
525 break;
526 default:
527 snd_BUG();
528 return -EINVAL;
531 /* second stage of initialization, analog parts and others */
532 ak = ice->akm = kcalloc(2, sizeof(struct snd_akm4xxx), GFP_KERNEL);
533 if (! ak)
534 return -ENOMEM;
535 switch (ice->eeprom.subvendor) {
536 case VT1724_SUBDEVICE_REVOLUTION71:
537 ice->akm_codecs = 2;
538 err = snd_ice1712_akm4xxx_init(ak, &akm_revo_front,
539 &akm_revo_front_priv, ice);
540 if (err < 0)
541 return err;
542 err = snd_ice1712_akm4xxx_init(ak+1, &akm_revo_surround,
543 &akm_revo_surround_priv, ice);
544 if (err < 0)
545 return err;
546 /* unmute all codecs */
547 snd_ice1712_gpio_write_bits(ice, VT1724_REVO_MUTE,
548 VT1724_REVO_MUTE);
549 break;
550 case VT1724_SUBDEVICE_REVOLUTION51:
551 ice->akm_codecs = 2;
552 err = snd_ice1712_akm4xxx_init(ak, &akm_revo51,
553 &akm_revo51_priv, ice);
554 if (err < 0)
555 return err;
556 err = snd_ice1712_akm4xxx_init(ak+1, &akm_revo51_adc,
557 &akm_revo51_adc_priv, ice);
558 if (err < 0)
559 return err;
560 err = revo51_i2c_init(ice, &ptc_revo51_volume);
561 if (err < 0)
562 return err;
563 /* unmute all codecs */
564 snd_ice1712_gpio_write_bits(ice, VT1724_REVO_MUTE,
565 VT1724_REVO_MUTE);
566 break;
567 case VT1724_SUBDEVICE_AUDIOPHILE192:
568 ice->akm_codecs = 1;
569 err = snd_ice1712_akm4xxx_init(ak, &akm_ap192, &akm_ap192_priv,
570 ice);
571 if (err < 0)
572 return err;
573 err = ap192_ak4114_init(ice);
574 if (err < 0)
575 return err;
577 /* unmute all codecs */
578 snd_ice1712_gpio_write_bits(ice, VT1724_REVO_MUTE,
579 VT1724_REVO_MUTE);
580 break;
583 return 0;
587 static int revo_add_controls(struct snd_ice1712 *ice)
589 struct revo51_spec *spec = ice->spec;
590 int err;
592 switch (ice->eeprom.subvendor) {
593 case VT1724_SUBDEVICE_REVOLUTION71:
594 err = snd_ice1712_akm4xxx_build_controls(ice);
595 if (err < 0)
596 return err;
597 break;
598 case VT1724_SUBDEVICE_REVOLUTION51:
599 err = snd_ice1712_akm4xxx_build_controls(ice);
600 if (err < 0)
601 return err;
602 spec = ice->spec;
603 err = snd_pt2258_build_controls(spec->pt2258);
604 if (err < 0)
605 return err;
606 break;
607 case VT1724_SUBDEVICE_AUDIOPHILE192:
608 err = snd_ice1712_akm4xxx_build_controls(ice);
609 if (err < 0)
610 return err;
611 /* only capture SPDIF over AK4114 */
612 err = snd_ak4114_build(spec->ak4114, NULL,
613 ice->pcm->streams[SNDRV_PCM_STREAM_CAPTURE].substream);
614 if (err < 0)
615 return err;
616 break;
618 return 0;
621 /* entry point */
622 struct snd_ice1712_card_info snd_vt1724_revo_cards[] = {
624 .subvendor = VT1724_SUBDEVICE_REVOLUTION71,
625 .name = "M Audio Revolution-7.1",
626 .model = "revo71",
627 .chip_init = revo_init,
628 .build_controls = revo_add_controls,
631 .subvendor = VT1724_SUBDEVICE_REVOLUTION51,
632 .name = "M Audio Revolution-5.1",
633 .model = "revo51",
634 .chip_init = revo_init,
635 .build_controls = revo_add_controls,
638 .subvendor = VT1724_SUBDEVICE_AUDIOPHILE192,
639 .name = "M Audio Audiophile192",
640 .model = "ap192",
641 .chip_init = revo_init,
642 .build_controls = revo_add_controls,
644 { } /* terminator */