2 * Fifo-attached Serial Interface (FSI) support for SH7724
4 * Copyright (C) 2009 Renesas Solutions Corp.
5 * Kuninori Morimoto <morimoto.kuninori@renesas.com>
8 * Copyright (c) 2007 Manuel Lauss <mano@roarinelk.homelinux.net>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
15 #include <linux/init.h>
16 #include <linux/module.h>
17 #include <linux/platform_device.h>
18 #include <linux/delay.h>
19 #include <linux/list.h>
20 #include <linux/pm_runtime.h>
22 #include <sound/core.h>
23 #include <sound/pcm.h>
24 #include <sound/initval.h>
25 #include <sound/soc.h>
26 #include <sound/pcm_params.h>
27 #include <sound/sh_fsi.h>
28 #include <asm/atomic.h>
31 #define DOFF_CTL 0x0004
32 #define DOFF_ST 0x0008
34 #define DIFF_CTL 0x0010
35 #define DIFF_ST 0x0014
40 #define MUTE_ST 0x0028
41 #define REG_END MUTE_ST
47 #define CLK_RST 0x0210
48 #define SOFT_RST 0x0214
49 #define MREG_START INT_ST
50 #define MREG_END SOFT_RST
54 #define CR_FMT(param) ((param) << 4)
56 # define CR_MONO_D 0x1
64 #define IRQ_HALF 0x00100000
65 #define FIFO_CLR 0x00000001
68 #define ERR_OVER 0x00000010
69 #define ERR_UNDER 0x00000001
70 #define ST_ERR (ERR_OVER | ERR_UNDER)
73 #define B_CLK 0x00000010
74 #define A_CLK 0x00000001
77 #define INT_B_IN (1 << 12)
78 #define INT_B_OUT (1 << 8)
79 #define INT_A_IN (1 << 4)
80 #define INT_A_OUT (1 << 0)
82 #define FSI_RATES SNDRV_PCM_RATE_8000_96000
84 #define FSI_FMTS (SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S16_LE)
86 /************************************************************************
92 ************************************************************************/
95 struct snd_pcm_substream *substream;
96 struct fsi_master *master;
110 struct fsi_priv fsia;
111 struct fsi_priv fsib;
112 struct sh_fsi_platform_info *info;
116 /************************************************************************
119 basic read write function
122 ************************************************************************/
123 static int __fsi_reg_write(u32 reg, u32 data)
125 /* valid data area is 24bit */
128 return ctrl_outl(data, reg);
131 static u32 __fsi_reg_read(u32 reg)
133 return ctrl_inl(reg);
136 static int __fsi_reg_mask_set(u32 reg, u32 mask, u32 data)
138 u32 val = __fsi_reg_read(reg);
143 return __fsi_reg_write(reg, val);
146 static int fsi_reg_write(struct fsi_priv *fsi, u32 reg, u32 data)
151 return __fsi_reg_write((u32)(fsi->base + reg), data);
154 static u32 fsi_reg_read(struct fsi_priv *fsi, u32 reg)
159 return __fsi_reg_read((u32)(fsi->base + reg));
162 static int fsi_reg_mask_set(struct fsi_priv *fsi, u32 reg, u32 mask, u32 data)
167 return __fsi_reg_mask_set((u32)(fsi->base + reg), mask, data);
170 static int fsi_master_write(struct fsi_master *master, u32 reg, u32 data)
175 if ((reg < MREG_START) ||
179 spin_lock_irqsave(&master->lock, flags);
180 ret = __fsi_reg_write((u32)(master->base + reg), data);
181 spin_unlock_irqrestore(&master->lock, flags);
186 static u32 fsi_master_read(struct fsi_master *master, u32 reg)
191 if ((reg < MREG_START) ||
195 spin_lock_irqsave(&master->lock, flags);
196 ret = __fsi_reg_read((u32)(master->base + reg));
197 spin_unlock_irqrestore(&master->lock, flags);
202 static int fsi_master_mask_set(struct fsi_master *master,
203 u32 reg, u32 mask, u32 data)
208 if ((reg < MREG_START) ||
212 spin_lock_irqsave(&master->lock, flags);
213 ret = __fsi_reg_mask_set((u32)(master->base + reg), mask, data);
214 spin_unlock_irqrestore(&master->lock, flags);
219 /************************************************************************
225 ************************************************************************/
226 static struct fsi_master *fsi_get_master(struct fsi_priv *fsi)
231 static int fsi_is_port_a(struct fsi_priv *fsi)
233 return fsi->master->base == fsi->base;
236 static struct snd_soc_dai *fsi_get_dai(struct snd_pcm_substream *substream)
238 struct snd_soc_pcm_runtime *rtd = substream->private_data;
239 struct snd_soc_dai_link *machine = rtd->dai;
241 return machine->cpu_dai;
244 static struct fsi_priv *fsi_get_priv(struct snd_pcm_substream *substream)
246 struct snd_soc_dai *dai = fsi_get_dai(substream);
248 return dai->private_data;
251 static u32 fsi_get_info_flags(struct fsi_priv *fsi)
253 int is_porta = fsi_is_port_a(fsi);
254 struct fsi_master *master = fsi_get_master(fsi);
256 return is_porta ? master->info->porta_flags :
257 master->info->portb_flags;
260 static int fsi_is_master_mode(struct fsi_priv *fsi, int is_play)
263 u32 flags = fsi_get_info_flags(fsi);
265 mode = is_play ? SH_FSI_OUT_SLAVE_MODE : SH_FSI_IN_SLAVE_MODE;
272 return (mode & flags) != mode;
275 static u32 fsi_port_ab_io_bit(struct fsi_priv *fsi, int is_play)
277 int is_porta = fsi_is_port_a(fsi);
281 data = is_play ? (1 << 0) : (1 << 4);
283 data = is_play ? (1 << 8) : (1 << 12);
288 static void fsi_stream_push(struct fsi_priv *fsi,
289 struct snd_pcm_substream *substream,
293 fsi->substream = substream;
294 fsi->buffer_len = buffer_len;
295 fsi->period_len = period_len;
296 fsi->byte_offset = 0;
300 static void fsi_stream_pop(struct fsi_priv *fsi)
302 fsi->substream = NULL;
305 fsi->byte_offset = 0;
309 static int fsi_get_fifo_residue(struct fsi_priv *fsi, int is_play)
312 u32 reg = is_play ? DOFF_ST : DIFF_ST;
315 status = fsi_reg_read(fsi, reg);
316 residue = 0x1ff & (status >> 8);
317 residue *= fsi->chan;
322 /************************************************************************
328 ************************************************************************/
329 static void fsi_irq_enable(struct fsi_priv *fsi, int is_play)
331 u32 data = fsi_port_ab_io_bit(fsi, is_play);
332 struct fsi_master *master = fsi_get_master(fsi);
334 fsi_master_mask_set(master, IMSK, data, data);
335 fsi_master_mask_set(master, IEMSK, data, data);
338 static void fsi_irq_disable(struct fsi_priv *fsi, int is_play)
340 u32 data = fsi_port_ab_io_bit(fsi, is_play);
341 struct fsi_master *master = fsi_get_master(fsi);
343 fsi_master_mask_set(master, IMSK, data, 0);
344 fsi_master_mask_set(master, IEMSK, data, 0);
347 static void fsi_clk_ctrl(struct fsi_priv *fsi, int enable)
349 u32 val = fsi_is_port_a(fsi) ? (1 << 0) : (1 << 4);
350 struct fsi_master *master = fsi_get_master(fsi);
353 fsi_master_mask_set(master, CLK_RST, val, val);
355 fsi_master_mask_set(master, CLK_RST, val, 0);
358 static void fsi_irq_init(struct fsi_priv *fsi, int is_play)
363 data = fsi_port_ab_io_bit(fsi, is_play);
364 ctrl = is_play ? DOFF_CTL : DIFF_CTL;
367 fsi_irq_disable(fsi, is_play);
369 /* set interrupt generation factor */
370 fsi_reg_write(fsi, ctrl, IRQ_HALF);
373 fsi_reg_mask_set(fsi, ctrl, FIFO_CLR, FIFO_CLR);
375 /* clear interrupt factor */
376 fsi_master_mask_set(fsi_get_master(fsi), INT_ST, data, 0);
379 static void fsi_soft_all_reset(struct fsi_master *master)
381 u32 status = fsi_master_read(master, SOFT_RST);
384 status &= 0x000000ff;
385 fsi_master_write(master, SOFT_RST, status);
389 status &= 0x000000f0;
390 fsi_master_write(master, SOFT_RST, status);
391 status |= 0x00000001;
392 fsi_master_write(master, SOFT_RST, status);
396 /* playback interrupt */
397 static int fsi_data_push(struct fsi_priv *fsi)
399 struct snd_pcm_runtime *runtime;
400 struct snd_pcm_substream *substream = NULL;
406 int i, ret, over_period;
410 !fsi->substream->runtime)
414 substream = fsi->substream;
415 runtime = substream->runtime;
417 /* FSI FIFO has limit.
418 * So, this driver can not send periods data at a time
420 if (fsi->byte_offset >=
421 fsi->period_len * (fsi->periods + 1)) {
424 fsi->periods = (fsi->periods + 1) % runtime->periods;
426 if (0 == fsi->periods)
427 fsi->byte_offset = 0;
430 /* get 1 channel data width */
431 width = frames_to_bytes(runtime, 1) / fsi->chan;
433 /* get send size for alsa */
434 send = (fsi->buffer_len - fsi->byte_offset) / width;
436 /* get FIFO free size */
437 fifo_free = (fsi->fifo_max * fsi->chan) - fsi_get_fifo_residue(fsi, 1);
440 if (fifo_free < send)
443 start = runtime->dma_area;
444 start += fsi->byte_offset;
448 for (i = 0; i < send; i++)
449 fsi_reg_write(fsi, DODT,
450 ((u32)*((u16 *)start + i) << 8));
453 for (i = 0; i < send; i++)
454 fsi_reg_write(fsi, DODT, *((u32 *)start + i));
460 fsi->byte_offset += send * width;
463 status = fsi_reg_read(fsi, DOFF_ST);
464 if (status & ERR_OVER) {
465 struct snd_soc_dai *dai = fsi_get_dai(substream);
466 dev_err(dai->dev, "over run error\n");
467 fsi_reg_write(fsi, DOFF_ST, status & ~ST_ERR);
471 fsi_irq_enable(fsi, 1);
474 snd_pcm_period_elapsed(substream);
479 static int fsi_data_pop(struct fsi_priv *fsi)
481 struct snd_pcm_runtime *runtime;
482 struct snd_pcm_substream *substream = NULL;
488 int i, ret, over_period;
492 !fsi->substream->runtime)
496 substream = fsi->substream;
497 runtime = substream->runtime;
499 /* FSI FIFO has limit.
500 * So, this driver can not send periods data at a time
502 if (fsi->byte_offset >=
503 fsi->period_len * (fsi->periods + 1)) {
506 fsi->periods = (fsi->periods + 1) % runtime->periods;
508 if (0 == fsi->periods)
509 fsi->byte_offset = 0;
512 /* get 1 channel data width */
513 width = frames_to_bytes(runtime, 1) / fsi->chan;
515 /* get free space for alsa */
516 free = (fsi->buffer_len - fsi->byte_offset) / width;
519 fifo_fill = fsi_get_fifo_residue(fsi, 0);
521 if (free < fifo_fill)
524 start = runtime->dma_area;
525 start += fsi->byte_offset;
529 for (i = 0; i < fifo_fill; i++)
530 *((u16 *)start + i) =
531 (u16)(fsi_reg_read(fsi, DIDT) >> 8);
534 for (i = 0; i < fifo_fill; i++)
535 *((u32 *)start + i) = fsi_reg_read(fsi, DIDT);
541 fsi->byte_offset += fifo_fill * width;
544 status = fsi_reg_read(fsi, DIFF_ST);
545 if (status & ERR_UNDER) {
546 struct snd_soc_dai *dai = fsi_get_dai(substream);
547 dev_err(dai->dev, "under run error\n");
548 fsi_reg_write(fsi, DIFF_ST, status & ~ST_ERR);
552 fsi_irq_enable(fsi, 0);
555 snd_pcm_period_elapsed(substream);
560 static irqreturn_t fsi_interrupt(int irq, void *data)
562 struct fsi_master *master = data;
563 u32 status = fsi_master_read(master, SOFT_RST) & ~0x00000010;
564 u32 int_st = fsi_master_read(master, INT_ST);
566 /* clear irq status */
567 fsi_master_write(master, SOFT_RST, status);
568 fsi_master_write(master, SOFT_RST, status | 0x00000010);
570 if (int_st & INT_A_OUT)
571 fsi_data_push(&master->fsia);
572 if (int_st & INT_B_OUT)
573 fsi_data_push(&master->fsib);
574 if (int_st & INT_A_IN)
575 fsi_data_pop(&master->fsia);
576 if (int_st & INT_B_IN)
577 fsi_data_pop(&master->fsib);
579 fsi_master_write(master, INT_ST, 0x0000000);
584 /************************************************************************
590 ************************************************************************/
591 static int fsi_dai_startup(struct snd_pcm_substream *substream,
592 struct snd_soc_dai *dai)
594 struct fsi_priv *fsi = fsi_get_priv(substream);
596 u32 flags = fsi_get_info_flags(fsi);
600 int is_play = (substream->stream == SNDRV_PCM_STREAM_PLAYBACK);
604 pm_runtime_get_sync(dai->dev);
607 data = is_play ? (1 << 0) : (1 << 4);
608 is_master = fsi_is_master_mode(fsi, is_play);
610 fsi_reg_mask_set(fsi, CKG1, data, data);
612 fsi_reg_mask_set(fsi, CKG1, data, 0);
614 /* clock inversion (CKG2) */
616 switch (SH_FSI_INVERSION_MASK & flags) {
630 fsi_reg_write(fsi, CKG2, data);
634 reg = is_play ? DO_FMT : DI_FMT;
635 fmt = is_play ? SH_FSI_GET_OFMT(flags) : SH_FSI_GET_IFMT(flags);
637 case SH_FSI_FMT_MONO:
639 data = CR_FMT(CR_MONO);
642 case SH_FSI_FMT_MONO_DELAY:
644 data = CR_FMT(CR_MONO_D);
649 data = CR_FMT(CR_PCM);
654 data = CR_FMT(CR_I2S);
659 data = CR_FMT(CR_TDM) | (fsi->chan - 1);
660 fsi->chan = is_play ?
661 SH_FSI_GET_CH_O(flags) : SH_FSI_GET_CH_I(flags);
663 case SH_FSI_FMT_TDM_DELAY:
665 data = CR_FMT(CR_TDM_D) | (fsi->chan - 1);
666 fsi->chan = is_play ?
667 SH_FSI_GET_CH_O(flags) : SH_FSI_GET_CH_I(flags);
670 dev_err(dai->dev, "unknown format.\n");
692 dev_err(dai->dev, "channel size error.\n");
696 fsi_reg_write(fsi, reg, data);
699 * clear clk reset if master mode
702 fsi_clk_ctrl(fsi, 1);
705 fsi_irq_init(fsi, is_play);
710 static void fsi_dai_shutdown(struct snd_pcm_substream *substream,
711 struct snd_soc_dai *dai)
713 struct fsi_priv *fsi = fsi_get_priv(substream);
714 int is_play = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
716 fsi_irq_disable(fsi, is_play);
717 fsi_clk_ctrl(fsi, 0);
719 pm_runtime_put_sync(dai->dev);
722 static int fsi_dai_trigger(struct snd_pcm_substream *substream, int cmd,
723 struct snd_soc_dai *dai)
725 struct fsi_priv *fsi = fsi_get_priv(substream);
726 struct snd_pcm_runtime *runtime = substream->runtime;
727 int is_play = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
731 case SNDRV_PCM_TRIGGER_START:
732 fsi_stream_push(fsi, substream,
733 frames_to_bytes(runtime, runtime->buffer_size),
734 frames_to_bytes(runtime, runtime->period_size));
735 ret = is_play ? fsi_data_push(fsi) : fsi_data_pop(fsi);
737 case SNDRV_PCM_TRIGGER_STOP:
738 fsi_irq_disable(fsi, is_play);
746 static struct snd_soc_dai_ops fsi_dai_ops = {
747 .startup = fsi_dai_startup,
748 .shutdown = fsi_dai_shutdown,
749 .trigger = fsi_dai_trigger,
752 /************************************************************************
758 ************************************************************************/
759 static struct snd_pcm_hardware fsi_pcm_hardware = {
760 .info = SNDRV_PCM_INFO_INTERLEAVED |
761 SNDRV_PCM_INFO_MMAP |
762 SNDRV_PCM_INFO_MMAP_VALID |
763 SNDRV_PCM_INFO_PAUSE,
770 .buffer_bytes_max = 64 * 1024,
771 .period_bytes_min = 32,
772 .period_bytes_max = 8192,
778 static int fsi_pcm_open(struct snd_pcm_substream *substream)
780 struct snd_pcm_runtime *runtime = substream->runtime;
783 snd_soc_set_runtime_hwparams(substream, &fsi_pcm_hardware);
785 ret = snd_pcm_hw_constraint_integer(runtime,
786 SNDRV_PCM_HW_PARAM_PERIODS);
791 static int fsi_hw_params(struct snd_pcm_substream *substream,
792 struct snd_pcm_hw_params *hw_params)
794 return snd_pcm_lib_malloc_pages(substream,
795 params_buffer_bytes(hw_params));
798 static int fsi_hw_free(struct snd_pcm_substream *substream)
800 return snd_pcm_lib_free_pages(substream);
803 static snd_pcm_uframes_t fsi_pointer(struct snd_pcm_substream *substream)
805 struct snd_pcm_runtime *runtime = substream->runtime;
806 struct fsi_priv *fsi = fsi_get_priv(substream);
809 location = (fsi->byte_offset - 1);
813 return bytes_to_frames(runtime, location);
816 static struct snd_pcm_ops fsi_pcm_ops = {
817 .open = fsi_pcm_open,
818 .ioctl = snd_pcm_lib_ioctl,
819 .hw_params = fsi_hw_params,
820 .hw_free = fsi_hw_free,
821 .pointer = fsi_pointer,
824 /************************************************************************
830 ************************************************************************/
831 #define PREALLOC_BUFFER (32 * 1024)
832 #define PREALLOC_BUFFER_MAX (32 * 1024)
834 static void fsi_pcm_free(struct snd_pcm *pcm)
836 snd_pcm_lib_preallocate_free_for_all(pcm);
839 static int fsi_pcm_new(struct snd_card *card,
840 struct snd_soc_dai *dai,
844 * dont use SNDRV_DMA_TYPE_DEV, since it will oops the SH kernel
845 * in MMAP mode (i.e. aplay -M)
847 return snd_pcm_lib_preallocate_pages_for_all(
849 SNDRV_DMA_TYPE_CONTINUOUS,
850 snd_dma_continuous_data(GFP_KERNEL),
851 PREALLOC_BUFFER, PREALLOC_BUFFER_MAX);
854 /************************************************************************
860 ************************************************************************/
861 struct snd_soc_dai fsi_soc_dai[] = {
897 EXPORT_SYMBOL_GPL(fsi_soc_dai);
899 struct snd_soc_platform fsi_soc_platform = {
901 .pcm_ops = &fsi_pcm_ops,
902 .pcm_new = fsi_pcm_new,
903 .pcm_free = fsi_pcm_free,
905 EXPORT_SYMBOL_GPL(fsi_soc_platform);
907 /************************************************************************
913 ************************************************************************/
914 static int fsi_probe(struct platform_device *pdev)
916 struct fsi_master *master;
917 struct resource *res;
922 dev_err(&pdev->dev, "current fsi support id 0 only now\n");
926 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
927 irq = platform_get_irq(pdev, 0);
928 if (!res || (int)irq <= 0) {
929 dev_err(&pdev->dev, "Not enough FSI platform resources.\n");
934 master = kzalloc(sizeof(*master), GFP_KERNEL);
936 dev_err(&pdev->dev, "Could not allocate master\n");
941 master->base = ioremap_nocache(res->start, resource_size(res));
944 dev_err(&pdev->dev, "Unable to ioremap FSI registers.\n");
949 master->info = pdev->dev.platform_data;
950 master->fsia.base = master->base;
951 master->fsia.master = master;
952 master->fsib.base = master->base + 0x40;
953 master->fsib.master = master;
954 spin_lock_init(&master->lock);
956 pm_runtime_enable(&pdev->dev);
957 pm_runtime_resume(&pdev->dev);
959 fsi_soc_dai[0].dev = &pdev->dev;
960 fsi_soc_dai[0].private_data = &master->fsia;
961 fsi_soc_dai[1].dev = &pdev->dev;
962 fsi_soc_dai[1].private_data = &master->fsib;
964 fsi_soft_all_reset(master);
966 ret = request_irq(irq, &fsi_interrupt, IRQF_DISABLED, "fsi", master);
968 dev_err(&pdev->dev, "irq request err\n");
972 ret = snd_soc_register_platform(&fsi_soc_platform);
974 dev_err(&pdev->dev, "cannot snd soc register\n");
978 return snd_soc_register_dais(fsi_soc_dai, ARRAY_SIZE(fsi_soc_dai));
981 free_irq(irq, master);
983 iounmap(master->base);
984 pm_runtime_disable(&pdev->dev);
992 static int fsi_remove(struct platform_device *pdev)
994 struct fsi_master *master;
996 master = fsi_get_master(fsi_soc_dai[0].private_data);
998 snd_soc_unregister_dais(fsi_soc_dai, ARRAY_SIZE(fsi_soc_dai));
999 snd_soc_unregister_platform(&fsi_soc_platform);
1001 pm_runtime_disable(&pdev->dev);
1003 free_irq(master->irq, master);
1005 iounmap(master->base);
1008 fsi_soc_dai[0].dev = NULL;
1009 fsi_soc_dai[0].private_data = NULL;
1010 fsi_soc_dai[1].dev = NULL;
1011 fsi_soc_dai[1].private_data = NULL;
1016 static int fsi_runtime_nop(struct device *dev)
1018 /* Runtime PM callback shared between ->runtime_suspend()
1019 * and ->runtime_resume(). Simply returns success.
1021 * This driver re-initializes all registers after
1022 * pm_runtime_get_sync() anyway so there is no need
1023 * to save and restore registers here.
1028 static struct dev_pm_ops fsi_pm_ops = {
1029 .runtime_suspend = fsi_runtime_nop,
1030 .runtime_resume = fsi_runtime_nop,
1033 static struct platform_driver fsi_driver = {
1039 .remove = fsi_remove,
1042 static int __init fsi_mobile_init(void)
1044 return platform_driver_register(&fsi_driver);
1047 static void __exit fsi_mobile_exit(void)
1049 platform_driver_unregister(&fsi_driver);
1051 module_init(fsi_mobile_init);
1052 module_exit(fsi_mobile_exit);
1054 MODULE_LICENSE("GPL");
1055 MODULE_DESCRIPTION("SuperH onchip FSI audio driver");
1056 MODULE_AUTHOR("Kuninori Morimoto <morimoto.kuninori@renesas.com>");