blob: 06ac2b92faf33926a174b111a09daa0eee45ddf7 [file] [log] [blame]
Timur Tabi17467f22008-01-11 18:15:26 +01001/*
2 * Freescale SSI ALSA SoC Digital Audio Interface (DAI) driver
3 *
4 * Author: Timur Tabi <timur@freescale.com>
5 *
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +00006 * Copyright 2007-2010 Freescale Semiconductor, Inc.
7 *
8 * This file is licensed under the terms of the GNU General Public License
9 * version 2. This program is licensed "as is" without any warranty of any
10 * kind, whether express or implied.
Timur Tabi17467f22008-01-11 18:15:26 +010011 */
12
13#include <linux/init.h>
14#include <linux/module.h>
15#include <linux/interrupt.h>
16#include <linux/device.h>
17#include <linux/delay.h>
Tejun Heo5a0e3ad2010-03-24 17:04:11 +090018#include <linux/slab.h>
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000019#include <linux/of_platform.h>
Timur Tabi17467f22008-01-11 18:15:26 +010020
Timur Tabi17467f22008-01-11 18:15:26 +010021#include <sound/core.h>
22#include <sound/pcm.h>
23#include <sound/pcm_params.h>
24#include <sound/initval.h>
25#include <sound/soc.h>
26
Timur Tabi17467f22008-01-11 18:15:26 +010027#include "fsl_ssi.h"
28
29/**
30 * FSLSSI_I2S_RATES: sample rates supported by the I2S
31 *
32 * This driver currently only supports the SSI running in I2S slave mode,
33 * which means the codec determines the sample rate. Therefore, we tell
34 * ALSA that we support all rates and let the codec driver decide what rates
35 * are really supported.
36 */
37#define FSLSSI_I2S_RATES (SNDRV_PCM_RATE_5512 | SNDRV_PCM_RATE_8000_192000 | \
38 SNDRV_PCM_RATE_CONTINUOUS)
39
40/**
41 * FSLSSI_I2S_FORMATS: audio formats supported by the SSI
42 *
43 * This driver currently only supports the SSI running in I2S slave mode.
44 *
45 * The SSI has a limitation in that the samples must be in the same byte
46 * order as the host CPU. This is because when multiple bytes are written
47 * to the STX register, the bytes and bits must be written in the same
48 * order. The STX is a shift register, so all the bits need to be aligned
49 * (bit-endianness must match byte-endianness). Processors typically write
50 * the bits within a byte in the same order that the bytes of a word are
51 * written in. So if the host CPU is big-endian, then only big-endian
52 * samples will be written to STX properly.
53 */
54#ifdef __BIG_ENDIAN
55#define FSLSSI_I2S_FORMATS (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_BE | \
56 SNDRV_PCM_FMTBIT_S18_3BE | SNDRV_PCM_FMTBIT_S20_3BE | \
57 SNDRV_PCM_FMTBIT_S24_3BE | SNDRV_PCM_FMTBIT_S24_BE)
58#else
59#define FSLSSI_I2S_FORMATS (SNDRV_PCM_FMTBIT_S8 | SNDRV_PCM_FMTBIT_S16_LE | \
60 SNDRV_PCM_FMTBIT_S18_3LE | SNDRV_PCM_FMTBIT_S20_3LE | \
61 SNDRV_PCM_FMTBIT_S24_3LE | SNDRV_PCM_FMTBIT_S24_LE)
62#endif
63
Timur Tabid5a908b2009-03-26 11:42:38 -050064/* SIER bitflag of interrupts to enable */
65#define SIER_FLAGS (CCSR_SSI_SIER_TFRC_EN | CCSR_SSI_SIER_TDMAE | \
66 CCSR_SSI_SIER_TIE | CCSR_SSI_SIER_TUE0_EN | \
67 CCSR_SSI_SIER_TUE1_EN | CCSR_SSI_SIER_RFRC_EN | \
68 CCSR_SSI_SIER_RDMAE | CCSR_SSI_SIER_RIE | \
69 CCSR_SSI_SIER_ROE0_EN | CCSR_SSI_SIER_ROE1_EN)
70
Timur Tabi17467f22008-01-11 18:15:26 +010071/**
72 * fsl_ssi_private: per-SSI private data
73 *
Timur Tabi17467f22008-01-11 18:15:26 +010074 * @ssi: pointer to the SSI's registers
75 * @ssi_phys: physical address of the SSI registers
76 * @irq: IRQ of this SSI
Timur Tabibe41e942008-07-28 17:04:39 -050077 * @first_stream: pointer to the stream that was opened first
78 * @second_stream: pointer to second stream
Timur Tabi17467f22008-01-11 18:15:26 +010079 * @playback: the number of playback streams opened
80 * @capture: the number of capture streams opened
Timur Tabia454dad2009-03-05 17:23:37 -060081 * @asynchronous: 0=synchronous mode, 1=asynchronous mode
Timur Tabi17467f22008-01-11 18:15:26 +010082 * @cpu_dai: the CPU DAI for this device
83 * @dev_attr: the sysfs device attribute structure
84 * @stats: SSI statistics
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000085 * @name: name for this device
Timur Tabi17467f22008-01-11 18:15:26 +010086 */
87struct fsl_ssi_private {
Timur Tabi17467f22008-01-11 18:15:26 +010088 struct ccsr_ssi __iomem *ssi;
89 dma_addr_t ssi_phys;
90 unsigned int irq;
Timur Tabibe41e942008-07-28 17:04:39 -050091 struct snd_pcm_substream *first_stream;
92 struct snd_pcm_substream *second_stream;
Timur Tabi17467f22008-01-11 18:15:26 +010093 unsigned int playback;
94 unsigned int capture;
Timur Tabia454dad2009-03-05 17:23:37 -060095 int asynchronous;
Timur Tabi8e9d8692010-08-06 12:16:12 -050096 unsigned int fifo_depth;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000097 struct snd_soc_dai_driver cpu_dai_drv;
Timur Tabi17467f22008-01-11 18:15:26 +010098 struct device_attribute dev_attr;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +000099 struct platform_device *pdev;
Timur Tabi17467f22008-01-11 18:15:26 +0100100
101 struct {
102 unsigned int rfrc;
103 unsigned int tfrc;
104 unsigned int cmdau;
105 unsigned int cmddu;
106 unsigned int rxt;
107 unsigned int rdr1;
108 unsigned int rdr0;
109 unsigned int tde1;
110 unsigned int tde0;
111 unsigned int roe1;
112 unsigned int roe0;
113 unsigned int tue1;
114 unsigned int tue0;
115 unsigned int tfs;
116 unsigned int rfs;
117 unsigned int tls;
118 unsigned int rls;
119 unsigned int rff1;
120 unsigned int rff0;
121 unsigned int tfe1;
122 unsigned int tfe0;
123 } stats;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000124
125 char name[1];
Timur Tabi17467f22008-01-11 18:15:26 +0100126};
127
128/**
129 * fsl_ssi_isr: SSI interrupt handler
130 *
131 * Although it's possible to use the interrupt handler to send and receive
132 * data to/from the SSI, we use the DMA instead. Programming is more
133 * complicated, but the performance is much better.
134 *
135 * This interrupt handler is used only to gather statistics.
136 *
137 * @irq: IRQ of the SSI device
138 * @dev_id: pointer to the ssi_private structure for this SSI device
139 */
140static irqreturn_t fsl_ssi_isr(int irq, void *dev_id)
141{
142 struct fsl_ssi_private *ssi_private = dev_id;
143 struct ccsr_ssi __iomem *ssi = ssi_private->ssi;
144 irqreturn_t ret = IRQ_NONE;
145 __be32 sisr;
146 __be32 sisr2 = 0;
147
148 /* We got an interrupt, so read the status register to see what we
149 were interrupted for. We mask it with the Interrupt Enable register
150 so that we only check for events that we're interested in.
151 */
Timur Tabid5a908b2009-03-26 11:42:38 -0500152 sisr = in_be32(&ssi->sisr) & SIER_FLAGS;
Timur Tabi17467f22008-01-11 18:15:26 +0100153
154 if (sisr & CCSR_SSI_SISR_RFRC) {
155 ssi_private->stats.rfrc++;
156 sisr2 |= CCSR_SSI_SISR_RFRC;
157 ret = IRQ_HANDLED;
158 }
159
160 if (sisr & CCSR_SSI_SISR_TFRC) {
161 ssi_private->stats.tfrc++;
162 sisr2 |= CCSR_SSI_SISR_TFRC;
163 ret = IRQ_HANDLED;
164 }
165
166 if (sisr & CCSR_SSI_SISR_CMDAU) {
167 ssi_private->stats.cmdau++;
168 ret = IRQ_HANDLED;
169 }
170
171 if (sisr & CCSR_SSI_SISR_CMDDU) {
172 ssi_private->stats.cmddu++;
173 ret = IRQ_HANDLED;
174 }
175
176 if (sisr & CCSR_SSI_SISR_RXT) {
177 ssi_private->stats.rxt++;
178 ret = IRQ_HANDLED;
179 }
180
181 if (sisr & CCSR_SSI_SISR_RDR1) {
182 ssi_private->stats.rdr1++;
183 ret = IRQ_HANDLED;
184 }
185
186 if (sisr & CCSR_SSI_SISR_RDR0) {
187 ssi_private->stats.rdr0++;
188 ret = IRQ_HANDLED;
189 }
190
191 if (sisr & CCSR_SSI_SISR_TDE1) {
192 ssi_private->stats.tde1++;
193 ret = IRQ_HANDLED;
194 }
195
196 if (sisr & CCSR_SSI_SISR_TDE0) {
197 ssi_private->stats.tde0++;
198 ret = IRQ_HANDLED;
199 }
200
201 if (sisr & CCSR_SSI_SISR_ROE1) {
202 ssi_private->stats.roe1++;
203 sisr2 |= CCSR_SSI_SISR_ROE1;
204 ret = IRQ_HANDLED;
205 }
206
207 if (sisr & CCSR_SSI_SISR_ROE0) {
208 ssi_private->stats.roe0++;
209 sisr2 |= CCSR_SSI_SISR_ROE0;
210 ret = IRQ_HANDLED;
211 }
212
213 if (sisr & CCSR_SSI_SISR_TUE1) {
214 ssi_private->stats.tue1++;
215 sisr2 |= CCSR_SSI_SISR_TUE1;
216 ret = IRQ_HANDLED;
217 }
218
219 if (sisr & CCSR_SSI_SISR_TUE0) {
220 ssi_private->stats.tue0++;
221 sisr2 |= CCSR_SSI_SISR_TUE0;
222 ret = IRQ_HANDLED;
223 }
224
225 if (sisr & CCSR_SSI_SISR_TFS) {
226 ssi_private->stats.tfs++;
227 ret = IRQ_HANDLED;
228 }
229
230 if (sisr & CCSR_SSI_SISR_RFS) {
231 ssi_private->stats.rfs++;
232 ret = IRQ_HANDLED;
233 }
234
235 if (sisr & CCSR_SSI_SISR_TLS) {
236 ssi_private->stats.tls++;
237 ret = IRQ_HANDLED;
238 }
239
240 if (sisr & CCSR_SSI_SISR_RLS) {
241 ssi_private->stats.rls++;
242 ret = IRQ_HANDLED;
243 }
244
245 if (sisr & CCSR_SSI_SISR_RFF1) {
246 ssi_private->stats.rff1++;
247 ret = IRQ_HANDLED;
248 }
249
250 if (sisr & CCSR_SSI_SISR_RFF0) {
251 ssi_private->stats.rff0++;
252 ret = IRQ_HANDLED;
253 }
254
255 if (sisr & CCSR_SSI_SISR_TFE1) {
256 ssi_private->stats.tfe1++;
257 ret = IRQ_HANDLED;
258 }
259
260 if (sisr & CCSR_SSI_SISR_TFE0) {
261 ssi_private->stats.tfe0++;
262 ret = IRQ_HANDLED;
263 }
264
265 /* Clear the bits that we set */
266 if (sisr2)
267 out_be32(&ssi->sisr, sisr2);
268
269 return ret;
270}
271
272/**
273 * fsl_ssi_startup: create a new substream
274 *
275 * This is the first function called when a stream is opened.
276 *
277 * If this is the first stream open, then grab the IRQ and program most of
278 * the SSI registers.
279 */
Mark Browndee89c42008-11-18 22:11:38 +0000280static int fsl_ssi_startup(struct snd_pcm_substream *substream,
281 struct snd_soc_dai *dai)
Timur Tabi17467f22008-01-11 18:15:26 +0100282{
283 struct snd_soc_pcm_runtime *rtd = substream->private_data;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000284 struct fsl_ssi_private *ssi_private = snd_soc_dai_get_drvdata(rtd->cpu_dai);
Timur Tabi17467f22008-01-11 18:15:26 +0100285
286 /*
287 * If this is the first stream opened, then request the IRQ
288 * and initialize the SSI registers.
289 */
290 if (!ssi_private->playback && !ssi_private->capture) {
291 struct ccsr_ssi __iomem *ssi = ssi_private->ssi;
Timur Tabi17467f22008-01-11 18:15:26 +0100292
293 /*
294 * Section 16.5 of the MPC8610 reference manual says that the
295 * SSI needs to be disabled before updating the registers we set
296 * here.
297 */
298 clrbits32(&ssi->scr, CCSR_SSI_SCR_SSIEN);
299
300 /*
301 * Program the SSI into I2S Slave Non-Network Synchronous mode.
302 * Also enable the transmit and receive FIFO.
303 *
304 * FIXME: Little-endian samples require a different shift dir
305 */
Timur Tabia454dad2009-03-05 17:23:37 -0600306 clrsetbits_be32(&ssi->scr,
307 CCSR_SSI_SCR_I2S_MODE_MASK | CCSR_SSI_SCR_SYN,
308 CCSR_SSI_SCR_TFR_CLK_DIS | CCSR_SSI_SCR_I2S_MODE_SLAVE
309 | (ssi_private->asynchronous ? 0 : CCSR_SSI_SCR_SYN));
Timur Tabi17467f22008-01-11 18:15:26 +0100310
311 out_be32(&ssi->stcr,
312 CCSR_SSI_STCR_TXBIT0 | CCSR_SSI_STCR_TFEN0 |
313 CCSR_SSI_STCR_TFSI | CCSR_SSI_STCR_TEFS |
314 CCSR_SSI_STCR_TSCKP);
315
316 out_be32(&ssi->srcr,
317 CCSR_SSI_SRCR_RXBIT0 | CCSR_SSI_SRCR_RFEN0 |
318 CCSR_SSI_SRCR_RFSI | CCSR_SSI_SRCR_REFS |
319 CCSR_SSI_SRCR_RSCKP);
320
321 /*
322 * The DC and PM bits are only used if the SSI is the clock
323 * master.
324 */
325
326 /* 4. Enable the interrupts and DMA requests */
Timur Tabid5a908b2009-03-26 11:42:38 -0500327 out_be32(&ssi->sier, SIER_FLAGS);
Timur Tabi17467f22008-01-11 18:15:26 +0100328
329 /*
330 * Set the watermark for transmit FIFI 0 and receive FIFO 0. We
Timur Tabi8e9d8692010-08-06 12:16:12 -0500331 * don't use FIFO 1. We program the transmit water to signal a
332 * DMA transfer if there are only two (or fewer) elements left
333 * in the FIFO. Two elements equals one frame (left channel,
334 * right channel). This value, however, depends on the depth of
335 * the transmit buffer.
336 *
337 * We program the receive FIFO to notify us if at least two
338 * elements (one frame) have been written to the FIFO. We could
339 * make this value larger (and maybe we should), but this way
340 * data will be written to memory as soon as it's available.
Timur Tabi17467f22008-01-11 18:15:26 +0100341 */
342 out_be32(&ssi->sfcsr,
Timur Tabi8e9d8692010-08-06 12:16:12 -0500343 CCSR_SSI_SFCSR_TFWM0(ssi_private->fifo_depth - 2) |
344 CCSR_SSI_SFCSR_RFWM0(ssi_private->fifo_depth - 2));
Timur Tabi17467f22008-01-11 18:15:26 +0100345
346 /*
347 * We keep the SSI disabled because if we enable it, then the
348 * DMA controller will start. It's not supposed to start until
349 * the SCR.TE (or SCR.RE) bit is set, but it does anyway. The
350 * DMA controller will transfer one "BWC" of data (i.e. the
351 * amount of data that the MR.BWC bits are set to). The reason
352 * this is bad is because at this point, the PCM driver has not
353 * finished initializing the DMA controller.
354 */
355 }
356
Timur Tabibe41e942008-07-28 17:04:39 -0500357 if (!ssi_private->first_stream)
358 ssi_private->first_stream = substream;
359 else {
360 /* This is the second stream open, so we need to impose sample
361 * rate and maybe sample size constraints. Note that this can
362 * cause a race condition if the second stream is opened before
363 * the first stream is fully initialized.
364 *
365 * We provide some protection by checking to make sure the first
366 * stream is initialized, but it's not perfect. ALSA sometimes
367 * re-initializes the driver with a different sample rate or
368 * size. If the second stream is opened before the first stream
369 * has received its final parameters, then the second stream may
370 * be constrained to the wrong sample rate or size.
371 *
372 * FIXME: This code does not handle opening and closing streams
373 * repeatedly. If you open two streams and then close the first
374 * one, you may not be able to open another stream until you
375 * close the second one as well.
376 */
377 struct snd_pcm_runtime *first_runtime =
378 ssi_private->first_stream->runtime;
379
Mark Brown08d15f02009-05-23 10:41:05 +0100380 if (!first_runtime->sample_bits) {
Timur Tabibe41e942008-07-28 17:04:39 -0500381 dev_err(substream->pcm->card->dev,
Mark Brown08d15f02009-05-23 10:41:05 +0100382 "set sample size in %s stream first\n",
Timur Tabibe41e942008-07-28 17:04:39 -0500383 substream->stream == SNDRV_PCM_STREAM_PLAYBACK
384 ? "capture" : "playback");
385 return -EAGAIN;
386 }
387
Timur Tabia454dad2009-03-05 17:23:37 -0600388 /* If we're in synchronous mode, then we need to constrain
389 * the sample size as well. We don't support independent sample
390 * rates in asynchronous mode.
391 */
392 if (!ssi_private->asynchronous)
393 snd_pcm_hw_constraint_minmax(substream->runtime,
394 SNDRV_PCM_HW_PARAM_SAMPLE_BITS,
395 first_runtime->sample_bits,
396 first_runtime->sample_bits);
Timur Tabibe41e942008-07-28 17:04:39 -0500397
398 ssi_private->second_stream = substream;
399 }
400
Timur Tabi17467f22008-01-11 18:15:26 +0100401 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
402 ssi_private->playback++;
403
404 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
405 ssi_private->capture++;
406
407 return 0;
408}
409
410/**
Timur Tabi85ef2372009-02-05 17:56:02 -0600411 * fsl_ssi_hw_params - program the sample size
Timur Tabi17467f22008-01-11 18:15:26 +0100412 *
413 * Most of the SSI registers have been programmed in the startup function,
414 * but the word length must be programmed here. Unfortunately, programming
415 * the SxCCR.WL bits requires the SSI to be temporarily disabled. This can
416 * cause a problem with supporting simultaneous playback and capture. If
417 * the SSI is already playing a stream, then that stream may be temporarily
418 * stopped when you start capture.
419 *
420 * Note: The SxCCR.DC and SxCCR.PM bits are only used if the SSI is the
421 * clock master.
422 */
Timur Tabi85ef2372009-02-05 17:56:02 -0600423static int fsl_ssi_hw_params(struct snd_pcm_substream *substream,
424 struct snd_pcm_hw_params *hw_params, struct snd_soc_dai *cpu_dai)
Timur Tabi17467f22008-01-11 18:15:26 +0100425{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000426 struct fsl_ssi_private *ssi_private = snd_soc_dai_get_drvdata(cpu_dai);
Timur Tabi17467f22008-01-11 18:15:26 +0100427
Timur Tabibe41e942008-07-28 17:04:39 -0500428 if (substream == ssi_private->first_stream) {
Timur Tabi85ef2372009-02-05 17:56:02 -0600429 struct ccsr_ssi __iomem *ssi = ssi_private->ssi;
430 unsigned int sample_size =
431 snd_pcm_format_width(params_format(hw_params));
Timur Tabia454dad2009-03-05 17:23:37 -0600432 u32 wl = CCSR_SSI_SxCCR_WL(sample_size);
Timur Tabi17467f22008-01-11 18:15:26 +0100433
Timur Tabibe41e942008-07-28 17:04:39 -0500434 /* The SSI should always be disabled at this points (SSIEN=0) */
Timur Tabi17467f22008-01-11 18:15:26 +0100435
Timur Tabibe41e942008-07-28 17:04:39 -0500436 /* In synchronous mode, the SSI uses STCCR for capture */
Timur Tabia454dad2009-03-05 17:23:37 -0600437 if ((substream->stream == SNDRV_PCM_STREAM_PLAYBACK) ||
438 !ssi_private->asynchronous)
439 clrsetbits_be32(&ssi->stccr,
440 CCSR_SSI_SxCCR_WL_MASK, wl);
441 else
442 clrsetbits_be32(&ssi->srccr,
443 CCSR_SSI_SxCCR_WL_MASK, wl);
Timur Tabibe41e942008-07-28 17:04:39 -0500444 }
Timur Tabi17467f22008-01-11 18:15:26 +0100445
446 return 0;
447}
448
449/**
450 * fsl_ssi_trigger: start and stop the DMA transfer.
451 *
452 * This function is called by ALSA to start, stop, pause, and resume the DMA
453 * transfer of data.
454 *
455 * The DMA channel is in external master start and pause mode, which
456 * means the SSI completely controls the flow of data.
457 */
Mark Browndee89c42008-11-18 22:11:38 +0000458static int fsl_ssi_trigger(struct snd_pcm_substream *substream, int cmd,
459 struct snd_soc_dai *dai)
Timur Tabi17467f22008-01-11 18:15:26 +0100460{
461 struct snd_soc_pcm_runtime *rtd = substream->private_data;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000462 struct fsl_ssi_private *ssi_private = snd_soc_dai_get_drvdata(rtd->cpu_dai);
Timur Tabi17467f22008-01-11 18:15:26 +0100463 struct ccsr_ssi __iomem *ssi = ssi_private->ssi;
464
465 switch (cmd) {
466 case SNDRV_PCM_TRIGGER_START:
Timur Tabi3a638ff2009-03-06 18:39:34 -0600467 clrbits32(&ssi->scr, CCSR_SSI_SCR_SSIEN);
Timur Tabi17467f22008-01-11 18:15:26 +0100468 case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
Timur Tabia4d11fe2009-03-25 18:20:37 -0500469 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
Timur Tabibe41e942008-07-28 17:04:39 -0500470 setbits32(&ssi->scr,
471 CCSR_SSI_SCR_SSIEN | CCSR_SSI_SCR_TE);
Timur Tabia4d11fe2009-03-25 18:20:37 -0500472 else
Timur Tabibe41e942008-07-28 17:04:39 -0500473 setbits32(&ssi->scr,
474 CCSR_SSI_SCR_SSIEN | CCSR_SSI_SCR_RE);
Timur Tabi17467f22008-01-11 18:15:26 +0100475 break;
476
477 case SNDRV_PCM_TRIGGER_STOP:
Timur Tabi17467f22008-01-11 18:15:26 +0100478 case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
479 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
480 clrbits32(&ssi->scr, CCSR_SSI_SCR_TE);
481 else
482 clrbits32(&ssi->scr, CCSR_SSI_SCR_RE);
483 break;
484
485 default:
486 return -EINVAL;
487 }
488
489 return 0;
490}
491
492/**
493 * fsl_ssi_shutdown: shutdown the SSI
494 *
495 * Shutdown the SSI if there are no other substreams open.
496 */
Mark Browndee89c42008-11-18 22:11:38 +0000497static void fsl_ssi_shutdown(struct snd_pcm_substream *substream,
498 struct snd_soc_dai *dai)
Timur Tabi17467f22008-01-11 18:15:26 +0100499{
500 struct snd_soc_pcm_runtime *rtd = substream->private_data;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000501 struct fsl_ssi_private *ssi_private = snd_soc_dai_get_drvdata(rtd->cpu_dai);
Timur Tabi17467f22008-01-11 18:15:26 +0100502
503 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
504 ssi_private->playback--;
505
506 if (substream->stream == SNDRV_PCM_STREAM_CAPTURE)
507 ssi_private->capture--;
508
Timur Tabibe41e942008-07-28 17:04:39 -0500509 if (ssi_private->first_stream == substream)
510 ssi_private->first_stream = ssi_private->second_stream;
511
512 ssi_private->second_stream = NULL;
513
Timur Tabi17467f22008-01-11 18:15:26 +0100514 /*
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400515 * If this is the last active substream, disable the SSI.
Timur Tabi17467f22008-01-11 18:15:26 +0100516 */
517 if (!ssi_private->playback && !ssi_private->capture) {
518 struct ccsr_ssi __iomem *ssi = ssi_private->ssi;
519
520 clrbits32(&ssi->scr, CCSR_SSI_SCR_SSIEN);
Timur Tabi17467f22008-01-11 18:15:26 +0100521 }
522}
523
Eric Miao6335d052009-03-03 09:41:00 +0800524static struct snd_soc_dai_ops fsl_ssi_dai_ops = {
525 .startup = fsl_ssi_startup,
526 .hw_params = fsl_ssi_hw_params,
527 .shutdown = fsl_ssi_shutdown,
528 .trigger = fsl_ssi_trigger,
Eric Miao6335d052009-03-03 09:41:00 +0800529};
530
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000531/* Template for the CPU dai driver structure */
532static struct snd_soc_dai_driver fsl_ssi_dai_template = {
Timur Tabi17467f22008-01-11 18:15:26 +0100533 .playback = {
534 /* The SSI does not support monaural audio. */
535 .channels_min = 2,
536 .channels_max = 2,
537 .rates = FSLSSI_I2S_RATES,
538 .formats = FSLSSI_I2S_FORMATS,
539 },
540 .capture = {
541 .channels_min = 2,
542 .channels_max = 2,
543 .rates = FSLSSI_I2S_RATES,
544 .formats = FSLSSI_I2S_FORMATS,
545 },
Eric Miao6335d052009-03-03 09:41:00 +0800546 .ops = &fsl_ssi_dai_ops,
Timur Tabi17467f22008-01-11 18:15:26 +0100547};
548
Timur Tabid5a908b2009-03-26 11:42:38 -0500549/* Show the statistics of a flag only if its interrupt is enabled. The
550 * compiler will optimze this code to a no-op if the interrupt is not
551 * enabled.
552 */
553#define SIER_SHOW(flag, name) \
554 do { \
555 if (SIER_FLAGS & CCSR_SSI_SIER_##flag) \
556 length += sprintf(buf + length, #name "=%u\n", \
557 ssi_private->stats.name); \
558 } while (0)
559
560
Timur Tabi17467f22008-01-11 18:15:26 +0100561/**
562 * fsl_sysfs_ssi_show: display SSI statistics
563 *
Timur Tabid5a908b2009-03-26 11:42:38 -0500564 * Display the statistics for the current SSI device. To avoid confusion,
565 * we only show those counts that are enabled.
Timur Tabi17467f22008-01-11 18:15:26 +0100566 */
567static ssize_t fsl_sysfs_ssi_show(struct device *dev,
568 struct device_attribute *attr, char *buf)
569{
570 struct fsl_ssi_private *ssi_private =
Timur Tabid5a908b2009-03-26 11:42:38 -0500571 container_of(attr, struct fsl_ssi_private, dev_attr);
572 ssize_t length = 0;
Timur Tabi17467f22008-01-11 18:15:26 +0100573
Timur Tabid5a908b2009-03-26 11:42:38 -0500574 SIER_SHOW(RFRC_EN, rfrc);
575 SIER_SHOW(TFRC_EN, tfrc);
576 SIER_SHOW(CMDAU_EN, cmdau);
577 SIER_SHOW(CMDDU_EN, cmddu);
578 SIER_SHOW(RXT_EN, rxt);
579 SIER_SHOW(RDR1_EN, rdr1);
580 SIER_SHOW(RDR0_EN, rdr0);
581 SIER_SHOW(TDE1_EN, tde1);
582 SIER_SHOW(TDE0_EN, tde0);
583 SIER_SHOW(ROE1_EN, roe1);
584 SIER_SHOW(ROE0_EN, roe0);
585 SIER_SHOW(TUE1_EN, tue1);
586 SIER_SHOW(TUE0_EN, tue0);
587 SIER_SHOW(TFS_EN, tfs);
588 SIER_SHOW(RFS_EN, rfs);
589 SIER_SHOW(TLS_EN, tls);
590 SIER_SHOW(RLS_EN, rls);
591 SIER_SHOW(RFF1_EN, rff1);
592 SIER_SHOW(RFF0_EN, rff0);
593 SIER_SHOW(TFE1_EN, tfe1);
594 SIER_SHOW(TFE0_EN, tfe0);
Timur Tabi17467f22008-01-11 18:15:26 +0100595
596 return length;
597}
598
599/**
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000600 * Make every character in a string lower-case
Timur Tabi17467f22008-01-11 18:15:26 +0100601 */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000602static void make_lowercase(char *s)
Timur Tabi17467f22008-01-11 18:15:26 +0100603{
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000604 char *p = s;
605 char c;
606
607 while ((c = *p)) {
608 if ((c >= 'A') && (c <= 'Z'))
609 *p = c + ('a' - 'A');
610 p++;
611 }
612}
613
Grant Likelyf07eb222011-02-22 21:05:04 -0700614static int __devinit fsl_ssi_probe(struct platform_device *pdev)
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000615{
Timur Tabi17467f22008-01-11 18:15:26 +0100616 struct fsl_ssi_private *ssi_private;
617 int ret = 0;
Timur Tabi87a06322010-08-03 17:55:28 -0500618 struct device_attribute *dev_attr = NULL;
Timur Tabi38fec722010-08-19 15:26:58 -0500619 struct device_node *np = pdev->dev.of_node;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000620 const char *p, *sprop;
Timur Tabi8e9d8692010-08-06 12:16:12 -0500621 const uint32_t *iprop;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000622 struct resource res;
623 char name[64];
Timur Tabi17467f22008-01-11 18:15:26 +0100624
Timur Tabiff713342010-08-04 17:51:08 -0500625 /* SSIs that are not connected on the board should have a
626 * status = "disabled"
627 * property in their device tree nodes.
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000628 */
Timur Tabiff713342010-08-04 17:51:08 -0500629 if (!of_device_is_available(np))
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000630 return -ENODEV;
631
Timur Tabiff713342010-08-04 17:51:08 -0500632 /* Check for a codec-handle property. */
633 if (!of_get_property(np, "codec-handle", NULL)) {
Timur Tabi38fec722010-08-19 15:26:58 -0500634 dev_err(&pdev->dev, "missing codec-handle property\n");
Timur Tabiff713342010-08-04 17:51:08 -0500635 return -ENODEV;
636 }
637
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000638 /* We only support the SSI in "I2S Slave" mode */
639 sprop = of_get_property(np, "fsl,mode", NULL);
640 if (!sprop || strcmp(sprop, "i2s-slave")) {
Timur Tabi38fec722010-08-19 15:26:58 -0500641 dev_notice(&pdev->dev, "mode %s is unsupported\n", sprop);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000642 return -ENODEV;
Timur Tabi17467f22008-01-11 18:15:26 +0100643 }
Timur Tabi17467f22008-01-11 18:15:26 +0100644
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000645 /* The DAI name is the last part of the full name of the node. */
646 p = strrchr(np->full_name, '/') + 1;
647 ssi_private = kzalloc(sizeof(struct fsl_ssi_private) + strlen(p),
648 GFP_KERNEL);
649 if (!ssi_private) {
Timur Tabi38fec722010-08-19 15:26:58 -0500650 dev_err(&pdev->dev, "could not allocate DAI object\n");
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000651 return -ENOMEM;
652 }
Timur Tabi17467f22008-01-11 18:15:26 +0100653
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000654 strcpy(ssi_private->name, p);
Timur Tabi17467f22008-01-11 18:15:26 +0100655
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000656 /* Initialize this copy of the CPU DAI driver structure */
657 memcpy(&ssi_private->cpu_dai_drv, &fsl_ssi_dai_template,
658 sizeof(fsl_ssi_dai_template));
659 ssi_private->cpu_dai_drv.name = ssi_private->name;
660
661 /* Get the addresses and IRQ */
662 ret = of_address_to_resource(np, 0, &res);
663 if (ret) {
Timur Tabi38fec722010-08-19 15:26:58 -0500664 dev_err(&pdev->dev, "could not determine device resources\n");
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400665 goto error_kmalloc;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000666 }
Timur Tabi147dfe92011-06-08 15:02:55 -0500667 ssi_private->ssi = of_iomap(np, 0);
668 if (!ssi_private->ssi) {
669 dev_err(&pdev->dev, "could not map device resources\n");
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400670 ret = -ENOMEM;
671 goto error_kmalloc;
Timur Tabi147dfe92011-06-08 15:02:55 -0500672 }
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000673 ssi_private->ssi_phys = res.start;
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400674
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000675 ssi_private->irq = irq_of_parse_and_map(np, 0);
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400676 if (ssi_private->irq == NO_IRQ) {
677 dev_err(&pdev->dev, "no irq for node %s\n", np->full_name);
678 ret = -ENXIO;
679 goto error_iomap;
680 }
681
682 /* The 'name' should not have any slashes in it. */
683 ret = request_irq(ssi_private->irq, fsl_ssi_isr, 0, ssi_private->name,
684 ssi_private);
685 if (ret < 0) {
686 dev_err(&pdev->dev, "could not claim irq %u\n", ssi_private->irq);
687 goto error_irqmap;
688 }
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000689
690 /* Are the RX and the TX clocks locked? */
691 if (of_find_property(np, "fsl,ssi-asynchronous", NULL))
692 ssi_private->asynchronous = 1;
693 else
694 ssi_private->cpu_dai_drv.symmetric_rates = 1;
Timur Tabi17467f22008-01-11 18:15:26 +0100695
Timur Tabi8e9d8692010-08-06 12:16:12 -0500696 /* Determine the FIFO depth. */
697 iprop = of_get_property(np, "fsl,fifo-depth", NULL);
698 if (iprop)
Timur Tabi147dfe92011-06-08 15:02:55 -0500699 ssi_private->fifo_depth = be32_to_cpup(iprop);
Timur Tabi8e9d8692010-08-06 12:16:12 -0500700 else
701 /* Older 8610 DTs didn't have the fifo-depth property */
702 ssi_private->fifo_depth = 8;
703
Timur Tabi17467f22008-01-11 18:15:26 +0100704 /* Initialize the the device_attribute structure */
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000705 dev_attr = &ssi_private->dev_attr;
706 dev_attr->attr.name = "statistics";
Timur Tabi17467f22008-01-11 18:15:26 +0100707 dev_attr->attr.mode = S_IRUGO;
708 dev_attr->show = fsl_sysfs_ssi_show;
709
Timur Tabi38fec722010-08-19 15:26:58 -0500710 ret = device_create_file(&pdev->dev, dev_attr);
Timur Tabi17467f22008-01-11 18:15:26 +0100711 if (ret) {
Timur Tabi38fec722010-08-19 15:26:58 -0500712 dev_err(&pdev->dev, "could not create sysfs %s file\n",
Timur Tabi17467f22008-01-11 18:15:26 +0100713 ssi_private->dev_attr.attr.name);
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400714 goto error_irq;
Timur Tabi17467f22008-01-11 18:15:26 +0100715 }
716
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000717 /* Register with ASoC */
Timur Tabi38fec722010-08-19 15:26:58 -0500718 dev_set_drvdata(&pdev->dev, ssi_private);
Mark Brown3f4b7832008-12-03 19:26:35 +0000719
Timur Tabi38fec722010-08-19 15:26:58 -0500720 ret = snd_soc_register_dai(&pdev->dev, &ssi_private->cpu_dai_drv);
Timur Tabi87a06322010-08-03 17:55:28 -0500721 if (ret) {
Timur Tabi38fec722010-08-19 15:26:58 -0500722 dev_err(&pdev->dev, "failed to register DAI: %d\n", ret);
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400723 goto error_dev;
Mark Brown3f4b7832008-12-03 19:26:35 +0000724 }
Timur Tabi17467f22008-01-11 18:15:26 +0100725
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000726 /* Trigger the machine driver's probe function. The platform driver
727 * name of the machine driver is taken from the /model property of the
728 * device tree. We also pass the address of the CPU DAI driver
729 * structure.
730 */
731 sprop = of_get_property(of_find_node_by_path("/"), "model", NULL);
732 /* Sometimes the model name has a "fsl," prefix, so we strip that. */
733 p = strrchr(sprop, ',');
734 if (p)
735 sprop = p + 1;
736 snprintf(name, sizeof(name), "snd-soc-%s", sprop);
737 make_lowercase(name);
738
739 ssi_private->pdev =
Timur Tabi38fec722010-08-19 15:26:58 -0500740 platform_device_register_data(&pdev->dev, name, 0, NULL, 0);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000741 if (IS_ERR(ssi_private->pdev)) {
742 ret = PTR_ERR(ssi_private->pdev);
Timur Tabi38fec722010-08-19 15:26:58 -0500743 dev_err(&pdev->dev, "failed to register platform: %d\n", ret);
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400744 goto error_dai;
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000745 }
746
747 return 0;
Timur Tabi87a06322010-08-03 17:55:28 -0500748
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400749error_dai:
Timur Tabi38fec722010-08-19 15:26:58 -0500750 snd_soc_unregister_dai(&pdev->dev);
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400751
752error_dev:
Timur Tabi38fec722010-08-19 15:26:58 -0500753 dev_set_drvdata(&pdev->dev, NULL);
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400754 device_remove_file(&pdev->dev, dev_attr);
755
756error_irq:
757 free_irq(ssi_private->irq, ssi_private);
758
759error_irqmap:
Timur Tabi87a06322010-08-03 17:55:28 -0500760 irq_dispose_mapping(ssi_private->irq);
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400761
762error_iomap:
Timur Tabi87a06322010-08-03 17:55:28 -0500763 iounmap(ssi_private->ssi);
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400764
765error_kmalloc:
Timur Tabi87a06322010-08-03 17:55:28 -0500766 kfree(ssi_private);
767
768 return ret;
Timur Tabi17467f22008-01-11 18:15:26 +0100769}
Timur Tabi17467f22008-01-11 18:15:26 +0100770
Timur Tabi38fec722010-08-19 15:26:58 -0500771static int fsl_ssi_remove(struct platform_device *pdev)
Timur Tabi17467f22008-01-11 18:15:26 +0100772{
Timur Tabi38fec722010-08-19 15:26:58 -0500773 struct fsl_ssi_private *ssi_private = dev_get_drvdata(&pdev->dev);
Timur Tabi17467f22008-01-11 18:15:26 +0100774
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000775 platform_device_unregister(ssi_private->pdev);
Timur Tabi38fec722010-08-19 15:26:58 -0500776 snd_soc_unregister_dai(&pdev->dev);
777 device_remove_file(&pdev->dev, &ssi_private->dev_attr);
Mark Brown3f4b7832008-12-03 19:26:35 +0000778
Timur Tabi1fab6ca2011-08-16 18:47:45 -0400779 free_irq(ssi_private->irq, ssi_private);
780 irq_dispose_mapping(ssi_private->irq);
781
Timur Tabi17467f22008-01-11 18:15:26 +0100782 kfree(ssi_private);
Timur Tabi38fec722010-08-19 15:26:58 -0500783 dev_set_drvdata(&pdev->dev, NULL);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000784
785 return 0;
Timur Tabi17467f22008-01-11 18:15:26 +0100786}
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000787
788static const struct of_device_id fsl_ssi_ids[] = {
789 { .compatible = "fsl,mpc8610-ssi", },
790 {}
791};
792MODULE_DEVICE_TABLE(of, fsl_ssi_ids);
793
Grant Likelyf07eb222011-02-22 21:05:04 -0700794static struct platform_driver fsl_ssi_driver = {
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000795 .driver = {
796 .name = "fsl-ssi-dai",
797 .owner = THIS_MODULE,
798 .of_match_table = fsl_ssi_ids,
799 },
800 .probe = fsl_ssi_probe,
801 .remove = fsl_ssi_remove,
802};
Timur Tabi17467f22008-01-11 18:15:26 +0100803
Timur Tabia454dad2009-03-05 17:23:37 -0600804static int __init fsl_ssi_init(void)
805{
806 printk(KERN_INFO "Freescale Synchronous Serial Interface (SSI) ASoC Driver\n");
807
Grant Likelyf07eb222011-02-22 21:05:04 -0700808 return platform_driver_register(&fsl_ssi_driver);
Timur Tabia454dad2009-03-05 17:23:37 -0600809}
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000810
811static void __exit fsl_ssi_exit(void)
812{
Grant Likelyf07eb222011-02-22 21:05:04 -0700813 platform_driver_unregister(&fsl_ssi_driver);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000814}
815
Timur Tabia454dad2009-03-05 17:23:37 -0600816module_init(fsl_ssi_init);
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000817module_exit(fsl_ssi_exit);
Timur Tabia454dad2009-03-05 17:23:37 -0600818
Timur Tabi17467f22008-01-11 18:15:26 +0100819MODULE_AUTHOR("Timur Tabi <timur@freescale.com>");
820MODULE_DESCRIPTION("Freescale Synchronous Serial Interface (SSI) ASoC Driver");
Liam Girdwoodf0fba2a2010-03-17 20:15:21 +0000821MODULE_LICENSE("GPL v2");