xref: /openbmc/linux/sound/soc/sh/rcar/rsnd.h (revision 8a26af30)
1 /*
2  * Renesas R-Car
3  *
4  * Copyright (C) 2013 Renesas Solutions Corp.
5  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
6  *
7  * This program is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License version 2 as
9  * published by the Free Software Foundation.
10  */
11 #ifndef RSND_H
12 #define RSND_H
13 
14 #include <linux/clk.h>
15 #include <linux/device.h>
16 #include <linux/dma-mapping.h>
17 #include <linux/io.h>
18 #include <linux/list.h>
19 #include <linux/module.h>
20 #include <linux/of_device.h>
21 #include <linux/of_irq.h>
22 #include <linux/sh_dma.h>
23 #include <linux/workqueue.h>
24 #include <sound/rcar_snd.h>
25 #include <sound/soc.h>
26 #include <sound/pcm_params.h>
27 
28 /*
29  *	pseudo register
30  *
31  * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
32  * This driver uses pseudo register in order to hide it.
33  * see gen1/gen2 for detail
34  */
35 enum rsnd_reg {
36 	/* SRU/SCU/SSIU */
37 	RSND_REG_SSI_MODE0,
38 	RSND_REG_SSI_MODE1,
39 	RSND_REG_SRC_BUSIF_MODE,
40 	RSND_REG_SRC_ROUTE_MODE0,
41 	RSND_REG_SRC_SWRSR,
42 	RSND_REG_SRC_SRCIR,
43 	RSND_REG_SRC_ADINR,
44 	RSND_REG_SRC_IFSCR,
45 	RSND_REG_SRC_IFSVR,
46 	RSND_REG_SRC_SRCCR,
47 	RSND_REG_CMD_ROUTE_SLCT,
48 	RSND_REG_DVC_SWRSR,
49 	RSND_REG_DVC_DVUIR,
50 	RSND_REG_DVC_ADINR,
51 	RSND_REG_DVC_DVUCR,
52 	RSND_REG_DVC_ZCMCR,
53 	RSND_REG_DVC_VOL0R,
54 	RSND_REG_DVC_VOL1R,
55 	RSND_REG_DVC_DVUER,
56 
57 	/* ADG */
58 	RSND_REG_BRRA,
59 	RSND_REG_BRRB,
60 	RSND_REG_SSICKR,
61 	RSND_REG_AUDIO_CLK_SEL0,
62 	RSND_REG_AUDIO_CLK_SEL1,
63 
64 	/* SSI */
65 	RSND_REG_SSICR,
66 	RSND_REG_SSISR,
67 	RSND_REG_SSITDR,
68 	RSND_REG_SSIRDR,
69 	RSND_REG_SSIWSR,
70 
71 	/* SHARE see below */
72 	RSND_REG_SHARE01,
73 	RSND_REG_SHARE02,
74 	RSND_REG_SHARE03,
75 	RSND_REG_SHARE04,
76 	RSND_REG_SHARE05,
77 	RSND_REG_SHARE06,
78 	RSND_REG_SHARE07,
79 	RSND_REG_SHARE08,
80 	RSND_REG_SHARE09,
81 	RSND_REG_SHARE10,
82 	RSND_REG_SHARE11,
83 	RSND_REG_SHARE12,
84 	RSND_REG_SHARE13,
85 	RSND_REG_SHARE14,
86 	RSND_REG_SHARE15,
87 	RSND_REG_SHARE16,
88 	RSND_REG_SHARE17,
89 	RSND_REG_SHARE18,
90 	RSND_REG_SHARE19,
91 	RSND_REG_SHARE20,
92 	RSND_REG_SHARE21,
93 
94 	RSND_REG_MAX,
95 };
96 
97 /* Gen1 only */
98 #define RSND_REG_SRC_ROUTE_SEL		RSND_REG_SHARE01
99 #define RSND_REG_SRC_TMG_SEL0		RSND_REG_SHARE02
100 #define RSND_REG_SRC_TMG_SEL1		RSND_REG_SHARE03
101 #define RSND_REG_SRC_TMG_SEL2		RSND_REG_SHARE04
102 #define RSND_REG_SRC_ROUTE_CTRL		RSND_REG_SHARE05
103 #define RSND_REG_SRC_MNFSR		RSND_REG_SHARE06
104 #define RSND_REG_AUDIO_CLK_SEL3		RSND_REG_SHARE07
105 #define RSND_REG_AUDIO_CLK_SEL4		RSND_REG_SHARE08
106 #define RSND_REG_AUDIO_CLK_SEL5		RSND_REG_SHARE09
107 
108 /* Gen2 only */
109 #define RSND_REG_SRC_CTRL		RSND_REG_SHARE01
110 #define RSND_REG_SSI_CTRL		RSND_REG_SHARE02
111 #define RSND_REG_SSI_BUSIF_MODE		RSND_REG_SHARE03
112 #define RSND_REG_SSI_BUSIF_ADINR	RSND_REG_SHARE04
113 #define RSND_REG_INT_ENABLE		RSND_REG_SHARE05
114 #define RSND_REG_SRC_BSDSR		RSND_REG_SHARE06
115 #define RSND_REG_SRC_BSISR		RSND_REG_SHARE07
116 #define RSND_REG_DIV_EN			RSND_REG_SHARE08
117 #define RSND_REG_SRCIN_TIMSEL0		RSND_REG_SHARE09
118 #define RSND_REG_SRCIN_TIMSEL1		RSND_REG_SHARE10
119 #define RSND_REG_SRCIN_TIMSEL2		RSND_REG_SHARE11
120 #define RSND_REG_SRCIN_TIMSEL3		RSND_REG_SHARE12
121 #define RSND_REG_SRCIN_TIMSEL4		RSND_REG_SHARE13
122 #define RSND_REG_SRCOUT_TIMSEL0		RSND_REG_SHARE14
123 #define RSND_REG_SRCOUT_TIMSEL1		RSND_REG_SHARE15
124 #define RSND_REG_SRCOUT_TIMSEL2		RSND_REG_SHARE16
125 #define RSND_REG_SRCOUT_TIMSEL3		RSND_REG_SHARE17
126 #define RSND_REG_SRCOUT_TIMSEL4		RSND_REG_SHARE18
127 #define RSND_REG_AUDIO_CLK_SEL2		RSND_REG_SHARE19
128 #define RSND_REG_CMD_CTRL		RSND_REG_SHARE20
129 #define RSND_REG_CMDOUT_TIMSEL		RSND_REG_SHARE21
130 
131 struct rsnd_of_data;
132 struct rsnd_priv;
133 struct rsnd_mod;
134 struct rsnd_dai;
135 struct rsnd_dai_stream;
136 
137 /*
138  *	R-Car basic functions
139  */
140 #define rsnd_mod_read(m, r) \
141 	rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
142 #define rsnd_mod_write(m, r, d) \
143 	rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
144 #define rsnd_mod_bset(m, r, s, d) \
145 	rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
146 
147 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
148 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
149 		enum rsnd_reg reg, u32 data);
150 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
151 		    u32 mask, u32 data);
152 u32 rsnd_get_adinr(struct rsnd_mod *mod);
153 
154 /*
155  *	R-Car DMA
156  */
157 struct rsnd_dma {
158 	struct sh_dmae_slave	slave;
159 	struct work_struct	work;
160 	struct dma_chan		*chan;
161 	enum dma_data_direction dir;
162 
163 	int submit_loop;
164 	int offset; /* it cares A/B plane */
165 };
166 
167 void rsnd_dma_start(struct rsnd_dma *dma);
168 void rsnd_dma_stop(struct rsnd_dma *dma);
169 int rsnd_dma_available(struct rsnd_dma *dma);
170 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
171 	int is_play, int id);
172 void  rsnd_dma_quit(struct rsnd_priv *priv,
173 		    struct rsnd_dma *dma);
174 
175 
176 /*
177  *	R-Car sound mod
178  */
179 enum rsnd_mod_type {
180 	RSND_MOD_SRC = 0,
181 	RSND_MOD_SSI,
182 	RSND_MOD_DVC,
183 	RSND_MOD_MAX,
184 };
185 
186 struct rsnd_mod_ops {
187 	char *name;
188 	int (*probe)(struct rsnd_mod *mod,
189 		     struct rsnd_dai *rdai);
190 	int (*remove)(struct rsnd_mod *mod,
191 		      struct rsnd_dai *rdai);
192 	int (*init)(struct rsnd_mod *mod,
193 		    struct rsnd_dai *rdai);
194 	int (*quit)(struct rsnd_mod *mod,
195 		    struct rsnd_dai *rdai);
196 	int (*start)(struct rsnd_mod *mod,
197 		     struct rsnd_dai *rdai);
198 	int (*stop)(struct rsnd_mod *mod,
199 		    struct rsnd_dai *rdai);
200 	int (*pcm_new)(struct rsnd_mod *mod,
201 		       struct rsnd_dai *rdai,
202 		       struct snd_soc_pcm_runtime *rtd);
203 };
204 
205 struct rsnd_dai_stream;
206 struct rsnd_mod {
207 	int id;
208 	enum rsnd_mod_type type;
209 	struct rsnd_priv *priv;
210 	struct rsnd_mod_ops *ops;
211 	struct rsnd_dma dma;
212 	struct rsnd_dai_stream *io;
213 };
214 
215 #define rsnd_mod_to_priv(mod) ((mod)->priv)
216 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
217 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
218 #define rsnd_mod_to_io(mod) ((mod)->io)
219 #define rsnd_mod_id(mod) ((mod)->id)
220 
221 void rsnd_mod_init(struct rsnd_priv *priv,
222 		   struct rsnd_mod *mod,
223 		   struct rsnd_mod_ops *ops,
224 		   enum rsnd_mod_type type,
225 		   int id);
226 char *rsnd_mod_name(struct rsnd_mod *mod);
227 
228 /*
229  *	R-Car sound DAI
230  */
231 #define RSND_DAI_NAME_SIZE	16
232 struct rsnd_dai_stream {
233 	struct snd_pcm_substream *substream;
234 	struct rsnd_mod *mod[RSND_MOD_MAX];
235 	struct rsnd_dai_path_info *info; /* rcar_snd.h */
236 	int byte_pos;
237 	int period_pos;
238 	int byte_per_period;
239 	int next_period_byte;
240 };
241 #define rsnd_io_to_mod_ssi(io)	((io)->mod[RSND_MOD_SSI])
242 #define rsnd_io_to_mod_src(io)	((io)->mod[RSND_MOD_SRC])
243 #define rsnd_io_to_mod_dvc(io)	((io)->mod[RSND_MOD_DVC])
244 
245 struct rsnd_dai {
246 	char name[RSND_DAI_NAME_SIZE];
247 	struct rsnd_dai_platform_info *info; /* rcar_snd.h */
248 	struct rsnd_dai_stream playback;
249 	struct rsnd_dai_stream capture;
250 
251 	unsigned int clk_master:1;
252 	unsigned int bit_clk_inv:1;
253 	unsigned int frm_clk_inv:1;
254 	unsigned int sys_delay:1;
255 	unsigned int data_alignment:1;
256 };
257 
258 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
259 #define for_each_rsnd_dai(rdai, priv, i)		\
260 	for (i = 0;					\
261 	     (i < rsnd_rdai_nr(priv)) &&		\
262 	     ((rdai) = rsnd_dai_get(priv, i));		\
263 	     i++)
264 
265 struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id);
266 int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io);
267 int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai);
268 #define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
269 #define rsnd_io_to_runtime(io) ((io)->substream->runtime)
270 
271 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
272 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
273 #define rsnd_dai_is_clk_master(rdai) ((rdai)->clk_master)
274 
275 /*
276  *	R-Car Gen1/Gen2
277  */
278 int rsnd_gen_probe(struct platform_device *pdev,
279 		   const struct rsnd_of_data *of_data,
280 		   struct rsnd_priv *priv);
281 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
282 			       struct rsnd_mod *mod,
283 			       enum rsnd_reg reg);
284 void rsnd_gen_dma_addr(struct rsnd_priv *priv,
285 		       struct rsnd_dma *dma,
286 		       struct dma_slave_config *cfg,
287 		       int is_play,  int slave_id);
288 
289 #define rsnd_is_gen1(s)		(((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
290 #define rsnd_is_gen2(s)		(((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
291 
292 /*
293  *	R-Car ADG
294  */
295 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
296 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
297 int rsnd_adg_probe(struct platform_device *pdev,
298 		   const struct rsnd_of_data *of_data,
299 		   struct rsnd_priv *priv);
300 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
301 				  struct rsnd_mod *mod,
302 				  unsigned int src_rate,
303 				  unsigned int dst_rate);
304 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
305 				  struct rsnd_dai *rdai,
306 				  struct rsnd_dai_stream *io,
307 				  unsigned int src_rate,
308 				  unsigned int dst_rate);
309 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
310 				     struct rsnd_dai *rdai,
311 				     struct rsnd_dai_stream *io);
312 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_dai *rdai,
313 				 struct rsnd_mod *mod,
314 				 struct rsnd_dai_stream *io);
315 
316 /*
317  *	R-Car sound priv
318  */
319 struct rsnd_of_data {
320 	u32 flags;
321 };
322 
323 struct rsnd_priv {
324 
325 	struct platform_device *pdev;
326 	struct rcar_snd_info *info;
327 	spinlock_t lock;
328 
329 	/*
330 	 * below value will be filled on rsnd_gen_probe()
331 	 */
332 	void *gen;
333 
334 	/*
335 	 * below value will be filled on rsnd_src_probe()
336 	 */
337 	void *src;
338 	int src_nr;
339 
340 	/*
341 	 * below value will be filled on rsnd_adg_probe()
342 	 */
343 	void *adg;
344 
345 	/*
346 	 * below value will be filled on rsnd_ssi_probe()
347 	 */
348 	void *ssi;
349 	int ssi_nr;
350 
351 	/*
352 	 * below value will be filled on rsnd_dvc_probe()
353 	 */
354 	void *dvc;
355 	int dvc_nr;
356 
357 	/*
358 	 * below value will be filled on rsnd_dai_probe()
359 	 */
360 	struct snd_soc_dai_driver *daidrv;
361 	struct rsnd_dai *rdai;
362 	int rdai_nr;
363 };
364 
365 #define rsnd_priv_to_pdev(priv)	((priv)->pdev)
366 #define rsnd_priv_to_dev(priv)	(&(rsnd_priv_to_pdev(priv)->dev))
367 #define rsnd_priv_to_info(priv)	((priv)->info)
368 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
369 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
370 
371 #define rsnd_info_is_playback(priv, type)				\
372 ({									\
373 	struct rcar_snd_info *info = rsnd_priv_to_info(priv);		\
374 	int i, is_play = 0;						\
375 	for (i = 0; i < info->dai_info_nr; i++) {			\
376 		if (info->dai_info[i].playback.type == (type)->info) {	\
377 			is_play = 1;					\
378 			break;						\
379 		}							\
380 	}								\
381 	is_play;							\
382 })
383 
384 /*
385  *	R-Car SRC
386  */
387 int rsnd_src_probe(struct platform_device *pdev,
388 		   const struct rsnd_of_data *of_data,
389 		   struct rsnd_priv *priv);
390 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
391 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
392 				   struct rsnd_dai_stream *io,
393 				   struct snd_pcm_runtime *runtime);
394 int rsnd_src_ssi_mode_init(struct rsnd_mod *ssi_mod,
395 			   struct rsnd_dai *rdai);
396 int rsnd_src_enable_ssi_irq(struct rsnd_mod *ssi_mod,
397 			    struct rsnd_dai *rdai);
398 
399 #define rsnd_src_nr(priv) ((priv)->src_nr)
400 
401 /*
402  *	R-Car SSI
403  */
404 int rsnd_ssi_probe(struct platform_device *pdev,
405 		   const struct rsnd_of_data *of_data,
406 		   struct rsnd_priv *priv);
407 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
408 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
409 
410 /*
411  *	R-Car DVC
412  */
413 int rsnd_dvc_probe(struct platform_device *pdev,
414 		   const struct rsnd_of_data *of_data,
415 		   struct rsnd_priv *priv);
416 void rsnd_dvc_remove(struct platform_device *pdev,
417 		     struct rsnd_priv *priv);
418 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
419 
420 #define rsnd_dvc_nr(priv) ((priv)->dvc_nr)
421 
422 
423 #endif
424