Add the rt linux 4.1.3-rt3 as base
[kvmfornfv.git] / kernel / 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  * bit
263  * 0    0: probe        1: remove
264  * 1    0: init         1: quit
265  * 2    0: start        1: stop
266  * 3    0: pcm_new
267  * 4    0: fallback
268  *
269  * 31 bit is always called (see __rsnd_mod_call)
270  * 31   0: hw_params
271  */
272 #define __rsnd_mod_shift_probe          0
273 #define __rsnd_mod_shift_remove         0
274 #define __rsnd_mod_shift_init           1
275 #define __rsnd_mod_shift_quit           1
276 #define __rsnd_mod_shift_start          2
277 #define __rsnd_mod_shift_stop           2
278 #define __rsnd_mod_shift_pcm_new        3
279 #define __rsnd_mod_shift_fallback       4
280 #define __rsnd_mod_shift_hw_params      31 /* always called */
281
282 #define __rsnd_mod_call_probe           0
283 #define __rsnd_mod_call_remove          1
284 #define __rsnd_mod_call_init            0
285 #define __rsnd_mod_call_quit            1
286 #define __rsnd_mod_call_start           0
287 #define __rsnd_mod_call_stop            1
288 #define __rsnd_mod_call_pcm_new         0
289 #define __rsnd_mod_call_fallback        0
290 #define __rsnd_mod_call_hw_params       0
291
292 #define rsnd_mod_to_priv(mod) (rsnd_io_to_priv(rsnd_mod_to_io(mod)))
293 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
294 #define rsnd_mod_to_io(mod) ((mod)->io)
295 #define rsnd_mod_id(mod) ((mod)->id)
296 #define rsnd_mod_hw_start(mod)  clk_enable((mod)->clk)
297 #define rsnd_mod_hw_stop(mod)   clk_disable((mod)->clk)
298
299 int rsnd_mod_init(struct rsnd_mod *mod,
300                    struct rsnd_mod_ops *ops,
301                    struct clk *clk,
302                    enum rsnd_mod_type type,
303                    int id);
304 void rsnd_mod_quit(struct rsnd_mod *mod);
305 char *rsnd_mod_name(struct rsnd_mod *mod);
306 struct dma_chan *rsnd_mod_dma_req(struct rsnd_mod *mod);
307
308 /*
309  *      R-Car sound DAI
310  */
311 #define RSND_DAI_NAME_SIZE      16
312 struct rsnd_dai_stream {
313         char name[RSND_DAI_NAME_SIZE];
314         struct snd_pcm_substream *substream;
315         struct rsnd_mod *mod[RSND_MOD_MAX];
316         struct rsnd_dai_path_info *info; /* rcar_snd.h */
317         struct rsnd_dai *rdai;
318         int byte_pos;
319         int period_pos;
320         int byte_per_period;
321         int next_period_byte;
322 };
323 #define rsnd_io_to_mod_ssi(io)  ((io)->mod[RSND_MOD_SSI])
324 #define rsnd_io_to_mod_src(io)  ((io)->mod[RSND_MOD_SRC])
325 #define rsnd_io_to_mod_dvc(io)  ((io)->mod[RSND_MOD_DVC])
326 #define rsnd_io_to_rdai(io)     ((io)->rdai)
327 #define rsnd_io_to_priv(io)     (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
328 #define rsnd_io_is_play(io)     (&rsnd_io_to_rdai(io)->playback == io)
329 #define rsnd_io_to_runtime(io) ((io)->substream ? \
330                                 (io)->substream->runtime : NULL)
331
332
333 struct rsnd_dai {
334         char name[RSND_DAI_NAME_SIZE];
335         struct rsnd_dai_stream playback;
336         struct rsnd_dai_stream capture;
337         struct rsnd_priv *priv;
338
339         unsigned int clk_master:1;
340         unsigned int bit_clk_inv:1;
341         unsigned int frm_clk_inv:1;
342         unsigned int sys_delay:1;
343         unsigned int data_alignment:1;
344 };
345
346 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
347 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
348 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
349 #define for_each_rsnd_dai(rdai, priv, i)                \
350         for (i = 0;                                     \
351              (i < rsnd_rdai_nr(priv)) &&                \
352              ((rdai) = rsnd_rdai_get(priv, i));         \
353              i++)
354
355 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
356
357 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
358 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
359
360 /*
361  *      R-Car Gen1/Gen2
362  */
363 int rsnd_gen_probe(struct platform_device *pdev,
364                    const struct rsnd_of_data *of_data,
365                    struct rsnd_priv *priv);
366 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
367                                struct rsnd_mod *mod,
368                                enum rsnd_reg reg);
369 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
370
371 #define rsnd_is_gen1(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
372 #define rsnd_is_gen2(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
373
374 /*
375  *      R-Car ADG
376  */
377 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
378 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
379 int rsnd_adg_probe(struct platform_device *pdev,
380                    const struct rsnd_of_data *of_data,
381                    struct rsnd_priv *priv);
382 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
383                                   struct rsnd_mod *mod,
384                                   unsigned int src_rate,
385                                   unsigned int dst_rate);
386 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
387                                   struct rsnd_dai_stream *io,
388                                   unsigned int src_rate,
389                                   unsigned int dst_rate);
390 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
391                                      struct rsnd_dai_stream *io);
392 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
393                                  struct rsnd_dai_stream *io);
394
395 /*
396  *      R-Car sound priv
397  */
398 struct rsnd_of_data {
399         u32 flags;
400 };
401
402 struct rsnd_priv {
403
404         struct platform_device *pdev;
405         struct rcar_snd_info *info;
406         spinlock_t lock;
407
408         /*
409          * below value will be filled on rsnd_gen_probe()
410          */
411         void *gen;
412
413         /*
414          * below value will be filled on rsnd_src_probe()
415          */
416         void *src;
417         int src_nr;
418
419         /*
420          * below value will be filled on rsnd_adg_probe()
421          */
422         void *adg;
423
424         /*
425          * below value will be filled on rsnd_dma_probe()
426          */
427         void *dma;
428
429         /*
430          * below value will be filled on rsnd_ssi_probe()
431          */
432         void *ssi;
433         int ssi_nr;
434
435         /*
436          * below value will be filled on rsnd_dvc_probe()
437          */
438         void *dvc;
439         int dvc_nr;
440
441         /*
442          * below value will be filled on rsnd_dai_probe()
443          */
444         struct snd_soc_dai_driver *daidrv;
445         struct rsnd_dai *rdai;
446         int rdai_nr;
447 };
448
449 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
450 #define rsnd_priv_to_dev(priv)  (&(rsnd_priv_to_pdev(priv)->dev))
451 #define rsnd_priv_to_info(priv) ((priv)->info)
452 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
453 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
454
455 /*
456  *      rsnd_kctrl
457  */
458 struct rsnd_kctrl_cfg {
459         unsigned int max;
460         unsigned int size;
461         u32 *val;
462         const char * const *texts;
463         void (*update)(struct rsnd_mod *mod);
464         struct snd_card *card;
465         struct snd_kcontrol *kctrl;
466 };
467
468 #define RSND_DVC_CHANNELS       2
469 struct rsnd_kctrl_cfg_m {
470         struct rsnd_kctrl_cfg cfg;
471         u32 val[RSND_DVC_CHANNELS];
472 };
473
474 struct rsnd_kctrl_cfg_s {
475         struct rsnd_kctrl_cfg cfg;
476         u32 val;
477 };
478
479 void _rsnd_kctrl_remove(struct rsnd_kctrl_cfg *cfg);
480 #define rsnd_kctrl_remove(_cfg) _rsnd_kctrl_remove(&((_cfg).cfg))
481
482 int rsnd_kctrl_new_m(struct rsnd_mod *mod,
483                      struct snd_soc_pcm_runtime *rtd,
484                      const unsigned char *name,
485                      void (*update)(struct rsnd_mod *mod),
486                      struct rsnd_kctrl_cfg_m *_cfg,
487                      u32 max);
488 int rsnd_kctrl_new_s(struct rsnd_mod *mod,
489                      struct snd_soc_pcm_runtime *rtd,
490                      const unsigned char *name,
491                      void (*update)(struct rsnd_mod *mod),
492                      struct rsnd_kctrl_cfg_s *_cfg,
493                      u32 max);
494 int rsnd_kctrl_new_e(struct rsnd_mod *mod,
495                      struct snd_soc_pcm_runtime *rtd,
496                      const unsigned char *name,
497                      struct rsnd_kctrl_cfg_s *_cfg,
498                      void (*update)(struct rsnd_mod *mod),
499                      const char * const *texts,
500                      u32 max);
501
502 /*
503  *      R-Car SRC
504  */
505 int rsnd_src_probe(struct platform_device *pdev,
506                    const struct rsnd_of_data *of_data,
507                    struct rsnd_priv *priv);
508 void rsnd_src_remove(struct platform_device *pdev,
509                      struct rsnd_priv *priv);
510 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
511 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
512                                    struct rsnd_dai_stream *io,
513                                    struct snd_pcm_runtime *runtime);
514 int rsnd_src_ssiu_start(struct rsnd_mod *ssi_mod,
515                         int use_busif);
516 int rsnd_src_ssiu_stop(struct rsnd_mod *ssi_mod);
517 int rsnd_src_ssi_irq_enable(struct rsnd_mod *ssi_mod);
518 int rsnd_src_ssi_irq_disable(struct rsnd_mod *ssi_mod);
519
520 #define rsnd_src_nr(priv) ((priv)->src_nr)
521
522 /*
523  *      R-Car SSI
524  */
525 int rsnd_ssi_probe(struct platform_device *pdev,
526                    const struct rsnd_of_data *of_data,
527                    struct rsnd_priv *priv);
528 void rsnd_ssi_remove(struct platform_device *pdev,
529                      struct rsnd_priv *priv);
530 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
531 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
532 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
533 int rsnd_ssi_use_busif(struct rsnd_mod *mod);
534
535 /*
536  *      R-Car DVC
537  */
538 int rsnd_dvc_probe(struct platform_device *pdev,
539                    const struct rsnd_of_data *of_data,
540                    struct rsnd_priv *priv);
541 void rsnd_dvc_remove(struct platform_device *pdev,
542                      struct rsnd_priv *priv);
543 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
544
545 #define rsnd_dvc_nr(priv) ((priv)->dvc_nr)
546
547
548 #endif