2 * Renesas R-Car SSIU/SSI support
4 * Copyright (C) 2013 Renesas Solutions Corp.
5 * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
8 * Kuninori Morimoto <morimoto.kuninori@renesas.com>
10 * This program is free software; you can redistribute it and/or modify
11 * it under the terms of the GNU General Public License version 2 as
12 * published by the Free Software Foundation.
14 #include <linux/delay.h>
16 #define RSND_SSI_NAME_SIZE 16
21 #define FORCE (1 << 31) /* Fixed */
22 #define DMEN (1 << 28) /* DMA Enable */
23 #define UIEN (1 << 27) /* Underflow Interrupt Enable */
24 #define OIEN (1 << 26) /* Overflow Interrupt Enable */
25 #define IIEN (1 << 25) /* Idle Mode Interrupt Enable */
26 #define DIEN (1 << 24) /* Data Interrupt Enable */
27 #define CHNL_4 (1 << 22) /* Channels */
28 #define CHNL_6 (2 << 22) /* Channels */
29 #define CHNL_8 (3 << 22) /* Channels */
30 #define DWL_8 (0 << 19) /* Data Word Length */
31 #define DWL_16 (1 << 19) /* Data Word Length */
32 #define DWL_18 (2 << 19) /* Data Word Length */
33 #define DWL_20 (3 << 19) /* Data Word Length */
34 #define DWL_22 (4 << 19) /* Data Word Length */
35 #define DWL_24 (5 << 19) /* Data Word Length */
36 #define DWL_32 (6 << 19) /* Data Word Length */
38 #define SWL_32 (3 << 16) /* R/W System Word Length */
39 #define SCKD (1 << 15) /* Serial Bit Clock Direction */
40 #define SWSD (1 << 14) /* Serial WS Direction */
41 #define SCKP (1 << 13) /* Serial Bit Clock Polarity */
42 #define SWSP (1 << 12) /* Serial WS Polarity */
43 #define SDTA (1 << 10) /* Serial Data Alignment */
44 #define PDTA (1 << 9) /* Parallel Data Alignment */
45 #define DEL (1 << 8) /* Serial Data Delay */
46 #define CKDV(v) (v << 4) /* Serial Clock Division Ratio */
47 #define TRMD (1 << 1) /* Transmit/Receive Mode Select */
48 #define EN (1 << 0) /* SSI Module Enable */
53 #define UIRQ (1 << 27) /* Underflow Error Interrupt Status */
54 #define OIRQ (1 << 26) /* Overflow Error Interrupt Status */
55 #define IIRQ (1 << 25) /* Idle Mode Interrupt Status */
56 #define DIRQ (1 << 24) /* Data Interrupt Status Flag */
61 #define CONT (1 << 8) /* WS Continue Function */
62 #define WS_MODE (1 << 0) /* WS Mode */
64 #define SSI_NAME "ssi"
67 struct rsnd_ssi *parent;
84 #define RSND_SSI_CLK_PIN_SHARE (1 << 0)
85 #define RSND_SSI_NO_BUSIF (1 << 1) /* SSI+DMA without BUSIF */
87 #define for_each_rsnd_ssi(pos, priv, i) \
89 (i < rsnd_ssi_nr(priv)) && \
90 ((pos) = ((struct rsnd_ssi *)(priv)->ssi + i)); \
93 #define rsnd_ssi_get(priv, id) ((struct rsnd_ssi *)(priv->ssi) + id)
94 #define rsnd_ssi_to_dma(mod) ((ssi)->dma)
95 #define rsnd_ssi_nr(priv) ((priv)->ssi_nr)
96 #define rsnd_mod_to_ssi(_mod) container_of((_mod), struct rsnd_ssi, mod)
97 #define rsnd_ssi_mode_flags(p) ((p)->flags)
98 #define rsnd_ssi_is_parent(ssi, io) ((ssi) == rsnd_io_to_mod_ssip(io))
99 #define rsnd_ssi_is_multi_slave(ssi, io) ((mod) != rsnd_io_to_mod_ssi(io))
101 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io)
103 struct rsnd_mod *mod = rsnd_io_to_mod_ssi(io);
104 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
107 if (!rsnd_ssi_is_dma_mode(mod))
110 if (!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_NO_BUSIF))
112 if (rsnd_io_to_mod_src(io))
118 static void rsnd_ssi_status_clear(struct rsnd_mod *mod)
120 rsnd_mod_write(mod, SSISR, 0);
123 static u32 rsnd_ssi_status_get(struct rsnd_mod *mod)
125 return rsnd_mod_read(mod, SSISR);
128 static void rsnd_ssi_status_check(struct rsnd_mod *mod,
131 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
132 struct device *dev = rsnd_priv_to_dev(priv);
136 for (i = 0; i < 1024; i++) {
137 status = rsnd_ssi_status_get(mod);
144 dev_warn(dev, "status check failed\n");
147 static int rsnd_ssi_irq_enable(struct rsnd_mod *ssi_mod)
149 struct rsnd_priv *priv = rsnd_mod_to_priv(ssi_mod);
151 if (rsnd_is_gen1(priv))
154 /* enable SSI interrupt if Gen2 */
155 rsnd_mod_write(ssi_mod, SSI_INT_ENABLE,
156 rsnd_ssi_is_dma_mode(ssi_mod) ?
157 0x0e000000 : 0x0f000000);
162 static int rsnd_ssi_irq_disable(struct rsnd_mod *ssi_mod)
164 struct rsnd_priv *priv = rsnd_mod_to_priv(ssi_mod);
166 if (rsnd_is_gen1(priv))
169 /* disable SSI interrupt if Gen2 */
170 rsnd_mod_write(ssi_mod, SSI_INT_ENABLE, 0x00000000);
175 u32 rsnd_ssi_multi_slaves(struct rsnd_dai_stream *io)
177 struct rsnd_mod *mod;
178 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
179 struct rsnd_priv *priv = rsnd_io_to_priv(io);
180 struct device *dev = rsnd_priv_to_dev(priv);
181 enum rsnd_mod_type types[] = {
188 switch (runtime->channels) {
189 case 2: /* Multi channel is not needed for Stereo */
194 dev_err(dev, "unsupported channel\n");
199 for (i = 0; i < ARRAY_SIZE(types); i++) {
200 mod = rsnd_io_to_mod(io, types[i]);
204 mask |= 1 << rsnd_mod_id(mod);
210 static int rsnd_ssi_master_clk_start(struct rsnd_ssi *ssi,
211 struct rsnd_dai_stream *io)
213 struct rsnd_priv *priv = rsnd_io_to_priv(io);
214 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
215 struct device *dev = rsnd_priv_to_dev(priv);
216 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
217 struct rsnd_mod *mod = rsnd_mod_get(ssi);
218 struct rsnd_mod *ssi_parent_mod = rsnd_io_to_mod_ssip(io);
219 int slots = rsnd_get_slot_width(io);
221 int ssi_clk_mul_table[] = {
222 1, 2, 4, 8, 16, 6, 12,
224 unsigned int main_rate;
225 unsigned int rate = rsnd_src_get_ssi_rate(priv, io, runtime);
227 if (!rsnd_rdai_is_clk_master(rdai))
230 if (ssi_parent_mod && !rsnd_ssi_is_parent(mod, io))
233 if (rsnd_ssi_is_multi_slave(mod, io))
236 if (ssi->usrcnt > 1) {
237 if (ssi->rate != rate) {
238 dev_err(dev, "SSI parent/child should use same rate\n");
246 * Find best clock, and try to start ADG
248 for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
251 * this driver is assuming that
252 * system word is 32bit x slots
253 * see rsnd_ssi_init()
255 main_rate = rate * 32 * slots * ssi_clk_mul_table[j];
257 ret = rsnd_adg_ssi_clk_try_start(mod, main_rate);
259 ssi->cr_clk = FORCE | SWL_32 |
260 SCKD | SWSD | CKDV(j);
265 dev_dbg(dev, "%s[%d] outputs %u Hz\n",
267 rsnd_mod_id(mod), rate);
273 dev_err(dev, "unsupported clock rate\n");
277 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi *ssi,
278 struct rsnd_dai_stream *io)
280 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
281 struct rsnd_mod *mod = rsnd_mod_get(ssi);
282 struct rsnd_mod *ssi_parent_mod = rsnd_io_to_mod_ssip(io);
284 if (!rsnd_rdai_is_clk_master(rdai))
287 if (ssi_parent_mod && !rsnd_ssi_is_parent(mod, io))
296 rsnd_adg_ssi_clk_stop(mod);
299 static int rsnd_ssi_config_init(struct rsnd_ssi *ssi,
300 struct rsnd_dai_stream *io)
302 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
303 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
309 is_tdm = (rsnd_get_slot_width(io) >= 6) ? 1 : 0;
312 * always use 32bit system word.
313 * see also rsnd_ssi_master_clk_enable()
315 cr_own = FORCE | SWL_32 | PDTA;
317 if (rdai->bit_clk_inv)
319 if (rdai->frm_clk_inv ^ is_tdm)
321 if (rdai->data_alignment)
325 if (rsnd_io_is_play(io))
328 switch (runtime->sample_bits) {
339 if (rsnd_ssi_is_dma_mode(rsnd_mod_get(ssi))) {
340 cr_mode = UIEN | OIEN | /* over/under run */
341 DMEN; /* DMA : enable DMA */
343 cr_mode = DIEN; /* PIO : enable Data interrupt */
349 * rsnd_ssiu_init_gen2()
357 ssi->cr_own = cr_own;
358 ssi->cr_mode = cr_mode;
365 * SSI mod common functions
367 static int rsnd_ssi_init(struct rsnd_mod *mod,
368 struct rsnd_dai_stream *io,
369 struct rsnd_priv *priv)
371 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
376 rsnd_mod_power_on(mod);
378 ret = rsnd_ssi_master_clk_start(ssi, io);
382 if (rsnd_ssi_is_parent(mod, io))
385 ret = rsnd_ssi_config_init(ssi, io);
389 ssi->err = -1; /* ignore 1st error */
391 /* clear error status */
392 rsnd_ssi_status_clear(mod);
394 rsnd_ssi_irq_enable(mod);
399 static int rsnd_ssi_quit(struct rsnd_mod *mod,
400 struct rsnd_dai_stream *io,
401 struct rsnd_priv *priv)
403 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
404 struct device *dev = rsnd_priv_to_dev(priv);
407 dev_err(dev, "%s[%d] usrcnt error\n",
408 rsnd_mod_name(mod), rsnd_mod_id(mod));
412 if (!rsnd_ssi_is_parent(mod, io)) {
414 dev_warn(dev, "%s[%d] under/over flow err = %d\n",
415 rsnd_mod_name(mod), rsnd_mod_id(mod),
421 rsnd_ssi_irq_disable(mod);
424 rsnd_ssi_master_clk_stop(ssi, io);
426 rsnd_mod_power_off(mod);
433 static int rsnd_ssi_hw_params(struct rsnd_mod *mod,
434 struct rsnd_dai_stream *io,
435 struct snd_pcm_substream *substream,
436 struct snd_pcm_hw_params *params)
438 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
439 int chan = params_channels(params);
443 * It will happen if SSI has parent/child connection.
445 if (ssi->usrcnt > 1) {
447 * it is error if child <-> parent SSI uses
448 * different channels.
450 if (ssi->chan != chan)
459 static u32 rsnd_ssi_record_error(struct rsnd_ssi *ssi)
461 struct rsnd_mod *mod = rsnd_mod_get(ssi);
462 u32 status = rsnd_ssi_status_get(mod);
464 /* under/over flow error */
465 if (status & (UIRQ | OIRQ))
471 static int __rsnd_ssi_start(struct rsnd_mod *mod,
472 struct rsnd_dai_stream *io,
473 struct rsnd_priv *priv)
475 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
483 * EN will be set via SSIU :: SSI_CONTROL
484 * if Multi channel mode
486 if (!rsnd_ssi_multi_slaves(io))
489 rsnd_mod_write(mod, SSICR, cr);
490 rsnd_mod_write(mod, SSIWSR, ssi->wsr);
495 static int rsnd_ssi_start(struct rsnd_mod *mod,
496 struct rsnd_dai_stream *io,
497 struct rsnd_priv *priv)
505 return __rsnd_ssi_start(mod, io, priv);
508 static int __rsnd_ssi_stop(struct rsnd_mod *mod,
509 struct rsnd_dai_stream *io,
510 struct rsnd_priv *priv)
512 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
517 * and, wait all data was sent
522 rsnd_mod_write(mod, SSICR, cr | EN);
523 rsnd_ssi_status_check(mod, DIRQ);
527 * and, wait idle state
529 rsnd_mod_write(mod, SSICR, cr); /* disabled all */
530 rsnd_ssi_status_check(mod, IIRQ);
535 static int rsnd_ssi_stop(struct rsnd_mod *mod,
536 struct rsnd_dai_stream *io,
537 struct rsnd_priv *priv)
539 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
542 * don't stop if not last user
550 return __rsnd_ssi_stop(mod, io, priv);
553 static void __rsnd_ssi_interrupt(struct rsnd_mod *mod,
554 struct rsnd_dai_stream *io)
556 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
557 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
558 struct device *dev = rsnd_priv_to_dev(priv);
559 int is_dma = rsnd_ssi_is_dma_mode(mod);
561 bool elapsed = false;
563 spin_lock(&priv->lock);
565 /* ignore all cases if not working */
566 if (!rsnd_io_is_working(io))
567 goto rsnd_ssi_interrupt_out;
569 status = rsnd_ssi_record_error(ssi);
572 if (!is_dma && (status & DIRQ)) {
573 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
574 u32 *buf = (u32 *)(runtime->dma_area +
575 rsnd_dai_pointer_offset(io, 0));
578 * 8/16/32 data can be assesse to TDR/RDR register
579 * directly as 32bit data
580 * see rsnd_ssi_init()
582 if (rsnd_io_is_play(io))
583 rsnd_mod_write(mod, SSITDR, *buf);
585 *buf = rsnd_mod_read(mod, SSIRDR);
587 elapsed = rsnd_dai_pointer_update(io, sizeof(*buf));
591 if (is_dma && (status & (UIRQ | OIRQ))) {
595 dev_dbg(dev, "%s[%d] restart\n",
596 rsnd_mod_name(mod), rsnd_mod_id(mod));
598 __rsnd_ssi_stop(mod, io, priv);
599 __rsnd_ssi_start(mod, io, priv);
602 if (ssi->err > 1024) {
603 rsnd_ssi_irq_disable(mod);
605 dev_warn(dev, "no more %s[%d] restart\n",
606 rsnd_mod_name(mod), rsnd_mod_id(mod));
609 rsnd_ssi_status_clear(mod);
610 rsnd_ssi_interrupt_out:
611 spin_unlock(&priv->lock);
614 rsnd_dai_period_elapsed(io);
617 static irqreturn_t rsnd_ssi_interrupt(int irq, void *data)
619 struct rsnd_mod *mod = data;
621 rsnd_mod_interrupt(mod, __rsnd_ssi_interrupt);
629 static void rsnd_ssi_parent_attach(struct rsnd_mod *mod,
630 struct rsnd_dai_stream *io,
631 struct rsnd_priv *priv)
633 if (!__rsnd_ssi_is_pin_sharing(mod))
636 switch (rsnd_mod_id(mod)) {
639 rsnd_dai_connect(rsnd_ssi_mod_get(priv, 0), io, RSND_MOD_SSIP);
642 rsnd_dai_connect(rsnd_ssi_mod_get(priv, 3), io, RSND_MOD_SSIP);
645 rsnd_dai_connect(rsnd_ssi_mod_get(priv, 7), io, RSND_MOD_SSIP);
650 static int rsnd_ssi_common_probe(struct rsnd_mod *mod,
651 struct rsnd_dai_stream *io,
652 struct rsnd_priv *priv)
654 struct device *dev = rsnd_priv_to_dev(priv);
655 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
659 * SSIP/SSIU/IRQ are not needed on
662 if (rsnd_ssi_is_multi_slave(mod, io))
665 rsnd_ssi_parent_attach(mod, io, priv);
667 ret = rsnd_ssiu_attach(io, mod);
671 ret = devm_request_irq(dev, ssi->irq,
679 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
681 .probe = rsnd_ssi_common_probe,
682 .init = rsnd_ssi_init,
683 .quit = rsnd_ssi_quit,
684 .start = rsnd_ssi_start,
685 .stop = rsnd_ssi_stop,
686 .hw_params = rsnd_ssi_hw_params,
689 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
690 struct rsnd_dai_stream *io,
691 struct rsnd_priv *priv)
693 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
694 int dma_id = 0; /* not needed */
698 * SSIP/SSIU/IRQ/DMA are not needed on
701 if (rsnd_ssi_is_multi_slave(mod, io))
704 ret = rsnd_ssi_common_probe(mod, io, priv);
708 ssi->dma = rsnd_dma_attach(io, mod, dma_id);
709 if (IS_ERR(ssi->dma))
710 return PTR_ERR(ssi->dma);
715 static int rsnd_ssi_dma_remove(struct rsnd_mod *mod,
716 struct rsnd_dai_stream *io,
717 struct rsnd_priv *priv)
719 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
720 struct device *dev = rsnd_priv_to_dev(priv);
723 /* PIO will request IRQ again */
724 devm_free_irq(dev, irq, mod);
729 static int rsnd_ssi_fallback(struct rsnd_mod *mod,
730 struct rsnd_dai_stream *io,
731 struct rsnd_priv *priv)
733 struct device *dev = rsnd_priv_to_dev(priv);
738 * SSI .probe might be called again.
740 * rsnd_rdai_continuance_probe()
742 mod->ops = &rsnd_ssi_pio_ops;
744 dev_info(dev, "%s[%d] fallback to PIO mode\n",
745 rsnd_mod_name(mod), rsnd_mod_id(mod));
750 static struct dma_chan *rsnd_ssi_dma_req(struct rsnd_dai_stream *io,
751 struct rsnd_mod *mod)
753 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
754 int is_play = rsnd_io_is_play(io);
757 if (rsnd_ssi_use_busif(io))
758 name = is_play ? "rxu" : "txu";
760 name = is_play ? "rx" : "tx";
762 return rsnd_dma_request_channel(rsnd_ssi_of_node(priv),
766 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
768 .dma_req = rsnd_ssi_dma_req,
769 .probe = rsnd_ssi_dma_probe,
770 .remove = rsnd_ssi_dma_remove,
771 .init = rsnd_ssi_init,
772 .quit = rsnd_ssi_quit,
773 .start = rsnd_ssi_start,
774 .stop = rsnd_ssi_stop,
775 .fallback = rsnd_ssi_fallback,
776 .hw_params = rsnd_ssi_hw_params,
779 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod)
781 return mod->ops == &rsnd_ssi_dma_ops;
788 static struct rsnd_mod_ops rsnd_ssi_non_ops = {
795 static void rsnd_ssi_connect(struct rsnd_mod *mod,
796 struct rsnd_dai_stream *io)
798 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
799 enum rsnd_mod_type types[] = {
805 enum rsnd_mod_type type;
808 /* try SSI -> SSIM1 -> SSIM2 -> SSIM3 */
809 for (i = 0; i < ARRAY_SIZE(types); i++) {
811 if (!rsnd_io_to_mod(io, type)) {
812 rsnd_dai_connect(mod, io, type);
813 rsnd_set_slot(rdai, 2 * (i + 1), (i + 1));
819 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
820 struct device_node *playback,
821 struct device_node *capture)
823 struct rsnd_priv *priv = rsnd_rdai_to_priv(rdai);
824 struct device_node *node;
825 struct device_node *np;
826 struct rsnd_mod *mod;
829 node = rsnd_ssi_of_node(priv);
834 for_each_child_of_node(node, np) {
835 mod = rsnd_ssi_mod_get(priv, i);
837 rsnd_ssi_connect(mod, &rdai->playback);
839 rsnd_ssi_connect(mod, &rdai->capture);
846 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
848 if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
851 return rsnd_mod_get(rsnd_ssi_get(priv, id));
854 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
856 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
858 return !!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_CLK_PIN_SHARE);
861 int rsnd_ssi_probe(struct rsnd_priv *priv)
863 struct device_node *node;
864 struct device_node *np;
865 struct device *dev = rsnd_priv_to_dev(priv);
866 struct rsnd_mod_ops *ops;
868 struct rsnd_ssi *ssi;
869 char name[RSND_SSI_NAME_SIZE];
872 node = rsnd_ssi_of_node(priv);
876 nr = of_get_child_count(node);
879 goto rsnd_ssi_probe_done;
882 ssi = devm_kzalloc(dev, sizeof(*ssi) * nr, GFP_KERNEL);
885 goto rsnd_ssi_probe_done;
892 for_each_child_of_node(node, np) {
893 ssi = rsnd_ssi_get(priv, i);
895 snprintf(name, RSND_SSI_NAME_SIZE, "%s.%d",
898 clk = devm_clk_get(dev, name);
901 goto rsnd_ssi_probe_done;
904 if (of_get_property(np, "shared-pin", NULL))
905 ssi->flags |= RSND_SSI_CLK_PIN_SHARE;
907 if (of_get_property(np, "no-busif", NULL))
908 ssi->flags |= RSND_SSI_NO_BUSIF;
910 ssi->irq = irq_of_parse_and_map(np, 0);
913 goto rsnd_ssi_probe_done;
916 ops = &rsnd_ssi_non_ops;
917 if (of_get_property(np, "pio-transfer", NULL))
918 ops = &rsnd_ssi_pio_ops;
920 ops = &rsnd_ssi_dma_ops;
922 ret = rsnd_mod_init(priv, rsnd_mod_get(ssi), ops, clk,
925 goto rsnd_ssi_probe_done;
938 void rsnd_ssi_remove(struct rsnd_priv *priv)
940 struct rsnd_ssi *ssi;
943 for_each_rsnd_ssi(ssi, priv, i) {
944 rsnd_mod_quit(rsnd_mod_get(ssi));