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>
27 #define RSND_GEN1_SRU 0
28 #define RSND_GEN1_ADG 1
29 #define RSND_GEN1_SSI 2
31 #define RSND_GEN2_SCU 0
32 #define RSND_GEN2_ADG 1
33 #define RSND_GEN2_SSIU 2
34 #define RSND_GEN2_SSI 3
36 #define RSND_BASE_MAX 4
41 * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
42 * This driver uses pseudo register in order to hide it.
43 * see gen1/gen2 for detail
46 /* SCU (SRC/SSIU/MIX/CTU/DVC) */
47 RSND_REG_SSI_MODE, /* Gen2 only */
52 RSND_REG_SSI_CTRL, /* Gen2 only */
53 RSND_REG_SSI_BUSIF_MODE, /* Gen2 only */
54 RSND_REG_SSI_BUSIF_ADINR, /* Gen2 only */
55 RSND_REG_SSI_BUSIF_DALIGN, /* Gen2 only */
56 RSND_REG_SSI_INT_ENABLE, /* Gen2 only */
57 RSND_REG_SRC_I_BUSIF_MODE,
58 RSND_REG_SRC_O_BUSIF_MODE,
59 RSND_REG_SRC_ROUTE_MODE0,
66 RSND_REG_SRC_CTRL, /* Gen2 only */
67 RSND_REG_SRC_BSDSR, /* Gen2 only */
68 RSND_REG_SRC_BSISR, /* Gen2 only */
69 RSND_REG_SRC_INT_ENABLE0, /* Gen2 only */
70 RSND_REG_SRC_BUSIF_DALIGN, /* Gen2 only */
71 RSND_REG_SRCIN_TIMSEL0, /* Gen2 only */
72 RSND_REG_SRCIN_TIMSEL1, /* Gen2 only */
73 RSND_REG_SRCIN_TIMSEL2, /* Gen2 only */
74 RSND_REG_SRCIN_TIMSEL3, /* Gen2 only */
75 RSND_REG_SRCIN_TIMSEL4, /* Gen2 only */
76 RSND_REG_SRCOUT_TIMSEL0, /* Gen2 only */
77 RSND_REG_SRCOUT_TIMSEL1, /* Gen2 only */
78 RSND_REG_SRCOUT_TIMSEL2, /* Gen2 only */
79 RSND_REG_SRCOUT_TIMSEL3, /* Gen2 only */
80 RSND_REG_SRCOUT_TIMSEL4, /* Gen2 only */
81 RSND_REG_SCU_SYS_STATUS0,
82 RSND_REG_SCU_SYS_STATUS1, /* Gen2 only */
83 RSND_REG_SCU_SYS_INT_EN0,
84 RSND_REG_SCU_SYS_INT_EN1, /* Gen2 only */
85 RSND_REG_CMD_CTRL, /* Gen2 only */
86 RSND_REG_CMD_BUSIF_DALIGN, /* Gen2 only */
87 RSND_REG_CMD_ROUTE_SLCT,
88 RSND_REG_CMDOUT_TIMSEL, /* Gen2 only */
150 RSND_REG_DVC_VRCTR, /* Gen2 only */
151 RSND_REG_DVC_VRPDR, /* Gen2 only */
152 RSND_REG_DVC_VRDBR, /* Gen2 only */
158 RSND_REG_DIV_EN, /* Gen2 only */
159 RSND_REG_AUDIO_CLK_SEL0,
160 RSND_REG_AUDIO_CLK_SEL1,
161 RSND_REG_AUDIO_CLK_SEL2, /* Gen2 only */
176 struct rsnd_dai_stream;
179 * R-Car basic functions
181 #define rsnd_mod_read(m, r) \
182 rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
183 #define rsnd_mod_write(m, r, d) \
184 rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
185 #define rsnd_mod_bset(m, r, s, d) \
186 rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
188 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
189 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
190 enum rsnd_reg reg, u32 data);
191 void rsnd_force_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
192 enum rsnd_reg reg, u32 data);
193 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
195 u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
196 u32 rsnd_get_adinr_chan(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
197 u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
202 int rsnd_dma_attach(struct rsnd_dai_stream *io,
203 struct rsnd_mod *mod, struct rsnd_mod **dma_mod, int id);
204 int rsnd_dma_probe(struct rsnd_priv *priv);
205 struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node,
206 struct rsnd_mod *mod, char *name);
219 RSND_MOD_SSIM3, /* SSI multi 3 */
220 RSND_MOD_SSIM2, /* SSI multi 2 */
221 RSND_MOD_SSIM1, /* SSI multi 1 */
222 RSND_MOD_SSIP, /* SSI parent */
228 struct rsnd_mod_ops {
230 struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
231 struct rsnd_mod *mod);
232 int (*probe)(struct rsnd_mod *mod,
233 struct rsnd_dai_stream *io,
234 struct rsnd_priv *priv);
235 int (*remove)(struct rsnd_mod *mod,
236 struct rsnd_dai_stream *io,
237 struct rsnd_priv *priv);
238 int (*init)(struct rsnd_mod *mod,
239 struct rsnd_dai_stream *io,
240 struct rsnd_priv *priv);
241 int (*quit)(struct rsnd_mod *mod,
242 struct rsnd_dai_stream *io,
243 struct rsnd_priv *priv);
244 int (*start)(struct rsnd_mod *mod,
245 struct rsnd_dai_stream *io,
246 struct rsnd_priv *priv);
247 int (*stop)(struct rsnd_mod *mod,
248 struct rsnd_dai_stream *io,
249 struct rsnd_priv *priv);
250 int (*irq)(struct rsnd_mod *mod,
251 struct rsnd_dai_stream *io,
252 struct rsnd_priv *priv, int enable);
253 int (*pcm_new)(struct rsnd_mod *mod,
254 struct rsnd_dai_stream *io,
255 struct snd_soc_pcm_runtime *rtd);
256 int (*hw_params)(struct rsnd_mod *mod,
257 struct rsnd_dai_stream *io,
258 struct snd_pcm_substream *substream,
259 struct snd_pcm_hw_params *hw_params);
260 int (*fallback)(struct rsnd_mod *mod,
261 struct rsnd_dai_stream *io,
262 struct rsnd_priv *priv);
265 struct rsnd_dai_stream;
268 enum rsnd_mod_type type;
269 struct rsnd_mod_ops *ops;
270 struct rsnd_priv *priv;
272 u32 *(*get_status)(struct rsnd_dai_stream *io,
273 struct rsnd_mod *mod,
274 enum rsnd_mod_type type);
285 * H is always called (see __rsnd_mod_call)
286 * H 0: probe 1: remove
291 #define __rsnd_mod_shift_init 4
292 #define __rsnd_mod_shift_quit 4
293 #define __rsnd_mod_shift_start 8
294 #define __rsnd_mod_shift_stop 8
295 #define __rsnd_mod_shift_probe 28 /* always called */
296 #define __rsnd_mod_shift_remove 28 /* always called */
297 #define __rsnd_mod_shift_irq 28 /* always called */
298 #define __rsnd_mod_shift_pcm_new 28 /* always called */
299 #define __rsnd_mod_shift_fallback 28 /* always called */
300 #define __rsnd_mod_shift_hw_params 28 /* always called */
302 #define __rsnd_mod_add_probe 0
303 #define __rsnd_mod_add_remove 0
304 #define __rsnd_mod_add_init 1
305 #define __rsnd_mod_add_quit -1
306 #define __rsnd_mod_add_start 1
307 #define __rsnd_mod_add_stop -1
308 #define __rsnd_mod_add_irq 0
309 #define __rsnd_mod_add_pcm_new 0
310 #define __rsnd_mod_add_fallback 0
311 #define __rsnd_mod_add_hw_params 0
313 #define __rsnd_mod_call_probe 0
314 #define __rsnd_mod_call_remove 0
315 #define __rsnd_mod_call_init 0
316 #define __rsnd_mod_call_quit 1
317 #define __rsnd_mod_call_start 0
318 #define __rsnd_mod_call_stop 1
319 #define __rsnd_mod_call_irq 0
320 #define __rsnd_mod_call_pcm_new 0
321 #define __rsnd_mod_call_fallback 0
322 #define __rsnd_mod_call_hw_params 0
324 #define rsnd_mod_to_priv(mod) ((mod)->priv)
325 #define rsnd_mod_id(mod) ((mod) ? (mod)->id : -1)
326 #define rsnd_mod_power_on(mod) clk_enable((mod)->clk)
327 #define rsnd_mod_power_off(mod) clk_disable((mod)->clk)
328 #define rsnd_mod_get(ip) (&(ip)->mod)
330 int rsnd_mod_init(struct rsnd_priv *priv,
331 struct rsnd_mod *mod,
332 struct rsnd_mod_ops *ops,
334 u32* (*get_status)(struct rsnd_dai_stream *io,
335 struct rsnd_mod *mod,
336 enum rsnd_mod_type type),
337 enum rsnd_mod_type type,
339 void rsnd_mod_quit(struct rsnd_mod *mod);
340 char *rsnd_mod_name(struct rsnd_mod *mod);
341 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
342 struct rsnd_mod *mod);
343 void rsnd_mod_interrupt(struct rsnd_mod *mod,
344 void (*callback)(struct rsnd_mod *mod,
345 struct rsnd_dai_stream *io));
346 u32 *rsnd_mod_get_status(struct rsnd_dai_stream *io,
347 struct rsnd_mod *mod,
348 enum rsnd_mod_type type);
350 void rsnd_parse_connect_common(struct rsnd_dai *rdai,
351 struct rsnd_mod* (*mod_get)(struct rsnd_priv *priv, int id),
352 struct device_node *node,
353 struct device_node *playback,
354 struct device_node *capture);
356 void rsnd_set_slot(struct rsnd_dai *rdai,
357 int slots, int slots_total);
358 int rsnd_get_slot(struct rsnd_dai_stream *io);
359 int rsnd_get_slot_width(struct rsnd_dai_stream *io);
360 int rsnd_get_slot_num(struct rsnd_dai_stream *io);
365 #define RSND_DAI_NAME_SIZE 16
366 struct rsnd_dai_stream {
367 char name[RSND_DAI_NAME_SIZE];
368 struct snd_pcm_substream *substream;
369 struct rsnd_mod *mod[RSND_MOD_MAX];
370 struct rsnd_dai_path_info *info; /* rcar_snd.h */
371 struct rsnd_dai *rdai;
372 u32 parent_ssi_status;
376 int next_period_byte;
378 #define rsnd_io_to_mod(io, i) ((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
379 #define rsnd_io_to_mod_ssi(io) rsnd_io_to_mod((io), RSND_MOD_SSI)
380 #define rsnd_io_to_mod_ssip(io) rsnd_io_to_mod((io), RSND_MOD_SSIP)
381 #define rsnd_io_to_mod_src(io) rsnd_io_to_mod((io), RSND_MOD_SRC)
382 #define rsnd_io_to_mod_ctu(io) rsnd_io_to_mod((io), RSND_MOD_CTU)
383 #define rsnd_io_to_mod_mix(io) rsnd_io_to_mod((io), RSND_MOD_MIX)
384 #define rsnd_io_to_mod_dvc(io) rsnd_io_to_mod((io), RSND_MOD_DVC)
385 #define rsnd_io_to_mod_cmd(io) rsnd_io_to_mod((io), RSND_MOD_CMD)
386 #define rsnd_io_to_rdai(io) ((io)->rdai)
387 #define rsnd_io_to_priv(io) (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
388 #define rsnd_io_is_play(io) (&rsnd_io_to_rdai(io)->playback == io)
389 #define rsnd_io_to_runtime(io) ((io)->substream ? \
390 (io)->substream->runtime : NULL)
391 int rsnd_io_is_working(struct rsnd_dai_stream *io);
394 char name[RSND_DAI_NAME_SIZE];
395 struct rsnd_dai_stream playback;
396 struct rsnd_dai_stream capture;
397 struct rsnd_priv *priv;
402 unsigned int clk_master:1;
403 unsigned int bit_clk_inv:1;
404 unsigned int frm_clk_inv:1;
405 unsigned int sys_delay:1;
406 unsigned int data_alignment:1;
409 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
410 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
411 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
412 #define for_each_rsnd_dai(rdai, priv, i) \
414 (i < rsnd_rdai_nr(priv)) && \
415 ((rdai) = rsnd_rdai_get(priv, i)); \
418 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
420 bool rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
421 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
422 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
423 int rsnd_dai_connect(struct rsnd_mod *mod,
424 struct rsnd_dai_stream *io,
425 enum rsnd_mod_type type);
426 #define rsnd_dai_of_node(priv) \
427 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,dai")
432 int rsnd_gen_probe(struct rsnd_priv *priv);
433 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
434 struct rsnd_mod *mod,
436 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
441 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
442 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
443 int rsnd_adg_probe(struct rsnd_priv *priv);
444 void rsnd_adg_remove(struct rsnd_priv *priv);
445 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
446 struct rsnd_dai_stream *io,
447 unsigned int src_rate,
448 unsigned int dst_rate);
449 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
450 struct rsnd_dai_stream *io);
451 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
452 struct rsnd_dai_stream *io);
459 struct platform_device *pdev;
462 #define RSND_GEN_MASK (0xF << 0)
463 #define RSND_GEN1 (1 << 0)
464 #define RSND_GEN2 (2 << 0)
467 * below value will be filled on rsnd_gen_probe()
472 * below value will be filled on rsnd_adg_probe()
477 * below value will be filled on rsnd_dma_probe()
482 * below value will be filled on rsnd_ssi_probe()
488 * below value will be filled on rsnd_ssiu_probe()
494 * below value will be filled on rsnd_src_probe()
500 * below value will be filled on rsnd_ctu_probe()
506 * below value will be filled on rsnd_mix_probe()
512 * below value will be filled on rsnd_dvc_probe()
518 * below value will be filled on rsnd_cmd_probe()
524 * below value will be filled on rsnd_dai_probe()
526 struct snd_soc_dai_driver *daidrv;
527 struct rsnd_dai *rdai;
531 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
532 #define rsnd_priv_to_dev(priv) (&(rsnd_priv_to_pdev(priv)->dev))
534 #define rsnd_is_gen1(priv) (((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
535 #define rsnd_is_gen2(priv) (((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
540 struct rsnd_kctrl_cfg {
544 const char * const *texts;
545 void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
546 struct rsnd_dai_stream *io;
547 struct snd_card *card;
548 struct snd_kcontrol *kctrl;
551 #define RSND_MAX_CHANNELS 8
552 struct rsnd_kctrl_cfg_m {
553 struct rsnd_kctrl_cfg cfg;
554 u32 val[RSND_MAX_CHANNELS];
557 struct rsnd_kctrl_cfg_s {
558 struct rsnd_kctrl_cfg cfg;
562 void _rsnd_kctrl_remove(struct rsnd_kctrl_cfg *cfg);
563 #define rsnd_kctrl_remove(_cfg) _rsnd_kctrl_remove(&((_cfg).cfg))
565 int rsnd_kctrl_new_m(struct rsnd_mod *mod,
566 struct rsnd_dai_stream *io,
567 struct snd_soc_pcm_runtime *rtd,
568 const unsigned char *name,
569 void (*update)(struct rsnd_dai_stream *io,
570 struct rsnd_mod *mod),
571 struct rsnd_kctrl_cfg_m *_cfg,
574 int rsnd_kctrl_new_s(struct rsnd_mod *mod,
575 struct rsnd_dai_stream *io,
576 struct snd_soc_pcm_runtime *rtd,
577 const unsigned char *name,
578 void (*update)(struct rsnd_dai_stream *io,
579 struct rsnd_mod *mod),
580 struct rsnd_kctrl_cfg_s *_cfg,
582 int rsnd_kctrl_new_e(struct rsnd_mod *mod,
583 struct rsnd_dai_stream *io,
584 struct snd_soc_pcm_runtime *rtd,
585 const unsigned char *name,
586 struct rsnd_kctrl_cfg_s *_cfg,
587 void (*update)(struct rsnd_dai_stream *io,
588 struct rsnd_mod *mod),
589 const char * const *texts,
595 int rsnd_ssi_probe(struct rsnd_priv *priv);
596 void rsnd_ssi_remove(struct rsnd_priv *priv);
597 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
598 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
599 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
600 u32 rsnd_ssi_multi_slaves_runtime(struct rsnd_dai_stream *io);
602 #define rsnd_ssi_is_pin_sharing(io) \
603 __rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
604 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
606 #define rsnd_ssi_of_node(priv) \
607 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,ssi")
608 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
609 struct device_node *playback,
610 struct device_node *capture);
615 int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
616 struct rsnd_mod *mod);
617 int rsnd_ssiu_probe(struct rsnd_priv *priv);
618 void rsnd_ssiu_remove(struct rsnd_priv *priv);
623 int rsnd_src_probe(struct rsnd_priv *priv);
624 void rsnd_src_remove(struct rsnd_priv *priv);
625 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
626 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
627 struct rsnd_dai_stream *io,
628 struct snd_pcm_runtime *runtime);
629 #define rsnd_src_of_node(priv) \
630 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,src")
631 #define rsnd_parse_connect_src(rdai, playback, capture) \
632 rsnd_parse_connect_common(rdai, rsnd_src_mod_get, \
633 rsnd_src_of_node(rsnd_rdai_to_priv(rdai)), \
639 int rsnd_ctu_probe(struct rsnd_priv *priv);
640 void rsnd_ctu_remove(struct rsnd_priv *priv);
641 struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
642 #define rsnd_ctu_of_node(priv) \
643 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,ctu")
644 #define rsnd_parse_connect_ctu(rdai, playback, capture) \
645 rsnd_parse_connect_common(rdai, rsnd_ctu_mod_get, \
646 rsnd_ctu_of_node(rsnd_rdai_to_priv(rdai)), \
652 int rsnd_mix_probe(struct rsnd_priv *priv);
653 void rsnd_mix_remove(struct rsnd_priv *priv);
654 struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
655 #define rsnd_mix_of_node(priv) \
656 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,mix")
657 #define rsnd_parse_connect_mix(rdai, playback, capture) \
658 rsnd_parse_connect_common(rdai, rsnd_mix_mod_get, \
659 rsnd_mix_of_node(rsnd_rdai_to_priv(rdai)), \
665 int rsnd_dvc_probe(struct rsnd_priv *priv);
666 void rsnd_dvc_remove(struct rsnd_priv *priv);
667 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
668 #define rsnd_dvc_of_node(priv) \
669 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,dvc")
670 #define rsnd_parse_connect_dvc(rdai, playback, capture) \
671 rsnd_parse_connect_common(rdai, rsnd_dvc_mod_get, \
672 rsnd_dvc_of_node(rsnd_rdai_to_priv(rdai)), \
678 int rsnd_cmd_probe(struct rsnd_priv *priv);
679 void rsnd_cmd_remove(struct rsnd_priv *priv);
680 int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
681 struct rsnd_mod *rsnd_cmd_mod_get(struct rsnd_priv *priv, int id);
684 void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
685 #define rsnd_mod_confirm_ssi(mssi) rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
686 #define rsnd_mod_confirm_src(msrc) rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
687 #define rsnd_mod_confirm_dvc(mdvc) rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
689 #define rsnd_mod_confirm_ssi(mssi)
690 #define rsnd_mod_confirm_src(msrc)
691 #define rsnd_mod_confirm_dvc(mdvc)