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;
73 #define for_each_rsnd_ssi(pos, priv, i) \
75 (i < rsnd_ssi_nr(priv)) && \
76 ((pos) = ((struct rsnd_ssi *)(priv)->ssi + i)); \
79 #define rsnd_ssi_nr(priv) ((priv)->ssi_nr)
80 #define rsnd_mod_to_ssi(_mod) container_of((_mod), struct rsnd_ssi, mod)
81 #define rsnd_dma_to_ssi(dma) rsnd_mod_to_ssi(rsnd_dma_to_mod(dma))
82 #define rsnd_ssi_pio_available(ssi) ((ssi)->info->irq > 0)
83 #define rsnd_ssi_dma_available(ssi) \
84 rsnd_dma_available(rsnd_mod_to_dma(&(ssi)->mod))
85 #define rsnd_ssi_clk_from_parent(ssi) ((ssi)->parent)
86 #define rsnd_ssi_mode_flags(p) ((p)->info->flags)
87 #define rsnd_ssi_dai_id(ssi) ((ssi)->info->dai_id)
89 static int rsnd_ssi_use_busif(struct rsnd_mod *mod)
91 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
92 struct rsnd_dai_stream *io = rsnd_mod_to_io(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 if (rsnd_ssi_clk_from_parent(ssi))
193 rsnd_ssi_hw_start(ssi->parent, io);
195 rsnd_ssi_master_clk_start(ssi, io);
199 cr_mode = rsnd_ssi_is_dma_mode(&ssi->mod) ?
200 DMEN : /* DMA : enable DMA */
201 DIEN; /* PIO : enable Data interrupt */
209 rsnd_mod_write(&ssi->mod, SSICR, cr);
211 /* enable WS continue */
212 if (rsnd_rdai_is_clk_master(rdai))
213 rsnd_mod_write(&ssi->mod, SSIWSR, CONT);
215 /* clear error status */
216 rsnd_mod_write(&ssi->mod, SSISR, 0);
220 dev_dbg(dev, "%s[%d] hw started\n",
221 rsnd_mod_name(&ssi->mod), rsnd_mod_id(&ssi->mod));
224 static void rsnd_ssi_hw_stop(struct rsnd_ssi *ssi)
226 struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
227 struct rsnd_dai_stream *io = rsnd_mod_to_io(&ssi->mod);
228 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
229 struct device *dev = rsnd_priv_to_dev(priv);
232 if (0 == ssi->usrcnt) /* stop might be called without start */
237 if (0 == ssi->usrcnt) {
240 * and, wait all data was sent
245 rsnd_mod_write(&ssi->mod, SSICR, cr | EN);
246 rsnd_ssi_status_check(&ssi->mod, DIRQ);
250 * and, wait idle state
252 rsnd_mod_write(&ssi->mod, SSICR, cr); /* disabled all */
253 rsnd_ssi_status_check(&ssi->mod, IIRQ);
255 if (rsnd_rdai_is_clk_master(rdai)) {
256 if (rsnd_ssi_clk_from_parent(ssi))
257 rsnd_ssi_hw_stop(ssi->parent);
259 rsnd_ssi_master_clk_stop(ssi);
262 rsnd_mod_hw_stop(&ssi->mod);
265 dev_dbg(dev, "%s[%d] hw stopped\n",
266 rsnd_mod_name(&ssi->mod), rsnd_mod_id(&ssi->mod));
270 * SSI mod common functions
272 static int rsnd_ssi_init(struct rsnd_mod *mod,
273 struct rsnd_priv *priv)
275 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
276 struct rsnd_dai_stream *io = rsnd_mod_to_io(mod);
277 struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
278 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
284 * always use 32bit system word for easy clock calculation.
285 * see also rsnd_ssi_master_clk_enable()
290 * init clock settings for SSICR
292 switch (runtime->sample_bits) {
303 if (rdai->bit_clk_inv)
305 if (rdai->frm_clk_inv)
307 if (rdai->data_alignment)
311 if (rsnd_io_is_play(io))
318 ssi->err = -1; /* ignore 1st error */
323 static int rsnd_ssi_quit(struct rsnd_mod *mod,
324 struct rsnd_priv *priv)
326 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
327 struct device *dev = rsnd_priv_to_dev(priv);
330 dev_warn(dev, "%s[%d] under/over flow err = %d\n",
331 rsnd_mod_name(mod), rsnd_mod_id(mod), ssi->err);
339 static void rsnd_ssi_record_error(struct rsnd_ssi *ssi, u32 status)
341 /* under/over flow error */
342 if (status & (UIRQ | OIRQ)) {
345 /* clear error status */
346 rsnd_mod_write(&ssi->mod, SSISR, 0);
350 static int rsnd_ssi_start(struct rsnd_mod *mod,
351 struct rsnd_priv *priv)
353 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
354 struct rsnd_dai_stream *io = rsnd_mod_to_io(mod);
356 rsnd_src_ssiu_start(mod, rsnd_ssi_use_busif(mod));
358 rsnd_ssi_hw_start(ssi, io);
360 rsnd_src_ssi_irq_enable(mod);
365 static int rsnd_ssi_stop(struct rsnd_mod *mod,
366 struct rsnd_priv *priv)
368 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
370 rsnd_src_ssi_irq_disable(mod);
372 rsnd_ssi_record_error(ssi, rsnd_mod_read(mod, SSISR));
374 rsnd_ssi_hw_stop(ssi);
376 rsnd_src_ssiu_stop(mod);
381 static irqreturn_t rsnd_ssi_interrupt(int irq, void *data)
383 struct rsnd_ssi *ssi = data;
384 struct rsnd_mod *mod = &ssi->mod;
385 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
386 struct rsnd_dai_stream *io = rsnd_mod_to_io(mod);
387 int is_dma = rsnd_ssi_is_dma_mode(mod);
388 u32 status = rsnd_mod_read(mod, SSISR);
394 if (!is_dma && (status & DIRQ)) {
395 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
396 u32 *buf = (u32 *)(runtime->dma_area +
397 rsnd_dai_pointer_offset(io, 0));
400 * 8/16/32 data can be assesse to TDR/RDR register
401 * directly as 32bit data
402 * see rsnd_ssi_init()
404 if (rsnd_io_is_play(io))
405 rsnd_mod_write(mod, SSITDR, *buf);
407 *buf = rsnd_mod_read(mod, SSIRDR);
409 rsnd_dai_pointer_update(io, sizeof(*buf));
413 if (status & (UIRQ | OIRQ)) {
414 struct device *dev = rsnd_priv_to_dev(priv);
419 rsnd_ssi_stop(mod, priv);
420 rsnd_ssi_start(mod, priv);
422 dev_dbg(dev, "%s[%d] restart\n",
423 rsnd_mod_name(mod), rsnd_mod_id(mod));
426 rsnd_ssi_record_error(ssi, status);
434 static int rsnd_ssi_pio_probe(struct rsnd_mod *mod,
435 struct rsnd_priv *priv)
437 struct device *dev = rsnd_priv_to_dev(priv);
438 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
441 ret = devm_request_irq(dev, ssi->info->irq,
446 dev_err(dev, "%s[%d] (PIO) request interrupt failed\n",
447 rsnd_mod_name(mod), rsnd_mod_id(mod));
449 dev_dbg(dev, "%s[%d] (PIO) is probed\n",
450 rsnd_mod_name(mod), rsnd_mod_id(mod));
455 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
457 .probe = rsnd_ssi_pio_probe,
458 .init = rsnd_ssi_init,
459 .quit = rsnd_ssi_quit,
460 .start = rsnd_ssi_start,
461 .stop = rsnd_ssi_stop,
464 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
465 struct rsnd_priv *priv)
467 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
468 struct device *dev = rsnd_priv_to_dev(priv);
469 int dma_id = ssi->info->dma_id;
472 ret = devm_request_irq(dev, ssi->info->irq,
477 goto rsnd_ssi_dma_probe_fail;
480 priv, rsnd_mod_to_dma(mod),
481 rsnd_info_is_playback(priv, ssi),
484 goto rsnd_ssi_dma_probe_fail;
486 dev_dbg(dev, "%s[%d] (DMA) is probed\n",
487 rsnd_mod_name(mod), rsnd_mod_id(mod));
491 rsnd_ssi_dma_probe_fail:
492 dev_err(dev, "%s[%d] (DMA) is failed\n",
493 rsnd_mod_name(mod), rsnd_mod_id(mod));
498 static int rsnd_ssi_dma_remove(struct rsnd_mod *mod,
499 struct rsnd_priv *priv)
501 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
502 struct device *dev = rsnd_priv_to_dev(priv);
503 int irq = ssi->info->irq;
505 rsnd_dma_quit(priv, rsnd_mod_to_dma(mod));
507 /* PIO will request IRQ again */
508 devm_free_irq(dev, irq, ssi);
513 static int rsnd_ssi_fallback(struct rsnd_mod *mod,
514 struct rsnd_priv *priv)
516 struct device *dev = rsnd_priv_to_dev(priv);
521 * SSI .probe might be called again.
523 * rsnd_rdai_continuance_probe()
525 mod->ops = &rsnd_ssi_pio_ops;
527 dev_info(dev, "%s[%d] fallback to PIO mode\n",
528 rsnd_mod_name(mod), rsnd_mod_id(mod));
533 static int rsnd_ssi_dma_start(struct rsnd_mod *mod,
534 struct rsnd_priv *priv)
536 struct rsnd_dma *dma = rsnd_mod_to_dma(mod);
540 rsnd_ssi_start(mod, priv);
545 static int rsnd_ssi_dma_stop(struct rsnd_mod *mod,
546 struct rsnd_priv *priv)
548 struct rsnd_dma *dma = rsnd_mod_to_dma(mod);
550 rsnd_ssi_stop(mod, priv);
557 static char *rsnd_ssi_dma_name(struct rsnd_mod *mod)
559 return rsnd_ssi_use_busif(mod) ? "ssiu" : SSI_NAME;
562 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
564 .dma_name = rsnd_ssi_dma_name,
565 .probe = rsnd_ssi_dma_probe,
566 .remove = rsnd_ssi_dma_remove,
567 .init = rsnd_ssi_init,
568 .quit = rsnd_ssi_quit,
569 .start = rsnd_ssi_dma_start,
570 .stop = rsnd_ssi_dma_stop,
571 .fallback = rsnd_ssi_fallback,
574 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod)
576 return mod->ops == &rsnd_ssi_dma_ops;
583 static struct rsnd_mod_ops rsnd_ssi_non_ops = {
590 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
592 if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
595 return &((struct rsnd_ssi *)(priv->ssi) + id)->mod;
598 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
600 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
602 return !!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_CLK_PIN_SHARE);
605 static void rsnd_ssi_parent_clk_setup(struct rsnd_priv *priv, struct rsnd_ssi *ssi)
607 if (!rsnd_ssi_is_pin_sharing(&ssi->mod))
610 switch (rsnd_mod_id(&ssi->mod)) {
613 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 0));
616 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 3));
619 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 7));
625 static void rsnd_of_parse_ssi(struct platform_device *pdev,
626 const struct rsnd_of_data *of_data,
627 struct rsnd_priv *priv)
629 struct device_node *node;
630 struct device_node *np;
631 struct rsnd_ssi_platform_info *ssi_info;
632 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
633 struct device *dev = &pdev->dev;
639 node = of_get_child_by_name(dev->of_node, "rcar_sound,ssi");
643 nr = of_get_child_count(node);
645 goto rsnd_of_parse_ssi_end;
647 ssi_info = devm_kzalloc(dev,
648 sizeof(struct rsnd_ssi_platform_info) * nr,
651 dev_err(dev, "ssi info allocation error\n");
652 goto rsnd_of_parse_ssi_end;
655 info->ssi_info = ssi_info;
656 info->ssi_info_nr = nr;
659 for_each_child_of_node(node, np) {
662 ssi_info = info->ssi_info + i;
667 if (of_get_property(np, "shared-pin", NULL))
668 ssi_info->flags |= RSND_SSI_CLK_PIN_SHARE;
673 ssi_info->irq = irq_of_parse_and_map(np, 0);
678 ssi_info->dma_id = of_get_property(np, "pio-transfer", NULL) ?
681 if (of_get_property(np, "no-busif", NULL))
682 ssi_info->flags |= RSND_SSI_NO_BUSIF;
685 rsnd_of_parse_ssi_end:
689 int rsnd_ssi_probe(struct platform_device *pdev,
690 const struct rsnd_of_data *of_data,
691 struct rsnd_priv *priv)
693 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
694 struct rsnd_ssi_platform_info *pinfo;
695 struct device *dev = rsnd_priv_to_dev(priv);
696 struct rsnd_mod_ops *ops;
698 struct rsnd_ssi *ssi;
699 char name[RSND_SSI_NAME_SIZE];
702 rsnd_of_parse_ssi(pdev, of_data, priv);
707 nr = info->ssi_info_nr;
708 ssi = devm_kzalloc(dev, sizeof(*ssi) * nr, GFP_KERNEL);
710 dev_err(dev, "SSI allocate failed\n");
717 for_each_rsnd_ssi(ssi, priv, i) {
718 pinfo = &info->ssi_info[i];
720 snprintf(name, RSND_SSI_NAME_SIZE, "%s.%d",
723 clk = devm_clk_get(dev, name);
729 ops = &rsnd_ssi_non_ops;
730 if (pinfo->dma_id > 0)
731 ops = &rsnd_ssi_dma_ops;
732 else if (rsnd_ssi_pio_available(ssi))
733 ops = &rsnd_ssi_pio_ops;
735 rsnd_mod_init(&ssi->mod, ops, clk, RSND_MOD_SSI, i);
737 rsnd_ssi_parent_clk_setup(priv, ssi);