2 * Routines for control of the AK4114 via I2C and 4-wire serial interface
3 * IEC958 (S/PDIF) receiver by Asahi Kasei
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 <sound/core.h>
27 #include <sound/control.h>
28 #include <sound/pcm.h>
29 #include <sound/ak4114.h>
30 #include <sound/asoundef.h>
32 MODULE_AUTHOR("Jaroslav Kysela <perex@suse.cz>");
33 MODULE_DESCRIPTION("AK4114 IEC958 (S/PDIF) receiver by Asahi Kasei");
34 MODULE_LICENSE("GPL");
36 #define AK4114_ADDR 0x00 /* fixed address */
38 static void ak4114_stats(struct work_struct *work);
40 static void reg_write(struct ak4114 *ak4114, unsigned char reg, unsigned char val)
42 ak4114->write(ak4114->private_data, reg, val);
43 if (reg <= AK4114_REG_INT1_MASK)
44 ak4114->regmap[reg] = val;
45 else if (reg >= AK4114_REG_RXCSB0 && reg <= AK4114_REG_TXCSB4)
46 ak4114->txcsb[reg-AK4114_REG_RXCSB0] = val;
49 static inline unsigned char reg_read(struct ak4114 *ak4114, unsigned char reg)
51 return ak4114->read(ak4114->private_data, reg);
55 static void reg_dump(struct ak4114 *ak4114)
59 printk(KERN_DEBUG "AK4114 REG DUMP:\n");
60 for (i = 0; i < 0x20; i++)
61 printk(KERN_DEBUG "reg[%02x] = %02x (%02x)\n", i, reg_read(ak4114, i), i < sizeof(ak4114->regmap) ? ak4114->regmap[i] : 0);
65 static void snd_ak4114_free(struct ak4114 *chip)
67 chip->init = 1; /* don't schedule new work */
69 flush_scheduled_work();
73 static int snd_ak4114_dev_free(struct snd_device *device)
75 struct ak4114 *chip = device->device_data;
76 snd_ak4114_free(chip);
80 int snd_ak4114_create(struct snd_card *card,
81 ak4114_read_t *read, ak4114_write_t *write,
82 const unsigned char pgm[7], const unsigned char txcsb[5],
83 void *private_data, struct ak4114 **r_ak4114)
88 static struct snd_device_ops ops = {
89 .dev_free = snd_ak4114_dev_free,
92 chip = kzalloc(sizeof(*chip), GFP_KERNEL);
95 spin_lock_init(&chip->lock);
99 chip->private_data = private_data;
101 for (reg = 0; reg < 7; reg++)
102 chip->regmap[reg] = pgm[reg];
103 for (reg = 0; reg < 5; reg++)
104 chip->txcsb[reg] = txcsb[reg];
106 snd_ak4114_reinit(chip);
108 chip->rcs0 = reg_read(chip, AK4114_REG_RCS0) & ~(AK4114_QINT | AK4114_CINT);
109 chip->rcs1 = reg_read(chip, AK4114_REG_RCS1);
111 if ((err = snd_device_new(card, SNDRV_DEV_LOWLEVEL, chip, &ops)) < 0)
119 snd_ak4114_free(chip);
120 return err < 0 ? err : -EIO;
123 void snd_ak4114_reg_write(struct ak4114 *chip, unsigned char reg, unsigned char mask, unsigned char val)
125 if (reg <= AK4114_REG_INT1_MASK)
126 reg_write(chip, reg, (chip->regmap[reg] & ~mask) | val);
127 else if (reg >= AK4114_REG_TXCSB0 && reg <= AK4114_REG_TXCSB4)
128 reg_write(chip, reg, (chip->txcsb[reg] & ~mask) | val);
131 void snd_ak4114_reinit(struct ak4114 *chip)
133 unsigned char old = chip->regmap[AK4114_REG_PWRDN], reg;
137 flush_scheduled_work();
138 /* bring the chip to reset state and powerdown state */
139 reg_write(chip, AK4114_REG_PWRDN, old & ~(AK4114_RST|AK4114_PWN));
141 /* release reset, but leave powerdown */
142 reg_write(chip, AK4114_REG_PWRDN, (old | AK4114_RST) & ~AK4114_PWN);
144 for (reg = 1; reg < 7; reg++)
145 reg_write(chip, reg, chip->regmap[reg]);
146 for (reg = 0; reg < 5; reg++)
147 reg_write(chip, reg + AK4114_REG_TXCSB0, chip->txcsb[reg]);
148 /* release powerdown, everything is initialized now */
149 reg_write(chip, AK4114_REG_PWRDN, old | AK4114_RST | AK4114_PWN);
150 /* bring up statistics / event queing */
152 INIT_DELAYED_WORK(&chip->work, ak4114_stats);
153 schedule_delayed_work(&chip->work, HZ / 10);
156 static unsigned int external_rate(unsigned char rcs1)
158 switch (rcs1 & (AK4114_FS0|AK4114_FS1|AK4114_FS2|AK4114_FS3)) {
159 case AK4114_FS_32000HZ: return 32000;
160 case AK4114_FS_44100HZ: return 44100;
161 case AK4114_FS_48000HZ: return 48000;
162 case AK4114_FS_88200HZ: return 88200;
163 case AK4114_FS_96000HZ: return 96000;
164 case AK4114_FS_176400HZ: return 176400;
165 case AK4114_FS_192000HZ: return 192000;
170 static int snd_ak4114_in_error_info(struct snd_kcontrol *kcontrol,
171 struct snd_ctl_elem_info *uinfo)
173 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
175 uinfo->value.integer.min = 0;
176 uinfo->value.integer.max = LONG_MAX;
180 static int snd_ak4114_in_error_get(struct snd_kcontrol *kcontrol,
181 struct snd_ctl_elem_value *ucontrol)
183 struct ak4114 *chip = snd_kcontrol_chip(kcontrol);
186 spin_lock_irq(&chip->lock);
187 ptr = (long *)(((char *)chip) + kcontrol->private_value);
188 ucontrol->value.integer.value[0] = *ptr;
190 spin_unlock_irq(&chip->lock);
194 static int snd_ak4114_in_bit_info(struct snd_kcontrol *kcontrol,
195 struct snd_ctl_elem_info *uinfo)
197 uinfo->type = SNDRV_CTL_ELEM_TYPE_BOOLEAN;
199 uinfo->value.integer.min = 0;
200 uinfo->value.integer.max = 1;
204 static int snd_ak4114_in_bit_get(struct snd_kcontrol *kcontrol,
205 struct snd_ctl_elem_value *ucontrol)
207 struct ak4114 *chip = snd_kcontrol_chip(kcontrol);
208 unsigned char reg = kcontrol->private_value & 0xff;
209 unsigned char bit = (kcontrol->private_value >> 8) & 0xff;
210 unsigned char inv = (kcontrol->private_value >> 31) & 1;
212 ucontrol->value.integer.value[0] = ((reg_read(chip, reg) & (1 << bit)) ? 1 : 0) ^ inv;
216 static int snd_ak4114_rate_info(struct snd_kcontrol *kcontrol,
217 struct snd_ctl_elem_info *uinfo)
219 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
221 uinfo->value.integer.min = 0;
222 uinfo->value.integer.max = 192000;
226 static int snd_ak4114_rate_get(struct snd_kcontrol *kcontrol,
227 struct snd_ctl_elem_value *ucontrol)
229 struct ak4114 *chip = snd_kcontrol_chip(kcontrol);
231 ucontrol->value.integer.value[0] = external_rate(reg_read(chip, AK4114_REG_RCS1));
235 static int snd_ak4114_spdif_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
237 uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
242 static int snd_ak4114_spdif_get(struct snd_kcontrol *kcontrol,
243 struct snd_ctl_elem_value *ucontrol)
245 struct ak4114 *chip = snd_kcontrol_chip(kcontrol);
248 for (i = 0; i < AK4114_REG_RXCSB_SIZE; i++)
249 ucontrol->value.iec958.status[i] = reg_read(chip, AK4114_REG_RXCSB0 + i);
253 static int snd_ak4114_spdif_playback_get(struct snd_kcontrol *kcontrol,
254 struct snd_ctl_elem_value *ucontrol)
256 struct ak4114 *chip = snd_kcontrol_chip(kcontrol);
259 for (i = 0; i < AK4114_REG_TXCSB_SIZE; i++)
260 ucontrol->value.iec958.status[i] = chip->txcsb[i];
264 static int snd_ak4114_spdif_playback_put(struct snd_kcontrol *kcontrol,
265 struct snd_ctl_elem_value *ucontrol)
267 struct ak4114 *chip = snd_kcontrol_chip(kcontrol);
270 for (i = 0; i < AK4114_REG_TXCSB_SIZE; i++)
271 reg_write(chip, AK4114_REG_TXCSB0 + i, ucontrol->value.iec958.status[i]);
275 static int snd_ak4114_spdif_mask_info(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
277 uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
282 static int snd_ak4114_spdif_mask_get(struct snd_kcontrol *kcontrol,
283 struct snd_ctl_elem_value *ucontrol)
285 memset(ucontrol->value.iec958.status, 0xff, AK4114_REG_RXCSB_SIZE);
289 static int snd_ak4114_spdif_pinfo(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
291 uinfo->type = SNDRV_CTL_ELEM_TYPE_INTEGER;
292 uinfo->value.integer.min = 0;
293 uinfo->value.integer.max = 0xffff;
298 static int snd_ak4114_spdif_pget(struct snd_kcontrol *kcontrol,
299 struct snd_ctl_elem_value *ucontrol)
301 struct ak4114 *chip = snd_kcontrol_chip(kcontrol);
304 ucontrol->value.integer.value[0] = 0xf8f2;
305 ucontrol->value.integer.value[1] = 0x4e1f;
306 tmp = reg_read(chip, AK4114_REG_Pc0) | (reg_read(chip, AK4114_REG_Pc1) << 8);
307 ucontrol->value.integer.value[2] = tmp;
308 tmp = reg_read(chip, AK4114_REG_Pd0) | (reg_read(chip, AK4114_REG_Pd1) << 8);
309 ucontrol->value.integer.value[3] = tmp;
313 static int snd_ak4114_spdif_qinfo(struct snd_kcontrol *kcontrol, struct snd_ctl_elem_info *uinfo)
315 uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
316 uinfo->count = AK4114_REG_QSUB_SIZE;
320 static int snd_ak4114_spdif_qget(struct snd_kcontrol *kcontrol,
321 struct snd_ctl_elem_value *ucontrol)
323 struct ak4114 *chip = snd_kcontrol_chip(kcontrol);
326 for (i = 0; i < AK4114_REG_QSUB_SIZE; i++)
327 ucontrol->value.bytes.data[i] = reg_read(chip, AK4114_REG_QSUB_ADDR + i);
331 /* Don't forget to change AK4114_CONTROLS define!!! */
332 static struct snd_kcontrol_new snd_ak4114_iec958_controls[] = {
334 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
335 .name = "IEC958 Parity Errors",
336 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
337 .info = snd_ak4114_in_error_info,
338 .get = snd_ak4114_in_error_get,
339 .private_value = offsetof(struct ak4114, parity_errors),
342 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
343 .name = "IEC958 V-Bit Errors",
344 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
345 .info = snd_ak4114_in_error_info,
346 .get = snd_ak4114_in_error_get,
347 .private_value = offsetof(struct ak4114, v_bit_errors),
350 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
351 .name = "IEC958 C-CRC Errors",
352 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
353 .info = snd_ak4114_in_error_info,
354 .get = snd_ak4114_in_error_get,
355 .private_value = offsetof(struct ak4114, ccrc_errors),
358 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
359 .name = "IEC958 Q-CRC Errors",
360 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
361 .info = snd_ak4114_in_error_info,
362 .get = snd_ak4114_in_error_get,
363 .private_value = offsetof(struct ak4114, qcrc_errors),
366 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
367 .name = "IEC958 External Rate",
368 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
369 .info = snd_ak4114_rate_info,
370 .get = snd_ak4114_rate_get,
373 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
374 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,MASK),
375 .access = SNDRV_CTL_ELEM_ACCESS_READ,
376 .info = snd_ak4114_spdif_mask_info,
377 .get = snd_ak4114_spdif_mask_get,
380 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
381 .name = SNDRV_CTL_NAME_IEC958("",PLAYBACK,DEFAULT),
382 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
383 .info = snd_ak4114_spdif_info,
384 .get = snd_ak4114_spdif_playback_get,
385 .put = snd_ak4114_spdif_playback_put,
388 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
389 .name = SNDRV_CTL_NAME_IEC958("",CAPTURE,MASK),
390 .access = SNDRV_CTL_ELEM_ACCESS_READ,
391 .info = snd_ak4114_spdif_mask_info,
392 .get = snd_ak4114_spdif_mask_get,
395 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
396 .name = SNDRV_CTL_NAME_IEC958("",CAPTURE,DEFAULT),
397 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
398 .info = snd_ak4114_spdif_info,
399 .get = snd_ak4114_spdif_get,
402 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
403 .name = "IEC958 Preample Capture Default",
404 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
405 .info = snd_ak4114_spdif_pinfo,
406 .get = snd_ak4114_spdif_pget,
409 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
410 .name = "IEC958 Q-subcode Capture Default",
411 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
412 .info = snd_ak4114_spdif_qinfo,
413 .get = snd_ak4114_spdif_qget,
416 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
417 .name = "IEC958 Audio",
418 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
419 .info = snd_ak4114_in_bit_info,
420 .get = snd_ak4114_in_bit_get,
421 .private_value = (1<<31) | (1<<8) | AK4114_REG_RCS0,
424 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
425 .name = "IEC958 Non-PCM Bitstream",
426 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
427 .info = snd_ak4114_in_bit_info,
428 .get = snd_ak4114_in_bit_get,
429 .private_value = (6<<8) | AK4114_REG_RCS1,
432 .iface = SNDRV_CTL_ELEM_IFACE_PCM,
433 .name = "IEC958 DTS Bitstream",
434 .access = SNDRV_CTL_ELEM_ACCESS_READ | SNDRV_CTL_ELEM_ACCESS_VOLATILE,
435 .info = snd_ak4114_in_bit_info,
436 .get = snd_ak4114_in_bit_get,
437 .private_value = (3<<8) | AK4114_REG_RCS1,
441 int snd_ak4114_build(struct ak4114 *ak4114,
442 struct snd_pcm_substream *ply_substream,
443 struct snd_pcm_substream *cap_substream)
445 struct snd_kcontrol *kctl;
449 snd_assert(cap_substream, return -EINVAL);
450 ak4114->playback_substream = ply_substream;
451 ak4114->capture_substream = cap_substream;
452 for (idx = 0; idx < AK4114_CONTROLS; idx++) {
453 kctl = snd_ctl_new1(&snd_ak4114_iec958_controls[idx], ak4114);
456 if (!strstr(kctl->id.name, "Playback")) {
457 if (ply_substream == NULL) {
458 snd_ctl_free_one(kctl);
459 ak4114->kctls[idx] = NULL;
462 kctl->id.device = ply_substream->pcm->device;
463 kctl->id.subdevice = ply_substream->number;
465 kctl->id.device = cap_substream->pcm->device;
466 kctl->id.subdevice = cap_substream->number;
468 err = snd_ctl_add(ak4114->card, kctl);
471 ak4114->kctls[idx] = kctl;
476 int snd_ak4114_external_rate(struct ak4114 *ak4114)
480 rcs1 = reg_read(ak4114, AK4114_REG_RCS1);
481 return external_rate(rcs1);
484 int snd_ak4114_check_rate_and_errors(struct ak4114 *ak4114, unsigned int flags)
486 struct snd_pcm_runtime *runtime = ak4114->capture_substream ? ak4114->capture_substream->runtime : NULL;
487 unsigned long _flags;
489 unsigned char rcs0, rcs1;
490 unsigned char c0, c1;
492 rcs1 = reg_read(ak4114, AK4114_REG_RCS1);
493 if (flags & AK4114_CHECK_NO_STAT)
495 rcs0 = reg_read(ak4114, AK4114_REG_RCS0);
496 spin_lock_irqsave(&ak4114->lock, _flags);
497 if (rcs0 & AK4114_PAR)
498 ak4114->parity_errors++;
500 ak4114->v_bit_errors++;
501 if (rcs1 & AK4114_CCRC)
502 ak4114->ccrc_errors++;
503 if (rcs1 & AK4114_QCRC)
504 ak4114->qcrc_errors++;
505 c0 = (ak4114->rcs0 & (AK4114_QINT | AK4114_CINT | AK4114_PEM | AK4114_AUDION | AK4114_AUTO | AK4114_UNLCK)) ^
506 (rcs0 & (AK4114_QINT | AK4114_CINT | AK4114_PEM | AK4114_AUDION | AK4114_AUTO | AK4114_UNLCK));
507 c1 = (ak4114->rcs1 & 0xf0) ^ (rcs1 & 0xf0);
508 ak4114->rcs0 = rcs0 & ~(AK4114_QINT | AK4114_CINT);
510 spin_unlock_irqrestore(&ak4114->lock, _flags);
512 if (rcs0 & AK4114_PAR)
513 snd_ctl_notify(ak4114->card, SNDRV_CTL_EVENT_MASK_VALUE, &ak4114->kctls[0]->id);
515 snd_ctl_notify(ak4114->card, SNDRV_CTL_EVENT_MASK_VALUE, &ak4114->kctls[1]->id);
516 if (rcs1 & AK4114_CCRC)
517 snd_ctl_notify(ak4114->card, SNDRV_CTL_EVENT_MASK_VALUE, &ak4114->kctls[2]->id);
518 if (rcs1 & AK4114_QCRC)
519 snd_ctl_notify(ak4114->card, SNDRV_CTL_EVENT_MASK_VALUE, &ak4114->kctls[3]->id);
523 snd_ctl_notify(ak4114->card, SNDRV_CTL_EVENT_MASK_VALUE, &ak4114->kctls[4]->id);
525 if ((c0 & AK4114_PEM) | (c0 & AK4114_CINT))
526 snd_ctl_notify(ak4114->card, SNDRV_CTL_EVENT_MASK_VALUE, &ak4114->kctls[9]->id);
527 if (c0 & AK4114_QINT)
528 snd_ctl_notify(ak4114->card, SNDRV_CTL_EVENT_MASK_VALUE, &ak4114->kctls[10]->id);
530 if (c0 & AK4114_AUDION)
531 snd_ctl_notify(ak4114->card, SNDRV_CTL_EVENT_MASK_VALUE, &ak4114->kctls[11]->id);
532 if (c0 & AK4114_AUTO)
533 snd_ctl_notify(ak4114->card, SNDRV_CTL_EVENT_MASK_VALUE, &ak4114->kctls[12]->id);
534 if (c0 & AK4114_DTSCD)
535 snd_ctl_notify(ak4114->card, SNDRV_CTL_EVENT_MASK_VALUE, &ak4114->kctls[13]->id);
537 if (ak4114->change_callback && (c0 | c1) != 0)
538 ak4114->change_callback(ak4114, c0, c1);
542 res = external_rate(rcs1);
543 if (!(flags & AK4114_CHECK_NO_RATE) && runtime && runtime->rate != res) {
544 snd_pcm_stream_lock_irqsave(ak4114->capture_substream, _flags);
545 if (snd_pcm_running(ak4114->capture_substream)) {
546 // printk(KERN_DEBUG "rate changed (%i <- %i)\n", runtime->rate, res);
547 snd_pcm_stop(ak4114->capture_substream, SNDRV_PCM_STATE_DRAINING);
550 snd_pcm_stream_unlock_irqrestore(ak4114->capture_substream, _flags);
555 static void ak4114_stats(struct work_struct *work)
557 struct ak4114 *chip = container_of(work, struct ak4114, work.work);
561 snd_ak4114_check_rate_and_errors(chip, 0);
562 schedule_delayed_work(&chip->work, HZ / 10);
565 EXPORT_SYMBOL(snd_ak4114_create);
566 EXPORT_SYMBOL(snd_ak4114_reg_write);
567 EXPORT_SYMBOL(snd_ak4114_reinit);
568 EXPORT_SYMBOL(snd_ak4114_build);
569 EXPORT_SYMBOL(snd_ak4114_external_rate);
570 EXPORT_SYMBOL(snd_ak4114_check_rate_and_errors);