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