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/soc.h>
25 #include <sound/pcm_params.h>
32 * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
33 * This driver uses pseudo register in order to hide it.
34 * see gen1/gen2 for detail
40 RSND_REG_SRC_BUSIF_MODE,
41 RSND_REG_SRC_ROUTE_MODE0,
48 RSND_REG_SCU_SYS_STATUS0,
49 RSND_REG_SCU_SYS_INT_EN0,
50 RSND_REG_CMD_ROUTE_SLCT,
76 RSND_REG_AUDIO_CLK_SEL0,
77 RSND_REG_AUDIO_CLK_SEL1,
121 #define RSND_REG_SRC_ROUTE_SEL RSND_REG_SHARE01
122 #define RSND_REG_SRC_TMG_SEL0 RSND_REG_SHARE02
123 #define RSND_REG_SRC_TMG_SEL1 RSND_REG_SHARE03
124 #define RSND_REG_SRC_TMG_SEL2 RSND_REG_SHARE04
125 #define RSND_REG_SRC_ROUTE_CTRL RSND_REG_SHARE05
126 #define RSND_REG_SRC_MNFSR RSND_REG_SHARE06
127 #define RSND_REG_AUDIO_CLK_SEL3 RSND_REG_SHARE07
128 #define RSND_REG_AUDIO_CLK_SEL4 RSND_REG_SHARE08
129 #define RSND_REG_AUDIO_CLK_SEL5 RSND_REG_SHARE09
132 #define RSND_REG_SRC_CTRL RSND_REG_SHARE01
133 #define RSND_REG_SSI_CTRL RSND_REG_SHARE02
134 #define RSND_REG_SSI_BUSIF_MODE RSND_REG_SHARE03
135 #define RSND_REG_SSI_BUSIF_ADINR RSND_REG_SHARE04
136 #define RSND_REG_SSI_INT_ENABLE RSND_REG_SHARE05
137 #define RSND_REG_SRC_BSDSR RSND_REG_SHARE06
138 #define RSND_REG_SRC_BSISR RSND_REG_SHARE07
139 #define RSND_REG_DIV_EN RSND_REG_SHARE08
140 #define RSND_REG_SRCIN_TIMSEL0 RSND_REG_SHARE09
141 #define RSND_REG_SRCIN_TIMSEL1 RSND_REG_SHARE10
142 #define RSND_REG_SRCIN_TIMSEL2 RSND_REG_SHARE11
143 #define RSND_REG_SRCIN_TIMSEL3 RSND_REG_SHARE12
144 #define RSND_REG_SRCIN_TIMSEL4 RSND_REG_SHARE13
145 #define RSND_REG_SRCOUT_TIMSEL0 RSND_REG_SHARE14
146 #define RSND_REG_SRCOUT_TIMSEL1 RSND_REG_SHARE15
147 #define RSND_REG_SRCOUT_TIMSEL2 RSND_REG_SHARE16
148 #define RSND_REG_SRCOUT_TIMSEL3 RSND_REG_SHARE17
149 #define RSND_REG_SRCOUT_TIMSEL4 RSND_REG_SHARE18
150 #define RSND_REG_AUDIO_CLK_SEL2 RSND_REG_SHARE19
151 #define RSND_REG_CMD_CTRL RSND_REG_SHARE20
152 #define RSND_REG_CMDOUT_TIMSEL RSND_REG_SHARE21
153 #define RSND_REG_SSI_BUSIF_DALIGN RSND_REG_SHARE22
154 #define RSND_REG_DVC_VRCTR RSND_REG_SHARE23
155 #define RSND_REG_DVC_VRPDR RSND_REG_SHARE24
156 #define RSND_REG_DVC_VRDBR RSND_REG_SHARE25
157 #define RSND_REG_SCU_SYS_STATUS1 RSND_REG_SHARE26
158 #define RSND_REG_SCU_SYS_INT_EN1 RSND_REG_SHARE27
159 #define RSND_REG_SRC_INT_ENABLE0 RSND_REG_SHARE28
160 #define RSND_REG_SRC_BUSIF_DALIGN RSND_REG_SHARE29
166 struct rsnd_dai_stream;
169 * R-Car basic functions
171 #define rsnd_mod_read(m, r) \
172 rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
173 #define rsnd_mod_write(m, r, d) \
174 rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
175 #define rsnd_mod_force_write(m, r, d) \
176 rsnd_force_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
177 #define rsnd_mod_bset(m, r, s, d) \
178 rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
180 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
181 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
182 enum rsnd_reg reg, u32 data);
183 void rsnd_force_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
184 enum rsnd_reg reg, u32 data);
185 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
187 u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
188 u32 rsnd_get_adinr_chan(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
189 u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
190 void rsnd_path_parse(struct rsnd_priv *priv,
191 struct rsnd_dai_stream *io);
199 struct dma_chan *chan;
208 struct rsnd_dma_ops *ops;
212 struct rsnd_dmaen en;
213 struct rsnd_dmapp pp;
216 #define rsnd_dma_to_dmaen(dma) (&(dma)->dma.en)
217 #define rsnd_dma_to_dmapp(dma) (&(dma)->dma.pp)
218 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
220 void rsnd_dma_start(struct rsnd_dai_stream *io, struct rsnd_dma *dma);
221 void rsnd_dma_stop(struct rsnd_dai_stream *io, struct rsnd_dma *dma);
222 int rsnd_dma_init(struct rsnd_dai_stream *io, struct rsnd_dma *dma, int id);
223 void rsnd_dma_quit(struct rsnd_dai_stream *io, struct rsnd_dma *dma);
224 int rsnd_dma_probe(struct platform_device *pdev,
225 const struct rsnd_of_data *of_data,
226 struct rsnd_priv *priv);
227 struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node,
228 struct rsnd_mod *mod, char *name);
242 struct rsnd_mod_ops {
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 (*pcm_new)(struct rsnd_mod *mod,
265 struct rsnd_dai_stream *io,
266 struct snd_soc_pcm_runtime *rtd);
267 int (*hw_params)(struct rsnd_mod *mod,
268 struct rsnd_dai_stream *io,
269 struct snd_pcm_substream *substream,
270 struct snd_pcm_hw_params *hw_params);
271 int (*fallback)(struct rsnd_mod *mod,
272 struct rsnd_dai_stream *io,
273 struct rsnd_priv *priv);
276 struct rsnd_dai_stream;
279 enum rsnd_mod_type type;
280 struct rsnd_mod_ops *ops;
282 struct rsnd_priv *priv;
291 * A 0: probe 1: remove
295 * H is always called (see __rsnd_mod_call)
300 #define __rsnd_mod_shift_probe 0
301 #define __rsnd_mod_shift_remove 0
302 #define __rsnd_mod_shift_init 4
303 #define __rsnd_mod_shift_quit 4
304 #define __rsnd_mod_shift_start 8
305 #define __rsnd_mod_shift_stop 8
306 #define __rsnd_mod_shift_pcm_new 28 /* always called */
307 #define __rsnd_mod_shift_fallback 28 /* always called */
308 #define __rsnd_mod_shift_hw_params 28 /* always called */
310 #define __rsnd_mod_add_probe 1
311 #define __rsnd_mod_add_remove -1
312 #define __rsnd_mod_add_init 1
313 #define __rsnd_mod_add_quit -1
314 #define __rsnd_mod_add_start 1
315 #define __rsnd_mod_add_stop -1
316 #define __rsnd_mod_add_pcm_new 0
317 #define __rsnd_mod_add_fallback 0
318 #define __rsnd_mod_add_hw_params 0
320 #define __rsnd_mod_call_probe 0
321 #define __rsnd_mod_call_remove 1
322 #define __rsnd_mod_call_init 0
323 #define __rsnd_mod_call_quit 1
324 #define __rsnd_mod_call_start 0
325 #define __rsnd_mod_call_stop 1
326 #define __rsnd_mod_call_pcm_new 0
327 #define __rsnd_mod_call_fallback 0
328 #define __rsnd_mod_call_hw_params 0
330 #define rsnd_mod_to_priv(mod) ((mod)->priv)
331 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
332 #define rsnd_mod_id(mod) ((mod) ? (mod)->id : -1)
333 #define rsnd_mod_power_on(mod) clk_enable((mod)->clk)
334 #define rsnd_mod_power_off(mod) clk_disable((mod)->clk)
335 #define rsnd_mod_get(ip) (&(ip)->mod)
337 int rsnd_mod_init(struct rsnd_priv *priv,
338 struct rsnd_mod *mod,
339 struct rsnd_mod_ops *ops,
341 enum rsnd_mod_type type,
343 void rsnd_mod_quit(struct rsnd_mod *mod);
344 char *rsnd_mod_name(struct rsnd_mod *mod);
345 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
346 struct rsnd_mod *mod);
347 void rsnd_mod_interrupt(struct rsnd_mod *mod,
348 void (*callback)(struct rsnd_mod *mod,
349 struct rsnd_dai_stream *io));
354 #define RSND_DAI_NAME_SIZE 16
355 struct rsnd_dai_stream {
356 char name[RSND_DAI_NAME_SIZE];
357 struct snd_pcm_substream *substream;
358 struct rsnd_mod *mod[RSND_MOD_MAX];
359 struct rsnd_dai_path_info *info; /* rcar_snd.h */
360 struct rsnd_dai *rdai;
364 int next_period_byte;
366 #define rsnd_io_to_mod(io, i) ((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
367 #define rsnd_io_to_mod_ssi(io) rsnd_io_to_mod((io), RSND_MOD_SSI)
368 #define rsnd_io_to_mod_src(io) rsnd_io_to_mod((io), RSND_MOD_SRC)
369 #define rsnd_io_to_mod_ctu(io) rsnd_io_to_mod((io), RSND_MOD_CTU)
370 #define rsnd_io_to_mod_mix(io) rsnd_io_to_mod((io), RSND_MOD_MIX)
371 #define rsnd_io_to_mod_dvc(io) rsnd_io_to_mod((io), RSND_MOD_DVC)
372 #define rsnd_io_to_rdai(io) ((io)->rdai)
373 #define rsnd_io_to_priv(io) (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
374 #define rsnd_io_is_play(io) (&rsnd_io_to_rdai(io)->playback == io)
375 #define rsnd_io_to_runtime(io) ((io)->substream ? \
376 (io)->substream->runtime : NULL)
377 int rsnd_io_is_working(struct rsnd_dai_stream *io);
380 char name[RSND_DAI_NAME_SIZE];
381 struct rsnd_dai_stream playback;
382 struct rsnd_dai_stream capture;
383 struct rsnd_priv *priv;
385 unsigned int clk_master:1;
386 unsigned int bit_clk_inv:1;
387 unsigned int frm_clk_inv:1;
388 unsigned int sys_delay:1;
389 unsigned int data_alignment:1;
392 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
393 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
394 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
395 #define for_each_rsnd_dai(rdai, priv, i) \
397 (i < rsnd_rdai_nr(priv)) && \
398 ((rdai) = rsnd_rdai_get(priv, i)); \
401 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
403 bool rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
404 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
405 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
410 int rsnd_gen_probe(struct platform_device *pdev,
411 const struct rsnd_of_data *of_data,
412 struct rsnd_priv *priv);
413 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
414 struct rsnd_mod *mod,
416 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
418 #define rsnd_is_gen1(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
419 #define rsnd_is_gen2(s) (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
424 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
425 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
426 int rsnd_adg_probe(struct platform_device *pdev,
427 const struct rsnd_of_data *of_data,
428 struct rsnd_priv *priv);
429 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
430 struct rsnd_mod *mod,
431 unsigned int src_rate,
432 unsigned int dst_rate);
433 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
434 struct rsnd_dai_stream *io,
435 unsigned int src_rate,
436 unsigned int dst_rate);
437 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
438 struct rsnd_dai_stream *io);
439 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
440 struct rsnd_dai_stream *io);
445 struct rsnd_of_data {
451 struct platform_device *pdev;
452 struct rcar_snd_info *info;
456 * below value will be filled on rsnd_gen_probe()
461 * below value will be filled on rsnd_adg_probe()
466 * below value will be filled on rsnd_dma_probe()
471 * below value will be filled on rsnd_ssi_probe()
477 * below value will be filled on rsnd_src_probe()
483 * below value will be filled on rsnd_ctu_probe()
489 * below value will be filled on rsnd_mix_probe()
495 * below value will be filled on rsnd_dvc_probe()
501 * below value will be filled on rsnd_dai_probe()
503 struct snd_soc_dai_driver *daidrv;
504 struct rsnd_dai *rdai;
508 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
509 #define rsnd_priv_to_dev(priv) (&(rsnd_priv_to_pdev(priv)->dev))
510 #define rsnd_priv_to_info(priv) ((priv)->info)
515 struct rsnd_kctrl_cfg {
519 const char * const *texts;
520 void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
521 struct rsnd_dai_stream *io;
522 struct snd_card *card;
523 struct snd_kcontrol *kctrl;
526 #define RSND_DVC_CHANNELS 2
527 struct rsnd_kctrl_cfg_m {
528 struct rsnd_kctrl_cfg cfg;
529 u32 val[RSND_DVC_CHANNELS];
532 struct rsnd_kctrl_cfg_s {
533 struct rsnd_kctrl_cfg cfg;
537 void _rsnd_kctrl_remove(struct rsnd_kctrl_cfg *cfg);
538 #define rsnd_kctrl_remove(_cfg) _rsnd_kctrl_remove(&((_cfg).cfg))
540 int rsnd_kctrl_new_m(struct rsnd_mod *mod,
541 struct rsnd_dai_stream *io,
542 struct snd_soc_pcm_runtime *rtd,
543 const unsigned char *name,
544 void (*update)(struct rsnd_dai_stream *io,
545 struct rsnd_mod *mod),
546 struct rsnd_kctrl_cfg_m *_cfg,
548 int rsnd_kctrl_new_s(struct rsnd_mod *mod,
549 struct rsnd_dai_stream *io,
550 struct snd_soc_pcm_runtime *rtd,
551 const unsigned char *name,
552 void (*update)(struct rsnd_dai_stream *io,
553 struct rsnd_mod *mod),
554 struct rsnd_kctrl_cfg_s *_cfg,
556 int rsnd_kctrl_new_e(struct rsnd_mod *mod,
557 struct rsnd_dai_stream *io,
558 struct snd_soc_pcm_runtime *rtd,
559 const unsigned char *name,
560 struct rsnd_kctrl_cfg_s *_cfg,
561 void (*update)(struct rsnd_dai_stream *io,
562 struct rsnd_mod *mod),
563 const char * const *texts,
569 int rsnd_ssi_probe(struct platform_device *pdev,
570 const struct rsnd_of_data *of_data,
571 struct rsnd_priv *priv);
572 void rsnd_ssi_remove(struct platform_device *pdev,
573 struct rsnd_priv *priv);
574 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
575 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
576 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
578 #define rsnd_ssi_is_pin_sharing(io) \
579 __rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
580 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
585 int rsnd_src_probe(struct platform_device *pdev,
586 const struct rsnd_of_data *of_data,
587 struct rsnd_priv *priv);
588 void rsnd_src_remove(struct platform_device *pdev,
589 struct rsnd_priv *priv);
590 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
591 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
592 struct rsnd_dai_stream *io,
593 struct snd_pcm_runtime *runtime);
594 int rsnd_src_ssiu_start(struct rsnd_mod *ssi_mod,
595 struct rsnd_dai_stream *io,
597 int rsnd_src_ssiu_stop(struct rsnd_mod *ssi_mod,
598 struct rsnd_dai_stream *io);
599 int rsnd_src_ssi_irq_enable(struct rsnd_mod *ssi_mod);
600 int rsnd_src_ssi_irq_disable(struct rsnd_mod *ssi_mod);
605 int rsnd_ctu_probe(struct platform_device *pdev,
606 const struct rsnd_of_data *of_data,
607 struct rsnd_priv *priv);
609 void rsnd_ctu_remove(struct platform_device *pdev,
610 struct rsnd_priv *priv);
611 struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
616 int rsnd_mix_probe(struct platform_device *pdev,
617 const struct rsnd_of_data *of_data,
618 struct rsnd_priv *priv);
620 void rsnd_mix_remove(struct platform_device *pdev,
621 struct rsnd_priv *priv);
622 struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
627 int rsnd_dvc_probe(struct platform_device *pdev,
628 const struct rsnd_of_data *of_data,
629 struct rsnd_priv *priv);
630 void rsnd_dvc_remove(struct platform_device *pdev,
631 struct rsnd_priv *priv);
632 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
635 void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
636 #define rsnd_mod_confirm_ssi(mssi) rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
637 #define rsnd_mod_confirm_src(msrc) rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
638 #define rsnd_mod_confirm_dvc(mdvc) rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
640 #define rsnd_mod_confirm_ssi(mssi)
641 #define rsnd_mod_confirm_src(msrc)
642 #define rsnd_mod_confirm_dvc(mdvc)