]> git.proxmox.com Git - mirror_ubuntu-focal-kernel.git/blame - sound/soc/sh/rcar/rsnd.h
ASoC: rsnd: care DMA slave channel name for DT
[mirror_ubuntu-focal-kernel.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>
90e8e50f
KM
20#include <linux/of_device.h>
21#include <linux/of_irq.h>
0a4d94c0
KM
22#include <linux/sh_dma.h>
23#include <linux/workqueue.h>
1536a968
KM
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 */
3337744a 35enum rsnd_reg {
507d466c 36 /* SRU/SCU/SSIU */
07539c1d
KM
37 RSND_REG_SSI_MODE0,
38 RSND_REG_SSI_MODE1,
0290d2a4 39 RSND_REG_SRC_BUSIF_MODE,
ef749400
KM
40 RSND_REG_SRC_ROUTE_MODE0,
41 RSND_REG_SRC_SWRSR,
42 RSND_REG_SRC_SRCIR,
690ef81e 43 RSND_REG_SRC_ADINR,
ef749400
KM
44 RSND_REG_SRC_IFSCR,
45 RSND_REG_SRC_IFSVR,
46 RSND_REG_SRC_SRCCR,
bff58ea4
KM
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,
07539c1d 56
dfc9403b
KM
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,
dfc9403b 63
ae5c3223
KM
64 /* SSI */
65 RSND_REG_SSICR,
66 RSND_REG_SSISR,
67 RSND_REG_SSITDR,
68 RSND_REG_SSIRDR,
69 RSND_REG_SSIWSR,
70
c82e1c88
KM
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,
bff58ea4
KM
91 RSND_REG_SHARE20,
92 RSND_REG_SHARE21,
c82e1c88 93
3337744a
KM
94 RSND_REG_MAX,
95};
96
c82e1c88
KM
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
bff58ea4
KM
128#define RSND_REG_CMD_CTRL RSND_REG_SHARE20
129#define RSND_REG_CMDOUT_TIMSEL RSND_REG_SHARE21
c82e1c88 130
90e8e50f 131struct rsnd_of_data;
1536a968 132struct rsnd_priv;
cdaa3cdf 133struct rsnd_mod;
1536a968
KM
134struct rsnd_dai;
135struct rsnd_dai_stream;
136
3337744a
KM
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
3337744a
KM
147u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
148void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
149 enum rsnd_reg reg, u32 data);
150void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
151 u32 mask, u32 data);
d7bdbc5d 152u32 rsnd_get_adinr(struct rsnd_mod *mod);
3337744a 153
0a4d94c0
KM
154/*
155 * R-Car DMA
156 */
157struct rsnd_dma {
0a4d94c0
KM
158 struct sh_dmae_slave slave;
159 struct work_struct work;
160 struct dma_chan *chan;
161 enum dma_data_direction dir;
0a4d94c0
KM
162
163 int submit_loop;
4686a0ad 164 int offset; /* it cares A/B plane */
0a4d94c0
KM
165};
166
167void rsnd_dma_start(struct rsnd_dma *dma);
168void rsnd_dma_stop(struct rsnd_dma *dma);
169int rsnd_dma_available(struct rsnd_dma *dma);
170int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
4686a0ad 171 int is_play, int id);
0a4d94c0
KM
172void rsnd_dma_quit(struct rsnd_priv *priv,
173 struct rsnd_dma *dma);
174
175
cdaa3cdf
KM
176/*
177 * R-Car sound mod
178 */
a126021d 179enum rsnd_mod_type {
ba9c949f 180 RSND_MOD_SRC = 0,
a126021d 181 RSND_MOD_SSI,
bff58ea4 182 RSND_MOD_DVC,
a126021d
KM
183 RSND_MOD_MAX,
184};
cdaa3cdf
KM
185
186struct rsnd_mod_ops {
187 char *name;
7681f6ac 188 int (*probe)(struct rsnd_mod *mod,
b42fccf6 189 struct rsnd_dai *rdai);
7681f6ac 190 int (*remove)(struct rsnd_mod *mod,
b42fccf6 191 struct rsnd_dai *rdai);
cdaa3cdf 192 int (*init)(struct rsnd_mod *mod,
b42fccf6 193 struct rsnd_dai *rdai);
cdaa3cdf 194 int (*quit)(struct rsnd_mod *mod,
b42fccf6 195 struct rsnd_dai *rdai);
cdaa3cdf 196 int (*start)(struct rsnd_mod *mod,
b42fccf6 197 struct rsnd_dai *rdai);
cdaa3cdf 198 int (*stop)(struct rsnd_mod *mod,
b42fccf6 199 struct rsnd_dai *rdai);
bff58ea4
KM
200 int (*pcm_new)(struct rsnd_mod *mod,
201 struct rsnd_dai *rdai,
202 struct snd_soc_pcm_runtime *rtd);
cdaa3cdf
KM
203};
204
4686a0ad 205struct rsnd_dai_stream;
cdaa3cdf
KM
206struct rsnd_mod {
207 int id;
a126021d 208 enum rsnd_mod_type type;
cdaa3cdf
KM
209 struct rsnd_priv *priv;
210 struct rsnd_mod_ops *ops;
0a4d94c0 211 struct rsnd_dma dma;
4686a0ad 212 struct rsnd_dai_stream *io;
cdaa3cdf
KM
213};
214
215#define rsnd_mod_to_priv(mod) ((mod)->priv)
0a4d94c0
KM
216#define rsnd_mod_to_dma(mod) (&(mod)->dma)
217#define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
4686a0ad 218#define rsnd_mod_to_io(mod) ((mod)->io)
cdaa3cdf 219#define rsnd_mod_id(mod) ((mod)->id)
cdaa3cdf
KM
220
221void rsnd_mod_init(struct rsnd_priv *priv,
222 struct rsnd_mod *mod,
223 struct rsnd_mod_ops *ops,
a126021d 224 enum rsnd_mod_type type,
cdaa3cdf
KM
225 int id);
226char *rsnd_mod_name(struct rsnd_mod *mod);
227
1536a968
KM
228/*
229 * R-Car sound DAI
230 */
231#define RSND_DAI_NAME_SIZE 16
232struct rsnd_dai_stream {
1536a968 233 struct snd_pcm_substream *substream;
a126021d 234 struct rsnd_mod *mod[RSND_MOD_MAX];
389933d9 235 struct rsnd_dai_path_info *info; /* rcar_snd.h */
1536a968
KM
236 int byte_pos;
237 int period_pos;
238 int byte_per_period;
239 int next_period_byte;
240};
374e5426 241#define rsnd_io_to_mod_ssi(io) ((io)->mod[RSND_MOD_SSI])
ba9c949f 242#define rsnd_io_to_mod_src(io) ((io)->mod[RSND_MOD_SRC])
bff58ea4 243#define rsnd_io_to_mod_dvc(io) ((io)->mod[RSND_MOD_DVC])
1536a968
KM
244
245struct 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
a3737731
DC
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;
1536a968
KM
256};
257
ecba9e72 258#define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
1536a968 259#define for_each_rsnd_dai(rdai, priv, i) \
00463c11 260 for (i = 0; \
ecba9e72 261 (i < rsnd_rdai_nr(priv)) && \
00463c11
KM
262 ((rdai) = rsnd_dai_get(priv, i)); \
263 i++)
1536a968
KM
264
265struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id);
266int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io);
4b4dab82 267int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai);
1536a968 268#define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
ae5c3223 269#define rsnd_io_to_runtime(io) ((io)->substream->runtime)
1536a968
KM
270
271void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
272int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
e779a20d 273#define rsnd_dai_is_clk_master(rdai) ((rdai)->clk_master)
1536a968 274
3337744a
KM
275/*
276 * R-Car Gen1/Gen2
277 */
278int rsnd_gen_probe(struct platform_device *pdev,
90e8e50f 279 const struct rsnd_of_data *of_data,
3337744a 280 struct rsnd_priv *priv);
3337744a
KM
281void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
282 struct rsnd_mod *mod,
283 enum rsnd_reg reg);
c5d5a58d
KM
284#define rsnd_is_gen1(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
285#define rsnd_is_gen2(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
3337744a 286
dfc9403b
KM
287/*
288 * R-Car ADG
289 */
290int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
291int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
292int rsnd_adg_probe(struct platform_device *pdev,
90e8e50f 293 const struct rsnd_of_data *of_data,
dfc9403b 294 struct rsnd_priv *priv);
28dc4b63
KM
295int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
296 struct rsnd_mod *mod,
297 unsigned int src_rate,
298 unsigned int dst_rate);
629509c5
KM
299int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
300 struct rsnd_dai *rdai,
301 struct rsnd_dai_stream *io,
302 unsigned int src_rate,
303 unsigned int dst_rate);
304int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
305 struct rsnd_dai *rdai,
306 struct rsnd_dai_stream *io);
bff58ea4
KM
307int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_dai *rdai,
308 struct rsnd_mod *mod,
309 struct rsnd_dai_stream *io);
dfc9403b 310
1536a968
KM
311/*
312 * R-Car sound priv
313 */
90e8e50f
KM
314struct rsnd_of_data {
315 u32 flags;
316};
317
1536a968
KM
318struct rsnd_priv {
319
9f464f8e 320 struct platform_device *pdev;
1536a968
KM
321 struct rcar_snd_info *info;
322 spinlock_t lock;
323
3337744a
KM
324 /*
325 * below value will be filled on rsnd_gen_probe()
326 */
327 void *gen;
328
07539c1d 329 /*
ba9c949f 330 * below value will be filled on rsnd_src_probe()
07539c1d 331 */
ba9c949f
KM
332 void *src;
333 int src_nr;
07539c1d 334
dfc9403b
KM
335 /*
336 * below value will be filled on rsnd_adg_probe()
337 */
338 void *adg;
339
ae5c3223
KM
340 /*
341 * below value will be filled on rsnd_ssi_probe()
342 */
dd27d808
KM
343 void *ssi;
344 int ssi_nr;
ae5c3223 345
bff58ea4
KM
346 /*
347 * below value will be filled on rsnd_dvc_probe()
348 */
349 void *dvc;
350 int dvc_nr;
351
1536a968
KM
352 /*
353 * below value will be filled on rsnd_dai_probe()
354 */
355 struct snd_soc_dai_driver *daidrv;
356 struct rsnd_dai *rdai;
ecba9e72 357 int rdai_nr;
1536a968
KM
358};
359
9f464f8e
KM
360#define rsnd_priv_to_pdev(priv) ((priv)->pdev)
361#define rsnd_priv_to_dev(priv) (&(rsnd_priv_to_pdev(priv)->dev))
5da39cf3 362#define rsnd_priv_to_info(priv) ((priv)->info)
1536a968
KM
363#define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
364#define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
365
389933d9
KM
366#define rsnd_info_is_playback(priv, type) \
367({ \
368 struct rcar_snd_info *info = rsnd_priv_to_info(priv); \
369 int i, is_play = 0; \
370 for (i = 0; i < info->dai_info_nr; i++) { \
371 if (info->dai_info[i].playback.type == (type)->info) { \
372 is_play = 1; \
373 break; \
374 } \
375 } \
376 is_play; \
377})
378
07539c1d 379/*
ba9c949f 380 * R-Car SRC
07539c1d 381 */
ba9c949f 382int rsnd_src_probe(struct platform_device *pdev,
90e8e50f 383 const struct rsnd_of_data *of_data,
07539c1d 384 struct rsnd_priv *priv);
ba9c949f
KM
385struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
386unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
374e5426 387 struct rsnd_dai_stream *io,
ef749400 388 struct snd_pcm_runtime *runtime);
ba9c949f 389int rsnd_src_ssi_mode_init(struct rsnd_mod *ssi_mod,
b42fccf6 390 struct rsnd_dai *rdai);
ba9c949f 391int rsnd_src_enable_ssi_irq(struct rsnd_mod *ssi_mod,
b42fccf6 392 struct rsnd_dai *rdai);
ef749400 393
ba9c949f 394#define rsnd_src_nr(priv) ((priv)->src_nr)
07539c1d 395
ae5c3223
KM
396/*
397 * R-Car SSI
398 */
399int rsnd_ssi_probe(struct platform_device *pdev,
90e8e50f 400 const struct rsnd_of_data *of_data,
ae5c3223 401 struct rsnd_priv *priv);
ae5c3223 402struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
7b5ce975 403int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
ae5c3223 404
bff58ea4
KM
405/*
406 * R-Car DVC
407 */
408int rsnd_dvc_probe(struct platform_device *pdev,
409 const struct rsnd_of_data *of_data,
410 struct rsnd_priv *priv);
411void rsnd_dvc_remove(struct platform_device *pdev,
412 struct rsnd_priv *priv);
413struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
414
415#define rsnd_dvc_nr(priv) ((priv)->dvc_nr)
416
417
1536a968 418#endif