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;
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_dma_to_ssi(dma) rsnd_mod_to_ssi(rsnd_dma_to_mod(dma))
84 #define rsnd_ssi_pio_available(ssi) ((ssi)->info->pio_irq > 0)
85 #define rsnd_ssi_dma_available(ssi) \
86 rsnd_dma_available(rsnd_mod_to_dma(&(ssi)->mod))
87 #define rsnd_ssi_clk_from_parent(ssi) ((ssi)->parent)
88 #define rsnd_ssi_mode_flags(p) ((p)->info->flags)
89 #define rsnd_ssi_dai_id(ssi) ((ssi)->info->dai_id)
91 static void rsnd_ssi_status_check(struct rsnd_mod *mod,
94 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
95 struct device *dev = rsnd_priv_to_dev(priv);
99 for (i = 0; i < 1024; i++) {
100 status = rsnd_mod_read(mod, SSISR);
107 dev_warn(dev, "status check failed\n");
110 static int rsnd_ssi_master_clk_start(struct rsnd_ssi *ssi,
111 struct rsnd_dai_stream *io)
113 struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
114 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
115 struct device *dev = rsnd_priv_to_dev(priv);
117 int adg_clk_div_table[] = {
118 1, 6, /* see adg.c */
120 int ssi_clk_mul_table[] = {
121 1, 2, 4, 8, 16, 6, 12,
123 unsigned int main_rate;
124 unsigned int rate = rsnd_src_get_ssi_rate(priv, io, runtime);
127 * Find best clock, and try to start ADG
129 for (i = 0; i < ARRAY_SIZE(adg_clk_div_table); i++) {
130 for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
133 * this driver is assuming that
134 * system word is 64fs (= 2 x 32bit)
135 * see rsnd_ssi_init()
137 main_rate = rate / adg_clk_div_table[i]
138 * 32 * 2 * ssi_clk_mul_table[j];
140 ret = rsnd_adg_ssi_clk_try_start(&ssi->mod, main_rate);
143 ssi->cr_clk = FORCE | SWL_32 |
144 SCKD | SWSD | CKDV(j);
146 dev_dbg(dev, "ssi%d outputs %u Hz\n",
147 rsnd_mod_id(&ssi->mod), rate);
154 dev_err(dev, "unsupported clock rate\n");
158 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi *ssi)
162 rsnd_adg_ssi_clk_stop(&ssi->mod);
165 static void rsnd_ssi_hw_start(struct rsnd_ssi *ssi,
166 struct rsnd_dai *rdai,
167 struct rsnd_dai_stream *io)
169 struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
170 struct device *dev = rsnd_priv_to_dev(priv);
173 if (0 == ssi->usrcnt) {
174 clk_prepare_enable(ssi->clk);
176 if (rsnd_dai_is_clk_master(rdai)) {
177 if (rsnd_ssi_clk_from_parent(ssi))
178 rsnd_ssi_hw_start(ssi->parent, rdai, io);
180 rsnd_ssi_master_clk_start(ssi, io);
189 rsnd_mod_write(&ssi->mod, SSICR, cr);
193 dev_dbg(dev, "ssi%d hw started\n", rsnd_mod_id(&ssi->mod));
196 static void rsnd_ssi_hw_stop(struct rsnd_ssi *ssi,
197 struct rsnd_dai *rdai)
199 struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
200 struct device *dev = rsnd_priv_to_dev(priv);
203 if (0 == ssi->usrcnt) /* stop might be called without start */
208 if (0 == ssi->usrcnt) {
211 * and, wait all data was sent
216 rsnd_mod_write(&ssi->mod, SSICR, cr | EN);
217 rsnd_ssi_status_check(&ssi->mod, DIRQ);
221 * and, wait idle state
223 rsnd_mod_write(&ssi->mod, SSICR, cr); /* disabled all */
224 rsnd_ssi_status_check(&ssi->mod, IIRQ);
226 if (rsnd_dai_is_clk_master(rdai)) {
227 if (rsnd_ssi_clk_from_parent(ssi))
228 rsnd_ssi_hw_stop(ssi->parent, rdai);
230 rsnd_ssi_master_clk_stop(ssi);
233 clk_disable_unprepare(ssi->clk);
236 dev_dbg(dev, "ssi%d hw stopped\n", rsnd_mod_id(&ssi->mod));
240 * SSI mod common functions
242 static int rsnd_ssi_init(struct rsnd_mod *mod,
243 struct rsnd_dai *rdai)
245 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
246 struct rsnd_dai_stream *io = rsnd_mod_to_io(mod);
247 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
253 * always use 32bit system word for easy clock calculation.
254 * see also rsnd_ssi_master_clk_enable()
259 * init clock settings for SSICR
261 switch (runtime->sample_bits) {
272 if (rdai->bit_clk_inv)
274 if (rdai->frm_clk_inv)
276 if (rdai->data_alignment)
280 if (rsnd_dai_is_play(rdai, io))
288 ssi->err = -1; /* ignore 1st error */
290 rsnd_src_ssi_mode_init(mod, rdai);
295 static int rsnd_ssi_quit(struct rsnd_mod *mod,
296 struct rsnd_dai *rdai)
298 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
299 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
300 struct device *dev = rsnd_priv_to_dev(priv);
303 dev_warn(dev, "ssi under/over flow err = %d\n", ssi->err);
312 static void rsnd_ssi_record_error(struct rsnd_ssi *ssi, u32 status)
314 /* under/over flow error */
315 if (status & (UIRQ | OIRQ)) {
318 /* clear error status */
319 rsnd_mod_write(&ssi->mod, SSISR, 0);
326 static irqreturn_t rsnd_ssi_pio_interrupt(int irq, void *data)
328 struct rsnd_ssi *ssi = data;
329 struct rsnd_mod *mod = &ssi->mod;
330 struct rsnd_dai_stream *io = rsnd_mod_to_io(mod);
331 u32 status = rsnd_mod_read(mod, SSISR);
332 irqreturn_t ret = IRQ_NONE;
334 if (io && (status & DIRQ)) {
335 struct rsnd_dai *rdai = ssi->rdai;
336 struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
337 u32 *buf = (u32 *)(runtime->dma_area +
338 rsnd_dai_pointer_offset(io, 0));
340 rsnd_ssi_record_error(ssi, status);
343 * 8/16/32 data can be assesse to TDR/RDR register
344 * directly as 32bit data
345 * see rsnd_ssi_init()
347 if (rsnd_dai_is_play(rdai, io))
348 rsnd_mod_write(mod, SSITDR, *buf);
350 *buf = rsnd_mod_read(mod, SSIRDR);
352 rsnd_dai_pointer_update(io, sizeof(*buf));
360 static int rsnd_ssi_pio_probe(struct rsnd_mod *mod,
361 struct rsnd_dai *rdai)
363 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
364 struct device *dev = rsnd_priv_to_dev(priv);
365 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
366 int irq = ssi->info->pio_irq;
369 ret = devm_request_irq(dev, irq,
370 rsnd_ssi_pio_interrupt,
374 dev_err(dev, "SSI request interrupt failed\n");
379 static int rsnd_ssi_pio_start(struct rsnd_mod *mod,
380 struct rsnd_dai *rdai)
382 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
383 struct rsnd_dai_stream *io = rsnd_mod_to_io(mod);
386 ssi->cr_etc = UIEN | OIEN | DIEN;
388 rsnd_src_enable_ssi_irq(mod, rdai);
390 rsnd_ssi_hw_start(ssi, rdai, io);
395 static int rsnd_ssi_pio_stop(struct rsnd_mod *mod,
396 struct rsnd_dai *rdai)
398 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
402 rsnd_ssi_hw_stop(ssi, rdai);
407 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
409 .probe = rsnd_ssi_pio_probe,
410 .init = rsnd_ssi_init,
411 .quit = rsnd_ssi_quit,
412 .start = rsnd_ssi_pio_start,
413 .stop = rsnd_ssi_pio_stop,
416 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
417 struct rsnd_dai *rdai)
419 struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
420 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
421 struct device *dev = rsnd_priv_to_dev(priv);
422 int dma_id = ssi->info->dma_id;
426 priv, rsnd_mod_to_dma(mod),
427 rsnd_info_is_playback(priv, ssi),
431 dev_err(dev, "SSI DMA failed\n");
436 static int rsnd_ssi_dma_remove(struct rsnd_mod *mod,
437 struct rsnd_dai *rdai)
439 rsnd_dma_quit(rsnd_mod_to_priv(mod), rsnd_mod_to_dma(mod));
444 static int rsnd_ssi_dma_start(struct rsnd_mod *mod,
445 struct rsnd_dai *rdai)
447 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
448 struct rsnd_dma *dma = rsnd_mod_to_dma(&ssi->mod);
449 struct rsnd_dai_stream *io = rsnd_mod_to_io(mod);
451 /* enable DMA transfer */
456 rsnd_ssi_hw_start(ssi, ssi->rdai, io);
458 /* enable WS continue */
459 if (rsnd_dai_is_clk_master(rdai))
460 rsnd_mod_write(&ssi->mod, SSIWSR, CONT);
465 static int rsnd_ssi_dma_stop(struct rsnd_mod *mod,
466 struct rsnd_dai *rdai)
468 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
469 struct rsnd_dma *dma = rsnd_mod_to_dma(&ssi->mod);
473 rsnd_ssi_record_error(ssi, rsnd_mod_read(mod, SSISR));
475 rsnd_ssi_hw_stop(ssi, rdai);
482 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
484 .probe = rsnd_ssi_dma_probe,
485 .remove = rsnd_ssi_dma_remove,
486 .init = rsnd_ssi_init,
487 .quit = rsnd_ssi_quit,
488 .start = rsnd_ssi_dma_start,
489 .stop = rsnd_ssi_dma_stop,
495 static struct rsnd_mod_ops rsnd_ssi_non_ops = {
502 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
504 if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
507 return &((struct rsnd_ssi *)(priv->ssi) + id)->mod;
510 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
512 struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
514 return !!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_CLK_PIN_SHARE);
517 static void rsnd_ssi_parent_clk_setup(struct rsnd_priv *priv, struct rsnd_ssi *ssi)
519 if (!rsnd_ssi_is_pin_sharing(&ssi->mod))
522 switch (rsnd_mod_id(&ssi->mod)) {
525 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 0));
528 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 3));
531 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 7));
537 static void rsnd_of_parse_ssi(struct platform_device *pdev,
538 const struct rsnd_of_data *of_data,
539 struct rsnd_priv *priv)
541 struct device_node *node;
542 struct device_node *np;
543 struct rsnd_ssi_platform_info *ssi_info;
544 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
545 struct device *dev = &pdev->dev;
551 node = of_get_child_by_name(dev->of_node, "rcar_sound,ssi");
555 nr = of_get_child_count(node);
559 ssi_info = devm_kzalloc(dev,
560 sizeof(struct rsnd_ssi_platform_info) * nr,
563 dev_err(dev, "ssi info allocation error\n");
567 info->ssi_info = ssi_info;
568 info->ssi_info_nr = nr;
571 for_each_child_of_node(node, np) {
574 ssi_info = info->ssi_info + i;
579 if (of_get_property(np, "shared-pin", NULL))
580 ssi_info->flags |= RSND_SSI_CLK_PIN_SHARE;
585 ssi_info->pio_irq = irq_of_parse_and_map(np, 0);
589 int rsnd_ssi_probe(struct platform_device *pdev,
590 const struct rsnd_of_data *of_data,
591 struct rsnd_priv *priv)
593 struct rcar_snd_info *info = rsnd_priv_to_info(priv);
594 struct rsnd_ssi_platform_info *pinfo;
595 struct device *dev = rsnd_priv_to_dev(priv);
596 struct rsnd_mod_ops *ops;
598 struct rsnd_ssi *ssi;
599 char name[RSND_SSI_NAME_SIZE];
602 rsnd_of_parse_ssi(pdev, of_data, priv);
607 nr = info->ssi_info_nr;
608 ssi = devm_kzalloc(dev, sizeof(*ssi) * nr, GFP_KERNEL);
610 dev_err(dev, "SSI allocate failed\n");
617 for_each_rsnd_ssi(ssi, priv, i) {
618 pinfo = &info->ssi_info[i];
620 snprintf(name, RSND_SSI_NAME_SIZE, "ssi.%d", i);
622 clk = devm_clk_get(dev, name);
629 ops = &rsnd_ssi_non_ops;
630 if (pinfo->dma_id > 0)
631 ops = &rsnd_ssi_dma_ops;
632 else if (rsnd_ssi_pio_available(ssi))
633 ops = &rsnd_ssi_pio_ops;
635 rsnd_mod_init(priv, &ssi->mod, ops, RSND_MOD_SSI, i);
637 rsnd_ssi_parent_clk_setup(priv, ssi);