ASoC: rsnd: tidyup original for_each_rsnd_xxx macro
[deliverable/linux.git] / sound / soc / sh / rcar / rsnd.h
CommitLineData
1536a968
KM
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>
0a4d94c0 16#include <linux/dma-mapping.h>
1536a968
KM
17#include <linux/io.h>
18#include <linux/list.h>
19#include <linux/module.h>
0a4d94c0
KM
20#include <linux/sh_dma.h>
21#include <linux/workqueue.h>
1536a968
KM
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 */
3337744a 33enum rsnd_reg {
507d466c 34 /* SRU/SCU/SSIU */
2582718c
KM
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 */
629509c5
KM
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 */
07539c1d
KM
45 RSND_REG_SSI_MODE0,
46 RSND_REG_SSI_MODE1,
52ea2a79 47 RSND_REG_INT_ENABLE, /* for Gen2 */
0290d2a4 48 RSND_REG_SRC_BUSIF_MODE,
ef749400
KM
49 RSND_REG_SRC_ROUTE_MODE0,
50 RSND_REG_SRC_SWRSR,
51 RSND_REG_SRC_SRCIR,
690ef81e 52 RSND_REG_SRC_ADINR,
ef749400
KM
53 RSND_REG_SRC_IFSCR,
54 RSND_REG_SRC_IFSVR,
55 RSND_REG_SRC_SRCCR,
1b7b08ef 56 RSND_REG_SRC_MNFSR, /* for Gen1 */
629509c5
KM
57 RSND_REG_SRC_BSDSR, /* for Gen2 */
58 RSND_REG_SRC_BSISR, /* for Gen2 */
07539c1d 59
dfc9403b
KM
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,
ef749400
KM
67 RSND_REG_AUDIO_CLK_SEL3, /* for Gen1 */
68 RSND_REG_AUDIO_CLK_SEL4, /* for Gen1 */
69 RSND_REG_AUDIO_CLK_SEL5, /* for Gen1 */
629509c5
KM
70 RSND_REG_SRCIN_TIMSEL0, /* for Gen2 */
71 RSND_REG_SRCIN_TIMSEL1, /* for Gen2 */
72 RSND_REG_SRCIN_TIMSEL2, /* for Gen2 */
73 RSND_REG_SRCIN_TIMSEL3, /* for Gen2 */
74 RSND_REG_SRCIN_TIMSEL4, /* for Gen2 */
75 RSND_REG_SRCOUT_TIMSEL0, /* for Gen2 */
76 RSND_REG_SRCOUT_TIMSEL1, /* for Gen2 */
77 RSND_REG_SRCOUT_TIMSEL2, /* for Gen2 */
78 RSND_REG_SRCOUT_TIMSEL3, /* for Gen2 */
79 RSND_REG_SRCOUT_TIMSEL4, /* for Gen2 */
dfc9403b 80
ae5c3223
KM
81 /* SSI */
82 RSND_REG_SSICR,
83 RSND_REG_SSISR,
84 RSND_REG_SSITDR,
85 RSND_REG_SSIRDR,
86 RSND_REG_SSIWSR,
87
3337744a
KM
88 RSND_REG_MAX,
89};
90
1536a968 91struct rsnd_priv;
cdaa3cdf 92struct rsnd_mod;
1536a968
KM
93struct rsnd_dai;
94struct rsnd_dai_stream;
95
3337744a
KM
96/*
97 * R-Car basic functions
98 */
99#define rsnd_mod_read(m, r) \
100 rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
101#define rsnd_mod_write(m, r, d) \
102 rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
103#define rsnd_mod_bset(m, r, s, d) \
104 rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
105
3337744a
KM
106u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
107void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
108 enum rsnd_reg reg, u32 data);
109void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
110 u32 mask, u32 data);
111
0a4d94c0
KM
112/*
113 * R-Car DMA
114 */
115struct rsnd_dma {
0a4d94c0
KM
116 struct sh_dmae_slave slave;
117 struct work_struct work;
118 struct dma_chan *chan;
119 enum dma_data_direction dir;
0a4d94c0
KM
120
121 int submit_loop;
4686a0ad 122 int offset; /* it cares A/B plane */
0a4d94c0
KM
123};
124
125void rsnd_dma_start(struct rsnd_dma *dma);
126void rsnd_dma_stop(struct rsnd_dma *dma);
127int rsnd_dma_available(struct rsnd_dma *dma);
128int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
4686a0ad 129 int is_play, int id);
0a4d94c0
KM
130void rsnd_dma_quit(struct rsnd_priv *priv,
131 struct rsnd_dma *dma);
132
133
cdaa3cdf
KM
134/*
135 * R-Car sound mod
136 */
137
138struct rsnd_mod_ops {
139 char *name;
140 int (*init)(struct rsnd_mod *mod,
141 struct rsnd_dai *rdai,
142 struct rsnd_dai_stream *io);
143 int (*quit)(struct rsnd_mod *mod,
144 struct rsnd_dai *rdai,
145 struct rsnd_dai_stream *io);
146 int (*start)(struct rsnd_mod *mod,
147 struct rsnd_dai *rdai,
148 struct rsnd_dai_stream *io);
149 int (*stop)(struct rsnd_mod *mod,
150 struct rsnd_dai *rdai,
151 struct rsnd_dai_stream *io);
152};
153
4686a0ad 154struct rsnd_dai_stream;
cdaa3cdf
KM
155struct rsnd_mod {
156 int id;
157 struct rsnd_priv *priv;
158 struct rsnd_mod_ops *ops;
159 struct list_head list; /* connect to rsnd_dai playback/capture */
0a4d94c0 160 struct rsnd_dma dma;
4686a0ad 161 struct rsnd_dai_stream *io;
cdaa3cdf
KM
162};
163
164#define rsnd_mod_to_priv(mod) ((mod)->priv)
0a4d94c0
KM
165#define rsnd_mod_to_dma(mod) (&(mod)->dma)
166#define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
4686a0ad 167#define rsnd_mod_to_io(mod) ((mod)->io)
cdaa3cdf
KM
168#define rsnd_mod_id(mod) ((mod)->id)
169#define for_each_rsnd_mod(pos, n, io) \
170 list_for_each_entry_safe(pos, n, &(io)->head, list)
92d9587e
KM
171#define __rsnd_mod_call(mod, func, rdai, io) \
172({ \
173 struct rsnd_priv *priv = rsnd_mod_to_priv(mod); \
174 struct device *dev = rsnd_priv_to_dev(priv); \
175 dev_dbg(dev, "%s-%d-%s\n", \
176 rsnd_mod_name(mod), rsnd_mod_id(mod), #func); \
177 (mod)->ops->func(mod, rdai, io); \
178})
179
cdaa3cdf
KM
180#define rsnd_mod_call(mod, func, rdai, io) \
181 (!(mod) ? -ENODEV : \
182 !((mod)->ops->func) ? 0 : \
92d9587e 183 __rsnd_mod_call(mod, func, rdai, io))
cdaa3cdf
KM
184
185void rsnd_mod_init(struct rsnd_priv *priv,
186 struct rsnd_mod *mod,
187 struct rsnd_mod_ops *ops,
188 int id);
189char *rsnd_mod_name(struct rsnd_mod *mod);
190
1536a968
KM
191/*
192 * R-Car sound DAI
193 */
194#define RSND_DAI_NAME_SIZE 16
195struct rsnd_dai_stream {
196 struct list_head head; /* head of rsnd_mod list */
197 struct snd_pcm_substream *substream;
198 int byte_pos;
199 int period_pos;
200 int byte_per_period;
201 int next_period_byte;
202};
203
204struct rsnd_dai {
205 char name[RSND_DAI_NAME_SIZE];
206 struct rsnd_dai_platform_info *info; /* rcar_snd.h */
207 struct rsnd_dai_stream playback;
208 struct rsnd_dai_stream capture;
209
a3737731
DC
210 unsigned int clk_master:1;
211 unsigned int bit_clk_inv:1;
212 unsigned int frm_clk_inv:1;
213 unsigned int sys_delay:1;
214 unsigned int data_alignment:1;
1536a968
KM
215};
216
217#define rsnd_dai_nr(priv) ((priv)->dai_nr)
218#define for_each_rsnd_dai(rdai, priv, i) \
00463c11
KM
219 for (i = 0; \
220 (i < rsnd_dai_nr(priv)) && \
221 ((rdai) = rsnd_dai_get(priv, i)); \
222 i++)
1536a968
KM
223
224struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id);
cdaa3cdf
KM
225int rsnd_dai_disconnect(struct rsnd_mod *mod);
226int rsnd_dai_connect(struct rsnd_dai *rdai, struct rsnd_mod *mod,
227 struct rsnd_dai_stream *io);
1536a968 228int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io);
4b4dab82 229int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai);
1536a968 230#define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
ae5c3223 231#define rsnd_io_to_runtime(io) ((io)->substream->runtime)
1536a968
KM
232
233void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
234int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
e779a20d 235#define rsnd_dai_is_clk_master(rdai) ((rdai)->clk_master)
1536a968 236
3337744a
KM
237/*
238 * R-Car Gen1/Gen2
239 */
240int rsnd_gen_probe(struct platform_device *pdev,
241 struct rcar_snd_info *info,
242 struct rsnd_priv *priv);
243void rsnd_gen_remove(struct platform_device *pdev,
244 struct rsnd_priv *priv);
245int rsnd_gen_path_init(struct rsnd_priv *priv,
246 struct rsnd_dai *rdai,
247 struct rsnd_dai_stream *io);
248int rsnd_gen_path_exit(struct rsnd_priv *priv,
249 struct rsnd_dai *rdai,
250 struct rsnd_dai_stream *io);
251void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
252 struct rsnd_mod *mod,
253 enum rsnd_reg reg);
c5d5a58d
KM
254#define rsnd_is_gen1(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
255#define rsnd_is_gen2(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
3337744a 256
dfc9403b
KM
257/*
258 * R-Car ADG
259 */
260int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
261int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
262int rsnd_adg_probe(struct platform_device *pdev,
263 struct rcar_snd_info *info,
264 struct rsnd_priv *priv);
265void rsnd_adg_remove(struct platform_device *pdev,
266 struct rsnd_priv *priv);
28dc4b63
KM
267int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
268 struct rsnd_mod *mod,
269 unsigned int src_rate,
270 unsigned int dst_rate);
629509c5
KM
271int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
272 struct rsnd_dai *rdai,
273 struct rsnd_dai_stream *io,
274 unsigned int src_rate,
275 unsigned int dst_rate);
276int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
277 struct rsnd_dai *rdai,
278 struct rsnd_dai_stream *io);
dfc9403b 279
1536a968
KM
280/*
281 * R-Car sound priv
282 */
283struct rsnd_priv {
284
285 struct device *dev;
286 struct rcar_snd_info *info;
287 spinlock_t lock;
288
3337744a
KM
289 /*
290 * below value will be filled on rsnd_gen_probe()
291 */
292 void *gen;
293
07539c1d
KM
294 /*
295 * below value will be filled on rsnd_scu_probe()
296 */
297 void *scu;
298 int scu_nr;
299
dfc9403b
KM
300 /*
301 * below value will be filled on rsnd_adg_probe()
302 */
303 void *adg;
304
ae5c3223
KM
305 /*
306 * below value will be filled on rsnd_ssi_probe()
307 */
dd27d808
KM
308 void *ssi;
309 int ssi_nr;
ae5c3223 310
1536a968
KM
311 /*
312 * below value will be filled on rsnd_dai_probe()
313 */
314 struct snd_soc_dai_driver *daidrv;
315 struct rsnd_dai *rdai;
316 int dai_nr;
317};
318
319#define rsnd_priv_to_dev(priv) ((priv)->dev)
320#define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
321#define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
322
07539c1d
KM
323/*
324 * R-Car SCU
325 */
326int rsnd_scu_probe(struct platform_device *pdev,
327 struct rcar_snd_info *info,
328 struct rsnd_priv *priv);
329void rsnd_scu_remove(struct platform_device *pdev,
330 struct rsnd_priv *priv);
331struct rsnd_mod *rsnd_scu_mod_get(struct rsnd_priv *priv, int id);
ef749400
KM
332unsigned int rsnd_scu_get_ssi_rate(struct rsnd_priv *priv,
333 struct rsnd_mod *ssi_mod,
334 struct snd_pcm_runtime *runtime);
335
07539c1d
KM
336#define rsnd_scu_nr(priv) ((priv)->scu_nr)
337
ae5c3223
KM
338/*
339 * R-Car SSI
340 */
341int rsnd_ssi_probe(struct platform_device *pdev,
342 struct rcar_snd_info *info,
343 struct rsnd_priv *priv);
344void rsnd_ssi_remove(struct platform_device *pdev,
345 struct rsnd_priv *priv);
346struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
4b4dab82
KM
347struct rsnd_mod *rsnd_ssi_mod_get_frm_dai(struct rsnd_priv *priv,
348 int dai_id, int is_play);
7b5ce975 349int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
32f27ebf 350int rsnd_ssi_is_play(struct rsnd_mod *mod);
ae5c3223 351
1536a968 352#endif
This page took 0.058459 seconds and 5 git commands to generate.