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 	int (*prepare)(struct rsnd_mod *mod,
284 		       struct rsnd_dai_stream *io,
285 		       struct rsnd_priv *priv);
286 };
287 
288 struct rsnd_dai_stream;
289 struct rsnd_mod {
290 	int id;
291 	enum rsnd_mod_type type;
292 	struct rsnd_mod_ops *ops;
293 	struct rsnd_priv *priv;
294 	struct clk *clk;
295 	u32 *(*get_status)(struct rsnd_dai_stream *io,
296 			   struct rsnd_mod *mod,
297 			   enum rsnd_mod_type type);
298 	u32 status;
299 };
300 /*
301  * status
302  *
303  * 0xH0000CBA
304  *
305  * A	0: nolock_start	1: nolock_stop
306  * B	0: init		1: quit
307  * C	0: start	1: stop
308  *
309  * H is always called (see __rsnd_mod_call)
310  * H	0: probe	1: remove
311  * H	0: pcm_new
312  * H	0: fallback
313  * H	0: hw_params
314  * H	0: pointer
315  * H	0: prepare
316  */
317 #define __rsnd_mod_shift_nolock_start	0
318 #define __rsnd_mod_shift_nolock_stop	0
319 #define __rsnd_mod_shift_init		4
320 #define __rsnd_mod_shift_quit		4
321 #define __rsnd_mod_shift_start		8
322 #define __rsnd_mod_shift_stop		8
323 #define __rsnd_mod_shift_probe		28 /* always called */
324 #define __rsnd_mod_shift_remove		28 /* always called */
325 #define __rsnd_mod_shift_irq		28 /* always called */
326 #define __rsnd_mod_shift_pcm_new	28 /* always called */
327 #define __rsnd_mod_shift_fallback	28 /* always called */
328 #define __rsnd_mod_shift_hw_params	28 /* always called */
329 #define __rsnd_mod_shift_pointer	28 /* always called */
330 #define __rsnd_mod_shift_prepare	28 /* always called */
331 
332 #define __rsnd_mod_add_probe		0
333 #define __rsnd_mod_add_remove		0
334 #define __rsnd_mod_add_nolock_start	 1
335 #define __rsnd_mod_add_nolock_stop	-1
336 #define __rsnd_mod_add_init		 1
337 #define __rsnd_mod_add_quit		-1
338 #define __rsnd_mod_add_start		 1
339 #define __rsnd_mod_add_stop		-1
340 #define __rsnd_mod_add_irq		0
341 #define __rsnd_mod_add_pcm_new		0
342 #define __rsnd_mod_add_fallback		0
343 #define __rsnd_mod_add_hw_params	0
344 #define __rsnd_mod_add_pointer		0
345 #define __rsnd_mod_add_prepare		0
346 
347 #define __rsnd_mod_call_probe		0
348 #define __rsnd_mod_call_remove		0
349 #define __rsnd_mod_call_init		0
350 #define __rsnd_mod_call_quit		1
351 #define __rsnd_mod_call_start		0
352 #define __rsnd_mod_call_stop		1
353 #define __rsnd_mod_call_irq		0
354 #define __rsnd_mod_call_pcm_new		0
355 #define __rsnd_mod_call_fallback	0
356 #define __rsnd_mod_call_hw_params	0
357 #define __rsnd_mod_call_pointer		0
358 #define __rsnd_mod_call_nolock_start	0
359 #define __rsnd_mod_call_nolock_stop	1
360 #define __rsnd_mod_call_prepare		0
361 
362 #define rsnd_mod_to_priv(mod)	((mod)->priv)
363 #define rsnd_mod_name(mod)	((mod)->ops->name)
364 #define rsnd_mod_id(mod)	((mod)->id)
365 #define rsnd_mod_power_on(mod)	clk_enable((mod)->clk)
366 #define rsnd_mod_power_off(mod)	clk_disable((mod)->clk)
367 #define rsnd_mod_get(ip)	(&(ip)->mod)
368 
369 int rsnd_mod_init(struct rsnd_priv *priv,
370 		  struct rsnd_mod *mod,
371 		  struct rsnd_mod_ops *ops,
372 		  struct clk *clk,
373 		  u32* (*get_status)(struct rsnd_dai_stream *io,
374 				     struct rsnd_mod *mod,
375 				     enum rsnd_mod_type type),
376 		  enum rsnd_mod_type type,
377 		  int id);
378 void rsnd_mod_quit(struct rsnd_mod *mod);
379 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
380 				  struct rsnd_mod *mod);
381 void rsnd_mod_interrupt(struct rsnd_mod *mod,
382 			void (*callback)(struct rsnd_mod *mod,
383 					 struct rsnd_dai_stream *io));
384 u32 *rsnd_mod_get_status(struct rsnd_dai_stream *io,
385 			 struct rsnd_mod *mod,
386 			 enum rsnd_mod_type type);
387 struct rsnd_mod *rsnd_mod_next(int *iterator,
388 			       struct rsnd_dai_stream *io,
389 			       enum rsnd_mod_type *array,
390 			       int array_size);
391 #define for_each_rsnd_mod(iterator, pos, io)				\
392 	for (iterator = 0;						\
393 	     (pos = rsnd_mod_next(&iterator, io, NULL, 0)); iterator++)
394 #define for_each_rsnd_mod_arrays(iterator, pos, io, array, size)	\
395 	for (iterator = 0;						\
396 	     (pos = rsnd_mod_next(&iterator, io, array, size)); iterator++)
397 #define for_each_rsnd_mod_array(iterator, pos, io, array)		\
398 	for_each_rsnd_mod_arrays(iterator, pos, io, array, ARRAY_SIZE(array))
399 
400 void rsnd_parse_connect_common(struct rsnd_dai *rdai,
401 		struct rsnd_mod* (*mod_get)(struct rsnd_priv *priv, int id),
402 		struct device_node *node,
403 		struct device_node *playback,
404 		struct device_node *capture);
405 
406 #define rsnd_runtime_channel_original(io) \
407 	rsnd_runtime_channel_original_with_params(io, NULL)
408 int rsnd_runtime_channel_original_with_params(struct rsnd_dai_stream *io,
409 				struct snd_pcm_hw_params *params);
410 #define rsnd_runtime_channel_after_ctu(io)			\
411 	rsnd_runtime_channel_after_ctu_with_params(io, NULL)
412 int rsnd_runtime_channel_after_ctu_with_params(struct rsnd_dai_stream *io,
413 				struct snd_pcm_hw_params *params);
414 #define rsnd_runtime_channel_for_ssi(io) \
415 	rsnd_runtime_channel_for_ssi_with_params(io, NULL)
416 int rsnd_runtime_channel_for_ssi_with_params(struct rsnd_dai_stream *io,
417 				 struct snd_pcm_hw_params *params);
418 int rsnd_runtime_is_ssi_multi(struct rsnd_dai_stream *io);
419 int rsnd_runtime_is_ssi_tdm(struct rsnd_dai_stream *io);
420 
421 /*
422  * DT
423  */
424 #define rsnd_parse_of_node(priv, node)					\
425 	of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, node)
426 #define RSND_NODE_DAI	"rcar_sound,dai"
427 #define RSND_NODE_SSI	"rcar_sound,ssi"
428 #define RSND_NODE_SRC	"rcar_sound,src"
429 #define RSND_NODE_CTU	"rcar_sound,ctu"
430 #define RSND_NODE_MIX	"rcar_sound,mix"
431 #define RSND_NODE_DVC	"rcar_sound,dvc"
432 
433 /*
434  *	R-Car sound DAI
435  */
436 #define RSND_DAI_NAME_SIZE	16
437 struct rsnd_dai_stream {
438 	char name[RSND_DAI_NAME_SIZE];
439 	struct snd_pcm_substream *substream;
440 	struct rsnd_mod *mod[RSND_MOD_MAX];
441 	struct rsnd_dai *rdai;
442 	struct device *dmac_dev; /* for IPMMU */
443 	u32 parent_ssi_status;
444 };
445 #define rsnd_io_to_mod(io, i)	((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
446 #define rsnd_io_to_mod_ssi(io)	rsnd_io_to_mod((io), RSND_MOD_SSI)
447 #define rsnd_io_to_mod_ssiu(io)	rsnd_io_to_mod((io), RSND_MOD_SSIU)
448 #define rsnd_io_to_mod_ssip(io)	rsnd_io_to_mod((io), RSND_MOD_SSIP)
449 #define rsnd_io_to_mod_src(io)	rsnd_io_to_mod((io), RSND_MOD_SRC)
450 #define rsnd_io_to_mod_ctu(io)	rsnd_io_to_mod((io), RSND_MOD_CTU)
451 #define rsnd_io_to_mod_mix(io)	rsnd_io_to_mod((io), RSND_MOD_MIX)
452 #define rsnd_io_to_mod_dvc(io)	rsnd_io_to_mod((io), RSND_MOD_DVC)
453 #define rsnd_io_to_mod_cmd(io)	rsnd_io_to_mod((io), RSND_MOD_CMD)
454 #define rsnd_io_to_rdai(io)	((io)->rdai)
455 #define rsnd_io_to_priv(io)	(rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
456 #define rsnd_io_is_play(io)	(&rsnd_io_to_rdai(io)->playback == io)
457 #define rsnd_io_to_runtime(io) ((io)->substream ? \
458 				(io)->substream->runtime : NULL)
459 int rsnd_io_is_working(struct rsnd_dai_stream *io);
460 
461 struct rsnd_dai {
462 	char name[RSND_DAI_NAME_SIZE];
463 	struct rsnd_dai_stream playback;
464 	struct rsnd_dai_stream capture;
465 	struct rsnd_priv *priv;
466 	struct snd_pcm_hw_constraint_list constraint;
467 
468 	int max_channels;	/* 2ch - 16ch */
469 	int ssi_lane;		/* 1lane - 4lane */
470 
471 	unsigned int clk_master:1;
472 	unsigned int bit_clk_inv:1;
473 	unsigned int frm_clk_inv:1;
474 	unsigned int sys_delay:1;
475 	unsigned int data_alignment:1;
476 };
477 
478 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
479 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
480 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
481 #define for_each_rsnd_dai(rdai, priv, i)		\
482 	for (i = 0;					\
483 	     (i < rsnd_rdai_nr(priv)) &&		\
484 	     ((rdai) = rsnd_rdai_get(priv, i));		\
485 	     i++)
486 
487 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
488 
489 #define rsnd_rdai_channels_set(rdai, max_channels) \
490 	rsnd_rdai_channels_ctrl(rdai, max_channels)
491 #define rsnd_rdai_channels_get(rdai) \
492 	rsnd_rdai_channels_ctrl(rdai, 0)
493 int rsnd_rdai_channels_ctrl(struct rsnd_dai *rdai,
494 			    int max_channels);
495 
496 #define rsnd_rdai_ssi_lane_set(rdai, ssi_lane) \
497 	rsnd_rdai_ssi_lane_ctrl(rdai, ssi_lane)
498 #define rsnd_rdai_ssi_lane_get(rdai) \
499 	rsnd_rdai_ssi_lane_ctrl(rdai, 0)
500 int rsnd_rdai_ssi_lane_ctrl(struct rsnd_dai *rdai,
501 			    int ssi_lane);
502 
503 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
504 int rsnd_dai_connect(struct rsnd_mod *mod,
505 		     struct rsnd_dai_stream *io,
506 		     enum rsnd_mod_type type);
507 
508 /*
509  *	R-Car Gen1/Gen2
510  */
511 int rsnd_gen_probe(struct rsnd_priv *priv);
512 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
513 			       struct rsnd_mod *mod,
514 			       enum rsnd_reg reg);
515 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
516 
517 /*
518  *	R-Car ADG
519  */
520 int rsnd_adg_clk_query(struct rsnd_priv *priv, unsigned int rate);
521 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
522 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
523 int rsnd_adg_probe(struct rsnd_priv *priv);
524 void rsnd_adg_remove(struct rsnd_priv *priv);
525 int rsnd_adg_set_src_timesel_gen2(struct rsnd_mod *src_mod,
526 				  struct rsnd_dai_stream *io,
527 				  unsigned int in_rate,
528 				  unsigned int out_rate);
529 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
530 				 struct rsnd_dai_stream *io);
531 #define rsnd_adg_clk_enable(priv)	rsnd_adg_clk_control(priv, 1)
532 #define rsnd_adg_clk_disable(priv)	rsnd_adg_clk_control(priv, 0)
533 void rsnd_adg_clk_control(struct rsnd_priv *priv, int enable);
534 
535 /*
536  *	R-Car sound priv
537  */
538 struct rsnd_priv {
539 
540 	struct platform_device *pdev;
541 	spinlock_t lock;
542 	unsigned long flags;
543 #define RSND_GEN_MASK	(0xF << 0)
544 #define RSND_GEN1	(1 << 0)
545 #define RSND_GEN2	(2 << 0)
546 #define RSND_GEN3	(3 << 0)
547 
548 	/*
549 	 * below value will be filled on rsnd_gen_probe()
550 	 */
551 	void *gen;
552 
553 	/*
554 	 * below value will be filled on rsnd_adg_probe()
555 	 */
556 	void *adg;
557 
558 	/*
559 	 * below value will be filled on rsnd_dma_probe()
560 	 */
561 	void *dma;
562 
563 	/*
564 	 * below value will be filled on rsnd_ssi_probe()
565 	 */
566 	void *ssi;
567 	int ssi_nr;
568 
569 	/*
570 	 * below value will be filled on rsnd_ssiu_probe()
571 	 */
572 	void *ssiu;
573 	int ssiu_nr;
574 
575 	/*
576 	 * below value will be filled on rsnd_src_probe()
577 	 */
578 	void *src;
579 	int src_nr;
580 
581 	/*
582 	 * below value will be filled on rsnd_ctu_probe()
583 	 */
584 	void *ctu;
585 	int ctu_nr;
586 
587 	/*
588 	 * below value will be filled on rsnd_mix_probe()
589 	 */
590 	void *mix;
591 	int mix_nr;
592 
593 	/*
594 	 * below value will be filled on rsnd_dvc_probe()
595 	 */
596 	void *dvc;
597 	int dvc_nr;
598 
599 	/*
600 	 * below value will be filled on rsnd_cmd_probe()
601 	 */
602 	void *cmd;
603 	int cmd_nr;
604 
605 	/*
606 	 * below value will be filled on rsnd_dai_probe()
607 	 */
608 	struct snd_soc_dai_driver *daidrv;
609 	struct rsnd_dai *rdai;
610 	int rdai_nr;
611 };
612 
613 #define rsnd_priv_to_pdev(priv)	((priv)->pdev)
614 #define rsnd_priv_to_dev(priv)	(&(rsnd_priv_to_pdev(priv)->dev))
615 
616 #define rsnd_is_gen1(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
617 #define rsnd_is_gen2(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
618 #define rsnd_is_gen3(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN3)
619 
620 #define rsnd_flags_has(p, f) ((p)->flags & (f))
621 #define rsnd_flags_set(p, f) ((p)->flags |= (f))
622 #define rsnd_flags_del(p, f) ((p)->flags &= ~(f))
623 
624 /*
625  *	rsnd_kctrl
626  */
627 struct rsnd_kctrl_cfg {
628 	unsigned int max;
629 	unsigned int size;
630 	u32 *val;
631 	const char * const *texts;
632 	int (*accept)(struct rsnd_dai_stream *io);
633 	void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
634 	struct rsnd_dai_stream *io;
635 	struct snd_card *card;
636 	struct snd_kcontrol *kctrl;
637 	struct rsnd_mod *mod;
638 };
639 
640 #define RSND_MAX_CHANNELS	8
641 struct rsnd_kctrl_cfg_m {
642 	struct rsnd_kctrl_cfg cfg;
643 	u32 val[RSND_MAX_CHANNELS];
644 };
645 
646 struct rsnd_kctrl_cfg_s {
647 	struct rsnd_kctrl_cfg cfg;
648 	u32 val;
649 };
650 #define rsnd_kctrl_size(x)	((x).cfg.size)
651 #define rsnd_kctrl_max(x)	((x).cfg.max)
652 #define rsnd_kctrl_valm(x, i)	((x).val[i])	/* = (x).cfg.val[i] */
653 #define rsnd_kctrl_vals(x)	((x).val)	/* = (x).cfg.val[0] */
654 
655 int rsnd_kctrl_accept_anytime(struct rsnd_dai_stream *io);
656 int rsnd_kctrl_accept_runtime(struct rsnd_dai_stream *io);
657 struct rsnd_kctrl_cfg *rsnd_kctrl_init_m(struct rsnd_kctrl_cfg_m *cfg);
658 struct rsnd_kctrl_cfg *rsnd_kctrl_init_s(struct rsnd_kctrl_cfg_s *cfg);
659 int rsnd_kctrl_new(struct rsnd_mod *mod,
660 		   struct rsnd_dai_stream *io,
661 		   struct snd_soc_pcm_runtime *rtd,
662 		   const unsigned char *name,
663 		   int (*accept)(struct rsnd_dai_stream *io),
664 		   void (*update)(struct rsnd_dai_stream *io,
665 				  struct rsnd_mod *mod),
666 		   struct rsnd_kctrl_cfg *cfg,
667 		   const char * const *texts,
668 		   int size,
669 		   u32 max);
670 
671 #define rsnd_kctrl_new_m(mod, io, rtd, name, accept, update, cfg, size, max) \
672 	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_m(cfg), \
673 		       NULL, size, max)
674 
675 #define rsnd_kctrl_new_s(mod, io, rtd, name, accept, update, cfg, max)	\
676 	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
677 		       NULL, 1, max)
678 
679 #define rsnd_kctrl_new_e(mod, io, rtd, name, accept, update, cfg, texts, size) \
680 	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
681 		       texts, 1, size)
682 
683 extern const char * const volume_ramp_rate[];
684 #define VOLUME_RAMP_MAX_DVC	(0x17 + 1)
685 #define VOLUME_RAMP_MAX_MIX	(0x0a + 1)
686 
687 /*
688  *	R-Car SSI
689  */
690 int rsnd_ssi_probe(struct rsnd_priv *priv);
691 void rsnd_ssi_remove(struct rsnd_priv *priv);
692 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
693 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
694 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
695 u32 rsnd_ssi_multi_slaves_runtime(struct rsnd_dai_stream *io);
696 
697 #define RSND_SSI_HDMI_PORT0	0xf0
698 #define RSND_SSI_HDMI_PORT1	0xf1
699 int rsnd_ssi_hdmi_port(struct rsnd_dai_stream *io);
700 void rsnd_ssi_parse_hdmi_connection(struct rsnd_priv *priv,
701 				    struct device_node *endpoint,
702 				    int dai_i);
703 
704 #define rsnd_ssi_is_pin_sharing(io)	\
705 	__rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
706 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
707 
708 #define rsnd_ssi_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSI)
709 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
710 			    struct device_node *playback,
711 			    struct device_node *capture);
712 unsigned int rsnd_ssi_clk_query(struct rsnd_priv *priv,
713 		       int param1, int param2, int *idx);
714 
715 /*
716  *	R-Car SSIU
717  */
718 int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
719 		     struct rsnd_mod *mod);
720 int rsnd_ssiu_probe(struct rsnd_priv *priv);
721 void rsnd_ssiu_remove(struct rsnd_priv *priv);
722 
723 /*
724  *	R-Car SRC
725  */
726 int rsnd_src_probe(struct rsnd_priv *priv);
727 void rsnd_src_remove(struct rsnd_priv *priv);
728 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
729 
730 #define rsnd_src_get_in_rate(priv, io) rsnd_src_get_rate(priv, io, 1)
731 #define rsnd_src_get_out_rate(priv, io) rsnd_src_get_rate(priv, io, 0)
732 unsigned int rsnd_src_get_rate(struct rsnd_priv *priv,
733 			       struct rsnd_dai_stream *io,
734 			       int is_in);
735 
736 #define rsnd_src_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SRC)
737 #define rsnd_parse_connect_src(rdai, playback, capture)			\
738 	rsnd_parse_connect_common(rdai, rsnd_src_mod_get,		\
739 				  rsnd_src_of_node(rsnd_rdai_to_priv(rdai)), \
740 						   playback, capture)
741 
742 /*
743  *	R-Car CTU
744  */
745 int rsnd_ctu_probe(struct rsnd_priv *priv);
746 void rsnd_ctu_remove(struct rsnd_priv *priv);
747 int rsnd_ctu_converted_channel(struct rsnd_mod *mod);
748 struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
749 #define rsnd_ctu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_CTU)
750 #define rsnd_parse_connect_ctu(rdai, playback, capture)			\
751 	rsnd_parse_connect_common(rdai, rsnd_ctu_mod_get,		\
752 				  rsnd_ctu_of_node(rsnd_rdai_to_priv(rdai)), \
753 						   playback, capture)
754 
755 /*
756  *	R-Car MIX
757  */
758 int rsnd_mix_probe(struct rsnd_priv *priv);
759 void rsnd_mix_remove(struct rsnd_priv *priv);
760 struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
761 #define rsnd_mix_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_MIX)
762 #define rsnd_parse_connect_mix(rdai, playback, capture)			\
763 	rsnd_parse_connect_common(rdai, rsnd_mix_mod_get,		\
764 				  rsnd_mix_of_node(rsnd_rdai_to_priv(rdai)), \
765 						   playback, capture)
766 
767 /*
768  *	R-Car DVC
769  */
770 int rsnd_dvc_probe(struct rsnd_priv *priv);
771 void rsnd_dvc_remove(struct rsnd_priv *priv);
772 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
773 #define rsnd_dvc_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_DVC)
774 #define rsnd_parse_connect_dvc(rdai, playback, capture)			\
775 	rsnd_parse_connect_common(rdai, rsnd_dvc_mod_get,		\
776 				  rsnd_dvc_of_node(rsnd_rdai_to_priv(rdai)), \
777 						   playback, capture)
778 
779 /*
780  *	R-Car CMD
781  */
782 int rsnd_cmd_probe(struct rsnd_priv *priv);
783 void rsnd_cmd_remove(struct rsnd_priv *priv);
784 int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
785 
786 void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
787 #ifdef DEBUG
788 #define rsnd_mod_confirm_ssi(mssi)	rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
789 #define rsnd_mod_confirm_src(msrc)	rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
790 #define rsnd_mod_confirm_dvc(mdvc)	rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
791 #else
792 #define rsnd_mod_confirm_ssi(mssi)
793 #define rsnd_mod_confirm_src(msrc)
794 #define rsnd_mod_confirm_dvc(mdvc)
795 #endif
796 
797 /*
798  * If you don't need interrupt status debug message,
799  * define RSND_DEBUG_NO_IRQ_STATUS as 1 on top of src.c/ssi.c
800  *
801  * #define RSND_DEBUG_NO_IRQ_STATUS 1
802  */
803 #define rsnd_dbg_irq_status(dev, param...)		\
804 	if (!IS_BUILTIN(RSND_DEBUG_NO_IRQ_STATUS))	\
805 		dev_dbg(dev, param)
806 
807 /*
808  * If you don't need rsnd_dai_call debug message,
809  * define RSND_DEBUG_NO_DAI_CALL as 1 on top of core.c
810  *
811  * #define RSND_DEBUG_NO_DAI_CALL 1
812  */
813 #define rsnd_dbg_dai_call(dev, param...)		\
814 	if (!IS_BUILTIN(RSND_DEBUG_NO_DAI_CALL))	\
815 		dev_dbg(dev, param)
816 
817 #endif
818