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"
82 #define RSND_SSI_CLK_PIN_SHARE (1 << 0)
83 #define RSND_SSI_NO_BUSIF (1 << 1) /* SSI+DMA without BUSIF */
85 #define for_each_rsnd_ssi(pos, priv, i) \
87 (i < rsnd_ssi_nr(priv)) && \
88 ((pos) = ((struct rsnd_ssi *)(priv)->ssi + i)); \
91 #define rsnd_ssi_get(priv, id) ((struct rsnd_ssi *)(priv->ssi) + id)
92 #define rsnd_ssi_to_dma(mod) ((ssi)->dma)
93 #define rsnd_ssi_nr(priv) ((priv)->ssi_nr)
94 #define rsnd_mod_to_ssi(_mod) container_of((_mod), struct rsnd_ssi, mod)
95 #define rsnd_ssi_mode_flags(p) ((p)->flags)
96 #define rsnd_ssi_is_parent(ssi, io) ((ssi) == rsnd_io_to_mod_ssip(io))
97 #define rsnd_ssi_is_multi_slave(mod, io) \
98 (rsnd_ssi_multi_slaves(io) & (1 << rsnd_mod_id(mod)))
100 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io)
102 struct rsnd_mod *mod = rsnd_io_to_mod_ssi(io);
103 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
106 if (!rsnd_ssi_is_dma_mode(mod))
109 if (!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_NO_BUSIF))
111 if (rsnd_io_to_mod_src(io))
117 static void rsnd_ssi_status_clear(struct rsnd_mod *mod)
119 rsnd_mod_write(mod, SSISR, 0);
122 static u32 rsnd_ssi_status_get(struct rsnd_mod *mod)
124 return rsnd_mod_read(mod, SSISR);
127 static void rsnd_ssi_status_check(struct rsnd_mod *mod,
130 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
131 struct device *dev = rsnd_priv_to_dev(priv);
135 for (i = 0; i < 1024; i++) {
136 status = rsnd_ssi_status_get(mod);
143 dev_warn(dev, "status check failed\n");
146 static int rsnd_ssi_irq(struct rsnd_mod *mod,
147 struct rsnd_dai_stream *io,
148 struct rsnd_priv *priv,
151 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
154 if (rsnd_is_gen1(priv))
157 if (ssi->usrcnt != 1)
161 val = rsnd_ssi_is_dma_mode(mod) ? 0x0e000000 : 0x0f000000;
163 rsnd_mod_write(mod, SSI_INT_ENABLE, val);
168 u32 rsnd_ssi_multi_slaves(struct rsnd_dai_stream *io)
170 struct rsnd_mod *mod;
171 enum rsnd_mod_type types[] = {
179 for (i = 0; i < ARRAY_SIZE(types); i++) {
180 mod = rsnd_io_to_mod(io, types[i]);
184 mask |= 1 << rsnd_mod_id(mod);
190 static int rsnd_ssi_master_clk_start(struct rsnd_ssi *ssi,
191 struct rsnd_dai_stream *io)
193 struct rsnd_priv *priv = rsnd_io_to_priv(io);
194 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
195 struct device *dev = rsnd_priv_to_dev(priv);
196 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
197 struct rsnd_mod *mod = rsnd_mod_get(ssi);
198 struct rsnd_mod *ssi_parent_mod = rsnd_io_to_mod_ssip(io);
199 int slots = rsnd_get_slot_width(io);
201 int ssi_clk_mul_table[] = {
202 1, 2, 4, 8, 16, 6, 12,
204 unsigned int main_rate;
205 unsigned int rate = rsnd_src_get_ssi_rate(priv, io, runtime);
207 if (!rsnd_rdai_is_clk_master(rdai))
210 if (ssi_parent_mod && !rsnd_ssi_is_parent(mod, io))
213 if (rsnd_ssi_is_multi_slave(mod, io))
216 if (ssi->usrcnt > 1) {
217 if (ssi->rate != rate) {
218 dev_err(dev, "SSI parent/child should use same rate\n");
226 * Find best clock, and try to start ADG
228 for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
231 * this driver is assuming that
232 * system word is 32bit x slots
233 * see rsnd_ssi_init()
235 main_rate = rate * 32 * slots * ssi_clk_mul_table[j];
237 ret = rsnd_adg_ssi_clk_try_start(mod, main_rate);
239 ssi->cr_clk = FORCE | SWL_32 |
240 SCKD | SWSD | CKDV(j);
245 dev_dbg(dev, "%s[%d] outputs %u Hz\n",
247 rsnd_mod_id(mod), rate);
253 dev_err(dev, "unsupported clock rate\n");
257 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi *ssi,
258 struct rsnd_dai_stream *io)
260 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
261 struct rsnd_mod *mod = rsnd_mod_get(ssi);
262 struct rsnd_mod *ssi_parent_mod = rsnd_io_to_mod_ssip(io);
264 if (!rsnd_rdai_is_clk_master(rdai))
267 if (ssi_parent_mod && !rsnd_ssi_is_parent(mod, io))
276 rsnd_adg_ssi_clk_stop(mod);
279 static int rsnd_ssi_config_init(struct rsnd_ssi *ssi,
280 struct rsnd_dai_stream *io)
282 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
283 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
289 is_tdm = (rsnd_get_slot_width(io) >= 6) ? 1 : 0;
292 * always use 32bit system word.
293 * see also rsnd_ssi_master_clk_enable()
295 cr_own = FORCE | SWL_32 | PDTA;
297 if (rdai->bit_clk_inv)
299 if (rdai->frm_clk_inv ^ is_tdm)
301 if (rdai->data_alignment)
305 if (rsnd_io_is_play(io))
308 switch (runtime->sample_bits) {
319 if (rsnd_ssi_is_dma_mode(rsnd_mod_get(ssi))) {
320 cr_mode = UIEN | OIEN | /* over/under run */
321 DMEN; /* DMA : enable DMA */
323 cr_mode = DIEN; /* PIO : enable Data interrupt */
329 * rsnd_ssiu_init_gen2()
337 ssi->cr_own = cr_own;
338 ssi->cr_mode = cr_mode;
345 * SSI mod common functions
347 static int rsnd_ssi_init(struct rsnd_mod *mod,
348 struct rsnd_dai_stream *io,
349 struct rsnd_priv *priv)
351 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
356 rsnd_mod_power_on(mod);
358 ret = rsnd_ssi_master_clk_start(ssi, io);
362 if (rsnd_ssi_is_parent(mod, io))
365 ret = rsnd_ssi_config_init(ssi, io);
369 /* clear error status */
370 rsnd_ssi_status_clear(mod);
375 static int rsnd_ssi_quit(struct rsnd_mod *mod,
376 struct rsnd_dai_stream *io,
377 struct rsnd_priv *priv)
379 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
380 struct device *dev = rsnd_priv_to_dev(priv);
383 dev_err(dev, "%s[%d] usrcnt error\n",
384 rsnd_mod_name(mod), rsnd_mod_id(mod));
388 if (!rsnd_ssi_is_parent(mod, io))
391 rsnd_ssi_master_clk_stop(ssi, io);
393 rsnd_mod_power_off(mod);
400 static int rsnd_ssi_hw_params(struct rsnd_mod *mod,
401 struct rsnd_dai_stream *io,
402 struct snd_pcm_substream *substream,
403 struct snd_pcm_hw_params *params)
405 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
406 int chan = params_channels(params);
410 * It will happen if SSI has parent/child connection.
412 if (ssi->usrcnt > 1) {
414 * it is error if child <-> parent SSI uses
415 * different channels.
417 if (ssi->chan != chan)
426 static int rsnd_ssi_start(struct rsnd_mod *mod,
427 struct rsnd_dai_stream *io,
428 struct rsnd_priv *priv)
430 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
438 * EN will be set via SSIU :: SSI_CONTROL
439 * if Multi channel mode
441 if (!rsnd_ssi_multi_slaves(io))
444 rsnd_mod_write(mod, SSICR, cr);
445 rsnd_mod_write(mod, SSIWSR, ssi->wsr);
450 static int rsnd_ssi_stop(struct rsnd_mod *mod,
451 struct rsnd_dai_stream *io,
452 struct rsnd_priv *priv)
454 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
458 * don't stop if not last user
468 * and, wait all data was sent
473 rsnd_mod_write(mod, SSICR, cr | EN);
474 rsnd_ssi_status_check(mod, DIRQ);
478 * and, wait idle state
480 rsnd_mod_write(mod, SSICR, cr); /* disabled all */
481 rsnd_ssi_status_check(mod, IIRQ);
486 static void __rsnd_ssi_interrupt(struct rsnd_mod *mod,
487 struct rsnd_dai_stream *io)
489 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
490 int is_dma = rsnd_ssi_is_dma_mode(mod);
492 bool elapsed = false;
495 spin_lock(&priv->lock);
497 /* ignore all cases if not working */
498 if (!rsnd_io_is_working(io))
499 goto rsnd_ssi_interrupt_out;
501 status = rsnd_ssi_status_get(mod);
504 if (!is_dma && (status & DIRQ)) {
505 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
506 u32 *buf = (u32 *)(runtime->dma_area +
507 rsnd_dai_pointer_offset(io, 0));
510 * 8/16/32 data can be assesse to TDR/RDR register
511 * directly as 32bit data
512 * see rsnd_ssi_init()
514 if (rsnd_io_is_play(io))
515 rsnd_mod_write(mod, SSITDR, *buf);
517 *buf = rsnd_mod_read(mod, SSIRDR);
519 elapsed = rsnd_dai_pointer_update(io, sizeof(*buf));
523 if (is_dma && (status & (UIRQ | OIRQ)))
526 rsnd_ssi_status_clear(mod);
527 rsnd_ssi_interrupt_out:
528 spin_unlock(&priv->lock);
531 rsnd_dai_period_elapsed(io);
534 snd_pcm_stop_xrun(io->substream);
538 static irqreturn_t rsnd_ssi_interrupt(int irq, void *data)
540 struct rsnd_mod *mod = data;
542 rsnd_mod_interrupt(mod, __rsnd_ssi_interrupt);
550 static void rsnd_ssi_parent_attach(struct rsnd_mod *mod,
551 struct rsnd_dai_stream *io,
552 struct rsnd_priv *priv)
554 if (!__rsnd_ssi_is_pin_sharing(mod))
557 switch (rsnd_mod_id(mod)) {
560 rsnd_dai_connect(rsnd_ssi_mod_get(priv, 0), io, RSND_MOD_SSIP);
563 rsnd_dai_connect(rsnd_ssi_mod_get(priv, 3), io, RSND_MOD_SSIP);
566 rsnd_dai_connect(rsnd_ssi_mod_get(priv, 7), io, RSND_MOD_SSIP);
571 static int rsnd_ssi_common_probe(struct rsnd_mod *mod,
572 struct rsnd_dai_stream *io,
573 struct rsnd_priv *priv)
575 struct device *dev = rsnd_priv_to_dev(priv);
576 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
580 * SSIP/SSIU/IRQ are not needed on
583 if (rsnd_ssi_is_multi_slave(mod, io))
586 rsnd_ssi_parent_attach(mod, io, priv);
588 ret = rsnd_ssiu_attach(io, mod);
592 ret = devm_request_irq(dev, ssi->irq,
600 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
602 .probe = rsnd_ssi_common_probe,
603 .init = rsnd_ssi_init,
604 .quit = rsnd_ssi_quit,
605 .start = rsnd_ssi_start,
606 .stop = rsnd_ssi_stop,
608 .hw_params = rsnd_ssi_hw_params,
611 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
612 struct rsnd_dai_stream *io,
613 struct rsnd_priv *priv)
615 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
616 int dma_id = 0; /* not needed */
620 * SSIP/SSIU/IRQ/DMA are not needed on
623 if (rsnd_ssi_is_multi_slave(mod, io))
626 ret = rsnd_ssi_common_probe(mod, io, priv);
630 /* SSI probe might be called many times in MUX multi path */
631 ret = rsnd_dma_attach(io, mod, &ssi->dma, dma_id);
636 static int rsnd_ssi_dma_remove(struct rsnd_mod *mod,
637 struct rsnd_dai_stream *io,
638 struct rsnd_priv *priv)
640 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
641 struct device *dev = rsnd_priv_to_dev(priv);
644 /* PIO will request IRQ again */
645 devm_free_irq(dev, irq, mod);
650 static int rsnd_ssi_fallback(struct rsnd_mod *mod,
651 struct rsnd_dai_stream *io,
652 struct rsnd_priv *priv)
654 struct device *dev = rsnd_priv_to_dev(priv);
659 * SSI .probe might be called again.
661 * rsnd_rdai_continuance_probe()
663 mod->ops = &rsnd_ssi_pio_ops;
665 dev_info(dev, "%s[%d] fallback to PIO mode\n",
666 rsnd_mod_name(mod), rsnd_mod_id(mod));
671 static struct dma_chan *rsnd_ssi_dma_req(struct rsnd_dai_stream *io,
672 struct rsnd_mod *mod)
674 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
675 int is_play = rsnd_io_is_play(io);
678 if (rsnd_ssi_use_busif(io))
679 name = is_play ? "rxu" : "txu";
681 name = is_play ? "rx" : "tx";
683 return rsnd_dma_request_channel(rsnd_ssi_of_node(priv),
687 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
689 .dma_req = rsnd_ssi_dma_req,
690 .probe = rsnd_ssi_dma_probe,
691 .remove = rsnd_ssi_dma_remove,
692 .init = rsnd_ssi_init,
693 .quit = rsnd_ssi_quit,
694 .start = rsnd_ssi_start,
695 .stop = rsnd_ssi_stop,
696 .fallback = rsnd_ssi_fallback,
697 .hw_params = rsnd_ssi_hw_params,
700 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod)
702 return mod->ops == &rsnd_ssi_dma_ops;
709 static struct rsnd_mod_ops rsnd_ssi_non_ops = {
716 static void rsnd_ssi_connect(struct rsnd_mod *mod,
717 struct rsnd_dai_stream *io)
719 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
720 enum rsnd_mod_type types[] = {
726 enum rsnd_mod_type type;
729 /* try SSI -> SSIM1 -> SSIM2 -> SSIM3 */
730 for (i = 0; i < ARRAY_SIZE(types); i++) {
732 if (!rsnd_io_to_mod(io, type)) {
733 rsnd_dai_connect(mod, io, type);
734 rsnd_set_slot(rdai, 2 * (i + 1), (i + 1));
740 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
741 struct device_node *playback,
742 struct device_node *capture)
744 struct rsnd_priv *priv = rsnd_rdai_to_priv(rdai);
745 struct device_node *node;
746 struct device_node *np;
747 struct rsnd_mod *mod;
750 node = rsnd_ssi_of_node(priv);
755 for_each_child_of_node(node, np) {
756 mod = rsnd_ssi_mod_get(priv, i);
758 rsnd_ssi_connect(mod, &rdai->playback);
760 rsnd_ssi_connect(mod, &rdai->capture);
767 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
769 if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
772 return rsnd_mod_get(rsnd_ssi_get(priv, id));
775 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
777 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
779 return !!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_CLK_PIN_SHARE);
782 static u32 *rsnd_ssi_get_status(struct rsnd_dai_stream *io,
783 struct rsnd_mod *mod,
784 enum rsnd_mod_type type)
787 * SSIP (= SSI parent) needs to be special, otherwise,
788 * 2nd SSI might doesn't start. see also rsnd_mod_call()
790 * We can't include parent SSI status on SSI, because we don't know
791 * how many SSI requests parent SSI. Thus, it is localed on "io" now.
794 * Capture : SSI1 (needs SSI0)
796 * 1) start Capture -> SSI0/SSI1 are started.
797 * 2) start Playback -> SSI0 doesn't work, because it is already
798 * marked as "started" on 1)
800 * OTOH, using each mod's status is good for MUX case.
801 * It doesn't need to start in 2nd start
803 * IO-0: SRC0 -> CTU1 -+-> MUX -> DVC -> SSIU -> SSI0
805 * IO-1: SRC1 -> CTU2 -+
807 * 1) start IO-0 -> start SSI0
808 * 2) start IO-1 -> SSI0 doesn't need to start, because it is
809 * already started on 1)
811 if (type == RSND_MOD_SSIP)
812 return &io->parent_ssi_status;
814 return rsnd_mod_get_status(io, mod, type);
817 int rsnd_ssi_probe(struct rsnd_priv *priv)
819 struct device_node *node;
820 struct device_node *np;
821 struct device *dev = rsnd_priv_to_dev(priv);
822 struct rsnd_mod_ops *ops;
824 struct rsnd_ssi *ssi;
825 char name[RSND_SSI_NAME_SIZE];
828 node = rsnd_ssi_of_node(priv);
832 nr = of_get_child_count(node);
835 goto rsnd_ssi_probe_done;
838 ssi = devm_kzalloc(dev, sizeof(*ssi) * nr, GFP_KERNEL);
841 goto rsnd_ssi_probe_done;
848 for_each_child_of_node(node, np) {
849 ssi = rsnd_ssi_get(priv, i);
851 snprintf(name, RSND_SSI_NAME_SIZE, "%s.%d",
854 clk = devm_clk_get(dev, name);
857 goto rsnd_ssi_probe_done;
860 if (of_get_property(np, "shared-pin", NULL))
861 ssi->flags |= RSND_SSI_CLK_PIN_SHARE;
863 if (of_get_property(np, "no-busif", NULL))
864 ssi->flags |= RSND_SSI_NO_BUSIF;
866 ssi->irq = irq_of_parse_and_map(np, 0);
869 goto rsnd_ssi_probe_done;
872 ops = &rsnd_ssi_non_ops;
873 if (of_get_property(np, "pio-transfer", NULL))
874 ops = &rsnd_ssi_pio_ops;
876 ops = &rsnd_ssi_dma_ops;
878 ret = rsnd_mod_init(priv, rsnd_mod_get(ssi), ops, clk,
879 rsnd_ssi_get_status, RSND_MOD_SSI, i);
881 goto rsnd_ssi_probe_done;
894 void rsnd_ssi_remove(struct rsnd_priv *priv)
896 struct rsnd_ssi *ssi;
899 for_each_rsnd_ssi(ssi, priv, i) {
900 rsnd_mod_quit(rsnd_mod_get(ssi));