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"
64 struct rsnd_ssi_platform_info
*info
; /* rcar_snd.h */
65 struct rsnd_ssi
*parent
;
68 struct rsnd_dai
*rdai
;
76 #define for_each_rsnd_ssi(pos, priv, i) \
78 (i < rsnd_ssi_nr(priv)) && \
79 ((pos) = ((struct rsnd_ssi *)(priv)->ssi + i)); \
82 #define rsnd_ssi_nr(priv) ((priv)->ssi_nr)
83 #define rsnd_mod_to_ssi(_mod) container_of((_mod), struct rsnd_ssi, mod)
84 #define rsnd_dma_to_ssi(dma) rsnd_mod_to_ssi(rsnd_dma_to_mod(dma))
85 #define rsnd_ssi_pio_available(ssi) ((ssi)->info->pio_irq > 0)
86 #define rsnd_ssi_dma_available(ssi) \
87 rsnd_dma_available(rsnd_mod_to_dma(&(ssi)->mod))
88 #define rsnd_ssi_clk_from_parent(ssi) ((ssi)->parent)
89 #define rsnd_ssi_mode_flags(p) ((p)->info->flags)
90 #define rsnd_ssi_dai_id(ssi) ((ssi)->info->dai_id)
92 static int rsnd_ssi_use_busif(struct rsnd_mod
*mod
)
94 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
95 struct rsnd_dai_stream
*io
= rsnd_mod_to_io(mod
);
98 if (!rsnd_ssi_is_dma_mode(mod
))
101 if (!(rsnd_ssi_mode_flags(ssi
) & RSND_SSI_NO_BUSIF
))
103 if (rsnd_io_to_mod_src(io
))
109 static void rsnd_ssi_status_check(struct rsnd_mod
*mod
,
112 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
113 struct device
*dev
= rsnd_priv_to_dev(priv
);
117 for (i
= 0; i
< 1024; i
++) {
118 status
= rsnd_mod_read(mod
, SSISR
);
125 dev_warn(dev
, "status check failed\n");
128 static int rsnd_ssi_master_clk_start(struct rsnd_ssi
*ssi
,
129 struct rsnd_dai_stream
*io
)
131 struct rsnd_priv
*priv
= rsnd_mod_to_priv(&ssi
->mod
);
132 struct snd_pcm_runtime
*runtime
= rsnd_io_to_runtime(io
);
133 struct device
*dev
= rsnd_priv_to_dev(priv
);
135 int adg_clk_div_table
[] = {
136 1, 6, /* see adg.c */
138 int ssi_clk_mul_table
[] = {
139 1, 2, 4, 8, 16, 6, 12,
141 unsigned int main_rate
;
142 unsigned int rate
= rsnd_src_get_ssi_rate(priv
, io
, runtime
);
145 * Find best clock, and try to start ADG
147 for (i
= 0; i
< ARRAY_SIZE(adg_clk_div_table
); i
++) {
148 for (j
= 0; j
< ARRAY_SIZE(ssi_clk_mul_table
); j
++) {
151 * this driver is assuming that
152 * system word is 64fs (= 2 x 32bit)
153 * see rsnd_ssi_init()
155 main_rate
= rate
/ adg_clk_div_table
[i
]
156 * 32 * 2 * ssi_clk_mul_table
[j
];
158 ret
= rsnd_adg_ssi_clk_try_start(&ssi
->mod
, main_rate
);
161 ssi
->cr_clk
= FORCE
| SWL_32
|
162 SCKD
| SWSD
| CKDV(j
);
164 dev_dbg(dev
, "%s[%d] outputs %u Hz\n",
165 rsnd_mod_name(&ssi
->mod
),
166 rsnd_mod_id(&ssi
->mod
), rate
);
173 dev_err(dev
, "unsupported clock rate\n");
177 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi
*ssi
)
181 rsnd_adg_ssi_clk_stop(&ssi
->mod
);
184 static void rsnd_ssi_hw_start(struct rsnd_ssi
*ssi
,
185 struct rsnd_dai
*rdai
,
186 struct rsnd_dai_stream
*io
)
188 struct rsnd_priv
*priv
= rsnd_mod_to_priv(&ssi
->mod
);
189 struct device
*dev
= rsnd_priv_to_dev(priv
);
193 if (0 == ssi
->usrcnt
) {
194 clk_prepare_enable(ssi
->clk
);
196 if (rsnd_dai_is_clk_master(rdai
)) {
197 if (rsnd_ssi_clk_from_parent(ssi
))
198 rsnd_ssi_hw_start(ssi
->parent
, rdai
, io
);
200 rsnd_ssi_master_clk_start(ssi
, io
);
204 cr_mode
= rsnd_ssi_is_dma_mode(&ssi
->mod
) ?
205 DMEN
: /* DMA : use DMA */
206 UIEN
| OIEN
| DIEN
; /* PIO : enable interrupt */
214 rsnd_mod_write(&ssi
->mod
, SSICR
, cr
);
216 /* enable WS continue */
217 if (rsnd_dai_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
,
230 struct rsnd_dai
*rdai
)
232 struct rsnd_priv
*priv
= rsnd_mod_to_priv(&ssi
->mod
);
233 struct device
*dev
= rsnd_priv_to_dev(priv
);
236 if (0 == ssi
->usrcnt
) /* stop might be called without start */
241 if (0 == ssi
->usrcnt
) {
244 * and, wait all data was sent
249 rsnd_mod_write(&ssi
->mod
, SSICR
, cr
| EN
);
250 rsnd_ssi_status_check(&ssi
->mod
, DIRQ
);
254 * and, wait idle state
256 rsnd_mod_write(&ssi
->mod
, SSICR
, cr
); /* disabled all */
257 rsnd_ssi_status_check(&ssi
->mod
, IIRQ
);
259 if (rsnd_dai_is_clk_master(rdai
)) {
260 if (rsnd_ssi_clk_from_parent(ssi
))
261 rsnd_ssi_hw_stop(ssi
->parent
, rdai
);
263 rsnd_ssi_master_clk_stop(ssi
);
266 clk_disable_unprepare(ssi
->clk
);
269 dev_dbg(dev
, "%s[%d] hw stopped\n",
270 rsnd_mod_name(&ssi
->mod
), rsnd_mod_id(&ssi
->mod
));
274 * SSI mod common functions
276 static int rsnd_ssi_init(struct rsnd_mod
*mod
,
277 struct rsnd_dai
*rdai
)
279 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
280 struct rsnd_dai_stream
*io
= rsnd_mod_to_io(mod
);
281 struct snd_pcm_runtime
*runtime
= rsnd_io_to_runtime(io
);
287 * always use 32bit system word for easy clock calculation.
288 * see also rsnd_ssi_master_clk_enable()
293 * init clock settings for SSICR
295 switch (runtime
->sample_bits
) {
306 if (rdai
->bit_clk_inv
)
308 if (rdai
->frm_clk_inv
)
310 if (rdai
->data_alignment
)
314 if (rsnd_dai_is_play(rdai
, io
))
322 ssi
->err
= -1; /* ignore 1st error */
327 static int rsnd_ssi_quit(struct rsnd_mod
*mod
,
328 struct rsnd_dai
*rdai
)
330 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
331 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
332 struct device
*dev
= rsnd_priv_to_dev(priv
);
335 dev_warn(dev
, "ssi under/over flow err = %d\n", ssi
->err
);
344 static void rsnd_ssi_record_error(struct rsnd_ssi
*ssi
, u32 status
)
346 /* under/over flow error */
347 if (status
& (UIRQ
| OIRQ
)) {
350 /* clear error status */
351 rsnd_mod_write(&ssi
->mod
, SSISR
, 0);
358 static irqreturn_t
rsnd_ssi_pio_interrupt(int irq
, void *data
)
360 struct rsnd_ssi
*ssi
= data
;
361 struct rsnd_mod
*mod
= &ssi
->mod
;
362 struct rsnd_dai_stream
*io
= rsnd_mod_to_io(mod
);
363 u32 status
= rsnd_mod_read(mod
, SSISR
);
364 irqreturn_t ret
= IRQ_NONE
;
366 if (io
&& (status
& DIRQ
)) {
367 struct rsnd_dai
*rdai
= ssi
->rdai
;
368 struct snd_pcm_runtime
*runtime
= rsnd_io_to_runtime(io
);
369 u32
*buf
= (u32
*)(runtime
->dma_area
+
370 rsnd_dai_pointer_offset(io
, 0));
372 rsnd_ssi_record_error(ssi
, status
);
375 * 8/16/32 data can be assesse to TDR/RDR register
376 * directly as 32bit data
377 * see rsnd_ssi_init()
379 if (rsnd_dai_is_play(rdai
, io
))
380 rsnd_mod_write(mod
, SSITDR
, *buf
);
382 *buf
= rsnd_mod_read(mod
, SSIRDR
);
384 rsnd_dai_pointer_update(io
, sizeof(*buf
));
392 static int rsnd_ssi_pio_probe(struct rsnd_mod
*mod
,
393 struct rsnd_dai
*rdai
)
395 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
396 struct device
*dev
= rsnd_priv_to_dev(priv
);
397 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
398 int irq
= ssi
->info
->pio_irq
;
401 ret
= devm_request_irq(dev
, irq
,
402 rsnd_ssi_pio_interrupt
,
406 dev_err(dev
, "%s[%d] (PIO) request interrupt failed\n",
407 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
409 dev_dbg(dev
, "%s[%d] (PIO) is probed\n",
410 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
415 static int rsnd_ssi_pio_start(struct rsnd_mod
*mod
,
416 struct rsnd_dai
*rdai
)
418 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
419 struct rsnd_dai_stream
*io
= rsnd_mod_to_io(mod
);
421 rsnd_src_ssiu_start(mod
, rdai
, rsnd_ssi_use_busif(mod
));
423 rsnd_ssi_hw_start(ssi
, rdai
, io
);
425 rsnd_src_ssi_irq_enable(mod
, rdai
);
430 static int rsnd_ssi_pio_stop(struct rsnd_mod
*mod
,
431 struct rsnd_dai
*rdai
)
433 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
435 rsnd_src_ssi_irq_disable(mod
, rdai
);
437 rsnd_ssi_record_error(ssi
, rsnd_mod_read(mod
, SSISR
));
439 rsnd_ssi_hw_stop(ssi
, rdai
);
441 rsnd_src_ssiu_stop(mod
, rdai
);
446 static struct rsnd_mod_ops rsnd_ssi_pio_ops
= {
448 .probe
= rsnd_ssi_pio_probe
,
449 .init
= rsnd_ssi_init
,
450 .quit
= rsnd_ssi_quit
,
451 .start
= rsnd_ssi_pio_start
,
452 .stop
= rsnd_ssi_pio_stop
,
455 static int rsnd_ssi_dma_probe(struct rsnd_mod
*mod
,
456 struct rsnd_dai
*rdai
)
458 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
459 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
460 struct device
*dev
= rsnd_priv_to_dev(priv
);
461 int dma_id
= ssi
->info
->dma_id
;
465 priv
, rsnd_mod_to_dma(mod
),
466 rsnd_info_is_playback(priv
, ssi
),
470 dev_err(dev
, "%s[%d] (DMA) is failed\n",
471 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
473 dev_dbg(dev
, "%s[%d] (DMA) is probed\n",
474 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
479 static int rsnd_ssi_dma_remove(struct rsnd_mod
*mod
,
480 struct rsnd_dai
*rdai
)
482 rsnd_dma_quit(rsnd_mod_to_priv(mod
), rsnd_mod_to_dma(mod
));
487 static int rsnd_ssi_fallback(struct rsnd_mod
*mod
,
488 struct rsnd_dai
*rdai
)
490 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
491 struct device
*dev
= rsnd_priv_to_dev(priv
);
496 * SSI .probe might be called again.
498 * rsnd_rdai_continuance_probe()
500 mod
->ops
= &rsnd_ssi_pio_ops
;
502 dev_info(dev
, "%s[%d] fallback to PIO mode\n",
503 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
508 static int rsnd_ssi_dma_start(struct rsnd_mod
*mod
,
509 struct rsnd_dai
*rdai
)
511 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
512 struct rsnd_dma
*dma
= rsnd_mod_to_dma(&ssi
->mod
);
513 struct rsnd_dai_stream
*io
= rsnd_mod_to_io(mod
);
515 rsnd_src_ssiu_start(mod
, rdai
, rsnd_ssi_use_busif(mod
));
517 rsnd_ssi_hw_start(ssi
, ssi
->rdai
, io
);
524 static int rsnd_ssi_dma_stop(struct rsnd_mod
*mod
,
525 struct rsnd_dai
*rdai
)
527 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
528 struct rsnd_dma
*dma
= rsnd_mod_to_dma(&ssi
->mod
);
532 rsnd_ssi_record_error(ssi
, rsnd_mod_read(mod
, SSISR
));
534 rsnd_ssi_hw_stop(ssi
, rdai
);
536 rsnd_src_ssiu_stop(mod
, rdai
);
541 static char *rsnd_ssi_dma_name(struct rsnd_mod
*mod
)
543 return rsnd_ssi_use_busif(mod
) ? "ssiu" : SSI_NAME
;
546 static struct rsnd_mod_ops rsnd_ssi_dma_ops
= {
548 .dma_name
= rsnd_ssi_dma_name
,
549 .probe
= rsnd_ssi_dma_probe
,
550 .remove
= rsnd_ssi_dma_remove
,
551 .init
= rsnd_ssi_init
,
552 .quit
= rsnd_ssi_quit
,
553 .start
= rsnd_ssi_dma_start
,
554 .stop
= rsnd_ssi_dma_stop
,
555 .fallback
= rsnd_ssi_fallback
,
558 int rsnd_ssi_is_dma_mode(struct rsnd_mod
*mod
)
560 return mod
->ops
== &rsnd_ssi_dma_ops
;
567 static struct rsnd_mod_ops rsnd_ssi_non_ops
= {
574 struct rsnd_mod
*rsnd_ssi_mod_get(struct rsnd_priv
*priv
, int id
)
576 if (WARN_ON(id
< 0 || id
>= rsnd_ssi_nr(priv
)))
579 return &((struct rsnd_ssi
*)(priv
->ssi
) + id
)->mod
;
582 int rsnd_ssi_is_pin_sharing(struct rsnd_mod
*mod
)
584 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
586 return !!(rsnd_ssi_mode_flags(ssi
) & RSND_SSI_CLK_PIN_SHARE
);
589 static void rsnd_ssi_parent_clk_setup(struct rsnd_priv
*priv
, struct rsnd_ssi
*ssi
)
591 if (!rsnd_ssi_is_pin_sharing(&ssi
->mod
))
594 switch (rsnd_mod_id(&ssi
->mod
)) {
597 ssi
->parent
= rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv
, 0));
600 ssi
->parent
= rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv
, 3));
603 ssi
->parent
= rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv
, 7));
609 static void rsnd_of_parse_ssi(struct platform_device
*pdev
,
610 const struct rsnd_of_data
*of_data
,
611 struct rsnd_priv
*priv
)
613 struct device_node
*node
;
614 struct device_node
*np
;
615 struct rsnd_ssi_platform_info
*ssi_info
;
616 struct rcar_snd_info
*info
= rsnd_priv_to_info(priv
);
617 struct device
*dev
= &pdev
->dev
;
623 node
= of_get_child_by_name(dev
->of_node
, "rcar_sound,ssi");
627 nr
= of_get_child_count(node
);
629 goto rsnd_of_parse_ssi_end
;
631 ssi_info
= devm_kzalloc(dev
,
632 sizeof(struct rsnd_ssi_platform_info
) * nr
,
635 dev_err(dev
, "ssi info allocation error\n");
636 goto rsnd_of_parse_ssi_end
;
639 info
->ssi_info
= ssi_info
;
640 info
->ssi_info_nr
= nr
;
643 for_each_child_of_node(node
, np
) {
646 ssi_info
= info
->ssi_info
+ i
;
651 if (of_get_property(np
, "shared-pin", NULL
))
652 ssi_info
->flags
|= RSND_SSI_CLK_PIN_SHARE
;
657 ssi_info
->pio_irq
= irq_of_parse_and_map(np
, 0);
662 ssi_info
->dma_id
= of_get_property(np
, "pio-transfer", NULL
) ?
665 if (of_get_property(np
, "no-busif", NULL
))
666 ssi_info
->flags
|= RSND_SSI_NO_BUSIF
;
669 rsnd_of_parse_ssi_end
:
673 int rsnd_ssi_probe(struct platform_device
*pdev
,
674 const struct rsnd_of_data
*of_data
,
675 struct rsnd_priv
*priv
)
677 struct rcar_snd_info
*info
= rsnd_priv_to_info(priv
);
678 struct rsnd_ssi_platform_info
*pinfo
;
679 struct device
*dev
= rsnd_priv_to_dev(priv
);
680 struct rsnd_mod_ops
*ops
;
682 struct rsnd_ssi
*ssi
;
683 char name
[RSND_SSI_NAME_SIZE
];
686 rsnd_of_parse_ssi(pdev
, of_data
, priv
);
691 nr
= info
->ssi_info_nr
;
692 ssi
= devm_kzalloc(dev
, sizeof(*ssi
) * nr
, GFP_KERNEL
);
694 dev_err(dev
, "SSI allocate failed\n");
701 for_each_rsnd_ssi(ssi
, priv
, i
) {
702 pinfo
= &info
->ssi_info
[i
];
704 snprintf(name
, RSND_SSI_NAME_SIZE
, "%s.%d",
707 clk
= devm_clk_get(dev
, name
);
714 ops
= &rsnd_ssi_non_ops
;
715 if (pinfo
->dma_id
> 0)
716 ops
= &rsnd_ssi_dma_ops
;
717 else if (rsnd_ssi_pio_available(ssi
))
718 ops
= &rsnd_ssi_pio_ops
;
720 rsnd_mod_init(priv
, &ssi
->mod
, ops
, RSND_MOD_SSI
, i
);
722 rsnd_ssi_parent_clk_setup(priv
, ssi
);