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_force_write(m, r, d) \
186 rsnd_force_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
187 #define rsnd_mod_bset(m, r, s, d) \
188 rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
190 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
191 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
192 enum rsnd_reg reg, u32 data);
193 void rsnd_force_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
194 enum rsnd_reg reg, u32 data);
195 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
197 u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
198 u32 rsnd_get_adinr_chan(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
199 u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
204 int rsnd_dma_attach(struct rsnd_dai_stream *io,
205 struct rsnd_mod *mod, struct rsnd_mod **dma_mod, int id);
206 int rsnd_dma_probe(struct rsnd_priv *priv);
207 struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node,
208 struct rsnd_mod *mod, char *name);
221 RSND_MOD_SSIM3, /* SSI multi 3 */
222 RSND_MOD_SSIM2, /* SSI multi 2 */
223 RSND_MOD_SSIM1, /* SSI multi 1 */
224 RSND_MOD_SSIP, /* SSI parent */
230 struct rsnd_mod_ops {
232 struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
233 struct rsnd_mod *mod);
234 int (*probe)(struct rsnd_mod *mod,
235 struct rsnd_dai_stream *io,
236 struct rsnd_priv *priv);
237 int (*remove)(struct rsnd_mod *mod,
238 struct rsnd_dai_stream *io,
239 struct rsnd_priv *priv);
240 int (*init)(struct rsnd_mod *mod,
241 struct rsnd_dai_stream *io,
242 struct rsnd_priv *priv);
243 int (*quit)(struct rsnd_mod *mod,
244 struct rsnd_dai_stream *io,
245 struct rsnd_priv *priv);
246 int (*start)(struct rsnd_mod *mod,
247 struct rsnd_dai_stream *io,
248 struct rsnd_priv *priv);
249 int (*stop)(struct rsnd_mod *mod,
250 struct rsnd_dai_stream *io,
251 struct rsnd_priv *priv);
252 int (*irq)(struct rsnd_mod *mod,
253 struct rsnd_dai_stream *io,
254 struct rsnd_priv *priv, int enable);
255 int (*pcm_new)(struct rsnd_mod *mod,
256 struct rsnd_dai_stream *io,
257 struct snd_soc_pcm_runtime *rtd);
258 int (*hw_params)(struct rsnd_mod *mod,
259 struct rsnd_dai_stream *io,
260 struct snd_pcm_substream *substream,
261 struct snd_pcm_hw_params *hw_params);
262 int (*fallback)(struct rsnd_mod *mod,
263 struct rsnd_dai_stream *io,
264 struct rsnd_priv *priv);
267 struct rsnd_dai_stream;
270 enum rsnd_mod_type type;
271 struct rsnd_mod_ops *ops;
272 struct rsnd_priv *priv;
274 u32 *(*get_status)(struct rsnd_dai_stream *io,
275 struct rsnd_mod *mod,
276 enum rsnd_mod_type type);
287 * H is always called (see __rsnd_mod_call)
288 * H 0: probe 1: remove
293 #define __rsnd_mod_shift_init 4
294 #define __rsnd_mod_shift_quit 4
295 #define __rsnd_mod_shift_start 8
296 #define __rsnd_mod_shift_stop 8
297 #define __rsnd_mod_shift_probe 28 /* always called */
298 #define __rsnd_mod_shift_remove 28 /* always called */
299 #define __rsnd_mod_shift_irq 28 /* always called */
300 #define __rsnd_mod_shift_pcm_new 28 /* always called */
301 #define __rsnd_mod_shift_fallback 28 /* always called */
302 #define __rsnd_mod_shift_hw_params 28 /* always called */
304 #define __rsnd_mod_add_probe 0
305 #define __rsnd_mod_add_remove 0
306 #define __rsnd_mod_add_init 1
307 #define __rsnd_mod_add_quit -1
308 #define __rsnd_mod_add_start 1
309 #define __rsnd_mod_add_stop -1
310 #define __rsnd_mod_add_irq 0
311 #define __rsnd_mod_add_pcm_new 0
312 #define __rsnd_mod_add_fallback 0
313 #define __rsnd_mod_add_hw_params 0
315 #define __rsnd_mod_call_probe 0
316 #define __rsnd_mod_call_remove 0
317 #define __rsnd_mod_call_init 0
318 #define __rsnd_mod_call_quit 1
319 #define __rsnd_mod_call_start 0
320 #define __rsnd_mod_call_stop 1
321 #define __rsnd_mod_call_irq 0
322 #define __rsnd_mod_call_pcm_new 0
323 #define __rsnd_mod_call_fallback 0
324 #define __rsnd_mod_call_hw_params 0
326 #define rsnd_mod_to_priv(mod) ((mod)->priv)
327 #define rsnd_mod_id(mod) ((mod) ? (mod)->id : -1)
328 #define rsnd_mod_power_on(mod) clk_enable((mod)->clk)
329 #define rsnd_mod_power_off(mod) clk_disable((mod)->clk)
330 #define rsnd_mod_get(ip) (&(ip)->mod)
332 int rsnd_mod_init(struct rsnd_priv *priv,
333 struct rsnd_mod *mod,
334 struct rsnd_mod_ops *ops,
336 u32* (*get_status)(struct rsnd_dai_stream *io,
337 struct rsnd_mod *mod,
338 enum rsnd_mod_type type),
339 enum rsnd_mod_type type,
341 void rsnd_mod_quit(struct rsnd_mod *mod);
342 char *rsnd_mod_name(struct rsnd_mod *mod);
343 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
344 struct rsnd_mod *mod);
345 void rsnd_mod_interrupt(struct rsnd_mod *mod,
346 void (*callback)(struct rsnd_mod *mod,
347 struct rsnd_dai_stream *io));
348 u32 *rsnd_mod_get_status(struct rsnd_dai_stream *io,
349 struct rsnd_mod *mod,
350 enum rsnd_mod_type type);
352 void rsnd_parse_connect_common(struct rsnd_dai *rdai,
353 struct rsnd_mod* (*mod_get)(struct rsnd_priv *priv, int id),
354 struct device_node *node,
355 struct device_node *playback,
356 struct device_node *capture);
358 void rsnd_set_slot(struct rsnd_dai *rdai,
359 int slots, int slots_total);
360 int rsnd_get_slot(struct rsnd_dai_stream *io);
361 int rsnd_get_slot_width(struct rsnd_dai_stream *io);
362 int rsnd_get_slot_num(struct rsnd_dai_stream *io);
367 #define RSND_DAI_NAME_SIZE 16
368 struct rsnd_dai_stream {
369 char name[RSND_DAI_NAME_SIZE];
370 struct snd_pcm_substream *substream;
371 struct rsnd_mod *mod[RSND_MOD_MAX];
372 struct rsnd_dai_path_info *info; /* rcar_snd.h */
373 struct rsnd_dai *rdai;
374 u32 parent_ssi_status;
378 int next_period_byte;
380 #define rsnd_io_to_mod(io, i) ((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
381 #define rsnd_io_to_mod_ssi(io) rsnd_io_to_mod((io), RSND_MOD_SSI)
382 #define rsnd_io_to_mod_ssip(io) rsnd_io_to_mod((io), RSND_MOD_SSIP)
383 #define rsnd_io_to_mod_src(io) rsnd_io_to_mod((io), RSND_MOD_SRC)
384 #define rsnd_io_to_mod_ctu(io) rsnd_io_to_mod((io), RSND_MOD_CTU)
385 #define rsnd_io_to_mod_mix(io) rsnd_io_to_mod((io), RSND_MOD_MIX)
386 #define rsnd_io_to_mod_dvc(io) rsnd_io_to_mod((io), RSND_MOD_DVC)
387 #define rsnd_io_to_mod_cmd(io) rsnd_io_to_mod((io), RSND_MOD_CMD)
388 #define rsnd_io_to_rdai(io) ((io)->rdai)
389 #define rsnd_io_to_priv(io) (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
390 #define rsnd_io_is_play(io) (&rsnd_io_to_rdai(io)->playback == io)
391 #define rsnd_io_to_runtime(io) ((io)->substream ? \
392 (io)->substream->runtime : NULL)
393 int rsnd_io_is_working(struct rsnd_dai_stream *io);
396 char name[RSND_DAI_NAME_SIZE];
397 struct rsnd_dai_stream playback;
398 struct rsnd_dai_stream capture;
399 struct rsnd_priv *priv;
404 unsigned int clk_master:1;
405 unsigned int bit_clk_inv:1;
406 unsigned int frm_clk_inv:1;
407 unsigned int sys_delay:1;
408 unsigned int data_alignment:1;
411 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
412 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
413 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
414 #define for_each_rsnd_dai(rdai, priv, i) \
416 (i < rsnd_rdai_nr(priv)) && \
417 ((rdai) = rsnd_rdai_get(priv, i)); \
420 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
422 bool rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
423 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
424 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
425 int rsnd_dai_connect(struct rsnd_mod *mod,
426 struct rsnd_dai_stream *io,
427 enum rsnd_mod_type type);
428 #define rsnd_dai_of_node(priv) \
429 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,dai")
434 int rsnd_gen_probe(struct rsnd_priv *priv);
435 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
436 struct rsnd_mod *mod,
438 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
443 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
444 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
445 int rsnd_adg_probe(struct rsnd_priv *priv);
446 void rsnd_adg_remove(struct rsnd_priv *priv);
447 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
448 struct rsnd_dai_stream *io,
449 unsigned int src_rate,
450 unsigned int dst_rate);
451 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
452 struct rsnd_dai_stream *io);
453 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
454 struct rsnd_dai_stream *io);
461 struct platform_device *pdev;
464 #define RSND_GEN_MASK (0xF << 0)
465 #define RSND_GEN1 (1 << 0)
466 #define RSND_GEN2 (2 << 0)
469 * below value will be filled on rsnd_gen_probe()
474 * below value will be filled on rsnd_adg_probe()
479 * below value will be filled on rsnd_dma_probe()
484 * below value will be filled on rsnd_ssi_probe()
490 * below value will be filled on rsnd_ssiu_probe()
496 * below value will be filled on rsnd_src_probe()
502 * below value will be filled on rsnd_ctu_probe()
508 * below value will be filled on rsnd_mix_probe()
514 * below value will be filled on rsnd_dvc_probe()
520 * below value will be filled on rsnd_cmd_probe()
526 * below value will be filled on rsnd_dai_probe()
528 struct snd_soc_dai_driver *daidrv;
529 struct rsnd_dai *rdai;
533 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
534 #define rsnd_priv_to_dev(priv) (&(rsnd_priv_to_pdev(priv)->dev))
536 #define rsnd_is_gen1(priv) (((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
537 #define rsnd_is_gen2(priv) (((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
542 struct rsnd_kctrl_cfg {
546 const char * const *texts;
547 void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
548 struct rsnd_dai_stream *io;
549 struct snd_card *card;
550 struct snd_kcontrol *kctrl;
553 #define RSND_DVC_CHANNELS 8
554 struct rsnd_kctrl_cfg_m {
555 struct rsnd_kctrl_cfg cfg;
556 u32 val[RSND_DVC_CHANNELS];
559 struct rsnd_kctrl_cfg_s {
560 struct rsnd_kctrl_cfg cfg;
564 void _rsnd_kctrl_remove(struct rsnd_kctrl_cfg *cfg);
565 #define rsnd_kctrl_remove(_cfg) _rsnd_kctrl_remove(&((_cfg).cfg))
567 int rsnd_kctrl_new_m(struct rsnd_mod *mod,
568 struct rsnd_dai_stream *io,
569 struct snd_soc_pcm_runtime *rtd,
570 const unsigned char *name,
571 void (*update)(struct rsnd_dai_stream *io,
572 struct rsnd_mod *mod),
573 struct rsnd_kctrl_cfg_m *_cfg,
576 int rsnd_kctrl_new_s(struct rsnd_mod *mod,
577 struct rsnd_dai_stream *io,
578 struct snd_soc_pcm_runtime *rtd,
579 const unsigned char *name,
580 void (*update)(struct rsnd_dai_stream *io,
581 struct rsnd_mod *mod),
582 struct rsnd_kctrl_cfg_s *_cfg,
584 int rsnd_kctrl_new_e(struct rsnd_mod *mod,
585 struct rsnd_dai_stream *io,
586 struct snd_soc_pcm_runtime *rtd,
587 const unsigned char *name,
588 struct rsnd_kctrl_cfg_s *_cfg,
589 void (*update)(struct rsnd_dai_stream *io,
590 struct rsnd_mod *mod),
591 const char * const *texts,
597 int rsnd_ssi_probe(struct rsnd_priv *priv);
598 void rsnd_ssi_remove(struct rsnd_priv *priv);
599 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
600 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
601 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
602 u32 rsnd_ssi_multi_slaves(struct rsnd_dai_stream *io);
604 #define rsnd_ssi_is_pin_sharing(io) \
605 __rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
606 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
608 #define rsnd_ssi_of_node(priv) \
609 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,ssi")
610 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
611 struct device_node *playback,
612 struct device_node *capture);
617 int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
618 struct rsnd_mod *mod);
619 int rsnd_ssiu_probe(struct rsnd_priv *priv);
620 void rsnd_ssiu_remove(struct rsnd_priv *priv);
625 int rsnd_src_probe(struct rsnd_priv *priv);
626 void rsnd_src_remove(struct rsnd_priv *priv);
627 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
628 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
629 struct rsnd_dai_stream *io,
630 struct snd_pcm_runtime *runtime);
631 #define rsnd_src_of_node(priv) \
632 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,src")
633 #define rsnd_parse_connect_src(rdai, playback, capture) \
634 rsnd_parse_connect_common(rdai, rsnd_src_mod_get, \
635 rsnd_src_of_node(rsnd_rdai_to_priv(rdai)), \
641 int rsnd_ctu_probe(struct rsnd_priv *priv);
642 void rsnd_ctu_remove(struct rsnd_priv *priv);
643 struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
644 #define rsnd_ctu_of_node(priv) \
645 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,ctu")
646 #define rsnd_parse_connect_ctu(rdai, playback, capture) \
647 rsnd_parse_connect_common(rdai, rsnd_ctu_mod_get, \
648 rsnd_ctu_of_node(rsnd_rdai_to_priv(rdai)), \
654 int rsnd_mix_probe(struct rsnd_priv *priv);
655 void rsnd_mix_remove(struct rsnd_priv *priv);
656 struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
657 #define rsnd_mix_of_node(priv) \
658 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,mix")
659 #define rsnd_parse_connect_mix(rdai, playback, capture) \
660 rsnd_parse_connect_common(rdai, rsnd_mix_mod_get, \
661 rsnd_mix_of_node(rsnd_rdai_to_priv(rdai)), \
667 int rsnd_dvc_probe(struct rsnd_priv *priv);
668 void rsnd_dvc_remove(struct rsnd_priv *priv);
669 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
670 #define rsnd_dvc_of_node(priv) \
671 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,dvc")
672 #define rsnd_parse_connect_dvc(rdai, playback, capture) \
673 rsnd_parse_connect_common(rdai, rsnd_dvc_mod_get, \
674 rsnd_dvc_of_node(rsnd_rdai_to_priv(rdai)), \
680 int rsnd_cmd_probe(struct rsnd_priv *priv);
681 void rsnd_cmd_remove(struct rsnd_priv *priv);
682 int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
683 struct rsnd_mod *rsnd_cmd_mod_get(struct rsnd_priv *priv, int id);
686 void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
687 #define rsnd_mod_confirm_ssi(mssi) rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
688 #define rsnd_mod_confirm_src(msrc) rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
689 #define rsnd_mod_confirm_dvc(mdvc) rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
691 #define rsnd_mod_confirm_ssi(mssi)
692 #define rsnd_mod_confirm_src(msrc)
693 #define rsnd_mod_confirm_dvc(mdvc)