4 * Copyright (C) 2013 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
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.
14 #include <linux/clk.h>
15 #include <linux/device.h>
16 #include <linux/dma-mapping.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>
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
39 RSND_REG_SRC_BUSIF_MODE,
40 RSND_REG_SRC_ROUTE_MODE0,
47 RSND_REG_SCU_SYS_STATUS0,
48 RSND_REG_SCU_SYS_INT_EN0,
49 RSND_REG_CMD_ROUTE_SLCT,
63 RSND_REG_AUDIO_CLK_SEL0,
64 RSND_REG_AUDIO_CLK_SEL1,
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
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
151 struct rsnd_dai_stream;
154 * R-Car basic functions
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)
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,
168 u32 rsnd_get_adinr(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
174 struct rsnd_dma_ops {
175 void (*start)(struct rsnd_dai_stream *io, struct rsnd_dma *dma);
176 void (*stop)(struct rsnd_dai_stream *io, struct rsnd_dma *dma);
177 int (*init)(struct rsnd_dai_stream *io, struct rsnd_dma *dma, int id,
178 struct rsnd_mod *mod_from, struct rsnd_mod *mod_to);
179 void (*quit)(struct rsnd_dai_stream *io, struct rsnd_dma *dma);
183 struct dma_chan *chan;
192 struct rsnd_dma_ops *ops;
196 struct rsnd_dmaen en;
197 struct rsnd_dmapp pp;
200 #define rsnd_dma_to_dmaen(dma) (&(dma)->dma.en)
201 #define rsnd_dma_to_dmapp(dma) (&(dma)->dma.pp)
203 void rsnd_dma_start(struct rsnd_dai_stream *io, struct rsnd_dma *dma);
204 void rsnd_dma_stop(struct rsnd_dai_stream *io, struct rsnd_dma *dma);
205 int rsnd_dma_init(struct rsnd_dai_stream *io, struct rsnd_dma *dma, int id);
206 void rsnd_dma_quit(struct rsnd_dai_stream *io, 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);
213 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
225 struct rsnd_mod_ops {
227 struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
228 struct rsnd_mod *mod);
229 int (*probe)(struct rsnd_mod *mod,
230 struct rsnd_dai_stream *io,
231 struct rsnd_priv *priv);
232 int (*remove)(struct rsnd_mod *mod,
233 struct rsnd_dai_stream *io,
234 struct rsnd_priv *priv);
235 int (*init)(struct rsnd_mod *mod,
236 struct rsnd_dai_stream *io,
237 struct rsnd_priv *priv);
238 int (*quit)(struct rsnd_mod *mod,
239 struct rsnd_dai_stream *io,
240 struct rsnd_priv *priv);
241 int (*start)(struct rsnd_mod *mod,
242 struct rsnd_dai_stream *io,
243 struct rsnd_priv *priv);
244 int (*stop)(struct rsnd_mod *mod,
245 struct rsnd_dai_stream *io,
246 struct rsnd_priv *priv);
247 int (*pcm_new)(struct rsnd_mod *mod,
248 struct rsnd_dai_stream *io,
249 struct snd_soc_pcm_runtime *rtd);
250 int (*hw_params)(struct rsnd_mod *mod,
251 struct rsnd_dai_stream *io,
252 struct snd_pcm_substream *substream,
253 struct snd_pcm_hw_params *hw_params);
254 int (*fallback)(struct rsnd_mod *mod,
255 struct rsnd_dai_stream *io,
256 struct rsnd_priv *priv);
259 struct rsnd_dai_stream;
262 enum rsnd_mod_type type;
263 struct rsnd_mod_ops *ops;
265 struct rsnd_dai_stream *io;
266 struct rsnd_priv *priv;
275 * A 0: probe 1: remove
279 * H is always called (see __rsnd_mod_call)
284 #define __rsnd_mod_shift_probe 0
285 #define __rsnd_mod_shift_remove 0
286 #define __rsnd_mod_shift_init 4
287 #define __rsnd_mod_shift_quit 4
288 #define __rsnd_mod_shift_start 8
289 #define __rsnd_mod_shift_stop 8
290 #define __rsnd_mod_shift_pcm_new 28 /* always called */
291 #define __rsnd_mod_shift_fallback 28 /* always called */
292 #define __rsnd_mod_shift_hw_params 28 /* always called */
294 #define __rsnd_mod_add_probe 1
295 #define __rsnd_mod_add_remove -1
296 #define __rsnd_mod_add_init 1
297 #define __rsnd_mod_add_quit -1
298 #define __rsnd_mod_add_start 1
299 #define __rsnd_mod_add_stop -1
300 #define __rsnd_mod_add_pcm_new 0
301 #define __rsnd_mod_add_fallback 0
302 #define __rsnd_mod_add_hw_params 0
304 #define __rsnd_mod_call_probe 0
305 #define __rsnd_mod_call_remove 1
306 #define __rsnd_mod_call_init 0
307 #define __rsnd_mod_call_quit 1
308 #define __rsnd_mod_call_start 0
309 #define __rsnd_mod_call_stop 1
310 #define __rsnd_mod_call_pcm_new 0
311 #define __rsnd_mod_call_fallback 0
312 #define __rsnd_mod_call_hw_params 0
314 #define rsnd_mod_to_priv(mod) ((mod)->priv)
315 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
316 #define rsnd_mod_to_io(mod) ((mod)->io)
317 #define rsnd_mod_id(mod) ((mod)->id)
318 #define rsnd_mod_hw_start(mod) clk_enable((mod)->clk)
319 #define rsnd_mod_hw_stop(mod) clk_disable((mod)->clk)
321 int rsnd_mod_init(struct rsnd_priv *priv,
322 struct rsnd_mod *mod,
323 struct rsnd_mod_ops *ops,
325 enum rsnd_mod_type type,
327 void rsnd_mod_quit(struct rsnd_mod *mod);
328 char *rsnd_mod_name(struct rsnd_mod *mod);
329 int rsnd_mod_is_working(struct rsnd_mod *mod);
330 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
331 struct rsnd_mod *mod);
332 void rsnd_mod_interrupt(struct rsnd_mod *mod,
333 void (*callback)(struct rsnd_mod *mod,
334 struct rsnd_dai_stream *io));
339 #define RSND_DAI_NAME_SIZE 16
340 struct rsnd_dai_stream {
341 char name[RSND_DAI_NAME_SIZE];
342 struct snd_pcm_substream *substream;
343 struct rsnd_mod *mod[RSND_MOD_MAX];
344 struct rsnd_dai_path_info *info; /* rcar_snd.h */
345 struct rsnd_dai *rdai;
349 int next_period_byte;
351 #define rsnd_io_to_mod_ssi(io) ((io)->mod[RSND_MOD_SSI])
352 #define rsnd_io_to_mod_src(io) ((io)->mod[RSND_MOD_SRC])
353 #define rsnd_io_to_mod_dvc(io) ((io)->mod[RSND_MOD_DVC])
354 #define rsnd_io_to_rdai(io) ((io)->rdai)
355 #define rsnd_io_to_priv(io) (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
356 #define rsnd_io_is_play(io) (&rsnd_io_to_rdai(io)->playback == io)
357 #define rsnd_io_to_runtime(io) ((io)->substream ? \
358 (io)->substream->runtime : NULL)
362 char name[RSND_DAI_NAME_SIZE];
363 struct rsnd_dai_stream playback;
364 struct rsnd_dai_stream capture;
365 struct rsnd_priv *priv;
367 unsigned int clk_master:1;
368 unsigned int bit_clk_inv:1;
369 unsigned int frm_clk_inv:1;
370 unsigned int sys_delay:1;
371 unsigned int data_alignment:1;
374 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
375 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
376 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
377 #define for_each_rsnd_dai(rdai, priv, i) \
379 (i < rsnd_rdai_nr(priv)) && \
380 ((rdai) = rsnd_rdai_get(priv, i)); \
383 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
385 bool rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
386 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
387 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
392 int rsnd_gen_probe(struct platform_device *pdev,
393 const struct rsnd_of_data *of_data,
394 struct rsnd_priv *priv);
395 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
396 struct rsnd_mod *mod,
398 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
400 #define rsnd_is_gen1(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
401 #define rsnd_is_gen2(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
406 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
407 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
408 int rsnd_adg_probe(struct platform_device *pdev,
409 const struct rsnd_of_data *of_data,
410 struct rsnd_priv *priv);
411 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
412 struct rsnd_mod *mod,
413 unsigned int src_rate,
414 unsigned int dst_rate);
415 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
416 struct rsnd_dai_stream *io,
417 unsigned int src_rate,
418 unsigned int dst_rate);
419 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
420 struct rsnd_dai_stream *io);
421 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
422 struct rsnd_dai_stream *io);
427 struct rsnd_of_data {
433 struct platform_device *pdev;
434 struct rcar_snd_info *info;
438 * below value will be filled on rsnd_gen_probe()
443 * below value will be filled on rsnd_src_probe()
449 * below value will be filled on rsnd_adg_probe()
454 * below value will be filled on rsnd_dma_probe()
459 * below value will be filled on rsnd_ssi_probe()
465 * below value will be filled on rsnd_dvc_probe()
471 * below value will be filled on rsnd_dai_probe()
473 struct snd_soc_dai_driver *daidrv;
474 struct rsnd_dai *rdai;
478 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
479 #define rsnd_priv_to_dev(priv) (&(rsnd_priv_to_pdev(priv)->dev))
480 #define rsnd_priv_to_info(priv) ((priv)->info)
485 struct rsnd_kctrl_cfg {
489 const char * const *texts;
490 void (*update)(struct rsnd_mod *mod);
491 struct snd_card *card;
492 struct snd_kcontrol *kctrl;
495 #define RSND_DVC_CHANNELS 2
496 struct rsnd_kctrl_cfg_m {
497 struct rsnd_kctrl_cfg cfg;
498 u32 val[RSND_DVC_CHANNELS];
501 struct rsnd_kctrl_cfg_s {
502 struct rsnd_kctrl_cfg cfg;
506 void _rsnd_kctrl_remove(struct rsnd_kctrl_cfg *cfg);
507 #define rsnd_kctrl_remove(_cfg) _rsnd_kctrl_remove(&((_cfg).cfg))
509 int rsnd_kctrl_new_m(struct rsnd_mod *mod,
510 struct snd_soc_pcm_runtime *rtd,
511 const unsigned char *name,
512 void (*update)(struct rsnd_mod *mod),
513 struct rsnd_kctrl_cfg_m *_cfg,
515 int rsnd_kctrl_new_s(struct rsnd_mod *mod,
516 struct snd_soc_pcm_runtime *rtd,
517 const unsigned char *name,
518 void (*update)(struct rsnd_mod *mod),
519 struct rsnd_kctrl_cfg_s *_cfg,
521 int rsnd_kctrl_new_e(struct rsnd_mod *mod,
522 struct snd_soc_pcm_runtime *rtd,
523 const unsigned char *name,
524 struct rsnd_kctrl_cfg_s *_cfg,
525 void (*update)(struct rsnd_mod *mod),
526 const char * const *texts,
532 int rsnd_src_probe(struct platform_device *pdev,
533 const struct rsnd_of_data *of_data,
534 struct rsnd_priv *priv);
535 void rsnd_src_remove(struct platform_device *pdev,
536 struct rsnd_priv *priv);
537 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
538 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
539 struct rsnd_dai_stream *io,
540 struct snd_pcm_runtime *runtime);
541 int rsnd_src_ssiu_start(struct rsnd_mod *ssi_mod,
542 struct rsnd_dai_stream *io,
544 int rsnd_src_ssiu_stop(struct rsnd_mod *ssi_mod,
545 struct rsnd_dai_stream *io);
546 int rsnd_src_ssi_irq_enable(struct rsnd_mod *ssi_mod);
547 int rsnd_src_ssi_irq_disable(struct rsnd_mod *ssi_mod);
549 #define rsnd_src_nr(priv) ((priv)->src_nr)
554 int rsnd_ssi_probe(struct platform_device *pdev,
555 const struct rsnd_of_data *of_data,
556 struct rsnd_priv *priv);
557 void rsnd_ssi_remove(struct platform_device *pdev,
558 struct rsnd_priv *priv);
559 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
560 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
561 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
562 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
567 int rsnd_dvc_probe(struct platform_device *pdev,
568 const struct rsnd_of_data *of_data,
569 struct rsnd_priv *priv);
570 void rsnd_dvc_remove(struct platform_device *pdev,
571 struct rsnd_priv *priv);
572 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
574 #define rsnd_dvc_nr(priv) ((priv)->dvc_nr)