xref: /openbmc/linux/sound/soc/sh/rcar/rsnd.h (revision 965f22bc)
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  */
43 enum rsnd_reg {
44 	/* SCU (MIX/CTU/DVC) */
45 	RSND_REG_SRC_I_BUSIF_MODE,
46 	RSND_REG_SRC_O_BUSIF_MODE,
47 	RSND_REG_SRC_ROUTE_MODE0,
48 	RSND_REG_SRC_SWRSR,
49 	RSND_REG_SRC_SRCIR,
50 	RSND_REG_SRC_ADINR,
51 	RSND_REG_SRC_IFSCR,
52 	RSND_REG_SRC_IFSVR,
53 	RSND_REG_SRC_SRCCR,
54 	RSND_REG_SRC_CTRL,
55 	RSND_REG_SRC_BSDSR,
56 	RSND_REG_SRC_BSISR,
57 	RSND_REG_SRC_INT_ENABLE0,
58 	RSND_REG_SRC_BUSIF_DALIGN,
59 	RSND_REG_SRCIN_TIMSEL0,
60 	RSND_REG_SRCIN_TIMSEL1,
61 	RSND_REG_SRCIN_TIMSEL2,
62 	RSND_REG_SRCIN_TIMSEL3,
63 	RSND_REG_SRCIN_TIMSEL4,
64 	RSND_REG_SRCOUT_TIMSEL0,
65 	RSND_REG_SRCOUT_TIMSEL1,
66 	RSND_REG_SRCOUT_TIMSEL2,
67 	RSND_REG_SRCOUT_TIMSEL3,
68 	RSND_REG_SRCOUT_TIMSEL4,
69 	RSND_REG_SCU_SYS_STATUS0,
70 	RSND_REG_SCU_SYS_STATUS1,
71 	RSND_REG_SCU_SYS_INT_EN0,
72 	RSND_REG_SCU_SYS_INT_EN1,
73 	RSND_REG_CMD_CTRL,
74 	RSND_REG_CMD_BUSIF_MODE,
75 	RSND_REG_CMD_BUSIF_DALIGN,
76 	RSND_REG_CMD_ROUTE_SLCT,
77 	RSND_REG_CMDOUT_TIMSEL,
78 	RSND_REG_CTU_SWRSR,
79 	RSND_REG_CTU_CTUIR,
80 	RSND_REG_CTU_ADINR,
81 	RSND_REG_CTU_CPMDR,
82 	RSND_REG_CTU_SCMDR,
83 	RSND_REG_CTU_SV00R,
84 	RSND_REG_CTU_SV01R,
85 	RSND_REG_CTU_SV02R,
86 	RSND_REG_CTU_SV03R,
87 	RSND_REG_CTU_SV04R,
88 	RSND_REG_CTU_SV05R,
89 	RSND_REG_CTU_SV06R,
90 	RSND_REG_CTU_SV07R,
91 	RSND_REG_CTU_SV10R,
92 	RSND_REG_CTU_SV11R,
93 	RSND_REG_CTU_SV12R,
94 	RSND_REG_CTU_SV13R,
95 	RSND_REG_CTU_SV14R,
96 	RSND_REG_CTU_SV15R,
97 	RSND_REG_CTU_SV16R,
98 	RSND_REG_CTU_SV17R,
99 	RSND_REG_CTU_SV20R,
100 	RSND_REG_CTU_SV21R,
101 	RSND_REG_CTU_SV22R,
102 	RSND_REG_CTU_SV23R,
103 	RSND_REG_CTU_SV24R,
104 	RSND_REG_CTU_SV25R,
105 	RSND_REG_CTU_SV26R,
106 	RSND_REG_CTU_SV27R,
107 	RSND_REG_CTU_SV30R,
108 	RSND_REG_CTU_SV31R,
109 	RSND_REG_CTU_SV32R,
110 	RSND_REG_CTU_SV33R,
111 	RSND_REG_CTU_SV34R,
112 	RSND_REG_CTU_SV35R,
113 	RSND_REG_CTU_SV36R,
114 	RSND_REG_CTU_SV37R,
115 	RSND_REG_MIX_SWRSR,
116 	RSND_REG_MIX_MIXIR,
117 	RSND_REG_MIX_ADINR,
118 	RSND_REG_MIX_MIXMR,
119 	RSND_REG_MIX_MVPDR,
120 	RSND_REG_MIX_MDBAR,
121 	RSND_REG_MIX_MDBBR,
122 	RSND_REG_MIX_MDBCR,
123 	RSND_REG_MIX_MDBDR,
124 	RSND_REG_MIX_MDBER,
125 	RSND_REG_DVC_SWRSR,
126 	RSND_REG_DVC_DVUIR,
127 	RSND_REG_DVC_ADINR,
128 	RSND_REG_DVC_DVUCR,
129 	RSND_REG_DVC_ZCMCR,
130 	RSND_REG_DVC_VOL0R,
131 	RSND_REG_DVC_VOL1R,
132 	RSND_REG_DVC_VOL2R,
133 	RSND_REG_DVC_VOL3R,
134 	RSND_REG_DVC_VOL4R,
135 	RSND_REG_DVC_VOL5R,
136 	RSND_REG_DVC_VOL6R,
137 	RSND_REG_DVC_VOL7R,
138 	RSND_REG_DVC_DVUER,
139 	RSND_REG_DVC_VRCTR,
140 	RSND_REG_DVC_VRPDR,
141 	RSND_REG_DVC_VRDBR,
142 
143 	/* ADG */
144 	RSND_REG_BRRA,
145 	RSND_REG_BRRB,
146 	RSND_REG_BRGCKR,
147 	RSND_REG_DIV_EN,
148 	RSND_REG_AUDIO_CLK_SEL0,
149 	RSND_REG_AUDIO_CLK_SEL1,
150 	RSND_REG_AUDIO_CLK_SEL2,
151 
152 	/* SSIU */
153 	RSND_REG_SSI_MODE,
154 	RSND_REG_SSI_MODE0,
155 	RSND_REG_SSI_MODE1,
156 	RSND_REG_SSI_MODE2,
157 	RSND_REG_SSI_CONTROL,
158 	RSND_REG_SSI_CTRL,
159 	RSND_REG_SSI_BUSIF_MODE,
160 	RSND_REG_SSI_BUSIF_ADINR,
161 	RSND_REG_SSI_BUSIF_DALIGN,
162 	RSND_REG_SSI_INT_ENABLE,
163 	RSND_REG_SSI_SYS_STATUS0,
164 	RSND_REG_SSI_SYS_STATUS1,
165 	RSND_REG_SSI_SYS_STATUS2,
166 	RSND_REG_SSI_SYS_STATUS3,
167 	RSND_REG_SSI_SYS_STATUS4,
168 	RSND_REG_SSI_SYS_STATUS5,
169 	RSND_REG_SSI_SYS_STATUS6,
170 	RSND_REG_SSI_SYS_STATUS7,
171 	RSND_REG_HDMI0_SEL,
172 	RSND_REG_HDMI1_SEL,
173 
174 	/* SSI */
175 	RSND_REG_SSICR,
176 	RSND_REG_SSISR,
177 	RSND_REG_SSITDR,
178 	RSND_REG_SSIRDR,
179 	RSND_REG_SSIWSR,
180 
181 	RSND_REG_MAX,
182 };
183 
184 struct rsnd_priv;
185 struct rsnd_mod;
186 struct rsnd_dai;
187 struct rsnd_dai_stream;
188 
189 /*
190  *	R-Car basic functions
191  */
192 #define rsnd_mod_read(m, r) \
193 	rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
194 #define rsnd_mod_write(m, r, d) \
195 	rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
196 #define rsnd_mod_bset(m, r, s, d) \
197 	rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
198 
199 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
200 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
201 		enum rsnd_reg reg, u32 data);
202 void rsnd_force_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
203 		enum rsnd_reg reg, u32 data);
204 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
205 		    u32 mask, u32 data);
206 u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
207 u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
208 u32 rsnd_get_busif_shift(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
209 
210 /*
211  *	R-Car DMA
212  */
213 int rsnd_dma_attach(struct rsnd_dai_stream *io,
214 		    struct rsnd_mod *mod, struct rsnd_mod **dma_mod);
215 int rsnd_dma_probe(struct rsnd_priv *priv);
216 struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node,
217 					  struct rsnd_mod *mod, char *name);
218 
219 /*
220  *	R-Car sound mod
221  */
222 enum rsnd_mod_type {
223 	RSND_MOD_AUDMAPP,
224 	RSND_MOD_AUDMA,
225 	RSND_MOD_DVC,
226 	RSND_MOD_MIX,
227 	RSND_MOD_CTU,
228 	RSND_MOD_CMD,
229 	RSND_MOD_SRC,
230 	RSND_MOD_SSIM3,		/* SSI multi 3 */
231 	RSND_MOD_SSIM2,		/* SSI multi 2 */
232 	RSND_MOD_SSIM1,		/* SSI multi 1 */
233 	RSND_MOD_SSIP,		/* SSI parent */
234 	RSND_MOD_SSI,
235 	RSND_MOD_SSIU,
236 	RSND_MOD_MAX,
237 };
238 
239 struct rsnd_mod_ops {
240 	char *name;
241 	struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
242 				    struct rsnd_mod *mod);
243 	int (*probe)(struct rsnd_mod *mod,
244 		     struct rsnd_dai_stream *io,
245 		     struct rsnd_priv *priv);
246 	int (*remove)(struct rsnd_mod *mod,
247 		      struct rsnd_dai_stream *io,
248 		      struct rsnd_priv *priv);
249 	int (*init)(struct rsnd_mod *mod,
250 		    struct rsnd_dai_stream *io,
251 		    struct rsnd_priv *priv);
252 	int (*quit)(struct rsnd_mod *mod,
253 		    struct rsnd_dai_stream *io,
254 		    struct rsnd_priv *priv);
255 	int (*start)(struct rsnd_mod *mod,
256 		     struct rsnd_dai_stream *io,
257 		     struct rsnd_priv *priv);
258 	int (*stop)(struct rsnd_mod *mod,
259 		    struct rsnd_dai_stream *io,
260 		    struct rsnd_priv *priv);
261 	int (*irq)(struct rsnd_mod *mod,
262 		   struct rsnd_dai_stream *io,
263 		   struct rsnd_priv *priv, int enable);
264 	int (*pcm_new)(struct rsnd_mod *mod,
265 		       struct rsnd_dai_stream *io,
266 		       struct snd_soc_pcm_runtime *rtd);
267 	int (*hw_params)(struct rsnd_mod *mod,
268 			 struct rsnd_dai_stream *io,
269 			 struct snd_pcm_substream *substream,
270 			 struct snd_pcm_hw_params *hw_params);
271 	int (*pointer)(struct rsnd_mod *mod,
272 		       struct rsnd_dai_stream *io,
273 		       snd_pcm_uframes_t *pointer);
274 	int (*fallback)(struct rsnd_mod *mod,
275 			struct rsnd_dai_stream *io,
276 			struct rsnd_priv *priv);
277 	int (*nolock_start)(struct rsnd_mod *mod,
278 		    struct rsnd_dai_stream *io,
279 		    struct rsnd_priv *priv);
280 	int (*nolock_stop)(struct rsnd_mod *mod,
281 		    struct rsnd_dai_stream *io,
282 		    struct rsnd_priv *priv);
283 };
284 
285 struct rsnd_dai_stream;
286 struct rsnd_mod {
287 	int id;
288 	enum rsnd_mod_type type;
289 	struct rsnd_mod_ops *ops;
290 	struct rsnd_priv *priv;
291 	struct clk *clk;
292 	u32 *(*get_status)(struct rsnd_dai_stream *io,
293 			   struct rsnd_mod *mod,
294 			   enum rsnd_mod_type type);
295 	u32 status;
296 };
297 /*
298  * status
299  *
300  * 0xH0000CBA
301  *
302  * A	0: nolock_start	1: nolock_stop
303  * B	0: init		1: quit
304  * C	0: start	1: stop
305  *
306  * H is always called (see __rsnd_mod_call)
307  * H	0: probe	1: remove
308  * H	0: pcm_new
309  * H	0: fallback
310  * H	0: hw_params
311  * H	0: pointer
312  */
313 #define __rsnd_mod_shift_nolock_start	0
314 #define __rsnd_mod_shift_nolock_stop	0
315 #define __rsnd_mod_shift_init		4
316 #define __rsnd_mod_shift_quit		4
317 #define __rsnd_mod_shift_start		8
318 #define __rsnd_mod_shift_stop		8
319 #define __rsnd_mod_shift_probe		28 /* always called */
320 #define __rsnd_mod_shift_remove		28 /* always called */
321 #define __rsnd_mod_shift_irq		28 /* always called */
322 #define __rsnd_mod_shift_pcm_new	28 /* always called */
323 #define __rsnd_mod_shift_fallback	28 /* always called */
324 #define __rsnd_mod_shift_hw_params	28 /* always called */
325 #define __rsnd_mod_shift_pointer	28 /* always called */
326 
327 #define __rsnd_mod_add_probe		0
328 #define __rsnd_mod_add_remove		0
329 #define __rsnd_mod_add_nolock_start	 1
330 #define __rsnd_mod_add_nolock_stop	-1
331 #define __rsnd_mod_add_init		 1
332 #define __rsnd_mod_add_quit		-1
333 #define __rsnd_mod_add_start		 1
334 #define __rsnd_mod_add_stop		-1
335 #define __rsnd_mod_add_irq		0
336 #define __rsnd_mod_add_pcm_new		0
337 #define __rsnd_mod_add_fallback		0
338 #define __rsnd_mod_add_hw_params	0
339 #define __rsnd_mod_add_pointer		0
340 
341 #define __rsnd_mod_call_probe		0
342 #define __rsnd_mod_call_remove		0
343 #define __rsnd_mod_call_init		0
344 #define __rsnd_mod_call_quit		1
345 #define __rsnd_mod_call_start		0
346 #define __rsnd_mod_call_stop		1
347 #define __rsnd_mod_call_irq		0
348 #define __rsnd_mod_call_pcm_new		0
349 #define __rsnd_mod_call_fallback	0
350 #define __rsnd_mod_call_hw_params	0
351 #define __rsnd_mod_call_pointer		0
352 #define __rsnd_mod_call_nolock_start	0
353 #define __rsnd_mod_call_nolock_stop	1
354 
355 #define rsnd_mod_to_priv(mod)	((mod)->priv)
356 #define rsnd_mod_name(mod)	((mod)->ops->name)
357 #define rsnd_mod_id(mod)	((mod)->id)
358 #define rsnd_mod_power_on(mod)	clk_enable((mod)->clk)
359 #define rsnd_mod_power_off(mod)	clk_disable((mod)->clk)
360 #define rsnd_mod_get(ip)	(&(ip)->mod)
361 
362 int rsnd_mod_init(struct rsnd_priv *priv,
363 		  struct rsnd_mod *mod,
364 		  struct rsnd_mod_ops *ops,
365 		  struct clk *clk,
366 		  u32* (*get_status)(struct rsnd_dai_stream *io,
367 				     struct rsnd_mod *mod,
368 				     enum rsnd_mod_type type),
369 		  enum rsnd_mod_type type,
370 		  int id);
371 void rsnd_mod_quit(struct rsnd_mod *mod);
372 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
373 				  struct rsnd_mod *mod);
374 void rsnd_mod_interrupt(struct rsnd_mod *mod,
375 			void (*callback)(struct rsnd_mod *mod,
376 					 struct rsnd_dai_stream *io));
377 u32 *rsnd_mod_get_status(struct rsnd_dai_stream *io,
378 			 struct rsnd_mod *mod,
379 			 enum rsnd_mod_type type);
380 struct rsnd_mod *rsnd_mod_next(int *iterator,
381 			       struct rsnd_dai_stream *io,
382 			       enum rsnd_mod_type *array,
383 			       int array_size);
384 #define for_each_rsnd_mod(iterator, pos, io)				\
385 	for (iterator = 0;						\
386 	     (pos = rsnd_mod_next(&iterator, io, NULL, 0)); iterator++)
387 #define for_each_rsnd_mod_arrays(iterator, pos, io, array, size)	\
388 	for (iterator = 0;						\
389 	     (pos = rsnd_mod_next(&iterator, io, array, size)); iterator++)
390 #define for_each_rsnd_mod_array(iterator, pos, io, array)		\
391 	for_each_rsnd_mod_arrays(iterator, pos, io, array, ARRAY_SIZE(array))
392 
393 void rsnd_parse_connect_common(struct rsnd_dai *rdai,
394 		struct rsnd_mod* (*mod_get)(struct rsnd_priv *priv, int id),
395 		struct device_node *node,
396 		struct device_node *playback,
397 		struct device_node *capture);
398 
399 #define rsnd_runtime_channel_original(io) \
400 	rsnd_runtime_channel_original_with_params(io, NULL)
401 int rsnd_runtime_channel_original_with_params(struct rsnd_dai_stream *io,
402 				struct snd_pcm_hw_params *params);
403 #define rsnd_runtime_channel_after_ctu(io)			\
404 	rsnd_runtime_channel_after_ctu_with_params(io, NULL)
405 int rsnd_runtime_channel_after_ctu_with_params(struct rsnd_dai_stream *io,
406 				struct snd_pcm_hw_params *params);
407 #define rsnd_runtime_channel_for_ssi(io) \
408 	rsnd_runtime_channel_for_ssi_with_params(io, NULL)
409 int rsnd_runtime_channel_for_ssi_with_params(struct rsnd_dai_stream *io,
410 				 struct snd_pcm_hw_params *params);
411 int rsnd_runtime_is_ssi_multi(struct rsnd_dai_stream *io);
412 int rsnd_runtime_is_ssi_tdm(struct rsnd_dai_stream *io);
413 
414 /*
415  * DT
416  */
417 #define rsnd_parse_of_node(priv, node)					\
418 	of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, node)
419 #define RSND_NODE_DAI	"rcar_sound,dai"
420 #define RSND_NODE_SSI	"rcar_sound,ssi"
421 #define RSND_NODE_SRC	"rcar_sound,src"
422 #define RSND_NODE_CTU	"rcar_sound,ctu"
423 #define RSND_NODE_MIX	"rcar_sound,mix"
424 #define RSND_NODE_DVC	"rcar_sound,dvc"
425 
426 /*
427  *	R-Car sound DAI
428  */
429 #define RSND_DAI_NAME_SIZE	16
430 struct rsnd_dai_stream {
431 	char name[RSND_DAI_NAME_SIZE];
432 	struct snd_pcm_substream *substream;
433 	struct rsnd_mod *mod[RSND_MOD_MAX];
434 	struct rsnd_dai *rdai;
435 	struct device *dmac_dev; /* for IPMMU */
436 	u32 parent_ssi_status;
437 };
438 #define rsnd_io_to_mod(io, i)	((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
439 #define rsnd_io_to_mod_ssi(io)	rsnd_io_to_mod((io), RSND_MOD_SSI)
440 #define rsnd_io_to_mod_ssiu(io)	rsnd_io_to_mod((io), RSND_MOD_SSIU)
441 #define rsnd_io_to_mod_ssip(io)	rsnd_io_to_mod((io), RSND_MOD_SSIP)
442 #define rsnd_io_to_mod_src(io)	rsnd_io_to_mod((io), RSND_MOD_SRC)
443 #define rsnd_io_to_mod_ctu(io)	rsnd_io_to_mod((io), RSND_MOD_CTU)
444 #define rsnd_io_to_mod_mix(io)	rsnd_io_to_mod((io), RSND_MOD_MIX)
445 #define rsnd_io_to_mod_dvc(io)	rsnd_io_to_mod((io), RSND_MOD_DVC)
446 #define rsnd_io_to_mod_cmd(io)	rsnd_io_to_mod((io), RSND_MOD_CMD)
447 #define rsnd_io_to_rdai(io)	((io)->rdai)
448 #define rsnd_io_to_priv(io)	(rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
449 #define rsnd_io_is_play(io)	(&rsnd_io_to_rdai(io)->playback == io)
450 #define rsnd_io_to_runtime(io) ((io)->substream ? \
451 				(io)->substream->runtime : NULL)
452 int rsnd_io_is_working(struct rsnd_dai_stream *io);
453 
454 struct rsnd_dai {
455 	char name[RSND_DAI_NAME_SIZE];
456 	struct rsnd_dai_stream playback;
457 	struct rsnd_dai_stream capture;
458 	struct rsnd_priv *priv;
459 	struct snd_pcm_hw_constraint_list constraint;
460 
461 	int max_channels;	/* 2ch - 16ch */
462 	int ssi_lane;		/* 1lane - 4lane */
463 
464 	unsigned int clk_master:1;
465 	unsigned int bit_clk_inv:1;
466 	unsigned int frm_clk_inv:1;
467 	unsigned int sys_delay:1;
468 	unsigned int data_alignment:1;
469 };
470 
471 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
472 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
473 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
474 #define for_each_rsnd_dai(rdai, priv, i)		\
475 	for (i = 0;					\
476 	     (i < rsnd_rdai_nr(priv)) &&		\
477 	     ((rdai) = rsnd_rdai_get(priv, i));		\
478 	     i++)
479 
480 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
481 
482 #define rsnd_rdai_channels_set(rdai, max_channels) \
483 	rsnd_rdai_channels_ctrl(rdai, max_channels)
484 #define rsnd_rdai_channels_get(rdai) \
485 	rsnd_rdai_channels_ctrl(rdai, 0)
486 int rsnd_rdai_channels_ctrl(struct rsnd_dai *rdai,
487 			    int max_channels);
488 
489 #define rsnd_rdai_ssi_lane_set(rdai, ssi_lane) \
490 	rsnd_rdai_ssi_lane_ctrl(rdai, ssi_lane)
491 #define rsnd_rdai_ssi_lane_get(rdai) \
492 	rsnd_rdai_ssi_lane_ctrl(rdai, 0)
493 int rsnd_rdai_ssi_lane_ctrl(struct rsnd_dai *rdai,
494 			    int ssi_lane);
495 
496 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
497 int rsnd_dai_connect(struct rsnd_mod *mod,
498 		     struct rsnd_dai_stream *io,
499 		     enum rsnd_mod_type type);
500 
501 /*
502  *	R-Car Gen1/Gen2
503  */
504 int rsnd_gen_probe(struct rsnd_priv *priv);
505 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
506 			       struct rsnd_mod *mod,
507 			       enum rsnd_reg reg);
508 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
509 
510 /*
511  *	R-Car ADG
512  */
513 int rsnd_adg_clk_query(struct rsnd_priv *priv, unsigned int rate);
514 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
515 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
516 int rsnd_adg_probe(struct rsnd_priv *priv);
517 void rsnd_adg_remove(struct rsnd_priv *priv);
518 int rsnd_adg_set_src_timesel_gen2(struct rsnd_mod *src_mod,
519 				  struct rsnd_dai_stream *io,
520 				  unsigned int in_rate,
521 				  unsigned int out_rate);
522 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
523 				 struct rsnd_dai_stream *io);
524 #define rsnd_adg_clk_enable(priv)	rsnd_adg_clk_control(priv, 1)
525 #define rsnd_adg_clk_disable(priv)	rsnd_adg_clk_control(priv, 0)
526 void rsnd_adg_clk_control(struct rsnd_priv *priv, int enable);
527 
528 /*
529  *	R-Car sound priv
530  */
531 struct rsnd_priv {
532 
533 	struct platform_device *pdev;
534 	spinlock_t lock;
535 	unsigned long flags;
536 #define RSND_GEN_MASK	(0xF << 0)
537 #define RSND_GEN1	(1 << 0)
538 #define RSND_GEN2	(2 << 0)
539 #define RSND_GEN3	(3 << 0)
540 
541 	/*
542 	 * below value will be filled on rsnd_gen_probe()
543 	 */
544 	void *gen;
545 
546 	/*
547 	 * below value will be filled on rsnd_adg_probe()
548 	 */
549 	void *adg;
550 
551 	/*
552 	 * below value will be filled on rsnd_dma_probe()
553 	 */
554 	void *dma;
555 
556 	/*
557 	 * below value will be filled on rsnd_ssi_probe()
558 	 */
559 	void *ssi;
560 	int ssi_nr;
561 
562 	/*
563 	 * below value will be filled on rsnd_ssiu_probe()
564 	 */
565 	void *ssiu;
566 	int ssiu_nr;
567 
568 	/*
569 	 * below value will be filled on rsnd_src_probe()
570 	 */
571 	void *src;
572 	int src_nr;
573 
574 	/*
575 	 * below value will be filled on rsnd_ctu_probe()
576 	 */
577 	void *ctu;
578 	int ctu_nr;
579 
580 	/*
581 	 * below value will be filled on rsnd_mix_probe()
582 	 */
583 	void *mix;
584 	int mix_nr;
585 
586 	/*
587 	 * below value will be filled on rsnd_dvc_probe()
588 	 */
589 	void *dvc;
590 	int dvc_nr;
591 
592 	/*
593 	 * below value will be filled on rsnd_cmd_probe()
594 	 */
595 	void *cmd;
596 	int cmd_nr;
597 
598 	/*
599 	 * below value will be filled on rsnd_dai_probe()
600 	 */
601 	struct snd_soc_dai_driver *daidrv;
602 	struct rsnd_dai *rdai;
603 	int rdai_nr;
604 };
605 
606 #define rsnd_priv_to_pdev(priv)	((priv)->pdev)
607 #define rsnd_priv_to_dev(priv)	(&(rsnd_priv_to_pdev(priv)->dev))
608 
609 #define rsnd_is_gen1(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
610 #define rsnd_is_gen2(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
611 #define rsnd_is_gen3(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN3)
612 
613 #define rsnd_flags_has(p, f) ((p)->flags & (f))
614 #define rsnd_flags_set(p, f) ((p)->flags |= (f))
615 #define rsnd_flags_del(p, f) ((p)->flags &= ~(f))
616 
617 /*
618  *	rsnd_kctrl
619  */
620 struct rsnd_kctrl_cfg {
621 	unsigned int max;
622 	unsigned int size;
623 	u32 *val;
624 	const char * const *texts;
625 	int (*accept)(struct rsnd_dai_stream *io);
626 	void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
627 	struct rsnd_dai_stream *io;
628 	struct snd_card *card;
629 	struct snd_kcontrol *kctrl;
630 	struct rsnd_mod *mod;
631 };
632 
633 #define RSND_MAX_CHANNELS	8
634 struct rsnd_kctrl_cfg_m {
635 	struct rsnd_kctrl_cfg cfg;
636 	u32 val[RSND_MAX_CHANNELS];
637 };
638 
639 struct rsnd_kctrl_cfg_s {
640 	struct rsnd_kctrl_cfg cfg;
641 	u32 val;
642 };
643 #define rsnd_kctrl_size(x)	((x).cfg.size)
644 #define rsnd_kctrl_max(x)	((x).cfg.max)
645 #define rsnd_kctrl_valm(x, i)	((x).val[i])	/* = (x).cfg.val[i] */
646 #define rsnd_kctrl_vals(x)	((x).val)	/* = (x).cfg.val[0] */
647 
648 int rsnd_kctrl_accept_anytime(struct rsnd_dai_stream *io);
649 int rsnd_kctrl_accept_runtime(struct rsnd_dai_stream *io);
650 struct rsnd_kctrl_cfg *rsnd_kctrl_init_m(struct rsnd_kctrl_cfg_m *cfg);
651 struct rsnd_kctrl_cfg *rsnd_kctrl_init_s(struct rsnd_kctrl_cfg_s *cfg);
652 int rsnd_kctrl_new(struct rsnd_mod *mod,
653 		   struct rsnd_dai_stream *io,
654 		   struct snd_soc_pcm_runtime *rtd,
655 		   const unsigned char *name,
656 		   int (*accept)(struct rsnd_dai_stream *io),
657 		   void (*update)(struct rsnd_dai_stream *io,
658 				  struct rsnd_mod *mod),
659 		   struct rsnd_kctrl_cfg *cfg,
660 		   const char * const *texts,
661 		   int size,
662 		   u32 max);
663 
664 #define rsnd_kctrl_new_m(mod, io, rtd, name, accept, update, cfg, size, max) \
665 	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_m(cfg), \
666 		       NULL, size, max)
667 
668 #define rsnd_kctrl_new_s(mod, io, rtd, name, accept, update, cfg, max)	\
669 	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
670 		       NULL, 1, max)
671 
672 #define rsnd_kctrl_new_e(mod, io, rtd, name, accept, update, cfg, texts, size) \
673 	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
674 		       texts, 1, size)
675 
676 extern const char * const volume_ramp_rate[];
677 #define VOLUME_RAMP_MAX_DVC	(0x17 + 1)
678 #define VOLUME_RAMP_MAX_MIX	(0x0a + 1)
679 
680 /*
681  *	R-Car SSI
682  */
683 int rsnd_ssi_probe(struct rsnd_priv *priv);
684 void rsnd_ssi_remove(struct rsnd_priv *priv);
685 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
686 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
687 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
688 u32 rsnd_ssi_multi_slaves_runtime(struct rsnd_dai_stream *io);
689 
690 #define RSND_SSI_HDMI_PORT0	0xf0
691 #define RSND_SSI_HDMI_PORT1	0xf1
692 int rsnd_ssi_hdmi_port(struct rsnd_dai_stream *io);
693 void rsnd_ssi_parse_hdmi_connection(struct rsnd_priv *priv,
694 				    struct device_node *endpoint,
695 				    int dai_i);
696 
697 #define rsnd_ssi_is_pin_sharing(io)	\
698 	__rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
699 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
700 
701 #define rsnd_ssi_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSI)
702 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
703 			    struct device_node *playback,
704 			    struct device_node *capture);
705 unsigned int rsnd_ssi_clk_query(struct rsnd_priv *priv,
706 		       int param1, int param2, int *idx);
707 
708 /*
709  *	R-Car SSIU
710  */
711 int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
712 		     struct rsnd_mod *mod);
713 int rsnd_ssiu_probe(struct rsnd_priv *priv);
714 void rsnd_ssiu_remove(struct rsnd_priv *priv);
715 
716 /*
717  *	R-Car SRC
718  */
719 int rsnd_src_probe(struct rsnd_priv *priv);
720 void rsnd_src_remove(struct rsnd_priv *priv);
721 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
722 
723 #define rsnd_src_get_in_rate(priv, io) rsnd_src_get_rate(priv, io, 1)
724 #define rsnd_src_get_out_rate(priv, io) rsnd_src_get_rate(priv, io, 0)
725 unsigned int rsnd_src_get_rate(struct rsnd_priv *priv,
726 			       struct rsnd_dai_stream *io,
727 			       int is_in);
728 
729 #define rsnd_src_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SRC)
730 #define rsnd_parse_connect_src(rdai, playback, capture)			\
731 	rsnd_parse_connect_common(rdai, rsnd_src_mod_get,		\
732 				  rsnd_src_of_node(rsnd_rdai_to_priv(rdai)), \
733 						   playback, capture)
734 
735 /*
736  *	R-Car CTU
737  */
738 int rsnd_ctu_probe(struct rsnd_priv *priv);
739 void rsnd_ctu_remove(struct rsnd_priv *priv);
740 int rsnd_ctu_converted_channel(struct rsnd_mod *mod);
741 struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
742 #define rsnd_ctu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_CTU)
743 #define rsnd_parse_connect_ctu(rdai, playback, capture)			\
744 	rsnd_parse_connect_common(rdai, rsnd_ctu_mod_get,		\
745 				  rsnd_ctu_of_node(rsnd_rdai_to_priv(rdai)), \
746 						   playback, capture)
747 
748 /*
749  *	R-Car MIX
750  */
751 int rsnd_mix_probe(struct rsnd_priv *priv);
752 void rsnd_mix_remove(struct rsnd_priv *priv);
753 struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
754 #define rsnd_mix_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_MIX)
755 #define rsnd_parse_connect_mix(rdai, playback, capture)			\
756 	rsnd_parse_connect_common(rdai, rsnd_mix_mod_get,		\
757 				  rsnd_mix_of_node(rsnd_rdai_to_priv(rdai)), \
758 						   playback, capture)
759 
760 /*
761  *	R-Car DVC
762  */
763 int rsnd_dvc_probe(struct rsnd_priv *priv);
764 void rsnd_dvc_remove(struct rsnd_priv *priv);
765 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
766 #define rsnd_dvc_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_DVC)
767 #define rsnd_parse_connect_dvc(rdai, playback, capture)			\
768 	rsnd_parse_connect_common(rdai, rsnd_dvc_mod_get,		\
769 				  rsnd_dvc_of_node(rsnd_rdai_to_priv(rdai)), \
770 						   playback, capture)
771 
772 /*
773  *	R-Car CMD
774  */
775 int rsnd_cmd_probe(struct rsnd_priv *priv);
776 void rsnd_cmd_remove(struct rsnd_priv *priv);
777 int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
778 
779 void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
780 #ifdef DEBUG
781 #define rsnd_mod_confirm_ssi(mssi)	rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
782 #define rsnd_mod_confirm_src(msrc)	rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
783 #define rsnd_mod_confirm_dvc(mdvc)	rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
784 #else
785 #define rsnd_mod_confirm_ssi(mssi)
786 #define rsnd_mod_confirm_src(msrc)
787 #define rsnd_mod_confirm_dvc(mdvc)
788 #endif
789 
790 /*
791  * If you don't need interrupt status debug message,
792  * define RSND_DEBUG_NO_IRQ_STATUS as 1 on top of src.c/ssi.c
793  *
794  * #define RSND_DEBUG_NO_IRQ_STATUS 1
795  */
796 #define rsnd_dbg_irq_status(dev, param...)		\
797 	if (!IS_BUILTIN(RSND_DEBUG_NO_IRQ_STATUS))	\
798 		dev_dbg(dev, param)
799 
800 /*
801  * If you don't need rsnd_dai_call debug message,
802  * define RSND_DEBUG_NO_DAI_CALL as 1 on top of core.c
803  *
804  * #define RSND_DEBUG_NO_DAI_CALL 1
805  */
806 #define rsnd_dbg_dai_call(dev, param...)		\
807 	if (!IS_BUILTIN(RSND_DEBUG_NO_DAI_CALL))	\
808 		dev_dbg(dev, param)
809 
810 #endif
811