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_mod *mod)
92 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
93 struct rsnd_dai_stream *io = rsnd_mod_to_io(mod);
96 if (!rsnd_ssi_is_dma_mode(mod))
99 if (!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_NO_BUSIF))
101 if (rsnd_io_to_mod_src(io))
107 static void rsnd_ssi_status_check(struct rsnd_mod *mod,
110 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
111 struct device *dev = rsnd_priv_to_dev(priv);
115 for (i = 0; i < 1024; i++) {
116 status = rsnd_mod_read(mod, SSISR);
123 dev_warn(dev, "status check failed\n");
126 static int rsnd_ssi_master_clk_start(struct rsnd_ssi *ssi,
127 struct rsnd_dai_stream *io)
129 struct rsnd_priv *priv = rsnd_io_to_priv(io);
130 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
131 struct device *dev = rsnd_priv_to_dev(priv);
133 int adg_clk_div_table[] = {
134 1, 6, /* see adg.c */
136 int ssi_clk_mul_table[] = {
137 1, 2, 4, 8, 16, 6, 12,
139 unsigned int main_rate;
140 unsigned int rate = rsnd_src_get_ssi_rate(priv, io, runtime);
143 * Find best clock, and try to start ADG
145 for (i = 0; i < ARRAY_SIZE(adg_clk_div_table); i++) {
146 for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
149 * this driver is assuming that
150 * system word is 64fs (= 2 x 32bit)
151 * see rsnd_ssi_init()
153 main_rate = rate / adg_clk_div_table[i]
154 * 32 * 2 * ssi_clk_mul_table[j];
156 ret = rsnd_adg_ssi_clk_try_start(&ssi->mod, main_rate);
158 ssi->cr_clk = FORCE | SWL_32 |
159 SCKD | SWSD | CKDV(j);
161 dev_dbg(dev, "%s[%d] outputs %u Hz\n",
162 rsnd_mod_name(&ssi->mod),
163 rsnd_mod_id(&ssi->mod), rate);
170 dev_err(dev, "unsupported clock rate\n");
174 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi *ssi)
177 rsnd_adg_ssi_clk_stop(&ssi->mod);
180 static void rsnd_ssi_hw_start(struct rsnd_ssi *ssi,
181 struct rsnd_dai_stream *io)
183 struct rsnd_priv *priv = rsnd_io_to_priv(io);
184 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
185 struct device *dev = rsnd_priv_to_dev(priv);
189 if (0 == ssi->usrcnt) {
190 rsnd_mod_hw_start(&ssi->mod);
192 if (rsnd_rdai_is_clk_master(rdai)) {
193 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
196 rsnd_ssi_hw_start(ssi_parent, io);
198 rsnd_ssi_master_clk_start(ssi, io);
202 if (rsnd_ssi_is_dma_mode(&ssi->mod)) {
203 cr_mode = UIEN | OIEN | /* over/under run */
204 DMEN; /* DMA : enable DMA */
206 cr_mode = DIEN; /* PIO : enable Data interrupt */
214 rsnd_mod_write(&ssi->mod, SSICR, cr);
216 /* enable WS continue */
217 if (rsnd_rdai_is_clk_master(rdai))
218 rsnd_mod_write(&ssi->mod, SSIWSR, CONT);
220 /* clear error status */
221 rsnd_mod_write(&ssi->mod, SSISR, 0);
225 dev_dbg(dev, "%s[%d] hw started\n",
226 rsnd_mod_name(&ssi->mod), rsnd_mod_id(&ssi->mod));
229 static void rsnd_ssi_hw_stop(struct rsnd_ssi *ssi)
231 struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
232 struct rsnd_dai_stream *io = rsnd_mod_to_io(&ssi->mod);
233 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
234 struct device *dev = rsnd_priv_to_dev(priv);
237 if (0 == ssi->usrcnt) {
238 dev_err(dev, "%s called without starting\n", __func__);
244 if (0 == ssi->usrcnt) {
247 * and, wait all data was sent
252 rsnd_mod_write(&ssi->mod, SSICR, cr | EN);
253 rsnd_ssi_status_check(&ssi->mod, DIRQ);
257 * and, wait idle state
259 rsnd_mod_write(&ssi->mod, SSICR, cr); /* disabled all */
260 rsnd_ssi_status_check(&ssi->mod, IIRQ);
262 if (rsnd_rdai_is_clk_master(rdai)) {
263 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
266 rsnd_ssi_hw_stop(ssi_parent);
268 rsnd_ssi_master_clk_stop(ssi);
271 rsnd_mod_hw_stop(&ssi->mod);
276 dev_dbg(dev, "%s[%d] hw stopped\n",
277 rsnd_mod_name(&ssi->mod), rsnd_mod_id(&ssi->mod));
281 * SSI mod common functions
283 static int rsnd_ssi_init(struct rsnd_mod *mod,
284 struct rsnd_dai_stream *io,
285 struct rsnd_priv *priv)
287 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
288 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
289 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
295 * always use 32bit system word for easy clock calculation.
296 * see also rsnd_ssi_master_clk_enable()
301 * init clock settings for SSICR
303 switch (runtime->sample_bits) {
314 if (rdai->bit_clk_inv)
316 if (rdai->frm_clk_inv)
318 if (rdai->data_alignment)
322 if (rsnd_io_is_play(io))
329 ssi->err = -1; /* ignore 1st error */
334 static int rsnd_ssi_quit(struct rsnd_mod *mod,
335 struct rsnd_dai_stream *io,
336 struct rsnd_priv *priv)
338 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
339 struct device *dev = rsnd_priv_to_dev(priv);
342 dev_warn(dev, "%s[%d] under/over flow err = %d\n",
343 rsnd_mod_name(mod), rsnd_mod_id(mod), ssi->err);
351 static int rsnd_ssi_hw_params(struct rsnd_mod *mod,
352 struct rsnd_dai_stream *io,
353 struct snd_pcm_substream *substream,
354 struct snd_pcm_hw_params *params)
356 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
357 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
358 int chan = params_channels(params);
362 * It will happen if SSI has parent/child connection.
366 * it is error if child <-> parent SSI uses
367 * different channels.
369 if (ssi->chan != chan)
373 /* It will be removed on rsnd_ssi_hw_stop */
376 return rsnd_ssi_hw_params(&ssi_parent->mod, io,
382 static void rsnd_ssi_record_error(struct rsnd_ssi *ssi, u32 status)
384 /* under/over flow error */
385 if (status & (UIRQ | OIRQ)) {
388 /* clear error status */
389 rsnd_mod_write(&ssi->mod, SSISR, 0);
393 static int rsnd_ssi_start(struct rsnd_mod *mod,
394 struct rsnd_dai_stream *io,
395 struct rsnd_priv *priv)
397 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
399 rsnd_src_ssiu_start(mod, io, rsnd_ssi_use_busif(mod));
401 rsnd_ssi_hw_start(ssi, io);
403 rsnd_src_ssi_irq_enable(mod);
408 static int rsnd_ssi_stop(struct rsnd_mod *mod,
409 struct rsnd_dai_stream *io,
410 struct rsnd_priv *priv)
412 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
414 rsnd_src_ssi_irq_disable(mod);
416 rsnd_ssi_record_error(ssi, rsnd_mod_read(mod, SSISR));
418 rsnd_ssi_hw_stop(ssi);
420 rsnd_src_ssiu_stop(mod, io);
425 static irqreturn_t rsnd_ssi_interrupt(int irq, void *data)
427 struct rsnd_ssi *ssi = data;
428 struct rsnd_mod *mod = &ssi->mod;
429 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
430 struct rsnd_dai_stream *io = rsnd_mod_to_io(mod);
431 int is_dma = rsnd_ssi_is_dma_mode(mod);
433 bool elapsed = false;
435 spin_lock(&priv->lock);
437 /* ignore all cases if not working */
438 if (!rsnd_mod_is_working(mod))
439 goto rsnd_ssi_interrupt_out;
441 status = rsnd_mod_read(mod, SSISR);
444 if (!is_dma && (status & DIRQ)) {
445 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
446 u32 *buf = (u32 *)(runtime->dma_area +
447 rsnd_dai_pointer_offset(io, 0));
450 * 8/16/32 data can be assesse to TDR/RDR register
451 * directly as 32bit data
452 * see rsnd_ssi_init()
454 if (rsnd_io_is_play(io))
455 rsnd_mod_write(mod, SSITDR, *buf);
457 *buf = rsnd_mod_read(mod, SSIRDR);
459 elapsed = rsnd_dai_pointer_update(io, sizeof(*buf));
463 if (is_dma && (status & (UIRQ | OIRQ))) {
464 struct device *dev = rsnd_priv_to_dev(priv);
469 dev_dbg(dev, "%s[%d] restart\n",
470 rsnd_mod_name(mod), rsnd_mod_id(mod));
472 rsnd_ssi_stop(mod, io, priv);
474 rsnd_ssi_start(mod, io, priv);
476 dev_warn(dev, "no more SSI restart\n");
479 rsnd_ssi_record_error(ssi, status);
481 rsnd_ssi_interrupt_out:
482 spin_unlock(&priv->lock);
485 rsnd_dai_period_elapsed(io);
493 static int rsnd_ssi_pio_probe(struct rsnd_mod *mod,
494 struct rsnd_dai_stream *io,
495 struct rsnd_priv *priv)
497 struct device *dev = rsnd_priv_to_dev(priv);
498 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
501 ret = devm_request_irq(dev, ssi->info->irq,
509 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
511 .probe = rsnd_ssi_pio_probe,
512 .init = rsnd_ssi_init,
513 .quit = rsnd_ssi_quit,
514 .start = rsnd_ssi_start,
515 .stop = rsnd_ssi_stop,
516 .hw_params = rsnd_ssi_hw_params,
519 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
520 struct rsnd_dai_stream *io,
521 struct rsnd_priv *priv)
523 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
524 struct device *dev = rsnd_priv_to_dev(priv);
525 int dma_id = ssi->info->dma_id;
528 ret = devm_request_irq(dev, ssi->info->irq,
536 io, rsnd_mod_to_dma(mod),
542 static int rsnd_ssi_dma_remove(struct rsnd_mod *mod,
543 struct rsnd_dai_stream *io,
544 struct rsnd_priv *priv)
546 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
547 struct device *dev = rsnd_priv_to_dev(priv);
548 int irq = ssi->info->irq;
550 rsnd_dma_quit(io, rsnd_mod_to_dma(mod));
552 /* PIO will request IRQ again */
553 devm_free_irq(dev, irq, ssi);
558 static int rsnd_ssi_fallback(struct rsnd_mod *mod,
559 struct rsnd_dai_stream *io,
560 struct rsnd_priv *priv)
562 struct device *dev = rsnd_priv_to_dev(priv);
567 * SSI .probe might be called again.
569 * rsnd_rdai_continuance_probe()
571 mod->ops = &rsnd_ssi_pio_ops;
573 dev_info(dev, "%s[%d] fallback to PIO mode\n",
574 rsnd_mod_name(mod), rsnd_mod_id(mod));
579 static int rsnd_ssi_dma_start(struct rsnd_mod *mod,
580 struct rsnd_dai_stream *io,
581 struct rsnd_priv *priv)
583 struct rsnd_dma *dma = rsnd_mod_to_dma(mod);
585 rsnd_dma_start(io, dma);
587 rsnd_ssi_start(mod, io, priv);
592 static int rsnd_ssi_dma_stop(struct rsnd_mod *mod,
593 struct rsnd_dai_stream *io,
594 struct rsnd_priv *priv)
596 struct rsnd_dma *dma = rsnd_mod_to_dma(mod);
598 rsnd_ssi_stop(mod, io, priv);
600 rsnd_dma_stop(io, dma);
605 static struct dma_chan *rsnd_ssi_dma_req(struct rsnd_dai_stream *io,
606 struct rsnd_mod *mod)
608 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
609 int is_play = rsnd_io_is_play(io);
612 if (rsnd_ssi_use_busif(mod))
613 name = is_play ? "rxu" : "txu";
615 name = is_play ? "rx" : "tx";
617 return rsnd_dma_request_channel(rsnd_ssi_of_node(priv),
621 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
623 .dma_req = rsnd_ssi_dma_req,
624 .probe = rsnd_ssi_dma_probe,
625 .remove = rsnd_ssi_dma_remove,
626 .init = rsnd_ssi_init,
627 .quit = rsnd_ssi_quit,
628 .start = rsnd_ssi_dma_start,
629 .stop = rsnd_ssi_dma_stop,
630 .fallback = rsnd_ssi_fallback,
631 .hw_params = rsnd_ssi_hw_params,
634 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod)
636 return mod->ops == &rsnd_ssi_dma_ops;
643 static struct rsnd_mod_ops rsnd_ssi_non_ops = {
650 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
652 if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
655 return &((struct rsnd_ssi *)(priv->ssi) + id)->mod;
658 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
660 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
662 return !!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_CLK_PIN_SHARE);
665 static void rsnd_ssi_parent_setup(struct rsnd_priv *priv, struct rsnd_ssi *ssi)
667 if (!rsnd_ssi_is_pin_sharing(&ssi->mod))
670 switch (rsnd_mod_id(&ssi->mod)) {
673 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 0));
676 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 3));
679 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 7));
685 static void rsnd_of_parse_ssi(struct platform_device *pdev,
686 const struct rsnd_of_data *of_data,
687 struct rsnd_priv *priv)
689 struct device_node *node;
690 struct device_node *np;
691 struct rsnd_ssi_platform_info *ssi_info;
692 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
693 struct device *dev = &pdev->dev;
699 node = rsnd_ssi_of_node(priv);
703 nr = of_get_child_count(node);
705 goto rsnd_of_parse_ssi_end;
707 ssi_info = devm_kzalloc(dev,
708 sizeof(struct rsnd_ssi_platform_info) * nr,
711 dev_err(dev, "ssi info allocation error\n");
712 goto rsnd_of_parse_ssi_end;
715 info->ssi_info = ssi_info;
716 info->ssi_info_nr = nr;
719 for_each_child_of_node(node, np) {
722 ssi_info = info->ssi_info + i;
727 if (of_get_property(np, "shared-pin", NULL))
728 ssi_info->flags |= RSND_SSI_CLK_PIN_SHARE;
733 ssi_info->irq = irq_of_parse_and_map(np, 0);
738 ssi_info->dma_id = of_get_property(np, "pio-transfer", NULL) ?
741 if (of_get_property(np, "no-busif", NULL))
742 ssi_info->flags |= RSND_SSI_NO_BUSIF;
745 rsnd_of_parse_ssi_end:
749 int rsnd_ssi_probe(struct platform_device *pdev,
750 const struct rsnd_of_data *of_data,
751 struct rsnd_priv *priv)
753 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
754 struct rsnd_ssi_platform_info *pinfo;
755 struct device *dev = rsnd_priv_to_dev(priv);
756 struct rsnd_mod_ops *ops;
758 struct rsnd_ssi *ssi;
759 char name[RSND_SSI_NAME_SIZE];
762 rsnd_of_parse_ssi(pdev, of_data, priv);
767 nr = info->ssi_info_nr;
768 ssi = devm_kzalloc(dev, sizeof(*ssi) * nr, GFP_KERNEL);
770 dev_err(dev, "SSI allocate failed\n");
777 for_each_rsnd_ssi(ssi, priv, i) {
778 pinfo = &info->ssi_info[i];
780 snprintf(name, RSND_SSI_NAME_SIZE, "%s.%d",
783 clk = devm_clk_get(dev, name);
789 ops = &rsnd_ssi_non_ops;
790 if (pinfo->dma_id > 0)
791 ops = &rsnd_ssi_dma_ops;
792 else if (rsnd_ssi_pio_available(ssi))
793 ops = &rsnd_ssi_pio_ops;
795 ret = rsnd_mod_init(priv, &ssi->mod, ops, clk, RSND_MOD_SSI, i);
799 rsnd_ssi_parent_setup(priv, ssi);
805 void rsnd_ssi_remove(struct platform_device *pdev,
806 struct rsnd_priv *priv)
808 struct rsnd_ssi *ssi;
811 for_each_rsnd_ssi(ssi, priv, i) {
812 rsnd_mod_quit(&ssi->mod);