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 */
28 #define DWL_8 (0 << 19) /* Data Word Length */
29 #define DWL_16 (1 << 19) /* Data Word Length */
30 #define DWL_18 (2 << 19) /* Data Word Length */
31 #define DWL_20 (3 << 19) /* Data Word Length */
32 #define DWL_22 (4 << 19) /* Data Word Length */
33 #define DWL_24 (5 << 19) /* Data Word Length */
34 #define DWL_32 (6 << 19) /* Data Word Length */
36 #define SWL_32 (3 << 16) /* R/W System Word Length */
37 #define SCKD (1 << 15) /* Serial Bit Clock Direction */
38 #define SWSD (1 << 14) /* Serial WS Direction */
39 #define SCKP (1 << 13) /* Serial Bit Clock Polarity */
40 #define SWSP (1 << 12) /* Serial WS Polarity */
41 #define SDTA (1 << 10) /* Serial Data Alignment */
42 #define DEL (1 << 8) /* Serial Data Delay */
43 #define CKDV(v) (v << 4) /* Serial Clock Division Ratio */
44 #define TRMD (1 << 1) /* Transmit/Receive Mode Select */
45 #define EN (1 << 0) /* SSI Module Enable */
50 #define UIRQ (1 << 27) /* Underflow Error Interrupt Status */
51 #define OIRQ (1 << 26) /* Overflow Error Interrupt Status */
52 #define IIRQ (1 << 25) /* Idle Mode Interrupt Status */
53 #define DIRQ (1 << 24) /* Data Interrupt Status Flag */
58 #define CONT (1 << 8) /* WS Continue Function */
60 #define SSI_NAME "ssi"
63 struct rsnd_ssi_platform_info *info; /* rcar_snd.h */
64 struct rsnd_ssi *parent;
74 #define for_each_rsnd_ssi(pos, priv, i) \
76 (i < rsnd_ssi_nr(priv)) && \
77 ((pos) = ((struct rsnd_ssi *)(priv)->ssi + i)); \
80 #define rsnd_ssi_nr(priv) ((priv)->ssi_nr)
81 #define rsnd_mod_to_ssi(_mod) container_of((_mod), struct rsnd_ssi, mod)
82 #define rsnd_dma_to_ssi(dma) rsnd_mod_to_ssi(rsnd_dma_to_mod(dma))
83 #define rsnd_ssi_pio_available(ssi) ((ssi)->info->irq > 0)
84 #define rsnd_ssi_parent(ssi) ((ssi)->parent)
85 #define rsnd_ssi_mode_flags(p) ((p)->info->flags)
86 #define rsnd_ssi_dai_id(ssi) ((ssi)->info->dai_id)
87 #define rsnd_ssi_of_node(priv) \
88 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,ssi")
90 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io, struct rsnd_mod *mod)
92 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
95 if (!rsnd_ssi_is_dma_mode(mod))
98 if (!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_NO_BUSIF))
100 if (rsnd_io_to_mod_src(io))
106 static void rsnd_ssi_status_check(struct rsnd_mod *mod,
109 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
110 struct device *dev = rsnd_priv_to_dev(priv);
114 for (i = 0; i < 1024; i++) {
115 status = rsnd_mod_read(mod, SSISR);
122 dev_warn(dev, "status check failed\n");
125 static int rsnd_ssi_master_clk_start(struct rsnd_ssi *ssi,
126 struct rsnd_dai_stream *io)
128 struct rsnd_priv *priv = rsnd_io_to_priv(io);
129 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
130 struct device *dev = rsnd_priv_to_dev(priv);
132 int adg_clk_div_table[] = {
133 1, 6, /* see adg.c */
135 int ssi_clk_mul_table[] = {
136 1, 2, 4, 8, 16, 6, 12,
138 unsigned int main_rate;
139 unsigned int rate = rsnd_src_get_ssi_rate(priv, io, runtime);
142 * Find best clock, and try to start ADG
144 for (i = 0; i < ARRAY_SIZE(adg_clk_div_table); i++) {
145 for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
148 * this driver is assuming that
149 * system word is 64fs (= 2 x 32bit)
150 * see rsnd_ssi_init()
152 main_rate = rate / adg_clk_div_table[i]
153 * 32 * 2 * ssi_clk_mul_table[j];
155 ret = rsnd_adg_ssi_clk_try_start(&ssi->mod, main_rate);
157 ssi->cr_clk = FORCE | SWL_32 |
158 SCKD | SWSD | CKDV(j);
160 dev_dbg(dev, "%s[%d] outputs %u Hz\n",
161 rsnd_mod_name(&ssi->mod),
162 rsnd_mod_id(&ssi->mod), rate);
169 dev_err(dev, "unsupported clock rate\n");
173 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi *ssi)
176 rsnd_adg_ssi_clk_stop(&ssi->mod);
179 static void rsnd_ssi_hw_start(struct rsnd_ssi *ssi,
180 struct rsnd_dai_stream *io)
182 struct rsnd_priv *priv = rsnd_io_to_priv(io);
183 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
184 struct device *dev = rsnd_priv_to_dev(priv);
188 if (0 == ssi->usrcnt) {
189 rsnd_mod_hw_start(&ssi->mod);
191 if (rsnd_rdai_is_clk_master(rdai)) {
192 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
195 rsnd_ssi_hw_start(ssi_parent, io);
197 rsnd_ssi_master_clk_start(ssi, io);
201 if (rsnd_ssi_is_dma_mode(&ssi->mod)) {
202 cr_mode = UIEN | OIEN | /* over/under run */
203 DMEN; /* DMA : enable DMA */
205 cr_mode = DIEN; /* PIO : enable Data interrupt */
213 rsnd_mod_write(&ssi->mod, SSICR, cr);
215 /* enable WS continue */
216 if (rsnd_rdai_is_clk_master(rdai))
217 rsnd_mod_write(&ssi->mod, SSIWSR, CONT);
219 /* clear error status */
220 rsnd_mod_write(&ssi->mod, SSISR, 0);
224 dev_dbg(dev, "%s[%d] hw started\n",
225 rsnd_mod_name(&ssi->mod), rsnd_mod_id(&ssi->mod));
228 static void rsnd_ssi_hw_stop(struct rsnd_dai_stream *io, struct rsnd_ssi *ssi)
230 struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
231 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
232 struct device *dev = rsnd_priv_to_dev(priv);
235 if (0 == ssi->usrcnt) {
236 dev_err(dev, "%s called without starting\n", __func__);
242 if (0 == ssi->usrcnt) {
245 * and, wait all data was sent
250 rsnd_mod_write(&ssi->mod, SSICR, cr | EN);
251 rsnd_ssi_status_check(&ssi->mod, DIRQ);
255 * and, wait idle state
257 rsnd_mod_write(&ssi->mod, SSICR, cr); /* disabled all */
258 rsnd_ssi_status_check(&ssi->mod, IIRQ);
260 if (rsnd_rdai_is_clk_master(rdai)) {
261 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
264 rsnd_ssi_hw_stop(io, ssi_parent);
266 rsnd_ssi_master_clk_stop(ssi);
269 rsnd_mod_hw_stop(&ssi->mod);
274 dev_dbg(dev, "%s[%d] hw stopped\n",
275 rsnd_mod_name(&ssi->mod), rsnd_mod_id(&ssi->mod));
279 * SSI mod common functions
281 static int rsnd_ssi_init(struct rsnd_mod *mod,
282 struct rsnd_dai_stream *io,
283 struct rsnd_priv *priv)
285 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
286 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
287 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
293 * always use 32bit system word for easy clock calculation.
294 * see also rsnd_ssi_master_clk_enable()
299 * init clock settings for SSICR
301 switch (runtime->sample_bits) {
312 if (rdai->bit_clk_inv)
314 if (rdai->frm_clk_inv)
316 if (rdai->data_alignment)
320 if (rsnd_io_is_play(io))
327 ssi->err = -1; /* ignore 1st error */
332 static int rsnd_ssi_quit(struct rsnd_mod *mod,
333 struct rsnd_dai_stream *io,
334 struct rsnd_priv *priv)
336 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
337 struct device *dev = rsnd_priv_to_dev(priv);
340 dev_warn(dev, "%s[%d] under/over flow err = %d\n",
341 rsnd_mod_name(mod), rsnd_mod_id(mod), ssi->err);
349 static int rsnd_ssi_hw_params(struct rsnd_mod *mod,
350 struct rsnd_dai_stream *io,
351 struct snd_pcm_substream *substream,
352 struct snd_pcm_hw_params *params)
354 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
355 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
356 int chan = params_channels(params);
360 * It will happen if SSI has parent/child connection.
364 * it is error if child <-> parent SSI uses
365 * different channels.
367 if (ssi->chan != chan)
371 /* It will be removed on rsnd_ssi_hw_stop */
374 return rsnd_ssi_hw_params(&ssi_parent->mod, io,
380 static void rsnd_ssi_record_error(struct rsnd_ssi *ssi, u32 status)
382 /* under/over flow error */
383 if (status & (UIRQ | OIRQ)) {
386 /* clear error status */
387 rsnd_mod_write(&ssi->mod, SSISR, 0);
391 static int rsnd_ssi_start(struct rsnd_mod *mod,
392 struct rsnd_dai_stream *io,
393 struct rsnd_priv *priv)
395 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
397 rsnd_src_ssiu_start(mod, io, rsnd_ssi_use_busif(io, mod));
399 rsnd_ssi_hw_start(ssi, io);
401 rsnd_src_ssi_irq_enable(mod);
406 static int rsnd_ssi_stop(struct rsnd_mod *mod,
407 struct rsnd_dai_stream *io,
408 struct rsnd_priv *priv)
410 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
412 rsnd_src_ssi_irq_disable(mod);
414 rsnd_ssi_record_error(ssi, rsnd_mod_read(mod, SSISR));
416 rsnd_ssi_hw_stop(io, ssi);
418 rsnd_src_ssiu_stop(mod, io);
423 static void __rsnd_ssi_interrupt(struct rsnd_mod *mod,
424 struct rsnd_dai_stream *io)
426 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
427 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
428 int is_dma = rsnd_ssi_is_dma_mode(mod);
430 bool elapsed = false;
432 spin_lock(&priv->lock);
434 /* ignore all cases if not working */
435 if (!rsnd_mod_is_working(mod))
436 goto rsnd_ssi_interrupt_out;
438 status = rsnd_mod_read(mod, SSISR);
441 if (!is_dma && (status & DIRQ)) {
442 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
443 u32 *buf = (u32 *)(runtime->dma_area +
444 rsnd_dai_pointer_offset(io, 0));
447 * 8/16/32 data can be assesse to TDR/RDR register
448 * directly as 32bit data
449 * see rsnd_ssi_init()
451 if (rsnd_io_is_play(io))
452 rsnd_mod_write(mod, SSITDR, *buf);
454 *buf = rsnd_mod_read(mod, SSIRDR);
456 elapsed = rsnd_dai_pointer_update(io, sizeof(*buf));
460 if (is_dma && (status & (UIRQ | OIRQ))) {
461 struct device *dev = rsnd_priv_to_dev(priv);
466 dev_dbg(dev, "%s[%d] restart\n",
467 rsnd_mod_name(mod), rsnd_mod_id(mod));
469 rsnd_ssi_stop(mod, io, priv);
471 rsnd_ssi_start(mod, io, priv);
473 dev_warn(dev, "no more SSI restart\n");
476 rsnd_ssi_record_error(ssi, status);
478 rsnd_ssi_interrupt_out:
479 spin_unlock(&priv->lock);
482 rsnd_dai_period_elapsed(io);
485 static irqreturn_t rsnd_ssi_interrupt(int irq, void *data)
487 struct rsnd_mod *mod = data;
489 rsnd_mod_interrupt(mod, __rsnd_ssi_interrupt);
497 static int rsnd_ssi_pio_probe(struct rsnd_mod *mod,
498 struct rsnd_dai_stream *io,
499 struct rsnd_priv *priv)
501 struct device *dev = rsnd_priv_to_dev(priv);
502 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
505 ret = devm_request_irq(dev, ssi->info->irq,
513 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
515 .probe = rsnd_ssi_pio_probe,
516 .init = rsnd_ssi_init,
517 .quit = rsnd_ssi_quit,
518 .start = rsnd_ssi_start,
519 .stop = rsnd_ssi_stop,
520 .hw_params = rsnd_ssi_hw_params,
523 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
524 struct rsnd_dai_stream *io,
525 struct rsnd_priv *priv)
527 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
528 struct device *dev = rsnd_priv_to_dev(priv);
529 int dma_id = ssi->info->dma_id;
532 ret = devm_request_irq(dev, ssi->info->irq,
540 io, rsnd_mod_to_dma(mod),
546 static int rsnd_ssi_dma_remove(struct rsnd_mod *mod,
547 struct rsnd_dai_stream *io,
548 struct rsnd_priv *priv)
550 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
551 struct device *dev = rsnd_priv_to_dev(priv);
552 int irq = ssi->info->irq;
554 rsnd_dma_quit(io, rsnd_mod_to_dma(mod));
556 /* PIO will request IRQ again */
557 devm_free_irq(dev, irq, ssi);
562 static int rsnd_ssi_fallback(struct rsnd_mod *mod,
563 struct rsnd_dai_stream *io,
564 struct rsnd_priv *priv)
566 struct device *dev = rsnd_priv_to_dev(priv);
571 * SSI .probe might be called again.
573 * rsnd_rdai_continuance_probe()
575 mod->ops = &rsnd_ssi_pio_ops;
577 dev_info(dev, "%s[%d] fallback to PIO mode\n",
578 rsnd_mod_name(mod), rsnd_mod_id(mod));
583 static int rsnd_ssi_dma_start(struct rsnd_mod *mod,
584 struct rsnd_dai_stream *io,
585 struct rsnd_priv *priv)
587 struct rsnd_dma *dma = rsnd_mod_to_dma(mod);
589 rsnd_dma_start(io, dma);
591 rsnd_ssi_start(mod, io, priv);
596 static int rsnd_ssi_dma_stop(struct rsnd_mod *mod,
597 struct rsnd_dai_stream *io,
598 struct rsnd_priv *priv)
600 struct rsnd_dma *dma = rsnd_mod_to_dma(mod);
602 rsnd_ssi_stop(mod, io, priv);
604 rsnd_dma_stop(io, dma);
609 static struct dma_chan *rsnd_ssi_dma_req(struct rsnd_dai_stream *io,
610 struct rsnd_mod *mod)
612 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
613 int is_play = rsnd_io_is_play(io);
616 if (rsnd_ssi_use_busif(io, mod))
617 name = is_play ? "rxu" : "txu";
619 name = is_play ? "rx" : "tx";
621 return rsnd_dma_request_channel(rsnd_ssi_of_node(priv),
625 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
627 .dma_req = rsnd_ssi_dma_req,
628 .probe = rsnd_ssi_dma_probe,
629 .remove = rsnd_ssi_dma_remove,
630 .init = rsnd_ssi_init,
631 .quit = rsnd_ssi_quit,
632 .start = rsnd_ssi_dma_start,
633 .stop = rsnd_ssi_dma_stop,
634 .fallback = rsnd_ssi_fallback,
635 .hw_params = rsnd_ssi_hw_params,
638 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod)
640 return mod->ops == &rsnd_ssi_dma_ops;
647 static struct rsnd_mod_ops rsnd_ssi_non_ops = {
654 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
656 if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
659 return &((struct rsnd_ssi *)(priv->ssi) + id)->mod;
662 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
664 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
666 return !!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_CLK_PIN_SHARE);
669 static void rsnd_ssi_parent_setup(struct rsnd_priv *priv, struct rsnd_ssi *ssi)
671 if (!rsnd_ssi_is_pin_sharing(&ssi->mod))
674 switch (rsnd_mod_id(&ssi->mod)) {
677 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 0));
680 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 3));
683 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 7));
689 static void rsnd_of_parse_ssi(struct platform_device *pdev,
690 const struct rsnd_of_data *of_data,
691 struct rsnd_priv *priv)
693 struct device_node *node;
694 struct device_node *np;
695 struct rsnd_ssi_platform_info *ssi_info;
696 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
697 struct device *dev = &pdev->dev;
703 node = rsnd_ssi_of_node(priv);
707 nr = of_get_child_count(node);
709 goto rsnd_of_parse_ssi_end;
711 ssi_info = devm_kzalloc(dev,
712 sizeof(struct rsnd_ssi_platform_info) * nr,
715 dev_err(dev, "ssi info allocation error\n");
716 goto rsnd_of_parse_ssi_end;
719 info->ssi_info = ssi_info;
720 info->ssi_info_nr = nr;
723 for_each_child_of_node(node, np) {
726 ssi_info = info->ssi_info + i;
731 if (of_get_property(np, "shared-pin", NULL))
732 ssi_info->flags |= RSND_SSI_CLK_PIN_SHARE;
737 ssi_info->irq = irq_of_parse_and_map(np, 0);
742 ssi_info->dma_id = of_get_property(np, "pio-transfer", NULL) ?
745 if (of_get_property(np, "no-busif", NULL))
746 ssi_info->flags |= RSND_SSI_NO_BUSIF;
749 rsnd_of_parse_ssi_end:
753 int rsnd_ssi_probe(struct platform_device *pdev,
754 const struct rsnd_of_data *of_data,
755 struct rsnd_priv *priv)
757 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
758 struct rsnd_ssi_platform_info *pinfo;
759 struct device *dev = rsnd_priv_to_dev(priv);
760 struct rsnd_mod_ops *ops;
762 struct rsnd_ssi *ssi;
763 char name[RSND_SSI_NAME_SIZE];
766 rsnd_of_parse_ssi(pdev, of_data, priv);
771 nr = info->ssi_info_nr;
772 ssi = devm_kzalloc(dev, sizeof(*ssi) * nr, GFP_KERNEL);
774 dev_err(dev, "SSI allocate failed\n");
781 for_each_rsnd_ssi(ssi, priv, i) {
782 pinfo = &info->ssi_info[i];
784 snprintf(name, RSND_SSI_NAME_SIZE, "%s.%d",
787 clk = devm_clk_get(dev, name);
793 ops = &rsnd_ssi_non_ops;
794 if (pinfo->dma_id > 0)
795 ops = &rsnd_ssi_dma_ops;
796 else if (rsnd_ssi_pio_available(ssi))
797 ops = &rsnd_ssi_pio_ops;
799 ret = rsnd_mod_init(priv, &ssi->mod, ops, clk, RSND_MOD_SSI, i);
803 rsnd_ssi_parent_setup(priv, ssi);
809 void rsnd_ssi_remove(struct platform_device *pdev,
810 struct rsnd_priv *priv)
812 struct rsnd_ssi *ssi;
815 for_each_rsnd_ssi(ssi, priv, i) {
816 rsnd_mod_quit(&ssi->mod);