2 * Routines for control of the CS8427 via i2c bus
3 * IEC958 (S/PDIF) receiver & transmitter by Cirrus Logic
4 * Copyright (c) by Jaroslav Kysela <perex@perex.cz>
7 * This program is free software; you can redistribute it and/or modify
8 * it under the terms of the GNU General Public License as published by
9 * the Free Software Foundation; either version 2 of the License, or
10 * (at your option) any later version.
12 * This program is distributed in the hope that it will be useful,
13 * but WITHOUT ANY WARRANTY; without even the implied warranty of
14 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 * GNU General Public License for more details.
17 * You should have received a copy of the GNU General Public License
18 * along with this program; if not, write to the Free Software
19 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
23 #include <linux/slab.h>
24 #include <linux/delay.h>
25 #include <linux/init.h>
26 #include <linux/bitrev.h>
27 #include <linux/module.h>
28 #include <asm/unaligned.h>
29 #include <sound/core.h>
30 #include <sound/control.h>
31 #include <sound/pcm.h>
32 #include <sound/cs8427.h>
33 #include <sound/asoundef.h>
35 static void snd_cs8427_reset(struct snd_i2c_device *cs8427);
37 MODULE_AUTHOR("Jaroslav Kysela <perex@perex.cz>");
38 MODULE_DESCRIPTION("IEC958 (S/PDIF) receiver & transmitter by Cirrus Logic");
39 MODULE_LICENSE("GPL");
41 #define CS8427_ADDR (0x20>>1) /* fixed address */
43 struct cs8427_stream {
44 struct snd_pcm_substream *substream;
45 char hw_status[24]; /* hardware status */
46 char def_status[24]; /* default status */
47 char pcm_status[24]; /* PCM private status */
49 struct snd_kcontrol *pcm_ctl;
53 unsigned char regmap[0x14]; /* map of first 1 + 13 registers */
55 unsigned int reset_timeout;
56 struct cs8427_stream playback;
57 struct cs8427_stream capture;
60 int snd_cs8427_reg_write(struct snd_i2c_device *device, unsigned char reg,
68 if ((err = snd_i2c_sendbytes(device, buf, 2)) != 2) {
69 snd_printk(KERN_ERR "unable to send bytes 0x%02x:0x%02x "
70 "to CS8427 (%i)\n", buf[0], buf[1], err);
71 return err < 0 ? err : -EIO;
76 EXPORT_SYMBOL(snd_cs8427_reg_write);
78 static int snd_cs8427_reg_read(struct snd_i2c_device *device, unsigned char reg)
83 if ((err = snd_i2c_sendbytes(device, ®, 1)) != 1) {
84 snd_printk(KERN_ERR "unable to send register 0x%x byte "
86 return err < 0 ? err : -EIO;
88 if ((err = snd_i2c_readbytes(device, &buf, 1)) != 1) {
89 snd_printk(KERN_ERR "unable to read register 0x%x byte "
90 "from CS8427\n", reg);
91 return err < 0 ? err : -EIO;
96 static int snd_cs8427_select_corudata(struct snd_i2c_device *device, int udata)
98 struct cs8427 *chip = device->private_data;
101 udata = udata ? CS8427_BSEL : 0;
102 if (udata != (chip->regmap[CS8427_REG_CSDATABUF] & udata)) {
103 chip->regmap[CS8427_REG_CSDATABUF] &= ~CS8427_BSEL;
104 chip->regmap[CS8427_REG_CSDATABUF] |= udata;
105 err = snd_cs8427_reg_write(device, CS8427_REG_CSDATABUF,
106 chip->regmap[CS8427_REG_CSDATABUF]);
113 static int snd_cs8427_send_corudata(struct snd_i2c_device *device,
115 unsigned char *ndata,
118 struct cs8427 *chip = device->private_data;
119 char *hw_data = udata ?
120 chip->playback.hw_udata : chip->playback.hw_status;
124 if (!memcmp(hw_data, ndata, count))
126 if ((err = snd_cs8427_select_corudata(device, udata)) < 0)
128 memcpy(hw_data, ndata, count);
130 memset(data, 0, sizeof(data));
131 if (memcmp(hw_data, data, count) == 0) {
132 chip->regmap[CS8427_REG_UDATABUF] &= ~CS8427_UBMMASK;
133 chip->regmap[CS8427_REG_UDATABUF] |= CS8427_UBMZEROS |
135 err = snd_cs8427_reg_write(device, CS8427_REG_UDATABUF,
136 chip->regmap[CS8427_REG_UDATABUF]);
137 return err < 0 ? err : 0;
140 data[0] = CS8427_REG_AUTOINC | CS8427_REG_CORU_DATABUF;
141 for (idx = 0; idx < count; idx++)
142 data[idx + 1] = bitrev8(ndata[idx]);
143 if (snd_i2c_sendbytes(device, data, count + 1) != count + 1)
148 static void snd_cs8427_free(struct snd_i2c_device *device)
150 kfree(device->private_data);
153 int snd_cs8427_init(struct snd_i2c_bus *bus,
154 struct snd_i2c_device *device)
156 static unsigned char initvals1[] = {
157 CS8427_REG_CONTROL1 | CS8427_REG_AUTOINC,
158 /* CS8427_REG_CONTROL1: RMCK to OMCK, valid PCM audio, disable mutes,
160 CS8427_SWCLK | CS8427_TCBLDIR,
161 /* CS8427_REG_CONTROL2: hold last valid audio sample, RMCK=256*Fs,
162 normal stereo operation */
164 /* CS8427_REG_DATAFLOW: output drivers normal operation, Tx<=serial,
166 CS8427_TXDSERIAL | CS8427_SPDAES3RECEIVER,
167 /* CS8427_REG_CLOCKSOURCE: Run off, CMCK=256*Fs,
168 output time base = OMCK, input time base = recovered input clock,
169 recovered input clock source is ILRCK changed to AES3INPUT
170 (workaround, see snd_cs8427_reset) */
172 /* CS8427_REG_SERIALINPUT: Serial audio input port data format = I2S,
174 CS8427_SIDEL | CS8427_SILRPOL,
175 /* CS8427_REG_SERIALOUTPUT: Serial audio output port data format
176 = I2S, 24-bit, 64*Fsi */
177 CS8427_SODEL | CS8427_SOLRPOL,
179 static unsigned char initvals2[] = {
180 CS8427_REG_RECVERRMASK | CS8427_REG_AUTOINC,
181 /* CS8427_REG_RECVERRMASK: unmask the input PLL clock, V, confidence,
182 biphase, parity status bits */
183 /* CS8427_UNLOCK | CS8427_V | CS8427_CONF | CS8427_BIP | CS8427_PAR,*/
184 0xff, /* set everything */
185 /* CS8427_REG_CSDATABUF:
186 Registers 32-55 window to CS buffer
187 Inhibit D->E transfers from overwriting first 5 bytes of CS data.
188 Inhibit D->E transfers (all) of CS data.
189 Allow E->F transfer of CS data.
190 One byte mode; both A/B channels get same written CB data.
191 A channel info is output to chip's EMPH* pin. */
192 CS8427_CBMR | CS8427_DETCI,
193 /* CS8427_REG_UDATABUF:
194 Use internal buffer to transmit User (U) data.
195 Chip's U pin is an output.
196 Transmit all O's for user data.
197 Inhibit D->E transfers.
198 Inhibit E->F transfers. */
199 CS8427_UD | CS8427_EFTUI | CS8427_DETUI,
201 struct cs8427 *chip = device->private_data;
203 unsigned char buf[24];
206 err = snd_cs8427_reg_read(device, CS8427_REG_ID_AND_VER);
207 if (err != CS8427_VER8427A) {
208 /* give second chance */
209 snd_printk(KERN_WARNING "invalid CS8427 signature 0x%x: "
210 "let me try again...\n", err);
211 err = snd_cs8427_reg_read(device, CS8427_REG_ID_AND_VER);
213 if (err != CS8427_VER8427A) {
215 snd_printk(KERN_ERR "unable to find CS8427 signature "
216 "(expected 0x%x, read 0x%x),\n",
217 CS8427_VER8427A, err);
218 snd_printk(KERN_ERR " initialization is not completed\n");
221 /* turn off run bit while making changes to configuration */
222 err = snd_cs8427_reg_write(device, CS8427_REG_CLOCKSOURCE, 0x00);
225 /* send initial values */
226 memcpy(chip->regmap + (initvals1[0] & 0x7f), initvals1 + 1, 6);
227 if ((err = snd_i2c_sendbytes(device, initvals1, 7)) != 7) {
228 err = err < 0 ? err : -EIO;
231 /* Turn off CS8427 interrupt stuff that is not used in hardware */
233 /* from address 9 to 15 */
234 buf[0] = 9; /* register */
235 if ((err = snd_i2c_sendbytes(device, buf, 7)) != 7)
237 /* send transfer initialization sequence */
238 memcpy(chip->regmap + (initvals2[0] & 0x7f), initvals2 + 1, 3);
239 if ((err = snd_i2c_sendbytes(device, initvals2, 4)) != 4) {
240 err = err < 0 ? err : -EIO;
243 /* write default channel status bytes */
244 put_unaligned_le32(SNDRV_PCM_DEFAULT_CON_SPDIF, buf);
245 memset(buf + 4, 0, 24 - 4);
246 if (snd_cs8427_send_corudata(device, 0, buf, 24) < 0)
248 memcpy(chip->playback.def_status, buf, 24);
249 memcpy(chip->playback.pcm_status, buf, 24);
252 /* turn on run bit and rock'n'roll */
253 snd_cs8427_reset(device);
262 EXPORT_SYMBOL(snd_cs8427_init);
264 int snd_cs8427_create(struct snd_i2c_bus *bus,
266 unsigned int reset_timeout,
267 struct snd_i2c_device **r_cs8427)
271 struct snd_i2c_device *device;
273 err = snd_i2c_device_create(bus, "CS8427", CS8427_ADDR | (addr & 7),
277 chip = device->private_data = kzalloc(sizeof(*chip), GFP_KERNEL);
279 snd_i2c_device_free(device);
282 device->private_free = snd_cs8427_free;
284 if (reset_timeout < 1)
286 chip->reset_timeout = reset_timeout;
288 err = snd_cs8427_init(bus, device);
292 #if 0 // it's nice for read tests
297 snd_i2c_sendbytes(device, buf, 1);
298 snd_i2c_readbytes(device, buf, 127);
299 for (xx = 0; xx < 127; xx++)
300 printk(KERN_DEBUG "reg[0x%x] = 0x%x\n", xx+1, buf[xx]);
309 snd_i2c_device_free(device);
310 return err < 0 ? err : -EIO;
313 EXPORT_SYMBOL(snd_cs8427_create);
316 * Reset the chip using run bit, also lock PLL using ILRCK and
317 * put back AES3INPUT. This workaround is described in latest
318 * CS8427 datasheet, otherwise TXDSERIAL will not work.
320 static void snd_cs8427_reset(struct snd_i2c_device *cs8427)
323 unsigned long end_time;
324 int data, aes3input = 0;
326 if (snd_BUG_ON(!cs8427))
328 chip = cs8427->private_data;
329 snd_i2c_lock(cs8427->bus);
330 if ((chip->regmap[CS8427_REG_CLOCKSOURCE] & CS8427_RXDAES3INPUT) ==
331 CS8427_RXDAES3INPUT) /* AES3 bit is set */
333 chip->regmap[CS8427_REG_CLOCKSOURCE] &= ~(CS8427_RUN | CS8427_RXDMASK);
334 snd_cs8427_reg_write(cs8427, CS8427_REG_CLOCKSOURCE,
335 chip->regmap[CS8427_REG_CLOCKSOURCE]);
337 chip->regmap[CS8427_REG_CLOCKSOURCE] |= CS8427_RUN | CS8427_RXDILRCK;
338 snd_cs8427_reg_write(cs8427, CS8427_REG_CLOCKSOURCE,
339 chip->regmap[CS8427_REG_CLOCKSOURCE]);
341 snd_i2c_unlock(cs8427->bus);
342 end_time = jiffies + chip->reset_timeout;
343 while (time_after_eq(end_time, jiffies)) {
344 snd_i2c_lock(cs8427->bus);
345 data = snd_cs8427_reg_read(cs8427, CS8427_REG_RECVERRORS);
346 snd_i2c_unlock(cs8427->bus);
347 if (!(data & CS8427_UNLOCK))
349 schedule_timeout_uninterruptible(1);
351 snd_i2c_lock(cs8427->bus);
352 chip->regmap[CS8427_REG_CLOCKSOURCE] &= ~CS8427_RXDMASK;
354 chip->regmap[CS8427_REG_CLOCKSOURCE] |= CS8427_RXDAES3INPUT;
355 snd_cs8427_reg_write(cs8427, CS8427_REG_CLOCKSOURCE,
356 chip->regmap[CS8427_REG_CLOCKSOURCE]);
357 snd_i2c_unlock(cs8427->bus);
360 static int snd_cs8427_in_status_info(struct snd_kcontrol *kcontrol,
361 struct snd_ctl_elem_info *uinfo)
363 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
365 uinfo->value.integer.min = 0;
366 uinfo->value.integer.max = 255;
370 static int snd_cs8427_in_status_get(struct snd_kcontrol *kcontrol,
371 struct snd_ctl_elem_value *ucontrol)
373 struct snd_i2c_device *device = snd_kcontrol_chip(kcontrol);
376 snd_i2c_lock(device->bus);
377 data = snd_cs8427_reg_read(device, kcontrol->private_value);
378 snd_i2c_unlock(device->bus);
381 ucontrol->value.integer.value[0] = data;
385 static int snd_cs8427_qsubcode_info(struct snd_kcontrol *kcontrol,
386 struct snd_ctl_elem_info *uinfo)
388 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
393 static int snd_cs8427_qsubcode_get(struct snd_kcontrol *kcontrol,
394 struct snd_ctl_elem_value *ucontrol)
396 struct snd_i2c_device *device = snd_kcontrol_chip(kcontrol);
397 unsigned char reg = CS8427_REG_QSUBCODE;
400 snd_i2c_lock(device->bus);
401 if ((err = snd_i2c_sendbytes(device, ®, 1)) != 1) {
402 snd_printk(KERN_ERR "unable to send register 0x%x byte "
404 snd_i2c_unlock(device->bus);
405 return err < 0 ? err : -EIO;
407 err = snd_i2c_readbytes(device, ucontrol->value.bytes.data, 10);
409 snd_printk(KERN_ERR "unable to read Q-subcode bytes "
411 snd_i2c_unlock(device->bus);
412 return err < 0 ? err : -EIO;
414 snd_i2c_unlock(device->bus);
418 static int snd_cs8427_spdif_info(struct snd_kcontrol *kcontrol,
419 struct snd_ctl_elem_info *uinfo)
421 uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
426 static int snd_cs8427_spdif_get(struct snd_kcontrol *kcontrol,
427 struct snd_ctl_elem_value *ucontrol)
429 struct snd_i2c_device *device = snd_kcontrol_chip(kcontrol);
430 struct cs8427 *chip = device->private_data;
432 snd_i2c_lock(device->bus);
433 memcpy(ucontrol->value.iec958.status, chip->playback.def_status, 24);
434 snd_i2c_unlock(device->bus);
438 static int snd_cs8427_spdif_put(struct snd_kcontrol *kcontrol,
439 struct snd_ctl_elem_value *ucontrol)
441 struct snd_i2c_device *device = snd_kcontrol_chip(kcontrol);
442 struct cs8427 *chip = device->private_data;
443 unsigned char *status = kcontrol->private_value ?
444 chip->playback.pcm_status : chip->playback.def_status;
445 struct snd_pcm_runtime *runtime = chip->playback.substream ?
446 chip->playback.substream->runtime : NULL;
449 snd_i2c_lock(device->bus);
450 change = memcmp(ucontrol->value.iec958.status, status, 24) != 0;
451 memcpy(status, ucontrol->value.iec958.status, 24);
452 if (change && (kcontrol->private_value ?
453 runtime != NULL : runtime == NULL)) {
454 err = snd_cs8427_send_corudata(device, 0, status, 24);
458 snd_i2c_unlock(device->bus);
462 static int snd_cs8427_spdif_mask_info(struct snd_kcontrol *kcontrol,
463 struct snd_ctl_elem_info *uinfo)
465 uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
470 static int snd_cs8427_spdif_mask_get(struct snd_kcontrol *kcontrol,
471 struct snd_ctl_elem_value *ucontrol)
473 memset(ucontrol->value.iec958.status, 0xff, 24);
477 static struct snd_kcontrol_new snd_cs8427_iec958_controls[] = {
479 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
480 .info = snd_cs8427_in_status_info,
481 .name = "IEC958 CS8427 Input Status",
482 .access = (SNDRV_CTL_ELEM_ACCESS_READ |
483 SNDRV_CTL_ELEM_ACCESS_VOLATILE),
484 .get = snd_cs8427_in_status_get,
488 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
489 .info = snd_cs8427_in_status_info,
490 .name = "IEC958 CS8427 Error Status",
491 .access = (SNDRV_CTL_ELEM_ACCESS_READ |
492 SNDRV_CTL_ELEM_ACCESS_VOLATILE),
493 .get = snd_cs8427_in_status_get,
497 .access = SNDRV_CTL_ELEM_ACCESS_READ,
498 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
499 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,MASK),
500 .info = snd_cs8427_spdif_mask_info,
501 .get = snd_cs8427_spdif_mask_get,
504 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
505 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,DEFAULT),
506 .info = snd_cs8427_spdif_info,
507 .get = snd_cs8427_spdif_get,
508 .put = snd_cs8427_spdif_put,
512 .access = (SNDRV_CTL_ELEM_ACCESS_READWRITE |
513 SNDRV_CTL_ELEM_ACCESS_INACTIVE),
514 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
515 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,PCM_STREAM),
516 .info = snd_cs8427_spdif_info,
517 .get = snd_cs8427_spdif_get,
518 .put = snd_cs8427_spdif_put,
522 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
523 .info = snd_cs8427_qsubcode_info,
524 .name = "IEC958 Q-subcode Capture Default",
525 .access = (SNDRV_CTL_ELEM_ACCESS_READ |
526 SNDRV_CTL_ELEM_ACCESS_VOLATILE),
527 .get = snd_cs8427_qsubcode_get
530 int snd_cs8427_iec958_build(struct snd_i2c_device *cs8427,
531 struct snd_pcm_substream *play_substream,
532 struct snd_pcm_substream *cap_substream)
534 struct cs8427 *chip = cs8427->private_data;
535 struct snd_kcontrol *kctl;
539 if (snd_BUG_ON(!play_substream || !cap_substream))
541 for (idx = 0; idx < ARRAY_SIZE(snd_cs8427_iec958_controls); idx++) {
542 kctl = snd_ctl_new1(&snd_cs8427_iec958_controls[idx], cs8427);
545 kctl->id.device = play_substream->pcm->device;
546 kctl->id.subdevice = play_substream->number;
547 err = snd_ctl_add(cs8427->bus->card, kctl);
550 if (! strcmp(kctl->id.name,
551 SNDRV_CTL_NAME_IEC958("",PLAYBACK,PCM_STREAM)))
552 chip->playback.pcm_ctl = kctl;
555 chip->playback.substream = play_substream;
556 chip->capture.substream = cap_substream;
557 if (snd_BUG_ON(!chip->playback.pcm_ctl))
562 EXPORT_SYMBOL(snd_cs8427_iec958_build);
564 int snd_cs8427_iec958_active(struct snd_i2c_device *cs8427, int active)
568 if (snd_BUG_ON(!cs8427))
570 chip = cs8427->private_data;
572 memcpy(chip->playback.pcm_status,
573 chip->playback.def_status, 24);
574 chip->playback.pcm_ctl->vd[0].access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
575 snd_ctl_notify(cs8427->bus->card,
576 SNDRV_CTL_EVENT_MASK_VALUE | SNDRV_CTL_EVENT_MASK_INFO,
577 &chip->playback.pcm_ctl->id);
581 EXPORT_SYMBOL(snd_cs8427_iec958_active);
583 int snd_cs8427_iec958_pcm(struct snd_i2c_device *cs8427, unsigned int rate)
589 if (snd_BUG_ON(!cs8427))
591 chip = cs8427->private_data;
592 status = chip->playback.pcm_status;
593 snd_i2c_lock(cs8427->bus);
594 if (status[0] & IEC958_AES0_PROFESSIONAL) {
595 status[0] &= ~IEC958_AES0_PRO_FS;
597 case 32000: status[0] |= IEC958_AES0_PRO_FS_32000; break;
598 case 44100: status[0] |= IEC958_AES0_PRO_FS_44100; break;
599 case 48000: status[0] |= IEC958_AES0_PRO_FS_48000; break;
600 default: status[0] |= IEC958_AES0_PRO_FS_NOTID; break;
603 status[3] &= ~IEC958_AES3_CON_FS;
605 case 32000: status[3] |= IEC958_AES3_CON_FS_32000; break;
606 case 44100: status[3] |= IEC958_AES3_CON_FS_44100; break;
607 case 48000: status[3] |= IEC958_AES3_CON_FS_48000; break;
610 err = snd_cs8427_send_corudata(cs8427, 0, status, 24);
612 snd_ctl_notify(cs8427->bus->card,
613 SNDRV_CTL_EVENT_MASK_VALUE,
614 &chip->playback.pcm_ctl->id);
615 reset = chip->rate != rate;
617 snd_i2c_unlock(cs8427->bus);
619 snd_cs8427_reset(cs8427);
620 return err < 0 ? err : 0;
623 EXPORT_SYMBOL(snd_cs8427_iec958_pcm);
625 static int __init alsa_cs8427_module_init(void)
630 static void __exit alsa_cs8427_module_exit(void)
634 module_init(alsa_cs8427_module_init)
635 module_exit(alsa_cs8427_module_exit)