cachepc-linux

Fork of AMDESE/linux with modifications for CachePC side-channel attack
git clone https://git.sinitax.com/sinitax/cachepc-linux
Log | Files | Refs | README | LICENSE | sfeed.txt

rsnd.h (26171B)


      1// SPDX-License-Identifier: GPL-2.0
      2//
      3// Renesas R-Car
      4//
      5// Copyright (C) 2013 Renesas Solutions Corp.
      6// Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
      7
      8#ifndef RSND_H
      9#define RSND_H
     10
     11#include <linux/clk.h>
     12#include <linux/device.h>
     13#include <linux/dma-mapping.h>
     14#include <linux/io.h>
     15#include <linux/list.h>
     16#include <linux/module.h>
     17#include <linux/of_device.h>
     18#include <linux/of_graph.h>
     19#include <linux/of_irq.h>
     20#include <linux/sh_dma.h>
     21#include <linux/workqueue.h>
     22#include <sound/soc.h>
     23#include <sound/pcm_params.h>
     24
     25#define RSND_GEN1_SRU	0
     26#define RSND_GEN1_ADG	1
     27#define RSND_GEN1_SSI	2
     28
     29#define RSND_GEN2_SCU	0
     30#define RSND_GEN2_ADG	1
     31#define RSND_GEN2_SSIU	2
     32#define RSND_GEN2_SSI	3
     33
     34#define RSND_BASE_MAX	4
     35
     36/*
     37 *	pseudo register
     38 *
     39 * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
     40 * This driver uses pseudo register in order to hide it.
     41 * see gen1/gen2 for detail
     42 */
     43enum rsnd_reg {
     44	/* SCU (MIX/CTU/DVC) */
     45	SRC_I_BUSIF_MODE,
     46	SRC_O_BUSIF_MODE,
     47	SRC_ROUTE_MODE0,
     48	SRC_SWRSR,
     49	SRC_SRCIR,
     50	SRC_ADINR,
     51	SRC_IFSCR,
     52	SRC_IFSVR,
     53	SRC_SRCCR,
     54	SRC_CTRL,
     55	SRC_BSDSR,
     56	SRC_BSISR,
     57	SRC_INT_ENABLE0,
     58	SRC_BUSIF_DALIGN,
     59	SRCIN_TIMSEL0,
     60	SRCIN_TIMSEL1,
     61	SRCIN_TIMSEL2,
     62	SRCIN_TIMSEL3,
     63	SRCIN_TIMSEL4,
     64	SRCOUT_TIMSEL0,
     65	SRCOUT_TIMSEL1,
     66	SRCOUT_TIMSEL2,
     67	SRCOUT_TIMSEL3,
     68	SRCOUT_TIMSEL4,
     69	SCU_SYS_STATUS0,
     70	SCU_SYS_STATUS1,
     71	SCU_SYS_INT_EN0,
     72	SCU_SYS_INT_EN1,
     73	CMD_CTRL,
     74	CMD_BUSIF_MODE,
     75	CMD_BUSIF_DALIGN,
     76	CMD_ROUTE_SLCT,
     77	CMDOUT_TIMSEL,
     78	CTU_SWRSR,
     79	CTU_CTUIR,
     80	CTU_ADINR,
     81	CTU_CPMDR,
     82	CTU_SCMDR,
     83	CTU_SV00R,
     84	CTU_SV01R,
     85	CTU_SV02R,
     86	CTU_SV03R,
     87	CTU_SV04R,
     88	CTU_SV05R,
     89	CTU_SV06R,
     90	CTU_SV07R,
     91	CTU_SV10R,
     92	CTU_SV11R,
     93	CTU_SV12R,
     94	CTU_SV13R,
     95	CTU_SV14R,
     96	CTU_SV15R,
     97	CTU_SV16R,
     98	CTU_SV17R,
     99	CTU_SV20R,
    100	CTU_SV21R,
    101	CTU_SV22R,
    102	CTU_SV23R,
    103	CTU_SV24R,
    104	CTU_SV25R,
    105	CTU_SV26R,
    106	CTU_SV27R,
    107	CTU_SV30R,
    108	CTU_SV31R,
    109	CTU_SV32R,
    110	CTU_SV33R,
    111	CTU_SV34R,
    112	CTU_SV35R,
    113	CTU_SV36R,
    114	CTU_SV37R,
    115	MIX_SWRSR,
    116	MIX_MIXIR,
    117	MIX_ADINR,
    118	MIX_MIXMR,
    119	MIX_MVPDR,
    120	MIX_MDBAR,
    121	MIX_MDBBR,
    122	MIX_MDBCR,
    123	MIX_MDBDR,
    124	MIX_MDBER,
    125	DVC_SWRSR,
    126	DVC_DVUIR,
    127	DVC_ADINR,
    128	DVC_DVUCR,
    129	DVC_ZCMCR,
    130	DVC_VOL0R,
    131	DVC_VOL1R,
    132	DVC_VOL2R,
    133	DVC_VOL3R,
    134	DVC_VOL4R,
    135	DVC_VOL5R,
    136	DVC_VOL6R,
    137	DVC_VOL7R,
    138	DVC_DVUER,
    139	DVC_VRCTR,
    140	DVC_VRPDR,
    141	DVC_VRDBR,
    142
    143	/* ADG */
    144	BRRA,
    145	BRRB,
    146	BRGCKR,
    147	DIV_EN,
    148	AUDIO_CLK_SEL0,
    149	AUDIO_CLK_SEL1,
    150	AUDIO_CLK_SEL2,
    151
    152	/* SSIU */
    153	SSI_MODE,
    154	SSI_MODE0,
    155	SSI_MODE1,
    156	SSI_MODE2,
    157	SSI_CONTROL,
    158	SSI_CTRL,
    159	SSI_BUSIF0_MODE,
    160	SSI_BUSIF1_MODE,
    161	SSI_BUSIF2_MODE,
    162	SSI_BUSIF3_MODE,
    163	SSI_BUSIF4_MODE,
    164	SSI_BUSIF5_MODE,
    165	SSI_BUSIF6_MODE,
    166	SSI_BUSIF7_MODE,
    167	SSI_BUSIF0_ADINR,
    168	SSI_BUSIF1_ADINR,
    169	SSI_BUSIF2_ADINR,
    170	SSI_BUSIF3_ADINR,
    171	SSI_BUSIF4_ADINR,
    172	SSI_BUSIF5_ADINR,
    173	SSI_BUSIF6_ADINR,
    174	SSI_BUSIF7_ADINR,
    175	SSI_BUSIF0_DALIGN,
    176	SSI_BUSIF1_DALIGN,
    177	SSI_BUSIF2_DALIGN,
    178	SSI_BUSIF3_DALIGN,
    179	SSI_BUSIF4_DALIGN,
    180	SSI_BUSIF5_DALIGN,
    181	SSI_BUSIF6_DALIGN,
    182	SSI_BUSIF7_DALIGN,
    183	SSI_INT_ENABLE,
    184	SSI_SYS_STATUS0,
    185	SSI_SYS_STATUS1,
    186	SSI_SYS_STATUS2,
    187	SSI_SYS_STATUS3,
    188	SSI_SYS_STATUS4,
    189	SSI_SYS_STATUS5,
    190	SSI_SYS_STATUS6,
    191	SSI_SYS_STATUS7,
    192	SSI_SYS_INT_ENABLE0,
    193	SSI_SYS_INT_ENABLE1,
    194	SSI_SYS_INT_ENABLE2,
    195	SSI_SYS_INT_ENABLE3,
    196	SSI_SYS_INT_ENABLE4,
    197	SSI_SYS_INT_ENABLE5,
    198	SSI_SYS_INT_ENABLE6,
    199	SSI_SYS_INT_ENABLE7,
    200	HDMI0_SEL,
    201	HDMI1_SEL,
    202	SSI9_BUSIF0_MODE,
    203	SSI9_BUSIF1_MODE,
    204	SSI9_BUSIF2_MODE,
    205	SSI9_BUSIF3_MODE,
    206	SSI9_BUSIF4_MODE,
    207	SSI9_BUSIF5_MODE,
    208	SSI9_BUSIF6_MODE,
    209	SSI9_BUSIF7_MODE,
    210	SSI9_BUSIF0_ADINR,
    211	SSI9_BUSIF1_ADINR,
    212	SSI9_BUSIF2_ADINR,
    213	SSI9_BUSIF3_ADINR,
    214	SSI9_BUSIF4_ADINR,
    215	SSI9_BUSIF5_ADINR,
    216	SSI9_BUSIF6_ADINR,
    217	SSI9_BUSIF7_ADINR,
    218	SSI9_BUSIF0_DALIGN,
    219	SSI9_BUSIF1_DALIGN,
    220	SSI9_BUSIF2_DALIGN,
    221	SSI9_BUSIF3_DALIGN,
    222	SSI9_BUSIF4_DALIGN,
    223	SSI9_BUSIF5_DALIGN,
    224	SSI9_BUSIF6_DALIGN,
    225	SSI9_BUSIF7_DALIGN,
    226
    227	/* SSI */
    228	SSICR,
    229	SSISR,
    230	SSITDR,
    231	SSIRDR,
    232	SSIWSR,
    233
    234	REG_MAX,
    235};
    236#define SRCIN_TIMSEL(i)		(SRCIN_TIMSEL0 + (i))
    237#define SRCOUT_TIMSEL(i)	(SRCOUT_TIMSEL0 + (i))
    238#define CTU_SVxxR(i, j)		(CTU_SV00R + (i * 8) + (j))
    239#define DVC_VOLxR(i)		(DVC_VOL0R + (i))
    240#define AUDIO_CLK_SEL(i)	(AUDIO_CLK_SEL0 + (i))
    241#define SSI_BUSIF_MODE(i)	(SSI_BUSIF0_MODE + (i))
    242#define SSI_BUSIF_ADINR(i)	(SSI_BUSIF0_ADINR + (i))
    243#define SSI_BUSIF_DALIGN(i)	(SSI_BUSIF0_DALIGN + (i))
    244#define SSI9_BUSIF_MODE(i)	(SSI9_BUSIF0_MODE + (i))
    245#define SSI9_BUSIF_ADINR(i)	(SSI9_BUSIF0_ADINR + (i))
    246#define SSI9_BUSIF_DALIGN(i)	(SSI9_BUSIF0_DALIGN + (i))
    247#define SSI_SYS_STATUS(i)	(SSI_SYS_STATUS0 + (i))
    248#define SSI_SYS_INT_ENABLE(i) (SSI_SYS_INT_ENABLE0 + (i))
    249
    250
    251struct rsnd_priv;
    252struct rsnd_mod;
    253struct rsnd_dai;
    254struct rsnd_dai_stream;
    255
    256/*
    257 *	R-Car basic functions
    258 */
    259u32 rsnd_mod_read(struct rsnd_mod *mod, enum rsnd_reg reg);
    260void rsnd_mod_write(struct rsnd_mod *mod, enum rsnd_reg reg, u32 data);
    261void rsnd_mod_bset(struct rsnd_mod *mod, enum rsnd_reg reg, u32 mask, u32 data);
    262u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
    263u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
    264u32 rsnd_get_busif_shift(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
    265
    266/*
    267 *	R-Car DMA
    268 */
    269int rsnd_dma_attach(struct rsnd_dai_stream *io,
    270		    struct rsnd_mod *mod, struct rsnd_mod **dma_mod);
    271int rsnd_dma_probe(struct rsnd_priv *priv);
    272struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node, char *name,
    273					  struct rsnd_mod *mod, char *x);
    274
    275/*
    276 *	R-Car sound mod
    277 */
    278enum rsnd_mod_type {
    279	RSND_MOD_AUDMAPP,
    280	RSND_MOD_AUDMA,
    281	RSND_MOD_DVC,
    282	RSND_MOD_MIX,
    283	RSND_MOD_CTU,
    284	RSND_MOD_CMD,
    285	RSND_MOD_SRC,
    286	RSND_MOD_SSIM3,		/* SSI multi 3 */
    287	RSND_MOD_SSIM2,		/* SSI multi 2 */
    288	RSND_MOD_SSIM1,		/* SSI multi 1 */
    289	RSND_MOD_SSIP,		/* SSI parent */
    290	RSND_MOD_SSI,
    291	RSND_MOD_SSIU,
    292	RSND_MOD_MAX,
    293};
    294
    295struct rsnd_mod_ops {
    296	char *name;
    297	struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
    298				    struct rsnd_mod *mod);
    299	int (*probe)(struct rsnd_mod *mod,
    300		     struct rsnd_dai_stream *io,
    301		     struct rsnd_priv *priv);
    302	int (*remove)(struct rsnd_mod *mod,
    303		      struct rsnd_dai_stream *io,
    304		      struct rsnd_priv *priv);
    305	int (*init)(struct rsnd_mod *mod,
    306		    struct rsnd_dai_stream *io,
    307		    struct rsnd_priv *priv);
    308	int (*quit)(struct rsnd_mod *mod,
    309		    struct rsnd_dai_stream *io,
    310		    struct rsnd_priv *priv);
    311	int (*start)(struct rsnd_mod *mod,
    312		     struct rsnd_dai_stream *io,
    313		     struct rsnd_priv *priv);
    314	int (*stop)(struct rsnd_mod *mod,
    315		    struct rsnd_dai_stream *io,
    316		    struct rsnd_priv *priv);
    317	int (*irq)(struct rsnd_mod *mod,
    318		   struct rsnd_dai_stream *io,
    319		   struct rsnd_priv *priv, int enable);
    320	int (*pcm_new)(struct rsnd_mod *mod,
    321		       struct rsnd_dai_stream *io,
    322		       struct snd_soc_pcm_runtime *rtd);
    323	int (*hw_params)(struct rsnd_mod *mod,
    324			 struct rsnd_dai_stream *io,
    325			 struct snd_pcm_substream *substream,
    326			 struct snd_pcm_hw_params *hw_params);
    327	int (*pointer)(struct rsnd_mod *mod,
    328		       struct rsnd_dai_stream *io,
    329		       snd_pcm_uframes_t *pointer);
    330	int (*fallback)(struct rsnd_mod *mod,
    331			struct rsnd_dai_stream *io,
    332			struct rsnd_priv *priv);
    333	int (*prepare)(struct rsnd_mod *mod,
    334		       struct rsnd_dai_stream *io,
    335		       struct rsnd_priv *priv);
    336	int (*cleanup)(struct rsnd_mod *mod,
    337		       struct rsnd_dai_stream *io,
    338		       struct rsnd_priv *priv);
    339	int (*hw_free)(struct rsnd_mod *mod,
    340		       struct rsnd_dai_stream *io,
    341		       struct snd_pcm_substream *substream);
    342	u32 *(*get_status)(struct rsnd_mod *mod,
    343			   struct rsnd_dai_stream *io,
    344			   enum rsnd_mod_type type);
    345	int (*id)(struct rsnd_mod *mod);
    346	int (*id_sub)(struct rsnd_mod *mod);
    347	int (*id_cmd)(struct rsnd_mod *mod);
    348
    349#ifdef CONFIG_DEBUG_FS
    350	void (*debug_info)(struct seq_file *m,
    351			   struct rsnd_dai_stream *io, struct rsnd_mod *mod);
    352#endif
    353};
    354
    355struct rsnd_dai_stream;
    356struct rsnd_mod {
    357	int id;
    358	enum rsnd_mod_type type;
    359	struct rsnd_mod_ops *ops;
    360	struct rsnd_priv *priv;
    361	struct clk *clk;
    362	u32 status;
    363};
    364/*
    365 * status
    366 *
    367 * 0xH000DCB0
    368 *
    369 * B	0: init		1: quit
    370 * C	0: start	1: stop
    371 * D	0: hw_params	1: hw_free
    372 *
    373 * H is always called (see __rsnd_mod_call)
    374 */
    375#define __rsnd_mod_shift_init		4
    376#define __rsnd_mod_shift_quit		4
    377#define __rsnd_mod_shift_start		8
    378#define __rsnd_mod_shift_stop		8
    379#define __rsnd_mod_shift_hw_params	12
    380#define __rsnd_mod_shift_hw_free	12
    381#define __rsnd_mod_shift_probe		28 /* always called */
    382#define __rsnd_mod_shift_remove		28 /* always called */
    383#define __rsnd_mod_shift_irq		28 /* always called */
    384#define __rsnd_mod_shift_pcm_new	28 /* always called */
    385#define __rsnd_mod_shift_fallback	28 /* always called */
    386#define __rsnd_mod_shift_pointer	28 /* always called */
    387#define __rsnd_mod_shift_prepare	28 /* always called */
    388#define __rsnd_mod_shift_cleanup	28 /* always called */
    389
    390#define __rsnd_mod_add_probe		0
    391#define __rsnd_mod_add_remove		0
    392#define __rsnd_mod_add_prepare		0
    393#define __rsnd_mod_add_cleanup		0
    394#define __rsnd_mod_add_init		 1 /* needs protect */
    395#define __rsnd_mod_add_quit		-1 /* needs protect */
    396#define __rsnd_mod_add_start		 1 /* needs protect */
    397#define __rsnd_mod_add_stop		-1 /* needs protect */
    398#define __rsnd_mod_add_hw_params	 1 /* needs protect */
    399#define __rsnd_mod_add_hw_free		-1 /* needs protect */
    400#define __rsnd_mod_add_irq		0
    401#define __rsnd_mod_add_pcm_new		0
    402#define __rsnd_mod_add_fallback		0
    403#define __rsnd_mod_add_pointer		0
    404
    405#define __rsnd_mod_call_probe		0
    406#define __rsnd_mod_call_remove		0
    407#define __rsnd_mod_call_prepare		0
    408#define __rsnd_mod_call_cleanup		0
    409#define __rsnd_mod_call_init		0 /* needs protect */
    410#define __rsnd_mod_call_quit		1 /* needs protect */
    411#define __rsnd_mod_call_start		0 /* needs protect */
    412#define __rsnd_mod_call_stop		1 /* needs protect */
    413#define __rsnd_mod_call_hw_params	0 /* needs protect */
    414#define __rsnd_mod_call_hw_free		1 /* needs protect */
    415#define __rsnd_mod_call_irq		0
    416#define __rsnd_mod_call_pcm_new		0
    417#define __rsnd_mod_call_fallback	0
    418#define __rsnd_mod_call_pointer		0
    419
    420#define rsnd_mod_to_priv(mod)	((mod)->priv)
    421#define rsnd_mod_power_on(mod)	clk_enable((mod)->clk)
    422#define rsnd_mod_power_off(mod)	clk_disable((mod)->clk)
    423#define rsnd_mod_get(ip)	(&(ip)->mod)
    424
    425int rsnd_mod_init(struct rsnd_priv *priv,
    426		  struct rsnd_mod *mod,
    427		  struct rsnd_mod_ops *ops,
    428		  struct clk *clk,
    429		  enum rsnd_mod_type type,
    430		  int id);
    431void rsnd_mod_quit(struct rsnd_mod *mod);
    432struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
    433				  struct rsnd_mod *mod);
    434void rsnd_mod_interrupt(struct rsnd_mod *mod,
    435			void (*callback)(struct rsnd_mod *mod,
    436					 struct rsnd_dai_stream *io));
    437u32 *rsnd_mod_get_status(struct rsnd_mod *mod,
    438			 struct rsnd_dai_stream *io,
    439			 enum rsnd_mod_type type);
    440int rsnd_mod_id(struct rsnd_mod *mod);
    441int rsnd_mod_id_raw(struct rsnd_mod *mod);
    442int rsnd_mod_id_sub(struct rsnd_mod *mod);
    443char *rsnd_mod_name(struct rsnd_mod *mod);
    444struct rsnd_mod *rsnd_mod_next(int *iterator,
    445			       struct rsnd_dai_stream *io,
    446			       enum rsnd_mod_type *array,
    447			       int array_size);
    448#define for_each_rsnd_mod(iterator, pos, io)				\
    449	for (iterator = 0;						\
    450	     (pos = rsnd_mod_next(&iterator, io, NULL, 0)); iterator++)
    451#define for_each_rsnd_mod_arrays(iterator, pos, io, array, size)	\
    452	for (iterator = 0;						\
    453	     (pos = rsnd_mod_next(&iterator, io, array, size)); iterator++)
    454#define for_each_rsnd_mod_array(iterator, pos, io, array)		\
    455	for_each_rsnd_mod_arrays(iterator, pos, io, array, ARRAY_SIZE(array))
    456
    457void rsnd_parse_connect_common(struct rsnd_dai *rdai, char *name,
    458		struct rsnd_mod* (*mod_get)(struct rsnd_priv *priv, int id),
    459		struct device_node *node,
    460		struct device_node *playback,
    461		struct device_node *capture);
    462int rsnd_node_count(struct rsnd_priv *priv, struct device_node *node, char *name);
    463int rsnd_node_fixed_index(struct device *dev, struct device_node *node, char *name, int idx);
    464
    465int rsnd_channel_normalization(int chan);
    466#define rsnd_runtime_channel_original(io) \
    467	rsnd_runtime_channel_original_with_params(io, NULL)
    468int rsnd_runtime_channel_original_with_params(struct rsnd_dai_stream *io,
    469				struct snd_pcm_hw_params *params);
    470#define rsnd_runtime_channel_after_ctu(io)			\
    471	rsnd_runtime_channel_after_ctu_with_params(io, NULL)
    472int rsnd_runtime_channel_after_ctu_with_params(struct rsnd_dai_stream *io,
    473				struct snd_pcm_hw_params *params);
    474#define rsnd_runtime_channel_for_ssi(io) \
    475	rsnd_runtime_channel_for_ssi_with_params(io, NULL)
    476int rsnd_runtime_channel_for_ssi_with_params(struct rsnd_dai_stream *io,
    477				 struct snd_pcm_hw_params *params);
    478int rsnd_runtime_is_multi_ssi(struct rsnd_dai_stream *io);
    479int rsnd_runtime_is_tdm(struct rsnd_dai_stream *io);
    480int rsnd_runtime_is_tdm_split(struct rsnd_dai_stream *io);
    481
    482/*
    483 * DT
    484 */
    485#define rsnd_parse_of_node(priv, node)					\
    486	of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, node)
    487#define RSND_NODE_DAI	"rcar_sound,dai"
    488#define RSND_NODE_SSI	"rcar_sound,ssi"
    489#define RSND_NODE_SSIU	"rcar_sound,ssiu"
    490#define RSND_NODE_SRC	"rcar_sound,src"
    491#define RSND_NODE_CTU	"rcar_sound,ctu"
    492#define RSND_NODE_MIX	"rcar_sound,mix"
    493#define RSND_NODE_DVC	"rcar_sound,dvc"
    494
    495/*
    496 *	R-Car sound DAI
    497 */
    498#define RSND_DAI_NAME_SIZE	16
    499struct rsnd_dai_stream {
    500	char name[RSND_DAI_NAME_SIZE];
    501	struct snd_pcm_substream *substream;
    502	struct rsnd_mod *mod[RSND_MOD_MAX];
    503	struct rsnd_mod *dma;
    504	struct rsnd_dai *rdai;
    505	struct device *dmac_dev; /* for IPMMU */
    506	u32 converted_rate;      /* converted sampling rate */
    507	int converted_chan;      /* converted channels */
    508	u32 parent_ssi_status;
    509	u32 flags;
    510};
    511
    512/* flags */
    513#define RSND_STREAM_HDMI0	(1 << 0) /* for HDMI0 */
    514#define RSND_STREAM_HDMI1	(1 << 1) /* for HDMI1 */
    515#define RSND_STREAM_TDM_SPLIT	(1 << 2) /* for TDM split mode */
    516
    517#define rsnd_io_to_mod(io, i)	((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
    518#define rsnd_io_to_mod_ssi(io)	rsnd_io_to_mod((io), RSND_MOD_SSI)
    519#define rsnd_io_to_mod_ssiu(io)	rsnd_io_to_mod((io), RSND_MOD_SSIU)
    520#define rsnd_io_to_mod_ssip(io)	rsnd_io_to_mod((io), RSND_MOD_SSIP)
    521#define rsnd_io_to_mod_src(io)	rsnd_io_to_mod((io), RSND_MOD_SRC)
    522#define rsnd_io_to_mod_ctu(io)	rsnd_io_to_mod((io), RSND_MOD_CTU)
    523#define rsnd_io_to_mod_mix(io)	rsnd_io_to_mod((io), RSND_MOD_MIX)
    524#define rsnd_io_to_mod_dvc(io)	rsnd_io_to_mod((io), RSND_MOD_DVC)
    525#define rsnd_io_to_mod_cmd(io)	rsnd_io_to_mod((io), RSND_MOD_CMD)
    526#define rsnd_io_to_rdai(io)	((io)->rdai)
    527#define rsnd_io_to_priv(io)	(rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
    528#define rsnd_io_is_play(io)	(&rsnd_io_to_rdai(io)->playback == io)
    529#define rsnd_io_to_runtime(io) ((io)->substream ? \
    530				(io)->substream->runtime : NULL)
    531#define rsnd_io_converted_rate(io)	((io)->converted_rate)
    532#define rsnd_io_converted_chan(io)	((io)->converted_chan)
    533int rsnd_io_is_working(struct rsnd_dai_stream *io);
    534
    535struct rsnd_dai {
    536	char name[RSND_DAI_NAME_SIZE];
    537	struct rsnd_dai_stream playback;
    538	struct rsnd_dai_stream capture;
    539	struct rsnd_priv *priv;
    540	struct snd_pcm_hw_constraint_list constraint;
    541
    542	int max_channels;	/* 2ch - 16ch */
    543	int ssi_lane;		/* 1lane - 4lane */
    544	int chan_width;		/* 16/24/32 bit width */
    545
    546	unsigned int clk_master:1;
    547	unsigned int bit_clk_inv:1;
    548	unsigned int frm_clk_inv:1;
    549	unsigned int sys_delay:1;
    550	unsigned int data_alignment:1;
    551};
    552
    553#define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
    554#define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
    555#define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
    556#define for_each_rsnd_dai(rdai, priv, i)		\
    557	for (i = 0;					\
    558	     (i < rsnd_rdai_nr(priv)) &&		\
    559	     ((rdai) = rsnd_rdai_get(priv, i));		\
    560	     i++)
    561
    562struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
    563
    564#define rsnd_rdai_channels_set(rdai, max_channels) \
    565	rsnd_rdai_channels_ctrl(rdai, max_channels)
    566#define rsnd_rdai_channels_get(rdai) \
    567	rsnd_rdai_channels_ctrl(rdai, 0)
    568int rsnd_rdai_channels_ctrl(struct rsnd_dai *rdai,
    569			    int max_channels);
    570
    571#define rsnd_rdai_ssi_lane_set(rdai, ssi_lane) \
    572	rsnd_rdai_ssi_lane_ctrl(rdai, ssi_lane)
    573#define rsnd_rdai_ssi_lane_get(rdai) \
    574	rsnd_rdai_ssi_lane_ctrl(rdai, 0)
    575int rsnd_rdai_ssi_lane_ctrl(struct rsnd_dai *rdai,
    576			    int ssi_lane);
    577
    578#define rsnd_rdai_width_set(rdai, width) \
    579	rsnd_rdai_width_ctrl(rdai, width)
    580#define rsnd_rdai_width_get(rdai) \
    581	rsnd_rdai_width_ctrl(rdai, 0)
    582int rsnd_rdai_width_ctrl(struct rsnd_dai *rdai, int width);
    583void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
    584int rsnd_dai_connect(struct rsnd_mod *mod,
    585		     struct rsnd_dai_stream *io,
    586		     enum rsnd_mod_type type);
    587
    588/*
    589 *	R-Car Gen1/Gen2
    590 */
    591int rsnd_gen_probe(struct rsnd_priv *priv);
    592void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
    593			       struct rsnd_mod *mod,
    594			       enum rsnd_reg reg);
    595phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
    596#ifdef CONFIG_DEBUG_FS
    597void __iomem *rsnd_gen_get_base_addr(struct rsnd_priv *priv, int reg_id);
    598#endif
    599
    600/*
    601 *	R-Car ADG
    602 */
    603int rsnd_adg_clk_query(struct rsnd_priv *priv, unsigned int rate);
    604int rsnd_adg_ssi_clk_stop(struct rsnd_mod *ssi_mod);
    605int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *ssi_mod, unsigned int rate);
    606int rsnd_adg_probe(struct rsnd_priv *priv);
    607void rsnd_adg_remove(struct rsnd_priv *priv);
    608int rsnd_adg_set_src_timesel_gen2(struct rsnd_mod *src_mod,
    609				  struct rsnd_dai_stream *io,
    610				  unsigned int in_rate,
    611				  unsigned int out_rate);
    612int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *cmd_mod,
    613				 struct rsnd_dai_stream *io);
    614#define rsnd_adg_clk_enable(priv)	rsnd_adg_clk_control(priv, 1)
    615#define rsnd_adg_clk_disable(priv)	rsnd_adg_clk_control(priv, 0)
    616void rsnd_adg_clk_control(struct rsnd_priv *priv, int enable);
    617void rsnd_adg_clk_dbg_info(struct rsnd_priv *priv, struct seq_file *m);
    618
    619/*
    620 *	R-Car sound priv
    621 */
    622struct rsnd_priv {
    623
    624	struct platform_device *pdev;
    625	spinlock_t lock;
    626	unsigned long flags;
    627#define RSND_GEN_MASK	(0xF << 0)
    628#define RSND_GEN1	(1 << 0)
    629#define RSND_GEN2	(2 << 0)
    630#define RSND_GEN3	(3 << 0)
    631#define RSND_SOC_MASK	(0xFF << 4)
    632#define RSND_SOC_E	(1 << 4) /* E1/E2/E3 */
    633
    634	/*
    635	 * below value will be filled on rsnd_gen_probe()
    636	 */
    637	void *gen;
    638
    639	/*
    640	 * below value will be filled on rsnd_adg_probe()
    641	 */
    642	void *adg;
    643
    644	/*
    645	 * below value will be filled on rsnd_dma_probe()
    646	 */
    647	void *dma;
    648
    649	/*
    650	 * below value will be filled on rsnd_ssi_probe()
    651	 */
    652	void *ssi;
    653	int ssi_nr;
    654
    655	/*
    656	 * below value will be filled on rsnd_ssiu_probe()
    657	 */
    658	void *ssiu;
    659	int ssiu_nr;
    660
    661	/*
    662	 * below value will be filled on rsnd_src_probe()
    663	 */
    664	void *src;
    665	int src_nr;
    666
    667	/*
    668	 * below value will be filled on rsnd_ctu_probe()
    669	 */
    670	void *ctu;
    671	int ctu_nr;
    672
    673	/*
    674	 * below value will be filled on rsnd_mix_probe()
    675	 */
    676	void *mix;
    677	int mix_nr;
    678
    679	/*
    680	 * below value will be filled on rsnd_dvc_probe()
    681	 */
    682	void *dvc;
    683	int dvc_nr;
    684
    685	/*
    686	 * below value will be filled on rsnd_cmd_probe()
    687	 */
    688	void *cmd;
    689	int cmd_nr;
    690
    691	/*
    692	 * below value will be filled on rsnd_dai_probe()
    693	 */
    694	struct snd_soc_dai_driver *daidrv;
    695	struct rsnd_dai *rdai;
    696	int rdai_nr;
    697};
    698
    699#define rsnd_priv_to_pdev(priv)	((priv)->pdev)
    700#define rsnd_priv_to_dev(priv)	(&(rsnd_priv_to_pdev(priv)->dev))
    701
    702#define rsnd_is_gen1(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
    703#define rsnd_is_gen2(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
    704#define rsnd_is_gen3(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN3)
    705#define rsnd_is_e3(priv)	(((priv)->flags & \
    706					(RSND_GEN_MASK | RSND_SOC_MASK)) == \
    707					(RSND_GEN3 | RSND_SOC_E))
    708
    709#define rsnd_flags_has(p, f) ((p)->flags & (f))
    710#define rsnd_flags_set(p, f) ((p)->flags |= (f))
    711#define rsnd_flags_del(p, f) ((p)->flags &= ~(f))
    712
    713/*
    714 *	rsnd_kctrl
    715 */
    716struct rsnd_kctrl_cfg {
    717	unsigned int max;
    718	unsigned int size;
    719	u32 *val;
    720	const char * const *texts;
    721	int (*accept)(struct rsnd_dai_stream *io);
    722	void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
    723	struct rsnd_dai_stream *io;
    724	struct snd_card *card;
    725	struct snd_kcontrol *kctrl;
    726	struct rsnd_mod *mod;
    727};
    728
    729#define RSND_MAX_CHANNELS	8
    730struct rsnd_kctrl_cfg_m {
    731	struct rsnd_kctrl_cfg cfg;
    732	u32 val[RSND_MAX_CHANNELS];
    733};
    734
    735struct rsnd_kctrl_cfg_s {
    736	struct rsnd_kctrl_cfg cfg;
    737	u32 val;
    738};
    739#define rsnd_kctrl_size(x)	((x).cfg.size)
    740#define rsnd_kctrl_max(x)	((x).cfg.max)
    741#define rsnd_kctrl_valm(x, i)	((x).val[i])	/* = (x).cfg.val[i] */
    742#define rsnd_kctrl_vals(x)	((x).val)	/* = (x).cfg.val[0] */
    743
    744int rsnd_kctrl_accept_anytime(struct rsnd_dai_stream *io);
    745int rsnd_kctrl_accept_runtime(struct rsnd_dai_stream *io);
    746struct rsnd_kctrl_cfg *rsnd_kctrl_init_m(struct rsnd_kctrl_cfg_m *cfg);
    747struct rsnd_kctrl_cfg *rsnd_kctrl_init_s(struct rsnd_kctrl_cfg_s *cfg);
    748int rsnd_kctrl_new(struct rsnd_mod *mod,
    749		   struct rsnd_dai_stream *io,
    750		   struct snd_soc_pcm_runtime *rtd,
    751		   const unsigned char *name,
    752		   int (*accept)(struct rsnd_dai_stream *io),
    753		   void (*update)(struct rsnd_dai_stream *io,
    754				  struct rsnd_mod *mod),
    755		   struct rsnd_kctrl_cfg *cfg,
    756		   const char * const *texts,
    757		   int size,
    758		   u32 max);
    759
    760#define rsnd_kctrl_new_m(mod, io, rtd, name, accept, update, cfg, size, max) \
    761	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_m(cfg), \
    762		       NULL, size, max)
    763
    764#define rsnd_kctrl_new_s(mod, io, rtd, name, accept, update, cfg, max)	\
    765	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
    766		       NULL, 1, max)
    767
    768#define rsnd_kctrl_new_e(mod, io, rtd, name, accept, update, cfg, texts, size) \
    769	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
    770		       texts, 1, size)
    771
    772extern const char * const volume_ramp_rate[];
    773#define VOLUME_RAMP_MAX_DVC	(0x17 + 1)
    774#define VOLUME_RAMP_MAX_MIX	(0x0a + 1)
    775
    776/*
    777 *	R-Car SSI
    778 */
    779int rsnd_ssi_probe(struct rsnd_priv *priv);
    780void rsnd_ssi_remove(struct rsnd_priv *priv);
    781struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
    782int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
    783u32 rsnd_ssi_multi_secondaries_runtime(struct rsnd_dai_stream *io);
    784int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
    785
    786#define rsnd_ssi_is_pin_sharing(io)	\
    787	__rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
    788int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
    789
    790#define rsnd_ssi_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSI)
    791void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
    792			    struct device_node *playback,
    793			    struct device_node *capture);
    794unsigned int rsnd_ssi_clk_query(struct rsnd_dai *rdai,
    795		       int param1, int param2, int *idx);
    796
    797/*
    798 *	R-Car SSIU
    799 */
    800int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
    801		     struct rsnd_mod *mod);
    802int rsnd_ssiu_probe(struct rsnd_priv *priv);
    803void rsnd_ssiu_remove(struct rsnd_priv *priv);
    804void rsnd_parse_connect_ssiu(struct rsnd_dai *rdai,
    805			     struct device_node *playback,
    806			     struct device_node *capture);
    807#define rsnd_ssiu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSIU)
    808bool rsnd_ssiu_busif_err_status_clear(struct rsnd_mod *mod);
    809
    810/*
    811 *	R-Car SRC
    812 */
    813int rsnd_src_probe(struct rsnd_priv *priv);
    814void rsnd_src_remove(struct rsnd_priv *priv);
    815struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
    816
    817#define rsnd_src_get_in_rate(priv, io) rsnd_src_get_rate(priv, io, 1)
    818#define rsnd_src_get_out_rate(priv, io) rsnd_src_get_rate(priv, io, 0)
    819unsigned int rsnd_src_get_rate(struct rsnd_priv *priv,
    820			       struct rsnd_dai_stream *io,
    821			       int is_in);
    822
    823#define rsnd_src_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SRC)
    824#define rsnd_parse_connect_src(rdai, playback, capture)			\
    825	rsnd_parse_connect_common(rdai, "src", rsnd_src_mod_get,	\
    826				  rsnd_src_of_node(rsnd_rdai_to_priv(rdai)), \
    827						   playback, capture)
    828
    829/*
    830 *	R-Car CTU
    831 */
    832int rsnd_ctu_probe(struct rsnd_priv *priv);
    833void rsnd_ctu_remove(struct rsnd_priv *priv);
    834struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
    835#define rsnd_ctu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_CTU)
    836#define rsnd_parse_connect_ctu(rdai, playback, capture)			\
    837	rsnd_parse_connect_common(rdai, "ctu", rsnd_ctu_mod_get,	\
    838				  rsnd_ctu_of_node(rsnd_rdai_to_priv(rdai)), \
    839						   playback, capture)
    840
    841/*
    842 *	R-Car MIX
    843 */
    844int rsnd_mix_probe(struct rsnd_priv *priv);
    845void rsnd_mix_remove(struct rsnd_priv *priv);
    846struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
    847#define rsnd_mix_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_MIX)
    848#define rsnd_parse_connect_mix(rdai, playback, capture)			\
    849	rsnd_parse_connect_common(rdai, "mix", rsnd_mix_mod_get,	\
    850				  rsnd_mix_of_node(rsnd_rdai_to_priv(rdai)), \
    851						   playback, capture)
    852
    853/*
    854 *	R-Car DVC
    855 */
    856int rsnd_dvc_probe(struct rsnd_priv *priv);
    857void rsnd_dvc_remove(struct rsnd_priv *priv);
    858struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
    859#define rsnd_dvc_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_DVC)
    860#define rsnd_parse_connect_dvc(rdai, playback, capture)			\
    861	rsnd_parse_connect_common(rdai, "dvc", rsnd_dvc_mod_get,	\
    862				  rsnd_dvc_of_node(rsnd_rdai_to_priv(rdai)), \
    863						   playback, capture)
    864
    865/*
    866 *	R-Car CMD
    867 */
    868int rsnd_cmd_probe(struct rsnd_priv *priv);
    869void rsnd_cmd_remove(struct rsnd_priv *priv);
    870int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
    871
    872void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
    873#ifdef DEBUG
    874#define rsnd_mod_confirm_ssi(mssi)	rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
    875#define rsnd_mod_confirm_src(msrc)	rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
    876#define rsnd_mod_confirm_dvc(mdvc)	rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
    877#else
    878#define rsnd_mod_confirm_ssi(mssi)
    879#define rsnd_mod_confirm_src(msrc)
    880#define rsnd_mod_confirm_dvc(mdvc)
    881#endif
    882
    883/*
    884 * If you don't need interrupt status debug message,
    885 * define RSND_DEBUG_NO_IRQ_STATUS as 1 on top of src.c/ssi.c
    886 *
    887 * #define RSND_DEBUG_NO_IRQ_STATUS 1
    888 */
    889#define rsnd_print_irq_status(dev, param...) do {	\
    890	if (!IS_BUILTIN(RSND_DEBUG_NO_IRQ_STATUS))	\
    891		dev_info(dev, param);			\
    892} while (0)
    893
    894/*
    895 * If you don't need rsnd_dai_call debug message,
    896 * define RSND_DEBUG_NO_DAI_CALL as 1 on top of core.c
    897 *
    898 * #define RSND_DEBUG_NO_DAI_CALL 1
    899 */
    900#define rsnd_dbg_dai_call(dev, param...)		\
    901	if (!IS_BUILTIN(RSND_DEBUG_NO_DAI_CALL))	\
    902		dev_dbg(dev, param)
    903
    904#endif
    905
    906#ifdef CONFIG_DEBUG_FS
    907int rsnd_debugfs_probe(struct snd_soc_component *component);
    908void rsnd_debugfs_reg_show(struct seq_file *m, phys_addr_t _addr,
    909			   void __iomem *base, int offset, int size);
    910void rsnd_debugfs_mod_reg_show(struct seq_file *m, struct rsnd_mod *mod,
    911			       int reg_id, int offset, int size);
    912
    913#else
    914#define rsnd_debugfs_probe  NULL
    915#endif