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@suse.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 <sound/driver.h>
24 #include <linux/slab.h>
25 #include <linux/delay.h>
26 #include <linux/init.h>
27 #include <sound/core.h>
28 #include <sound/control.h>
29 #include <sound/pcm.h>
30 #include <sound/cs8427.h>
31 #include <sound/asoundef.h>
33 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
34 MODULE_DESCRIPTION("IEC958 (S/PDIF) receiver & transmitter by Cirrus Logic");
35 MODULE_LICENSE("GPL");
37 #define CS8427_ADDR (0x20>>1) /* fixed address */
40 snd_pcm_substream_t *substream;
41 char hw_status[24]; /* hardware status */
42 char def_status[24]; /* default status */
43 char pcm_status[24]; /* PCM private status */
45 snd_kcontrol_t *pcm_ctl;
49 unsigned char regmap[0x14]; /* map of first 1 + 13 registers */
51 unsigned int reset_timeout;
52 cs8427_stream_t playback;
53 cs8427_stream_t capture;
56 static unsigned char swapbits(unsigned char val)
59 unsigned char res = 0;
60 for (bit = 0; bit < 8; bit++) {
68 int snd_cs8427_detect(snd_i2c_bus_t *bus, unsigned char addr)
73 res = snd_i2c_probeaddr(bus, CS8427_ADDR | (addr & 7));
78 int snd_cs8427_reg_write(snd_i2c_device_t *device, unsigned char reg, unsigned char val)
85 if ((err = snd_i2c_sendbytes(device, buf, 2)) != 2) {
86 snd_printk("unable to send bytes 0x%02x:0x%02x to CS8427 (%i)\n", buf[0], buf[1], err);
87 return err < 0 ? err : -EIO;
92 int snd_cs8427_reg_read(snd_i2c_device_t *device, unsigned char reg)
97 if ((err = snd_i2c_sendbytes(device, ®, 1)) != 1) {
98 snd_printk("unable to send register 0x%x byte to CS8427\n", reg);
99 return err < 0 ? err : -EIO;
101 if ((err = snd_i2c_readbytes(device, &buf, 1)) != 1) {
102 snd_printk("unable to read register 0x%x byte from CS8427\n", reg);
103 return err < 0 ? err : -EIO;
108 static int snd_cs8427_select_corudata(snd_i2c_device_t *device, int udata)
110 cs8427_t *chip = device->private_data;
113 udata = udata ? CS8427_BSEL : 0;
114 if (udata != (chip->regmap[CS8427_REG_CSDATABUF] & udata)) {
115 chip->regmap[CS8427_REG_CSDATABUF] &= ~CS8427_BSEL;
116 chip->regmap[CS8427_REG_CSDATABUF] |= udata;
117 err = snd_cs8427_reg_write(device, CS8427_REG_CSDATABUF, chip->regmap[CS8427_REG_CSDATABUF]);
124 static int snd_cs8427_send_corudata(snd_i2c_device_t *device,
126 unsigned char *ndata,
129 cs8427_t *chip = device->private_data;
130 char *hw_data = udata ? chip->playback.hw_udata : chip->playback.hw_status;
134 if (!memcmp(hw_data, ndata, count))
136 if ((err = snd_cs8427_select_corudata(device, udata)) < 0)
138 memcpy(hw_data, ndata, count);
140 memset(data, 0, sizeof(data));
141 if (memcmp(hw_data, data, count) == 0) {
142 chip->regmap[CS8427_REG_UDATABUF] &= ~CS8427_UBMMASK;
143 chip->regmap[CS8427_REG_UDATABUF] |= CS8427_UBMZEROS | CS8427_EFTUI;
144 if ((err = snd_cs8427_reg_write(device, CS8427_REG_UDATABUF, chip->regmap[CS8427_REG_UDATABUF])) < 0)
149 data[0] = CS8427_REG_AUTOINC | CS8427_REG_CORU_DATABUF;
150 for (idx = 0; idx < count; idx++)
151 data[idx + 1] = swapbits(ndata[idx]);
152 if (snd_i2c_sendbytes(device, data, count + 1) != count + 1)
157 static void snd_cs8427_free(snd_i2c_device_t *device)
159 if (device->private_data)
160 kfree(device->private_data);
163 int snd_cs8427_create(snd_i2c_bus_t *bus,
165 unsigned int reset_timeout,
166 snd_i2c_device_t **r_cs8427)
168 static unsigned char initvals1[] = {
169 CS8427_REG_CONTROL1 | CS8427_REG_AUTOINC,
170 /* CS8427_REG_CONTROL1: RMCK to OMCK, valid PCM audio, disable mutes, TCBL=output */
171 CS8427_SWCLK | CS8427_TCBLDIR,
172 /* CS8427_REG_CONTROL2: hold last valid audio sample, RMCK=256*Fs, normal stereo operation */
174 /* CS8427_REG_DATAFLOW: output drivers normal operation, Tx<=serial, Rx=>serial */
175 CS8427_TXDSERIAL | CS8427_SPDAES3RECEIVER,
176 /* CS8427_REG_CLOCKSOURCE: Run off, CMCK=256*Fs, output time base = OMCK, input time base =
177 recovered input clock, recovered input clock source is ILRCK changed to AES3INPUT (workaround, see snd_cs8427_reset) */
179 /* CS8427_REG_SERIALINPUT: Serial audio input port data format = I2S, 24-bit, 64*Fsi */
180 CS8427_SIDEL | CS8427_SILRPOL,
181 /* CS8427_REG_SERIALOUTPUT: Serial audio output port data format = I2S, 24-bit, 64*Fsi */
182 CS8427_SODEL | CS8427_SOLRPOL,
184 static unsigned char initvals2[] = {
185 CS8427_REG_RECVERRMASK | CS8427_REG_AUTOINC,
186 /* CS8427_REG_RECVERRMASK: unmask the input PLL clock, V, confidence, biphase, parity status bits */
187 /* CS8427_UNLOCK | CS8427_V | CS8427_CONF | CS8427_BIP | CS8427_PAR, */
188 0xff, /* set everything */
189 /* CS8427_REG_CSDATABUF:
190 Registers 32-55 window to CS buffer
191 Inhibit D->E transfers from overwriting first 5 bytes of CS data.
192 Inhibit D->E transfers (all) of CS data.
193 Allow E->F transfer of CS data.
194 One byte mode; both A/B channels get same written CB data.
195 A channel info is output to chip's EMPH* pin. */
196 CS8427_CBMR | CS8427_DETCI,
197 /* CS8427_REG_UDATABUF:
198 Use internal buffer to transmit User (U) data.
199 Chip's U pin is an output.
200 Transmit all O's for user data.
201 Inhibit D->E transfers.
202 Inhibit E->F transfers. */
203 CS8427_UD | CS8427_EFTUI | CS8427_DETUI,
207 snd_i2c_device_t *device;
208 unsigned char buf[24];
210 if ((err = snd_i2c_device_create(bus, "CS8427", CS8427_ADDR | (addr & 7), &device)) < 0)
212 chip = device->private_data = kcalloc(1, sizeof(*chip), GFP_KERNEL);
214 snd_i2c_device_free(device);
217 device->private_free = snd_cs8427_free;
220 if ((err = snd_cs8427_reg_read(device, CS8427_REG_ID_AND_VER)) != CS8427_VER8427A) {
222 snd_printk("unable to find CS8427 signature (expected 0x%x, read 0x%x), initialization is not completed\n", CS8427_VER8427A, err);
225 /* turn off run bit while making changes to configuration */
226 if ((err = snd_cs8427_reg_write(device, CS8427_REG_CLOCKSOURCE, 0x00)) < 0)
228 /* send initial values */
229 memcpy(chip->regmap + (initvals1[0] & 0x7f), initvals1 + 1, 6);
230 if ((err = snd_i2c_sendbytes(device, initvals1, 7)) != 7) {
231 err = err < 0 ? err : -EIO;
234 /* Turn off CS8427 interrupt stuff that is not used in hardware */
236 /* from address 9 to 15 */
237 buf[0] = 9; /* register */
238 if ((err = snd_i2c_sendbytes(device, buf, 7)) != 7)
240 /* send transfer initialization sequence */
241 memcpy(chip->regmap + (initvals2[0] & 0x7f), initvals2 + 1, 3);
242 if ((err = snd_i2c_sendbytes(device, initvals2, 4)) != 4) {
243 err = err < 0 ? err : -EIO;
246 /* write default channel status bytes */
247 buf[0] = ((unsigned char)(SNDRV_PCM_DEFAULT_CON_SPDIF >> 0));
248 buf[1] = ((unsigned char)(SNDRV_PCM_DEFAULT_CON_SPDIF >> 8));
249 buf[2] = ((unsigned char)(SNDRV_PCM_DEFAULT_CON_SPDIF >> 16));
250 buf[3] = ((unsigned char)(SNDRV_PCM_DEFAULT_CON_SPDIF >> 24));
251 memset(buf + 4, 0, 24 - 4);
252 if (snd_cs8427_send_corudata(device, 0, buf, 24) < 0)
254 memcpy(chip->playback.def_status, buf, 24);
255 memcpy(chip->playback.pcm_status, buf, 24);
258 /* turn on run bit and rock'n'roll */
259 if (reset_timeout < 1)
261 chip->reset_timeout = reset_timeout;
262 snd_cs8427_reset(device);
264 #if 0 // it's nice for read tests
269 snd_i2c_sendbytes(device, buf, 1);
270 snd_i2c_readbytes(device, buf, 127);
271 for (xx = 0; xx < 127; xx++)
272 printk("reg[0x%x] = 0x%x\n", xx+1, buf[xx]);
282 snd_i2c_device_free(device);
283 return err < 0 ? err : -EIO;
287 * Reset the chip using run bit, also lock PLL using ILRCK and
288 * put back AES3INPUT. This workaround is described in latest
289 * CS8427 datasheet, otherwise TXDSERIAL will not work.
291 void snd_cs8427_reset(snd_i2c_device_t *cs8427)
294 unsigned long end_time;
297 snd_assert(cs8427, return);
298 chip = cs8427->private_data;
299 snd_i2c_lock(cs8427->bus);
300 chip->regmap[CS8427_REG_CLOCKSOURCE] &= ~(CS8427_RUN | CS8427_RXDMASK);
301 snd_cs8427_reg_write(cs8427, CS8427_REG_CLOCKSOURCE, chip->regmap[CS8427_REG_CLOCKSOURCE]);
303 chip->regmap[CS8427_REG_CLOCKSOURCE] |= CS8427_RUN | CS8427_RXDILRCK;
304 snd_cs8427_reg_write(cs8427, CS8427_REG_CLOCKSOURCE, chip->regmap[CS8427_REG_CLOCKSOURCE]);
306 snd_i2c_unlock(cs8427->bus);
307 end_time = jiffies + chip->reset_timeout;
308 while (time_after_eq(end_time, jiffies)) {
309 snd_i2c_lock(cs8427->bus);
310 data = snd_cs8427_reg_read(cs8427, CS8427_REG_RECVERRORS);
311 snd_i2c_unlock(cs8427->bus);
312 if (!(data & CS8427_UNLOCK))
314 set_current_state(TASK_UNINTERRUPTIBLE);
317 snd_i2c_lock(cs8427->bus);
318 chip->regmap[CS8427_REG_CLOCKSOURCE] &= ~CS8427_RXDMASK;
319 chip->regmap[CS8427_REG_CLOCKSOURCE] |= CS8427_RXDAES3INPUT;
320 snd_cs8427_reg_write(cs8427, CS8427_REG_CLOCKSOURCE, chip->regmap[CS8427_REG_CLOCKSOURCE]);
321 snd_i2c_unlock(cs8427->bus);
324 static int snd_cs8427_in_status_info(snd_kcontrol_t *kcontrol,
325 snd_ctl_elem_info_t *uinfo)
327 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
329 uinfo->value.integer.min = 0;
330 uinfo->value.integer.max = 255;
334 static int snd_cs8427_in_status_get(snd_kcontrol_t *kcontrol,
335 snd_ctl_elem_value_t *ucontrol)
337 snd_i2c_device_t *device = snd_kcontrol_chip(kcontrol);
340 snd_i2c_lock(device->bus);
341 data = snd_cs8427_reg_read(device, kcontrol->private_value);
342 snd_i2c_unlock(device->bus);
345 ucontrol->value.integer.value[0] = data;
349 static int snd_cs8427_qsubcode_info(snd_kcontrol_t *kcontrol,
350 snd_ctl_elem_info_t *uinfo)
352 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
357 static int snd_cs8427_qsubcode_get(snd_kcontrol_t *kcontrol,
358 snd_ctl_elem_value_t *ucontrol)
360 snd_i2c_device_t *device = snd_kcontrol_chip(kcontrol);
361 unsigned char reg = CS8427_REG_QSUBCODE;
364 snd_i2c_lock(device->bus);
365 if ((err = snd_i2c_sendbytes(device, ®, 1)) != 1) {
366 snd_printk("unable to send register 0x%x byte to CS8427\n", reg);
367 snd_i2c_unlock(device->bus);
368 return err < 0 ? err : -EIO;
370 if ((err = snd_i2c_readbytes(device, ucontrol->value.bytes.data, 10)) != 10) {
371 snd_printk("unable to read Q-subcode bytes from CS8427\n");
372 snd_i2c_unlock(device->bus);
373 return err < 0 ? err : -EIO;
375 snd_i2c_unlock(device->bus);
379 static int snd_cs8427_spdif_info(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
381 uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
386 static int snd_cs8427_spdif_get(snd_kcontrol_t * kcontrol,
387 snd_ctl_elem_value_t * ucontrol)
389 snd_i2c_device_t *device = snd_kcontrol_chip(kcontrol);
390 cs8427_t *chip = device->private_data;
392 snd_i2c_lock(device->bus);
393 memcpy(ucontrol->value.iec958.status, chip->playback.def_status, 24);
394 snd_i2c_unlock(device->bus);
398 static int snd_cs8427_spdif_put(snd_kcontrol_t * kcontrol,
399 snd_ctl_elem_value_t * ucontrol)
401 snd_i2c_device_t *device = snd_kcontrol_chip(kcontrol);
402 cs8427_t *chip = device->private_data;
403 unsigned char *status = kcontrol->private_value ? chip->playback.pcm_status : chip->playback.def_status;
404 snd_pcm_runtime_t *runtime = chip->playback.substream ? chip->playback.substream->runtime : NULL;
407 snd_i2c_lock(device->bus);
408 change = memcmp(ucontrol->value.iec958.status, status, 24) != 0;
409 memcpy(status, ucontrol->value.iec958.status, 24);
410 if (change && (kcontrol->private_value ? runtime != NULL : runtime == NULL)) {
411 err = snd_cs8427_send_corudata(device, 0, status, 24);
415 snd_i2c_unlock(device->bus);
419 static int snd_cs8427_spdif_mask_info(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
421 uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
426 static int snd_cs8427_spdif_mask_get(snd_kcontrol_t * kcontrol,
427 snd_ctl_elem_value_t * ucontrol)
429 memset(ucontrol->value.iec958.status, 0xff, 24);
433 static snd_kcontrol_new_t snd_cs8427_iec958_controls[] = {
435 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
436 .info = snd_cs8427_in_status_info,
437 .name = "IEC958 CS8427 Input Status",
438 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
439 .get = snd_cs8427_in_status_get,
443 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
444 .info = snd_cs8427_in_status_info,
445 .name = "IEC958 CS8427 Error Status",
446 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
447 .get = snd_cs8427_in_status_get,
451 .access = SNDRV_CTL_ELEM_ACCESS_READ,
452 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
453 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,MASK),
454 .info = snd_cs8427_spdif_mask_info,
455 .get = snd_cs8427_spdif_mask_get,
458 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
459 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,DEFAULT),
460 .info = snd_cs8427_spdif_info,
461 .get = snd_cs8427_spdif_get,
462 .put = snd_cs8427_spdif_put,
466 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_INACTIVE,
467 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
468 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,PCM_STREAM),
469 .info = snd_cs8427_spdif_info,
470 .get = snd_cs8427_spdif_get,
471 .put = snd_cs8427_spdif_put,
475 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
476 .info = snd_cs8427_qsubcode_info,
477 .name = "IEC958 Q-subcode Capture Default",
478 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
479 .get = snd_cs8427_qsubcode_get
482 int snd_cs8427_iec958_build(snd_i2c_device_t *cs8427,
483 snd_pcm_substream_t *play_substream,
484 snd_pcm_substream_t *cap_substream)
486 cs8427_t *chip = cs8427->private_data;
487 snd_kcontrol_t *kctl;
491 snd_assert(play_substream && cap_substream, return -EINVAL);
492 for (idx = 0; idx < ARRAY_SIZE(snd_cs8427_iec958_controls); idx++) {
493 kctl = snd_ctl_new1(&snd_cs8427_iec958_controls[idx], cs8427);
496 kctl->id.device = play_substream->pcm->device;
497 kctl->id.subdevice = play_substream->number;
498 err = snd_ctl_add(cs8427->bus->card, kctl);
501 if (!strcmp(kctl->id.name, SNDRV_CTL_NAME_IEC958("",PLAYBACK,PCM_STREAM)))
502 chip->playback.pcm_ctl = kctl;
505 chip->playback.substream = play_substream;
506 chip->capture.substream = cap_substream;
507 snd_assert(chip->playback.pcm_ctl, return -EIO);
511 int snd_cs8427_iec958_active(snd_i2c_device_t *cs8427, int active)
515 snd_assert(cs8427, return -ENXIO);
516 chip = cs8427->private_data;
518 memcpy(chip->playback.pcm_status, chip->playback.def_status, 24);
519 chip->playback.pcm_ctl->vd[0].access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
520 snd_ctl_notify(cs8427->bus->card, SNDRV_CTL_EVENT_MASK_VALUE |
521 SNDRV_CTL_EVENT_MASK_INFO, &chip->playback.pcm_ctl->id);
525 int snd_cs8427_iec958_pcm(snd_i2c_device_t *cs8427, unsigned int rate)
531 snd_assert(cs8427, return -ENXIO);
532 chip = cs8427->private_data;
533 status = chip->playback.pcm_status;
534 snd_i2c_lock(cs8427->bus);
535 if (status[0] & IEC958_AES0_PROFESSIONAL) {
536 status[0] &= ~IEC958_AES0_PRO_FS;
538 case 32000: status[0] |= IEC958_AES0_PRO_FS_32000; break;
539 case 44100: status[0] |= IEC958_AES0_PRO_FS_44100; break;
540 case 48000: status[0] |= IEC958_AES0_PRO_FS_48000; break;
541 default: status[0] |= IEC958_AES0_PRO_FS_NOTID; break;
544 status[3] &= ~IEC958_AES3_CON_FS;
546 case 32000: status[3] |= IEC958_AES3_CON_FS_32000; break;
547 case 44100: status[3] |= IEC958_AES3_CON_FS_44100; break;
548 case 48000: status[3] |= IEC958_AES3_CON_FS_48000; break;
551 err = snd_cs8427_send_corudata(cs8427, 0, status, 24);
553 snd_ctl_notify(cs8427->bus->card,
554 SNDRV_CTL_EVENT_MASK_VALUE,
555 &chip->playback.pcm_ctl->id);
556 reset = chip->rate != rate;
558 snd_i2c_unlock(cs8427->bus);
560 snd_cs8427_reset(cs8427);
561 return err < 0 ? err : 0;
564 static int __init alsa_cs8427_module_init(void)
569 static void __exit alsa_cs8427_module_exit(void)
573 module_init(alsa_cs8427_module_init)
574 module_exit(alsa_cs8427_module_exit)
576 EXPORT_SYMBOL(snd_cs8427_detect);
577 EXPORT_SYMBOL(snd_cs8427_create);
578 EXPORT_SYMBOL(snd_cs8427_reset);
579 EXPORT_SYMBOL(snd_cs8427_reg_write);
580 EXPORT_SYMBOL(snd_cs8427_reg_read);
581 EXPORT_SYMBOL(snd_cs8427_iec958_build);
582 EXPORT_SYMBOL(snd_cs8427_iec958_active);
583 EXPORT_SYMBOL(snd_cs8427_iec958_pcm);