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 void __fsi_reg_write(u32 reg, u32 data)
125 /* valid data area is 24bit */
128 __raw_writel(data, reg);
131 static u32 __fsi_reg_read(u32 reg)
133 return __raw_readl(reg);
136 static void __fsi_reg_mask_set(u32 reg, u32 mask, u32 data)
138 u32 val = __fsi_reg_read(reg);
143 __fsi_reg_write(reg, val);
146 static void fsi_reg_write(struct fsi_priv *fsi, u32 reg, u32 data)
151 __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 void fsi_reg_mask_set(struct fsi_priv *fsi, u32 reg, u32 mask, u32 data)
167 __fsi_reg_mask_set((u32)(fsi->base + reg), mask, data);
170 static void fsi_master_write(struct fsi_master *master, u32 reg, u32 data)
174 if ((reg < MREG_START) ||
178 spin_lock_irqsave(&master->lock, flags);
179 __fsi_reg_write((u32)(master->base + reg), data);
180 spin_unlock_irqrestore(&master->lock, flags);
183 static u32 fsi_master_read(struct fsi_master *master, u32 reg)
188 if ((reg < MREG_START) ||
192 spin_lock_irqsave(&master->lock, flags);
193 ret = __fsi_reg_read((u32)(master->base + reg));
194 spin_unlock_irqrestore(&master->lock, flags);
199 static void fsi_master_mask_set(struct fsi_master *master,
200 u32 reg, u32 mask, u32 data)
204 if ((reg < MREG_START) ||
208 spin_lock_irqsave(&master->lock, flags);
209 __fsi_reg_mask_set((u32)(master->base + reg), mask, data);
210 spin_unlock_irqrestore(&master->lock, flags);
213 /************************************************************************
219 ************************************************************************/
220 static struct fsi_master *fsi_get_master(struct fsi_priv *fsi)
225 static int fsi_is_port_a(struct fsi_priv *fsi)
227 return fsi->master->base == fsi->base;
230 static struct snd_soc_dai *fsi_get_dai(struct snd_pcm_substream *substream)
232 struct snd_soc_pcm_runtime *rtd = substream->private_data;
233 struct snd_soc_dai_link *machine = rtd->dai;
235 return machine->cpu_dai;
238 static struct fsi_priv *fsi_get_priv(struct snd_pcm_substream *substream)
240 struct snd_soc_dai *dai = fsi_get_dai(substream);
242 return dai->private_data;
245 static u32 fsi_get_info_flags(struct fsi_priv *fsi)
247 int is_porta = fsi_is_port_a(fsi);
248 struct fsi_master *master = fsi_get_master(fsi);
250 return is_porta ? master->info->porta_flags :
251 master->info->portb_flags;
254 static int fsi_is_master_mode(struct fsi_priv *fsi, int is_play)
257 u32 flags = fsi_get_info_flags(fsi);
259 mode = is_play ? SH_FSI_OUT_SLAVE_MODE : SH_FSI_IN_SLAVE_MODE;
266 return (mode & flags) != mode;
269 static u32 fsi_port_ab_io_bit(struct fsi_priv *fsi, int is_play)
271 int is_porta = fsi_is_port_a(fsi);
275 data = is_play ? (1 << 0) : (1 << 4);
277 data = is_play ? (1 << 8) : (1 << 12);
282 static void fsi_stream_push(struct fsi_priv *fsi,
283 struct snd_pcm_substream *substream,
287 fsi->substream = substream;
288 fsi->buffer_len = buffer_len;
289 fsi->period_len = period_len;
290 fsi->byte_offset = 0;
294 static void fsi_stream_pop(struct fsi_priv *fsi)
296 fsi->substream = NULL;
299 fsi->byte_offset = 0;
303 static int fsi_get_fifo_residue(struct fsi_priv *fsi, int is_play)
306 u32 reg = is_play ? DOFF_ST : DIFF_ST;
309 status = fsi_reg_read(fsi, reg);
310 residue = 0x1ff & (status >> 8);
311 residue *= fsi->chan;
316 /************************************************************************
322 ************************************************************************/
323 static void fsi_irq_enable(struct fsi_priv *fsi, int is_play)
325 u32 data = fsi_port_ab_io_bit(fsi, is_play);
326 struct fsi_master *master = fsi_get_master(fsi);
328 fsi_master_mask_set(master, IMSK, data, data);
329 fsi_master_mask_set(master, IEMSK, data, data);
332 static void fsi_irq_disable(struct fsi_priv *fsi, int is_play)
334 u32 data = fsi_port_ab_io_bit(fsi, is_play);
335 struct fsi_master *master = fsi_get_master(fsi);
337 fsi_master_mask_set(master, IMSK, data, 0);
338 fsi_master_mask_set(master, IEMSK, data, 0);
341 static void fsi_clk_ctrl(struct fsi_priv *fsi, int enable)
343 u32 val = fsi_is_port_a(fsi) ? (1 << 0) : (1 << 4);
344 struct fsi_master *master = fsi_get_master(fsi);
347 fsi_master_mask_set(master, CLK_RST, val, val);
349 fsi_master_mask_set(master, CLK_RST, val, 0);
352 static void fsi_irq_init(struct fsi_priv *fsi, int is_play)
357 data = fsi_port_ab_io_bit(fsi, is_play);
358 ctrl = is_play ? DOFF_CTL : DIFF_CTL;
361 fsi_irq_disable(fsi, is_play);
363 /* set interrupt generation factor */
364 fsi_reg_write(fsi, ctrl, IRQ_HALF);
367 fsi_reg_mask_set(fsi, ctrl, FIFO_CLR, FIFO_CLR);
369 /* clear interrupt factor */
370 fsi_master_mask_set(fsi_get_master(fsi), INT_ST, data, 0);
373 static void fsi_soft_all_reset(struct fsi_master *master)
375 u32 status = fsi_master_read(master, SOFT_RST);
378 status &= 0x000000ff;
379 fsi_master_write(master, SOFT_RST, status);
383 status &= 0x000000f0;
384 fsi_master_write(master, SOFT_RST, status);
385 status |= 0x00000001;
386 fsi_master_write(master, SOFT_RST, status);
390 /* playback interrupt */
391 static int fsi_data_push(struct fsi_priv *fsi)
393 struct snd_pcm_runtime *runtime;
394 struct snd_pcm_substream *substream = NULL;
400 int i, ret, over_period;
404 !fsi->substream->runtime)
408 substream = fsi->substream;
409 runtime = substream->runtime;
411 /* FSI FIFO has limit.
412 * So, this driver can not send periods data at a time
414 if (fsi->byte_offset >=
415 fsi->period_len * (fsi->periods + 1)) {
418 fsi->periods = (fsi->periods + 1) % runtime->periods;
420 if (0 == fsi->periods)
421 fsi->byte_offset = 0;
424 /* get 1 channel data width */
425 width = frames_to_bytes(runtime, 1) / fsi->chan;
427 /* get send size for alsa */
428 send = (fsi->buffer_len - fsi->byte_offset) / width;
430 /* get FIFO free size */
431 fifo_free = (fsi->fifo_max * fsi->chan) - fsi_get_fifo_residue(fsi, 1);
434 if (fifo_free < send)
437 start = runtime->dma_area;
438 start += fsi->byte_offset;
442 for (i = 0; i < send; i++)
443 fsi_reg_write(fsi, DODT,
444 ((u32)*((u16 *)start + i) << 8));
447 for (i = 0; i < send; i++)
448 fsi_reg_write(fsi, DODT, *((u32 *)start + i));
454 fsi->byte_offset += send * width;
457 status = fsi_reg_read(fsi, DOFF_ST);
458 if (status & ERR_OVER) {
459 struct snd_soc_dai *dai = fsi_get_dai(substream);
460 dev_err(dai->dev, "over run error\n");
461 fsi_reg_write(fsi, DOFF_ST, status & ~ST_ERR);
465 fsi_irq_enable(fsi, 1);
468 snd_pcm_period_elapsed(substream);
473 static int fsi_data_pop(struct fsi_priv *fsi)
475 struct snd_pcm_runtime *runtime;
476 struct snd_pcm_substream *substream = NULL;
482 int i, ret, over_period;
486 !fsi->substream->runtime)
490 substream = fsi->substream;
491 runtime = substream->runtime;
493 /* FSI FIFO has limit.
494 * So, this driver can not send periods data at a time
496 if (fsi->byte_offset >=
497 fsi->period_len * (fsi->periods + 1)) {
500 fsi->periods = (fsi->periods + 1) % runtime->periods;
502 if (0 == fsi->periods)
503 fsi->byte_offset = 0;
506 /* get 1 channel data width */
507 width = frames_to_bytes(runtime, 1) / fsi->chan;
509 /* get free space for alsa */
510 free = (fsi->buffer_len - fsi->byte_offset) / width;
513 fifo_fill = fsi_get_fifo_residue(fsi, 0);
515 if (free < fifo_fill)
518 start = runtime->dma_area;
519 start += fsi->byte_offset;
523 for (i = 0; i < fifo_fill; i++)
524 *((u16 *)start + i) =
525 (u16)(fsi_reg_read(fsi, DIDT) >> 8);
528 for (i = 0; i < fifo_fill; i++)
529 *((u32 *)start + i) = fsi_reg_read(fsi, DIDT);
535 fsi->byte_offset += fifo_fill * width;
538 status = fsi_reg_read(fsi, DIFF_ST);
539 if (status & ERR_UNDER) {
540 struct snd_soc_dai *dai = fsi_get_dai(substream);
541 dev_err(dai->dev, "under run error\n");
542 fsi_reg_write(fsi, DIFF_ST, status & ~ST_ERR);
546 fsi_irq_enable(fsi, 0);
549 snd_pcm_period_elapsed(substream);
554 static irqreturn_t fsi_interrupt(int irq, void *data)
556 struct fsi_master *master = data;
557 u32 status = fsi_master_read(master, SOFT_RST) & ~0x00000010;
558 u32 int_st = fsi_master_read(master, INT_ST);
560 /* clear irq status */
561 fsi_master_write(master, SOFT_RST, status);
562 fsi_master_write(master, SOFT_RST, status | 0x00000010);
564 if (int_st & INT_A_OUT)
565 fsi_data_push(&master->fsia);
566 if (int_st & INT_B_OUT)
567 fsi_data_push(&master->fsib);
568 if (int_st & INT_A_IN)
569 fsi_data_pop(&master->fsia);
570 if (int_st & INT_B_IN)
571 fsi_data_pop(&master->fsib);
573 fsi_master_write(master, INT_ST, 0x0000000);
578 /************************************************************************
584 ************************************************************************/
585 static int fsi_dai_startup(struct snd_pcm_substream *substream,
586 struct snd_soc_dai *dai)
588 struct fsi_priv *fsi = fsi_get_priv(substream);
590 u32 flags = fsi_get_info_flags(fsi);
594 int is_play = (substream->stream == SNDRV_PCM_STREAM_PLAYBACK);
598 pm_runtime_get_sync(dai->dev);
601 data = is_play ? (1 << 0) : (1 << 4);
602 is_master = fsi_is_master_mode(fsi, is_play);
604 fsi_reg_mask_set(fsi, CKG1, data, data);
606 fsi_reg_mask_set(fsi, CKG1, data, 0);
608 /* clock inversion (CKG2) */
610 switch (SH_FSI_INVERSION_MASK & flags) {
624 fsi_reg_write(fsi, CKG2, data);
628 reg = is_play ? DO_FMT : DI_FMT;
629 fmt = is_play ? SH_FSI_GET_OFMT(flags) : SH_FSI_GET_IFMT(flags);
631 case SH_FSI_FMT_MONO:
633 data = CR_FMT(CR_MONO);
636 case SH_FSI_FMT_MONO_DELAY:
638 data = CR_FMT(CR_MONO_D);
643 data = CR_FMT(CR_PCM);
648 data = CR_FMT(CR_I2S);
653 data = CR_FMT(CR_TDM) | (fsi->chan - 1);
654 fsi->chan = is_play ?
655 SH_FSI_GET_CH_O(flags) : SH_FSI_GET_CH_I(flags);
657 case SH_FSI_FMT_TDM_DELAY:
659 data = CR_FMT(CR_TDM_D) | (fsi->chan - 1);
660 fsi->chan = is_play ?
661 SH_FSI_GET_CH_O(flags) : SH_FSI_GET_CH_I(flags);
664 dev_err(dai->dev, "unknown format.\n");
686 dev_err(dai->dev, "channel size error.\n");
690 fsi_reg_write(fsi, reg, data);
693 * clear clk reset if master mode
696 fsi_clk_ctrl(fsi, 1);
699 fsi_irq_init(fsi, is_play);
704 static void fsi_dai_shutdown(struct snd_pcm_substream *substream,
705 struct snd_soc_dai *dai)
707 struct fsi_priv *fsi = fsi_get_priv(substream);
708 int is_play = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
710 fsi_irq_disable(fsi, is_play);
711 fsi_clk_ctrl(fsi, 0);
713 pm_runtime_put_sync(dai->dev);
716 static int fsi_dai_trigger(struct snd_pcm_substream *substream, int cmd,
717 struct snd_soc_dai *dai)
719 struct fsi_priv *fsi = fsi_get_priv(substream);
720 struct snd_pcm_runtime *runtime = substream->runtime;
721 int is_play = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
725 case SNDRV_PCM_TRIGGER_START:
726 fsi_stream_push(fsi, substream,
727 frames_to_bytes(runtime, runtime->buffer_size),
728 frames_to_bytes(runtime, runtime->period_size));
729 ret = is_play ? fsi_data_push(fsi) : fsi_data_pop(fsi);
731 case SNDRV_PCM_TRIGGER_STOP:
732 fsi_irq_disable(fsi, is_play);
740 static struct snd_soc_dai_ops fsi_dai_ops = {
741 .startup = fsi_dai_startup,
742 .shutdown = fsi_dai_shutdown,
743 .trigger = fsi_dai_trigger,
746 /************************************************************************
752 ************************************************************************/
753 static struct snd_pcm_hardware fsi_pcm_hardware = {
754 .info = SNDRV_PCM_INFO_INTERLEAVED |
755 SNDRV_PCM_INFO_MMAP |
756 SNDRV_PCM_INFO_MMAP_VALID |
757 SNDRV_PCM_INFO_PAUSE,
764 .buffer_bytes_max = 64 * 1024,
765 .period_bytes_min = 32,
766 .period_bytes_max = 8192,
772 static int fsi_pcm_open(struct snd_pcm_substream *substream)
774 struct snd_pcm_runtime *runtime = substream->runtime;
777 snd_soc_set_runtime_hwparams(substream, &fsi_pcm_hardware);
779 ret = snd_pcm_hw_constraint_integer(runtime,
780 SNDRV_PCM_HW_PARAM_PERIODS);
785 static int fsi_hw_params(struct snd_pcm_substream *substream,
786 struct snd_pcm_hw_params *hw_params)
788 return snd_pcm_lib_malloc_pages(substream,
789 params_buffer_bytes(hw_params));
792 static int fsi_hw_free(struct snd_pcm_substream *substream)
794 return snd_pcm_lib_free_pages(substream);
797 static snd_pcm_uframes_t fsi_pointer(struct snd_pcm_substream *substream)
799 struct snd_pcm_runtime *runtime = substream->runtime;
800 struct fsi_priv *fsi = fsi_get_priv(substream);
803 location = (fsi->byte_offset - 1);
807 return bytes_to_frames(runtime, location);
810 static struct snd_pcm_ops fsi_pcm_ops = {
811 .open = fsi_pcm_open,
812 .ioctl = snd_pcm_lib_ioctl,
813 .hw_params = fsi_hw_params,
814 .hw_free = fsi_hw_free,
815 .pointer = fsi_pointer,
818 /************************************************************************
824 ************************************************************************/
825 #define PREALLOC_BUFFER (32 * 1024)
826 #define PREALLOC_BUFFER_MAX (32 * 1024)
828 static void fsi_pcm_free(struct snd_pcm *pcm)
830 snd_pcm_lib_preallocate_free_for_all(pcm);
833 static int fsi_pcm_new(struct snd_card *card,
834 struct snd_soc_dai *dai,
838 * dont use SNDRV_DMA_TYPE_DEV, since it will oops the SH kernel
839 * in MMAP mode (i.e. aplay -M)
841 return snd_pcm_lib_preallocate_pages_for_all(
843 SNDRV_DMA_TYPE_CONTINUOUS,
844 snd_dma_continuous_data(GFP_KERNEL),
845 PREALLOC_BUFFER, PREALLOC_BUFFER_MAX);
848 /************************************************************************
854 ************************************************************************/
855 struct snd_soc_dai fsi_soc_dai[] = {
891 EXPORT_SYMBOL_GPL(fsi_soc_dai);
893 struct snd_soc_platform fsi_soc_platform = {
895 .pcm_ops = &fsi_pcm_ops,
896 .pcm_new = fsi_pcm_new,
897 .pcm_free = fsi_pcm_free,
899 EXPORT_SYMBOL_GPL(fsi_soc_platform);
901 /************************************************************************
907 ************************************************************************/
908 static int fsi_probe(struct platform_device *pdev)
910 struct fsi_master *master;
911 struct resource *res;
916 dev_err(&pdev->dev, "current fsi support id 0 only now\n");
920 res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
921 irq = platform_get_irq(pdev, 0);
922 if (!res || (int)irq <= 0) {
923 dev_err(&pdev->dev, "Not enough FSI platform resources.\n");
928 master = kzalloc(sizeof(*master), GFP_KERNEL);
930 dev_err(&pdev->dev, "Could not allocate master\n");
935 master->base = ioremap_nocache(res->start, resource_size(res));
938 dev_err(&pdev->dev, "Unable to ioremap FSI registers.\n");
943 master->info = pdev->dev.platform_data;
944 master->fsia.base = master->base;
945 master->fsia.master = master;
946 master->fsib.base = master->base + 0x40;
947 master->fsib.master = master;
948 spin_lock_init(&master->lock);
950 pm_runtime_enable(&pdev->dev);
951 pm_runtime_resume(&pdev->dev);
953 fsi_soc_dai[0].dev = &pdev->dev;
954 fsi_soc_dai[0].private_data = &master->fsia;
955 fsi_soc_dai[1].dev = &pdev->dev;
956 fsi_soc_dai[1].private_data = &master->fsib;
958 fsi_soft_all_reset(master);
960 ret = request_irq(irq, &fsi_interrupt, IRQF_DISABLED, "fsi", master);
962 dev_err(&pdev->dev, "irq request err\n");
966 ret = snd_soc_register_platform(&fsi_soc_platform);
968 dev_err(&pdev->dev, "cannot snd soc register\n");
972 return snd_soc_register_dais(fsi_soc_dai, ARRAY_SIZE(fsi_soc_dai));
975 free_irq(irq, master);
977 iounmap(master->base);
978 pm_runtime_disable(&pdev->dev);
986 static int fsi_remove(struct platform_device *pdev)
988 struct fsi_master *master;
990 master = fsi_get_master(fsi_soc_dai[0].private_data);
992 snd_soc_unregister_dais(fsi_soc_dai, ARRAY_SIZE(fsi_soc_dai));
993 snd_soc_unregister_platform(&fsi_soc_platform);
995 pm_runtime_disable(&pdev->dev);
997 free_irq(master->irq, master);
999 iounmap(master->base);
1002 fsi_soc_dai[0].dev = NULL;
1003 fsi_soc_dai[0].private_data = NULL;
1004 fsi_soc_dai[1].dev = NULL;
1005 fsi_soc_dai[1].private_data = NULL;
1010 static int fsi_runtime_nop(struct device *dev)
1012 /* Runtime PM callback shared between ->runtime_suspend()
1013 * and ->runtime_resume(). Simply returns success.
1015 * This driver re-initializes all registers after
1016 * pm_runtime_get_sync() anyway so there is no need
1017 * to save and restore registers here.
1022 static struct dev_pm_ops fsi_pm_ops = {
1023 .runtime_suspend = fsi_runtime_nop,
1024 .runtime_resume = fsi_runtime_nop,
1027 static struct platform_driver fsi_driver = {
1033 .remove = fsi_remove,
1036 static int __init fsi_mobile_init(void)
1038 return platform_driver_register(&fsi_driver);
1041 static void __exit fsi_mobile_exit(void)
1043 platform_driver_unregister(&fsi_driver);
1045 module_init(fsi_mobile_init);
1046 module_exit(fsi_mobile_exit);
1048 MODULE_LICENSE("GPL");
1049 MODULE_DESCRIPTION("SuperH onchip FSI audio driver");
1050 MODULE_AUTHOR("Kuninori Morimoto <morimoto.kuninori@renesas.com>");