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
,
192 struct rsnd_priv
*priv
= rsnd_mod_to_priv(&ssi
->mod
);
193 struct device
*dev
= rsnd_priv_to_dev(priv
);
195 int adg_clk_div_table
[] = {
196 1, 6, /* see adg.c */
198 int ssi_clk_mul_table
[] = {
199 1, 2, 4, 8, 16, 6, 12,
201 unsigned int main_rate
;
204 * Find best clock, and try to start ADG
206 for (i
= 0; i
< ARRAY_SIZE(adg_clk_div_table
); i
++) {
207 for (j
= 0; j
< ARRAY_SIZE(ssi_clk_mul_table
); j
++) {
210 * this driver is assuming that
211 * system word is 64fs (= 2 x 32bit)
212 * see rsnd_ssi_init()
214 main_rate
= rate
/ adg_clk_div_table
[i
]
215 * 32 * 2 * ssi_clk_mul_table
[j
];
217 ret
= rsnd_adg_ssi_clk_try_start(&ssi
->mod
, main_rate
);
220 ssi
->cr_clk
= FORCE
| SWL_32
|
221 SCKD
| SWSD
| CKDV(j
);
223 dev_dbg(dev
, "ssi%d outputs %u Hz\n",
224 rsnd_mod_id(&ssi
->mod
), rate
);
231 dev_err(dev
, "unsupported clock rate\n");
235 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi
*ssi
)
239 rsnd_adg_ssi_clk_stop(&ssi
->mod
);
242 static void rsnd_ssi_hw_start(struct rsnd_ssi
*ssi
,
243 struct rsnd_dai
*rdai
,
244 struct rsnd_dai_stream
*io
)
246 struct rsnd_priv
*priv
= rsnd_mod_to_priv(&ssi
->mod
);
247 struct device
*dev
= rsnd_priv_to_dev(priv
);
250 if (0 == ssi
->usrcnt
) {
251 clk_enable(ssi
->clk
);
253 if (rsnd_rdai_is_clk_master(rdai
)) {
254 struct snd_pcm_runtime
*runtime
;
256 runtime
= rsnd_io_to_runtime(io
);
258 if (rsnd_ssi_clk_from_parent(ssi
))
259 rsnd_ssi_hw_start(ssi
->parent
, rdai
, io
);
261 rsnd_ssi_master_clk_start(ssi
, runtime
->rate
);
270 rsnd_mod_write(&ssi
->mod
, SSICR
, cr
);
274 dev_dbg(dev
, "ssi%d hw started\n", rsnd_mod_id(&ssi
->mod
));
277 static void rsnd_ssi_hw_stop(struct rsnd_ssi
*ssi
,
278 struct rsnd_dai
*rdai
)
280 struct rsnd_priv
*priv
= rsnd_mod_to_priv(&ssi
->mod
);
281 struct device
*dev
= rsnd_priv_to_dev(priv
);
284 if (0 == ssi
->usrcnt
) /* stop might be called without start */
289 if (0 == ssi
->usrcnt
) {
292 * and, wait all data was sent
297 rsnd_mod_write(&ssi
->mod
, SSICR
, cr
| EN
);
298 rsnd_ssi_status_check(&ssi
->mod
, DIRQ
);
302 * and, wait idle state
304 rsnd_mod_write(&ssi
->mod
, SSICR
, cr
); /* disabled all */
305 rsnd_ssi_status_check(&ssi
->mod
, IIRQ
);
307 if (rsnd_rdai_is_clk_master(rdai
)) {
308 if (rsnd_ssi_clk_from_parent(ssi
))
309 rsnd_ssi_hw_stop(ssi
->parent
, rdai
);
311 rsnd_ssi_master_clk_stop(ssi
);
314 clk_disable(ssi
->clk
);
317 dev_dbg(dev
, "ssi%d hw stopped\n", rsnd_mod_id(&ssi
->mod
));
321 * SSI mod common functions
323 static int rsnd_ssi_init(struct rsnd_mod
*mod
,
324 struct rsnd_dai
*rdai
,
325 struct rsnd_dai_stream
*io
)
327 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
328 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
329 struct device
*dev
= rsnd_priv_to_dev(priv
);
330 struct snd_pcm_runtime
*runtime
= rsnd_io_to_runtime(io
);
336 * always use 32bit system word for easy clock calculation.
337 * see also rsnd_ssi_master_clk_enable()
342 * init clock settings for SSICR
344 switch (runtime
->sample_bits
) {
355 if (rdai
->bit_clk_inv
)
357 if (rdai
->frm_clk_inv
)
359 if (rdai
->data_alignment
)
363 if (rsnd_dai_is_play(rdai
, io
))
372 ssi
->err
= -1; /* ignore 1st error */
374 rsnd_ssi_mode_set(priv
, rdai
, ssi
);
376 dev_dbg(dev
, "%s.%d init\n", rsnd_mod_name(mod
), rsnd_mod_id(mod
));
381 static int rsnd_ssi_quit(struct rsnd_mod
*mod
,
382 struct rsnd_dai
*rdai
,
383 struct rsnd_dai_stream
*io
)
385 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
386 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
387 struct device
*dev
= rsnd_priv_to_dev(priv
);
389 dev_dbg(dev
, "%s.%d quit\n", rsnd_mod_name(mod
), rsnd_mod_id(mod
));
392 dev_warn(dev
, "ssi under/over flow err = %d\n", ssi
->err
);
402 static void rsnd_ssi_record_error(struct rsnd_ssi
*ssi
, u32 status
)
404 /* under/over flow error */
405 if (status
& (UIRQ
| OIRQ
)) {
408 /* clear error status */
409 rsnd_mod_write(&ssi
->mod
, SSISR
, 0);
416 static irqreturn_t
rsnd_ssi_pio_interrupt(int irq
, void *data
)
418 struct rsnd_ssi
*ssi
= data
;
419 struct rsnd_dai_stream
*io
= ssi
->io
;
420 u32 status
= rsnd_mod_read(&ssi
->mod
, SSISR
);
421 irqreturn_t ret
= IRQ_NONE
;
423 if (io
&& (status
& DIRQ
)) {
424 struct rsnd_dai
*rdai
= ssi
->rdai
;
425 struct snd_pcm_runtime
*runtime
= rsnd_io_to_runtime(io
);
426 u32
*buf
= (u32
*)(runtime
->dma_area
+
427 rsnd_dai_pointer_offset(io
, 0));
429 rsnd_ssi_record_error(ssi
, status
);
432 * 8/16/32 data can be assesse to TDR/RDR register
433 * directly as 32bit data
434 * see rsnd_ssi_init()
436 if (rsnd_dai_is_play(rdai
, io
))
437 rsnd_mod_write(&ssi
->mod
, SSITDR
, *buf
);
439 *buf
= rsnd_mod_read(&ssi
->mod
, SSIRDR
);
441 rsnd_dai_pointer_update(io
, sizeof(*buf
));
449 static int rsnd_ssi_pio_start(struct rsnd_mod
*mod
,
450 struct rsnd_dai
*rdai
,
451 struct rsnd_dai_stream
*io
)
453 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
454 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
455 struct device
*dev
= rsnd_priv_to_dev(priv
);
458 ssi
->cr_etc
= UIEN
| OIEN
| DIEN
;
460 /* enable PIO interrupt */
461 rsnd_mod_write(&ssi
->mod
, INT_ENABLE
, 0x0f000000);
463 rsnd_ssi_hw_start(ssi
, rdai
, io
);
465 dev_dbg(dev
, "%s.%d start\n", rsnd_mod_name(mod
), rsnd_mod_id(mod
));
470 static int rsnd_ssi_pio_stop(struct rsnd_mod
*mod
,
471 struct rsnd_dai
*rdai
,
472 struct rsnd_dai_stream
*io
)
474 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
475 struct device
*dev
= rsnd_priv_to_dev(priv
);
476 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
478 dev_dbg(dev
, "%s.%d stop\n", rsnd_mod_name(mod
), rsnd_mod_id(mod
));
482 rsnd_ssi_hw_stop(ssi
, rdai
);
487 static struct rsnd_mod_ops rsnd_ssi_pio_ops
= {
489 .init
= rsnd_ssi_init
,
490 .quit
= rsnd_ssi_quit
,
491 .start
= rsnd_ssi_pio_start
,
492 .stop
= rsnd_ssi_pio_stop
,
495 static int rsnd_ssi_dma_inquiry(struct rsnd_dma
*dma
, dma_addr_t
*buf
, int *len
)
497 struct rsnd_ssi
*ssi
= rsnd_dma_to_ssi(dma
);
498 struct rsnd_dai_stream
*io
= ssi
->io
;
499 struct snd_pcm_runtime
*runtime
= rsnd_io_to_runtime(io
);
501 *len
= io
->byte_per_period
;
502 *buf
= runtime
->dma_addr
+
503 rsnd_dai_pointer_offset(io
, ssi
->dma_offset
+ *len
);
504 ssi
->dma_offset
= *len
; /* it cares A/B plane */
509 static int rsnd_ssi_dma_complete(struct rsnd_dma
*dma
)
511 struct rsnd_ssi
*ssi
= rsnd_dma_to_ssi(dma
);
512 struct rsnd_dai_stream
*io
= ssi
->io
;
513 u32 status
= rsnd_mod_read(&ssi
->mod
, SSISR
);
515 rsnd_ssi_record_error(ssi
, status
);
517 rsnd_dai_pointer_update(ssi
->io
, io
->byte_per_period
);
522 static int rsnd_ssi_dma_start(struct rsnd_mod
*mod
,
523 struct rsnd_dai
*rdai
,
524 struct rsnd_dai_stream
*io
)
526 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
527 struct rsnd_dma
*dma
= rsnd_mod_to_dma(&ssi
->mod
);
529 /* enable DMA transfer */
535 rsnd_ssi_hw_start(ssi
, ssi
->rdai
, io
);
537 /* enable WS continue */
538 if (rsnd_rdai_is_clk_master(rdai
))
539 rsnd_mod_write(&ssi
->mod
, SSIWSR
, CONT
);
544 static int rsnd_ssi_dma_stop(struct rsnd_mod
*mod
,
545 struct rsnd_dai
*rdai
,
546 struct rsnd_dai_stream
*io
)
548 struct rsnd_ssi
*ssi
= rsnd_mod_to_ssi(mod
);
549 struct rsnd_dma
*dma
= rsnd_mod_to_dma(&ssi
->mod
);
553 rsnd_ssi_hw_stop(ssi
, rdai
);
560 static struct rsnd_mod_ops rsnd_ssi_dma_ops
= {
562 .init
= rsnd_ssi_init
,
563 .quit
= rsnd_ssi_quit
,
564 .start
= rsnd_ssi_dma_start
,
565 .stop
= rsnd_ssi_dma_stop
,
571 static int rsnd_ssi_non(struct rsnd_mod
*mod
,
572 struct rsnd_dai
*rdai
,
573 struct rsnd_dai_stream
*io
)
575 struct rsnd_priv
*priv
= rsnd_mod_to_priv(mod
);
576 struct device
*dev
= rsnd_priv_to_dev(priv
);
578 dev_dbg(dev
, "%s\n", __func__
);
583 static struct rsnd_mod_ops rsnd_ssi_non_ops
= {
585 .init
= rsnd_ssi_non
,
586 .quit
= rsnd_ssi_non
,
587 .start
= rsnd_ssi_non
,
588 .stop
= rsnd_ssi_non
,
594 struct rsnd_mod
*rsnd_ssi_mod_get_frm_dai(struct rsnd_priv
*priv
,
595 int dai_id
, int is_play
)
597 struct rsnd_ssi
*ssi
;
602 for_each_rsnd_ssi(ssi
, priv
, i
) {
603 if (rsnd_ssi_dai_id(ssi
) != dai_id
)
606 has_play
= !!(rsnd_ssi_mode_flags(ssi
) & RSND_SSI_PLAY
);
608 if (is_play
== has_play
)
615 struct rsnd_mod
*rsnd_ssi_mod_get(struct rsnd_priv
*priv
, int id
)
617 BUG_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
));