xref: /openbmc/linux/sound/soc/sh/rcar/rsnd.h (revision d870a91e)
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/sh_dma.h>
21 #include <linux/workqueue.h>
22 #include <sound/rcar_snd.h>
23 #include <sound/soc.h>
24 #include <sound/pcm_params.h>
25 
26 /*
27  *	pseudo register
28  *
29  * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
30  * This driver uses pseudo register in order to hide it.
31  * see gen1/gen2 for detail
32  */
33 enum rsnd_reg {
34 	/* SRU/SCU/SSIU */
35 	RSND_REG_SRC_ROUTE_SEL,		/* for Gen1 */
36 	RSND_REG_SRC_TMG_SEL0,		/* for Gen1 */
37 	RSND_REG_SRC_TMG_SEL1,		/* for Gen1 */
38 	RSND_REG_SRC_TMG_SEL2,		/* for Gen1 */
39 	RSND_REG_SRC_ROUTE_CTRL,	/* for Gen1 */
40 	RSND_REG_SRC_CTRL,		/* for Gen2 */
41 	RSND_REG_SSI_CTRL,		/* for Gen2 */
42 	RSND_REG_SSI_CONTROL,
43 	RSND_REG_SSI_BUSIF_MODE,	/* for Gen2 */
44 	RSND_REG_SSI_BUSIF_ADINR,	/* for Gen2 */
45 	RSND_REG_SSI_MODE0,
46 	RSND_REG_SSI_MODE1,
47 	RSND_REG_INT_ENABLE,		/* for Gen2 */
48 	RSND_REG_SRC_BUSIF_MODE,
49 	RSND_REG_SRC_ROUTE_MODE0,
50 	RSND_REG_SRC_SWRSR,
51 	RSND_REG_SRC_SRCIR,
52 	RSND_REG_SRC_ADINR,
53 	RSND_REG_SRC_IFSCR,
54 	RSND_REG_SRC_IFSVR,
55 	RSND_REG_SRC_SRCCR,
56 	RSND_REG_SRC_MNFSR,		/* for Gen1 */
57 	RSND_REG_SRC_BSDSR,		/* for Gen2 */
58 	RSND_REG_SRC_BSISR,		/* for Gen2 */
59 
60 	/* ADG */
61 	RSND_REG_BRRA,
62 	RSND_REG_BRRB,
63 	RSND_REG_SSICKR,
64 	RSND_REG_AUDIO_CLK_SEL0,
65 	RSND_REG_AUDIO_CLK_SEL1,
66 	RSND_REG_AUDIO_CLK_SEL2,
67 	RSND_REG_AUDIO_CLK_SEL3,	/* for Gen1 */
68 	RSND_REG_AUDIO_CLK_SEL4,	/* for Gen1 */
69 	RSND_REG_AUDIO_CLK_SEL5,	/* for Gen1 */
70 	RSND_REG_DIV_EN,		/* for Gen2 */
71 	RSND_REG_SRCIN_TIMSEL0,		/* for Gen2 */
72 	RSND_REG_SRCIN_TIMSEL1,		/* for Gen2 */
73 	RSND_REG_SRCIN_TIMSEL2,		/* for Gen2 */
74 	RSND_REG_SRCIN_TIMSEL3,		/* for Gen2 */
75 	RSND_REG_SRCIN_TIMSEL4,		/* for Gen2 */
76 	RSND_REG_SRCOUT_TIMSEL0,	/* for Gen2 */
77 	RSND_REG_SRCOUT_TIMSEL1,	/* for Gen2 */
78 	RSND_REG_SRCOUT_TIMSEL2,	/* for Gen2 */
79 	RSND_REG_SRCOUT_TIMSEL3,	/* for Gen2 */
80 	RSND_REG_SRCOUT_TIMSEL4,	/* for Gen2 */
81 
82 	/* SSI */
83 	RSND_REG_SSICR,
84 	RSND_REG_SSISR,
85 	RSND_REG_SSITDR,
86 	RSND_REG_SSIRDR,
87 	RSND_REG_SSIWSR,
88 
89 	RSND_REG_MAX,
90 };
91 
92 struct rsnd_priv;
93 struct rsnd_mod;
94 struct rsnd_dai;
95 struct rsnd_dai_stream;
96 
97 /*
98  *	R-Car basic functions
99  */
100 #define rsnd_mod_read(m, r) \
101 	rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
102 #define rsnd_mod_write(m, r, d) \
103 	rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
104 #define rsnd_mod_bset(m, r, s, d) \
105 	rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
106 
107 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
108 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
109 		enum rsnd_reg reg, u32 data);
110 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
111 		    u32 mask, u32 data);
112 
113 /*
114  *	R-Car DMA
115  */
116 struct rsnd_dma {
117 	struct sh_dmae_slave	slave;
118 	struct work_struct	work;
119 	struct dma_chan		*chan;
120 	enum dma_data_direction dir;
121 
122 	int submit_loop;
123 	int offset; /* it cares A/B plane */
124 };
125 
126 void rsnd_dma_start(struct rsnd_dma *dma);
127 void rsnd_dma_stop(struct rsnd_dma *dma);
128 int rsnd_dma_available(struct rsnd_dma *dma);
129 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
130 	int is_play, int id);
131 void  rsnd_dma_quit(struct rsnd_priv *priv,
132 		    struct rsnd_dma *dma);
133 
134 
135 /*
136  *	R-Car sound mod
137  */
138 
139 struct rsnd_mod_ops {
140 	char *name;
141 	int (*init)(struct rsnd_mod *mod,
142 		    struct rsnd_dai *rdai,
143 		    struct rsnd_dai_stream *io);
144 	int (*quit)(struct rsnd_mod *mod,
145 		    struct rsnd_dai *rdai,
146 		    struct rsnd_dai_stream *io);
147 	int (*start)(struct rsnd_mod *mod,
148 		     struct rsnd_dai *rdai,
149 		     struct rsnd_dai_stream *io);
150 	int (*stop)(struct rsnd_mod *mod,
151 		    struct rsnd_dai *rdai,
152 		    struct rsnd_dai_stream *io);
153 };
154 
155 struct rsnd_dai_stream;
156 struct rsnd_mod {
157 	int id;
158 	struct rsnd_priv *priv;
159 	struct rsnd_mod_ops *ops;
160 	struct list_head list; /* connect to rsnd_dai playback/capture */
161 	struct rsnd_dma dma;
162 	struct rsnd_dai_stream *io;
163 };
164 
165 #define rsnd_mod_to_priv(mod) ((mod)->priv)
166 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
167 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
168 #define rsnd_mod_to_io(mod) ((mod)->io)
169 #define rsnd_mod_id(mod) ((mod)->id)
170 #define for_each_rsnd_mod(pos, n, io)	\
171 	list_for_each_entry_safe(pos, n, &(io)->head, list)
172 
173 void rsnd_mod_init(struct rsnd_priv *priv,
174 		   struct rsnd_mod *mod,
175 		   struct rsnd_mod_ops *ops,
176 		   int id);
177 char *rsnd_mod_name(struct rsnd_mod *mod);
178 
179 /*
180  *	R-Car sound DAI
181  */
182 #define RSND_DAI_NAME_SIZE	16
183 struct rsnd_dai_stream {
184 	struct list_head head; /* head of rsnd_mod list */
185 	struct snd_pcm_substream *substream;
186 	int byte_pos;
187 	int period_pos;
188 	int byte_per_period;
189 	int next_period_byte;
190 };
191 
192 struct rsnd_dai {
193 	char name[RSND_DAI_NAME_SIZE];
194 	struct rsnd_dai_platform_info *info; /* rcar_snd.h */
195 	struct rsnd_dai_stream playback;
196 	struct rsnd_dai_stream capture;
197 
198 	unsigned int clk_master:1;
199 	unsigned int bit_clk_inv:1;
200 	unsigned int frm_clk_inv:1;
201 	unsigned int sys_delay:1;
202 	unsigned int data_alignment:1;
203 };
204 
205 #define rsnd_dai_nr(priv) ((priv)->dai_nr)
206 #define for_each_rsnd_dai(rdai, priv, i)		\
207 	for (i = 0;					\
208 	     (i < rsnd_dai_nr(priv)) &&			\
209 	     ((rdai) = rsnd_dai_get(priv, i));		\
210 	     i++)
211 
212 struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id);
213 int rsnd_dai_disconnect(struct rsnd_mod *mod);
214 int rsnd_dai_connect(struct rsnd_dai *rdai, struct rsnd_mod *mod,
215 		     struct rsnd_dai_stream *io);
216 int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io);
217 int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai);
218 #define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
219 #define rsnd_io_to_runtime(io) ((io)->substream->runtime)
220 
221 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
222 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
223 #define rsnd_dai_is_clk_master(rdai) ((rdai)->clk_master)
224 
225 /*
226  *	R-Car Gen1/Gen2
227  */
228 int rsnd_gen_probe(struct platform_device *pdev,
229 		   struct rcar_snd_info *info,
230 		   struct rsnd_priv *priv);
231 void rsnd_gen_remove(struct platform_device *pdev,
232 		     struct rsnd_priv *priv);
233 int rsnd_gen_path_init(struct rsnd_priv *priv,
234 		       struct rsnd_dai *rdai,
235 		       struct rsnd_dai_stream *io);
236 int rsnd_gen_path_exit(struct rsnd_priv *priv,
237 		       struct rsnd_dai *rdai,
238 		       struct rsnd_dai_stream *io);
239 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
240 			       struct rsnd_mod *mod,
241 			       enum rsnd_reg reg);
242 #define rsnd_is_gen1(s)		(((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
243 #define rsnd_is_gen2(s)		(((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
244 
245 /*
246  *	R-Car ADG
247  */
248 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
249 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
250 int rsnd_adg_probe(struct platform_device *pdev,
251 		   struct rcar_snd_info *info,
252 		   struct rsnd_priv *priv);
253 void rsnd_adg_remove(struct platform_device *pdev,
254 		   struct rsnd_priv *priv);
255 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
256 				  struct rsnd_mod *mod,
257 				  unsigned int src_rate,
258 				  unsigned int dst_rate);
259 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
260 				  struct rsnd_dai *rdai,
261 				  struct rsnd_dai_stream *io,
262 				  unsigned int src_rate,
263 				  unsigned int dst_rate);
264 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
265 				     struct rsnd_dai *rdai,
266 				     struct rsnd_dai_stream *io);
267 
268 /*
269  *	R-Car sound priv
270  */
271 struct rsnd_priv {
272 
273 	struct device *dev;
274 	struct rcar_snd_info *info;
275 	spinlock_t lock;
276 
277 	/*
278 	 * below value will be filled on rsnd_gen_probe()
279 	 */
280 	void *gen;
281 
282 	/*
283 	 * below value will be filled on rsnd_scu_probe()
284 	 */
285 	void *scu;
286 	int scu_nr;
287 
288 	/*
289 	 * below value will be filled on rsnd_adg_probe()
290 	 */
291 	void *adg;
292 
293 	/*
294 	 * below value will be filled on rsnd_ssi_probe()
295 	 */
296 	void *ssi;
297 	int ssi_nr;
298 
299 	/*
300 	 * below value will be filled on rsnd_dai_probe()
301 	 */
302 	struct snd_soc_dai_driver *daidrv;
303 	struct rsnd_dai *rdai;
304 	int dai_nr;
305 };
306 
307 #define rsnd_priv_to_dev(priv)	((priv)->dev)
308 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
309 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
310 
311 /*
312  *	R-Car SCU
313  */
314 int rsnd_scu_probe(struct platform_device *pdev,
315 		   struct rcar_snd_info *info,
316 		   struct rsnd_priv *priv);
317 void rsnd_scu_remove(struct platform_device *pdev,
318 		     struct rsnd_priv *priv);
319 struct rsnd_mod *rsnd_scu_mod_get(struct rsnd_priv *priv, int id);
320 unsigned int rsnd_scu_get_ssi_rate(struct rsnd_priv *priv,
321 				   struct rsnd_mod *ssi_mod,
322 				   struct snd_pcm_runtime *runtime);
323 
324 #define rsnd_scu_nr(priv) ((priv)->scu_nr)
325 
326 /*
327  *	R-Car SSI
328  */
329 int rsnd_ssi_probe(struct platform_device *pdev,
330 		   struct rcar_snd_info *info,
331 		   struct rsnd_priv *priv);
332 void rsnd_ssi_remove(struct platform_device *pdev,
333 		   struct rsnd_priv *priv);
334 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
335 struct rsnd_mod *rsnd_ssi_mod_get_frm_dai(struct rsnd_priv *priv,
336 					  int dai_id, int is_play);
337 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
338 int rsnd_ssi_is_play(struct rsnd_mod *mod);
339 
340 #endif
341