xref: /openbmc/linux/sound/soc/sh/rcar/rsnd.h (revision e3d786a3)
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_BUSIF0_MODE,
160 	RSND_REG_SSI_BUSIF0_ADINR,
161 	RSND_REG_SSI_BUSIF0_DALIGN,
162 	RSND_REG_SSI_BUSIF1_MODE,
163 	RSND_REG_SSI_BUSIF1_ADINR,
164 	RSND_REG_SSI_BUSIF1_DALIGN,
165 	RSND_REG_SSI_BUSIF2_MODE,
166 	RSND_REG_SSI_BUSIF2_ADINR,
167 	RSND_REG_SSI_BUSIF2_DALIGN,
168 	RSND_REG_SSI_BUSIF3_MODE,
169 	RSND_REG_SSI_BUSIF3_ADINR,
170 	RSND_REG_SSI_BUSIF3_DALIGN,
171 	RSND_REG_SSI_BUSIF4_MODE,
172 	RSND_REG_SSI_BUSIF4_ADINR,
173 	RSND_REG_SSI_BUSIF4_DALIGN,
174 	RSND_REG_SSI_BUSIF5_MODE,
175 	RSND_REG_SSI_BUSIF5_ADINR,
176 	RSND_REG_SSI_BUSIF5_DALIGN,
177 	RSND_REG_SSI_BUSIF6_MODE,
178 	RSND_REG_SSI_BUSIF6_ADINR,
179 	RSND_REG_SSI_BUSIF6_DALIGN,
180 	RSND_REG_SSI_BUSIF7_MODE,
181 	RSND_REG_SSI_BUSIF7_ADINR,
182 	RSND_REG_SSI_BUSIF7_DALIGN,
183 	RSND_REG_SSI_INT_ENABLE,
184 	RSND_REG_SSI_SYS_STATUS0,
185 	RSND_REG_SSI_SYS_STATUS1,
186 	RSND_REG_SSI_SYS_STATUS2,
187 	RSND_REG_SSI_SYS_STATUS3,
188 	RSND_REG_SSI_SYS_STATUS4,
189 	RSND_REG_SSI_SYS_STATUS5,
190 	RSND_REG_SSI_SYS_STATUS6,
191 	RSND_REG_SSI_SYS_STATUS7,
192 	RSND_REG_HDMI0_SEL,
193 	RSND_REG_HDMI1_SEL,
194 
195 	/* SSI */
196 	RSND_REG_SSICR,
197 	RSND_REG_SSISR,
198 	RSND_REG_SSITDR,
199 	RSND_REG_SSIRDR,
200 	RSND_REG_SSIWSR,
201 
202 	RSND_REG_MAX,
203 };
204 
205 struct rsnd_priv;
206 struct rsnd_mod;
207 struct rsnd_dai;
208 struct rsnd_dai_stream;
209 
210 /*
211  *	R-Car basic functions
212  */
213 #define rsnd_mod_read(m, r) \
214 	rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
215 #define rsnd_mod_write(m, r, d) \
216 	rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
217 #define rsnd_mod_bset(m, r, s, d) \
218 	rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
219 
220 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
221 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
222 		enum rsnd_reg reg, u32 data);
223 void rsnd_force_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
224 		enum rsnd_reg reg, u32 data);
225 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
226 		    u32 mask, u32 data);
227 u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
228 u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
229 u32 rsnd_get_busif_shift(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
230 
231 /*
232  *	R-Car DMA
233  */
234 int rsnd_dma_attach(struct rsnd_dai_stream *io,
235 		    struct rsnd_mod *mod, struct rsnd_mod **dma_mod);
236 int rsnd_dma_probe(struct rsnd_priv *priv);
237 struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node,
238 					  struct rsnd_mod *mod, char *name);
239 
240 /*
241  *	R-Car sound mod
242  */
243 enum rsnd_mod_type {
244 	RSND_MOD_AUDMAPP,
245 	RSND_MOD_AUDMA,
246 	RSND_MOD_DVC,
247 	RSND_MOD_MIX,
248 	RSND_MOD_CTU,
249 	RSND_MOD_CMD,
250 	RSND_MOD_SRC,
251 	RSND_MOD_SSIM3,		/* SSI multi 3 */
252 	RSND_MOD_SSIM2,		/* SSI multi 2 */
253 	RSND_MOD_SSIM1,		/* SSI multi 1 */
254 	RSND_MOD_SSIP,		/* SSI parent */
255 	RSND_MOD_SSI,
256 	RSND_MOD_SSIU,
257 	RSND_MOD_MAX,
258 };
259 
260 struct rsnd_mod_ops {
261 	char *name;
262 	struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
263 				    struct rsnd_mod *mod);
264 	int (*probe)(struct rsnd_mod *mod,
265 		     struct rsnd_dai_stream *io,
266 		     struct rsnd_priv *priv);
267 	int (*remove)(struct rsnd_mod *mod,
268 		      struct rsnd_dai_stream *io,
269 		      struct rsnd_priv *priv);
270 	int (*init)(struct rsnd_mod *mod,
271 		    struct rsnd_dai_stream *io,
272 		    struct rsnd_priv *priv);
273 	int (*quit)(struct rsnd_mod *mod,
274 		    struct rsnd_dai_stream *io,
275 		    struct rsnd_priv *priv);
276 	int (*start)(struct rsnd_mod *mod,
277 		     struct rsnd_dai_stream *io,
278 		     struct rsnd_priv *priv);
279 	int (*stop)(struct rsnd_mod *mod,
280 		    struct rsnd_dai_stream *io,
281 		    struct rsnd_priv *priv);
282 	int (*irq)(struct rsnd_mod *mod,
283 		   struct rsnd_dai_stream *io,
284 		   struct rsnd_priv *priv, int enable);
285 	int (*pcm_new)(struct rsnd_mod *mod,
286 		       struct rsnd_dai_stream *io,
287 		       struct snd_soc_pcm_runtime *rtd);
288 	int (*hw_params)(struct rsnd_mod *mod,
289 			 struct rsnd_dai_stream *io,
290 			 struct snd_pcm_substream *substream,
291 			 struct snd_pcm_hw_params *hw_params);
292 	int (*pointer)(struct rsnd_mod *mod,
293 		       struct rsnd_dai_stream *io,
294 		       snd_pcm_uframes_t *pointer);
295 	int (*fallback)(struct rsnd_mod *mod,
296 			struct rsnd_dai_stream *io,
297 			struct rsnd_priv *priv);
298 	int (*prepare)(struct rsnd_mod *mod,
299 		       struct rsnd_dai_stream *io,
300 		       struct rsnd_priv *priv);
301 	int (*cleanup)(struct rsnd_mod *mod,
302 		       struct rsnd_dai_stream *io,
303 		       struct rsnd_priv *priv);
304 };
305 
306 struct rsnd_dai_stream;
307 struct rsnd_mod {
308 	int id;
309 	enum rsnd_mod_type type;
310 	struct rsnd_mod_ops *ops;
311 	struct rsnd_priv *priv;
312 	struct clk *clk;
313 	u32 *(*get_status)(struct rsnd_dai_stream *io,
314 			   struct rsnd_mod *mod,
315 			   enum rsnd_mod_type type);
316 	u32 status;
317 };
318 /*
319  * status
320  *
321  * 0xH0000CB0
322  *
323  * B	0: init		1: quit
324  * C	0: start	1: stop
325  *
326  * H is always called (see __rsnd_mod_call)
327  * H	0: probe	1: remove
328  * H	0: pcm_new
329  * H	0: fallback
330  * H	0: hw_params
331  * H	0: pointer
332  * H	0: prepare
333  * H	0: cleanup
334  */
335 #define __rsnd_mod_shift_init		4
336 #define __rsnd_mod_shift_quit		4
337 #define __rsnd_mod_shift_start		8
338 #define __rsnd_mod_shift_stop		8
339 #define __rsnd_mod_shift_probe		28 /* always called */
340 #define __rsnd_mod_shift_remove		28 /* always called */
341 #define __rsnd_mod_shift_irq		28 /* always called */
342 #define __rsnd_mod_shift_pcm_new	28 /* always called */
343 #define __rsnd_mod_shift_fallback	28 /* always called */
344 #define __rsnd_mod_shift_hw_params	28 /* always called */
345 #define __rsnd_mod_shift_pointer	28 /* always called */
346 #define __rsnd_mod_shift_prepare	28 /* always called */
347 #define __rsnd_mod_shift_cleanup	28 /* always called */
348 
349 #define __rsnd_mod_add_probe		0
350 #define __rsnd_mod_add_remove		0
351 #define __rsnd_mod_add_prepare		0
352 #define __rsnd_mod_add_cleanup		0
353 #define __rsnd_mod_add_init		 1
354 #define __rsnd_mod_add_quit		-1
355 #define __rsnd_mod_add_start		 1
356 #define __rsnd_mod_add_stop		-1
357 #define __rsnd_mod_add_irq		0
358 #define __rsnd_mod_add_pcm_new		0
359 #define __rsnd_mod_add_fallback		0
360 #define __rsnd_mod_add_hw_params	0
361 #define __rsnd_mod_add_pointer		0
362 
363 #define __rsnd_mod_call_probe		0
364 #define __rsnd_mod_call_remove		0
365 #define __rsnd_mod_call_prepare		0
366 #define __rsnd_mod_call_cleanup		0
367 #define __rsnd_mod_call_init		0
368 #define __rsnd_mod_call_quit		1
369 #define __rsnd_mod_call_start		0
370 #define __rsnd_mod_call_stop		1
371 #define __rsnd_mod_call_irq		0
372 #define __rsnd_mod_call_pcm_new		0
373 #define __rsnd_mod_call_fallback	0
374 #define __rsnd_mod_call_hw_params	0
375 #define __rsnd_mod_call_pointer		0
376 
377 #define rsnd_mod_to_priv(mod)	((mod)->priv)
378 #define rsnd_mod_name(mod)	((mod)->ops->name)
379 #define rsnd_mod_id(mod)	((mod)->id)
380 #define rsnd_mod_power_on(mod)	clk_enable((mod)->clk)
381 #define rsnd_mod_power_off(mod)	clk_disable((mod)->clk)
382 #define rsnd_mod_get(ip)	(&(ip)->mod)
383 
384 int rsnd_mod_init(struct rsnd_priv *priv,
385 		  struct rsnd_mod *mod,
386 		  struct rsnd_mod_ops *ops,
387 		  struct clk *clk,
388 		  u32* (*get_status)(struct rsnd_dai_stream *io,
389 				     struct rsnd_mod *mod,
390 				     enum rsnd_mod_type type),
391 		  enum rsnd_mod_type type,
392 		  int id);
393 void rsnd_mod_quit(struct rsnd_mod *mod);
394 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
395 				  struct rsnd_mod *mod);
396 void rsnd_mod_interrupt(struct rsnd_mod *mod,
397 			void (*callback)(struct rsnd_mod *mod,
398 					 struct rsnd_dai_stream *io));
399 u32 *rsnd_mod_get_status(struct rsnd_dai_stream *io,
400 			 struct rsnd_mod *mod,
401 			 enum rsnd_mod_type type);
402 struct rsnd_mod *rsnd_mod_next(int *iterator,
403 			       struct rsnd_dai_stream *io,
404 			       enum rsnd_mod_type *array,
405 			       int array_size);
406 #define for_each_rsnd_mod(iterator, pos, io)				\
407 	for (iterator = 0;						\
408 	     (pos = rsnd_mod_next(&iterator, io, NULL, 0)); iterator++)
409 #define for_each_rsnd_mod_arrays(iterator, pos, io, array, size)	\
410 	for (iterator = 0;						\
411 	     (pos = rsnd_mod_next(&iterator, io, array, size)); iterator++)
412 #define for_each_rsnd_mod_array(iterator, pos, io, array)		\
413 	for_each_rsnd_mod_arrays(iterator, pos, io, array, ARRAY_SIZE(array))
414 
415 void rsnd_parse_connect_common(struct rsnd_dai *rdai,
416 		struct rsnd_mod* (*mod_get)(struct rsnd_priv *priv, int id),
417 		struct device_node *node,
418 		struct device_node *playback,
419 		struct device_node *capture);
420 
421 #define rsnd_runtime_channel_original(io) \
422 	rsnd_runtime_channel_original_with_params(io, NULL)
423 int rsnd_runtime_channel_original_with_params(struct rsnd_dai_stream *io,
424 				struct snd_pcm_hw_params *params);
425 #define rsnd_runtime_channel_after_ctu(io)			\
426 	rsnd_runtime_channel_after_ctu_with_params(io, NULL)
427 int rsnd_runtime_channel_after_ctu_with_params(struct rsnd_dai_stream *io,
428 				struct snd_pcm_hw_params *params);
429 #define rsnd_runtime_channel_for_ssi(io) \
430 	rsnd_runtime_channel_for_ssi_with_params(io, NULL)
431 int rsnd_runtime_channel_for_ssi_with_params(struct rsnd_dai_stream *io,
432 				 struct snd_pcm_hw_params *params);
433 int rsnd_runtime_is_ssi_multi(struct rsnd_dai_stream *io);
434 int rsnd_runtime_is_ssi_tdm(struct rsnd_dai_stream *io);
435 
436 /*
437  * DT
438  */
439 #define rsnd_parse_of_node(priv, node)					\
440 	of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, node)
441 #define RSND_NODE_DAI	"rcar_sound,dai"
442 #define RSND_NODE_SSI	"rcar_sound,ssi"
443 #define RSND_NODE_SRC	"rcar_sound,src"
444 #define RSND_NODE_CTU	"rcar_sound,ctu"
445 #define RSND_NODE_MIX	"rcar_sound,mix"
446 #define RSND_NODE_DVC	"rcar_sound,dvc"
447 
448 /*
449  *	R-Car sound DAI
450  */
451 #define RSND_DAI_NAME_SIZE	16
452 struct rsnd_dai_stream {
453 	char name[RSND_DAI_NAME_SIZE];
454 	struct snd_pcm_substream *substream;
455 	struct rsnd_mod *mod[RSND_MOD_MAX];
456 	struct rsnd_mod *dma;
457 	struct rsnd_dai *rdai;
458 	struct device *dmac_dev; /* for IPMMU */
459 	u32 parent_ssi_status;
460 };
461 #define rsnd_io_to_mod(io, i)	((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
462 #define rsnd_io_to_mod_ssi(io)	rsnd_io_to_mod((io), RSND_MOD_SSI)
463 #define rsnd_io_to_mod_ssiu(io)	rsnd_io_to_mod((io), RSND_MOD_SSIU)
464 #define rsnd_io_to_mod_ssip(io)	rsnd_io_to_mod((io), RSND_MOD_SSIP)
465 #define rsnd_io_to_mod_src(io)	rsnd_io_to_mod((io), RSND_MOD_SRC)
466 #define rsnd_io_to_mod_ctu(io)	rsnd_io_to_mod((io), RSND_MOD_CTU)
467 #define rsnd_io_to_mod_mix(io)	rsnd_io_to_mod((io), RSND_MOD_MIX)
468 #define rsnd_io_to_mod_dvc(io)	rsnd_io_to_mod((io), RSND_MOD_DVC)
469 #define rsnd_io_to_mod_cmd(io)	rsnd_io_to_mod((io), RSND_MOD_CMD)
470 #define rsnd_io_to_rdai(io)	((io)->rdai)
471 #define rsnd_io_to_priv(io)	(rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
472 #define rsnd_io_is_play(io)	(&rsnd_io_to_rdai(io)->playback == io)
473 #define rsnd_io_to_runtime(io) ((io)->substream ? \
474 				(io)->substream->runtime : NULL)
475 int rsnd_io_is_working(struct rsnd_dai_stream *io);
476 
477 struct rsnd_dai {
478 	char name[RSND_DAI_NAME_SIZE];
479 	struct rsnd_dai_stream playback;
480 	struct rsnd_dai_stream capture;
481 	struct rsnd_priv *priv;
482 	struct snd_pcm_hw_constraint_list constraint;
483 
484 	int max_channels;	/* 2ch - 16ch */
485 	int ssi_lane;		/* 1lane - 4lane */
486 	int chan_width;		/* 16/24/32 bit width */
487 
488 	unsigned int clk_master:1;
489 	unsigned int bit_clk_inv:1;
490 	unsigned int frm_clk_inv:1;
491 	unsigned int sys_delay:1;
492 	unsigned int data_alignment:1;
493 };
494 
495 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
496 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
497 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
498 #define for_each_rsnd_dai(rdai, priv, i)		\
499 	for (i = 0;					\
500 	     (i < rsnd_rdai_nr(priv)) &&		\
501 	     ((rdai) = rsnd_rdai_get(priv, i));		\
502 	     i++)
503 
504 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
505 
506 #define rsnd_rdai_channels_set(rdai, max_channels) \
507 	rsnd_rdai_channels_ctrl(rdai, max_channels)
508 #define rsnd_rdai_channels_get(rdai) \
509 	rsnd_rdai_channels_ctrl(rdai, 0)
510 int rsnd_rdai_channels_ctrl(struct rsnd_dai *rdai,
511 			    int max_channels);
512 
513 #define rsnd_rdai_ssi_lane_set(rdai, ssi_lane) \
514 	rsnd_rdai_ssi_lane_ctrl(rdai, ssi_lane)
515 #define rsnd_rdai_ssi_lane_get(rdai) \
516 	rsnd_rdai_ssi_lane_ctrl(rdai, 0)
517 int rsnd_rdai_ssi_lane_ctrl(struct rsnd_dai *rdai,
518 			    int ssi_lane);
519 
520 #define rsnd_rdai_width_set(rdai, width) \
521 	rsnd_rdai_width_ctrl(rdai, width)
522 #define rsnd_rdai_width_get(rdai) \
523 	rsnd_rdai_width_ctrl(rdai, 0)
524 int rsnd_rdai_width_ctrl(struct rsnd_dai *rdai, int width);
525 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
526 int rsnd_dai_connect(struct rsnd_mod *mod,
527 		     struct rsnd_dai_stream *io,
528 		     enum rsnd_mod_type type);
529 
530 /*
531  *	R-Car Gen1/Gen2
532  */
533 int rsnd_gen_probe(struct rsnd_priv *priv);
534 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
535 			       struct rsnd_mod *mod,
536 			       enum rsnd_reg reg);
537 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
538 
539 /*
540  *	R-Car ADG
541  */
542 int rsnd_adg_clk_query(struct rsnd_priv *priv, unsigned int rate);
543 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
544 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
545 int rsnd_adg_probe(struct rsnd_priv *priv);
546 void rsnd_adg_remove(struct rsnd_priv *priv);
547 int rsnd_adg_set_src_timesel_gen2(struct rsnd_mod *src_mod,
548 				  struct rsnd_dai_stream *io,
549 				  unsigned int in_rate,
550 				  unsigned int out_rate);
551 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
552 				 struct rsnd_dai_stream *io);
553 #define rsnd_adg_clk_enable(priv)	rsnd_adg_clk_control(priv, 1)
554 #define rsnd_adg_clk_disable(priv)	rsnd_adg_clk_control(priv, 0)
555 void rsnd_adg_clk_control(struct rsnd_priv *priv, int enable);
556 
557 /*
558  *	R-Car sound priv
559  */
560 struct rsnd_priv {
561 
562 	struct platform_device *pdev;
563 	spinlock_t lock;
564 	unsigned long flags;
565 #define RSND_GEN_MASK	(0xF << 0)
566 #define RSND_GEN1	(1 << 0)
567 #define RSND_GEN2	(2 << 0)
568 #define RSND_GEN3	(3 << 0)
569 
570 	/*
571 	 * below value will be filled on rsnd_gen_probe()
572 	 */
573 	void *gen;
574 
575 	/*
576 	 * below value will be filled on rsnd_adg_probe()
577 	 */
578 	void *adg;
579 
580 	/*
581 	 * below value will be filled on rsnd_dma_probe()
582 	 */
583 	void *dma;
584 
585 	/*
586 	 * below value will be filled on rsnd_ssi_probe()
587 	 */
588 	void *ssi;
589 	int ssi_nr;
590 
591 	/*
592 	 * below value will be filled on rsnd_ssiu_probe()
593 	 */
594 	void *ssiu;
595 	int ssiu_nr;
596 
597 	/*
598 	 * below value will be filled on rsnd_src_probe()
599 	 */
600 	void *src;
601 	int src_nr;
602 
603 	/*
604 	 * below value will be filled on rsnd_ctu_probe()
605 	 */
606 	void *ctu;
607 	int ctu_nr;
608 
609 	/*
610 	 * below value will be filled on rsnd_mix_probe()
611 	 */
612 	void *mix;
613 	int mix_nr;
614 
615 	/*
616 	 * below value will be filled on rsnd_dvc_probe()
617 	 */
618 	void *dvc;
619 	int dvc_nr;
620 
621 	/*
622 	 * below value will be filled on rsnd_cmd_probe()
623 	 */
624 	void *cmd;
625 	int cmd_nr;
626 
627 	/*
628 	 * below value will be filled on rsnd_dai_probe()
629 	 */
630 	struct snd_soc_dai_driver *daidrv;
631 	struct rsnd_dai *rdai;
632 	int rdai_nr;
633 };
634 
635 #define rsnd_priv_to_pdev(priv)	((priv)->pdev)
636 #define rsnd_priv_to_dev(priv)	(&(rsnd_priv_to_pdev(priv)->dev))
637 
638 #define rsnd_is_gen1(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
639 #define rsnd_is_gen2(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
640 #define rsnd_is_gen3(priv)	(((priv)->flags & RSND_GEN_MASK) == RSND_GEN3)
641 
642 #define rsnd_flags_has(p, f) ((p)->flags & (f))
643 #define rsnd_flags_set(p, f) ((p)->flags |= (f))
644 #define rsnd_flags_del(p, f) ((p)->flags &= ~(f))
645 
646 /*
647  *	rsnd_kctrl
648  */
649 struct rsnd_kctrl_cfg {
650 	unsigned int max;
651 	unsigned int size;
652 	u32 *val;
653 	const char * const *texts;
654 	int (*accept)(struct rsnd_dai_stream *io);
655 	void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
656 	struct rsnd_dai_stream *io;
657 	struct snd_card *card;
658 	struct snd_kcontrol *kctrl;
659 	struct rsnd_mod *mod;
660 };
661 
662 #define RSND_MAX_CHANNELS	8
663 struct rsnd_kctrl_cfg_m {
664 	struct rsnd_kctrl_cfg cfg;
665 	u32 val[RSND_MAX_CHANNELS];
666 };
667 
668 struct rsnd_kctrl_cfg_s {
669 	struct rsnd_kctrl_cfg cfg;
670 	u32 val;
671 };
672 #define rsnd_kctrl_size(x)	((x).cfg.size)
673 #define rsnd_kctrl_max(x)	((x).cfg.max)
674 #define rsnd_kctrl_valm(x, i)	((x).val[i])	/* = (x).cfg.val[i] */
675 #define rsnd_kctrl_vals(x)	((x).val)	/* = (x).cfg.val[0] */
676 
677 int rsnd_kctrl_accept_anytime(struct rsnd_dai_stream *io);
678 int rsnd_kctrl_accept_runtime(struct rsnd_dai_stream *io);
679 struct rsnd_kctrl_cfg *rsnd_kctrl_init_m(struct rsnd_kctrl_cfg_m *cfg);
680 struct rsnd_kctrl_cfg *rsnd_kctrl_init_s(struct rsnd_kctrl_cfg_s *cfg);
681 int rsnd_kctrl_new(struct rsnd_mod *mod,
682 		   struct rsnd_dai_stream *io,
683 		   struct snd_soc_pcm_runtime *rtd,
684 		   const unsigned char *name,
685 		   int (*accept)(struct rsnd_dai_stream *io),
686 		   void (*update)(struct rsnd_dai_stream *io,
687 				  struct rsnd_mod *mod),
688 		   struct rsnd_kctrl_cfg *cfg,
689 		   const char * const *texts,
690 		   int size,
691 		   u32 max);
692 
693 #define rsnd_kctrl_new_m(mod, io, rtd, name, accept, update, cfg, size, max) \
694 	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_m(cfg), \
695 		       NULL, size, max)
696 
697 #define rsnd_kctrl_new_s(mod, io, rtd, name, accept, update, cfg, max)	\
698 	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
699 		       NULL, 1, max)
700 
701 #define rsnd_kctrl_new_e(mod, io, rtd, name, accept, update, cfg, texts, size) \
702 	rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
703 		       texts, 1, size)
704 
705 extern const char * const volume_ramp_rate[];
706 #define VOLUME_RAMP_MAX_DVC	(0x17 + 1)
707 #define VOLUME_RAMP_MAX_MIX	(0x0a + 1)
708 
709 /*
710  *	R-Car SSI
711  */
712 int rsnd_ssi_probe(struct rsnd_priv *priv);
713 void rsnd_ssi_remove(struct rsnd_priv *priv);
714 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
715 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
716 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
717 int rsnd_ssi_get_busif(struct rsnd_dai_stream *io);
718 u32 rsnd_ssi_multi_slaves_runtime(struct rsnd_dai_stream *io);
719 
720 #define RSND_SSI_HDMI_PORT0	0xf0
721 #define RSND_SSI_HDMI_PORT1	0xf1
722 int rsnd_ssi_hdmi_port(struct rsnd_dai_stream *io);
723 void rsnd_ssi_parse_hdmi_connection(struct rsnd_priv *priv,
724 				    struct device_node *endpoint,
725 				    int dai_i);
726 
727 #define rsnd_ssi_is_pin_sharing(io)	\
728 	__rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
729 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
730 
731 #define rsnd_ssi_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSI)
732 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
733 			    struct device_node *playback,
734 			    struct device_node *capture);
735 unsigned int rsnd_ssi_clk_query(struct rsnd_dai *rdai,
736 		       int param1, int param2, int *idx);
737 
738 /*
739  *	R-Car SSIU
740  */
741 int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
742 		     struct rsnd_mod *mod);
743 int rsnd_ssiu_probe(struct rsnd_priv *priv);
744 void rsnd_ssiu_remove(struct rsnd_priv *priv);
745 
746 /*
747  *	R-Car SRC
748  */
749 int rsnd_src_probe(struct rsnd_priv *priv);
750 void rsnd_src_remove(struct rsnd_priv *priv);
751 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
752 
753 #define rsnd_src_get_in_rate(priv, io) rsnd_src_get_rate(priv, io, 1)
754 #define rsnd_src_get_out_rate(priv, io) rsnd_src_get_rate(priv, io, 0)
755 unsigned int rsnd_src_get_rate(struct rsnd_priv *priv,
756 			       struct rsnd_dai_stream *io,
757 			       int is_in);
758 
759 #define rsnd_src_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SRC)
760 #define rsnd_parse_connect_src(rdai, playback, capture)			\
761 	rsnd_parse_connect_common(rdai, rsnd_src_mod_get,		\
762 				  rsnd_src_of_node(rsnd_rdai_to_priv(rdai)), \
763 						   playback, capture)
764 
765 /*
766  *	R-Car CTU
767  */
768 int rsnd_ctu_probe(struct rsnd_priv *priv);
769 void rsnd_ctu_remove(struct rsnd_priv *priv);
770 int rsnd_ctu_converted_channel(struct rsnd_mod *mod);
771 struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
772 #define rsnd_ctu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_CTU)
773 #define rsnd_parse_connect_ctu(rdai, playback, capture)			\
774 	rsnd_parse_connect_common(rdai, rsnd_ctu_mod_get,		\
775 				  rsnd_ctu_of_node(rsnd_rdai_to_priv(rdai)), \
776 						   playback, capture)
777 
778 /*
779  *	R-Car MIX
780  */
781 int rsnd_mix_probe(struct rsnd_priv *priv);
782 void rsnd_mix_remove(struct rsnd_priv *priv);
783 struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
784 #define rsnd_mix_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_MIX)
785 #define rsnd_parse_connect_mix(rdai, playback, capture)			\
786 	rsnd_parse_connect_common(rdai, rsnd_mix_mod_get,		\
787 				  rsnd_mix_of_node(rsnd_rdai_to_priv(rdai)), \
788 						   playback, capture)
789 
790 /*
791  *	R-Car DVC
792  */
793 int rsnd_dvc_probe(struct rsnd_priv *priv);
794 void rsnd_dvc_remove(struct rsnd_priv *priv);
795 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
796 #define rsnd_dvc_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_DVC)
797 #define rsnd_parse_connect_dvc(rdai, playback, capture)			\
798 	rsnd_parse_connect_common(rdai, rsnd_dvc_mod_get,		\
799 				  rsnd_dvc_of_node(rsnd_rdai_to_priv(rdai)), \
800 						   playback, capture)
801 
802 /*
803  *	R-Car CMD
804  */
805 int rsnd_cmd_probe(struct rsnd_priv *priv);
806 void rsnd_cmd_remove(struct rsnd_priv *priv);
807 int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
808 
809 void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
810 #ifdef DEBUG
811 #define rsnd_mod_confirm_ssi(mssi)	rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
812 #define rsnd_mod_confirm_src(msrc)	rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
813 #define rsnd_mod_confirm_dvc(mdvc)	rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
814 #else
815 #define rsnd_mod_confirm_ssi(mssi)
816 #define rsnd_mod_confirm_src(msrc)
817 #define rsnd_mod_confirm_dvc(mdvc)
818 #endif
819 
820 /*
821  * If you don't need interrupt status debug message,
822  * define RSND_DEBUG_NO_IRQ_STATUS as 1 on top of src.c/ssi.c
823  *
824  * #define RSND_DEBUG_NO_IRQ_STATUS 1
825  */
826 #define rsnd_dbg_irq_status(dev, param...)		\
827 	if (!IS_BUILTIN(RSND_DEBUG_NO_IRQ_STATUS))	\
828 		dev_dbg(dev, param)
829 
830 /*
831  * If you don't need rsnd_dai_call debug message,
832  * define RSND_DEBUG_NO_DAI_CALL as 1 on top of core.c
833  *
834  * #define RSND_DEBUG_NO_DAI_CALL 1
835  */
836 #define rsnd_dbg_dai_call(dev, param...)		\
837 	if (!IS_BUILTIN(RSND_DEBUG_NO_DAI_CALL))	\
838 		dev_dbg(dev, param)
839 
840 #endif
841