]> git.proxmox.com Git - mirror_ubuntu-bionic-kernel.git/blob - sound/soc/sh/rcar/rsnd.h
ASoC: rsnd: count each mod (SSI/SRC/DVC)
[mirror_ubuntu-bionic-kernel.git] / sound / soc / sh / rcar / rsnd.h
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_SCU_SYS_STATUS0,
48 RSND_REG_SCU_SYS_INT_EN0,
49 RSND_REG_CMD_ROUTE_SLCT,
50 RSND_REG_DVC_SWRSR,
51 RSND_REG_DVC_DVUIR,
52 RSND_REG_DVC_ADINR,
53 RSND_REG_DVC_DVUCR,
54 RSND_REG_DVC_ZCMCR,
55 RSND_REG_DVC_VOL0R,
56 RSND_REG_DVC_VOL1R,
57 RSND_REG_DVC_DVUER,
58
59 /* ADG */
60 RSND_REG_BRRA,
61 RSND_REG_BRRB,
62 RSND_REG_SSICKR,
63 RSND_REG_AUDIO_CLK_SEL0,
64 RSND_REG_AUDIO_CLK_SEL1,
65
66 /* SSI */
67 RSND_REG_SSICR,
68 RSND_REG_SSISR,
69 RSND_REG_SSITDR,
70 RSND_REG_SSIRDR,
71 RSND_REG_SSIWSR,
72
73 /* SHARE see below */
74 RSND_REG_SHARE01,
75 RSND_REG_SHARE02,
76 RSND_REG_SHARE03,
77 RSND_REG_SHARE04,
78 RSND_REG_SHARE05,
79 RSND_REG_SHARE06,
80 RSND_REG_SHARE07,
81 RSND_REG_SHARE08,
82 RSND_REG_SHARE09,
83 RSND_REG_SHARE10,
84 RSND_REG_SHARE11,
85 RSND_REG_SHARE12,
86 RSND_REG_SHARE13,
87 RSND_REG_SHARE14,
88 RSND_REG_SHARE15,
89 RSND_REG_SHARE16,
90 RSND_REG_SHARE17,
91 RSND_REG_SHARE18,
92 RSND_REG_SHARE19,
93 RSND_REG_SHARE20,
94 RSND_REG_SHARE21,
95 RSND_REG_SHARE22,
96 RSND_REG_SHARE23,
97 RSND_REG_SHARE24,
98 RSND_REG_SHARE25,
99 RSND_REG_SHARE26,
100 RSND_REG_SHARE27,
101 RSND_REG_SHARE28,
102
103 RSND_REG_MAX,
104 };
105
106 /* Gen1 only */
107 #define RSND_REG_SRC_ROUTE_SEL RSND_REG_SHARE01
108 #define RSND_REG_SRC_TMG_SEL0 RSND_REG_SHARE02
109 #define RSND_REG_SRC_TMG_SEL1 RSND_REG_SHARE03
110 #define RSND_REG_SRC_TMG_SEL2 RSND_REG_SHARE04
111 #define RSND_REG_SRC_ROUTE_CTRL RSND_REG_SHARE05
112 #define RSND_REG_SRC_MNFSR RSND_REG_SHARE06
113 #define RSND_REG_AUDIO_CLK_SEL3 RSND_REG_SHARE07
114 #define RSND_REG_AUDIO_CLK_SEL4 RSND_REG_SHARE08
115 #define RSND_REG_AUDIO_CLK_SEL5 RSND_REG_SHARE09
116
117 /* Gen2 only */
118 #define RSND_REG_SRC_CTRL RSND_REG_SHARE01
119 #define RSND_REG_SSI_CTRL RSND_REG_SHARE02
120 #define RSND_REG_SSI_BUSIF_MODE RSND_REG_SHARE03
121 #define RSND_REG_SSI_BUSIF_ADINR RSND_REG_SHARE04
122 #define RSND_REG_INT_ENABLE RSND_REG_SHARE05
123 #define RSND_REG_SRC_BSDSR RSND_REG_SHARE06
124 #define RSND_REG_SRC_BSISR RSND_REG_SHARE07
125 #define RSND_REG_DIV_EN RSND_REG_SHARE08
126 #define RSND_REG_SRCIN_TIMSEL0 RSND_REG_SHARE09
127 #define RSND_REG_SRCIN_TIMSEL1 RSND_REG_SHARE10
128 #define RSND_REG_SRCIN_TIMSEL2 RSND_REG_SHARE11
129 #define RSND_REG_SRCIN_TIMSEL3 RSND_REG_SHARE12
130 #define RSND_REG_SRCIN_TIMSEL4 RSND_REG_SHARE13
131 #define RSND_REG_SRCOUT_TIMSEL0 RSND_REG_SHARE14
132 #define RSND_REG_SRCOUT_TIMSEL1 RSND_REG_SHARE15
133 #define RSND_REG_SRCOUT_TIMSEL2 RSND_REG_SHARE16
134 #define RSND_REG_SRCOUT_TIMSEL3 RSND_REG_SHARE17
135 #define RSND_REG_SRCOUT_TIMSEL4 RSND_REG_SHARE18
136 #define RSND_REG_AUDIO_CLK_SEL2 RSND_REG_SHARE19
137 #define RSND_REG_CMD_CTRL RSND_REG_SHARE20
138 #define RSND_REG_CMDOUT_TIMSEL RSND_REG_SHARE21
139 #define RSND_REG_BUSIF_DALIGN RSND_REG_SHARE22
140 #define RSND_REG_DVC_VRCTR RSND_REG_SHARE23
141 #define RSND_REG_DVC_VRPDR RSND_REG_SHARE24
142 #define RSND_REG_DVC_VRDBR RSND_REG_SHARE25
143 #define RSND_REG_SCU_SYS_STATUS1 RSND_REG_SHARE26
144 #define RSND_REG_SCU_SYS_INT_EN1 RSND_REG_SHARE27
145 #define RSND_REG_SRC_INT_ENABLE0 RSND_REG_SHARE28
146
147 struct rsnd_of_data;
148 struct rsnd_priv;
149 struct rsnd_mod;
150 struct rsnd_dai;
151 struct rsnd_dai_stream;
152
153 /*
154 * R-Car basic functions
155 */
156 #define rsnd_mod_read(m, r) \
157 rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
158 #define rsnd_mod_write(m, r, d) \
159 rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
160 #define rsnd_mod_bset(m, r, s, d) \
161 rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
162
163 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
164 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
165 enum rsnd_reg reg, u32 data);
166 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
167 u32 mask, u32 data);
168 u32 rsnd_get_adinr(struct rsnd_mod *mod);
169
170 /*
171 * R-Car DMA
172 */
173 struct rsnd_dma;
174 struct rsnd_dma_ops {
175 void (*start)(struct rsnd_dma *dma);
176 void (*stop)(struct rsnd_dma *dma);
177 int (*init)(struct rsnd_priv *priv, struct rsnd_dma *dma, int id,
178 struct rsnd_mod *mod_from, struct rsnd_mod *mod_to);
179 void (*quit)(struct rsnd_dma *dma);
180 };
181
182 struct rsnd_dmaen {
183 struct dma_chan *chan;
184 };
185
186 struct rsnd_dmapp {
187 int dmapp_id;
188 u32 chcr;
189 };
190
191 struct rsnd_dma {
192 struct rsnd_dma_ops *ops;
193 dma_addr_t src_addr;
194 dma_addr_t dst_addr;
195 union {
196 struct rsnd_dmaen en;
197 struct rsnd_dmapp pp;
198 } dma;
199 };
200 #define rsnd_dma_to_dmaen(dma) (&(dma)->dma.en)
201 #define rsnd_dma_to_dmapp(dma) (&(dma)->dma.pp)
202
203 void rsnd_dma_start(struct rsnd_dma *dma);
204 void rsnd_dma_stop(struct rsnd_dma *dma);
205 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma, int id);
206 void rsnd_dma_quit(struct rsnd_dma *dma);
207 int rsnd_dma_probe(struct platform_device *pdev,
208 const struct rsnd_of_data *of_data,
209 struct rsnd_priv *priv);
210 struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node,
211 struct rsnd_mod *mod, char *name);
212
213 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
214
215 /*
216 * R-Car sound mod
217 */
218 enum rsnd_mod_type {
219 RSND_MOD_DVC = 0,
220 RSND_MOD_SRC,
221 RSND_MOD_SSI,
222 RSND_MOD_MAX,
223 };
224
225 struct rsnd_mod_ops {
226 char *name;
227 struct dma_chan* (*dma_req)(struct rsnd_mod *mod);
228 int (*probe)(struct rsnd_mod *mod,
229 struct rsnd_priv *priv);
230 int (*remove)(struct rsnd_mod *mod,
231 struct rsnd_priv *priv);
232 int (*init)(struct rsnd_mod *mod,
233 struct rsnd_priv *priv);
234 int (*quit)(struct rsnd_mod *mod,
235 struct rsnd_priv *priv);
236 int (*start)(struct rsnd_mod *mod,
237 struct rsnd_priv *priv);
238 int (*stop)(struct rsnd_mod *mod,
239 struct rsnd_priv *priv);
240 int (*pcm_new)(struct rsnd_mod *mod,
241 struct snd_soc_pcm_runtime *rtd);
242 int (*hw_params)(struct rsnd_mod *mod,
243 struct snd_pcm_substream *substream,
244 struct snd_pcm_hw_params *hw_params);
245 int (*fallback)(struct rsnd_mod *mod,
246 struct rsnd_priv *priv);
247 };
248
249 struct rsnd_dai_stream;
250 struct rsnd_mod {
251 int id;
252 enum rsnd_mod_type type;
253 struct rsnd_mod_ops *ops;
254 struct rsnd_dma dma;
255 struct rsnd_dai_stream *io;
256 struct clk *clk;
257 u32 status;
258 };
259 /*
260 * status
261 *
262 * 0xH0000CBA
263 *
264 * A 0: probe 1: remove
265 * B 0: init 1: quit
266 * C 0: start 1: stop
267 *
268 * H is always called (see __rsnd_mod_call)
269 * H 0: pcm_new
270 * H 0: fallback
271 * H 0: hw_params
272 */
273 #define __rsnd_mod_shift_probe 0
274 #define __rsnd_mod_shift_remove 0
275 #define __rsnd_mod_shift_init 4
276 #define __rsnd_mod_shift_quit 4
277 #define __rsnd_mod_shift_start 8
278 #define __rsnd_mod_shift_stop 8
279 #define __rsnd_mod_shift_pcm_new 28 /* always called */
280 #define __rsnd_mod_shift_fallback 28 /* always called */
281 #define __rsnd_mod_shift_hw_params 28 /* always called */
282
283 #define __rsnd_mod_add_probe 1
284 #define __rsnd_mod_add_remove -1
285 #define __rsnd_mod_add_init 1
286 #define __rsnd_mod_add_quit -1
287 #define __rsnd_mod_add_start 1
288 #define __rsnd_mod_add_stop -1
289 #define __rsnd_mod_add_pcm_new 0
290 #define __rsnd_mod_add_fallback 0
291 #define __rsnd_mod_add_hw_params 0
292
293 #define __rsnd_mod_call_probe 0
294 #define __rsnd_mod_call_remove 1
295 #define __rsnd_mod_call_init 0
296 #define __rsnd_mod_call_quit 1
297 #define __rsnd_mod_call_start 0
298 #define __rsnd_mod_call_stop 1
299 #define __rsnd_mod_call_pcm_new 0
300 #define __rsnd_mod_call_fallback 0
301 #define __rsnd_mod_call_hw_params 0
302
303 #define rsnd_mod_to_priv(mod) (rsnd_io_to_priv(rsnd_mod_to_io(mod)))
304 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
305 #define rsnd_mod_to_io(mod) ((mod)->io)
306 #define rsnd_mod_id(mod) ((mod)->id)
307 #define rsnd_mod_hw_start(mod) clk_enable((mod)->clk)
308 #define rsnd_mod_hw_stop(mod) clk_disable((mod)->clk)
309
310 int rsnd_mod_init(struct rsnd_mod *mod,
311 struct rsnd_mod_ops *ops,
312 struct clk *clk,
313 enum rsnd_mod_type type,
314 int id);
315 void rsnd_mod_quit(struct rsnd_mod *mod);
316 char *rsnd_mod_name(struct rsnd_mod *mod);
317 int rsnd_mod_is_working(struct rsnd_mod *mod);
318 struct dma_chan *rsnd_mod_dma_req(struct rsnd_mod *mod);
319
320 /*
321 * R-Car sound DAI
322 */
323 #define RSND_DAI_NAME_SIZE 16
324 struct rsnd_dai_stream {
325 char name[RSND_DAI_NAME_SIZE];
326 struct snd_pcm_substream *substream;
327 struct rsnd_mod *mod[RSND_MOD_MAX];
328 struct rsnd_dai_path_info *info; /* rcar_snd.h */
329 struct rsnd_dai *rdai;
330 int byte_pos;
331 int period_pos;
332 int byte_per_period;
333 int next_period_byte;
334 };
335 #define rsnd_io_to_mod_ssi(io) ((io)->mod[RSND_MOD_SSI])
336 #define rsnd_io_to_mod_src(io) ((io)->mod[RSND_MOD_SRC])
337 #define rsnd_io_to_mod_dvc(io) ((io)->mod[RSND_MOD_DVC])
338 #define rsnd_io_to_rdai(io) ((io)->rdai)
339 #define rsnd_io_to_priv(io) (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
340 #define rsnd_io_is_play(io) (&rsnd_io_to_rdai(io)->playback == io)
341 #define rsnd_io_to_runtime(io) ((io)->substream ? \
342 (io)->substream->runtime : NULL)
343
344
345 struct rsnd_dai {
346 char name[RSND_DAI_NAME_SIZE];
347 struct rsnd_dai_stream playback;
348 struct rsnd_dai_stream capture;
349 struct rsnd_priv *priv;
350
351 unsigned int clk_master:1;
352 unsigned int bit_clk_inv:1;
353 unsigned int frm_clk_inv:1;
354 unsigned int sys_delay:1;
355 unsigned int data_alignment:1;
356 };
357
358 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
359 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
360 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
361 #define for_each_rsnd_dai(rdai, priv, i) \
362 for (i = 0; \
363 (i < rsnd_rdai_nr(priv)) && \
364 ((rdai) = rsnd_rdai_get(priv, i)); \
365 i++)
366
367 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
368
369 bool rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
370 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
371 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
372
373 /*
374 * R-Car Gen1/Gen2
375 */
376 int rsnd_gen_probe(struct platform_device *pdev,
377 const struct rsnd_of_data *of_data,
378 struct rsnd_priv *priv);
379 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
380 struct rsnd_mod *mod,
381 enum rsnd_reg reg);
382 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
383
384 #define rsnd_is_gen1(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
385 #define rsnd_is_gen2(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
386
387 /*
388 * R-Car ADG
389 */
390 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
391 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
392 int rsnd_adg_probe(struct platform_device *pdev,
393 const struct rsnd_of_data *of_data,
394 struct rsnd_priv *priv);
395 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
396 struct rsnd_mod *mod,
397 unsigned int src_rate,
398 unsigned int dst_rate);
399 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
400 struct rsnd_dai_stream *io,
401 unsigned int src_rate,
402 unsigned int dst_rate);
403 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
404 struct rsnd_dai_stream *io);
405 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
406 struct rsnd_dai_stream *io);
407
408 /*
409 * R-Car sound priv
410 */
411 struct rsnd_of_data {
412 u32 flags;
413 };
414
415 struct rsnd_priv {
416
417 struct platform_device *pdev;
418 struct rcar_snd_info *info;
419 spinlock_t lock;
420
421 /*
422 * below value will be filled on rsnd_gen_probe()
423 */
424 void *gen;
425
426 /*
427 * below value will be filled on rsnd_src_probe()
428 */
429 void *src;
430 int src_nr;
431
432 /*
433 * below value will be filled on rsnd_adg_probe()
434 */
435 void *adg;
436
437 /*
438 * below value will be filled on rsnd_dma_probe()
439 */
440 void *dma;
441
442 /*
443 * below value will be filled on rsnd_ssi_probe()
444 */
445 void *ssi;
446 int ssi_nr;
447
448 /*
449 * below value will be filled on rsnd_dvc_probe()
450 */
451 void *dvc;
452 int dvc_nr;
453
454 /*
455 * below value will be filled on rsnd_dai_probe()
456 */
457 struct snd_soc_dai_driver *daidrv;
458 struct rsnd_dai *rdai;
459 int rdai_nr;
460 };
461
462 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
463 #define rsnd_priv_to_dev(priv) (&(rsnd_priv_to_pdev(priv)->dev))
464 #define rsnd_priv_to_info(priv) ((priv)->info)
465
466 /*
467 * rsnd_kctrl
468 */
469 struct rsnd_kctrl_cfg {
470 unsigned int max;
471 unsigned int size;
472 u32 *val;
473 const char * const *texts;
474 void (*update)(struct rsnd_mod *mod);
475 struct snd_card *card;
476 struct snd_kcontrol *kctrl;
477 };
478
479 #define RSND_DVC_CHANNELS 2
480 struct rsnd_kctrl_cfg_m {
481 struct rsnd_kctrl_cfg cfg;
482 u32 val[RSND_DVC_CHANNELS];
483 };
484
485 struct rsnd_kctrl_cfg_s {
486 struct rsnd_kctrl_cfg cfg;
487 u32 val;
488 };
489
490 void _rsnd_kctrl_remove(struct rsnd_kctrl_cfg *cfg);
491 #define rsnd_kctrl_remove(_cfg) _rsnd_kctrl_remove(&((_cfg).cfg))
492
493 int rsnd_kctrl_new_m(struct rsnd_mod *mod,
494 struct snd_soc_pcm_runtime *rtd,
495 const unsigned char *name,
496 void (*update)(struct rsnd_mod *mod),
497 struct rsnd_kctrl_cfg_m *_cfg,
498 u32 max);
499 int rsnd_kctrl_new_s(struct rsnd_mod *mod,
500 struct snd_soc_pcm_runtime *rtd,
501 const unsigned char *name,
502 void (*update)(struct rsnd_mod *mod),
503 struct rsnd_kctrl_cfg_s *_cfg,
504 u32 max);
505 int rsnd_kctrl_new_e(struct rsnd_mod *mod,
506 struct snd_soc_pcm_runtime *rtd,
507 const unsigned char *name,
508 struct rsnd_kctrl_cfg_s *_cfg,
509 void (*update)(struct rsnd_mod *mod),
510 const char * const *texts,
511 u32 max);
512
513 /*
514 * R-Car SRC
515 */
516 int rsnd_src_probe(struct platform_device *pdev,
517 const struct rsnd_of_data *of_data,
518 struct rsnd_priv *priv);
519 void rsnd_src_remove(struct platform_device *pdev,
520 struct rsnd_priv *priv);
521 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
522 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
523 struct rsnd_dai_stream *io,
524 struct snd_pcm_runtime *runtime);
525 int rsnd_src_ssiu_start(struct rsnd_mod *ssi_mod,
526 int use_busif);
527 int rsnd_src_ssiu_stop(struct rsnd_mod *ssi_mod);
528 int rsnd_src_ssi_irq_enable(struct rsnd_mod *ssi_mod);
529 int rsnd_src_ssi_irq_disable(struct rsnd_mod *ssi_mod);
530
531 #define rsnd_src_nr(priv) ((priv)->src_nr)
532
533 /*
534 * R-Car SSI
535 */
536 int rsnd_ssi_probe(struct platform_device *pdev,
537 const struct rsnd_of_data *of_data,
538 struct rsnd_priv *priv);
539 void rsnd_ssi_remove(struct platform_device *pdev,
540 struct rsnd_priv *priv);
541 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
542 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
543 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
544 int rsnd_ssi_use_busif(struct rsnd_mod *mod);
545
546 /*
547 * R-Car DVC
548 */
549 int rsnd_dvc_probe(struct platform_device *pdev,
550 const struct rsnd_of_data *of_data,
551 struct rsnd_priv *priv);
552 void rsnd_dvc_remove(struct platform_device *pdev,
553 struct rsnd_priv *priv);
554 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
555
556 #define rsnd_dvc_nr(priv) ((priv)->dvc_nr)
557
558
559 #endif