GNU Linux-libre 4.14.290-gnu1
[releases.git] / sound / soc / atmel / atmel_ssc_dai.c
1 /*
2  * atmel_ssc_dai.c  --  ALSA SoC ATMEL SSC Audio Layer Platform driver
3  *
4  * Copyright (C) 2005 SAN People
5  * Copyright (C) 2008 Atmel
6  *
7  * Author: Sedji Gaouaou <sedji.gaouaou@atmel.com>
8  *         ATMEL CORP.
9  *
10  * Based on at91-ssc.c by
11  * Frank Mandarino <fmandarino@endrelia.com>
12  * Based on pxa2xx Platform drivers by
13  * Liam Girdwood <lrg@slimlogic.co.uk>
14  *
15  * This program is free software; you can redistribute it and/or modify
16  * it under the terms of the GNU General Public License as published by
17  * the Free Software Foundation; either version 2 of the License, or
18  * (at your option) any later version.
19  *
20  * This program is distributed in the hope that it will be useful,
21  * but WITHOUT ANY WARRANTY; without even the implied warranty of
22  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
23  * GNU General Public License for more details.
24  *
25  * You should have received a copy of the GNU General Public License
26  * along with this program; if not, write to the Free Software
27  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
28  */
29
30 #include <linux/init.h>
31 #include <linux/module.h>
32 #include <linux/interrupt.h>
33 #include <linux/device.h>
34 #include <linux/delay.h>
35 #include <linux/clk.h>
36 #include <linux/atmel_pdc.h>
37
38 #include <linux/atmel-ssc.h>
39 #include <sound/core.h>
40 #include <sound/pcm.h>
41 #include <sound/pcm_params.h>
42 #include <sound/initval.h>
43 #include <sound/soc.h>
44
45 #include "atmel-pcm.h"
46 #include "atmel_ssc_dai.h"
47
48
49 #define NUM_SSC_DEVICES         3
50
51 /*
52  * SSC PDC registers required by the PCM DMA engine.
53  */
54 static struct atmel_pdc_regs pdc_tx_reg = {
55         .xpr            = ATMEL_PDC_TPR,
56         .xcr            = ATMEL_PDC_TCR,
57         .xnpr           = ATMEL_PDC_TNPR,
58         .xncr           = ATMEL_PDC_TNCR,
59 };
60
61 static struct atmel_pdc_regs pdc_rx_reg = {
62         .xpr            = ATMEL_PDC_RPR,
63         .xcr            = ATMEL_PDC_RCR,
64         .xnpr           = ATMEL_PDC_RNPR,
65         .xncr           = ATMEL_PDC_RNCR,
66 };
67
68 /*
69  * SSC & PDC status bits for transmit and receive.
70  */
71 static struct atmel_ssc_mask ssc_tx_mask = {
72         .ssc_enable     = SSC_BIT(CR_TXEN),
73         .ssc_disable    = SSC_BIT(CR_TXDIS),
74         .ssc_endx       = SSC_BIT(SR_ENDTX),
75         .ssc_endbuf     = SSC_BIT(SR_TXBUFE),
76         .ssc_error      = SSC_BIT(SR_OVRUN),
77         .pdc_enable     = ATMEL_PDC_TXTEN,
78         .pdc_disable    = ATMEL_PDC_TXTDIS,
79 };
80
81 static struct atmel_ssc_mask ssc_rx_mask = {
82         .ssc_enable     = SSC_BIT(CR_RXEN),
83         .ssc_disable    = SSC_BIT(CR_RXDIS),
84         .ssc_endx       = SSC_BIT(SR_ENDRX),
85         .ssc_endbuf     = SSC_BIT(SR_RXBUFF),
86         .ssc_error      = SSC_BIT(SR_OVRUN),
87         .pdc_enable     = ATMEL_PDC_RXTEN,
88         .pdc_disable    = ATMEL_PDC_RXTDIS,
89 };
90
91
92 /*
93  * DMA parameters.
94  */
95 static struct atmel_pcm_dma_params ssc_dma_params[NUM_SSC_DEVICES][2] = {
96         {{
97         .name           = "SSC0 PCM out",
98         .pdc            = &pdc_tx_reg,
99         .mask           = &ssc_tx_mask,
100         },
101         {
102         .name           = "SSC0 PCM in",
103         .pdc            = &pdc_rx_reg,
104         .mask           = &ssc_rx_mask,
105         } },
106         {{
107         .name           = "SSC1 PCM out",
108         .pdc            = &pdc_tx_reg,
109         .mask           = &ssc_tx_mask,
110         },
111         {
112         .name           = "SSC1 PCM in",
113         .pdc            = &pdc_rx_reg,
114         .mask           = &ssc_rx_mask,
115         } },
116         {{
117         .name           = "SSC2 PCM out",
118         .pdc            = &pdc_tx_reg,
119         .mask           = &ssc_tx_mask,
120         },
121         {
122         .name           = "SSC2 PCM in",
123         .pdc            = &pdc_rx_reg,
124         .mask           = &ssc_rx_mask,
125         } },
126 };
127
128
129 static struct atmel_ssc_info ssc_info[NUM_SSC_DEVICES] = {
130         {
131         .name           = "ssc0",
132         .lock           = __SPIN_LOCK_UNLOCKED(ssc_info[0].lock),
133         .dir_mask       = SSC_DIR_MASK_UNUSED,
134         .initialized    = 0,
135         },
136         {
137         .name           = "ssc1",
138         .lock           = __SPIN_LOCK_UNLOCKED(ssc_info[1].lock),
139         .dir_mask       = SSC_DIR_MASK_UNUSED,
140         .initialized    = 0,
141         },
142         {
143         .name           = "ssc2",
144         .lock           = __SPIN_LOCK_UNLOCKED(ssc_info[2].lock),
145         .dir_mask       = SSC_DIR_MASK_UNUSED,
146         .initialized    = 0,
147         },
148 };
149
150
151 /*
152  * SSC interrupt handler.  Passes PDC interrupts to the DMA
153  * interrupt handler in the PCM driver.
154  */
155 static irqreturn_t atmel_ssc_interrupt(int irq, void *dev_id)
156 {
157         struct atmel_ssc_info *ssc_p = dev_id;
158         struct atmel_pcm_dma_params *dma_params;
159         u32 ssc_sr;
160         u32 ssc_substream_mask;
161         int i;
162
163         ssc_sr = (unsigned long)ssc_readl(ssc_p->ssc->regs, SR)
164                         & (unsigned long)ssc_readl(ssc_p->ssc->regs, IMR);
165
166         /*
167          * Loop through the substreams attached to this SSC.  If
168          * a DMA-related interrupt occurred on that substream, call
169          * the DMA interrupt handler function, if one has been
170          * registered in the dma_params structure by the PCM driver.
171          */
172         for (i = 0; i < ARRAY_SIZE(ssc_p->dma_params); i++) {
173                 dma_params = ssc_p->dma_params[i];
174
175                 if ((dma_params != NULL) &&
176                         (dma_params->dma_intr_handler != NULL)) {
177                         ssc_substream_mask = (dma_params->mask->ssc_endx |
178                                         dma_params->mask->ssc_endbuf);
179                         if (ssc_sr & ssc_substream_mask) {
180                                 dma_params->dma_intr_handler(ssc_sr,
181                                                 dma_params->
182                                                 substream);
183                         }
184                 }
185         }
186
187         return IRQ_HANDLED;
188 }
189
190 /*
191  * When the bit clock is input, limit the maximum rate according to the
192  * Serial Clock Ratio Considerations section from the SSC documentation:
193  *
194  *   The Transmitter and the Receiver can be programmed to operate
195  *   with the clock signals provided on either the TK or RK pins.
196  *   This allows the SSC to support many slave-mode data transfers.
197  *   In this case, the maximum clock speed allowed on the RK pin is:
198  *   - Peripheral clock divided by 2 if Receiver Frame Synchro is input
199  *   - Peripheral clock divided by 3 if Receiver Frame Synchro is output
200  *   In addition, the maximum clock speed allowed on the TK pin is:
201  *   - Peripheral clock divided by 6 if Transmit Frame Synchro is input
202  *   - Peripheral clock divided by 2 if Transmit Frame Synchro is output
203  *
204  * When the bit clock is output, limit the rate according to the
205  * SSC divider restrictions.
206  */
207 static int atmel_ssc_hw_rule_rate(struct snd_pcm_hw_params *params,
208                                   struct snd_pcm_hw_rule *rule)
209 {
210         struct atmel_ssc_info *ssc_p = rule->private;
211         struct ssc_device *ssc = ssc_p->ssc;
212         struct snd_interval *i = hw_param_interval(params, rule->var);
213         struct snd_interval t;
214         struct snd_ratnum r = {
215                 .den_min = 1,
216                 .den_max = 4095,
217                 .den_step = 1,
218         };
219         unsigned int num = 0, den = 0;
220         int frame_size;
221         int mck_div = 2;
222         int ret;
223
224         frame_size = snd_soc_params_to_frame_size(params);
225         if (frame_size < 0)
226                 return frame_size;
227
228         switch (ssc_p->daifmt & SND_SOC_DAIFMT_MASTER_MASK) {
229         case SND_SOC_DAIFMT_CBM_CFS:
230                 if ((ssc_p->dir_mask & SSC_DIR_MASK_CAPTURE)
231                     && ssc->clk_from_rk_pin)
232                         /* Receiver Frame Synchro (i.e. capture)
233                          * is output (format is _CFS) and the RK pin
234                          * is used for input (format is _CBM_).
235                          */
236                         mck_div = 3;
237                 break;
238
239         case SND_SOC_DAIFMT_CBM_CFM:
240                 if ((ssc_p->dir_mask & SSC_DIR_MASK_PLAYBACK)
241                     && !ssc->clk_from_rk_pin)
242                         /* Transmit Frame Synchro (i.e. playback)
243                          * is input (format is _CFM) and the TK pin
244                          * is used for input (format _CBM_ but not
245                          * using the RK pin).
246                          */
247                         mck_div = 6;
248                 break;
249         }
250
251         switch (ssc_p->daifmt & SND_SOC_DAIFMT_MASTER_MASK) {
252         case SND_SOC_DAIFMT_CBS_CFS:
253                 r.num = ssc_p->mck_rate / mck_div / frame_size;
254
255                 ret = snd_interval_ratnum(i, 1, &r, &num, &den);
256                 if (ret >= 0 && den && rule->var == SNDRV_PCM_HW_PARAM_RATE) {
257                         params->rate_num = num;
258                         params->rate_den = den;
259                 }
260                 break;
261
262         case SND_SOC_DAIFMT_CBM_CFS:
263         case SND_SOC_DAIFMT_CBM_CFM:
264                 t.min = 8000;
265                 t.max = ssc_p->mck_rate / mck_div / frame_size;
266                 t.openmin = t.openmax = 0;
267                 t.integer = 0;
268                 ret = snd_interval_refine(i, &t);
269                 break;
270
271         default:
272                 ret = -EINVAL;
273                 break;
274         }
275
276         return ret;
277 }
278
279 /*-------------------------------------------------------------------------*\
280  * DAI functions
281 \*-------------------------------------------------------------------------*/
282 /*
283  * Startup.  Only that one substream allowed in each direction.
284  */
285 static int atmel_ssc_startup(struct snd_pcm_substream *substream,
286                              struct snd_soc_dai *dai)
287 {
288         struct platform_device *pdev = to_platform_device(dai->dev);
289         struct atmel_ssc_info *ssc_p = &ssc_info[pdev->id];
290         struct atmel_pcm_dma_params *dma_params;
291         int dir, dir_mask;
292         int ret;
293
294         pr_debug("atmel_ssc_startup: SSC_SR=0x%x\n",
295                 ssc_readl(ssc_p->ssc->regs, SR));
296
297         /* Enable PMC peripheral clock for this SSC */
298         pr_debug("atmel_ssc_dai: Starting clock\n");
299         ret = clk_enable(ssc_p->ssc->clk);
300         if (ret)
301                 return ret;
302
303         ssc_p->mck_rate = clk_get_rate(ssc_p->ssc->clk);
304
305         /* Reset the SSC unless initialized to keep it in a clean state */
306         if (!ssc_p->initialized)
307                 ssc_writel(ssc_p->ssc->regs, CR, SSC_BIT(CR_SWRST));
308
309         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
310                 dir = 0;
311                 dir_mask = SSC_DIR_MASK_PLAYBACK;
312         } else {
313                 dir = 1;
314                 dir_mask = SSC_DIR_MASK_CAPTURE;
315         }
316
317         ret = snd_pcm_hw_rule_add(substream->runtime, 0,
318                                   SNDRV_PCM_HW_PARAM_RATE,
319                                   atmel_ssc_hw_rule_rate,
320                                   ssc_p,
321                                   SNDRV_PCM_HW_PARAM_FRAME_BITS,
322                                   SNDRV_PCM_HW_PARAM_CHANNELS, -1);
323         if (ret < 0) {
324                 dev_err(dai->dev, "Failed to specify rate rule: %d\n", ret);
325                 return ret;
326         }
327
328         dma_params = &ssc_dma_params[pdev->id][dir];
329         dma_params->ssc = ssc_p->ssc;
330         dma_params->substream = substream;
331
332         ssc_p->dma_params[dir] = dma_params;
333
334         snd_soc_dai_set_dma_data(dai, substream, dma_params);
335
336         spin_lock_irq(&ssc_p->lock);
337         if (ssc_p->dir_mask & dir_mask) {
338                 spin_unlock_irq(&ssc_p->lock);
339                 return -EBUSY;
340         }
341         ssc_p->dir_mask |= dir_mask;
342         spin_unlock_irq(&ssc_p->lock);
343
344         return 0;
345 }
346
347 /*
348  * Shutdown.  Clear DMA parameters and shutdown the SSC if there
349  * are no other substreams open.
350  */
351 static void atmel_ssc_shutdown(struct snd_pcm_substream *substream,
352                                struct snd_soc_dai *dai)
353 {
354         struct platform_device *pdev = to_platform_device(dai->dev);
355         struct atmel_ssc_info *ssc_p = &ssc_info[pdev->id];
356         struct atmel_pcm_dma_params *dma_params;
357         int dir, dir_mask;
358
359         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
360                 dir = 0;
361         else
362                 dir = 1;
363
364         dma_params = ssc_p->dma_params[dir];
365
366         if (dma_params != NULL) {
367                 dma_params->ssc = NULL;
368                 dma_params->substream = NULL;
369                 ssc_p->dma_params[dir] = NULL;
370         }
371
372         dir_mask = 1 << dir;
373
374         spin_lock_irq(&ssc_p->lock);
375         ssc_p->dir_mask &= ~dir_mask;
376         if (!ssc_p->dir_mask) {
377                 if (ssc_p->initialized) {
378                         free_irq(ssc_p->ssc->irq, ssc_p);
379                         ssc_p->initialized = 0;
380                 }
381
382                 /* Reset the SSC */
383                 ssc_writel(ssc_p->ssc->regs, CR, SSC_BIT(CR_SWRST));
384                 /* Clear the SSC dividers */
385                 ssc_p->cmr_div = ssc_p->tcmr_period = ssc_p->rcmr_period = 0;
386                 ssc_p->forced_divider = 0;
387         }
388         spin_unlock_irq(&ssc_p->lock);
389
390         /* Shutdown the SSC clock. */
391         pr_debug("atmel_ssc_dai: Stopping clock\n");
392         clk_disable(ssc_p->ssc->clk);
393 }
394
395
396 /*
397  * Record the DAI format for use in hw_params().
398  */
399 static int atmel_ssc_set_dai_fmt(struct snd_soc_dai *cpu_dai,
400                 unsigned int fmt)
401 {
402         struct platform_device *pdev = to_platform_device(cpu_dai->dev);
403         struct atmel_ssc_info *ssc_p = &ssc_info[pdev->id];
404
405         ssc_p->daifmt = fmt;
406         return 0;
407 }
408
409 /*
410  * Record SSC clock dividers for use in hw_params().
411  */
412 static int atmel_ssc_set_dai_clkdiv(struct snd_soc_dai *cpu_dai,
413         int div_id, int div)
414 {
415         struct platform_device *pdev = to_platform_device(cpu_dai->dev);
416         struct atmel_ssc_info *ssc_p = &ssc_info[pdev->id];
417
418         switch (div_id) {
419         case ATMEL_SSC_CMR_DIV:
420                 /*
421                  * The same master clock divider is used for both
422                  * transmit and receive, so if a value has already
423                  * been set, it must match this value.
424                  */
425                 if (ssc_p->dir_mask !=
426                         (SSC_DIR_MASK_PLAYBACK | SSC_DIR_MASK_CAPTURE))
427                         ssc_p->cmr_div = div;
428                 else if (ssc_p->cmr_div == 0)
429                         ssc_p->cmr_div = div;
430                 else
431                         if (div != ssc_p->cmr_div)
432                                 return -EBUSY;
433                 ssc_p->forced_divider |= BIT(ATMEL_SSC_CMR_DIV);
434                 break;
435
436         case ATMEL_SSC_TCMR_PERIOD:
437                 ssc_p->tcmr_period = div;
438                 ssc_p->forced_divider |= BIT(ATMEL_SSC_TCMR_PERIOD);
439                 break;
440
441         case ATMEL_SSC_RCMR_PERIOD:
442                 ssc_p->rcmr_period = div;
443                 ssc_p->forced_divider |= BIT(ATMEL_SSC_RCMR_PERIOD);
444                 break;
445
446         default:
447                 return -EINVAL;
448         }
449
450         return 0;
451 }
452
453 /* Is the cpu-dai master of the frame clock? */
454 static int atmel_ssc_cfs(struct atmel_ssc_info *ssc_p)
455 {
456         switch (ssc_p->daifmt & SND_SOC_DAIFMT_MASTER_MASK) {
457         case SND_SOC_DAIFMT_CBM_CFS:
458         case SND_SOC_DAIFMT_CBS_CFS:
459                 return 1;
460         }
461         return 0;
462 }
463
464 /* Is the cpu-dai master of the bit clock? */
465 static int atmel_ssc_cbs(struct atmel_ssc_info *ssc_p)
466 {
467         switch (ssc_p->daifmt & SND_SOC_DAIFMT_MASTER_MASK) {
468         case SND_SOC_DAIFMT_CBS_CFM:
469         case SND_SOC_DAIFMT_CBS_CFS:
470                 return 1;
471         }
472         return 0;
473 }
474
475 /*
476  * Configure the SSC.
477  */
478 static int atmel_ssc_hw_params(struct snd_pcm_substream *substream,
479         struct snd_pcm_hw_params *params,
480         struct snd_soc_dai *dai)
481 {
482         struct platform_device *pdev = to_platform_device(dai->dev);
483         int id = pdev->id;
484         struct atmel_ssc_info *ssc_p = &ssc_info[id];
485         struct ssc_device *ssc = ssc_p->ssc;
486         struct atmel_pcm_dma_params *dma_params;
487         int dir, channels, bits;
488         u32 tfmr, rfmr, tcmr, rcmr;
489         int ret;
490         int fslen, fslen_ext;
491         u32 cmr_div;
492         u32 tcmr_period;
493         u32 rcmr_period;
494
495         /*
496          * Currently, there is only one set of dma params for
497          * each direction.  If more are added, this code will
498          * have to be changed to select the proper set.
499          */
500         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
501                 dir = 0;
502         else
503                 dir = 1;
504
505         /*
506          * If the cpu dai should provide BCLK, but noone has provided the
507          * divider needed for that to work, fall back to something sensible.
508          */
509         cmr_div = ssc_p->cmr_div;
510         if (!(ssc_p->forced_divider & BIT(ATMEL_SSC_CMR_DIV)) &&
511             atmel_ssc_cbs(ssc_p)) {
512                 int bclk_rate = snd_soc_params_to_bclk(params);
513
514                 if (bclk_rate < 0) {
515                         dev_err(dai->dev, "unable to calculate cmr_div: %d\n",
516                                 bclk_rate);
517                         return bclk_rate;
518                 }
519
520                 cmr_div = DIV_ROUND_CLOSEST(ssc_p->mck_rate, 2 * bclk_rate);
521         }
522
523         /*
524          * If the cpu dai should provide LRCLK, but noone has provided the
525          * dividers needed for that to work, fall back to something sensible.
526          */
527         tcmr_period = ssc_p->tcmr_period;
528         rcmr_period = ssc_p->rcmr_period;
529         if (atmel_ssc_cfs(ssc_p)) {
530                 int frame_size = snd_soc_params_to_frame_size(params);
531
532                 if (frame_size < 0) {
533                         dev_err(dai->dev,
534                                 "unable to calculate tx/rx cmr_period: %d\n",
535                                 frame_size);
536                         return frame_size;
537                 }
538
539                 if (!(ssc_p->forced_divider & BIT(ATMEL_SSC_TCMR_PERIOD)))
540                         tcmr_period = frame_size / 2 - 1;
541                 if (!(ssc_p->forced_divider & BIT(ATMEL_SSC_RCMR_PERIOD)))
542                         rcmr_period = frame_size / 2 - 1;
543         }
544
545         dma_params = ssc_p->dma_params[dir];
546
547         channels = params_channels(params);
548
549         /*
550          * Determine sample size in bits and the PDC increment.
551          */
552         switch (params_format(params)) {
553         case SNDRV_PCM_FORMAT_S8:
554                 bits = 8;
555                 dma_params->pdc_xfer_size = 1;
556                 break;
557         case SNDRV_PCM_FORMAT_S16_LE:
558                 bits = 16;
559                 dma_params->pdc_xfer_size = 2;
560                 break;
561         case SNDRV_PCM_FORMAT_S24_LE:
562                 bits = 24;
563                 dma_params->pdc_xfer_size = 4;
564                 break;
565         case SNDRV_PCM_FORMAT_S32_LE:
566                 bits = 32;
567                 dma_params->pdc_xfer_size = 4;
568                 break;
569         default:
570                 printk(KERN_WARNING "atmel_ssc_dai: unsupported PCM format");
571                 return -EINVAL;
572         }
573
574         /*
575          * Compute SSC register settings.
576          */
577         switch (ssc_p->daifmt
578                 & (SND_SOC_DAIFMT_FORMAT_MASK | SND_SOC_DAIFMT_MASTER_MASK)) {
579
580         case SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBS_CFS:
581                 /*
582                  * I2S format, SSC provides BCLK and LRC clocks.
583                  *
584                  * The SSC transmit and receive clocks are generated
585                  * from the MCK divider, and the BCLK signal
586                  * is output on the SSC TK line.
587                  */
588
589                 if (bits > 16 && !ssc->pdata->has_fslen_ext) {
590                         dev_err(dai->dev,
591                                 "sample size %d is too large for SSC device\n",
592                                 bits);
593                         return -EINVAL;
594                 }
595
596                 fslen_ext = (bits - 1) / 16;
597                 fslen = (bits - 1) % 16;
598
599                 rcmr =    SSC_BF(RCMR_PERIOD, rcmr_period)
600                         | SSC_BF(RCMR_STTDLY, START_DELAY)
601                         | SSC_BF(RCMR_START, SSC_START_FALLING_RF)
602                         | SSC_BF(RCMR_CKI, SSC_CKI_RISING)
603                         | SSC_BF(RCMR_CKO, SSC_CKO_NONE)
604                         | SSC_BF(RCMR_CKS, SSC_CKS_DIV);
605
606                 rfmr =    SSC_BF(RFMR_FSLEN_EXT, fslen_ext)
607                         | SSC_BF(RFMR_FSEDGE, SSC_FSEDGE_POSITIVE)
608                         | SSC_BF(RFMR_FSOS, SSC_FSOS_NEGATIVE)
609                         | SSC_BF(RFMR_FSLEN, fslen)
610                         | SSC_BF(RFMR_DATNB, (channels - 1))
611                         | SSC_BIT(RFMR_MSBF)
612                         | SSC_BF(RFMR_LOOP, 0)
613                         | SSC_BF(RFMR_DATLEN, (bits - 1));
614
615                 tcmr =    SSC_BF(TCMR_PERIOD, tcmr_period)
616                         | SSC_BF(TCMR_STTDLY, START_DELAY)
617                         | SSC_BF(TCMR_START, SSC_START_FALLING_RF)
618                         | SSC_BF(TCMR_CKI, SSC_CKI_FALLING)
619                         | SSC_BF(TCMR_CKO, SSC_CKO_CONTINUOUS)
620                         | SSC_BF(TCMR_CKS, SSC_CKS_DIV);
621
622                 tfmr =    SSC_BF(TFMR_FSLEN_EXT, fslen_ext)
623                         | SSC_BF(TFMR_FSEDGE, SSC_FSEDGE_POSITIVE)
624                         | SSC_BF(TFMR_FSDEN, 0)
625                         | SSC_BF(TFMR_FSOS, SSC_FSOS_NEGATIVE)
626                         | SSC_BF(TFMR_FSLEN, fslen)
627                         | SSC_BF(TFMR_DATNB, (channels - 1))
628                         | SSC_BIT(TFMR_MSBF)
629                         | SSC_BF(TFMR_DATDEF, 0)
630                         | SSC_BF(TFMR_DATLEN, (bits - 1));
631                 break;
632
633         case SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFM:
634                 /* I2S format, CODEC supplies BCLK and LRC clocks. */
635                 rcmr =    SSC_BF(RCMR_PERIOD, 0)
636                         | SSC_BF(RCMR_STTDLY, START_DELAY)
637                         | SSC_BF(RCMR_START, SSC_START_FALLING_RF)
638                         | SSC_BF(RCMR_CKI, SSC_CKI_RISING)
639                         | SSC_BF(RCMR_CKO, SSC_CKO_NONE)
640                         | SSC_BF(RCMR_CKS, ssc->clk_from_rk_pin ?
641                                            SSC_CKS_PIN : SSC_CKS_CLOCK);
642
643                 rfmr =    SSC_BF(RFMR_FSEDGE, SSC_FSEDGE_POSITIVE)
644                         | SSC_BF(RFMR_FSOS, SSC_FSOS_NONE)
645                         | SSC_BF(RFMR_FSLEN, 0)
646                         | SSC_BF(RFMR_DATNB, (channels - 1))
647                         | SSC_BIT(RFMR_MSBF)
648                         | SSC_BF(RFMR_LOOP, 0)
649                         | SSC_BF(RFMR_DATLEN, (bits - 1));
650
651                 tcmr =    SSC_BF(TCMR_PERIOD, 0)
652                         | SSC_BF(TCMR_STTDLY, START_DELAY)
653                         | SSC_BF(TCMR_START, SSC_START_FALLING_RF)
654                         | SSC_BF(TCMR_CKI, SSC_CKI_FALLING)
655                         | SSC_BF(TCMR_CKO, SSC_CKO_NONE)
656                         | SSC_BF(TCMR_CKS, ssc->clk_from_rk_pin ?
657                                            SSC_CKS_CLOCK : SSC_CKS_PIN);
658
659                 tfmr =    SSC_BF(TFMR_FSEDGE, SSC_FSEDGE_POSITIVE)
660                         | SSC_BF(TFMR_FSDEN, 0)
661                         | SSC_BF(TFMR_FSOS, SSC_FSOS_NONE)
662                         | SSC_BF(TFMR_FSLEN, 0)
663                         | SSC_BF(TFMR_DATNB, (channels - 1))
664                         | SSC_BIT(TFMR_MSBF)
665                         | SSC_BF(TFMR_DATDEF, 0)
666                         | SSC_BF(TFMR_DATLEN, (bits - 1));
667                 break;
668
669         case SND_SOC_DAIFMT_I2S | SND_SOC_DAIFMT_CBM_CFS:
670                 /* I2S format, CODEC supplies BCLK, SSC supplies LRCLK. */
671                 if (bits > 16 && !ssc->pdata->has_fslen_ext) {
672                         dev_err(dai->dev,
673                                 "sample size %d is too large for SSC device\n",
674                                 bits);
675                         return -EINVAL;
676                 }
677
678                 fslen_ext = (bits - 1) / 16;
679                 fslen = (bits - 1) % 16;
680
681                 rcmr =    SSC_BF(RCMR_PERIOD, rcmr_period)
682                         | SSC_BF(RCMR_STTDLY, START_DELAY)
683                         | SSC_BF(RCMR_START, SSC_START_FALLING_RF)
684                         | SSC_BF(RCMR_CKI, SSC_CKI_RISING)
685                         | SSC_BF(RCMR_CKO, SSC_CKO_NONE)
686                         | SSC_BF(RCMR_CKS, ssc->clk_from_rk_pin ?
687                                            SSC_CKS_PIN : SSC_CKS_CLOCK);
688
689                 rfmr =    SSC_BF(RFMR_FSLEN_EXT, fslen_ext)
690                         | SSC_BF(RFMR_FSEDGE, SSC_FSEDGE_POSITIVE)
691                         | SSC_BF(RFMR_FSOS, SSC_FSOS_NEGATIVE)
692                         | SSC_BF(RFMR_FSLEN, fslen)
693                         | SSC_BF(RFMR_DATNB, (channels - 1))
694                         | SSC_BIT(RFMR_MSBF)
695                         | SSC_BF(RFMR_LOOP, 0)
696                         | SSC_BF(RFMR_DATLEN, (bits - 1));
697
698                 tcmr =    SSC_BF(TCMR_PERIOD, tcmr_period)
699                         | SSC_BF(TCMR_STTDLY, START_DELAY)
700                         | SSC_BF(TCMR_START, SSC_START_FALLING_RF)
701                         | SSC_BF(TCMR_CKI, SSC_CKI_FALLING)
702                         | SSC_BF(TCMR_CKO, SSC_CKO_NONE)
703                         | SSC_BF(TCMR_CKS, ssc->clk_from_rk_pin ?
704                                            SSC_CKS_CLOCK : SSC_CKS_PIN);
705
706                 tfmr =    SSC_BF(TFMR_FSLEN_EXT, fslen_ext)
707                         | SSC_BF(TFMR_FSEDGE, SSC_FSEDGE_NEGATIVE)
708                         | SSC_BF(TFMR_FSDEN, 0)
709                         | SSC_BF(TFMR_FSOS, SSC_FSOS_NEGATIVE)
710                         | SSC_BF(TFMR_FSLEN, fslen)
711                         | SSC_BF(TFMR_DATNB, (channels - 1))
712                         | SSC_BIT(TFMR_MSBF)
713                         | SSC_BF(TFMR_DATDEF, 0)
714                         | SSC_BF(TFMR_DATLEN, (bits - 1));
715                 break;
716
717         case SND_SOC_DAIFMT_DSP_A | SND_SOC_DAIFMT_CBS_CFS:
718                 /*
719                  * DSP/PCM Mode A format, SSC provides BCLK and LRC clocks.
720                  *
721                  * The SSC transmit and receive clocks are generated from the
722                  * MCK divider, and the BCLK signal is output
723                  * on the SSC TK line.
724                  */
725                 rcmr =    SSC_BF(RCMR_PERIOD, rcmr_period)
726                         | SSC_BF(RCMR_STTDLY, 1)
727                         | SSC_BF(RCMR_START, SSC_START_RISING_RF)
728                         | SSC_BF(RCMR_CKI, SSC_CKI_RISING)
729                         | SSC_BF(RCMR_CKO, SSC_CKO_NONE)
730                         | SSC_BF(RCMR_CKS, SSC_CKS_DIV);
731
732                 rfmr =    SSC_BF(RFMR_FSEDGE, SSC_FSEDGE_POSITIVE)
733                         | SSC_BF(RFMR_FSOS, SSC_FSOS_POSITIVE)
734                         | SSC_BF(RFMR_FSLEN, 0)
735                         | SSC_BF(RFMR_DATNB, (channels - 1))
736                         | SSC_BIT(RFMR_MSBF)
737                         | SSC_BF(RFMR_LOOP, 0)
738                         | SSC_BF(RFMR_DATLEN, (bits - 1));
739
740                 tcmr =    SSC_BF(TCMR_PERIOD, tcmr_period)
741                         | SSC_BF(TCMR_STTDLY, 1)
742                         | SSC_BF(TCMR_START, SSC_START_RISING_RF)
743                         | SSC_BF(TCMR_CKI, SSC_CKI_FALLING)
744                         | SSC_BF(TCMR_CKO, SSC_CKO_CONTINUOUS)
745                         | SSC_BF(TCMR_CKS, SSC_CKS_DIV);
746
747                 tfmr =    SSC_BF(TFMR_FSEDGE, SSC_FSEDGE_POSITIVE)
748                         | SSC_BF(TFMR_FSDEN, 0)
749                         | SSC_BF(TFMR_FSOS, SSC_FSOS_POSITIVE)
750                         | SSC_BF(TFMR_FSLEN, 0)
751                         | SSC_BF(TFMR_DATNB, (channels - 1))
752                         | SSC_BIT(TFMR_MSBF)
753                         | SSC_BF(TFMR_DATDEF, 0)
754                         | SSC_BF(TFMR_DATLEN, (bits - 1));
755                 break;
756
757         case SND_SOC_DAIFMT_DSP_A | SND_SOC_DAIFMT_CBM_CFM:
758                 /*
759                  * DSP/PCM Mode A format, CODEC supplies BCLK and LRC clocks.
760                  *
761                  * Data is transferred on first BCLK after LRC pulse rising
762                  * edge.If stereo, the right channel data is contiguous with
763                  * the left channel data.
764                  */
765                 rcmr =    SSC_BF(RCMR_PERIOD, 0)
766                         | SSC_BF(RCMR_STTDLY, START_DELAY)
767                         | SSC_BF(RCMR_START, SSC_START_RISING_RF)
768                         | SSC_BF(RCMR_CKI, SSC_CKI_RISING)
769                         | SSC_BF(RCMR_CKO, SSC_CKO_NONE)
770                         | SSC_BF(RCMR_CKS, ssc->clk_from_rk_pin ?
771                                            SSC_CKS_PIN : SSC_CKS_CLOCK);
772
773                 rfmr =    SSC_BF(RFMR_FSEDGE, SSC_FSEDGE_POSITIVE)
774                         | SSC_BF(RFMR_FSOS, SSC_FSOS_NONE)
775                         | SSC_BF(RFMR_FSLEN, 0)
776                         | SSC_BF(RFMR_DATNB, (channels - 1))
777                         | SSC_BIT(RFMR_MSBF)
778                         | SSC_BF(RFMR_LOOP, 0)
779                         | SSC_BF(RFMR_DATLEN, (bits - 1));
780
781                 tcmr =    SSC_BF(TCMR_PERIOD, 0)
782                         | SSC_BF(TCMR_STTDLY, START_DELAY)
783                         | SSC_BF(TCMR_START, SSC_START_RISING_RF)
784                         | SSC_BF(TCMR_CKI, SSC_CKI_FALLING)
785                         | SSC_BF(TCMR_CKO, SSC_CKO_NONE)
786                         | SSC_BF(RCMR_CKS, ssc->clk_from_rk_pin ?
787                                            SSC_CKS_CLOCK : SSC_CKS_PIN);
788
789                 tfmr =    SSC_BF(TFMR_FSEDGE, SSC_FSEDGE_POSITIVE)
790                         | SSC_BF(TFMR_FSDEN, 0)
791                         | SSC_BF(TFMR_FSOS, SSC_FSOS_NONE)
792                         | SSC_BF(TFMR_FSLEN, 0)
793                         | SSC_BF(TFMR_DATNB, (channels - 1))
794                         | SSC_BIT(TFMR_MSBF)
795                         | SSC_BF(TFMR_DATDEF, 0)
796                         | SSC_BF(TFMR_DATLEN, (bits - 1));
797                 break;
798
799         default:
800                 printk(KERN_WARNING "atmel_ssc_dai: unsupported DAI format 0x%x\n",
801                         ssc_p->daifmt);
802                 return -EINVAL;
803         }
804         pr_debug("atmel_ssc_hw_params: "
805                         "RCMR=%08x RFMR=%08x TCMR=%08x TFMR=%08x\n",
806                         rcmr, rfmr, tcmr, tfmr);
807
808         if (!ssc_p->initialized) {
809                 if (!ssc_p->ssc->pdata->use_dma) {
810                         ssc_writel(ssc_p->ssc->regs, PDC_RPR, 0);
811                         ssc_writel(ssc_p->ssc->regs, PDC_RCR, 0);
812                         ssc_writel(ssc_p->ssc->regs, PDC_RNPR, 0);
813                         ssc_writel(ssc_p->ssc->regs, PDC_RNCR, 0);
814
815                         ssc_writel(ssc_p->ssc->regs, PDC_TPR, 0);
816                         ssc_writel(ssc_p->ssc->regs, PDC_TCR, 0);
817                         ssc_writel(ssc_p->ssc->regs, PDC_TNPR, 0);
818                         ssc_writel(ssc_p->ssc->regs, PDC_TNCR, 0);
819                 }
820
821                 ret = request_irq(ssc_p->ssc->irq, atmel_ssc_interrupt, 0,
822                                 ssc_p->name, ssc_p);
823                 if (ret < 0) {
824                         printk(KERN_WARNING
825                                         "atmel_ssc_dai: request_irq failure\n");
826                         pr_debug("Atmel_ssc_dai: Stoping clock\n");
827                         clk_disable(ssc_p->ssc->clk);
828                         return ret;
829                 }
830
831                 ssc_p->initialized = 1;
832         }
833
834         /* set SSC clock mode register */
835         ssc_writel(ssc_p->ssc->regs, CMR, cmr_div);
836
837         /* set receive clock mode and format */
838         ssc_writel(ssc_p->ssc->regs, RCMR, rcmr);
839         ssc_writel(ssc_p->ssc->regs, RFMR, rfmr);
840
841         /* set transmit clock mode and format */
842         ssc_writel(ssc_p->ssc->regs, TCMR, tcmr);
843         ssc_writel(ssc_p->ssc->regs, TFMR, tfmr);
844
845         pr_debug("atmel_ssc_dai,hw_params: SSC initialized\n");
846         return 0;
847 }
848
849
850 static int atmel_ssc_prepare(struct snd_pcm_substream *substream,
851                              struct snd_soc_dai *dai)
852 {
853         struct platform_device *pdev = to_platform_device(dai->dev);
854         struct atmel_ssc_info *ssc_p = &ssc_info[pdev->id];
855         struct atmel_pcm_dma_params *dma_params;
856         int dir;
857
858         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
859                 dir = 0;
860         else
861                 dir = 1;
862
863         dma_params = ssc_p->dma_params[dir];
864
865         ssc_writel(ssc_p->ssc->regs, CR, dma_params->mask->ssc_disable);
866         ssc_writel(ssc_p->ssc->regs, IDR, dma_params->mask->ssc_error);
867
868         pr_debug("%s enabled SSC_SR=0x%08x\n",
869                         dir ? "receive" : "transmit",
870                         ssc_readl(ssc_p->ssc->regs, SR));
871         return 0;
872 }
873
874 static int atmel_ssc_trigger(struct snd_pcm_substream *substream,
875                              int cmd, struct snd_soc_dai *dai)
876 {
877         struct platform_device *pdev = to_platform_device(dai->dev);
878         struct atmel_ssc_info *ssc_p = &ssc_info[pdev->id];
879         struct atmel_pcm_dma_params *dma_params;
880         int dir;
881
882         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
883                 dir = 0;
884         else
885                 dir = 1;
886
887         dma_params = ssc_p->dma_params[dir];
888
889         switch (cmd) {
890         case SNDRV_PCM_TRIGGER_START:
891         case SNDRV_PCM_TRIGGER_RESUME:
892         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
893                 ssc_writel(ssc_p->ssc->regs, CR, dma_params->mask->ssc_enable);
894                 break;
895         default:
896                 ssc_writel(ssc_p->ssc->regs, CR, dma_params->mask->ssc_disable);
897                 break;
898         }
899
900         return 0;
901 }
902
903 #ifdef CONFIG_PM
904 static int atmel_ssc_suspend(struct snd_soc_dai *cpu_dai)
905 {
906         struct atmel_ssc_info *ssc_p;
907         struct platform_device *pdev = to_platform_device(cpu_dai->dev);
908
909         if (!cpu_dai->active)
910                 return 0;
911
912         ssc_p = &ssc_info[pdev->id];
913
914         /* Save the status register before disabling transmit and receive */
915         ssc_p->ssc_state.ssc_sr = ssc_readl(ssc_p->ssc->regs, SR);
916         ssc_writel(ssc_p->ssc->regs, CR, SSC_BIT(CR_TXDIS) | SSC_BIT(CR_RXDIS));
917
918         /* Save the current interrupt mask, then disable unmasked interrupts */
919         ssc_p->ssc_state.ssc_imr = ssc_readl(ssc_p->ssc->regs, IMR);
920         ssc_writel(ssc_p->ssc->regs, IDR, ssc_p->ssc_state.ssc_imr);
921
922         ssc_p->ssc_state.ssc_cmr = ssc_readl(ssc_p->ssc->regs, CMR);
923         ssc_p->ssc_state.ssc_rcmr = ssc_readl(ssc_p->ssc->regs, RCMR);
924         ssc_p->ssc_state.ssc_rfmr = ssc_readl(ssc_p->ssc->regs, RFMR);
925         ssc_p->ssc_state.ssc_tcmr = ssc_readl(ssc_p->ssc->regs, TCMR);
926         ssc_p->ssc_state.ssc_tfmr = ssc_readl(ssc_p->ssc->regs, TFMR);
927
928         return 0;
929 }
930
931
932
933 static int atmel_ssc_resume(struct snd_soc_dai *cpu_dai)
934 {
935         struct atmel_ssc_info *ssc_p;
936         struct platform_device *pdev = to_platform_device(cpu_dai->dev);
937         u32 cr;
938
939         if (!cpu_dai->active)
940                 return 0;
941
942         ssc_p = &ssc_info[pdev->id];
943
944         /* restore SSC register settings */
945         ssc_writel(ssc_p->ssc->regs, TFMR, ssc_p->ssc_state.ssc_tfmr);
946         ssc_writel(ssc_p->ssc->regs, TCMR, ssc_p->ssc_state.ssc_tcmr);
947         ssc_writel(ssc_p->ssc->regs, RFMR, ssc_p->ssc_state.ssc_rfmr);
948         ssc_writel(ssc_p->ssc->regs, RCMR, ssc_p->ssc_state.ssc_rcmr);
949         ssc_writel(ssc_p->ssc->regs, CMR, ssc_p->ssc_state.ssc_cmr);
950
951         /* re-enable interrupts */
952         ssc_writel(ssc_p->ssc->regs, IER, ssc_p->ssc_state.ssc_imr);
953
954         /* Re-enable receive and transmit as appropriate */
955         cr = 0;
956         cr |=
957             (ssc_p->ssc_state.ssc_sr & SSC_BIT(SR_RXEN)) ? SSC_BIT(CR_RXEN) : 0;
958         cr |=
959             (ssc_p->ssc_state.ssc_sr & SSC_BIT(SR_TXEN)) ? SSC_BIT(CR_TXEN) : 0;
960         ssc_writel(ssc_p->ssc->regs, CR, cr);
961
962         return 0;
963 }
964 #else /* CONFIG_PM */
965 #  define atmel_ssc_suspend     NULL
966 #  define atmel_ssc_resume      NULL
967 #endif /* CONFIG_PM */
968
969 #define ATMEL_SSC_FORMATS (SNDRV_PCM_FMTBIT_S8     | SNDRV_PCM_FMTBIT_S16_LE |\
970                           SNDRV_PCM_FMTBIT_S24_LE | SNDRV_PCM_FMTBIT_S32_LE)
971
972 static const struct snd_soc_dai_ops atmel_ssc_dai_ops = {
973         .startup        = atmel_ssc_startup,
974         .shutdown       = atmel_ssc_shutdown,
975         .prepare        = atmel_ssc_prepare,
976         .trigger        = atmel_ssc_trigger,
977         .hw_params      = atmel_ssc_hw_params,
978         .set_fmt        = atmel_ssc_set_dai_fmt,
979         .set_clkdiv     = atmel_ssc_set_dai_clkdiv,
980 };
981
982 static struct snd_soc_dai_driver atmel_ssc_dai = {
983                 .suspend = atmel_ssc_suspend,
984                 .resume = atmel_ssc_resume,
985                 .playback = {
986                         .channels_min = 1,
987                         .channels_max = 2,
988                         .rates = SNDRV_PCM_RATE_CONTINUOUS,
989                         .rate_min = 8000,
990                         .rate_max = 384000,
991                         .formats = ATMEL_SSC_FORMATS,},
992                 .capture = {
993                         .channels_min = 1,
994                         .channels_max = 2,
995                         .rates = SNDRV_PCM_RATE_CONTINUOUS,
996                         .rate_min = 8000,
997                         .rate_max = 384000,
998                         .formats = ATMEL_SSC_FORMATS,},
999                 .ops = &atmel_ssc_dai_ops,
1000 };
1001
1002 static const struct snd_soc_component_driver atmel_ssc_component = {
1003         .name           = "atmel-ssc",
1004 };
1005
1006 static int asoc_ssc_init(struct device *dev)
1007 {
1008         struct platform_device *pdev = to_platform_device(dev);
1009         struct ssc_device *ssc = platform_get_drvdata(pdev);
1010         int ret;
1011
1012         ret = snd_soc_register_component(dev, &atmel_ssc_component,
1013                                          &atmel_ssc_dai, 1);
1014         if (ret) {
1015                 dev_err(dev, "Could not register DAI: %d\n", ret);
1016                 goto err;
1017         }
1018
1019         if (ssc->pdata->use_dma)
1020                 ret = atmel_pcm_dma_platform_register(dev);
1021         else
1022                 ret = atmel_pcm_pdc_platform_register(dev);
1023
1024         if (ret) {
1025                 dev_err(dev, "Could not register PCM: %d\n", ret);
1026                 goto err_unregister_dai;
1027         }
1028
1029         return 0;
1030
1031 err_unregister_dai:
1032         snd_soc_unregister_component(dev);
1033 err:
1034         return ret;
1035 }
1036
1037 static void asoc_ssc_exit(struct device *dev)
1038 {
1039         struct platform_device *pdev = to_platform_device(dev);
1040         struct ssc_device *ssc = platform_get_drvdata(pdev);
1041
1042         if (ssc->pdata->use_dma)
1043                 atmel_pcm_dma_platform_unregister(dev);
1044         else
1045                 atmel_pcm_pdc_platform_unregister(dev);
1046
1047         snd_soc_unregister_component(dev);
1048 }
1049
1050 /**
1051  * atmel_ssc_set_audio - Allocate the specified SSC for audio use.
1052  */
1053 int atmel_ssc_set_audio(int ssc_id)
1054 {
1055         struct ssc_device *ssc;
1056         int ret;
1057
1058         /* If we can grab the SSC briefly to parent the DAI device off it */
1059         ssc = ssc_request(ssc_id);
1060         if (IS_ERR(ssc)) {
1061                 pr_err("Unable to parent ASoC SSC DAI on SSC: %ld\n",
1062                         PTR_ERR(ssc));
1063                 return PTR_ERR(ssc);
1064         } else {
1065                 ssc_info[ssc_id].ssc = ssc;
1066         }
1067
1068         ret = asoc_ssc_init(&ssc->pdev->dev);
1069
1070         return ret;
1071 }
1072 EXPORT_SYMBOL_GPL(atmel_ssc_set_audio);
1073
1074 void atmel_ssc_put_audio(int ssc_id)
1075 {
1076         struct ssc_device *ssc = ssc_info[ssc_id].ssc;
1077
1078         asoc_ssc_exit(&ssc->pdev->dev);
1079         ssc_free(ssc);
1080 }
1081 EXPORT_SYMBOL_GPL(atmel_ssc_put_audio);
1082
1083 /* Module information */
1084 MODULE_AUTHOR("Sedji Gaouaou, sedji.gaouaou@atmel.com, www.atmel.com");
1085 MODULE_DESCRIPTION("ATMEL SSC ASoC Interface");
1086 MODULE_LICENSE("GPL");