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 */
50 RSND_REG_SSI_CTRL, /* Gen2 only */
51 RSND_REG_SSI_BUSIF_MODE, /* Gen2 only */
52 RSND_REG_SSI_BUSIF_ADINR, /* Gen2 only */
53 RSND_REG_SSI_BUSIF_DALIGN, /* Gen2 only */
54 RSND_REG_SSI_INT_ENABLE, /* Gen2 only */
55 RSND_REG_SRC_I_BUSIF_MODE,
56 RSND_REG_SRC_O_BUSIF_MODE,
57 RSND_REG_SRC_ROUTE_MODE0,
64 RSND_REG_SRC_CTRL, /* Gen2 only */
65 RSND_REG_SRC_BSDSR, /* Gen2 only */
66 RSND_REG_SRC_BSISR, /* Gen2 only */
67 RSND_REG_SRC_INT_ENABLE0, /* Gen2 only */
68 RSND_REG_SRC_BUSIF_DALIGN, /* Gen2 only */
69 RSND_REG_SRCIN_TIMSEL0, /* Gen2 only */
70 RSND_REG_SRCIN_TIMSEL1, /* Gen2 only */
71 RSND_REG_SRCIN_TIMSEL2, /* Gen2 only */
72 RSND_REG_SRCIN_TIMSEL3, /* Gen2 only */
73 RSND_REG_SRCIN_TIMSEL4, /* Gen2 only */
74 RSND_REG_SRCOUT_TIMSEL0, /* Gen2 only */
75 RSND_REG_SRCOUT_TIMSEL1, /* Gen2 only */
76 RSND_REG_SRCOUT_TIMSEL2, /* Gen2 only */
77 RSND_REG_SRCOUT_TIMSEL3, /* Gen2 only */
78 RSND_REG_SRCOUT_TIMSEL4, /* Gen2 only */
79 RSND_REG_SCU_SYS_STATUS0,
80 RSND_REG_SCU_SYS_STATUS1, /* Gen2 only */
81 RSND_REG_SCU_SYS_INT_EN0,
82 RSND_REG_SCU_SYS_INT_EN1, /* Gen2 only */
83 RSND_REG_CMD_CTRL, /* Gen2 only */
84 RSND_REG_CMD_BUSIF_DALIGN, /* Gen2 only */
85 RSND_REG_CMD_ROUTE_SLCT,
86 RSND_REG_CMDOUT_TIMSEL, /* Gen2 only */
113 RSND_REG_DVC_VRCTR, /* Gen2 only */
114 RSND_REG_DVC_VRPDR, /* Gen2 only */
115 RSND_REG_DVC_VRDBR, /* Gen2 only */
121 RSND_REG_DIV_EN, /* Gen2 only */
122 RSND_REG_AUDIO_CLK_SEL0,
123 RSND_REG_AUDIO_CLK_SEL1,
124 RSND_REG_AUDIO_CLK_SEL2, /* Gen2 only */
139 struct rsnd_dai_stream;
142 * R-Car basic functions
144 #define rsnd_mod_read(m, r) \
145 rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
146 #define rsnd_mod_write(m, r, d) \
147 rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
148 #define rsnd_mod_force_write(m, r, d) \
149 rsnd_force_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
150 #define rsnd_mod_bset(m, r, s, d) \
151 rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
153 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
154 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
155 enum rsnd_reg reg, u32 data);
156 void rsnd_force_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
157 enum rsnd_reg reg, u32 data);
158 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
160 u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
161 u32 rsnd_get_adinr_chan(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
162 u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
167 struct rsnd_mod *rsnd_dma_attach(struct rsnd_dai_stream *io,
168 struct rsnd_mod *mod, int id);
169 int rsnd_dma_probe(struct rsnd_priv *priv);
170 struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node,
171 struct rsnd_mod *mod, char *name);
185 RSND_MOD_SSIP, /* SSI parent */
190 struct rsnd_mod_ops {
192 struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
193 struct rsnd_mod *mod);
194 int (*probe)(struct rsnd_mod *mod,
195 struct rsnd_dai_stream *io,
196 struct rsnd_priv *priv);
197 int (*remove)(struct rsnd_mod *mod,
198 struct rsnd_dai_stream *io,
199 struct rsnd_priv *priv);
200 int (*init)(struct rsnd_mod *mod,
201 struct rsnd_dai_stream *io,
202 struct rsnd_priv *priv);
203 int (*quit)(struct rsnd_mod *mod,
204 struct rsnd_dai_stream *io,
205 struct rsnd_priv *priv);
206 int (*start)(struct rsnd_mod *mod,
207 struct rsnd_dai_stream *io,
208 struct rsnd_priv *priv);
209 int (*stop)(struct rsnd_mod *mod,
210 struct rsnd_dai_stream *io,
211 struct rsnd_priv *priv);
212 int (*pcm_new)(struct rsnd_mod *mod,
213 struct rsnd_dai_stream *io,
214 struct snd_soc_pcm_runtime *rtd);
215 int (*hw_params)(struct rsnd_mod *mod,
216 struct rsnd_dai_stream *io,
217 struct snd_pcm_substream *substream,
218 struct snd_pcm_hw_params *hw_params);
219 int (*fallback)(struct rsnd_mod *mod,
220 struct rsnd_dai_stream *io,
221 struct rsnd_priv *priv);
224 struct rsnd_dai_stream;
227 enum rsnd_mod_type type;
228 struct rsnd_mod_ops *ops;
229 struct rsnd_priv *priv;
237 * A 0: probe 1: remove
241 * H is always called (see __rsnd_mod_call)
246 #define __rsnd_mod_shift_probe 0
247 #define __rsnd_mod_shift_remove 0
248 #define __rsnd_mod_shift_init 4
249 #define __rsnd_mod_shift_quit 4
250 #define __rsnd_mod_shift_start 8
251 #define __rsnd_mod_shift_stop 8
252 #define __rsnd_mod_shift_pcm_new 28 /* always called */
253 #define __rsnd_mod_shift_fallback 28 /* always called */
254 #define __rsnd_mod_shift_hw_params 28 /* always called */
256 #define __rsnd_mod_add_probe 1
257 #define __rsnd_mod_add_remove -1
258 #define __rsnd_mod_add_init 1
259 #define __rsnd_mod_add_quit -1
260 #define __rsnd_mod_add_start 1
261 #define __rsnd_mod_add_stop -1
262 #define __rsnd_mod_add_pcm_new 0
263 #define __rsnd_mod_add_fallback 0
264 #define __rsnd_mod_add_hw_params 0
266 #define __rsnd_mod_call_probe 0
267 #define __rsnd_mod_call_remove 1
268 #define __rsnd_mod_call_init 0
269 #define __rsnd_mod_call_quit 1
270 #define __rsnd_mod_call_start 0
271 #define __rsnd_mod_call_stop 1
272 #define __rsnd_mod_call_pcm_new 0
273 #define __rsnd_mod_call_fallback 0
274 #define __rsnd_mod_call_hw_params 0
276 #define rsnd_mod_to_priv(mod) ((mod)->priv)
277 #define rsnd_mod_id(mod) ((mod) ? (mod)->id : -1)
278 #define rsnd_mod_power_on(mod) clk_enable((mod)->clk)
279 #define rsnd_mod_power_off(mod) clk_disable((mod)->clk)
280 #define rsnd_mod_get(ip) (&(ip)->mod)
282 int rsnd_mod_init(struct rsnd_priv *priv,
283 struct rsnd_mod *mod,
284 struct rsnd_mod_ops *ops,
286 enum rsnd_mod_type type,
288 void rsnd_mod_quit(struct rsnd_mod *mod);
289 char *rsnd_mod_name(struct rsnd_mod *mod);
290 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
291 struct rsnd_mod *mod);
292 void rsnd_mod_interrupt(struct rsnd_mod *mod,
293 void (*callback)(struct rsnd_mod *mod,
294 struct rsnd_dai_stream *io));
296 int rsnd_get_slot_rdai(struct rsnd_dai *rdai);
297 int rsnd_get_slot_runtime(struct rsnd_dai_stream *io);
298 int rsnd_get_slot_extend(struct rsnd_dai_stream *io);
303 #define RSND_DAI_NAME_SIZE 16
304 struct rsnd_dai_stream {
305 char name[RSND_DAI_NAME_SIZE];
306 struct snd_pcm_substream *substream;
307 struct rsnd_mod *mod[RSND_MOD_MAX];
308 struct rsnd_dai_path_info *info; /* rcar_snd.h */
309 struct rsnd_dai *rdai;
310 u32 mod_status[RSND_MOD_MAX];
314 int next_period_byte;
316 #define rsnd_io_to_mod(io, i) ((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
317 #define rsnd_io_to_mod_ssi(io) rsnd_io_to_mod((io), RSND_MOD_SSI)
318 #define rsnd_io_to_mod_ssip(io) rsnd_io_to_mod((io), RSND_MOD_SSIP)
319 #define rsnd_io_to_mod_src(io) rsnd_io_to_mod((io), RSND_MOD_SRC)
320 #define rsnd_io_to_mod_ctu(io) rsnd_io_to_mod((io), RSND_MOD_CTU)
321 #define rsnd_io_to_mod_mix(io) rsnd_io_to_mod((io), RSND_MOD_MIX)
322 #define rsnd_io_to_mod_dvc(io) rsnd_io_to_mod((io), RSND_MOD_DVC)
323 #define rsnd_io_to_mod_cmd(io) rsnd_io_to_mod((io), RSND_MOD_CMD)
324 #define rsnd_io_to_rdai(io) ((io)->rdai)
325 #define rsnd_io_to_priv(io) (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
326 #define rsnd_io_is_play(io) (&rsnd_io_to_rdai(io)->playback == io)
327 #define rsnd_io_to_runtime(io) ((io)->substream ? \
328 (io)->substream->runtime : NULL)
329 int rsnd_io_is_working(struct rsnd_dai_stream *io);
332 char name[RSND_DAI_NAME_SIZE];
333 struct rsnd_dai_stream playback;
334 struct rsnd_dai_stream capture;
335 struct rsnd_priv *priv;
339 unsigned int clk_master:1;
340 unsigned int bit_clk_inv:1;
341 unsigned int frm_clk_inv:1;
342 unsigned int sys_delay:1;
343 unsigned int data_alignment:1;
346 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
347 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
348 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
349 #define for_each_rsnd_dai(rdai, priv, i) \
351 (i < rsnd_rdai_nr(priv)) && \
352 ((rdai) = rsnd_rdai_get(priv, i)); \
355 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
357 bool rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
358 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
359 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
360 int rsnd_dai_connect(struct rsnd_mod *mod,
361 struct rsnd_dai_stream *io,
362 enum rsnd_mod_type type);
363 #define rsnd_dai_of_node(priv) \
364 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,dai")
369 int rsnd_gen_probe(struct rsnd_priv *priv);
370 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
371 struct rsnd_mod *mod,
373 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
378 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
379 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
380 int rsnd_adg_probe(struct rsnd_priv *priv);
381 void rsnd_adg_remove(struct rsnd_priv *priv);
382 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
383 struct rsnd_dai_stream *io,
384 unsigned int src_rate,
385 unsigned int dst_rate);
386 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
387 struct rsnd_dai_stream *io);
388 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
389 struct rsnd_dai_stream *io);
396 struct platform_device *pdev;
399 #define RSND_GEN_MASK (0xF << 0)
400 #define RSND_GEN1 (1 << 0)
401 #define RSND_GEN2 (2 << 0)
404 * below value will be filled on rsnd_gen_probe()
409 * below value will be filled on rsnd_adg_probe()
414 * below value will be filled on rsnd_dma_probe()
419 * below value will be filled on rsnd_ssi_probe()
425 * below value will be filled on rsnd_ssiu_probe()
431 * below value will be filled on rsnd_src_probe()
437 * below value will be filled on rsnd_ctu_probe()
443 * below value will be filled on rsnd_mix_probe()
449 * below value will be filled on rsnd_dvc_probe()
455 * below value will be filled on rsnd_cmd_probe()
461 * below value will be filled on rsnd_dai_probe()
463 struct snd_soc_dai_driver *daidrv;
464 struct rsnd_dai *rdai;
468 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
469 #define rsnd_priv_to_dev(priv) (&(rsnd_priv_to_pdev(priv)->dev))
471 #define rsnd_is_gen1(priv) (((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
472 #define rsnd_is_gen2(priv) (((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
477 struct rsnd_kctrl_cfg {
481 const char * const *texts;
482 void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
483 struct rsnd_dai_stream *io;
484 struct snd_card *card;
485 struct snd_kcontrol *kctrl;
488 #define RSND_DVC_CHANNELS 8
489 struct rsnd_kctrl_cfg_m {
490 struct rsnd_kctrl_cfg cfg;
491 u32 val[RSND_DVC_CHANNELS];
494 struct rsnd_kctrl_cfg_s {
495 struct rsnd_kctrl_cfg cfg;
499 void _rsnd_kctrl_remove(struct rsnd_kctrl_cfg *cfg);
500 #define rsnd_kctrl_remove(_cfg) _rsnd_kctrl_remove(&((_cfg).cfg))
502 int rsnd_kctrl_new_m(struct rsnd_mod *mod,
503 struct rsnd_dai_stream *io,
504 struct snd_soc_pcm_runtime *rtd,
505 const unsigned char *name,
506 void (*update)(struct rsnd_dai_stream *io,
507 struct rsnd_mod *mod),
508 struct rsnd_kctrl_cfg_m *_cfg,
511 int rsnd_kctrl_new_s(struct rsnd_mod *mod,
512 struct rsnd_dai_stream *io,
513 struct snd_soc_pcm_runtime *rtd,
514 const unsigned char *name,
515 void (*update)(struct rsnd_dai_stream *io,
516 struct rsnd_mod *mod),
517 struct rsnd_kctrl_cfg_s *_cfg,
519 int rsnd_kctrl_new_e(struct rsnd_mod *mod,
520 struct rsnd_dai_stream *io,
521 struct snd_soc_pcm_runtime *rtd,
522 const unsigned char *name,
523 struct rsnd_kctrl_cfg_s *_cfg,
524 void (*update)(struct rsnd_dai_stream *io,
525 struct rsnd_mod *mod),
526 const char * const *texts,
532 int rsnd_ssi_probe(struct rsnd_priv *priv);
533 void rsnd_ssi_remove(struct rsnd_priv *priv);
534 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
535 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
536 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
538 #define rsnd_ssi_is_pin_sharing(io) \
539 __rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
540 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
542 #define rsnd_ssi_of_node(priv) \
543 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,ssi")
548 int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
549 struct rsnd_mod *mod);
550 int rsnd_ssiu_probe(struct rsnd_priv *priv);
551 void rsnd_ssiu_remove(struct rsnd_priv *priv);
556 int rsnd_src_probe(struct rsnd_priv *priv);
557 void rsnd_src_remove(struct rsnd_priv *priv);
558 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
559 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
560 struct rsnd_dai_stream *io,
561 struct snd_pcm_runtime *runtime);
562 #define rsnd_src_of_node(priv) \
563 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,src")
568 int rsnd_ctu_probe(struct rsnd_priv *priv);
569 void rsnd_ctu_remove(struct rsnd_priv *priv);
570 struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
571 #define rsnd_ctu_of_node(priv) \
572 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,ctu")
577 int rsnd_mix_probe(struct rsnd_priv *priv);
578 void rsnd_mix_remove(struct rsnd_priv *priv);
579 struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
580 #define rsnd_mix_of_node(priv) \
581 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,mix")
586 int rsnd_dvc_probe(struct rsnd_priv *priv);
587 void rsnd_dvc_remove(struct rsnd_priv *priv);
588 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
589 #define rsnd_dvc_of_node(priv) \
590 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,dvc")
595 int rsnd_cmd_probe(struct rsnd_priv *priv);
596 void rsnd_cmd_remove(struct rsnd_priv *priv);
597 int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
598 struct rsnd_mod *rsnd_cmd_mod_get(struct rsnd_priv *priv, int id);
601 void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
602 #define rsnd_mod_confirm_ssi(mssi) rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
603 #define rsnd_mod_confirm_src(msrc) rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
604 #define rsnd_mod_confirm_dvc(mdvc) rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
606 #define rsnd_mod_confirm_ssi(mssi)
607 #define rsnd_mod_confirm_src(msrc)
608 #define rsnd_mod_confirm_dvc(mdvc)