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