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_clk_from_parent(ssi) ((ssi)->parent)
84 #define rsnd_ssi_mode_flags(p) ((p)->info->flags)
85 #define rsnd_ssi_dai_id(ssi) ((ssi)->info->dai_id)
87 static int rsnd_ssi_use_busif(struct rsnd_mod
*mod
)
89 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
90 struct rsnd_dai_stream
*io
= rsnd_mod_to_io(mod
);
93 if (!rsnd_ssi_is_dma_mode(mod
))
96 if (!(rsnd_ssi_mode_flags(ssi
) & RSND_SSI_NO_BUSIF
))
98 if (rsnd_io_to_mod_src(io
))
104 static void rsnd_ssi_status_check(struct rsnd_mod
*mod
,
107 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
108 struct device
*dev
= rsnd_priv_to_dev(priv
);
112 for (i
= 0; i
< 1024; i
++) {
113 status
= rsnd_mod_read(mod
, SSISR
);
120 dev_warn(dev
, "status check failed\n");
123 static int rsnd_ssi_master_clk_start(struct rsnd_ssi
*ssi
,
124 struct rsnd_dai_stream
*io
)
126 struct rsnd_priv
*priv
= rsnd_io_to_priv(io
);
127 struct snd_pcm_runtime
*runtime
= rsnd_io_to_runtime(io
);
128 struct device
*dev
= rsnd_priv_to_dev(priv
);
130 int adg_clk_div_table
[] = {
131 1, 6, /* see adg.c */
133 int ssi_clk_mul_table
[] = {
134 1, 2, 4, 8, 16, 6, 12,
136 unsigned int main_rate
;
137 unsigned int rate
= rsnd_src_get_ssi_rate(priv
, io
, runtime
);
140 * Find best clock, and try to start ADG
142 for (i
= 0; i
< ARRAY_SIZE(adg_clk_div_table
); i
++) {
143 for (j
= 0; j
< ARRAY_SIZE(ssi_clk_mul_table
); j
++) {
146 * this driver is assuming that
147 * system word is 64fs (= 2 x 32bit)
148 * see rsnd_ssi_init()
150 main_rate
= rate
/ adg_clk_div_table
[i
]
151 * 32 * 2 * ssi_clk_mul_table
[j
];
153 ret
= rsnd_adg_ssi_clk_try_start(&ssi
->mod
, main_rate
);
155 ssi
->cr_clk
= FORCE
| SWL_32
|
156 SCKD
| SWSD
| CKDV(j
);
158 dev_dbg(dev
, "%s[%d] outputs %u Hz\n",
159 rsnd_mod_name(&ssi
->mod
),
160 rsnd_mod_id(&ssi
->mod
), rate
);
167 dev_err(dev
, "unsupported clock rate\n");
171 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi
*ssi
)
174 rsnd_adg_ssi_clk_stop(&ssi
->mod
);
177 static void rsnd_ssi_hw_start(struct rsnd_ssi
*ssi
,
178 struct rsnd_dai_stream
*io
)
180 struct rsnd_priv
*priv
= rsnd_io_to_priv(io
);
181 struct rsnd_dai
*rdai
= rsnd_io_to_rdai(io
);
182 struct device
*dev
= rsnd_priv_to_dev(priv
);
186 if (0 == ssi
->usrcnt
) {
187 rsnd_mod_hw_start(&ssi
->mod
);
189 if (rsnd_rdai_is_clk_master(rdai
)) {
190 if (rsnd_ssi_clk_from_parent(ssi
))
191 rsnd_ssi_hw_start(ssi
->parent
, io
);
193 rsnd_ssi_master_clk_start(ssi
, io
);
197 cr_mode
= rsnd_ssi_is_dma_mode(&ssi
->mod
) ?
198 DMEN
: /* DMA : enable DMA */
199 DIEN
; /* PIO : enable Data interrupt */
207 rsnd_mod_write(&ssi
->mod
, SSICR
, cr
);
209 /* enable WS continue */
210 if (rsnd_rdai_is_clk_master(rdai
))
211 rsnd_mod_write(&ssi
->mod
, SSIWSR
, CONT
);
213 /* clear error status */
214 rsnd_mod_write(&ssi
->mod
, SSISR
, 0);
218 dev_dbg(dev
, "%s[%d] hw started\n",
219 rsnd_mod_name(&ssi
->mod
), rsnd_mod_id(&ssi
->mod
));
222 static void rsnd_ssi_hw_stop(struct rsnd_ssi
*ssi
)
224 struct rsnd_priv
*priv
= rsnd_mod_to_priv(&ssi
->mod
);
225 struct rsnd_dai_stream
*io
= rsnd_mod_to_io(&ssi
->mod
);
226 struct rsnd_dai
*rdai
= rsnd_io_to_rdai(io
);
227 struct device
*dev
= rsnd_priv_to_dev(priv
);
230 if (0 == ssi
->usrcnt
) /* stop might be called without start */
235 if (0 == ssi
->usrcnt
) {
238 * and, wait all data was sent
243 rsnd_mod_write(&ssi
->mod
, SSICR
, cr
| EN
);
244 rsnd_ssi_status_check(&ssi
->mod
, DIRQ
);
248 * and, wait idle state
250 rsnd_mod_write(&ssi
->mod
, SSICR
, cr
); /* disabled all */
251 rsnd_ssi_status_check(&ssi
->mod
, IIRQ
);
253 if (rsnd_rdai_is_clk_master(rdai
)) {
254 if (rsnd_ssi_clk_from_parent(ssi
))
255 rsnd_ssi_hw_stop(ssi
->parent
);
257 rsnd_ssi_master_clk_stop(ssi
);
260 rsnd_mod_hw_stop(&ssi
->mod
);
263 dev_dbg(dev
, "%s[%d] hw stopped\n",
264 rsnd_mod_name(&ssi
->mod
), rsnd_mod_id(&ssi
->mod
));
268 * SSI mod common functions
270 static int rsnd_ssi_init(struct rsnd_mod
*mod
,
271 struct rsnd_priv
*priv
)
273 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
274 struct rsnd_dai_stream
*io
= rsnd_mod_to_io(mod
);
275 struct rsnd_dai
*rdai
= rsnd_io_to_rdai(io
);
276 struct snd_pcm_runtime
*runtime
= rsnd_io_to_runtime(io
);
282 * always use 32bit system word for easy clock calculation.
283 * see also rsnd_ssi_master_clk_enable()
288 * init clock settings for SSICR
290 switch (runtime
->sample_bits
) {
301 if (rdai
->bit_clk_inv
)
303 if (rdai
->frm_clk_inv
)
305 if (rdai
->data_alignment
)
309 if (rsnd_io_is_play(io
))
316 ssi
->err
= -1; /* ignore 1st error */
321 static int rsnd_ssi_quit(struct rsnd_mod
*mod
,
322 struct rsnd_priv
*priv
)
324 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
325 struct device
*dev
= rsnd_priv_to_dev(priv
);
328 dev_warn(dev
, "%s[%d] under/over flow err = %d\n",
329 rsnd_mod_name(mod
), rsnd_mod_id(mod
), ssi
->err
);
337 static void rsnd_ssi_record_error(struct rsnd_ssi
*ssi
, u32 status
)
339 /* under/over flow error */
340 if (status
& (UIRQ
| OIRQ
)) {
343 /* clear error status */
344 rsnd_mod_write(&ssi
->mod
, SSISR
, 0);
348 static int rsnd_ssi_start(struct rsnd_mod
*mod
,
349 struct rsnd_priv
*priv
)
351 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
352 struct rsnd_dai_stream
*io
= rsnd_mod_to_io(mod
);
354 rsnd_src_ssiu_start(mod
, rsnd_ssi_use_busif(mod
));
356 rsnd_ssi_hw_start(ssi
, io
);
358 rsnd_src_ssi_irq_enable(mod
);
363 static int rsnd_ssi_stop(struct rsnd_mod
*mod
,
364 struct rsnd_priv
*priv
)
366 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
368 rsnd_src_ssi_irq_disable(mod
);
370 rsnd_ssi_record_error(ssi
, rsnd_mod_read(mod
, SSISR
));
372 rsnd_ssi_hw_stop(ssi
);
374 rsnd_src_ssiu_stop(mod
);
379 static irqreturn_t
rsnd_ssi_interrupt(int irq
, void *data
)
381 struct rsnd_ssi
*ssi
= data
;
382 struct rsnd_mod
*mod
= &ssi
->mod
;
383 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
384 struct rsnd_dai_stream
*io
= rsnd_mod_to_io(mod
);
385 int is_dma
= rsnd_ssi_is_dma_mode(mod
);
386 u32 status
= rsnd_mod_read(mod
, SSISR
);
392 if (!is_dma
&& (status
& DIRQ
)) {
393 struct snd_pcm_runtime
*runtime
= rsnd_io_to_runtime(io
);
394 u32
*buf
= (u32
*)(runtime
->dma_area
+
395 rsnd_dai_pointer_offset(io
, 0));
398 * 8/16/32 data can be assesse to TDR/RDR register
399 * directly as 32bit data
400 * see rsnd_ssi_init()
402 if (rsnd_io_is_play(io
))
403 rsnd_mod_write(mod
, SSITDR
, *buf
);
405 *buf
= rsnd_mod_read(mod
, SSIRDR
);
407 rsnd_dai_pointer_update(io
, sizeof(*buf
));
411 if (status
& (UIRQ
| OIRQ
)) {
412 struct device
*dev
= rsnd_priv_to_dev(priv
);
417 rsnd_ssi_stop(mod
, priv
);
418 rsnd_ssi_start(mod
, priv
);
420 dev_dbg(dev
, "%s[%d] restart\n",
421 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
424 rsnd_ssi_record_error(ssi
, status
);
432 static int rsnd_ssi_pio_probe(struct rsnd_mod
*mod
,
433 struct rsnd_priv
*priv
)
435 struct device
*dev
= rsnd_priv_to_dev(priv
);
436 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
439 ret
= devm_request_irq(dev
, ssi
->info
->irq
,
444 dev_err(dev
, "%s[%d] (PIO) request interrupt failed\n",
445 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
447 dev_dbg(dev
, "%s[%d] (PIO) is probed\n",
448 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
453 static struct rsnd_mod_ops rsnd_ssi_pio_ops
= {
455 .probe
= rsnd_ssi_pio_probe
,
456 .init
= rsnd_ssi_init
,
457 .quit
= rsnd_ssi_quit
,
458 .start
= rsnd_ssi_start
,
459 .stop
= rsnd_ssi_stop
,
462 static int rsnd_ssi_dma_probe(struct rsnd_mod
*mod
,
463 struct rsnd_priv
*priv
)
465 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
466 struct device
*dev
= rsnd_priv_to_dev(priv
);
467 int dma_id
= ssi
->info
->dma_id
;
470 ret
= devm_request_irq(dev
, ssi
->info
->irq
,
475 goto rsnd_ssi_dma_probe_fail
;
478 priv
, rsnd_mod_to_dma(mod
),
481 goto rsnd_ssi_dma_probe_fail
;
483 dev_dbg(dev
, "%s[%d] (DMA) is probed\n",
484 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
488 rsnd_ssi_dma_probe_fail
:
489 dev_err(dev
, "%s[%d] (DMA) is failed\n",
490 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
495 static int rsnd_ssi_dma_remove(struct rsnd_mod
*mod
,
496 struct rsnd_priv
*priv
)
498 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
499 struct device
*dev
= rsnd_priv_to_dev(priv
);
500 int irq
= ssi
->info
->irq
;
502 rsnd_dma_quit(rsnd_mod_to_dma(mod
));
504 /* PIO will request IRQ again */
505 devm_free_irq(dev
, irq
, ssi
);
510 static int rsnd_ssi_fallback(struct rsnd_mod
*mod
,
511 struct rsnd_priv
*priv
)
513 struct device
*dev
= rsnd_priv_to_dev(priv
);
518 * SSI .probe might be called again.
520 * rsnd_rdai_continuance_probe()
522 mod
->ops
= &rsnd_ssi_pio_ops
;
524 dev_info(dev
, "%s[%d] fallback to PIO mode\n",
525 rsnd_mod_name(mod
), rsnd_mod_id(mod
));
530 static int rsnd_ssi_dma_start(struct rsnd_mod
*mod
,
531 struct rsnd_priv
*priv
)
533 struct rsnd_dma
*dma
= rsnd_mod_to_dma(mod
);
537 rsnd_ssi_start(mod
, priv
);
542 static int rsnd_ssi_dma_stop(struct rsnd_mod
*mod
,
543 struct rsnd_priv
*priv
)
545 struct rsnd_dma
*dma
= rsnd_mod_to_dma(mod
);
547 rsnd_ssi_stop(mod
, priv
);
554 static char *rsnd_ssi_dma_name(struct rsnd_mod
*mod
)
556 return rsnd_ssi_use_busif(mod
) ? "ssiu" : SSI_NAME
;
559 static struct rsnd_mod_ops rsnd_ssi_dma_ops
= {
561 .dma_name
= rsnd_ssi_dma_name
,
562 .probe
= rsnd_ssi_dma_probe
,
563 .remove
= rsnd_ssi_dma_remove
,
564 .init
= rsnd_ssi_init
,
565 .quit
= rsnd_ssi_quit
,
566 .start
= rsnd_ssi_dma_start
,
567 .stop
= rsnd_ssi_dma_stop
,
568 .fallback
= rsnd_ssi_fallback
,
571 int rsnd_ssi_is_dma_mode(struct rsnd_mod
*mod
)
573 return mod
->ops
== &rsnd_ssi_dma_ops
;
580 static struct rsnd_mod_ops rsnd_ssi_non_ops
= {
587 struct rsnd_mod
*rsnd_ssi_mod_get(struct rsnd_priv
*priv
, int id
)
589 if (WARN_ON(id
< 0 || id
>= rsnd_ssi_nr(priv
)))
592 return &((struct rsnd_ssi
*)(priv
->ssi
) + id
)->mod
;
595 int rsnd_ssi_is_pin_sharing(struct rsnd_mod
*mod
)
597 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
599 return !!(rsnd_ssi_mode_flags(ssi
) & RSND_SSI_CLK_PIN_SHARE
);
602 static void rsnd_ssi_parent_clk_setup(struct rsnd_priv
*priv
, struct rsnd_ssi
*ssi
)
604 if (!rsnd_ssi_is_pin_sharing(&ssi
->mod
))
607 switch (rsnd_mod_id(&ssi
->mod
)) {
610 ssi
->parent
= rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv
, 0));
613 ssi
->parent
= rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv
, 3));
616 ssi
->parent
= rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv
, 7));
622 static void rsnd_of_parse_ssi(struct platform_device
*pdev
,
623 const struct rsnd_of_data
*of_data
,
624 struct rsnd_priv
*priv
)
626 struct device_node
*node
;
627 struct device_node
*np
;
628 struct rsnd_ssi_platform_info
*ssi_info
;
629 struct rcar_snd_info
*info
= rsnd_priv_to_info(priv
);
630 struct device
*dev
= &pdev
->dev
;
636 node
= of_get_child_by_name(dev
->of_node
, "rcar_sound,ssi");
640 nr
= of_get_child_count(node
);
642 goto rsnd_of_parse_ssi_end
;
644 ssi_info
= devm_kzalloc(dev
,
645 sizeof(struct rsnd_ssi_platform_info
) * nr
,
648 dev_err(dev
, "ssi info allocation error\n");
649 goto rsnd_of_parse_ssi_end
;
652 info
->ssi_info
= ssi_info
;
653 info
->ssi_info_nr
= nr
;
656 for_each_child_of_node(node
, np
) {
659 ssi_info
= info
->ssi_info
+ i
;
664 if (of_get_property(np
, "shared-pin", NULL
))
665 ssi_info
->flags
|= RSND_SSI_CLK_PIN_SHARE
;
670 ssi_info
->irq
= irq_of_parse_and_map(np
, 0);
675 ssi_info
->dma_id
= of_get_property(np
, "pio-transfer", NULL
) ?
678 if (of_get_property(np
, "no-busif", NULL
))
679 ssi_info
->flags
|= RSND_SSI_NO_BUSIF
;
682 rsnd_of_parse_ssi_end
:
686 int rsnd_ssi_probe(struct platform_device
*pdev
,
687 const struct rsnd_of_data
*of_data
,
688 struct rsnd_priv
*priv
)
690 struct rcar_snd_info
*info
= rsnd_priv_to_info(priv
);
691 struct rsnd_ssi_platform_info
*pinfo
;
692 struct device
*dev
= rsnd_priv_to_dev(priv
);
693 struct rsnd_mod_ops
*ops
;
695 struct rsnd_ssi
*ssi
;
696 char name
[RSND_SSI_NAME_SIZE
];
699 rsnd_of_parse_ssi(pdev
, of_data
, priv
);
704 nr
= info
->ssi_info_nr
;
705 ssi
= devm_kzalloc(dev
, sizeof(*ssi
) * nr
, GFP_KERNEL
);
707 dev_err(dev
, "SSI allocate failed\n");
714 for_each_rsnd_ssi(ssi
, priv
, i
) {
715 pinfo
= &info
->ssi_info
[i
];
717 snprintf(name
, RSND_SSI_NAME_SIZE
, "%s.%d",
720 clk
= devm_clk_get(dev
, name
);
726 ops
= &rsnd_ssi_non_ops
;
727 if (pinfo
->dma_id
> 0)
728 ops
= &rsnd_ssi_dma_ops
;
729 else if (rsnd_ssi_pio_available(ssi
))
730 ops
= &rsnd_ssi_pio_ops
;
732 rsnd_mod_init(&ssi
->mod
, ops
, clk
, RSND_MOD_SSI
, i
);
734 rsnd_ssi_parent_clk_setup(priv
, ssi
);