ASoC: rsnd: remove duplicate parameter from rsnd_mod_ops
[platform/adaptation/renesas_rcar/renesas_kernel.git] / sound / soc / sh / rcar / ssi.c
1 /*
2  * Renesas R-Car SSIU/SSI support
3  *
4  * Copyright (C) 2013 Renesas Solutions Corp.
5  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
6  *
7  * Based on fsi.c
8  * Kuninori Morimoto <morimoto.kuninori@renesas.com>
9  *
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.
13  */
14 #include <linux/delay.h>
15 #include "rsnd.h"
16 #define RSND_SSI_NAME_SIZE 16
17
18 /*
19  * SSICR
20  */
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 */
27
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 */
35
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 */
46
47 /*
48  * SSISR
49  */
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 */
54
55 /*
56  * SSIWSR
57  */
58 #define CONT            (1 << 8)        /* WS Continue Function */
59
60 struct rsnd_ssi {
61         struct clk *clk;
62         struct rsnd_ssi_platform_info *info; /* rcar_snd.h */
63         struct rsnd_ssi *parent;
64         struct rsnd_mod mod;
65
66         struct rsnd_dai *rdai;
67         u32 cr_own;
68         u32 cr_clk;
69         u32 cr_etc;
70         int err;
71         unsigned int usrcnt;
72         unsigned int rate;
73 };
74
75 #define for_each_rsnd_ssi(pos, priv, i)                                 \
76         for (i = 0;                                                     \
77              (i < rsnd_ssi_nr(priv)) &&                                 \
78                 ((pos) = ((struct rsnd_ssi *)(priv)->ssi + i));         \
79              i++)
80
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)
90
91 static void rsnd_ssi_status_check(struct rsnd_mod *mod,
92                                   u32 bit)
93 {
94         struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
95         struct device *dev = rsnd_priv_to_dev(priv);
96         u32 status;
97         int i;
98
99         for (i = 0; i < 1024; i++) {
100                 status = rsnd_mod_read(mod, SSISR);
101                 if (status & bit)
102                         return;
103
104                 udelay(50);
105         }
106
107         dev_warn(dev, "status check failed\n");
108 }
109
110 static int rsnd_ssi_master_clk_start(struct rsnd_ssi *ssi,
111                                      struct rsnd_dai_stream *io)
112 {
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);
116         int i, j, ret;
117         int adg_clk_div_table[] = {
118                 1, 6, /* see adg.c */
119         };
120         int ssi_clk_mul_table[] = {
121                 1, 2, 4, 8, 16, 6, 12,
122         };
123         unsigned int main_rate;
124         unsigned int rate = rsnd_src_get_ssi_rate(priv, io, runtime);
125
126         /*
127          * Find best clock, and try to start ADG
128          */
129         for (i = 0; i < ARRAY_SIZE(adg_clk_div_table); i++) {
130                 for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
131
132                         /*
133                          * this driver is assuming that
134                          * system word is 64fs (= 2 x 32bit)
135                          * see rsnd_ssi_init()
136                          */
137                         main_rate = rate / adg_clk_div_table[i]
138                                 * 32 * 2 * ssi_clk_mul_table[j];
139
140                         ret = rsnd_adg_ssi_clk_try_start(&ssi->mod, main_rate);
141                         if (0 == ret) {
142                                 ssi->rate       = rate;
143                                 ssi->cr_clk     = FORCE | SWL_32 |
144                                                   SCKD | SWSD | CKDV(j);
145
146                                 dev_dbg(dev, "ssi%d outputs %u Hz\n",
147                                         rsnd_mod_id(&ssi->mod), rate);
148
149                                 return 0;
150                         }
151                 }
152         }
153
154         dev_err(dev, "unsupported clock rate\n");
155         return -EIO;
156 }
157
158 static void rsnd_ssi_master_clk_stop(struct rsnd_ssi *ssi)
159 {
160         ssi->rate = 0;
161         ssi->cr_clk = 0;
162         rsnd_adg_ssi_clk_stop(&ssi->mod);
163 }
164
165 static void rsnd_ssi_hw_start(struct rsnd_ssi *ssi,
166                               struct rsnd_dai *rdai,
167                               struct rsnd_dai_stream *io)
168 {
169         struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
170         struct device *dev = rsnd_priv_to_dev(priv);
171         u32 cr;
172
173         if (0 == ssi->usrcnt) {
174                 clk_prepare_enable(ssi->clk);
175
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);
179                         else
180                                 rsnd_ssi_master_clk_start(ssi, io);
181                 }
182         }
183
184         cr  =   ssi->cr_own     |
185                 ssi->cr_clk     |
186                 ssi->cr_etc     |
187                 EN;
188
189         rsnd_mod_write(&ssi->mod, SSICR, cr);
190
191         ssi->usrcnt++;
192
193         dev_dbg(dev, "ssi%d hw started\n", rsnd_mod_id(&ssi->mod));
194 }
195
196 static void rsnd_ssi_hw_stop(struct rsnd_ssi *ssi,
197                              struct rsnd_dai *rdai)
198 {
199         struct rsnd_priv *priv = rsnd_mod_to_priv(&ssi->mod);
200         struct device *dev = rsnd_priv_to_dev(priv);
201         u32 cr;
202
203         if (0 == ssi->usrcnt) /* stop might be called without start */
204                 return;
205
206         ssi->usrcnt--;
207
208         if (0 == ssi->usrcnt) {
209                 /*
210                  * disable all IRQ,
211                  * and, wait all data was sent
212                  */
213                 cr  =   ssi->cr_own     |
214                         ssi->cr_clk;
215
216                 rsnd_mod_write(&ssi->mod, SSICR, cr | EN);
217                 rsnd_ssi_status_check(&ssi->mod, DIRQ);
218
219                 /*
220                  * disable SSI,
221                  * and, wait idle state
222                  */
223                 rsnd_mod_write(&ssi->mod, SSICR, cr);   /* disabled all */
224                 rsnd_ssi_status_check(&ssi->mod, IIRQ);
225
226                 if (rsnd_dai_is_clk_master(rdai)) {
227                         if (rsnd_ssi_clk_from_parent(ssi))
228                                 rsnd_ssi_hw_stop(ssi->parent, rdai);
229                         else
230                                 rsnd_ssi_master_clk_stop(ssi);
231                 }
232
233                 clk_disable_unprepare(ssi->clk);
234         }
235
236         dev_dbg(dev, "ssi%d hw stopped\n", rsnd_mod_id(&ssi->mod));
237 }
238
239 /*
240  *      SSI mod common functions
241  */
242 static int rsnd_ssi_init(struct rsnd_mod *mod,
243                          struct rsnd_dai *rdai)
244 {
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);
248         u32 cr;
249
250         cr = FORCE;
251
252         /*
253          * always use 32bit system word for easy clock calculation.
254          * see also rsnd_ssi_master_clk_enable()
255          */
256         cr |= SWL_32;
257
258         /*
259          * init clock settings for SSICR
260          */
261         switch (runtime->sample_bits) {
262         case 16:
263                 cr |= DWL_16;
264                 break;
265         case 32:
266                 cr |= DWL_24;
267                 break;
268         default:
269                 return -EIO;
270         }
271
272         if (rdai->bit_clk_inv)
273                 cr |= SCKP;
274         if (rdai->frm_clk_inv)
275                 cr |= SWSP;
276         if (rdai->data_alignment)
277                 cr |= SDTA;
278         if (rdai->sys_delay)
279                 cr |= DEL;
280         if (rsnd_dai_is_play(rdai, io))
281                 cr |= TRMD;
282
283         /*
284          * set ssi parameter
285          */
286         ssi->rdai       = rdai;
287         ssi->cr_own     = cr;
288         ssi->err        = -1; /* ignore 1st error */
289
290         rsnd_src_ssi_mode_init(mod, rdai);
291
292         return 0;
293 }
294
295 static int rsnd_ssi_quit(struct rsnd_mod *mod,
296                          struct rsnd_dai *rdai)
297 {
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);
301
302         if (ssi->err > 0)
303                 dev_warn(dev, "ssi under/over flow err = %d\n", ssi->err);
304
305         ssi->rdai       = NULL;
306         ssi->cr_own     = 0;
307         ssi->err        = 0;
308
309         return 0;
310 }
311
312 static void rsnd_ssi_record_error(struct rsnd_ssi *ssi, u32 status)
313 {
314         /* under/over flow error */
315         if (status & (UIRQ | OIRQ)) {
316                 ssi->err++;
317
318                 /* clear error status */
319                 rsnd_mod_write(&ssi->mod, SSISR, 0);
320         }
321 }
322
323 /*
324  *              SSI PIO
325  */
326 static irqreturn_t rsnd_ssi_pio_interrupt(int irq, void *data)
327 {
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;
333
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));
339
340                 rsnd_ssi_record_error(ssi, status);
341
342                 /*
343                  * 8/16/32 data can be assesse to TDR/RDR register
344                  * directly as 32bit data
345                  * see rsnd_ssi_init()
346                  */
347                 if (rsnd_dai_is_play(rdai, io))
348                         rsnd_mod_write(mod, SSITDR, *buf);
349                 else
350                         *buf = rsnd_mod_read(mod, SSIRDR);
351
352                 rsnd_dai_pointer_update(io, sizeof(*buf));
353
354                 ret = IRQ_HANDLED;
355         }
356
357         return ret;
358 }
359
360 static int rsnd_ssi_pio_probe(struct rsnd_mod *mod,
361                               struct rsnd_dai *rdai)
362 {
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;
367         int ret;
368
369         ret = devm_request_irq(dev, irq,
370                                rsnd_ssi_pio_interrupt,
371                                IRQF_SHARED,
372                                dev_name(dev), ssi);
373         if (ret)
374                 dev_err(dev, "SSI request interrupt failed\n");
375
376         return ret;
377 }
378
379 static int rsnd_ssi_pio_start(struct rsnd_mod *mod,
380                               struct rsnd_dai *rdai)
381 {
382         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
383         struct rsnd_dai_stream *io = rsnd_mod_to_io(mod);
384
385         /* enable PIO IRQ */
386         ssi->cr_etc = UIEN | OIEN | DIEN;
387
388         rsnd_src_enable_ssi_irq(mod, rdai);
389
390         rsnd_ssi_hw_start(ssi, rdai, io);
391
392         return 0;
393 }
394
395 static int rsnd_ssi_pio_stop(struct rsnd_mod *mod,
396                              struct rsnd_dai *rdai)
397 {
398         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
399
400         ssi->cr_etc = 0;
401
402         rsnd_ssi_hw_stop(ssi, rdai);
403
404         return 0;
405 }
406
407 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
408         .name   = "ssi (pio)",
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,
414 };
415
416 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
417                           struct rsnd_dai *rdai)
418 {
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;
423         int ret;
424
425         ret = rsnd_dma_init(
426                 priv, rsnd_mod_to_dma(mod),
427                 rsnd_info_is_playback(priv, ssi),
428                 dma_id);
429
430         if (ret < 0)
431                 dev_err(dev, "SSI DMA failed\n");
432
433         return ret;
434 }
435
436 static int rsnd_ssi_dma_remove(struct rsnd_mod *mod,
437                                struct rsnd_dai *rdai)
438 {
439         rsnd_dma_quit(rsnd_mod_to_priv(mod), rsnd_mod_to_dma(mod));
440
441         return 0;
442 }
443
444 static int rsnd_ssi_dma_start(struct rsnd_mod *mod,
445                               struct rsnd_dai *rdai)
446 {
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);
450
451         /* enable DMA transfer */
452         ssi->cr_etc = DMEN;
453
454         rsnd_dma_start(dma);
455
456         rsnd_ssi_hw_start(ssi, ssi->rdai, io);
457
458         /* enable WS continue */
459         if (rsnd_dai_is_clk_master(rdai))
460                 rsnd_mod_write(&ssi->mod, SSIWSR, CONT);
461
462         return 0;
463 }
464
465 static int rsnd_ssi_dma_stop(struct rsnd_mod *mod,
466                              struct rsnd_dai *rdai)
467 {
468         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
469         struct rsnd_dma *dma = rsnd_mod_to_dma(&ssi->mod);
470
471         ssi->cr_etc = 0;
472
473         rsnd_ssi_record_error(ssi, rsnd_mod_read(mod, SSISR));
474
475         rsnd_ssi_hw_stop(ssi, rdai);
476
477         rsnd_dma_stop(dma);
478
479         return 0;
480 }
481
482 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
483         .name   = "ssi (dma)",
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,
490 };
491
492 /*
493  *              Non SSI
494  */
495 static struct rsnd_mod_ops rsnd_ssi_non_ops = {
496         .name   = "ssi (non)",
497 };
498
499 /*
500  *              ssi mod function
501  */
502 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
503 {
504         if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
505                 id = 0;
506
507         return &((struct rsnd_ssi *)(priv->ssi) + id)->mod;
508 }
509
510 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
511 {
512         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
513
514         return !!(rsnd_ssi_mode_flags(ssi) & RSND_SSI_CLK_PIN_SHARE);
515 }
516
517 static void rsnd_ssi_parent_clk_setup(struct rsnd_priv *priv, struct rsnd_ssi *ssi)
518 {
519         if (!rsnd_ssi_is_pin_sharing(&ssi->mod))
520                 return;
521
522         switch (rsnd_mod_id(&ssi->mod)) {
523         case 1:
524         case 2:
525                 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 0));
526                 break;
527         case 4:
528                 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 3));
529                 break;
530         case 8:
531                 ssi->parent = rsnd_mod_to_ssi(rsnd_ssi_mod_get(priv, 7));
532                 break;
533         }
534 }
535
536
537 static void rsnd_of_parse_ssi(struct platform_device *pdev,
538                               const struct rsnd_of_data *of_data,
539                               struct rsnd_priv *priv)
540 {
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;
546         int nr, i;
547
548         if (!of_data)
549                 return;
550
551         node = of_get_child_by_name(dev->of_node, "rcar_sound,ssi");
552         if (!node)
553                 return;
554
555         nr = of_get_child_count(node);
556         if (!nr)
557                 return;
558
559         ssi_info = devm_kzalloc(dev,
560                                 sizeof(struct rsnd_ssi_platform_info) * nr,
561                                 GFP_KERNEL);
562         if (!ssi_info) {
563                 dev_err(dev, "ssi info allocation error\n");
564                 return;
565         }
566
567         info->ssi_info          = ssi_info;
568         info->ssi_info_nr       = nr;
569
570         i = -1;
571         for_each_child_of_node(node, np) {
572                 i++;
573
574                 ssi_info = info->ssi_info + i;
575
576                 /*
577                  * pin settings
578                  */
579                 if (of_get_property(np, "shared-pin", NULL))
580                         ssi_info->flags |= RSND_SSI_CLK_PIN_SHARE;
581
582                 /*
583                  * irq
584                  */
585                 ssi_info->pio_irq = irq_of_parse_and_map(np, 0);
586         }
587 }
588
589 int rsnd_ssi_probe(struct platform_device *pdev,
590                    const struct rsnd_of_data *of_data,
591                    struct rsnd_priv *priv)
592 {
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;
597         struct clk *clk;
598         struct rsnd_ssi *ssi;
599         char name[RSND_SSI_NAME_SIZE];
600         int i, nr;
601
602         rsnd_of_parse_ssi(pdev, of_data, priv);
603
604         /*
605          *      init SSI
606          */
607         nr      = info->ssi_info_nr;
608         ssi     = devm_kzalloc(dev, sizeof(*ssi) * nr, GFP_KERNEL);
609         if (!ssi) {
610                 dev_err(dev, "SSI allocate failed\n");
611                 return -ENOMEM;
612         }
613
614         priv->ssi       = ssi;
615         priv->ssi_nr    = nr;
616
617         for_each_rsnd_ssi(ssi, priv, i) {
618                 pinfo = &info->ssi_info[i];
619
620                 snprintf(name, RSND_SSI_NAME_SIZE, "ssi.%d", i);
621
622                 clk = devm_clk_get(dev, name);
623                 if (IS_ERR(clk))
624                         return PTR_ERR(clk);
625
626                 ssi->info       = pinfo;
627                 ssi->clk        = clk;
628
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;
634
635                 rsnd_mod_init(priv, &ssi->mod, ops, RSND_MOD_SSI, i);
636
637                 rsnd_ssi_parent_clk_setup(priv, ssi);
638         }
639
640         return 0;
641 }