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_ssi_pio_available(ssi) ((ssi)->info->irq > 0)
83 #define rsnd_ssi_parent(ssi) ((ssi)->parent)
84 #define rsnd_ssi_mode_flags(p) ((p)->info->flags)
85 #define rsnd_ssi_dai_id(ssi) ((ssi)->info->dai_id)
86 #define rsnd_ssi_of_node(priv) \
87 of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, "rcar_sound,ssi")
89 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io)
91 struct rsnd_mod *mod = rsnd_io_to_mod_ssi(io);
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);
131 struct rsnd_mod *mod = rsnd_mod_get(ssi);
133 int ssi_clk_mul_table[] = {
134 1, 2, 4, 8, 16, 6, 12,
136 unsigned int main_rate;
137 unsigned int rate = rsnd_src_get_ssi_rate(priv, io, runtime);
140 * Find best clock, and try to start ADG
142 for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
145 * this driver is assuming that
146 * system word is 64fs (= 2 x 32bit)
147 * see rsnd_ssi_init()
149 main_rate = rate * 32 * 2 * ssi_clk_mul_table[j];
151 ret = rsnd_adg_ssi_clk_try_start(mod, main_rate);
153 ssi->cr_clk = FORCE | SWL_32 |
154 SCKD | SWSD | CKDV(j);
156 dev_dbg(dev, "%s[%d] outputs %u Hz\n",
158 rsnd_mod_id(mod), rate);
164 dev_err(dev, "unsupported clock rate\n");
168 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi *ssi)
170 struct rsnd_mod *mod = rsnd_mod_get(ssi);
173 rsnd_adg_ssi_clk_stop(mod);
176 static void rsnd_ssi_hw_start(struct rsnd_ssi *ssi,
177 struct rsnd_dai_stream *io)
179 struct rsnd_priv *priv = rsnd_io_to_priv(io);
180 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
181 struct device *dev = rsnd_priv_to_dev(priv);
182 struct rsnd_mod *mod = rsnd_mod_get(ssi);
186 if (0 == ssi->usrcnt) {
187 rsnd_mod_power_on(mod);
189 if (rsnd_rdai_is_clk_master(rdai)) {
190 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
193 rsnd_ssi_hw_start(ssi_parent, io);
195 rsnd_ssi_master_clk_start(ssi, io);
199 if (rsnd_ssi_is_dma_mode(mod)) {
200 cr_mode = UIEN | OIEN | /* over/under run */
201 DMEN; /* DMA : enable DMA */
203 cr_mode = DIEN; /* PIO : enable Data interrupt */
211 rsnd_mod_write(mod, SSICR, cr);
213 /* enable WS continue */
214 if (rsnd_rdai_is_clk_master(rdai))
215 rsnd_mod_write(mod, SSIWSR, CONT);
217 /* clear error status */
218 rsnd_mod_write(mod, SSISR, 0);
222 dev_dbg(dev, "%s[%d] hw started\n",
223 rsnd_mod_name(mod), rsnd_mod_id(mod));
226 static void rsnd_ssi_hw_stop(struct rsnd_dai_stream *io, struct rsnd_ssi *ssi)
228 struct rsnd_mod *mod = rsnd_mod_get(ssi);
229 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
230 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
231 struct device *dev = rsnd_priv_to_dev(priv);
234 if (0 == ssi->usrcnt) {
235 dev_err(dev, "%s called without starting\n", __func__);
241 if (0 == ssi->usrcnt) {
244 * and, wait all data was sent
249 rsnd_mod_write(mod, SSICR, cr | EN);
250 rsnd_ssi_status_check(mod, DIRQ);
254 * and, wait idle state
256 rsnd_mod_write(mod, SSICR, cr); /* disabled all */
257 rsnd_ssi_status_check(mod, IIRQ);
259 if (rsnd_rdai_is_clk_master(rdai)) {
260 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
263 rsnd_ssi_hw_stop(io, ssi_parent);
265 rsnd_ssi_master_clk_stop(ssi);
268 rsnd_mod_power_off(mod);
273 dev_dbg(dev, "%s[%d] hw stopped\n",
274 rsnd_mod_name(mod), rsnd_mod_id(mod));
278 * SSI mod common functions
280 static int rsnd_ssi_init(struct rsnd_mod *mod,
281 struct rsnd_dai_stream *io,
282 struct rsnd_priv *priv)
284 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
285 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
286 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
292 * always use 32bit system word for easy clock calculation.
293 * see also rsnd_ssi_master_clk_enable()
298 * init clock settings for SSICR
300 switch (runtime->sample_bits) {
311 if (rdai->bit_clk_inv)
313 if (rdai->frm_clk_inv)
315 if (rdai->data_alignment)
319 if (rsnd_io_is_play(io))
326 ssi->err = -1; /* ignore 1st error */
331 static int rsnd_ssi_quit(struct rsnd_mod *mod,
332 struct rsnd_dai_stream *io,
333 struct rsnd_priv *priv)
335 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
336 struct device *dev = rsnd_priv_to_dev(priv);
339 dev_warn(dev, "%s[%d] under/over flow err = %d\n",
340 rsnd_mod_name(mod), rsnd_mod_id(mod), ssi->err);
348 static int rsnd_ssi_hw_params(struct rsnd_mod *mod,
349 struct rsnd_dai_stream *io,
350 struct snd_pcm_substream *substream,
351 struct snd_pcm_hw_params *params)
353 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
354 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
355 int chan = params_channels(params);
359 * It will happen if SSI has parent/child connection.
363 * it is error if child <-> parent SSI uses
364 * different channels.
366 if (ssi->chan != chan)
370 /* It will be removed on rsnd_ssi_hw_stop */
373 return rsnd_ssi_hw_params(rsnd_mod_get(ssi_parent), io,
379 static void rsnd_ssi_record_error(struct rsnd_ssi *ssi, u32 status)
381 struct rsnd_mod *mod = rsnd_mod_get(ssi);
383 /* under/over flow error */
384 if (status & (UIRQ | OIRQ)) {
387 /* clear error status */
388 rsnd_mod_write(mod, SSISR, 0);
392 static int rsnd_ssi_start(struct rsnd_mod *mod,
393 struct rsnd_dai_stream *io,
394 struct rsnd_priv *priv)
396 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
398 rsnd_src_ssiu_start(mod, io, rsnd_ssi_use_busif(io));
400 rsnd_ssi_hw_start(ssi, io);
402 rsnd_src_ssi_irq_enable(mod);
407 static int rsnd_ssi_stop(struct rsnd_mod *mod,
408 struct rsnd_dai_stream *io,
409 struct rsnd_priv *priv)
411 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
413 rsnd_src_ssi_irq_disable(mod);
415 rsnd_ssi_record_error(ssi, rsnd_mod_read(mod, SSISR));
417 rsnd_ssi_hw_stop(io, ssi);
419 rsnd_src_ssiu_stop(mod, io);
424 static void __rsnd_ssi_interrupt(struct rsnd_mod *mod,
425 struct rsnd_dai_stream *io)
427 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
428 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
429 int is_dma = rsnd_ssi_is_dma_mode(mod);
431 bool elapsed = false;
433 spin_lock(&priv->lock);
435 /* ignore all cases if not working */
436 if (!rsnd_io_is_working(io))
437 goto rsnd_ssi_interrupt_out;
439 status = rsnd_mod_read(mod, SSISR);
442 if (!is_dma && (status & DIRQ)) {
443 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
444 u32 *buf = (u32 *)(runtime->dma_area +
445 rsnd_dai_pointer_offset(io, 0));
448 * 8/16/32 data can be assesse to TDR/RDR register
449 * directly as 32bit data
450 * see rsnd_ssi_init()
452 if (rsnd_io_is_play(io))
453 rsnd_mod_write(mod, SSITDR, *buf);
455 *buf = rsnd_mod_read(mod, SSIRDR);
457 elapsed = rsnd_dai_pointer_update(io, sizeof(*buf));
461 if (is_dma && (status & (UIRQ | OIRQ))) {
462 struct device *dev = rsnd_priv_to_dev(priv);
467 dev_dbg(dev, "%s[%d] restart\n",
468 rsnd_mod_name(mod), rsnd_mod_id(mod));
470 rsnd_ssi_stop(mod, io, priv);
472 rsnd_ssi_start(mod, io, priv);
474 dev_warn(dev, "no more SSI restart\n");
477 rsnd_ssi_record_error(ssi, status);
479 rsnd_ssi_interrupt_out:
480 spin_unlock(&priv->lock);
483 rsnd_dai_period_elapsed(io);
486 static irqreturn_t rsnd_ssi_interrupt(int irq, void *data)
488 struct rsnd_mod *mod = data;
490 rsnd_mod_interrupt(mod, __rsnd_ssi_interrupt);
498 static int rsnd_ssi_pio_probe(struct rsnd_mod *mod,
499 struct rsnd_dai_stream *io,
500 struct rsnd_priv *priv)
502 struct device *dev = rsnd_priv_to_dev(priv);
503 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
506 ret = devm_request_irq(dev, ssi->info->irq,
514 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
516 .probe = rsnd_ssi_pio_probe,
517 .init = rsnd_ssi_init,
518 .quit = rsnd_ssi_quit,
519 .start = rsnd_ssi_start,
520 .stop = rsnd_ssi_stop,
521 .hw_params = rsnd_ssi_hw_params,
524 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
525 struct rsnd_dai_stream *io,
526 struct rsnd_priv *priv)
528 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
529 struct device *dev = rsnd_priv_to_dev(priv);
530 int dma_id = ssi->info->dma_id;
533 ret = devm_request_irq(dev, ssi->info->irq,
541 io, rsnd_mod_to_dma(mod),
547 static int rsnd_ssi_dma_remove(struct rsnd_mod *mod,
548 struct rsnd_dai_stream *io,
549 struct rsnd_priv *priv)
551 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
552 struct device *dev = rsnd_priv_to_dev(priv);
553 int irq = ssi->info->irq;
555 rsnd_dma_quit(io, rsnd_mod_to_dma(mod));
557 /* PIO will request IRQ again */
558 devm_free_irq(dev, irq, mod);
563 static int rsnd_ssi_fallback(struct rsnd_mod *mod,
564 struct rsnd_dai_stream *io,
565 struct rsnd_priv *priv)
567 struct device *dev = rsnd_priv_to_dev(priv);
572 * SSI .probe might be called again.
574 * rsnd_rdai_continuance_probe()
576 mod->ops = &rsnd_ssi_pio_ops;
578 dev_info(dev, "%s[%d] fallback to PIO mode\n",
579 rsnd_mod_name(mod), rsnd_mod_id(mod));
584 static int rsnd_ssi_dma_start(struct rsnd_mod *mod,
585 struct rsnd_dai_stream *io,
586 struct rsnd_priv *priv)
588 struct rsnd_dma *dma = rsnd_mod_to_dma(mod);
590 rsnd_dma_start(io, dma);
592 rsnd_ssi_start(mod, io, priv);
597 static int rsnd_ssi_dma_stop(struct rsnd_mod *mod,
598 struct rsnd_dai_stream *io,
599 struct rsnd_priv *priv)
601 struct rsnd_dma *dma = rsnd_mod_to_dma(mod);
603 rsnd_ssi_stop(mod, io, priv);
605 rsnd_dma_stop(io, dma);
610 static struct dma_chan *rsnd_ssi_dma_req(struct rsnd_dai_stream *io,
611 struct rsnd_mod *mod)
613 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
614 int is_play = rsnd_io_is_play(io);
617 if (rsnd_ssi_use_busif(io))
618 name = is_play ? "rxu" : "txu";
620 name = is_play ? "rx" : "tx";
622 return rsnd_dma_request_channel(rsnd_ssi_of_node(priv),
626 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
628 .dma_req = rsnd_ssi_dma_req,
629 .probe = rsnd_ssi_dma_probe,
630 .remove = rsnd_ssi_dma_remove,
631 .init = rsnd_ssi_init,
632 .quit = rsnd_ssi_quit,
633 .start = rsnd_ssi_dma_start,
634 .stop = rsnd_ssi_dma_stop,
635 .fallback = rsnd_ssi_fallback,
636 .hw_params = rsnd_ssi_hw_params,
639 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod)
641 return mod->ops == &rsnd_ssi_dma_ops;
648 static struct rsnd_mod_ops rsnd_ssi_non_ops = {
655 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
657 if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
660 return rsnd_mod_get((struct rsnd_ssi *)(priv->ssi) + id);
663 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
665 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
667 return !!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_CLK_PIN_SHARE);
670 static void rsnd_ssi_parent_setup(struct rsnd_priv *priv, struct rsnd_ssi *ssi)
672 struct rsnd_mod *mod = rsnd_mod_get(ssi);
674 if (!__rsnd_ssi_is_pin_sharing(mod))
677 switch (rsnd_mod_id(mod)) {
680 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 0));
683 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 3));
686 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 7));
692 static void rsnd_of_parse_ssi(struct platform_device *pdev,
693 const struct rsnd_of_data *of_data,
694 struct rsnd_priv *priv)
696 struct device_node *node;
697 struct device_node *np;
698 struct rsnd_ssi_platform_info *ssi_info;
699 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
700 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);
779 for_each_rsnd_ssi(ssi, priv, i) {
780 pinfo = &info->ssi_info[i];
782 snprintf(name, RSND_SSI_NAME_SIZE, "%s.%d",
785 clk = devm_clk_get(dev, name);
791 ops = &rsnd_ssi_non_ops;
792 if (pinfo->dma_id > 0)
793 ops = &rsnd_ssi_dma_ops;
794 else if (rsnd_ssi_pio_available(ssi))
795 ops = &rsnd_ssi_pio_ops;
797 ret = rsnd_mod_init(priv, rsnd_mod_get(ssi), ops, clk,
802 rsnd_ssi_parent_setup(priv, ssi);
808 void rsnd_ssi_remove(struct platform_device *pdev,
809 struct rsnd_priv *priv)
811 struct rsnd_ssi *ssi;
814 for_each_rsnd_ssi(ssi, priv, i) {
815 rsnd_mod_quit(rsnd_mod_get(ssi));