ASoC: AMD: Change codec to channel link as per hardware redesign
[muen/linux.git] / sound / soc / sh / rcar / ssi.c
1 // SPDX-License-Identifier: GPL-2.0
2 //
3 // Renesas R-Car SSIU/SSI support
4 //
5 // Copyright (C) 2013 Renesas Solutions Corp.
6 // Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
7 //
8 // Based on fsi.c
9 // Kuninori Morimoto <morimoto.kuninori@renesas.com>
10
11 /*
12  * you can enable below define if you don't need
13  * SSI interrupt status debug message when debugging
14  * see rsnd_dbg_irq_status()
15  *
16  * #define RSND_DEBUG_NO_IRQ_STATUS 1
17  */
18
19 #include <sound/simple_card_utils.h>
20 #include <linux/delay.h>
21 #include "rsnd.h"
22 #define RSND_SSI_NAME_SIZE 16
23
24 /*
25  * SSICR
26  */
27 #define FORCE           (1 << 31)       /* Fixed */
28 #define DMEN            (1 << 28)       /* DMA Enable */
29 #define UIEN            (1 << 27)       /* Underflow Interrupt Enable */
30 #define OIEN            (1 << 26)       /* Overflow Interrupt Enable */
31 #define IIEN            (1 << 25)       /* Idle Mode Interrupt Enable */
32 #define DIEN            (1 << 24)       /* Data Interrupt Enable */
33 #define CHNL_4          (1 << 22)       /* Channels */
34 #define CHNL_6          (2 << 22)       /* Channels */
35 #define CHNL_8          (3 << 22)       /* Channels */
36 #define DWL_8           (0 << 19)       /* Data Word Length */
37 #define DWL_16          (1 << 19)       /* Data Word Length */
38 #define DWL_18          (2 << 19)       /* Data Word Length */
39 #define DWL_20          (3 << 19)       /* Data Word Length */
40 #define DWL_22          (4 << 19)       /* Data Word Length */
41 #define DWL_24          (5 << 19)       /* Data Word Length */
42 #define DWL_32          (6 << 19)       /* Data Word Length */
43
44 #define SWL_32          (3 << 16)       /* R/W System Word Length */
45 #define SCKD            (1 << 15)       /* Serial Bit Clock Direction */
46 #define SWSD            (1 << 14)       /* Serial WS Direction */
47 #define SCKP            (1 << 13)       /* Serial Bit Clock Polarity */
48 #define SWSP            (1 << 12)       /* Serial WS Polarity */
49 #define SDTA            (1 << 10)       /* Serial Data Alignment */
50 #define PDTA            (1 <<  9)       /* Parallel Data Alignment */
51 #define DEL             (1 <<  8)       /* Serial Data Delay */
52 #define CKDV(v)         (v <<  4)       /* Serial Clock Division Ratio */
53 #define TRMD            (1 <<  1)       /* Transmit/Receive Mode Select */
54 #define EN              (1 <<  0)       /* SSI Module Enable */
55
56 /*
57  * SSISR
58  */
59 #define UIRQ            (1 << 27)       /* Underflow Error Interrupt Status */
60 #define OIRQ            (1 << 26)       /* Overflow Error Interrupt Status */
61 #define IIRQ            (1 << 25)       /* Idle Mode Interrupt Status */
62 #define DIRQ            (1 << 24)       /* Data Interrupt Status Flag */
63
64 /*
65  * SSIWSR
66  */
67 #define CONT            (1 << 8)        /* WS Continue Function */
68 #define WS_MODE         (1 << 0)        /* WS Mode */
69
70 #define SSI_NAME "ssi"
71
72 struct rsnd_ssi {
73         struct rsnd_mod mod;
74         struct rsnd_mod *dma;
75
76         u32 flags;
77         u32 cr_own;
78         u32 cr_clk;
79         u32 cr_mode;
80         u32 cr_en;
81         u32 wsr;
82         int chan;
83         int rate;
84         int irq;
85         unsigned int usrcnt;
86
87         /* for PIO */
88         int byte_pos;
89         int byte_per_period;
90         int next_period_byte;
91 };
92
93 /* flags */
94 #define RSND_SSI_CLK_PIN_SHARE          (1 << 0)
95 #define RSND_SSI_NO_BUSIF               (1 << 1) /* SSI+DMA without BUSIF */
96 #define RSND_SSI_HDMI0                  (1 << 2) /* for HDMI0 */
97 #define RSND_SSI_HDMI1                  (1 << 3) /* for HDMI1 */
98 #define RSND_SSI_PROBED                 (1 << 4)
99
100 #define for_each_rsnd_ssi(pos, priv, i)                                 \
101         for (i = 0;                                                     \
102              (i < rsnd_ssi_nr(priv)) &&                                 \
103                 ((pos) = ((struct rsnd_ssi *)(priv)->ssi + i));         \
104              i++)
105
106 #define rsnd_ssi_get(priv, id) ((struct rsnd_ssi *)(priv->ssi) + id)
107 #define rsnd_ssi_nr(priv) ((priv)->ssi_nr)
108 #define rsnd_mod_to_ssi(_mod) container_of((_mod), struct rsnd_ssi, mod)
109 #define rsnd_ssi_is_parent(ssi, io) ((ssi) == rsnd_io_to_mod_ssip(io))
110 #define rsnd_ssi_is_multi_slave(mod, io) \
111         (rsnd_ssi_multi_slaves(io) & (1 << rsnd_mod_id(mod)))
112 #define rsnd_ssi_is_run_mods(mod, io) \
113         (rsnd_ssi_run_mods(io) & (1 << rsnd_mod_id(mod)))
114 #define rsnd_ssi_can_output_clk(mod) (!__rsnd_ssi_is_pin_sharing(mod))
115
116 int rsnd_ssi_hdmi_port(struct rsnd_dai_stream *io)
117 {
118         struct rsnd_mod *mod = rsnd_io_to_mod_ssi(io);
119         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
120
121         if (rsnd_flags_has(ssi, RSND_SSI_HDMI0))
122                 return RSND_SSI_HDMI_PORT0;
123
124         if (rsnd_flags_has(ssi, RSND_SSI_HDMI1))
125                 return RSND_SSI_HDMI_PORT1;
126
127         return 0;
128 }
129
130 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io)
131 {
132         struct rsnd_mod *mod = rsnd_io_to_mod_ssi(io);
133         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
134         int use_busif = 0;
135
136         if (!rsnd_ssi_is_dma_mode(mod))
137                 return 0;
138
139         if (!(rsnd_flags_has(ssi, RSND_SSI_NO_BUSIF)))
140                 use_busif = 1;
141         if (rsnd_io_to_mod_src(io))
142                 use_busif = 1;
143
144         return use_busif;
145 }
146
147 static void rsnd_ssi_status_clear(struct rsnd_mod *mod)
148 {
149         rsnd_mod_write(mod, SSISR, 0);
150 }
151
152 static u32 rsnd_ssi_status_get(struct rsnd_mod *mod)
153 {
154         return rsnd_mod_read(mod, SSISR);
155 }
156
157 static void rsnd_ssi_status_check(struct rsnd_mod *mod,
158                                   u32 bit)
159 {
160         struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
161         struct device *dev = rsnd_priv_to_dev(priv);
162         u32 status;
163         int i;
164
165         for (i = 0; i < 1024; i++) {
166                 status = rsnd_ssi_status_get(mod);
167                 if (status & bit)
168                         return;
169
170                 udelay(5);
171         }
172
173         dev_warn(dev, "%s[%d] status check failed\n",
174                  rsnd_mod_name(mod), rsnd_mod_id(mod));
175 }
176
177 static u32 rsnd_ssi_multi_slaves(struct rsnd_dai_stream *io)
178 {
179         struct rsnd_mod *mod;
180         enum rsnd_mod_type types[] = {
181                 RSND_MOD_SSIM1,
182                 RSND_MOD_SSIM2,
183                 RSND_MOD_SSIM3,
184         };
185         int i, mask;
186
187         mask = 0;
188         for (i = 0; i < ARRAY_SIZE(types); i++) {
189                 mod = rsnd_io_to_mod(io, types[i]);
190                 if (!mod)
191                         continue;
192
193                 mask |= 1 << rsnd_mod_id(mod);
194         }
195
196         return mask;
197 }
198
199 static u32 rsnd_ssi_run_mods(struct rsnd_dai_stream *io)
200 {
201         struct rsnd_mod *ssi_mod = rsnd_io_to_mod_ssi(io);
202         struct rsnd_mod *ssi_parent_mod = rsnd_io_to_mod_ssip(io);
203         u32 mods;
204
205         mods = rsnd_ssi_multi_slaves_runtime(io) |
206                 1 << rsnd_mod_id(ssi_mod);
207
208         if (ssi_parent_mod)
209                 mods |= 1 << rsnd_mod_id(ssi_parent_mod);
210
211         return mods;
212 }
213
214 u32 rsnd_ssi_multi_slaves_runtime(struct rsnd_dai_stream *io)
215 {
216         if (rsnd_runtime_is_ssi_multi(io))
217                 return rsnd_ssi_multi_slaves(io);
218
219         return 0;
220 }
221
222 unsigned int rsnd_ssi_clk_query(struct rsnd_priv *priv,
223                        int param1, int param2, int *idx)
224 {
225         int ssi_clk_mul_table[] = {
226                 1, 2, 4, 8, 16, 6, 12,
227         };
228         int j, ret;
229         unsigned int main_rate;
230
231         for (j = 0; j < ARRAY_SIZE(ssi_clk_mul_table); j++) {
232
233                 /*
234                  * It will set SSIWSR.CONT here, but SSICR.CKDV = 000
235                  * with it is not allowed. (SSIWSR.WS_MODE with
236                  * SSICR.CKDV = 000 is not allowed either).
237                  * Skip it. See SSICR.CKDV
238                  */
239                 if (j == 0)
240                         continue;
241
242                 /*
243                  * this driver is assuming that
244                  * system word is 32bit x chan
245                  * see rsnd_ssi_init()
246                  */
247                 main_rate = 32 * param1 * param2 * ssi_clk_mul_table[j];
248
249                 ret = rsnd_adg_clk_query(priv, main_rate);
250                 if (ret < 0)
251                         continue;
252
253                 if (idx)
254                         *idx = j;
255
256                 return main_rate;
257         }
258
259         return 0;
260 }
261
262 static int rsnd_ssi_master_clk_start(struct rsnd_mod *mod,
263                                      struct rsnd_dai_stream *io)
264 {
265         struct rsnd_priv *priv = rsnd_io_to_priv(io);
266         struct device *dev = rsnd_priv_to_dev(priv);
267         struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
268         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
269         int chan = rsnd_runtime_channel_for_ssi(io);
270         int idx, ret;
271         unsigned int main_rate;
272         unsigned int rate = rsnd_io_is_play(io) ?
273                 rsnd_src_get_out_rate(priv, io) :
274                 rsnd_src_get_in_rate(priv, io);
275
276         if (!rsnd_rdai_is_clk_master(rdai))
277                 return 0;
278
279         if (!rsnd_ssi_can_output_clk(mod))
280                 return 0;
281
282         if (rsnd_ssi_is_multi_slave(mod, io))
283                 return 0;
284
285         if (ssi->usrcnt > 1) {
286                 if (ssi->rate != rate) {
287                         dev_err(dev, "SSI parent/child should use same rate\n");
288                         return -EINVAL;
289                 }
290
291                 return 0;
292         }
293
294         main_rate = rsnd_ssi_clk_query(priv, rate, chan, &idx);
295         if (!main_rate) {
296                 dev_err(dev, "unsupported clock rate\n");
297                 return -EIO;
298         }
299
300         ret = rsnd_adg_ssi_clk_try_start(mod, main_rate);
301         if (ret < 0)
302                 return ret;
303
304         /*
305          * SSI clock will be output contiguously
306          * by below settings.
307          * This means, rsnd_ssi_master_clk_start()
308          * and rsnd_ssi_register_setup() are necessary
309          * for SSI parent
310          *
311          * SSICR  : FORCE, SCKD, SWSD
312          * SSIWSR : CONT
313          */
314         ssi->cr_clk = FORCE | SWL_32 | SCKD | SWSD | CKDV(idx);
315         ssi->wsr = CONT;
316         ssi->rate = rate;
317
318         dev_dbg(dev, "%s[%d] outputs %u Hz\n",
319                 rsnd_mod_name(mod),
320                 rsnd_mod_id(mod), rate);
321
322         return 0;
323 }
324
325 static void rsnd_ssi_master_clk_stop(struct rsnd_mod *mod,
326                                      struct rsnd_dai_stream *io)
327 {
328         struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
329         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
330
331         if (!rsnd_rdai_is_clk_master(rdai))
332                 return;
333
334         if (!rsnd_ssi_can_output_clk(mod))
335                 return;
336
337         if (ssi->usrcnt > 1)
338                 return;
339
340         ssi->cr_clk     = 0;
341         ssi->rate       = 0;
342
343         rsnd_adg_ssi_clk_stop(mod);
344 }
345
346 static void rsnd_ssi_config_init(struct rsnd_mod *mod,
347                                 struct rsnd_dai_stream *io)
348 {
349         struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
350         struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
351         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
352         u32 cr_own;
353         u32 cr_mode;
354         u32 wsr;
355         int is_tdm;
356
357         if (rsnd_ssi_is_parent(mod, io))
358                 return;
359
360         is_tdm = rsnd_runtime_is_ssi_tdm(io);
361
362         /*
363          * always use 32bit system word.
364          * see also rsnd_ssi_master_clk_enable()
365          */
366         cr_own = FORCE | SWL_32;
367
368         if (rdai->bit_clk_inv)
369                 cr_own |= SCKP;
370         if (rdai->frm_clk_inv ^ is_tdm)
371                 cr_own |= SWSP;
372         if (rdai->data_alignment)
373                 cr_own |= SDTA;
374         if (rdai->sys_delay)
375                 cr_own |= DEL;
376         if (rsnd_io_is_play(io))
377                 cr_own |= TRMD;
378
379         switch (snd_pcm_format_width(runtime->format)) {
380         case 16:
381                 cr_own |= DWL_16;
382                 break;
383         case 24:
384                 cr_own |= DWL_24;
385                 break;
386         }
387
388         if (rsnd_ssi_is_dma_mode(mod)) {
389                 cr_mode = UIEN | OIEN | /* over/under run */
390                           DMEN;         /* DMA : enable DMA */
391         } else {
392                 cr_mode = DIEN;         /* PIO : enable Data interrupt */
393         }
394
395         /*
396          * TDM Extend Mode
397          * see
398          *      rsnd_ssiu_init_gen2()
399          */
400         wsr = ssi->wsr;
401         if (is_tdm) {
402                 wsr     |= WS_MODE;
403                 cr_own  |= CHNL_8;
404         }
405
406         ssi->cr_own     = cr_own;
407         ssi->cr_mode    = cr_mode;
408         ssi->wsr        = wsr;
409 }
410
411 static void rsnd_ssi_register_setup(struct rsnd_mod *mod)
412 {
413         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
414
415         rsnd_mod_write(mod, SSIWSR,     ssi->wsr);
416         rsnd_mod_write(mod, SSICR,      ssi->cr_own     |
417                                         ssi->cr_clk     |
418                                         ssi->cr_mode    |
419                                         ssi->cr_en);
420 }
421
422 /*
423  *      SSI mod common functions
424  */
425 static int rsnd_ssi_init(struct rsnd_mod *mod,
426                          struct rsnd_dai_stream *io,
427                          struct rsnd_priv *priv)
428 {
429         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
430         int ret;
431
432         if (!rsnd_ssi_is_run_mods(mod, io))
433                 return 0;
434
435         ssi->usrcnt++;
436
437         rsnd_mod_power_on(mod);
438
439         ret = rsnd_ssi_master_clk_start(mod, io);
440         if (ret < 0)
441                 return ret;
442
443         rsnd_ssi_config_init(mod, io);
444
445         rsnd_ssi_register_setup(mod);
446
447         /* clear error status */
448         rsnd_ssi_status_clear(mod);
449
450         return 0;
451 }
452
453 static int rsnd_ssi_quit(struct rsnd_mod *mod,
454                          struct rsnd_dai_stream *io,
455                          struct rsnd_priv *priv)
456 {
457         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
458         struct device *dev = rsnd_priv_to_dev(priv);
459
460         if (!rsnd_ssi_is_run_mods(mod, io))
461                 return 0;
462
463         if (!ssi->usrcnt) {
464                 dev_err(dev, "%s[%d] usrcnt error\n",
465                         rsnd_mod_name(mod), rsnd_mod_id(mod));
466                 return -EIO;
467         }
468
469         if (!rsnd_ssi_is_parent(mod, io))
470                 ssi->cr_own     = 0;
471
472         rsnd_ssi_master_clk_stop(mod, io);
473
474         rsnd_mod_power_off(mod);
475
476         ssi->usrcnt--;
477
478         return 0;
479 }
480
481 static int rsnd_ssi_hw_params(struct rsnd_mod *mod,
482                               struct rsnd_dai_stream *io,
483                               struct snd_pcm_substream *substream,
484                               struct snd_pcm_hw_params *params)
485 {
486         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
487         int chan = params_channels(params);
488
489         /*
490          * snd_pcm_ops::hw_params will be called *before*
491          * snd_soc_dai_ops::trigger. Thus, ssi->usrcnt is 0
492          * in 1st call.
493          */
494         if (ssi->usrcnt) {
495                 /*
496                  * Already working.
497                  * It will happen if SSI has parent/child connection.
498                  * it is error if child <-> parent SSI uses
499                  * different channels.
500                  */
501                 if (ssi->chan != chan)
502                         return -EIO;
503         }
504
505         ssi->chan = chan;
506
507         return 0;
508 }
509
510 static int rsnd_ssi_start(struct rsnd_mod *mod,
511                           struct rsnd_dai_stream *io,
512                           struct rsnd_priv *priv)
513 {
514         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
515
516         if (!rsnd_ssi_is_run_mods(mod, io))
517                 return 0;
518
519         /*
520          * EN will be set via SSIU :: SSI_CONTROL
521          * if Multi channel mode
522          */
523         if (rsnd_ssi_multi_slaves_runtime(io))
524                 return 0;
525
526         /*
527          * EN is for data output.
528          * SSI parent EN is not needed.
529          */
530         if (rsnd_ssi_is_parent(mod, io))
531                 return 0;
532
533         ssi->cr_en = EN;
534
535         rsnd_mod_write(mod, SSICR,      ssi->cr_own     |
536                                         ssi->cr_clk     |
537                                         ssi->cr_mode    |
538                                         ssi->cr_en);
539
540         return 0;
541 }
542
543 static int rsnd_ssi_stop(struct rsnd_mod *mod,
544                          struct rsnd_dai_stream *io,
545                          struct rsnd_priv *priv)
546 {
547         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
548         u32 cr;
549
550         if (!rsnd_ssi_is_run_mods(mod, io))
551                 return 0;
552
553         if (rsnd_ssi_is_parent(mod, io))
554                 return 0;
555
556         cr  =   ssi->cr_own     |
557                 ssi->cr_clk;
558
559         /*
560          * disable all IRQ,
561          * Playback: Wait all data was sent
562          * Capture:  It might not receave data. Do nothing
563          */
564         if (rsnd_io_is_play(io)) {
565                 rsnd_mod_write(mod, SSICR, cr | EN);
566                 rsnd_ssi_status_check(mod, DIRQ);
567         }
568
569         /*
570          * disable SSI,
571          * and, wait idle state
572          */
573         rsnd_mod_write(mod, SSICR, cr); /* disabled all */
574         rsnd_ssi_status_check(mod, IIRQ);
575
576         ssi->cr_en = 0;
577
578         return 0;
579 }
580
581 static int rsnd_ssi_irq(struct rsnd_mod *mod,
582                         struct rsnd_dai_stream *io,
583                         struct rsnd_priv *priv,
584                         int enable)
585 {
586         u32 val = 0;
587
588         if (rsnd_is_gen1(priv))
589                 return 0;
590
591         if (rsnd_ssi_is_parent(mod, io))
592                 return 0;
593
594         if (!rsnd_ssi_is_run_mods(mod, io))
595                 return 0;
596
597         if (enable)
598                 val = rsnd_ssi_is_dma_mode(mod) ? 0x0e000000 : 0x0f000000;
599
600         rsnd_mod_write(mod, SSI_INT_ENABLE, val);
601
602         return 0;
603 }
604
605 static bool rsnd_ssi_pio_interrupt(struct rsnd_mod *mod,
606                                    struct rsnd_dai_stream *io);
607 static void __rsnd_ssi_interrupt(struct rsnd_mod *mod,
608                                  struct rsnd_dai_stream *io)
609 {
610         struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
611         struct device *dev = rsnd_priv_to_dev(priv);
612         int is_dma = rsnd_ssi_is_dma_mode(mod);
613         u32 status;
614         bool elapsed = false;
615         bool stop = false;
616
617         spin_lock(&priv->lock);
618
619         /* ignore all cases if not working */
620         if (!rsnd_io_is_working(io))
621                 goto rsnd_ssi_interrupt_out;
622
623         status = rsnd_ssi_status_get(mod);
624
625         /* PIO only */
626         if (!is_dma && (status & DIRQ))
627                 elapsed = rsnd_ssi_pio_interrupt(mod, io);
628
629         /* DMA only */
630         if (is_dma && (status & (UIRQ | OIRQ))) {
631                 rsnd_dbg_irq_status(dev, "%s[%d] err status : 0x%08x\n",
632                         rsnd_mod_name(mod), rsnd_mod_id(mod), status);
633
634                 stop = true;
635         }
636
637         rsnd_ssi_status_clear(mod);
638 rsnd_ssi_interrupt_out:
639         spin_unlock(&priv->lock);
640
641         if (elapsed)
642                 rsnd_dai_period_elapsed(io);
643
644         if (stop)
645                 snd_pcm_stop_xrun(io->substream);
646
647 }
648
649 static irqreturn_t rsnd_ssi_interrupt(int irq, void *data)
650 {
651         struct rsnd_mod *mod = data;
652
653         rsnd_mod_interrupt(mod, __rsnd_ssi_interrupt);
654
655         return IRQ_HANDLED;
656 }
657
658 /*
659  *              SSI PIO
660  */
661 static void rsnd_ssi_parent_attach(struct rsnd_mod *mod,
662                                    struct rsnd_dai_stream *io)
663 {
664         struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
665         struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
666
667         if (!__rsnd_ssi_is_pin_sharing(mod))
668                 return;
669
670         if (!rsnd_rdai_is_clk_master(rdai))
671                 return;
672
673         switch (rsnd_mod_id(mod)) {
674         case 1:
675         case 2:
676                 rsnd_dai_connect(rsnd_ssi_mod_get(priv, 0), io, RSND_MOD_SSIP);
677                 break;
678         case 4:
679                 rsnd_dai_connect(rsnd_ssi_mod_get(priv, 3), io, RSND_MOD_SSIP);
680                 break;
681         case 8:
682                 rsnd_dai_connect(rsnd_ssi_mod_get(priv, 7), io, RSND_MOD_SSIP);
683                 break;
684         }
685 }
686
687 static int rsnd_ssi_pcm_new(struct rsnd_mod *mod,
688                             struct rsnd_dai_stream *io,
689                             struct snd_soc_pcm_runtime *rtd)
690 {
691         /*
692          * rsnd_rdai_is_clk_master() will be enabled after set_fmt,
693          * and, pcm_new will be called after it.
694          * This function reuse pcm_new at this point.
695          */
696         rsnd_ssi_parent_attach(mod, io);
697
698         return 0;
699 }
700
701 static int rsnd_ssi_common_probe(struct rsnd_mod *mod,
702                                  struct rsnd_dai_stream *io,
703                                  struct rsnd_priv *priv)
704 {
705         struct device *dev = rsnd_priv_to_dev(priv);
706         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
707         int ret;
708
709         /*
710          * SSIP/SSIU/IRQ are not needed on
711          * SSI Multi slaves
712          */
713         if (rsnd_ssi_is_multi_slave(mod, io))
714                 return 0;
715
716         /*
717          * It can't judge ssi parent at this point
718          * see rsnd_ssi_pcm_new()
719          */
720
721         ret = rsnd_ssiu_attach(io, mod);
722         if (ret < 0)
723                 return ret;
724
725         /*
726          * SSI might be called again as PIO fallback
727          * It is easy to manual handling for IRQ request/free
728          *
729          * OTOH, this function might be called many times if platform is
730          * using MIX. It needs xxx_attach() many times on xxx_probe().
731          * Because of it, we can't control .probe/.remove calling count by
732          * mod->status.
733          * But it don't need to call request_irq() many times.
734          * Let's control it by RSND_SSI_PROBED flag.
735          */
736         if (!rsnd_flags_has(ssi, RSND_SSI_PROBED)) {
737                 ret = request_irq(ssi->irq,
738                                   rsnd_ssi_interrupt,
739                                   IRQF_SHARED,
740                                   dev_name(dev), mod);
741
742                 rsnd_flags_set(ssi, RSND_SSI_PROBED);
743         }
744
745         return ret;
746 }
747
748 static int rsnd_ssi_common_remove(struct rsnd_mod *mod,
749                                   struct rsnd_dai_stream *io,
750                                   struct rsnd_priv *priv)
751 {
752         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
753         struct rsnd_mod *pure_ssi_mod = rsnd_io_to_mod_ssi(io);
754
755         /* Do nothing if non SSI (= SSI parent, multi SSI) mod */
756         if (pure_ssi_mod != mod)
757                 return 0;
758
759         /* PIO will request IRQ again */
760         if (rsnd_flags_has(ssi, RSND_SSI_PROBED)) {
761                 free_irq(ssi->irq, mod);
762
763                 rsnd_flags_del(ssi, RSND_SSI_PROBED);
764         }
765
766         return 0;
767 }
768
769 /*
770  *      SSI PIO functions
771  */
772 static bool rsnd_ssi_pio_interrupt(struct rsnd_mod *mod,
773                                    struct rsnd_dai_stream *io)
774 {
775         struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
776         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
777         u32 *buf = (u32 *)(runtime->dma_area + ssi->byte_pos);
778         int shift = 0;
779         int byte_pos;
780         bool elapsed = false;
781
782         if (snd_pcm_format_width(runtime->format) == 24)
783                 shift = 8;
784
785         /*
786          * 8/16/32 data can be assesse to TDR/RDR register
787          * directly as 32bit data
788          * see rsnd_ssi_init()
789          */
790         if (rsnd_io_is_play(io))
791                 rsnd_mod_write(mod, SSITDR, (*buf) << shift);
792         else
793                 *buf = (rsnd_mod_read(mod, SSIRDR) >> shift);
794
795         byte_pos = ssi->byte_pos + sizeof(*buf);
796
797         if (byte_pos >= ssi->next_period_byte) {
798                 int period_pos = byte_pos / ssi->byte_per_period;
799
800                 if (period_pos >= runtime->periods) {
801                         byte_pos = 0;
802                         period_pos = 0;
803                 }
804
805                 ssi->next_period_byte = (period_pos + 1) * ssi->byte_per_period;
806
807                 elapsed = true;
808         }
809
810         WRITE_ONCE(ssi->byte_pos, byte_pos);
811
812         return elapsed;
813 }
814
815 static int rsnd_ssi_pio_init(struct rsnd_mod *mod,
816                              struct rsnd_dai_stream *io,
817                              struct rsnd_priv *priv)
818 {
819         struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
820         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
821
822         if (!rsnd_ssi_is_parent(mod, io)) {
823                 ssi->byte_pos           = 0;
824                 ssi->byte_per_period    = runtime->period_size *
825                                           runtime->channels *
826                                           samples_to_bytes(runtime, 1);
827                 ssi->next_period_byte   = ssi->byte_per_period;
828         }
829
830         return rsnd_ssi_init(mod, io, priv);
831 }
832
833 static int rsnd_ssi_pio_pointer(struct rsnd_mod *mod,
834                             struct rsnd_dai_stream *io,
835                             snd_pcm_uframes_t *pointer)
836 {
837         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
838         struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
839
840         *pointer = bytes_to_frames(runtime, READ_ONCE(ssi->byte_pos));
841
842         return 0;
843 }
844
845 static struct rsnd_mod_ops rsnd_ssi_pio_ops = {
846         .name   = SSI_NAME,
847         .probe  = rsnd_ssi_common_probe,
848         .remove = rsnd_ssi_common_remove,
849         .init   = rsnd_ssi_pio_init,
850         .quit   = rsnd_ssi_quit,
851         .start  = rsnd_ssi_start,
852         .stop   = rsnd_ssi_stop,
853         .irq    = rsnd_ssi_irq,
854         .pointer = rsnd_ssi_pio_pointer,
855         .pcm_new = rsnd_ssi_pcm_new,
856         .hw_params = rsnd_ssi_hw_params,
857 };
858
859 static int rsnd_ssi_dma_probe(struct rsnd_mod *mod,
860                               struct rsnd_dai_stream *io,
861                               struct rsnd_priv *priv)
862 {
863         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
864         int ret;
865
866         /*
867          * SSIP/SSIU/IRQ/DMA are not needed on
868          * SSI Multi slaves
869          */
870         if (rsnd_ssi_is_multi_slave(mod, io))
871                 return 0;
872
873         ret = rsnd_ssi_common_probe(mod, io, priv);
874         if (ret)
875                 return ret;
876
877         /* SSI probe might be called many times in MUX multi path */
878         ret = rsnd_dma_attach(io, mod, &ssi->dma);
879
880         return ret;
881 }
882
883 static int rsnd_ssi_fallback(struct rsnd_mod *mod,
884                              struct rsnd_dai_stream *io,
885                              struct rsnd_priv *priv)
886 {
887         struct device *dev = rsnd_priv_to_dev(priv);
888
889         /*
890          * fallback to PIO
891          *
892          * SSI .probe might be called again.
893          * see
894          *      rsnd_rdai_continuance_probe()
895          */
896         mod->ops = &rsnd_ssi_pio_ops;
897
898         dev_info(dev, "%s[%d] fallback to PIO mode\n",
899                  rsnd_mod_name(mod), rsnd_mod_id(mod));
900
901         return 0;
902 }
903
904 static struct dma_chan *rsnd_ssi_dma_req(struct rsnd_dai_stream *io,
905                                          struct rsnd_mod *mod)
906 {
907         struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
908         int is_play = rsnd_io_is_play(io);
909         char *name;
910
911         if (rsnd_ssi_use_busif(io))
912                 name = is_play ? "rxu" : "txu";
913         else
914                 name = is_play ? "rx" : "tx";
915
916         return rsnd_dma_request_channel(rsnd_ssi_of_node(priv),
917                                         mod, name);
918 }
919
920 static struct rsnd_mod_ops rsnd_ssi_dma_ops = {
921         .name   = SSI_NAME,
922         .dma_req = rsnd_ssi_dma_req,
923         .probe  = rsnd_ssi_dma_probe,
924         .remove = rsnd_ssi_common_remove,
925         .init   = rsnd_ssi_init,
926         .quit   = rsnd_ssi_quit,
927         .start  = rsnd_ssi_start,
928         .stop   = rsnd_ssi_stop,
929         .irq    = rsnd_ssi_irq,
930         .pcm_new = rsnd_ssi_pcm_new,
931         .fallback = rsnd_ssi_fallback,
932         .hw_params = rsnd_ssi_hw_params,
933 };
934
935 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod)
936 {
937         return mod->ops == &rsnd_ssi_dma_ops;
938 }
939
940
941 /*
942  *              ssi mod function
943  */
944 static void rsnd_ssi_connect(struct rsnd_mod *mod,
945                              struct rsnd_dai_stream *io)
946 {
947         struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
948         enum rsnd_mod_type types[] = {
949                 RSND_MOD_SSI,
950                 RSND_MOD_SSIM1,
951                 RSND_MOD_SSIM2,
952                 RSND_MOD_SSIM3,
953         };
954         enum rsnd_mod_type type;
955         int i;
956
957         /* try SSI -> SSIM1 -> SSIM2 -> SSIM3 */
958         for (i = 0; i < ARRAY_SIZE(types); i++) {
959                 type = types[i];
960                 if (!rsnd_io_to_mod(io, type)) {
961                         rsnd_dai_connect(mod, io, type);
962                         rsnd_rdai_channels_set(rdai, (i + 1) * 2);
963                         rsnd_rdai_ssi_lane_set(rdai, (i + 1));
964                         return;
965                 }
966         }
967 }
968
969 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
970                             struct device_node *playback,
971                             struct device_node *capture)
972 {
973         struct rsnd_priv *priv = rsnd_rdai_to_priv(rdai);
974         struct device_node *node;
975         struct device_node *np;
976         struct rsnd_mod *mod;
977         int i;
978
979         node = rsnd_ssi_of_node(priv);
980         if (!node)
981                 return;
982
983         i = 0;
984         for_each_child_of_node(node, np) {
985                 mod = rsnd_ssi_mod_get(priv, i);
986                 if (np == playback)
987                         rsnd_ssi_connect(mod, &rdai->playback);
988                 if (np == capture)
989                         rsnd_ssi_connect(mod, &rdai->capture);
990                 i++;
991         }
992
993         of_node_put(node);
994 }
995
996 static void __rsnd_ssi_parse_hdmi_connection(struct rsnd_priv *priv,
997                                              struct rsnd_dai_stream *io,
998                                              struct device_node *remote_ep)
999 {
1000         struct device *dev = rsnd_priv_to_dev(priv);
1001         struct rsnd_mod *mod = rsnd_io_to_mod_ssi(io);
1002         struct rsnd_ssi *ssi;
1003         struct device_node *remote_node = of_graph_get_port_parent(remote_ep);
1004
1005         /* support Gen3 only */
1006         if (!rsnd_is_gen3(priv))
1007                 return;
1008
1009         if (!mod)
1010                 return;
1011
1012         ssi  = rsnd_mod_to_ssi(mod);
1013
1014         /* HDMI0 */
1015         if (strstr(remote_node->full_name, "hdmi@fead0000")) {
1016                 rsnd_flags_set(ssi, RSND_SSI_HDMI0);
1017                 dev_dbg(dev, "%s[%d] connected to HDMI0\n",
1018                          rsnd_mod_name(mod), rsnd_mod_id(mod));
1019         }
1020
1021         /* HDMI1 */
1022         if (strstr(remote_node->full_name, "hdmi@feae0000")) {
1023                 rsnd_flags_set(ssi, RSND_SSI_HDMI1);
1024                 dev_dbg(dev, "%s[%d] connected to HDMI1\n",
1025                         rsnd_mod_name(mod), rsnd_mod_id(mod));
1026         }
1027 }
1028
1029 void rsnd_ssi_parse_hdmi_connection(struct rsnd_priv *priv,
1030                                     struct device_node *endpoint,
1031                                     int dai_i)
1032 {
1033         struct rsnd_dai *rdai = rsnd_rdai_get(priv, dai_i);
1034         struct device_node *remote_ep;
1035
1036         remote_ep = of_graph_get_remote_endpoint(endpoint);
1037         if (!remote_ep)
1038                 return;
1039
1040         __rsnd_ssi_parse_hdmi_connection(priv, &rdai->playback, remote_ep);
1041         __rsnd_ssi_parse_hdmi_connection(priv, &rdai->capture,  remote_ep);
1042 }
1043
1044 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id)
1045 {
1046         if (WARN_ON(id < 0 || id >= rsnd_ssi_nr(priv)))
1047                 id = 0;
1048
1049         return rsnd_mod_get(rsnd_ssi_get(priv, id));
1050 }
1051
1052 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod)
1053 {
1054         struct rsnd_ssi *ssi = rsnd_mod_to_ssi(mod);
1055
1056         return !!(rsnd_flags_has(ssi, RSND_SSI_CLK_PIN_SHARE));
1057 }
1058
1059 static u32 *rsnd_ssi_get_status(struct rsnd_dai_stream *io,
1060                                 struct rsnd_mod *mod,
1061                                 enum rsnd_mod_type type)
1062 {
1063         /*
1064          * SSIP (= SSI parent) needs to be special, otherwise,
1065          * 2nd SSI might doesn't start. see also rsnd_mod_call()
1066          *
1067          * We can't include parent SSI status on SSI, because we don't know
1068          * how many SSI requests parent SSI. Thus, it is localed on "io" now.
1069          * ex) trouble case
1070          *      Playback: SSI0
1071          *      Capture : SSI1 (needs SSI0)
1072          *
1073          * 1) start Capture  -> SSI0/SSI1 are started.
1074          * 2) start Playback -> SSI0 doesn't work, because it is already
1075          *                      marked as "started" on 1)
1076          *
1077          * OTOH, using each mod's status is good for MUX case.
1078          * It doesn't need to start in 2nd start
1079          * ex)
1080          *      IO-0: SRC0 -> CTU1 -+-> MUX -> DVC -> SSIU -> SSI0
1081          *                          |
1082          *      IO-1: SRC1 -> CTU2 -+
1083          *
1084          * 1) start IO-0 ->     start SSI0
1085          * 2) start IO-1 ->     SSI0 doesn't need to start, because it is
1086          *                      already started on 1)
1087          */
1088         if (type == RSND_MOD_SSIP)
1089                 return &io->parent_ssi_status;
1090
1091         return rsnd_mod_get_status(io, mod, type);
1092 }
1093
1094 int rsnd_ssi_probe(struct rsnd_priv *priv)
1095 {
1096         struct device_node *node;
1097         struct device_node *np;
1098         struct device *dev = rsnd_priv_to_dev(priv);
1099         struct rsnd_mod_ops *ops;
1100         struct clk *clk;
1101         struct rsnd_ssi *ssi;
1102         char name[RSND_SSI_NAME_SIZE];
1103         int i, nr, ret;
1104
1105         node = rsnd_ssi_of_node(priv);
1106         if (!node)
1107                 return -EINVAL;
1108
1109         nr = of_get_child_count(node);
1110         if (!nr) {
1111                 ret = -EINVAL;
1112                 goto rsnd_ssi_probe_done;
1113         }
1114
1115         ssi     = devm_kcalloc(dev, nr, sizeof(*ssi), GFP_KERNEL);
1116         if (!ssi) {
1117                 ret = -ENOMEM;
1118                 goto rsnd_ssi_probe_done;
1119         }
1120
1121         priv->ssi       = ssi;
1122         priv->ssi_nr    = nr;
1123
1124         i = 0;
1125         for_each_child_of_node(node, np) {
1126                 if (!of_device_is_available(np))
1127                         goto skip;
1128
1129                 ssi = rsnd_ssi_get(priv, i);
1130
1131                 snprintf(name, RSND_SSI_NAME_SIZE, "%s.%d",
1132                          SSI_NAME, i);
1133
1134                 clk = devm_clk_get(dev, name);
1135                 if (IS_ERR(clk)) {
1136                         ret = PTR_ERR(clk);
1137                         of_node_put(np);
1138                         goto rsnd_ssi_probe_done;
1139                 }
1140
1141                 if (of_get_property(np, "shared-pin", NULL))
1142                         rsnd_flags_set(ssi, RSND_SSI_CLK_PIN_SHARE);
1143
1144                 if (of_get_property(np, "no-busif", NULL))
1145                         rsnd_flags_set(ssi, RSND_SSI_NO_BUSIF);
1146
1147                 ssi->irq = irq_of_parse_and_map(np, 0);
1148                 if (!ssi->irq) {
1149                         ret = -EINVAL;
1150                         of_node_put(np);
1151                         goto rsnd_ssi_probe_done;
1152                 }
1153
1154                 if (of_property_read_bool(np, "pio-transfer"))
1155                         ops = &rsnd_ssi_pio_ops;
1156                 else
1157                         ops = &rsnd_ssi_dma_ops;
1158
1159                 ret = rsnd_mod_init(priv, rsnd_mod_get(ssi), ops, clk,
1160                                     rsnd_ssi_get_status, RSND_MOD_SSI, i);
1161                 if (ret) {
1162                         of_node_put(np);
1163                         goto rsnd_ssi_probe_done;
1164                 }
1165 skip:
1166                 i++;
1167         }
1168
1169         ret = 0;
1170
1171 rsnd_ssi_probe_done:
1172         of_node_put(node);
1173
1174         return ret;
1175 }
1176
1177 void rsnd_ssi_remove(struct rsnd_priv *priv)
1178 {
1179         struct rsnd_ssi *ssi;
1180         int i;
1181
1182         for_each_rsnd_ssi(ssi, priv, i) {
1183                 rsnd_mod_quit(rsnd_mod_get(ssi));
1184         }
1185 }