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