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 static void snd_cs8427_reset(snd_i2c_device_t *cs8427);
35 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
36 MODULE_DESCRIPTION("IEC958 (S/PDIF) receiver & transmitter by Cirrus Logic");
37 MODULE_LICENSE("GPL");
39 #define CS8427_ADDR (0x20>>1) /* fixed address */
42 snd_pcm_substream_t *substream;
43 char hw_status[24]; /* hardware status */
44 char def_status[24]; /* default status */
45 char pcm_status[24]; /* PCM private status */
47 snd_kcontrol_t *pcm_ctl;
51 unsigned char regmap[0x14]; /* map of first 1 + 13 registers */
53 unsigned int reset_timeout;
54 cs8427_stream_t playback;
55 cs8427_stream_t capture;
58 static unsigned char swapbits(unsigned char val)
61 unsigned char res = 0;
62 for (bit = 0; bit < 8; bit++) {
70 int snd_cs8427_reg_write(snd_i2c_device_t *device, unsigned char reg, unsigned char val)
77 if ((err = snd_i2c_sendbytes(device, buf, 2)) != 2) {
78 snd_printk(KERN_ERR "unable to send bytes 0x%02x:0x%02x to CS8427 (%i)\n", buf[0], buf[1], err);
79 return err < 0 ? err : -EIO;
84 static int snd_cs8427_reg_read(snd_i2c_device_t *device, unsigned char reg)
89 if ((err = snd_i2c_sendbytes(device, ®, 1)) != 1) {
90 snd_printk(KERN_ERR "unable to send register 0x%x byte to CS8427\n", reg);
91 return err < 0 ? err : -EIO;
93 if ((err = snd_i2c_readbytes(device, &buf, 1)) != 1) {
94 snd_printk(KERN_ERR "unable to read register 0x%x byte from CS8427\n", reg);
95 return err < 0 ? err : -EIO;
100 static int snd_cs8427_select_corudata(snd_i2c_device_t *device, int udata)
102 cs8427_t *chip = device->private_data;
105 udata = udata ? CS8427_BSEL : 0;
106 if (udata != (chip->regmap[CS8427_REG_CSDATABUF] & udata)) {
107 chip->regmap[CS8427_REG_CSDATABUF] &= ~CS8427_BSEL;
108 chip->regmap[CS8427_REG_CSDATABUF] |= udata;
109 err = snd_cs8427_reg_write(device, CS8427_REG_CSDATABUF, chip->regmap[CS8427_REG_CSDATABUF]);
116 static int snd_cs8427_send_corudata(snd_i2c_device_t *device,
118 unsigned char *ndata,
121 cs8427_t *chip = device->private_data;
122 char *hw_data = udata ? chip->playback.hw_udata : chip->playback.hw_status;
126 if (!memcmp(hw_data, ndata, count))
128 if ((err = snd_cs8427_select_corudata(device, udata)) < 0)
130 memcpy(hw_data, ndata, count);
132 memset(data, 0, sizeof(data));
133 if (memcmp(hw_data, data, count) == 0) {
134 chip->regmap[CS8427_REG_UDATABUF] &= ~CS8427_UBMMASK;
135 chip->regmap[CS8427_REG_UDATABUF] |= CS8427_UBMZEROS | CS8427_EFTUI;
136 if ((err = snd_cs8427_reg_write(device, CS8427_REG_UDATABUF, chip->regmap[CS8427_REG_UDATABUF])) < 0)
141 data[0] = CS8427_REG_AUTOINC | CS8427_REG_CORU_DATABUF;
142 for (idx = 0; idx < count; idx++)
143 data[idx + 1] = swapbits(ndata[idx]);
144 if (snd_i2c_sendbytes(device, data, count + 1) != count + 1)
149 static void snd_cs8427_free(snd_i2c_device_t *device)
151 kfree(device->private_data);
154 int snd_cs8427_create(snd_i2c_bus_t *bus,
156 unsigned int reset_timeout,
157 snd_i2c_device_t **r_cs8427)
159 static unsigned char initvals1[] = {
160 CS8427_REG_CONTROL1 | CS8427_REG_AUTOINC,
161 /* CS8427_REG_CONTROL1: RMCK to OMCK, valid PCM audio, disable mutes, TCBL=output */
162 CS8427_SWCLK | CS8427_TCBLDIR,
163 /* CS8427_REG_CONTROL2: hold last valid audio sample, RMCK=256*Fs, normal stereo operation */
165 /* CS8427_REG_DATAFLOW: output drivers normal operation, Tx<=serial, Rx=>serial */
166 CS8427_TXDSERIAL | CS8427_SPDAES3RECEIVER,
167 /* CS8427_REG_CLOCKSOURCE: Run off, CMCK=256*Fs, output time base = OMCK, input time base =
168 recovered input clock, recovered input clock source is ILRCK changed to AES3INPUT (workaround, see snd_cs8427_reset) */
170 /* CS8427_REG_SERIALINPUT: Serial audio input port data format = I2S, 24-bit, 64*Fsi */
171 CS8427_SIDEL | CS8427_SILRPOL,
172 /* CS8427_REG_SERIALOUTPUT: Serial audio output port data format = I2S, 24-bit, 64*Fsi */
173 CS8427_SODEL | CS8427_SOLRPOL,
175 static unsigned char initvals2[] = {
176 CS8427_REG_RECVERRMASK | CS8427_REG_AUTOINC,
177 /* CS8427_REG_RECVERRMASK: unmask the input PLL clock, V, confidence, biphase, parity status bits */
178 /* CS8427_UNLOCK | CS8427_V | CS8427_CONF | CS8427_BIP | CS8427_PAR, */
179 0xff, /* set everything */
180 /* CS8427_REG_CSDATABUF:
181 Registers 32-55 window to CS buffer
182 Inhibit D->E transfers from overwriting first 5 bytes of CS data.
183 Inhibit D->E transfers (all) of CS data.
184 Allow E->F transfer of CS data.
185 One byte mode; both A/B channels get same written CB data.
186 A channel info is output to chip's EMPH* pin. */
187 CS8427_CBMR | CS8427_DETCI,
188 /* CS8427_REG_UDATABUF:
189 Use internal buffer to transmit User (U) data.
190 Chip's U pin is an output.
191 Transmit all O's for user data.
192 Inhibit D->E transfers.
193 Inhibit E->F transfers. */
194 CS8427_UD | CS8427_EFTUI | CS8427_DETUI,
198 snd_i2c_device_t *device;
199 unsigned char buf[24];
201 if ((err = snd_i2c_device_create(bus, "CS8427", CS8427_ADDR | (addr & 7), &device)) < 0)
203 chip = device->private_data = kzalloc(sizeof(*chip), GFP_KERNEL);
205 snd_i2c_device_free(device);
208 device->private_free = snd_cs8427_free;
211 if ((err = snd_cs8427_reg_read(device, CS8427_REG_ID_AND_VER)) != CS8427_VER8427A) {
213 snd_printk(KERN_ERR "unable to find CS8427 signature (expected 0x%x, read 0x%x), initialization is not completed\n", CS8427_VER8427A, err);
216 /* turn off run bit while making changes to configuration */
217 if ((err = snd_cs8427_reg_write(device, CS8427_REG_CLOCKSOURCE, 0x00)) < 0)
219 /* send initial values */
220 memcpy(chip->regmap + (initvals1[0] & 0x7f), initvals1 + 1, 6);
221 if ((err = snd_i2c_sendbytes(device, initvals1, 7)) != 7) {
222 err = err < 0 ? err : -EIO;
225 /* Turn off CS8427 interrupt stuff that is not used in hardware */
227 /* from address 9 to 15 */
228 buf[0] = 9; /* register */
229 if ((err = snd_i2c_sendbytes(device, buf, 7)) != 7)
231 /* send transfer initialization sequence */
232 memcpy(chip->regmap + (initvals2[0] & 0x7f), initvals2 + 1, 3);
233 if ((err = snd_i2c_sendbytes(device, initvals2, 4)) != 4) {
234 err = err < 0 ? err : -EIO;
237 /* write default channel status bytes */
238 buf[0] = ((unsigned char)(SNDRV_PCM_DEFAULT_CON_SPDIF >> 0));
239 buf[1] = ((unsigned char)(SNDRV_PCM_DEFAULT_CON_SPDIF >> 8));
240 buf[2] = ((unsigned char)(SNDRV_PCM_DEFAULT_CON_SPDIF >> 16));
241 buf[3] = ((unsigned char)(SNDRV_PCM_DEFAULT_CON_SPDIF >> 24));
242 memset(buf + 4, 0, 24 - 4);
243 if (snd_cs8427_send_corudata(device, 0, buf, 24) < 0)
245 memcpy(chip->playback.def_status, buf, 24);
246 memcpy(chip->playback.pcm_status, buf, 24);
249 /* turn on run bit and rock'n'roll */
250 if (reset_timeout < 1)
252 chip->reset_timeout = reset_timeout;
253 snd_cs8427_reset(device);
255 #if 0 // it's nice for read tests
260 snd_i2c_sendbytes(device, buf, 1);
261 snd_i2c_readbytes(device, buf, 127);
262 for (xx = 0; xx < 127; xx++)
263 printk(KERN_DEBUG "reg[0x%x] = 0x%x\n", xx+1, buf[xx]);
273 snd_i2c_device_free(device);
274 return err < 0 ? err : -EIO;
278 * Reset the chip using run bit, also lock PLL using ILRCK and
279 * put back AES3INPUT. This workaround is described in latest
280 * CS8427 datasheet, otherwise TXDSERIAL will not work.
282 static void snd_cs8427_reset(snd_i2c_device_t *cs8427)
285 unsigned long end_time;
288 snd_assert(cs8427, return);
289 chip = cs8427->private_data;
290 snd_i2c_lock(cs8427->bus);
291 chip->regmap[CS8427_REG_CLOCKSOURCE] &= ~(CS8427_RUN | CS8427_RXDMASK);
292 snd_cs8427_reg_write(cs8427, CS8427_REG_CLOCKSOURCE, chip->regmap[CS8427_REG_CLOCKSOURCE]);
294 chip->regmap[CS8427_REG_CLOCKSOURCE] |= CS8427_RUN | CS8427_RXDILRCK;
295 snd_cs8427_reg_write(cs8427, CS8427_REG_CLOCKSOURCE, chip->regmap[CS8427_REG_CLOCKSOURCE]);
297 snd_i2c_unlock(cs8427->bus);
298 end_time = jiffies + chip->reset_timeout;
299 while (time_after_eq(end_time, jiffies)) {
300 snd_i2c_lock(cs8427->bus);
301 data = snd_cs8427_reg_read(cs8427, CS8427_REG_RECVERRORS);
302 snd_i2c_unlock(cs8427->bus);
303 if (!(data & CS8427_UNLOCK))
305 schedule_timeout_uninterruptible(1);
307 snd_i2c_lock(cs8427->bus);
308 chip->regmap[CS8427_REG_CLOCKSOURCE] &= ~CS8427_RXDMASK;
309 chip->regmap[CS8427_REG_CLOCKSOURCE] |= CS8427_RXDAES3INPUT;
310 snd_cs8427_reg_write(cs8427, CS8427_REG_CLOCKSOURCE, chip->regmap[CS8427_REG_CLOCKSOURCE]);
311 snd_i2c_unlock(cs8427->bus);
314 static int snd_cs8427_in_status_info(snd_kcontrol_t *kcontrol,
315 snd_ctl_elem_info_t *uinfo)
317 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
319 uinfo->value.integer.min = 0;
320 uinfo->value.integer.max = 255;
324 static int snd_cs8427_in_status_get(snd_kcontrol_t *kcontrol,
325 snd_ctl_elem_value_t *ucontrol)
327 snd_i2c_device_t *device = snd_kcontrol_chip(kcontrol);
330 snd_i2c_lock(device->bus);
331 data = snd_cs8427_reg_read(device, kcontrol->private_value);
332 snd_i2c_unlock(device->bus);
335 ucontrol->value.integer.value[0] = data;
339 static int snd_cs8427_qsubcode_info(snd_kcontrol_t *kcontrol,
340 snd_ctl_elem_info_t *uinfo)
342 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
347 static int snd_cs8427_qsubcode_get(snd_kcontrol_t *kcontrol,
348 snd_ctl_elem_value_t *ucontrol)
350 snd_i2c_device_t *device = snd_kcontrol_chip(kcontrol);
351 unsigned char reg = CS8427_REG_QSUBCODE;
354 snd_i2c_lock(device->bus);
355 if ((err = snd_i2c_sendbytes(device, ®, 1)) != 1) {
356 snd_printk(KERN_ERR "unable to send register 0x%x byte to CS8427\n", reg);
357 snd_i2c_unlock(device->bus);
358 return err < 0 ? err : -EIO;
360 if ((err = snd_i2c_readbytes(device, ucontrol->value.bytes.data, 10)) != 10) {
361 snd_printk(KERN_ERR "unable to read Q-subcode bytes from CS8427\n");
362 snd_i2c_unlock(device->bus);
363 return err < 0 ? err : -EIO;
365 snd_i2c_unlock(device->bus);
369 static int snd_cs8427_spdif_info(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
371 uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
376 static int snd_cs8427_spdif_get(snd_kcontrol_t * kcontrol,
377 snd_ctl_elem_value_t * ucontrol)
379 snd_i2c_device_t *device = snd_kcontrol_chip(kcontrol);
380 cs8427_t *chip = device->private_data;
382 snd_i2c_lock(device->bus);
383 memcpy(ucontrol->value.iec958.status, chip->playback.def_status, 24);
384 snd_i2c_unlock(device->bus);
388 static int snd_cs8427_spdif_put(snd_kcontrol_t * kcontrol,
389 snd_ctl_elem_value_t * ucontrol)
391 snd_i2c_device_t *device = snd_kcontrol_chip(kcontrol);
392 cs8427_t *chip = device->private_data;
393 unsigned char *status = kcontrol->private_value ? chip->playback.pcm_status : chip->playback.def_status;
394 snd_pcm_runtime_t *runtime = chip->playback.substream ? chip->playback.substream->runtime : NULL;
397 snd_i2c_lock(device->bus);
398 change = memcmp(ucontrol->value.iec958.status, status, 24) != 0;
399 memcpy(status, ucontrol->value.iec958.status, 24);
400 if (change && (kcontrol->private_value ? runtime != NULL : runtime == NULL)) {
401 err = snd_cs8427_send_corudata(device, 0, status, 24);
405 snd_i2c_unlock(device->bus);
409 static int snd_cs8427_spdif_mask_info(snd_kcontrol_t *kcontrol, snd_ctl_elem_info_t * uinfo)
411 uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
416 static int snd_cs8427_spdif_mask_get(snd_kcontrol_t * kcontrol,
417 snd_ctl_elem_value_t * ucontrol)
419 memset(ucontrol->value.iec958.status, 0xff, 24);
423 static snd_kcontrol_new_t snd_cs8427_iec958_controls[] = {
425 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
426 .info = snd_cs8427_in_status_info,
427 .name = "IEC958 CS8427 Input Status",
428 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
429 .get = snd_cs8427_in_status_get,
433 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
434 .info = snd_cs8427_in_status_info,
435 .name = "IEC958 CS8427 Error Status",
436 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
437 .get = snd_cs8427_in_status_get,
441 .access = SNDRV_CTL_ELEM_ACCESS_READ,
442 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
443 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,MASK),
444 .info = snd_cs8427_spdif_mask_info,
445 .get = snd_cs8427_spdif_mask_get,
448 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
449 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,DEFAULT),
450 .info = snd_cs8427_spdif_info,
451 .get = snd_cs8427_spdif_get,
452 .put = snd_cs8427_spdif_put,
456 .access = SNDRV_CTL_ELEM_ACCESS_READWRITE | SNDRV_CTL_ELEM_ACCESS_INACTIVE,
457 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
458 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,PCM_STREAM),
459 .info = snd_cs8427_spdif_info,
460 .get = snd_cs8427_spdif_get,
461 .put = snd_cs8427_spdif_put,
465 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
466 .info = snd_cs8427_qsubcode_info,
467 .name = "IEC958 Q-subcode Capture Default",
468 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
469 .get = snd_cs8427_qsubcode_get
472 int snd_cs8427_iec958_build(snd_i2c_device_t *cs8427,
473 snd_pcm_substream_t *play_substream,
474 snd_pcm_substream_t *cap_substream)
476 cs8427_t *chip = cs8427->private_data;
477 snd_kcontrol_t *kctl;
481 snd_assert(play_substream && cap_substream, return -EINVAL);
482 for (idx = 0; idx < ARRAY_SIZE(snd_cs8427_iec958_controls); idx++) {
483 kctl = snd_ctl_new1(&snd_cs8427_iec958_controls[idx], cs8427);
486 kctl->id.device = play_substream->pcm->device;
487 kctl->id.subdevice = play_substream->number;
488 err = snd_ctl_add(cs8427->bus->card, kctl);
491 if (!strcmp(kctl->id.name, SNDRV_CTL_NAME_IEC958("",PLAYBACK,PCM_STREAM)))
492 chip->playback.pcm_ctl = kctl;
495 chip->playback.substream = play_substream;
496 chip->capture.substream = cap_substream;
497 snd_assert(chip->playback.pcm_ctl, return -EIO);
501 int snd_cs8427_iec958_active(snd_i2c_device_t *cs8427, int active)
505 snd_assert(cs8427, return -ENXIO);
506 chip = cs8427->private_data;
508 memcpy(chip->playback.pcm_status, chip->playback.def_status, 24);
509 chip->playback.pcm_ctl->vd[0].access &= ~SNDRV_CTL_ELEM_ACCESS_INACTIVE;
510 snd_ctl_notify(cs8427->bus->card, SNDRV_CTL_EVENT_MASK_VALUE |
511 SNDRV_CTL_EVENT_MASK_INFO, &chip->playback.pcm_ctl->id);
515 int snd_cs8427_iec958_pcm(snd_i2c_device_t *cs8427, unsigned int rate)
521 snd_assert(cs8427, return -ENXIO);
522 chip = cs8427->private_data;
523 status = chip->playback.pcm_status;
524 snd_i2c_lock(cs8427->bus);
525 if (status[0] & IEC958_AES0_PROFESSIONAL) {
526 status[0] &= ~IEC958_AES0_PRO_FS;
528 case 32000: status[0] |= IEC958_AES0_PRO_FS_32000; break;
529 case 44100: status[0] |= IEC958_AES0_PRO_FS_44100; break;
530 case 48000: status[0] |= IEC958_AES0_PRO_FS_48000; break;
531 default: status[0] |= IEC958_AES0_PRO_FS_NOTID; break;
534 status[3] &= ~IEC958_AES3_CON_FS;
536 case 32000: status[3] |= IEC958_AES3_CON_FS_32000; break;
537 case 44100: status[3] |= IEC958_AES3_CON_FS_44100; break;
538 case 48000: status[3] |= IEC958_AES3_CON_FS_48000; break;
541 err = snd_cs8427_send_corudata(cs8427, 0, status, 24);
543 snd_ctl_notify(cs8427->bus->card,
544 SNDRV_CTL_EVENT_MASK_VALUE,
545 &chip->playback.pcm_ctl->id);
546 reset = chip->rate != rate;
548 snd_i2c_unlock(cs8427->bus);
550 snd_cs8427_reset(cs8427);
551 return err < 0 ? err : 0;
554 static int __init alsa_cs8427_module_init(void)
559 static void __exit alsa_cs8427_module_exit(void)
563 module_init(alsa_cs8427_module_init)
564 module_exit(alsa_cs8427_module_exit)
566 EXPORT_SYMBOL(snd_cs8427_create);
567 EXPORT_SYMBOL(snd_cs8427_reset);
568 EXPORT_SYMBOL(snd_cs8427_reg_write);
569 EXPORT_SYMBOL(snd_cs8427_iec958_build);
570 EXPORT_SYMBOL(snd_cs8427_iec958_active);
571 EXPORT_SYMBOL(snd_cs8427_iec958_pcm);