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 */
62 struct rsnd_ssi_platform_info *info; /* rcar_snd.h */
63 struct rsnd_ssi *parent;
66 struct rsnd_dai *rdai;
67 struct rsnd_dai_stream *io;
85 #define for_each_rsnd_ssi(pos, priv, i) \
87 (i < rsnd_ssi_nr(priv)) && \
88 ((pos) = ((struct rsnd_ssiu *)((priv)->ssiu))->ssi + i); \
91 #define rsnd_ssi_nr(priv) (((struct rsnd_ssiu *)((priv)->ssiu))->ssi_nr)
92 #define rsnd_mod_to_ssi(_mod) container_of((_mod), struct rsnd_ssi, mod)
93 #define rsnd_dma_to_ssi(dma) rsnd_mod_to_ssi(rsnd_dma_to_mod(dma))
94 #define rsnd_ssi_pio_available(ssi) ((ssi)->info->pio_irq > 0)
95 #define rsnd_ssi_dma_available(ssi) \
96 rsnd_dma_available(rsnd_mod_to_dma(&(ssi)->mod))
97 #define rsnd_ssi_clk_from_parent(ssi) ((ssi)->parent)
98 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
99 #define rsnd_ssi_mode_flags(p) ((p)->info->flags)
100 #define rsnd_ssi_dai_id(ssi) ((ssi)->info->dai_id)
101 #define rsnd_ssi_to_ssiu(ssi)\
102 (((struct rsnd_ssiu *)((ssi) - rsnd_mod_id(&(ssi)->mod))) - 1)
104 static void rsnd_ssi_mode_set(struct rsnd_priv *priv,
105 struct rsnd_dai *rdai,
106 struct rsnd_ssi *ssi)
108 struct device *dev = rsnd_priv_to_dev(priv);
109 struct rsnd_mod *scu;
110 struct rsnd_ssiu *ssiu = rsnd_ssi_to_ssiu(ssi);
111 int id = rsnd_mod_id(&ssi->mod);
115 scu = rsnd_scu_mod_get(priv, rsnd_mod_id(&ssi->mod));
121 /* see also BUSIF_MODE */
122 if (rsnd_scu_hpbif_is_enable(scu)) {
123 ssiu->ssi_mode0 &= ~(1 << id);
124 dev_dbg(dev, "SSI%d uses DEPENDENT mode\n", id);
126 ssiu->ssi_mode0 |= (1 << id);
127 dev_dbg(dev, "SSI%d uses INDEPENDENT mode\n", id);
133 #define ssi_parent_set(p, sync, adg, ext) \
135 ssi->parent = ssiu->ssi + p; \
136 if (rsnd_rdai_is_clk_master(rdai)) \
140 if (flags & RSND_SSI_SYNC) \
144 flags = rsnd_ssi_mode_flags(ssi);
145 if (flags & RSND_SSI_CLK_PIN_SHARE) {
150 ssi_parent_set(0, (1 << 4), (0x2 << 0), (0x1 << 0));
153 ssi_parent_set(0, (1 << 4), (0x2 << 2), (0x1 << 2));
156 ssi_parent_set(3, (1 << 20), (0x2 << 16), (0x1 << 16));
159 ssi_parent_set(7, 0, 0, 0);
163 ssiu->ssi_mode1 |= val;
166 rsnd_mod_write(&ssi->mod, SSI_MODE0, ssiu->ssi_mode0);
167 rsnd_mod_write(&ssi->mod, SSI_MODE1, ssiu->ssi_mode1);
170 static void rsnd_ssi_status_check(struct rsnd_mod *mod,
173 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
174 struct device *dev = rsnd_priv_to_dev(priv);
178 for (i = 0; i < 1024; i++) {
179 status = rsnd_mod_read(mod, SSISR);
186 dev_warn(dev, "status check failed\n");
189 static int rsnd_ssi_master_clk_start(struct rsnd_ssi *ssi,
190 struct rsnd_dai_stream *io)
192 struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
193 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
194 struct device *dev = rsnd_priv_to_dev(priv);
196 int adg_clk_div_table[] = {
197 1, 6, /* see adg.c */
199 int ssi_clk_mul_table[] = {
200 1, 2, 4, 8, 16, 6, 12,
202 unsigned int main_rate;
203 unsigned int rate = rsnd_scu_get_ssi_rate(priv, &ssi->mod, runtime);
206 * Find best clock, and try to start ADG
208 for (i = 0; i < ARRAY_SIZE(adg_clk_div_table); i++) {
209 for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
212 * this driver is assuming that
213 * system word is 64fs (= 2 x 32bit)
214 * see rsnd_ssi_init()
216 main_rate = rate / adg_clk_div_table[i]
217 * 32 * 2 * ssi_clk_mul_table[j];
219 ret = rsnd_adg_ssi_clk_try_start(&ssi->mod, main_rate);
222 ssi->cr_clk = FORCE | SWL_32 |
223 SCKD | SWSD | CKDV(j);
225 dev_dbg(dev, "ssi%d outputs %u Hz\n",
226 rsnd_mod_id(&ssi->mod), rate);
233 dev_err(dev, "unsupported clock rate\n");
237 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi *ssi)
241 rsnd_adg_ssi_clk_stop(&ssi->mod);
244 static void rsnd_ssi_hw_start(struct rsnd_ssi *ssi,
245 struct rsnd_dai *rdai,
246 struct rsnd_dai_stream *io)
248 struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
249 struct device *dev = rsnd_priv_to_dev(priv);
252 if (0 == ssi->usrcnt) {
253 clk_enable(ssi->clk);
255 if (rsnd_rdai_is_clk_master(rdai)) {
256 if (rsnd_ssi_clk_from_parent(ssi))
257 rsnd_ssi_hw_start(ssi->parent, rdai, io);
259 rsnd_ssi_master_clk_start(ssi, io);
268 rsnd_mod_write(&ssi->mod, SSICR, cr);
272 dev_dbg(dev, "ssi%d hw started\n", rsnd_mod_id(&ssi->mod));
275 static void rsnd_ssi_hw_stop(struct rsnd_ssi *ssi,
276 struct rsnd_dai *rdai)
278 struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
279 struct device *dev = rsnd_priv_to_dev(priv);
282 if (0 == ssi->usrcnt) /* stop might be called without start */
287 if (0 == ssi->usrcnt) {
290 * and, wait all data was sent
295 rsnd_mod_write(&ssi->mod, SSICR, cr | EN);
296 rsnd_ssi_status_check(&ssi->mod, DIRQ);
300 * and, wait idle state
302 rsnd_mod_write(&ssi->mod, SSICR, cr); /* disabled all */
303 rsnd_ssi_status_check(&ssi->mod, IIRQ);
305 if (rsnd_rdai_is_clk_master(rdai)) {
306 if (rsnd_ssi_clk_from_parent(ssi))
307 rsnd_ssi_hw_stop(ssi->parent, rdai);
309 rsnd_ssi_master_clk_stop(ssi);
312 clk_disable(ssi->clk);
315 dev_dbg(dev, "ssi%d hw stopped\n", rsnd_mod_id(&ssi->mod));
319 * SSI mod common functions
321 static int rsnd_ssi_init(struct rsnd_mod *mod,
322 struct rsnd_dai *rdai,
323 struct rsnd_dai_stream *io)
325 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
326 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
327 struct device *dev = rsnd_priv_to_dev(priv);
328 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
334 * always use 32bit system word for easy clock calculation.
335 * see also rsnd_ssi_master_clk_enable()
340 * init clock settings for SSICR
342 switch (runtime->sample_bits) {
353 if (rdai->bit_clk_inv)
355 if (rdai->frm_clk_inv)
357 if (rdai->data_alignment)
361 if (rsnd_dai_is_play(rdai, io))
370 ssi->err = -1; /* ignore 1st error */
372 rsnd_ssi_mode_set(priv, rdai, ssi);
374 dev_dbg(dev, "%s.%d init\n", rsnd_mod_name(mod), rsnd_mod_id(mod));
379 static int rsnd_ssi_quit(struct rsnd_mod *mod,
380 struct rsnd_dai *rdai,
381 struct rsnd_dai_stream *io)
383 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
384 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
385 struct device *dev = rsnd_priv_to_dev(priv);
387 dev_dbg(dev, "%s.%d quit\n", rsnd_mod_name(mod), rsnd_mod_id(mod));
390 dev_warn(dev, "ssi under/over flow err = %d\n", ssi->err);
400 static void rsnd_ssi_record_error(struct rsnd_ssi *ssi, u32 status)
402 /* under/over flow error */
403 if (status & (UIRQ | OIRQ)) {
406 /* clear error status */
407 rsnd_mod_write(&ssi->mod, SSISR, 0);
414 static irqreturn_t rsnd_ssi_pio_interrupt(int irq, void *data)
416 struct rsnd_ssi *ssi = data;
417 struct rsnd_dai_stream *io = ssi->io;
418 u32 status = rsnd_mod_read(&ssi->mod, SSISR);
419 irqreturn_t ret = IRQ_NONE;
421 if (io && (status & DIRQ)) {
422 struct rsnd_dai *rdai = ssi->rdai;
423 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
424 u32 *buf = (u32 *)(runtime->dma_area +
425 rsnd_dai_pointer_offset(io, 0));
427 rsnd_ssi_record_error(ssi, status);
430 * 8/16/32 data can be assesse to TDR/RDR register
431 * directly as 32bit data
432 * see rsnd_ssi_init()
434 if (rsnd_dai_is_play(rdai, io))
435 rsnd_mod_write(&ssi->mod, SSITDR, *buf);
437 *buf = rsnd_mod_read(&ssi->mod, SSIRDR);
439 rsnd_dai_pointer_update(io, sizeof(*buf));
447 static int rsnd_ssi_pio_start(struct rsnd_mod *mod,
448 struct rsnd_dai *rdai,
449 struct rsnd_dai_stream *io)
451 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
452 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
453 struct device *dev = rsnd_priv_to_dev(priv);
456 ssi->cr_etc = UIEN | OIEN | DIEN;
458 /* enable PIO interrupt if gen2 */
459 if (rsnd_is_gen2(priv))
460 rsnd_mod_write(&ssi->mod, INT_ENABLE, 0x0f000000);
462 rsnd_ssi_hw_start(ssi, rdai, io);
464 dev_dbg(dev, "%s.%d start\n", rsnd_mod_name(mod), rsnd_mod_id(mod));
469 static int rsnd_ssi_pio_stop(struct rsnd_mod *mod,
470 struct rsnd_dai *rdai,
471 struct rsnd_dai_stream *io)
473 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
474 struct device *dev = rsnd_priv_to_dev(priv);
475 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
477 dev_dbg(dev, "%s.%d stop\n", rsnd_mod_name(mod), rsnd_mod_id(mod));
481 rsnd_ssi_hw_stop(ssi, rdai);
486 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
488 .init = rsnd_ssi_init,
489 .quit = rsnd_ssi_quit,
490 .start = rsnd_ssi_pio_start,
491 .stop = rsnd_ssi_pio_stop,
494 static int rsnd_ssi_dma_inquiry(struct rsnd_dma *dma, dma_addr_t *buf, int *len)
496 struct rsnd_ssi *ssi = rsnd_dma_to_ssi(dma);
497 struct rsnd_dai_stream *io = ssi->io;
498 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
500 *len = io->byte_per_period;
501 *buf = runtime->dma_addr +
502 rsnd_dai_pointer_offset(io, ssi->dma_offset + *len);
503 ssi->dma_offset = *len; /* it cares A/B plane */
508 static int rsnd_ssi_dma_complete(struct rsnd_dma *dma)
510 struct rsnd_ssi *ssi = rsnd_dma_to_ssi(dma);
511 struct rsnd_dai_stream *io = ssi->io;
512 u32 status = rsnd_mod_read(&ssi->mod, SSISR);
514 rsnd_ssi_record_error(ssi, status);
516 rsnd_dai_pointer_update(ssi->io, io->byte_per_period);
521 static int rsnd_ssi_dma_start(struct rsnd_mod *mod,
522 struct rsnd_dai *rdai,
523 struct rsnd_dai_stream *io)
525 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
526 struct rsnd_dma *dma = rsnd_mod_to_dma(&ssi->mod);
528 /* enable DMA transfer */
534 rsnd_ssi_hw_start(ssi, ssi->rdai, io);
536 /* enable WS continue */
537 if (rsnd_rdai_is_clk_master(rdai))
538 rsnd_mod_write(&ssi->mod, SSIWSR, CONT);
543 static int rsnd_ssi_dma_stop(struct rsnd_mod *mod,
544 struct rsnd_dai *rdai,
545 struct rsnd_dai_stream *io)
547 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
548 struct rsnd_dma *dma = rsnd_mod_to_dma(&ssi->mod);
552 rsnd_ssi_hw_stop(ssi, rdai);
559 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
561 .init = rsnd_ssi_init,
562 .quit = rsnd_ssi_quit,
563 .start = rsnd_ssi_dma_start,
564 .stop = rsnd_ssi_dma_stop,
570 static int rsnd_ssi_non(struct rsnd_mod *mod,
571 struct rsnd_dai *rdai,
572 struct rsnd_dai_stream *io)
574 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
575 struct device *dev = rsnd_priv_to_dev(priv);
577 dev_dbg(dev, "%s\n", __func__);
582 static struct rsnd_mod_ops rsnd_ssi_non_ops = {
584 .init = rsnd_ssi_non,
585 .quit = rsnd_ssi_non,
586 .start = rsnd_ssi_non,
587 .stop = rsnd_ssi_non,
593 struct rsnd_mod *rsnd_ssi_mod_get_frm_dai(struct rsnd_priv *priv,
594 int dai_id, int is_play)
596 struct rsnd_ssi *ssi;
601 for_each_rsnd_ssi(ssi, priv, i) {
602 if (rsnd_ssi_dai_id(ssi) != dai_id)
605 has_play = !!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_PLAY);
607 if (is_play == has_play)
614 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
616 if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
619 return &(((struct rsnd_ssiu *)(priv->ssiu))->ssi + id)->mod;
622 int rsnd_ssi_probe(struct platform_device *pdev,
623 struct rcar_snd_info *info,
624 struct rsnd_priv *priv)
626 struct rsnd_ssi_platform_info *pinfo;
627 struct device *dev = rsnd_priv_to_dev(priv);
628 struct rsnd_mod_ops *ops;
630 struct rsnd_ssiu *ssiu;
631 struct rsnd_ssi *ssi;
632 char name[RSND_SSI_NAME_SIZE];
638 nr = info->ssi_info_nr;
639 ssiu = devm_kzalloc(dev, sizeof(*ssiu) + (sizeof(*ssi) * nr),
642 dev_err(dev, "SSI allocate failed\n");
647 ssiu->ssi = (struct rsnd_ssi *)(ssiu + 1);
650 for_each_rsnd_ssi(ssi, priv, i) {
651 pinfo = &info->ssi_info[i];
653 snprintf(name, RSND_SSI_NAME_SIZE, "ssi.%d", i);
655 clk = devm_clk_get(dev, name);
662 ops = &rsnd_ssi_non_ops;
667 if (pinfo->dma_id > 0) {
669 priv, rsnd_mod_to_dma(&ssi->mod),
670 (rsnd_ssi_mode_flags(ssi) & RSND_SSI_PLAY),
672 rsnd_ssi_dma_inquiry,
673 rsnd_ssi_dma_complete);
675 dev_info(dev, "SSI DMA failed. try PIO transter\n");
677 ops = &rsnd_ssi_dma_ops;
679 dev_dbg(dev, "SSI%d use DMA transfer\n", i);
685 if (!rsnd_ssi_dma_available(ssi) &&
686 rsnd_ssi_pio_available(ssi)) {
687 ret = devm_request_irq(dev, pinfo->pio_irq,
688 &rsnd_ssi_pio_interrupt,
692 dev_err(dev, "SSI request interrupt failed\n");
696 ops = &rsnd_ssi_pio_ops;
698 dev_dbg(dev, "SSI%d use PIO transfer\n", i);
701 rsnd_mod_init(priv, &ssi->mod, ops, i);
704 dev_dbg(dev, "ssi probed\n");
709 void rsnd_ssi_remove(struct platform_device *pdev,
710 struct rsnd_priv *priv)
712 struct rsnd_ssi *ssi;
715 for_each_rsnd_ssi(ssi, priv, i) {
716 if (rsnd_ssi_dma_available(ssi))
717 rsnd_dma_quit(priv, rsnd_mod_to_dma(&ssi->mod));