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
72 #define B_CLK 0x00000010
73 #define A_CLK 0x00000001
76 #define INT_B_IN (1 << 12)
77 #define INT_B_OUT (1 << 8)
78 #define INT_A_IN (1 << 4)
79 #define INT_A_OUT (1 << 0)
81 #define FSI_RATES SNDRV_PCM_RATE_8000_96000
83 #define FSI_FMTS (SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S16_LE)
85 /************************************************************************
91 ************************************************************************/
94 struct snd_pcm_substream
*substream
;
108 struct fsi_priv fsia
;
109 struct fsi_priv fsib
;
110 struct sh_fsi_platform_info
*info
;
113 static struct fsi_master
*master
;
115 /************************************************************************
118 basic read write function
121 ************************************************************************/
122 static int __fsi_reg_write(u32 reg
, u32 data
)
124 /* valid data area is 24bit */
127 return ctrl_outl(data
, reg
);
130 static u32
__fsi_reg_read(u32 reg
)
132 return ctrl_inl(reg
);
135 static int __fsi_reg_mask_set(u32 reg
, u32 mask
, u32 data
)
137 u32 val
= __fsi_reg_read(reg
);
142 return __fsi_reg_write(reg
, val
);
145 static int fsi_reg_write(struct fsi_priv
*fsi
, u32 reg
, u32 data
)
150 return __fsi_reg_write((u32
)(fsi
->base
+ reg
), data
);
153 static u32
fsi_reg_read(struct fsi_priv
*fsi
, u32 reg
)
158 return __fsi_reg_read((u32
)(fsi
->base
+ reg
));
161 static int fsi_reg_mask_set(struct fsi_priv
*fsi
, u32 reg
, u32 mask
, u32 data
)
166 return __fsi_reg_mask_set((u32
)(fsi
->base
+ reg
), mask
, data
);
169 static int fsi_master_write(u32 reg
, u32 data
)
171 if ((reg
< MREG_START
) ||
175 return __fsi_reg_write((u32
)(master
->base
+ reg
), data
);
178 static u32
fsi_master_read(u32 reg
)
180 if ((reg
< MREG_START
) ||
184 return __fsi_reg_read((u32
)(master
->base
+ reg
));
187 static int fsi_master_mask_set(u32 reg
, u32 mask
, u32 data
)
189 if ((reg
< MREG_START
) ||
193 return __fsi_reg_mask_set((u32
)(master
->base
+ reg
), mask
, data
);
196 /************************************************************************
202 ************************************************************************/
203 static struct fsi_priv
*fsi_get(struct snd_pcm_substream
*substream
)
205 struct snd_soc_pcm_runtime
*rtd
;
206 struct fsi_priv
*fsi
= NULL
;
208 if (!substream
|| !master
)
211 rtd
= substream
->private_data
;
212 switch (rtd
->dai
->cpu_dai
->id
) {
224 static int fsi_is_port_a(struct fsi_priv
*fsi
)
231 if (fsi
== &master
->fsia
)
237 static u32
fsi_get_info_flags(struct fsi_priv
*fsi
)
239 int is_porta
= fsi_is_port_a(fsi
);
241 return is_porta
? master
->info
->porta_flags
:
242 master
->info
->portb_flags
;
245 static int fsi_is_master_mode(struct fsi_priv
*fsi
, int is_play
)
248 u32 flags
= fsi_get_info_flags(fsi
);
250 mode
= is_play
? SH_FSI_OUT_SLAVE_MODE
: SH_FSI_IN_SLAVE_MODE
;
257 return (mode
& flags
) != mode
;
260 static u32
fsi_port_ab_io_bit(struct fsi_priv
*fsi
, int is_play
)
262 int is_porta
= fsi_is_port_a(fsi
);
266 data
= is_play
? (1 << 0) : (1 << 4);
268 data
= is_play
? (1 << 8) : (1 << 12);
273 static void fsi_stream_push(struct fsi_priv
*fsi
,
274 struct snd_pcm_substream
*substream
,
278 fsi
->substream
= substream
;
279 fsi
->buffer_len
= buffer_len
;
280 fsi
->period_len
= period_len
;
281 fsi
->byte_offset
= 0;
285 static void fsi_stream_pop(struct fsi_priv
*fsi
)
287 fsi
->substream
= NULL
;
290 fsi
->byte_offset
= 0;
294 static int fsi_get_fifo_residue(struct fsi_priv
*fsi
, int is_play
)
297 u32 reg
= is_play
? DOFF_ST
: DIFF_ST
;
300 status
= fsi_reg_read(fsi
, reg
);
301 residue
= 0x1ff & (status
>> 8);
302 residue
*= fsi
->chan
;
307 /************************************************************************
313 ************************************************************************/
314 static void fsi_irq_enable(struct fsi_priv
*fsi
, int is_play
)
316 u32 data
= fsi_port_ab_io_bit(fsi
, is_play
);
318 fsi_master_mask_set(IMSK
, data
, data
);
319 fsi_master_mask_set(IEMSK
, data
, data
);
322 static void fsi_irq_disable(struct fsi_priv
*fsi
, int is_play
)
324 u32 data
= fsi_port_ab_io_bit(fsi
, is_play
);
326 fsi_master_mask_set(IMSK
, data
, 0);
327 fsi_master_mask_set(IEMSK
, data
, 0);
330 static void fsi_clk_ctrl(struct fsi_priv
*fsi
, int enable
)
332 u32 val
= fsi_is_port_a(fsi
) ? (1 << 0) : (1 << 4);
335 fsi_master_mask_set(CLK_RST
, val
, val
);
337 fsi_master_mask_set(CLK_RST
, val
, 0);
340 static void fsi_irq_init(struct fsi_priv
*fsi
, int is_play
)
345 data
= fsi_port_ab_io_bit(fsi
, is_play
);
346 ctrl
= is_play
? DOFF_CTL
: DIFF_CTL
;
349 fsi_irq_disable(fsi
, is_play
);
351 /* set interrupt generation factor */
352 fsi_reg_write(fsi
, ctrl
, IRQ_HALF
);
355 fsi_reg_mask_set(fsi
, ctrl
, FIFO_CLR
, FIFO_CLR
);
357 /* clear interrupt factor */
358 fsi_master_mask_set(INT_ST
, data
, 0);
361 static void fsi_soft_all_reset(void)
363 u32 status
= fsi_master_read(SOFT_RST
);
366 status
&= 0x000000ff;
367 fsi_master_write(SOFT_RST
, status
);
371 status
&= 0x000000f0;
372 fsi_master_write(SOFT_RST
, status
);
373 status
|= 0x00000001;
374 fsi_master_write(SOFT_RST
, status
);
378 /* playback interrupt */
379 static int fsi_data_push(struct fsi_priv
*fsi
)
381 struct snd_pcm_runtime
*runtime
;
382 struct snd_pcm_substream
*substream
= NULL
;
391 !fsi
->substream
->runtime
)
394 runtime
= fsi
->substream
->runtime
;
396 /* FSI FIFO has limit.
397 * So, this driver can not send periods data at a time
399 if (fsi
->byte_offset
>=
400 fsi
->period_len
* (fsi
->periods
+ 1)) {
402 substream
= fsi
->substream
;
403 fsi
->periods
= (fsi
->periods
+ 1) % runtime
->periods
;
405 if (0 == fsi
->periods
)
406 fsi
->byte_offset
= 0;
409 /* get 1 channel data width */
410 width
= frames_to_bytes(runtime
, 1) / fsi
->chan
;
412 /* get send size for alsa */
413 send
= (fsi
->buffer_len
- fsi
->byte_offset
) / width
;
415 /* get FIFO free size */
416 fifo_free
= (fsi
->fifo_max
* fsi
->chan
) - fsi_get_fifo_residue(fsi
, 1);
419 if (fifo_free
< send
)
422 start
= runtime
->dma_area
;
423 start
+= fsi
->byte_offset
;
427 for (i
= 0; i
< send
; i
++)
428 fsi_reg_write(fsi
, DODT
,
429 ((u32
)*((u16
*)start
+ i
) << 8));
432 for (i
= 0; i
< send
; i
++)
433 fsi_reg_write(fsi
, DODT
, *((u32
*)start
+ i
));
439 fsi
->byte_offset
+= send
* width
;
441 fsi_irq_enable(fsi
, 1);
444 snd_pcm_period_elapsed(substream
);
449 static int fsi_data_pop(struct fsi_priv
*fsi
)
451 struct snd_pcm_runtime
*runtime
;
452 struct snd_pcm_substream
*substream
= NULL
;
461 !fsi
->substream
->runtime
)
464 runtime
= fsi
->substream
->runtime
;
466 /* FSI FIFO has limit.
467 * So, this driver can not send periods data at a time
469 if (fsi
->byte_offset
>=
470 fsi
->period_len
* (fsi
->periods
+ 1)) {
472 substream
= fsi
->substream
;
473 fsi
->periods
= (fsi
->periods
+ 1) % runtime
->periods
;
475 if (0 == fsi
->periods
)
476 fsi
->byte_offset
= 0;
479 /* get 1 channel data width */
480 width
= frames_to_bytes(runtime
, 1) / fsi
->chan
;
482 /* get free space for alsa */
483 free
= (fsi
->buffer_len
- fsi
->byte_offset
) / width
;
486 fifo_fill
= fsi_get_fifo_residue(fsi
, 0);
488 if (free
< fifo_fill
)
491 start
= runtime
->dma_area
;
492 start
+= fsi
->byte_offset
;
496 for (i
= 0; i
< fifo_fill
; i
++)
497 *((u16
*)start
+ i
) =
498 (u16
)(fsi_reg_read(fsi
, DIDT
) >> 8);
501 for (i
= 0; i
< fifo_fill
; i
++)
502 *((u32
*)start
+ i
) = fsi_reg_read(fsi
, DIDT
);
508 fsi
->byte_offset
+= fifo_fill
* width
;
510 fsi_irq_enable(fsi
, 0);
513 snd_pcm_period_elapsed(substream
);
518 static irqreturn_t
fsi_interrupt(int irq
, void *data
)
520 u32 status
= fsi_master_read(SOFT_RST
) & ~0x00000010;
521 u32 int_st
= fsi_master_read(INT_ST
);
523 /* clear irq status */
524 fsi_master_write(SOFT_RST
, status
);
525 fsi_master_write(SOFT_RST
, status
| 0x00000010);
527 if (int_st
& INT_A_OUT
)
528 fsi_data_push(&master
->fsia
);
529 if (int_st
& INT_B_OUT
)
530 fsi_data_push(&master
->fsib
);
531 if (int_st
& INT_A_IN
)
532 fsi_data_pop(&master
->fsia
);
533 if (int_st
& INT_B_IN
)
534 fsi_data_pop(&master
->fsib
);
536 fsi_master_write(INT_ST
, 0x0000000);
541 /************************************************************************
547 ************************************************************************/
548 static int fsi_dai_startup(struct snd_pcm_substream
*substream
,
549 struct snd_soc_dai
*dai
)
551 struct fsi_priv
*fsi
= fsi_get(substream
);
553 u32 flags
= fsi_get_info_flags(fsi
);
557 int is_play
= (substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
);
561 pm_runtime_get_sync(dai
->dev
);
564 data
= is_play
? (1 << 0) : (1 << 4);
565 is_master
= fsi_is_master_mode(fsi
, is_play
);
567 fsi_reg_mask_set(fsi
, CKG1
, data
, data
);
569 fsi_reg_mask_set(fsi
, CKG1
, data
, 0);
571 /* clock inversion (CKG2) */
573 switch (SH_FSI_INVERSION_MASK
& flags
) {
587 fsi_reg_write(fsi
, CKG2
, data
);
591 reg
= is_play
? DO_FMT
: DI_FMT
;
592 fmt
= is_play
? SH_FSI_GET_OFMT(flags
) : SH_FSI_GET_IFMT(flags
);
594 case SH_FSI_FMT_MONO
:
596 data
= CR_FMT(CR_MONO
);
599 case SH_FSI_FMT_MONO_DELAY
:
601 data
= CR_FMT(CR_MONO_D
);
606 data
= CR_FMT(CR_PCM
);
611 data
= CR_FMT(CR_I2S
);
616 data
= CR_FMT(CR_TDM
) | (fsi
->chan
- 1);
617 fsi
->chan
= is_play
?
618 SH_FSI_GET_CH_O(flags
) : SH_FSI_GET_CH_I(flags
);
620 case SH_FSI_FMT_TDM_DELAY
:
622 data
= CR_FMT(CR_TDM_D
) | (fsi
->chan
- 1);
623 fsi
->chan
= is_play
?
624 SH_FSI_GET_CH_O(flags
) : SH_FSI_GET_CH_I(flags
);
627 dev_err(dai
->dev
, "unknown format.\n");
649 dev_err(dai
->dev
, "channel size error.\n");
653 fsi_reg_write(fsi
, reg
, data
);
656 * clear clk reset if master mode
659 fsi_clk_ctrl(fsi
, 1);
662 fsi_irq_init(fsi
, is_play
);
667 static void fsi_dai_shutdown(struct snd_pcm_substream
*substream
,
668 struct snd_soc_dai
*dai
)
670 struct fsi_priv
*fsi
= fsi_get(substream
);
671 int is_play
= substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
;
673 fsi_irq_disable(fsi
, is_play
);
674 fsi_clk_ctrl(fsi
, 0);
676 pm_runtime_put_sync(dai
->dev
);
679 static int fsi_dai_trigger(struct snd_pcm_substream
*substream
, int cmd
,
680 struct snd_soc_dai
*dai
)
682 struct fsi_priv
*fsi
= fsi_get(substream
);
683 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
684 int is_play
= substream
->stream
== SNDRV_PCM_STREAM_PLAYBACK
;
688 case SNDRV_PCM_TRIGGER_START
:
689 fsi_stream_push(fsi
, substream
,
690 frames_to_bytes(runtime
, runtime
->buffer_size
),
691 frames_to_bytes(runtime
, runtime
->period_size
));
692 ret
= is_play
? fsi_data_push(fsi
) : fsi_data_pop(fsi
);
694 case SNDRV_PCM_TRIGGER_STOP
:
695 fsi_irq_disable(fsi
, is_play
);
703 static struct snd_soc_dai_ops fsi_dai_ops
= {
704 .startup
= fsi_dai_startup
,
705 .shutdown
= fsi_dai_shutdown
,
706 .trigger
= fsi_dai_trigger
,
709 /************************************************************************
715 ************************************************************************/
716 static struct snd_pcm_hardware fsi_pcm_hardware
= {
717 .info
= SNDRV_PCM_INFO_INTERLEAVED
|
718 SNDRV_PCM_INFO_MMAP
|
719 SNDRV_PCM_INFO_MMAP_VALID
|
720 SNDRV_PCM_INFO_PAUSE
,
727 .buffer_bytes_max
= 64 * 1024,
728 .period_bytes_min
= 32,
729 .period_bytes_max
= 8192,
735 static int fsi_pcm_open(struct snd_pcm_substream
*substream
)
737 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
740 snd_soc_set_runtime_hwparams(substream
, &fsi_pcm_hardware
);
742 ret
= snd_pcm_hw_constraint_integer(runtime
,
743 SNDRV_PCM_HW_PARAM_PERIODS
);
748 static int fsi_hw_params(struct snd_pcm_substream
*substream
,
749 struct snd_pcm_hw_params
*hw_params
)
751 return snd_pcm_lib_malloc_pages(substream
,
752 params_buffer_bytes(hw_params
));
755 static int fsi_hw_free(struct snd_pcm_substream
*substream
)
757 return snd_pcm_lib_free_pages(substream
);
760 static snd_pcm_uframes_t
fsi_pointer(struct snd_pcm_substream
*substream
)
762 struct snd_pcm_runtime
*runtime
= substream
->runtime
;
763 struct fsi_priv
*fsi
= fsi_get(substream
);
766 location
= (fsi
->byte_offset
- 1);
770 return bytes_to_frames(runtime
, location
);
773 static struct snd_pcm_ops fsi_pcm_ops
= {
774 .open
= fsi_pcm_open
,
775 .ioctl
= snd_pcm_lib_ioctl
,
776 .hw_params
= fsi_hw_params
,
777 .hw_free
= fsi_hw_free
,
778 .pointer
= fsi_pointer
,
781 /************************************************************************
787 ************************************************************************/
788 #define PREALLOC_BUFFER (32 * 1024)
789 #define PREALLOC_BUFFER_MAX (32 * 1024)
791 static void fsi_pcm_free(struct snd_pcm
*pcm
)
793 snd_pcm_lib_preallocate_free_for_all(pcm
);
796 static int fsi_pcm_new(struct snd_card
*card
,
797 struct snd_soc_dai
*dai
,
801 * dont use SNDRV_DMA_TYPE_DEV, since it will oops the SH kernel
802 * in MMAP mode (i.e. aplay -M)
804 return snd_pcm_lib_preallocate_pages_for_all(
806 SNDRV_DMA_TYPE_CONTINUOUS
,
807 snd_dma_continuous_data(GFP_KERNEL
),
808 PREALLOC_BUFFER
, PREALLOC_BUFFER_MAX
);
811 /************************************************************************
817 ************************************************************************/
818 struct snd_soc_dai fsi_soc_dai
[] = {
854 EXPORT_SYMBOL_GPL(fsi_soc_dai
);
856 struct snd_soc_platform fsi_soc_platform
= {
858 .pcm_ops
= &fsi_pcm_ops
,
859 .pcm_new
= fsi_pcm_new
,
860 .pcm_free
= fsi_pcm_free
,
862 EXPORT_SYMBOL_GPL(fsi_soc_platform
);
864 /************************************************************************
870 ************************************************************************/
871 static int fsi_probe(struct platform_device
*pdev
)
873 struct resource
*res
;
877 res
= platform_get_resource(pdev
, IORESOURCE_MEM
, 0);
878 irq
= platform_get_irq(pdev
, 0);
879 if (!res
|| (int)irq
<= 0) {
880 dev_err(&pdev
->dev
, "Not enough FSI platform resources.\n");
885 master
= kzalloc(sizeof(*master
), GFP_KERNEL
);
887 dev_err(&pdev
->dev
, "Could not allocate master\n");
892 master
->base
= ioremap_nocache(res
->start
, resource_size(res
));
895 dev_err(&pdev
->dev
, "Unable to ioremap FSI registers.\n");
900 master
->info
= pdev
->dev
.platform_data
;
901 master
->fsia
.base
= master
->base
;
902 master
->fsib
.base
= master
->base
+ 0x40;
904 pm_runtime_enable(&pdev
->dev
);
905 pm_runtime_resume(&pdev
->dev
);
907 fsi_soc_dai
[0].dev
= &pdev
->dev
;
908 fsi_soc_dai
[1].dev
= &pdev
->dev
;
910 fsi_soft_all_reset();
912 ret
= request_irq(irq
, &fsi_interrupt
, IRQF_DISABLED
, "fsi", master
);
914 dev_err(&pdev
->dev
, "irq request err\n");
918 ret
= snd_soc_register_platform(&fsi_soc_platform
);
920 dev_err(&pdev
->dev
, "cannot snd soc register\n");
924 return snd_soc_register_dais(fsi_soc_dai
, ARRAY_SIZE(fsi_soc_dai
));
927 free_irq(irq
, master
);
929 iounmap(master
->base
);
930 pm_runtime_disable(&pdev
->dev
);
938 static int fsi_remove(struct platform_device
*pdev
)
940 snd_soc_unregister_dais(fsi_soc_dai
, ARRAY_SIZE(fsi_soc_dai
));
941 snd_soc_unregister_platform(&fsi_soc_platform
);
943 pm_runtime_disable(&pdev
->dev
);
945 free_irq(master
->irq
, master
);
947 iounmap(master
->base
);
953 static int fsi_runtime_nop(struct device
*dev
)
955 /* Runtime PM callback shared between ->runtime_suspend()
956 * and ->runtime_resume(). Simply returns success.
958 * This driver re-initializes all registers after
959 * pm_runtime_get_sync() anyway so there is no need
960 * to save and restore registers here.
965 static struct dev_pm_ops fsi_pm_ops
= {
966 .runtime_suspend
= fsi_runtime_nop
,
967 .runtime_resume
= fsi_runtime_nop
,
970 static struct platform_driver fsi_driver
= {
976 .remove
= fsi_remove
,
979 static int __init
fsi_mobile_init(void)
981 return platform_driver_register(&fsi_driver
);
984 static void __exit
fsi_mobile_exit(void)
986 platform_driver_unregister(&fsi_driver
);
988 module_init(fsi_mobile_init
);
989 module_exit(fsi_mobile_exit
);
991 MODULE_LICENSE("GPL");
992 MODULE_DESCRIPTION("SuperH onchip FSI audio driver");
993 MODULE_AUTHOR("Kuninori Morimoto <morimoto.kuninori@renesas.com>");