Merge branch 'x86-mm-for-linus' of git://git.kernel.org/pub/scm/linux/kernel/git...
[sfrench/cifs-2.6.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_graph.h>
22 #include <linux/of_irq.h>
23 #include <linux/sh_dma.h>
24 #include <linux/workqueue.h>
25 #include <sound/soc.h>
26 #include <sound/pcm_params.h>
27
28 #define RSND_GEN1_SRU   0
29 #define RSND_GEN1_ADG   1
30 #define RSND_GEN1_SSI   2
31
32 #define RSND_GEN2_SCU   0
33 #define RSND_GEN2_ADG   1
34 #define RSND_GEN2_SSIU  2
35 #define RSND_GEN2_SSI   3
36
37 #define RSND_BASE_MAX   4
38
39 /*
40  *      pseudo register
41  *
42  * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
43  * This driver uses pseudo register in order to hide it.
44  * see gen1/gen2 for detail
45  */
46 enum rsnd_reg {
47         /* SCU (MIX/CTU/DVC) */
48         RSND_REG_SRC_I_BUSIF_MODE,
49         RSND_REG_SRC_O_BUSIF_MODE,
50         RSND_REG_SRC_ROUTE_MODE0,
51         RSND_REG_SRC_SWRSR,
52         RSND_REG_SRC_SRCIR,
53         RSND_REG_SRC_ADINR,
54         RSND_REG_SRC_IFSCR,
55         RSND_REG_SRC_IFSVR,
56         RSND_REG_SRC_SRCCR,
57         RSND_REG_SRC_CTRL,
58         RSND_REG_SRC_BSDSR,
59         RSND_REG_SRC_BSISR,
60         RSND_REG_SRC_INT_ENABLE0,
61         RSND_REG_SRC_BUSIF_DALIGN,
62         RSND_REG_SRCIN_TIMSEL0,
63         RSND_REG_SRCIN_TIMSEL1,
64         RSND_REG_SRCIN_TIMSEL2,
65         RSND_REG_SRCIN_TIMSEL3,
66         RSND_REG_SRCIN_TIMSEL4,
67         RSND_REG_SRCOUT_TIMSEL0,
68         RSND_REG_SRCOUT_TIMSEL1,
69         RSND_REG_SRCOUT_TIMSEL2,
70         RSND_REG_SRCOUT_TIMSEL3,
71         RSND_REG_SRCOUT_TIMSEL4,
72         RSND_REG_SCU_SYS_STATUS0,
73         RSND_REG_SCU_SYS_STATUS1,
74         RSND_REG_SCU_SYS_INT_EN0,
75         RSND_REG_SCU_SYS_INT_EN1,
76         RSND_REG_CMD_CTRL,
77         RSND_REG_CMD_BUSIF_MODE,
78         RSND_REG_CMD_BUSIF_DALIGN,
79         RSND_REG_CMD_ROUTE_SLCT,
80         RSND_REG_CMDOUT_TIMSEL,
81         RSND_REG_CTU_SWRSR,
82         RSND_REG_CTU_CTUIR,
83         RSND_REG_CTU_ADINR,
84         RSND_REG_CTU_CPMDR,
85         RSND_REG_CTU_SCMDR,
86         RSND_REG_CTU_SV00R,
87         RSND_REG_CTU_SV01R,
88         RSND_REG_CTU_SV02R,
89         RSND_REG_CTU_SV03R,
90         RSND_REG_CTU_SV04R,
91         RSND_REG_CTU_SV05R,
92         RSND_REG_CTU_SV06R,
93         RSND_REG_CTU_SV07R,
94         RSND_REG_CTU_SV10R,
95         RSND_REG_CTU_SV11R,
96         RSND_REG_CTU_SV12R,
97         RSND_REG_CTU_SV13R,
98         RSND_REG_CTU_SV14R,
99         RSND_REG_CTU_SV15R,
100         RSND_REG_CTU_SV16R,
101         RSND_REG_CTU_SV17R,
102         RSND_REG_CTU_SV20R,
103         RSND_REG_CTU_SV21R,
104         RSND_REG_CTU_SV22R,
105         RSND_REG_CTU_SV23R,
106         RSND_REG_CTU_SV24R,
107         RSND_REG_CTU_SV25R,
108         RSND_REG_CTU_SV26R,
109         RSND_REG_CTU_SV27R,
110         RSND_REG_CTU_SV30R,
111         RSND_REG_CTU_SV31R,
112         RSND_REG_CTU_SV32R,
113         RSND_REG_CTU_SV33R,
114         RSND_REG_CTU_SV34R,
115         RSND_REG_CTU_SV35R,
116         RSND_REG_CTU_SV36R,
117         RSND_REG_CTU_SV37R,
118         RSND_REG_MIX_SWRSR,
119         RSND_REG_MIX_MIXIR,
120         RSND_REG_MIX_ADINR,
121         RSND_REG_MIX_MIXMR,
122         RSND_REG_MIX_MVPDR,
123         RSND_REG_MIX_MDBAR,
124         RSND_REG_MIX_MDBBR,
125         RSND_REG_MIX_MDBCR,
126         RSND_REG_MIX_MDBDR,
127         RSND_REG_MIX_MDBER,
128         RSND_REG_DVC_SWRSR,
129         RSND_REG_DVC_DVUIR,
130         RSND_REG_DVC_ADINR,
131         RSND_REG_DVC_DVUCR,
132         RSND_REG_DVC_ZCMCR,
133         RSND_REG_DVC_VOL0R,
134         RSND_REG_DVC_VOL1R,
135         RSND_REG_DVC_VOL2R,
136         RSND_REG_DVC_VOL3R,
137         RSND_REG_DVC_VOL4R,
138         RSND_REG_DVC_VOL5R,
139         RSND_REG_DVC_VOL6R,
140         RSND_REG_DVC_VOL7R,
141         RSND_REG_DVC_DVUER,
142         RSND_REG_DVC_VRCTR,
143         RSND_REG_DVC_VRPDR,
144         RSND_REG_DVC_VRDBR,
145
146         /* ADG */
147         RSND_REG_BRRA,
148         RSND_REG_BRRB,
149         RSND_REG_BRGCKR,
150         RSND_REG_DIV_EN,
151         RSND_REG_AUDIO_CLK_SEL0,
152         RSND_REG_AUDIO_CLK_SEL1,
153         RSND_REG_AUDIO_CLK_SEL2,
154
155         /* SSIU */
156         RSND_REG_SSI_MODE,
157         RSND_REG_SSI_MODE0,
158         RSND_REG_SSI_MODE1,
159         RSND_REG_SSI_MODE2,
160         RSND_REG_SSI_CONTROL,
161         RSND_REG_SSI_CTRL,
162         RSND_REG_SSI_BUSIF_MODE,
163         RSND_REG_SSI_BUSIF_ADINR,
164         RSND_REG_SSI_BUSIF_DALIGN,
165         RSND_REG_SSI_INT_ENABLE,
166         RSND_REG_SSI_SYS_STATUS0,
167         RSND_REG_SSI_SYS_STATUS1,
168         RSND_REG_SSI_SYS_STATUS2,
169         RSND_REG_SSI_SYS_STATUS3,
170         RSND_REG_SSI_SYS_STATUS4,
171         RSND_REG_SSI_SYS_STATUS5,
172         RSND_REG_SSI_SYS_STATUS6,
173         RSND_REG_SSI_SYS_STATUS7,
174         RSND_REG_HDMI0_SEL,
175         RSND_REG_HDMI1_SEL,
176
177         /* SSI */
178         RSND_REG_SSICR,
179         RSND_REG_SSISR,
180         RSND_REG_SSITDR,
181         RSND_REG_SSIRDR,
182         RSND_REG_SSIWSR,
183
184         RSND_REG_MAX,
185 };
186
187 struct rsnd_priv;
188 struct rsnd_mod;
189 struct rsnd_dai;
190 struct rsnd_dai_stream;
191
192 /*
193  *      R-Car basic functions
194  */
195 #define rsnd_mod_read(m, r) \
196         rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
197 #define rsnd_mod_write(m, r, d) \
198         rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
199 #define rsnd_mod_bset(m, r, s, d) \
200         rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
201
202 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
203 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
204                 enum rsnd_reg reg, u32 data);
205 void rsnd_force_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
206                 enum rsnd_reg reg, u32 data);
207 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
208                     u32 mask, u32 data);
209 u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
210 u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
211 u32 rsnd_get_busif_shift(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
212
213 /*
214  *      R-Car DMA
215  */
216 int rsnd_dma_attach(struct rsnd_dai_stream *io,
217                     struct rsnd_mod *mod, struct rsnd_mod **dma_mod);
218 int rsnd_dma_probe(struct rsnd_priv *priv);
219 struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node,
220                                           struct rsnd_mod *mod, char *name);
221
222 /*
223  *      R-Car sound mod
224  */
225 enum rsnd_mod_type {
226         RSND_MOD_AUDMAPP,
227         RSND_MOD_AUDMA,
228         RSND_MOD_DVC,
229         RSND_MOD_MIX,
230         RSND_MOD_CTU,
231         RSND_MOD_CMD,
232         RSND_MOD_SRC,
233         RSND_MOD_SSIM3,         /* SSI multi 3 */
234         RSND_MOD_SSIM2,         /* SSI multi 2 */
235         RSND_MOD_SSIM1,         /* SSI multi 1 */
236         RSND_MOD_SSIP,          /* SSI parent */
237         RSND_MOD_SSI,
238         RSND_MOD_SSIU,
239         RSND_MOD_MAX,
240 };
241
242 struct rsnd_mod_ops {
243         char *name;
244         struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
245                                     struct rsnd_mod *mod);
246         int (*probe)(struct rsnd_mod *mod,
247                      struct rsnd_dai_stream *io,
248                      struct rsnd_priv *priv);
249         int (*remove)(struct rsnd_mod *mod,
250                       struct rsnd_dai_stream *io,
251                       struct rsnd_priv *priv);
252         int (*init)(struct rsnd_mod *mod,
253                     struct rsnd_dai_stream *io,
254                     struct rsnd_priv *priv);
255         int (*quit)(struct rsnd_mod *mod,
256                     struct rsnd_dai_stream *io,
257                     struct rsnd_priv *priv);
258         int (*start)(struct rsnd_mod *mod,
259                      struct rsnd_dai_stream *io,
260                      struct rsnd_priv *priv);
261         int (*stop)(struct rsnd_mod *mod,
262                     struct rsnd_dai_stream *io,
263                     struct rsnd_priv *priv);
264         int (*irq)(struct rsnd_mod *mod,
265                    struct rsnd_dai_stream *io,
266                    struct rsnd_priv *priv, int enable);
267         int (*pcm_new)(struct rsnd_mod *mod,
268                        struct rsnd_dai_stream *io,
269                        struct snd_soc_pcm_runtime *rtd);
270         int (*hw_params)(struct rsnd_mod *mod,
271                          struct rsnd_dai_stream *io,
272                          struct snd_pcm_substream *substream,
273                          struct snd_pcm_hw_params *hw_params);
274         int (*pointer)(struct rsnd_mod *mod,
275                        struct rsnd_dai_stream *io,
276                        snd_pcm_uframes_t *pointer);
277         int (*fallback)(struct rsnd_mod *mod,
278                         struct rsnd_dai_stream *io,
279                         struct rsnd_priv *priv);
280         int (*nolock_start)(struct rsnd_mod *mod,
281                     struct rsnd_dai_stream *io,
282                     struct rsnd_priv *priv);
283         int (*nolock_stop)(struct rsnd_mod *mod,
284                     struct rsnd_dai_stream *io,
285                     struct rsnd_priv *priv);
286 };
287
288 struct rsnd_dai_stream;
289 struct rsnd_mod {
290         int id;
291         enum rsnd_mod_type type;
292         struct rsnd_mod_ops *ops;
293         struct rsnd_priv *priv;
294         struct clk *clk;
295         u32 *(*get_status)(struct rsnd_dai_stream *io,
296                            struct rsnd_mod *mod,
297                            enum rsnd_mod_type type);
298         u32 status;
299 };
300 /*
301  * status
302  *
303  * 0xH0000CBA
304  *
305  * A    0: nolock_start 1: nolock_stop
306  * B    0: init         1: quit
307  * C    0: start        1: stop
308  *
309  * H is always called (see __rsnd_mod_call)
310  * H    0: probe        1: remove
311  * H    0: pcm_new
312  * H    0: fallback
313  * H    0: hw_params
314  * H    0: pointer
315  */
316 #define __rsnd_mod_shift_nolock_start   0
317 #define __rsnd_mod_shift_nolock_stop    0
318 #define __rsnd_mod_shift_init           4
319 #define __rsnd_mod_shift_quit           4
320 #define __rsnd_mod_shift_start          8
321 #define __rsnd_mod_shift_stop           8
322 #define __rsnd_mod_shift_probe          28 /* always called */
323 #define __rsnd_mod_shift_remove         28 /* always called */
324 #define __rsnd_mod_shift_irq            28 /* always called */
325 #define __rsnd_mod_shift_pcm_new        28 /* always called */
326 #define __rsnd_mod_shift_fallback       28 /* always called */
327 #define __rsnd_mod_shift_hw_params      28 /* always called */
328 #define __rsnd_mod_shift_pointer        28 /* always called */
329
330 #define __rsnd_mod_add_probe            0
331 #define __rsnd_mod_add_remove           0
332 #define __rsnd_mod_add_nolock_start      1
333 #define __rsnd_mod_add_nolock_stop      -1
334 #define __rsnd_mod_add_init              1
335 #define __rsnd_mod_add_quit             -1
336 #define __rsnd_mod_add_start             1
337 #define __rsnd_mod_add_stop             -1
338 #define __rsnd_mod_add_irq              0
339 #define __rsnd_mod_add_pcm_new          0
340 #define __rsnd_mod_add_fallback         0
341 #define __rsnd_mod_add_hw_params        0
342 #define __rsnd_mod_add_pointer          0
343
344 #define __rsnd_mod_call_probe           0
345 #define __rsnd_mod_call_remove          0
346 #define __rsnd_mod_call_init            0
347 #define __rsnd_mod_call_quit            1
348 #define __rsnd_mod_call_start           0
349 #define __rsnd_mod_call_stop            1
350 #define __rsnd_mod_call_irq             0
351 #define __rsnd_mod_call_pcm_new         0
352 #define __rsnd_mod_call_fallback        0
353 #define __rsnd_mod_call_hw_params       0
354 #define __rsnd_mod_call_pointer         0
355 #define __rsnd_mod_call_nolock_start    0
356 #define __rsnd_mod_call_nolock_stop     1
357
358 #define rsnd_mod_to_priv(mod)   ((mod)->priv)
359 #define rsnd_mod_name(mod)      ((mod)->ops->name)
360 #define rsnd_mod_id(mod)        ((mod)->id)
361 #define rsnd_mod_power_on(mod)  clk_enable((mod)->clk)
362 #define rsnd_mod_power_off(mod) clk_disable((mod)->clk)
363 #define rsnd_mod_get(ip)        (&(ip)->mod)
364
365 int rsnd_mod_init(struct rsnd_priv *priv,
366                   struct rsnd_mod *mod,
367                   struct rsnd_mod_ops *ops,
368                   struct clk *clk,
369                   u32* (*get_status)(struct rsnd_dai_stream *io,
370                                      struct rsnd_mod *mod,
371                                      enum rsnd_mod_type type),
372                   enum rsnd_mod_type type,
373                   int id);
374 void rsnd_mod_quit(struct rsnd_mod *mod);
375 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
376                                   struct rsnd_mod *mod);
377 void rsnd_mod_interrupt(struct rsnd_mod *mod,
378                         void (*callback)(struct rsnd_mod *mod,
379                                          struct rsnd_dai_stream *io));
380 u32 *rsnd_mod_get_status(struct rsnd_dai_stream *io,
381                          struct rsnd_mod *mod,
382                          enum rsnd_mod_type type);
383 struct rsnd_mod *rsnd_mod_next(int *iterator,
384                                struct rsnd_dai_stream *io,
385                                enum rsnd_mod_type *array,
386                                int array_size);
387 #define for_each_rsnd_mod(iterator, pos, io)                            \
388         for (iterator = 0;                                              \
389              (pos = rsnd_mod_next(&iterator, io, NULL, 0)); iterator++)
390 #define for_each_rsnd_mod_arrays(iterator, pos, io, array, size)        \
391         for (iterator = 0;                                              \
392              (pos = rsnd_mod_next(&iterator, io, array, size)); iterator++)
393 #define for_each_rsnd_mod_array(iterator, pos, io, array)               \
394         for_each_rsnd_mod_arrays(iterator, pos, io, array, ARRAY_SIZE(array))
395
396 void rsnd_parse_connect_common(struct rsnd_dai *rdai,
397                 struct rsnd_mod* (*mod_get)(struct rsnd_priv *priv, int id),
398                 struct device_node *node,
399                 struct device_node *playback,
400                 struct device_node *capture);
401
402 #define rsnd_runtime_channel_original(io) \
403         rsnd_runtime_channel_original_with_params(io, NULL)
404 int rsnd_runtime_channel_original_with_params(struct rsnd_dai_stream *io,
405                                 struct snd_pcm_hw_params *params);
406 #define rsnd_runtime_channel_after_ctu(io)                      \
407         rsnd_runtime_channel_after_ctu_with_params(io, NULL)
408 int rsnd_runtime_channel_after_ctu_with_params(struct rsnd_dai_stream *io,
409                                 struct snd_pcm_hw_params *params);
410 #define rsnd_runtime_channel_for_ssi(io) \
411         rsnd_runtime_channel_for_ssi_with_params(io, NULL)
412 int rsnd_runtime_channel_for_ssi_with_params(struct rsnd_dai_stream *io,
413                                  struct snd_pcm_hw_params *params);
414 int rsnd_runtime_is_ssi_multi(struct rsnd_dai_stream *io);
415 int rsnd_runtime_is_ssi_tdm(struct rsnd_dai_stream *io);
416
417 /*
418  * DT
419  */
420 #define rsnd_parse_of_node(priv, node)                                  \
421         of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, node)
422 #define RSND_NODE_DAI   "rcar_sound,dai"
423 #define RSND_NODE_SSI   "rcar_sound,ssi"
424 #define RSND_NODE_SRC   "rcar_sound,src"
425 #define RSND_NODE_CTU   "rcar_sound,ctu"
426 #define RSND_NODE_MIX   "rcar_sound,mix"
427 #define RSND_NODE_DVC   "rcar_sound,dvc"
428
429 /*
430  *      R-Car sound DAI
431  */
432 #define RSND_DAI_NAME_SIZE      16
433 struct rsnd_dai_stream {
434         char name[RSND_DAI_NAME_SIZE];
435         struct snd_pcm_substream *substream;
436         struct rsnd_mod *mod[RSND_MOD_MAX];
437         struct rsnd_dai *rdai;
438         u32 parent_ssi_status;
439 };
440 #define rsnd_io_to_mod(io, i)   ((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
441 #define rsnd_io_to_mod_ssi(io)  rsnd_io_to_mod((io), RSND_MOD_SSI)
442 #define rsnd_io_to_mod_ssiu(io) rsnd_io_to_mod((io), RSND_MOD_SSIU)
443 #define rsnd_io_to_mod_ssip(io) rsnd_io_to_mod((io), RSND_MOD_SSIP)
444 #define rsnd_io_to_mod_src(io)  rsnd_io_to_mod((io), RSND_MOD_SRC)
445 #define rsnd_io_to_mod_ctu(io)  rsnd_io_to_mod((io), RSND_MOD_CTU)
446 #define rsnd_io_to_mod_mix(io)  rsnd_io_to_mod((io), RSND_MOD_MIX)
447 #define rsnd_io_to_mod_dvc(io)  rsnd_io_to_mod((io), RSND_MOD_DVC)
448 #define rsnd_io_to_mod_cmd(io)  rsnd_io_to_mod((io), RSND_MOD_CMD)
449 #define rsnd_io_to_rdai(io)     ((io)->rdai)
450 #define rsnd_io_to_priv(io)     (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
451 #define rsnd_io_is_play(io)     (&rsnd_io_to_rdai(io)->playback == io)
452 #define rsnd_io_to_runtime(io) ((io)->substream ? \
453                                 (io)->substream->runtime : NULL)
454 int rsnd_io_is_working(struct rsnd_dai_stream *io);
455
456 struct rsnd_dai {
457         char name[RSND_DAI_NAME_SIZE];
458         struct rsnd_dai_stream playback;
459         struct rsnd_dai_stream capture;
460         struct rsnd_priv *priv;
461         struct snd_pcm_hw_constraint_list constraint;
462
463         int max_channels;       /* 2ch - 16ch */
464         int ssi_lane;           /* 1lane - 4lane */
465
466         unsigned int clk_master:1;
467         unsigned int bit_clk_inv:1;
468         unsigned int frm_clk_inv:1;
469         unsigned int sys_delay:1;
470         unsigned int data_alignment:1;
471 };
472
473 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
474 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
475 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
476 #define for_each_rsnd_dai(rdai, priv, i)                \
477         for (i = 0;                                     \
478              (i < rsnd_rdai_nr(priv)) &&                \
479              ((rdai) = rsnd_rdai_get(priv, i));         \
480              i++)
481
482 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
483
484 #define rsnd_rdai_channels_set(rdai, max_channels) \
485         rsnd_rdai_channels_ctrl(rdai, max_channels)
486 #define rsnd_rdai_channels_get(rdai) \
487         rsnd_rdai_channels_ctrl(rdai, 0)
488 int rsnd_rdai_channels_ctrl(struct rsnd_dai *rdai,
489                             int max_channels);
490
491 #define rsnd_rdai_ssi_lane_set(rdai, ssi_lane) \
492         rsnd_rdai_ssi_lane_ctrl(rdai, ssi_lane)
493 #define rsnd_rdai_ssi_lane_get(rdai) \
494         rsnd_rdai_ssi_lane_ctrl(rdai, 0)
495 int rsnd_rdai_ssi_lane_ctrl(struct rsnd_dai *rdai,
496                             int ssi_lane);
497
498 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
499 int rsnd_dai_connect(struct rsnd_mod *mod,
500                      struct rsnd_dai_stream *io,
501                      enum rsnd_mod_type type);
502
503 /*
504  *      R-Car Gen1/Gen2
505  */
506 int rsnd_gen_probe(struct rsnd_priv *priv);
507 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
508                                struct rsnd_mod *mod,
509                                enum rsnd_reg reg);
510 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
511
512 /*
513  *      R-Car ADG
514  */
515 int rsnd_adg_clk_query(struct rsnd_priv *priv, unsigned int rate);
516 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
517 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
518 int rsnd_adg_probe(struct rsnd_priv *priv);
519 void rsnd_adg_remove(struct rsnd_priv *priv);
520 int rsnd_adg_set_src_timesel_gen2(struct rsnd_mod *src_mod,
521                                   struct rsnd_dai_stream *io,
522                                   unsigned int in_rate,
523                                   unsigned int out_rate);
524 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
525                                  struct rsnd_dai_stream *io);
526 #define rsnd_adg_clk_enable(priv)       rsnd_adg_clk_control(priv, 1)
527 #define rsnd_adg_clk_disable(priv)      rsnd_adg_clk_control(priv, 0)
528 void rsnd_adg_clk_control(struct rsnd_priv *priv, int enable);
529
530 /*
531  *      R-Car sound priv
532  */
533 struct rsnd_priv {
534
535         struct platform_device *pdev;
536         spinlock_t lock;
537         unsigned long flags;
538 #define RSND_GEN_MASK   (0xF << 0)
539 #define RSND_GEN1       (1 << 0)
540 #define RSND_GEN2       (2 << 0)
541
542         /*
543          * below value will be filled on rsnd_gen_probe()
544          */
545         void *gen;
546
547         /*
548          * below value will be filled on rsnd_adg_probe()
549          */
550         void *adg;
551
552         /*
553          * below value will be filled on rsnd_dma_probe()
554          */
555         void *dma;
556
557         /*
558          * below value will be filled on rsnd_ssi_probe()
559          */
560         void *ssi;
561         int ssi_nr;
562
563         /*
564          * below value will be filled on rsnd_ssiu_probe()
565          */
566         void *ssiu;
567         int ssiu_nr;
568
569         /*
570          * below value will be filled on rsnd_src_probe()
571          */
572         void *src;
573         int src_nr;
574
575         /*
576          * below value will be filled on rsnd_ctu_probe()
577          */
578         void *ctu;
579         int ctu_nr;
580
581         /*
582          * below value will be filled on rsnd_mix_probe()
583          */
584         void *mix;
585         int mix_nr;
586
587         /*
588          * below value will be filled on rsnd_dvc_probe()
589          */
590         void *dvc;
591         int dvc_nr;
592
593         /*
594          * below value will be filled on rsnd_cmd_probe()
595          */
596         void *cmd;
597         int cmd_nr;
598
599         /*
600          * below value will be filled on rsnd_dai_probe()
601          */
602         struct snd_soc_dai_driver *daidrv;
603         struct rsnd_dai *rdai;
604         int rdai_nr;
605 };
606
607 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
608 #define rsnd_priv_to_dev(priv)  (&(rsnd_priv_to_pdev(priv)->dev))
609
610 #define rsnd_is_gen1(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
611 #define rsnd_is_gen2(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
612
613 #define rsnd_flags_has(p, f) ((p)->flags & (f))
614 #define rsnd_flags_set(p, f) ((p)->flags |= (f))
615 #define rsnd_flags_del(p, f) ((p)->flags &= ~(f))
616
617 /*
618  *      rsnd_kctrl
619  */
620 struct rsnd_kctrl_cfg {
621         unsigned int max;
622         unsigned int size;
623         u32 *val;
624         const char * const *texts;
625         int (*accept)(struct rsnd_dai_stream *io);
626         void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
627         struct rsnd_dai_stream *io;
628         struct snd_card *card;
629         struct snd_kcontrol *kctrl;
630         struct rsnd_mod *mod;
631 };
632
633 #define RSND_MAX_CHANNELS       8
634 struct rsnd_kctrl_cfg_m {
635         struct rsnd_kctrl_cfg cfg;
636         u32 val[RSND_MAX_CHANNELS];
637 };
638
639 struct rsnd_kctrl_cfg_s {
640         struct rsnd_kctrl_cfg cfg;
641         u32 val;
642 };
643 #define rsnd_kctrl_size(x)      ((x).cfg.size)
644 #define rsnd_kctrl_max(x)       ((x).cfg.max)
645 #define rsnd_kctrl_valm(x, i)   ((x).val[i])    /* = (x).cfg.val[i] */
646 #define rsnd_kctrl_vals(x)      ((x).val)       /* = (x).cfg.val[0] */
647
648 int rsnd_kctrl_accept_anytime(struct rsnd_dai_stream *io);
649 int rsnd_kctrl_accept_runtime(struct rsnd_dai_stream *io);
650 struct rsnd_kctrl_cfg *rsnd_kctrl_init_m(struct rsnd_kctrl_cfg_m *cfg);
651 struct rsnd_kctrl_cfg *rsnd_kctrl_init_s(struct rsnd_kctrl_cfg_s *cfg);
652 int rsnd_kctrl_new(struct rsnd_mod *mod,
653                    struct rsnd_dai_stream *io,
654                    struct snd_soc_pcm_runtime *rtd,
655                    const unsigned char *name,
656                    int (*accept)(struct rsnd_dai_stream *io),
657                    void (*update)(struct rsnd_dai_stream *io,
658                                   struct rsnd_mod *mod),
659                    struct rsnd_kctrl_cfg *cfg,
660                    const char * const *texts,
661                    int size,
662                    u32 max);
663
664 #define rsnd_kctrl_new_m(mod, io, rtd, name, accept, update, cfg, size, max) \
665         rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_m(cfg), \
666                        NULL, size, max)
667
668 #define rsnd_kctrl_new_s(mod, io, rtd, name, accept, update, cfg, max)  \
669         rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
670                        NULL, 1, max)
671
672 #define rsnd_kctrl_new_e(mod, io, rtd, name, accept, update, cfg, texts, size) \
673         rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
674                        texts, 1, size)
675
676 extern const char * const volume_ramp_rate[];
677 #define VOLUME_RAMP_MAX_DVC     (0x17 + 1)
678 #define VOLUME_RAMP_MAX_MIX     (0x0a + 1)
679
680 /*
681  *      R-Car SSI
682  */
683 int rsnd_ssi_probe(struct rsnd_priv *priv);
684 void rsnd_ssi_remove(struct rsnd_priv *priv);
685 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
686 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
687 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
688 u32 rsnd_ssi_multi_slaves_runtime(struct rsnd_dai_stream *io);
689
690 #define RSND_SSI_HDMI_PORT0     0xf0
691 #define RSND_SSI_HDMI_PORT1     0xf1
692 int rsnd_ssi_hdmi_port(struct rsnd_dai_stream *io);
693 void rsnd_ssi_parse_hdmi_connection(struct rsnd_priv *priv,
694                                     struct device_node *endpoint,
695                                     int dai_i);
696
697 #define rsnd_ssi_is_pin_sharing(io)     \
698         __rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
699 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
700
701 #define rsnd_ssi_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSI)
702 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
703                             struct device_node *playback,
704                             struct device_node *capture);
705 unsigned int rsnd_ssi_clk_query(struct rsnd_priv *priv,
706                        int param1, int param2, int *idx);
707
708 /*
709  *      R-Car SSIU
710  */
711 int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
712                      struct rsnd_mod *mod);
713 int rsnd_ssiu_probe(struct rsnd_priv *priv);
714 void rsnd_ssiu_remove(struct rsnd_priv *priv);
715
716 /*
717  *      R-Car SRC
718  */
719 int rsnd_src_probe(struct rsnd_priv *priv);
720 void rsnd_src_remove(struct rsnd_priv *priv);
721 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
722
723 #define rsnd_src_get_in_rate(priv, io) rsnd_src_get_rate(priv, io, 1)
724 #define rsnd_src_get_out_rate(priv, io) rsnd_src_get_rate(priv, io, 0)
725 unsigned int rsnd_src_get_rate(struct rsnd_priv *priv,
726                                struct rsnd_dai_stream *io,
727                                int is_in);
728
729 #define rsnd_src_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SRC)
730 #define rsnd_parse_connect_src(rdai, playback, capture)                 \
731         rsnd_parse_connect_common(rdai, rsnd_src_mod_get,               \
732                                   rsnd_src_of_node(rsnd_rdai_to_priv(rdai)), \
733                                                    playback, capture)
734
735 /*
736  *      R-Car CTU
737  */
738 int rsnd_ctu_probe(struct rsnd_priv *priv);
739 void rsnd_ctu_remove(struct rsnd_priv *priv);
740 int rsnd_ctu_converted_channel(struct rsnd_mod *mod);
741 struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
742 #define rsnd_ctu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_CTU)
743 #define rsnd_parse_connect_ctu(rdai, playback, capture)                 \
744         rsnd_parse_connect_common(rdai, rsnd_ctu_mod_get,               \
745                                   rsnd_ctu_of_node(rsnd_rdai_to_priv(rdai)), \
746                                                    playback, capture)
747
748 /*
749  *      R-Car MIX
750  */
751 int rsnd_mix_probe(struct rsnd_priv *priv);
752 void rsnd_mix_remove(struct rsnd_priv *priv);
753 struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
754 #define rsnd_mix_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_MIX)
755 #define rsnd_parse_connect_mix(rdai, playback, capture)                 \
756         rsnd_parse_connect_common(rdai, rsnd_mix_mod_get,               \
757                                   rsnd_mix_of_node(rsnd_rdai_to_priv(rdai)), \
758                                                    playback, capture)
759
760 /*
761  *      R-Car DVC
762  */
763 int rsnd_dvc_probe(struct rsnd_priv *priv);
764 void rsnd_dvc_remove(struct rsnd_priv *priv);
765 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
766 #define rsnd_dvc_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_DVC)
767 #define rsnd_parse_connect_dvc(rdai, playback, capture)                 \
768         rsnd_parse_connect_common(rdai, rsnd_dvc_mod_get,               \
769                                   rsnd_dvc_of_node(rsnd_rdai_to_priv(rdai)), \
770                                                    playback, capture)
771
772 /*
773  *      R-Car CMD
774  */
775 int rsnd_cmd_probe(struct rsnd_priv *priv);
776 void rsnd_cmd_remove(struct rsnd_priv *priv);
777 int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
778 struct rsnd_mod *rsnd_cmd_mod_get(struct rsnd_priv *priv, int id);
779
780 void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
781 #ifdef DEBUG
782 #define rsnd_mod_confirm_ssi(mssi)      rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
783 #define rsnd_mod_confirm_src(msrc)      rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
784 #define rsnd_mod_confirm_dvc(mdvc)      rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
785 #else
786 #define rsnd_mod_confirm_ssi(mssi)
787 #define rsnd_mod_confirm_src(msrc)
788 #define rsnd_mod_confirm_dvc(mdvc)
789 #endif
790
791 #endif