sound/soc/mxs/mxs-saif.c

   1 /*
   2  * Copyright 2011 Freescale Semiconductor, Inc.
   3  *
   4  * This program is free software; you can redistribute it and/or modify
   5  * it under the terms of the GNU General Public License as published by
   6  * the Free Software Foundation; either version 2 of the License, or
   7  * (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU General Public License along
  15  * with this program; if not, write to the Free Software Foundation, Inc.,
  16  * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
  17  */
  18
  19 #include <linux/module.h>
  20 #include <linux/init.h>
  21 #include <linux/of.h>
  22 #include <linux/of_device.h>
  23 #include <linux/platform_device.h>
  24 #include <linux/slab.h>
  25 #include <linux/dma-mapping.h>
  26 #include <linux/clk.h>
  27 #include <linux/delay.h>
  28 #include <linux/time.h>
  29 #include <linux/fsl/mxs-dma.h>
  30 #include <linux/pinctrl/consumer.h>
  31 #include <sound/core.h>
  32 #include <sound/pcm.h>
  33 #include <sound/pcm_params.h>
  34 #include <sound/soc.h>
  35 #include <sound/saif.h>
  36 #include <asm/mach-types.h>
  37 #include <mach/hardware.h>
  38 #include <mach/mxs.h>
  39
  40 #include "mxs-saif.h"
  41
  42 static struct mxs_saif *mxs_saif[2];
  43
  44 /*
  45  * SAIF is a little different with other normal SOC DAIs on clock using.
  46  *
  47  * For MXS, two SAIF modules are instantiated on-chip.
  48  * Each SAIF has a set of clock pins and can be operating in master
  49  * mode simultaneously if they are connected to different off-chip codecs.
  50  * Also, one of the two SAIFs can master or drive the clock pins while the
  51  * other SAIF, in slave mode, receives clocking from the master SAIF.
  52  * This also means that both SAIFs must operate at the same sample rate.
  53  *
  54  * We abstract this as each saif has a master, the master could be
  55  * himself or other saifs. In the generic saif driver, saif does not need
  56  * to know the different clkmux. Saif only needs to know who is his master
  57  * and operating his master to generate the proper clock rate for him.
  58  * The master id is provided in mach-specific layer according to different
  59  * clkmux setting.
  60  */
  61
  62 static int mxs_saif_set_dai_sysclk(struct snd_soc_dai *cpu_dai,
  63                         int clk_id, unsigned int freq, int dir)
  64 {
  65         struct mxs_saif *saif = snd_soc_dai_get_drvdata(cpu_dai);
  66
  67         switch (clk_id) {
  68         case MXS_SAIF_MCLK:
  69                 saif->mclk = freq;
  70                 break;
  71         default:
  72                 return -EINVAL;
  73         }
  74         return 0;
  75 }
  76
  77 /*
  78  * Since SAIF may work on EXTMASTER mode, IOW, it's working BITCLK&LRCLK
  79  * is provided by other SAIF, we provide a interface here to get its master
  80  * from its master_id.
  81  * Note that the master could be himself.
  82  */
  83 static inline struct mxs_saif *mxs_saif_get_master(struct mxs_saif * saif)
  84 {
  85         return mxs_saif[saif->master_id];
  86 }
  87
  88 /*
  89  * Set SAIF clock and MCLK
  90  */
  91 static int mxs_saif_set_clk(struct mxs_saif *saif,
  92                                   unsigned int mclk,
  93                                   unsigned int rate)
  94 {
  95         u32 scr;
  96         int ret;
  97         struct mxs_saif *master_saif;
  98
  99         dev_dbg(saif->dev, "mclk %d rate %d\n", mclk, rate);
 100
 101         /* Set master saif to generate proper clock */
 102         master_saif = mxs_saif_get_master(saif);
 103         if (!master_saif)
 104                 return -EINVAL;
 105
 106         dev_dbg(saif->dev, "master saif%d\n", master_saif->id);
 107
 108         /* Checking if can playback and capture simutaneously */
 109         if (master_saif->ongoing && rate != master_saif->cur_rate) {
 110                 dev_err(saif->dev,
 111                         "can not change clock, master saif%d(rate %d) is ongoing\n",
 112                         master_saif->id, master_saif->cur_rate);
 113                 return -EINVAL;
 114         }
 115
 116         scr = __raw_readl(master_saif->base + SAIF_CTRL);
 117         scr &= ~BM_SAIF_CTRL_BITCLK_MULT_RATE;
 118         scr &= ~BM_SAIF_CTRL_BITCLK_BASE_RATE;
 119
 120         /*
 121          * Set SAIF clock
 122          *
 123          * The SAIF clock should be either 384*fs or 512*fs.
 124          * If MCLK is used, the SAIF clk ratio need to match mclk ratio.
 125          *  For 32x mclk, set saif clk as 512*fs.
 126          *  For 48x mclk, set saif clk as 384*fs.
 127          *
 128          * If MCLK is not used, we just set saif clk to 512*fs.
 129          */
 130         clk_prepare_enable(master_saif->clk);
 131
 132         if (master_saif->mclk_in_use) {
 133                 if (mclk % 32 == 0) {
 134                         scr &= ~BM_SAIF_CTRL_BITCLK_BASE_RATE;
 135                         ret = clk_set_rate(master_saif->clk, 512 * rate);
 136                 } else if (mclk % 48 == 0) {
 137                         scr |= BM_SAIF_CTRL_BITCLK_BASE_RATE;
 138                         ret = clk_set_rate(master_saif->clk, 384 * rate);
 139                 } else {
 140                         /* SAIF MCLK should be either 32x or 48x */
 141                         clk_disable_unprepare(master_saif->clk);
 142                         return -EINVAL;
 143                 }
 144         } else {
 145                 ret = clk_set_rate(master_saif->clk, 512 * rate);
 146                 scr &= ~BM_SAIF_CTRL_BITCLK_BASE_RATE;
 147         }
 148
 149         clk_disable_unprepare(master_saif->clk);
 150
 151         if (ret)
 152                 return ret;
 153
 154         master_saif->cur_rate = rate;
 155
 156         if (!master_saif->mclk_in_use) {
 157                 __raw_writel(scr, master_saif->base + SAIF_CTRL);
 158                 return 0;
 159         }
 160
 161         /*
 162          * Program the over-sample rate for MCLK output
 163          *
 164          * The available MCLK range is 32x, 48x... 512x. The rate
 165          * could be from 8kHz to 192kH.
 166          */
 167         switch (mclk / rate) {
 168         case 32:
 169                 scr |= BF_SAIF_CTRL_BITCLK_MULT_RATE(4);
 170                 break;
 171         case 64:
 172                 scr |= BF_SAIF_CTRL_BITCLK_MULT_RATE(3);
 173                 break;
 174         case 128:
 175                 scr |= BF_SAIF_CTRL_BITCLK_MULT_RATE(2);
 176                 break;
 177         case 256:
 178                 scr |= BF_SAIF_CTRL_BITCLK_MULT_RATE(1);
 179                 break;
 180         case 512:
 181                 scr |= BF_SAIF_CTRL_BITCLK_MULT_RATE(0);
 182                 break;
 183         case 48:
 184                 scr |= BF_SAIF_CTRL_BITCLK_MULT_RATE(3);
 185                 break;
 186         case 96:
 187                 scr |= BF_SAIF_CTRL_BITCLK_MULT_RATE(2);
 188                 break;
 189         case 192:
 190                 scr |= BF_SAIF_CTRL_BITCLK_MULT_RATE(1);
 191                 break;
 192         case 384:
 193                 scr |= BF_SAIF_CTRL_BITCLK_MULT_RATE(0);
 194                 break;
 195         default:
 196                 return -EINVAL;
 197         }
 198
 199         __raw_writel(scr, master_saif->base + SAIF_CTRL);
 200
 201         return 0;
 202 }
 203
 204 /*
 205  * Put and disable MCLK.
 206  */
 207 int mxs_saif_put_mclk(unsigned int saif_id)
 208 {
 209         struct mxs_saif *saif = mxs_saif[saif_id];
 210         u32 stat;
 211
 212         if (!saif)
 213                 return -EINVAL;
 214
 215         stat = __raw_readl(saif->base + SAIF_STAT);
 216         if (stat & BM_SAIF_STAT_BUSY) {
 217                 dev_err(saif->dev, "error: busy\n");
 218                 return -EBUSY;
 219         }
 220
 221         clk_disable_unprepare(saif->clk);
 222
 223         /* disable MCLK output */
 224         __raw_writel(BM_SAIF_CTRL_CLKGATE,
 225                 saif->base + SAIF_CTRL + MXS_SET_ADDR);
 226         __raw_writel(BM_SAIF_CTRL_RUN,
 227                 saif->base + SAIF_CTRL + MXS_CLR_ADDR);
 228
 229         saif->mclk_in_use = 0;
 230         return 0;
 231 }
 232
 233 /*
 234  * Get MCLK and set clock rate, then enable it
 235  *
 236  * This interface is used for codecs who are using MCLK provided
 237  * by saif.
 238  */
 239 int mxs_saif_get_mclk(unsigned int saif_id, unsigned int mclk,
 240                                         unsigned int rate)
 241 {
 242         struct mxs_saif *saif = mxs_saif[saif_id];
 243         u32 stat;
 244         int ret;
 245         struct mxs_saif *master_saif;
 246
 247         if (!saif)
 248                 return -EINVAL;
 249
 250         /* Clear Reset */
 251         __raw_writel(BM_SAIF_CTRL_SFTRST,
 252                 saif->base + SAIF_CTRL + MXS_CLR_ADDR);
 253
 254         /* FIXME: need clear clk gate for register r/w */
 255         __raw_writel(BM_SAIF_CTRL_CLKGATE,
 256                 saif->base + SAIF_CTRL + MXS_CLR_ADDR);
 257
 258         master_saif = mxs_saif_get_master(saif);
 259         if (saif != master_saif) {
 260                 dev_err(saif->dev, "can not get mclk from a non-master saif\n");
 261                 return -EINVAL;
 262         }
 263
 264         stat = __raw_readl(saif->base + SAIF_STAT);
 265         if (stat & BM_SAIF_STAT_BUSY) {
 266                 dev_err(saif->dev, "error: busy\n");
 267                 return -EBUSY;
 268         }
 269
 270         saif->mclk_in_use = 1;
 271         ret = mxs_saif_set_clk(saif, mclk, rate);
 272         if (ret)
 273                 return ret;
 274
 275         ret = clk_prepare_enable(saif->clk);
 276         if (ret)
 277                 return ret;
 278
 279         /* enable MCLK output */
 280         __raw_writel(BM_SAIF_CTRL_RUN,
 281                 saif->base + SAIF_CTRL + MXS_SET_ADDR);
 282
 283         return 0;
 284 }
 285
 286 /*
 287  * SAIF DAI format configuration.
 288  * Should only be called when port is inactive.
 289  */
 290 static int mxs_saif_set_dai_fmt(struct snd_soc_dai *cpu_dai, unsigned int fmt)
 291 {
 292         u32 scr, stat;
 293         u32 scr0;
 294         struct mxs_saif *saif = snd_soc_dai_get_drvdata(cpu_dai);
 295
 296         stat = __raw_readl(saif->base + SAIF_STAT);
 297         if (stat & BM_SAIF_STAT_BUSY) {
 298                 dev_err(cpu_dai->dev, "error: busy\n");
 299                 return -EBUSY;
 300         }
 301
 302         scr0 = __raw_readl(saif->base + SAIF_CTRL);
 303         scr0 = scr0 & ~BM_SAIF_CTRL_BITCLK_EDGE & ~BM_SAIF_CTRL_LRCLK_POLARITY \
 304                 & ~BM_SAIF_CTRL_JUSTIFY & ~BM_SAIF_CTRL_DELAY;
 305         scr = 0;
 306
 307         /* DAI mode */
 308         switch (fmt & SND_SOC_DAIFMT_FORMAT_MASK) {
 309         case SND_SOC_DAIFMT_I2S:
 310                 /* data frame low 1clk before data */
 311                 scr |= BM_SAIF_CTRL_DELAY;
 312                 scr &= ~BM_SAIF_CTRL_LRCLK_POLARITY;
 313                 break;
 314         case SND_SOC_DAIFMT_LEFT_J:
 315                 /* data frame high with data */
 316                 scr &= ~BM_SAIF_CTRL_DELAY;
 317                 scr &= ~BM_SAIF_CTRL_LRCLK_POLARITY;
 318                 scr &= ~BM_SAIF_CTRL_JUSTIFY;
 319                 break;
 320         default:
 321                 return -EINVAL;
 322         }
 323
 324         /* DAI clock inversion */
 325         switch (fmt & SND_SOC_DAIFMT_INV_MASK) {
 326         case SND_SOC_DAIFMT_IB_IF:
 327                 scr |= BM_SAIF_CTRL_BITCLK_EDGE;
 328                 scr |= BM_SAIF_CTRL_LRCLK_POLARITY;
 329                 break;
 330         case SND_SOC_DAIFMT_IB_NF:
 331                 scr |= BM_SAIF_CTRL_BITCLK_EDGE;
 332                 scr &= ~BM_SAIF_CTRL_LRCLK_POLARITY;
 333                 break;
 334         case SND_SOC_DAIFMT_NB_IF:
 335                 scr &= ~BM_SAIF_CTRL_BITCLK_EDGE;
 336                 scr |= BM_SAIF_CTRL_LRCLK_POLARITY;
 337                 break;
 338         case SND_SOC_DAIFMT_NB_NF:
 339                 scr &= ~BM_SAIF_CTRL_BITCLK_EDGE;
 340                 scr &= ~BM_SAIF_CTRL_LRCLK_POLARITY;
 341                 break;
 342         }
 343
 344         /*
 345          * Note: We simply just support master mode since SAIF TX can only
 346          * work as master.
 347          * Here the master is relative to codec side.
 348          * Saif internally could be slave when working on EXTMASTER mode.
 349          * We just hide this to machine driver.
 350          */
 351         switch (fmt & SND_SOC_DAIFMT_MASTER_MASK) {
 352         case SND_SOC_DAIFMT_CBS_CFS:
 353                 if (saif->id == saif->master_id)
 354                         scr &= ~BM_SAIF_CTRL_SLAVE_MODE;
 355                 else
 356                         scr |= BM_SAIF_CTRL_SLAVE_MODE;
 357
 358                 __raw_writel(scr | scr0, saif->base + SAIF_CTRL);
 359                 break;
 360         default:
 361                 return -EINVAL;
 362         }
 363
 364         return 0;
 365 }
 366
 367 static int mxs_saif_startup(struct snd_pcm_substream *substream,
 368                            struct snd_soc_dai *cpu_dai)
 369 {
 370         struct mxs_saif *saif = snd_soc_dai_get_drvdata(cpu_dai);
 371         snd_soc_dai_set_dma_data(cpu_dai, substream, &saif->dma_param);
 372
 373         /* clear error status to 0 for each re-open */
 374         saif->fifo_underrun = 0;
 375         saif->fifo_overrun = 0;
 376
 377         /* Clear Reset for normal operations */
 378         __raw_writel(BM_SAIF_CTRL_SFTRST,
 379                 saif->base + SAIF_CTRL + MXS_CLR_ADDR);
 380
 381         /* clear clock gate */
 382         __raw_writel(BM_SAIF_CTRL_CLKGATE,
 383                 saif->base + SAIF_CTRL + MXS_CLR_ADDR);
 384
 385         return 0;
 386 }
 387
 388 /*
 389  * Should only be called when port is inactive.
 390  * although can be called multiple times by upper layers.
 391  */
 392 static int mxs_saif_hw_params(struct snd_pcm_substream *substream,
 393                              struct snd_pcm_hw_params *params,
 394                              struct snd_soc_dai *cpu_dai)
 395 {
 396         struct mxs_saif *saif = snd_soc_dai_get_drvdata(cpu_dai);
 397         struct mxs_saif *master_saif;
 398         u32 scr, stat;
 399         int ret;
 400
 401         master_saif = mxs_saif_get_master(saif);
 402         if (!master_saif)
 403                 return -EINVAL;
 404
 405         /* mclk should already be set */
 406         if (!saif->mclk && saif->mclk_in_use) {
 407                 dev_err(cpu_dai->dev, "set mclk first\n");
 408                 return -EINVAL;
 409         }
 410
 411         stat = __raw_readl(saif->base + SAIF_STAT);
 412         if (stat & BM_SAIF_STAT_BUSY) {
 413                 dev_err(cpu_dai->dev, "error: busy\n");
 414                 return -EBUSY;
 415         }
 416
 417         /*
 418          * Set saif clk based on sample rate.
 419          * If mclk is used, we also set mclk, if not, saif->mclk is
 420          * default 0, means not used.
 421          */
 422         ret = mxs_saif_set_clk(saif, saif->mclk, params_rate(params));
 423         if (ret) {
 424                 dev_err(cpu_dai->dev, "unable to get proper clk\n");
 425                 return ret;
 426         }
 427
 428         /* prepare clk in hw_param, enable in trigger */
 429         clk_prepare(saif->clk);
 430         if (saif != master_saif)
 431                 clk_prepare(master_saif->clk);
 432
 433         scr = __raw_readl(saif->base + SAIF_CTRL);
 434
 435         scr &= ~BM_SAIF_CTRL_WORD_LENGTH;
 436         scr &= ~BM_SAIF_CTRL_BITCLK_48XFS_ENABLE;
 437         switch (params_format(params)) {
 438         case SNDRV_PCM_FORMAT_S16_LE:
 439                 scr |= BF_SAIF_CTRL_WORD_LENGTH(0);
 440                 break;
 441         case SNDRV_PCM_FORMAT_S20_3LE:
 442                 scr |= BF_SAIF_CTRL_WORD_LENGTH(4);
 443                 scr |= BM_SAIF_CTRL_BITCLK_48XFS_ENABLE;
 444                 break;
 445         case SNDRV_PCM_FORMAT_S24_LE:
 446                 scr |= BF_SAIF_CTRL_WORD_LENGTH(8);
 447                 scr |= BM_SAIF_CTRL_BITCLK_48XFS_ENABLE;
 448                 break;
 449         default:
 450                 return -EINVAL;
 451         }
 452
 453         /* Tx/Rx config */
 454         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
 455                 /* enable TX mode */
 456                 scr &= ~BM_SAIF_CTRL_READ_MODE;
 457         } else {
 458                 /* enable RX mode */
 459                 scr |= BM_SAIF_CTRL_READ_MODE;
 460         }
 461
 462         __raw_writel(scr, saif->base + SAIF_CTRL);
 463         return 0;
 464 }
 465
 466 static int mxs_saif_prepare(struct snd_pcm_substream *substream,
 467                            struct snd_soc_dai *cpu_dai)
 468 {
 469         struct mxs_saif *saif = snd_soc_dai_get_drvdata(cpu_dai);
 470
 471         /* enable FIFO error irqs */
 472         __raw_writel(BM_SAIF_CTRL_FIFO_ERROR_IRQ_EN,
 473                 saif->base + SAIF_CTRL + MXS_SET_ADDR);
 474
 475         return 0;
 476 }
 477
 478 static int mxs_saif_trigger(struct snd_pcm_substream *substream, int cmd,
 479                                 struct snd_soc_dai *cpu_dai)
 480 {
 481         struct mxs_saif *saif = snd_soc_dai_get_drvdata(cpu_dai);
 482         struct mxs_saif *master_saif;
 483         u32 delay;
 484
 485         master_saif = mxs_saif_get_master(saif);
 486         if (!master_saif)
 487                 return -EINVAL;
 488
 489         switch (cmd) {
 490         case SNDRV_PCM_TRIGGER_START:
 491         case SNDRV_PCM_TRIGGER_RESUME:
 492         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
 493                 dev_dbg(cpu_dai->dev, "start\n");
 494
 495                 clk_enable(master_saif->clk);
 496                 if (!master_saif->mclk_in_use)
 497                         __raw_writel(BM_SAIF_CTRL_RUN,
 498                                 master_saif->base + SAIF_CTRL + MXS_SET_ADDR);
 499
 500                 /*
 501                  * If the saif's master is not himself, we also need to enable
 502                  * itself clk for its internal basic logic to work.
 503                  */
 504                 if (saif != master_saif) {
 505                         clk_enable(saif->clk);
 506                         __raw_writel(BM_SAIF_CTRL_RUN,
 507                                 saif->base + SAIF_CTRL + MXS_SET_ADDR);
 508                 }
 509
 510                 if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK) {
 511                         /*
 512                          * write a data to saif data register to trigger
 513                          * the transfer
 514                          */
 515                         __raw_writel(0, saif->base + SAIF_DATA);
 516                 } else {
 517                         /*
 518                          * read a data from saif data register to trigger
 519                          * the receive
 520                          */
 521                         __raw_readl(saif->base + SAIF_DATA);
 522                 }
 523
 524                 master_saif->ongoing = 1;
 525
 526                 dev_dbg(saif->dev, "CTRL 0x%x STAT 0x%x\n",
 527                         __raw_readl(saif->base + SAIF_CTRL),
 528                         __raw_readl(saif->base + SAIF_STAT));
 529
 530                 dev_dbg(master_saif->dev, "CTRL 0x%x STAT 0x%x\n",
 531                         __raw_readl(master_saif->base + SAIF_CTRL),
 532                         __raw_readl(master_saif->base + SAIF_STAT));
 533                 break;
 534         case SNDRV_PCM_TRIGGER_SUSPEND:
 535         case SNDRV_PCM_TRIGGER_STOP:
 536         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
 537                 dev_dbg(cpu_dai->dev, "stop\n");
 538
 539                 /* wait a while for the current sample to complete */
 540                 delay = USEC_PER_SEC / master_saif->cur_rate;
 541
 542                 if (!master_saif->mclk_in_use) {
 543                         __raw_writel(BM_SAIF_CTRL_RUN,
 544                                 master_saif->base + SAIF_CTRL + MXS_CLR_ADDR);
 545                         udelay(delay);
 546                 }
 547                 clk_disable(master_saif->clk);
 548
 549                 if (saif != master_saif) {
 550                         __raw_writel(BM_SAIF_CTRL_RUN,
 551                                 saif->base + SAIF_CTRL + MXS_CLR_ADDR);
 552                         udelay(delay);
 553                         clk_disable(saif->clk);
 554                 }
 555
 556                 master_saif->ongoing = 0;
 557
 558                 break;
 559         default:
 560                 return -EINVAL;
 561         }
 562
 563         return 0;
 564 }
 565
 566 #define MXS_SAIF_RATES          SNDRV_PCM_RATE_8000_192000
 567 #define MXS_SAIF_FORMATS \
 568         (SNDRV_PCM_FMTBIT_S16_LE | SNDRV_PCM_FMTBIT_S20_3LE | \
 569         SNDRV_PCM_FMTBIT_S24_LE)
 570
 571 static const struct snd_soc_dai_ops mxs_saif_dai_ops = {
 572         .startup = mxs_saif_startup,
 573         .trigger = mxs_saif_trigger,
 574         .prepare = mxs_saif_prepare,
 575         .hw_params = mxs_saif_hw_params,
 576         .set_sysclk = mxs_saif_set_dai_sysclk,
 577         .set_fmt = mxs_saif_set_dai_fmt,
 578 };
 579
 580 static int mxs_saif_dai_probe(struct snd_soc_dai *dai)
 581 {
 582         struct mxs_saif *saif = dev_get_drvdata(dai->dev);
 583
 584         snd_soc_dai_set_drvdata(dai, saif);
 585
 586         return 0;
 587 }
 588
 589 static struct snd_soc_dai_driver mxs_saif_dai = {
 590         .name = "mxs-saif",
 591         .probe = mxs_saif_dai_probe,
 592         .playback = {
 593                 .channels_min = 2,
 594                 .channels_max = 2,
 595                 .rates = MXS_SAIF_RATES,
 596                 .formats = MXS_SAIF_FORMATS,
 597         },
 598         .capture = {
 599                 .channels_min = 2,
 600                 .channels_max = 2,
 601                 .rates = MXS_SAIF_RATES,
 602                 .formats = MXS_SAIF_FORMATS,
 603         },
 604         .ops = &mxs_saif_dai_ops,
 605 };
 606
 607 static irqreturn_t mxs_saif_irq(int irq, void *dev_id)
 608 {
 609         struct mxs_saif *saif = dev_id;
 610         unsigned int stat;
 611
 612         stat = __raw_readl(saif->base + SAIF_STAT);
 613         if (!(stat & (BM_SAIF_STAT_FIFO_UNDERFLOW_IRQ |
 614                         BM_SAIF_STAT_FIFO_OVERFLOW_IRQ)))
 615                 return IRQ_NONE;
 616
 617         if (stat & BM_SAIF_STAT_FIFO_UNDERFLOW_IRQ) {
 618                 dev_dbg(saif->dev, "underrun!!! %d\n", ++saif->fifo_underrun);
 619                 __raw_writel(BM_SAIF_STAT_FIFO_UNDERFLOW_IRQ,
 620                                 saif->base + SAIF_STAT + MXS_CLR_ADDR);
 621         }
 622
 623         if (stat & BM_SAIF_STAT_FIFO_OVERFLOW_IRQ) {
 624                 dev_dbg(saif->dev, "overrun!!! %d\n", ++saif->fifo_overrun);
 625                 __raw_writel(BM_SAIF_STAT_FIFO_OVERFLOW_IRQ,
 626                                 saif->base + SAIF_STAT + MXS_CLR_ADDR);
 627         }
 628
 629         dev_dbg(saif->dev, "SAIF_CTRL %x SAIF_STAT %x\n",
 630                __raw_readl(saif->base + SAIF_CTRL),
 631                __raw_readl(saif->base + SAIF_STAT));
 632
 633         return IRQ_HANDLED;
 634 }
 635
 636 static int __devinit mxs_saif_probe(struct platform_device *pdev)
 637 {
 638         struct device_node *np = pdev->dev.of_node;
 639         struct resource *iores, *dmares;
 640         struct mxs_saif *saif;
 641         struct mxs_saif_platform_data *pdata;
 642         struct pinctrl *pinctrl;
 643         int ret = 0;
 644
 645
 646         if (!np && pdev->id >= ARRAY_SIZE(mxs_saif))
 647                 return -EINVAL;
 648
 649         saif = devm_kzalloc(&pdev->dev, sizeof(*saif), GFP_KERNEL);
 650         if (!saif)
 651                 return -ENOMEM;
 652
 653         if (np) {
 654                 struct device_node *master;
 655                 saif->id = of_alias_get_id(np, "saif");
 656                 if (saif->id < 0)
 657                         return saif->id;
 658                 /*
 659                  * If there is no "fsl,saif-master" phandle, it's a saif
 660                  * master.  Otherwise, it's a slave and its phandle points
 661                  * to the master.
 662                  */
 663                 master = of_parse_phandle(np, "fsl,saif-master", 0);
 664                 if (!master) {
 665                         saif->master_id = saif->id;
 666                 } else {
 667                         saif->master_id = of_alias_get_id(master, "saif");
 668                         if (saif->master_id < 0)
 669                                 return saif->master_id;
 670                 }
 671         } else {
 672                 saif->id = pdev->id;
 673                 pdata = pdev->dev.platform_data;
 674                 if (pdata && !pdata->master_mode)
 675                         saif->master_id = pdata->master_id;
 676                 else
 677                         saif->master_id = saif->id;
 678         }
 679
 680         if (saif->master_id < 0 || saif->master_id >= ARRAY_SIZE(mxs_saif)) {
 681                 dev_err(&pdev->dev, "get wrong master id\n");
 682                 return -EINVAL;
 683         }
 684
 685         mxs_saif[saif->id] = saif;
 686
 687         pinctrl = devm_pinctrl_get_select_default(&pdev->dev);
 688         if (IS_ERR(pinctrl)) {
 689                 ret = PTR_ERR(pinctrl);
 690                 return ret;
 691         }
 692
 693         saif->clk = clk_get(&pdev->dev, NULL);
 694         if (IS_ERR(saif->clk)) {
 695                 ret = PTR_ERR(saif->clk);
 696                 dev_err(&pdev->dev, "Cannot get the clock: %d\n",
 697                         ret);
 698                 return ret;
 699         }
 700
 701         iores = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 702
 703         saif->base = devm_request_and_ioremap(&pdev->dev, iores);
 704         if (!saif->base) {
 705                 dev_err(&pdev->dev, "ioremap failed\n");
 706                 ret = -ENODEV;
 707                 goto failed_get_resource;
 708         }
 709
 710         dmares = platform_get_resource(pdev, IORESOURCE_DMA, 0);
 711         if (!dmares) {
 712                 /*
 713                  * TODO: This is a temporary solution and should be changed
 714                  * to use generic DMA binding later when the helplers get in.
 715                  */
 716                 ret = of_property_read_u32(np, "fsl,saif-dma-channel",
 717                                            &saif->dma_param.chan_num);
 718                 if (ret) {
 719                         dev_err(&pdev->dev, "failed to get dma channel\n");
 720                         goto failed_get_resource;
 721                 }
 722         } else {
 723                 saif->dma_param.chan_num = dmares->start;
 724         }
 725
 726         saif->irq = platform_get_irq(pdev, 0);
 727         if (saif->irq < 0) {
 728                 ret = saif->irq;
 729                 dev_err(&pdev->dev, "failed to get irq resource: %d\n",
 730                         ret);
 731                 goto failed_get_resource;
 732         }
 733
 734         saif->dev = &pdev->dev;
 735         ret = devm_request_irq(&pdev->dev, saif->irq, mxs_saif_irq, 0,
 736                                "mxs-saif", saif);
 737         if (ret) {
 738                 dev_err(&pdev->dev, "failed to request irq\n");
 739                 goto failed_get_resource;
 740         }
 741
 742         saif->dma_param.chan_irq = platform_get_irq(pdev, 1);
 743         if (saif->dma_param.chan_irq < 0) {
 744                 ret = saif->dma_param.chan_irq;
 745                 dev_err(&pdev->dev, "failed to get dma irq resource: %d\n",
 746                         ret);
 747                 goto failed_get_resource;
 748         }
 749
 750         platform_set_drvdata(pdev, saif);
 751
 752         ret = snd_soc_register_dai(&pdev->dev, &mxs_saif_dai);
 753         if (ret) {
 754                 dev_err(&pdev->dev, "register DAI failed\n");
 755                 goto failed_get_resource;
 756         }
 757
 758         ret = mxs_pcm_platform_register(&pdev->dev);
 759         if (ret) {
 760                 dev_err(&pdev->dev, "register PCM failed: %d\n", ret);
 761                 goto failed_pdev_alloc;
 762         }
 763
 764         return 0;
 765
 766 failed_pdev_alloc:
 767         snd_soc_unregister_dai(&pdev->dev);
 768 failed_get_resource:
 769         clk_put(saif->clk);
 770
 771         return ret;
 772 }
 773
 774 static int __devexit mxs_saif_remove(struct platform_device *pdev)
 775 {
 776         struct mxs_saif *saif = platform_get_drvdata(pdev);
 777
 778         mxs_pcm_platform_unregister(&pdev->dev);
 779         snd_soc_unregister_dai(&pdev->dev);
 780         clk_put(saif->clk);
 781
 782         return 0;
 783 }
 784
 785 static const struct of_device_id mxs_saif_dt_ids[] = {
 786         { .compatible = "fsl,imx28-saif", },
 787         { /* sentinel */ }
 788 };
 789 MODULE_DEVICE_TABLE(of, mxs_saif_dt_ids);
 790
 791 static struct platform_driver mxs_saif_driver = {
 792         .probe = mxs_saif_probe,
 793         .remove = __devexit_p(mxs_saif_remove),
 794
 795         .driver = {
 796                 .name = "mxs-saif",
 797                 .owner = THIS_MODULE,
 798                 .of_match_table = mxs_saif_dt_ids,
 799         },
 800 };
 801
 802 module_platform_driver(mxs_saif_driver);
 803
 804 MODULE_AUTHOR("Freescale Semiconductor, Inc.");
 805 MODULE_DESCRIPTION("MXS ASoC SAIF driver");
 806 MODULE_LICENSE("GPL");