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 PDTA (1 << 9) /* Parallel Data Alignment */
43 #define DEL (1 << 8) /* Serial Data Delay */
44 #define CKDV(v) (v << 4) /* Serial Clock Division Ratio */
45 #define TRMD (1 << 1) /* Transmit/Receive Mode Select */
46 #define EN (1 << 0) /* SSI Module Enable */
51 #define UIRQ (1 << 27) /* Underflow Error Interrupt Status */
52 #define OIRQ (1 << 26) /* Overflow Error Interrupt Status */
53 #define IIRQ (1 << 25) /* Idle Mode Interrupt Status */
54 #define DIRQ (1 << 24) /* Data Interrupt Status Flag */
59 #define CONT (1 << 8) /* WS Continue Function */
61 #define SSI_NAME "ssi"
64 struct rsnd_ssi_platform_info *info; /* rcar_snd.h */
65 struct rsnd_ssi *parent;
75 #define for_each_rsnd_ssi(pos, priv, i) \
77 (i < rsnd_ssi_nr(priv)) && \
78 ((pos) = ((struct rsnd_ssi *)(priv)->ssi + i)); \
81 #define rsnd_ssi_nr(priv) ((priv)->ssi_nr)
82 #define rsnd_mod_to_ssi(_mod) container_of((_mod), struct rsnd_ssi, mod)
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)
92 struct rsnd_mod *mod = rsnd_io_to_mod_ssi(io);
93 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(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);
132 struct rsnd_mod *mod = rsnd_mod_get(ssi);
134 int ssi_clk_mul_table[] = {
135 1, 2, 4, 8, 16, 6, 12,
137 unsigned int main_rate;
138 unsigned int rate = rsnd_src_get_ssi_rate(priv, io, runtime);
141 * Find best clock, and try to start ADG
143 for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
146 * It will set SSIWSR.CONT here, but SSICR.CKDV = 000
147 * with it is not allowed. (SSIWSR.WS_MODE with
148 * SSICR.CKDV = 000 is not allowed either).
149 * Skip it. See SSICR.CKDV
155 * this driver is assuming that
156 * system word is 64fs (= 2 x 32bit)
157 * see rsnd_ssi_init()
159 main_rate = rate * 32 * 2 * ssi_clk_mul_table[j];
161 ret = rsnd_adg_ssi_clk_try_start(mod, main_rate);
163 ssi->cr_clk = FORCE | SWL_32 |
164 SCKD | SWSD | CKDV(j);
166 dev_dbg(dev, "%s[%d] outputs %u Hz\n",
168 rsnd_mod_id(mod), rate);
174 dev_err(dev, "unsupported clock rate\n");
178 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi *ssi)
180 struct rsnd_mod *mod = rsnd_mod_get(ssi);
183 rsnd_adg_ssi_clk_stop(mod);
186 static void rsnd_ssi_hw_start(struct rsnd_ssi *ssi,
187 struct rsnd_dai_stream *io)
189 struct rsnd_priv *priv = rsnd_io_to_priv(io);
190 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
191 struct device *dev = rsnd_priv_to_dev(priv);
192 struct rsnd_mod *mod = rsnd_mod_get(ssi);
196 if (0 == ssi->usrcnt) {
197 rsnd_mod_power_on(mod);
199 if (rsnd_rdai_is_clk_master(rdai)) {
200 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
203 rsnd_ssi_hw_start(ssi_parent, io);
205 rsnd_ssi_master_clk_start(ssi, io);
209 if (rsnd_ssi_is_dma_mode(mod)) {
210 cr_mode = UIEN | OIEN | /* over/under run */
211 DMEN; /* DMA : enable DMA */
213 cr_mode = DIEN; /* PIO : enable Data interrupt */
221 rsnd_mod_write(mod, SSICR, cr);
223 /* enable WS continue */
224 if (rsnd_rdai_is_clk_master(rdai))
225 rsnd_mod_write(mod, SSIWSR, CONT);
227 /* clear error status */
228 rsnd_mod_write(mod, SSISR, 0);
232 dev_dbg(dev, "%s[%d] hw started\n",
233 rsnd_mod_name(mod), rsnd_mod_id(mod));
236 static void rsnd_ssi_hw_stop(struct rsnd_dai_stream *io, struct rsnd_ssi *ssi)
238 struct rsnd_mod *mod = rsnd_mod_get(ssi);
239 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
240 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
241 struct device *dev = rsnd_priv_to_dev(priv);
244 if (0 == ssi->usrcnt) {
245 dev_err(dev, "%s called without starting\n", __func__);
251 if (0 == ssi->usrcnt) {
254 * and, wait all data was sent
259 rsnd_mod_write(mod, SSICR, cr | EN);
260 rsnd_ssi_status_check(mod, DIRQ);
264 * and, wait idle state
266 rsnd_mod_write(mod, SSICR, cr); /* disabled all */
267 rsnd_ssi_status_check(mod, IIRQ);
269 if (rsnd_rdai_is_clk_master(rdai)) {
270 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
273 rsnd_ssi_hw_stop(io, ssi_parent);
275 rsnd_ssi_master_clk_stop(ssi);
278 rsnd_mod_power_off(mod);
283 dev_dbg(dev, "%s[%d] hw stopped\n",
284 rsnd_mod_name(mod), rsnd_mod_id(mod));
288 * SSI mod common functions
290 static int rsnd_ssi_init(struct rsnd_mod *mod,
291 struct rsnd_dai_stream *io,
292 struct rsnd_priv *priv)
294 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
295 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
296 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
302 * always use 32bit system word for easy clock calculation.
303 * see also rsnd_ssi_master_clk_enable()
308 * init clock settings for SSICR
310 switch (runtime->sample_bits) {
321 if (rdai->bit_clk_inv)
323 if (rdai->frm_clk_inv)
325 if (rdai->data_alignment)
329 if (rsnd_io_is_play(io))
336 ssi->err = -1; /* ignore 1st error */
341 static int rsnd_ssi_quit(struct rsnd_mod *mod,
342 struct rsnd_dai_stream *io,
343 struct rsnd_priv *priv)
345 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
346 struct device *dev = rsnd_priv_to_dev(priv);
349 dev_warn(dev, "%s[%d] under/over flow err = %d\n",
350 rsnd_mod_name(mod), rsnd_mod_id(mod), ssi->err);
358 static int rsnd_ssi_hw_params(struct rsnd_mod *mod,
359 struct rsnd_dai_stream *io,
360 struct snd_pcm_substream *substream,
361 struct snd_pcm_hw_params *params)
363 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
364 struct rsnd_ssi *ssi_parent = rsnd_ssi_parent(ssi);
365 int chan = params_channels(params);
369 * It will happen if SSI has parent/child connection.
373 * it is error if child <-> parent SSI uses
374 * different channels.
376 if (ssi->chan != chan)
380 /* It will be removed on rsnd_ssi_hw_stop */
383 return rsnd_ssi_hw_params(rsnd_mod_get(ssi_parent), io,
389 static void rsnd_ssi_record_error(struct rsnd_ssi *ssi, u32 status)
391 struct rsnd_mod *mod = rsnd_mod_get(ssi);
393 /* under/over flow error */
394 if (status & (UIRQ | OIRQ)) {
397 /* clear error status */
398 rsnd_mod_write(mod, SSISR, 0);
402 static int rsnd_ssi_start(struct rsnd_mod *mod,
403 struct rsnd_dai_stream *io,
404 struct rsnd_priv *priv)
406 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
408 rsnd_src_ssiu_start(mod, io, rsnd_ssi_use_busif(io));
410 rsnd_ssi_hw_start(ssi, io);
412 rsnd_src_ssi_irq_enable(mod);
417 static int rsnd_ssi_stop(struct rsnd_mod *mod,
418 struct rsnd_dai_stream *io,
419 struct rsnd_priv *priv)
421 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
423 rsnd_src_ssi_irq_disable(mod);
425 rsnd_ssi_record_error(ssi, rsnd_mod_read(mod, SSISR));
427 rsnd_ssi_hw_stop(io, ssi);
429 rsnd_src_ssiu_stop(mod, io);
434 static void __rsnd_ssi_interrupt(struct rsnd_mod *mod,
435 struct rsnd_dai_stream *io)
437 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
438 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
439 int is_dma = rsnd_ssi_is_dma_mode(mod);
441 bool elapsed = false;
443 spin_lock(&priv->lock);
445 /* ignore all cases if not working */
446 if (!rsnd_io_is_working(io))
447 goto rsnd_ssi_interrupt_out;
449 status = rsnd_mod_read(mod, SSISR);
452 if (!is_dma && (status & DIRQ)) {
453 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
454 u32 *buf = (u32 *)(runtime->dma_area +
455 rsnd_dai_pointer_offset(io, 0));
458 switch (runtime->sample_bits) {
465 * 8/16/32 data can be assesse to TDR/RDR register
466 * directly as 32bit data
467 * see rsnd_ssi_init()
469 if (rsnd_io_is_play(io))
470 rsnd_mod_write(mod, SSITDR, (*buf) << shift);
472 *buf = (rsnd_mod_read(mod, SSIRDR) >> shift);
474 elapsed = rsnd_dai_pointer_update(io, sizeof(*buf));
478 if (is_dma && (status & (UIRQ | OIRQ))) {
479 struct device *dev = rsnd_priv_to_dev(priv);
484 dev_dbg(dev, "%s[%d] restart\n",
485 rsnd_mod_name(mod), rsnd_mod_id(mod));
487 rsnd_ssi_stop(mod, io, priv);
489 rsnd_ssi_start(mod, io, priv);
491 dev_warn(dev, "no more SSI restart\n");
494 rsnd_ssi_record_error(ssi, status);
496 rsnd_ssi_interrupt_out:
497 spin_unlock(&priv->lock);
500 rsnd_dai_period_elapsed(io);
503 static irqreturn_t rsnd_ssi_interrupt(int irq, void *data)
505 struct rsnd_mod *mod = data;
507 rsnd_mod_interrupt(mod, __rsnd_ssi_interrupt);
515 static int rsnd_ssi_pio_probe(struct rsnd_mod *mod,
516 struct rsnd_dai_stream *io,
517 struct rsnd_priv *priv)
519 struct device *dev = rsnd_priv_to_dev(priv);
520 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
523 ret = devm_request_irq(dev, ssi->info->irq,
531 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
533 .probe = rsnd_ssi_pio_probe,
534 .init = rsnd_ssi_init,
535 .quit = rsnd_ssi_quit,
536 .start = rsnd_ssi_start,
537 .stop = rsnd_ssi_stop,
538 .hw_params = rsnd_ssi_hw_params,
541 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
542 struct rsnd_dai_stream *io,
543 struct rsnd_priv *priv)
545 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
546 struct device *dev = rsnd_priv_to_dev(priv);
547 int dma_id = ssi->info->dma_id;
550 ret = devm_request_irq(dev, ssi->info->irq,
558 io, rsnd_mod_to_dma(mod),
564 static int rsnd_ssi_dma_remove(struct rsnd_mod *mod,
565 struct rsnd_dai_stream *io,
566 struct rsnd_priv *priv)
568 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
569 struct rsnd_mod *pure_ssi_mod = rsnd_io_to_mod_ssi(io);
570 struct device *dev = rsnd_priv_to_dev(priv);
571 int irq = ssi->info->irq;
573 rsnd_dma_quit(io, rsnd_mod_to_dma(mod));
575 /* Do nothing if non SSI (= SSI parent, multi SSI) mod */
576 if (pure_ssi_mod != mod)
579 /* PIO will request IRQ again */
580 devm_free_irq(dev, irq, mod);
585 static int rsnd_ssi_fallback(struct rsnd_mod *mod,
586 struct rsnd_dai_stream *io,
587 struct rsnd_priv *priv)
589 struct device *dev = rsnd_priv_to_dev(priv);
594 * SSI .probe might be called again.
596 * rsnd_rdai_continuance_probe()
598 mod->ops = &rsnd_ssi_pio_ops;
600 dev_info(dev, "%s[%d] fallback to PIO mode\n",
601 rsnd_mod_name(mod), rsnd_mod_id(mod));
606 static int rsnd_ssi_dma_start(struct rsnd_mod *mod,
607 struct rsnd_dai_stream *io,
608 struct rsnd_priv *priv)
610 struct rsnd_dma *dma = rsnd_mod_to_dma(mod);
612 rsnd_dma_start(io, dma);
614 rsnd_ssi_start(mod, io, priv);
619 static int rsnd_ssi_dma_stop(struct rsnd_mod *mod,
620 struct rsnd_dai_stream *io,
621 struct rsnd_priv *priv)
623 struct rsnd_dma *dma = rsnd_mod_to_dma(mod);
625 rsnd_ssi_stop(mod, io, priv);
627 rsnd_dma_stop(io, dma);
632 static struct dma_chan *rsnd_ssi_dma_req(struct rsnd_dai_stream *io,
633 struct rsnd_mod *mod)
635 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
636 int is_play = rsnd_io_is_play(io);
639 if (rsnd_ssi_use_busif(io))
640 name = is_play ? "rxu" : "txu";
642 name = is_play ? "rx" : "tx";
644 return rsnd_dma_request_channel(rsnd_ssi_of_node(priv),
648 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
650 .dma_req = rsnd_ssi_dma_req,
651 .probe = rsnd_ssi_dma_probe,
652 .remove = rsnd_ssi_dma_remove,
653 .init = rsnd_ssi_init,
654 .quit = rsnd_ssi_quit,
655 .start = rsnd_ssi_dma_start,
656 .stop = rsnd_ssi_dma_stop,
657 .fallback = rsnd_ssi_fallback,
658 .hw_params = rsnd_ssi_hw_params,
661 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod)
663 return mod->ops == &rsnd_ssi_dma_ops;
670 static struct rsnd_mod_ops rsnd_ssi_non_ops = {
677 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
679 if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
682 return rsnd_mod_get((struct rsnd_ssi *)(priv->ssi) + id);
685 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
687 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
689 return !!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_CLK_PIN_SHARE);
692 static void rsnd_ssi_parent_setup(struct rsnd_priv *priv, struct rsnd_ssi *ssi)
694 struct rsnd_mod *mod = rsnd_mod_get(ssi);
696 if (!__rsnd_ssi_is_pin_sharing(mod))
699 switch (rsnd_mod_id(mod)) {
702 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 0));
705 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 3));
708 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 7));
714 static void rsnd_of_parse_ssi(struct platform_device *pdev,
715 const struct rsnd_of_data *of_data,
716 struct rsnd_priv *priv)
718 struct device_node *node;
719 struct device_node *np;
720 struct rsnd_ssi_platform_info *ssi_info;
721 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
722 struct device *dev = &pdev->dev;
725 node = rsnd_ssi_of_node(priv);
729 nr = of_get_child_count(node);
731 goto rsnd_of_parse_ssi_end;
733 ssi_info = devm_kzalloc(dev,
734 sizeof(struct rsnd_ssi_platform_info) * nr,
737 dev_err(dev, "ssi info allocation error\n");
738 goto rsnd_of_parse_ssi_end;
741 info->ssi_info = ssi_info;
742 info->ssi_info_nr = nr;
745 for_each_child_of_node(node, np) {
748 ssi_info = info->ssi_info + i;
753 if (of_get_property(np, "shared-pin", NULL))
754 ssi_info->flags |= RSND_SSI_CLK_PIN_SHARE;
759 ssi_info->irq = irq_of_parse_and_map(np, 0);
764 ssi_info->dma_id = of_get_property(np, "pio-transfer", NULL) ?
767 if (of_get_property(np, "no-busif", NULL))
768 ssi_info->flags |= RSND_SSI_NO_BUSIF;
771 rsnd_of_parse_ssi_end:
775 int rsnd_ssi_probe(struct platform_device *pdev,
776 const struct rsnd_of_data *of_data,
777 struct rsnd_priv *priv)
779 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
780 struct rsnd_ssi_platform_info *pinfo;
781 struct device *dev = rsnd_priv_to_dev(priv);
782 struct rsnd_mod_ops *ops;
784 struct rsnd_ssi *ssi;
785 char name[RSND_SSI_NAME_SIZE];
788 rsnd_of_parse_ssi(pdev, of_data, priv);
793 nr = info->ssi_info_nr;
794 ssi = devm_kzalloc(dev, sizeof(*ssi) * nr, GFP_KERNEL);
801 for_each_rsnd_ssi(ssi, priv, i) {
802 pinfo = &info->ssi_info[i];
804 snprintf(name, RSND_SSI_NAME_SIZE, "%s.%d",
807 clk = devm_clk_get(dev, name);
813 ops = &rsnd_ssi_non_ops;
814 if (pinfo->dma_id > 0)
815 ops = &rsnd_ssi_dma_ops;
816 else if (rsnd_ssi_pio_available(ssi))
817 ops = &rsnd_ssi_pio_ops;
819 ret = rsnd_mod_init(priv, rsnd_mod_get(ssi), ops, clk,
824 rsnd_ssi_parent_setup(priv, ssi);
830 void rsnd_ssi_remove(struct platform_device *pdev,
831 struct rsnd_priv *priv)
833 struct rsnd_ssi *ssi;
836 for_each_rsnd_ssi(ssi, priv, i) {
837 rsnd_mod_quit(rsnd_mod_get(ssi));