sound/soc/samsung/spdif.c

   1 /* sound/soc/samsung/spdif.c
   2  *
   3  * ALSA SoC Audio Layer - Samsung S/PDIF Controller driver
   4  *
   5  * Copyright (c) 2010 Samsung Electronics Co. Ltd
   6  *              http://www.samsung.com/
   7  *
   8  * This program is free software; you can redistribute it and/or modify
   9  * it under the terms of the GNU General Public License version 2 as
  10  * published by the Free Software Foundation.
  11  */
  12
  13 #include <linux/clk.h>
  14 #include <linux/io.h>
  15 #include <linux/module.h>
  16
  17 #include <sound/soc.h>
  18 #include <sound/pcm_params.h>
  19
  20 #include <linux/platform_data/asoc-s3c.h>
  21
  22 #include "dma.h"
  23 #include "spdif.h"
  24
  25 /* Registers */
  26 #define CLKCON                          0x00
  27 #define CON                             0x04
  28 #define BSTAS                           0x08
  29 #define CSTAS                           0x0C
  30 #define DATA_OUTBUF                     0x10
  31 #define DCNT                            0x14
  32 #define BSTAS_S                         0x18
  33 #define DCNT_S                          0x1C
  34
  35 #define CLKCTL_MASK                     0x7
  36 #define CLKCTL_MCLK_EXT                 (0x1 << 2)
  37 #define CLKCTL_PWR_ON                   (0x1 << 0)
  38
  39 #define CON_MASK                        0x3ffffff
  40 #define CON_FIFO_TH_SHIFT               19
  41 #define CON_FIFO_TH_MASK                (0x7 << 19)
  42 #define CON_USERDATA_23RDBIT            (0x1 << 12)
  43
  44 #define CON_SW_RESET                    (0x1 << 5)
  45
  46 #define CON_MCLKDIV_MASK                (0x3 << 3)
  47 #define CON_MCLKDIV_256FS               (0x0 << 3)
  48 #define CON_MCLKDIV_384FS               (0x1 << 3)
  49 #define CON_MCLKDIV_512FS               (0x2 << 3)
  50
  51 #define CON_PCM_MASK                    (0x3 << 1)
  52 #define CON_PCM_16BIT                   (0x0 << 1)
  53 #define CON_PCM_20BIT                   (0x1 << 1)
  54 #define CON_PCM_24BIT                   (0x2 << 1)
  55
  56 #define CON_PCM_DATA                    (0x1 << 0)
  57
  58 #define CSTAS_MASK                      0x3fffffff
  59 #define CSTAS_SAMP_FREQ_MASK            (0xF << 24)
  60 #define CSTAS_SAMP_FREQ_44              (0x0 << 24)
  61 #define CSTAS_SAMP_FREQ_48              (0x2 << 24)
  62 #define CSTAS_SAMP_FREQ_32              (0x3 << 24)
  63 #define CSTAS_SAMP_FREQ_96              (0xA << 24)
  64
  65 #define CSTAS_CATEGORY_MASK             (0xFF << 8)
  66 #define CSTAS_CATEGORY_CODE_CDP         (0x01 << 8)
  67
  68 #define CSTAS_NO_COPYRIGHT              (0x1 << 2)
  69
  70 /**
  71  * struct samsung_spdif_info - Samsung S/PDIF Controller information
  72  * @lock: Spin lock for S/PDIF.
  73  * @dev: The parent device passed to use from the probe.
  74  * @regs: The pointer to the device register block.
  75  * @clk_rate: Current clock rate for calcurate ratio.
  76  * @pclk: The peri-clock pointer for spdif master operation.
  77  * @sclk: The source clock pointer for making sync signals.
  78  * @save_clkcon: Backup clkcon reg. in suspend.
  79  * @save_con: Backup con reg. in suspend.
  80  * @save_cstas: Backup cstas reg. in suspend.
  81  * @dma_playback: DMA information for playback channel.
  82  */
  83 struct samsung_spdif_info {
  84         spinlock_t      lock;
  85         struct device   *dev;
  86         void __iomem    *regs;
  87         unsigned long   clk_rate;
  88         struct clk      *pclk;
  89         struct clk      *sclk;
  90         u32             saved_clkcon;
  91         u32             saved_con;
  92         u32             saved_cstas;
  93         struct s3c_dma_params   *dma_playback;
  94 };
  95
  96 static struct s3c_dma_client spdif_dma_client_out = {
  97         .name           = "S/PDIF Stereo out",
  98 };
  99
 100 static struct s3c_dma_params spdif_stereo_out;
 101 static struct samsung_spdif_info spdif_info;
 102
 103 static inline struct samsung_spdif_info *to_info(struct snd_soc_dai *cpu_dai)
 104 {
 105         return snd_soc_dai_get_drvdata(cpu_dai);
 106 }
 107
 108 static void spdif_snd_txctrl(struct samsung_spdif_info *spdif, int on)
 109 {
 110         void __iomem *regs = spdif->regs;
 111         u32 clkcon;
 112
 113         dev_dbg(spdif->dev, "Entered %s\n", __func__);
 114
 115         clkcon = readl(regs + CLKCON) & CLKCTL_MASK;
 116         if (on)
 117                 writel(clkcon | CLKCTL_PWR_ON, regs + CLKCON);
 118         else
 119                 writel(clkcon & ~CLKCTL_PWR_ON, regs + CLKCON);
 120 }
 121
 122 static int spdif_set_sysclk(struct snd_soc_dai *cpu_dai,
 123                                 int clk_id, unsigned int freq, int dir)
 124 {
 125         struct samsung_spdif_info *spdif = to_info(cpu_dai);
 126         u32 clkcon;
 127
 128         dev_dbg(spdif->dev, "Entered %s\n", __func__);
 129
 130         clkcon = readl(spdif->regs + CLKCON);
 131
 132         if (clk_id == SND_SOC_SPDIF_INT_MCLK)
 133                 clkcon &= ~CLKCTL_MCLK_EXT;
 134         else
 135                 clkcon |= CLKCTL_MCLK_EXT;
 136
 137         writel(clkcon, spdif->regs + CLKCON);
 138
 139         spdif->clk_rate = freq;
 140
 141         return 0;
 142 }
 143
 144 static int spdif_trigger(struct snd_pcm_substream *substream, int cmd,
 145                                 struct snd_soc_dai *dai)
 146 {
 147         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 148         struct samsung_spdif_info *spdif = to_info(rtd->cpu_dai);
 149         unsigned long flags;
 150
 151         dev_dbg(spdif->dev, "Entered %s\n", __func__);
 152
 153         switch (cmd) {
 154         case SNDRV_PCM_TRIGGER_START:
 155         case SNDRV_PCM_TRIGGER_RESUME:
 156         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
 157                 spin_lock_irqsave(&spdif->lock, flags);
 158                 spdif_snd_txctrl(spdif, 1);
 159                 spin_unlock_irqrestore(&spdif->lock, flags);
 160                 break;
 161         case SNDRV_PCM_TRIGGER_STOP:
 162         case SNDRV_PCM_TRIGGER_SUSPEND:
 163         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
 164                 spin_lock_irqsave(&spdif->lock, flags);
 165                 spdif_snd_txctrl(spdif, 0);
 166                 spin_unlock_irqrestore(&spdif->lock, flags);
 167                 break;
 168         default:
 169                 return -EINVAL;
 170         }
 171
 172         return 0;
 173 }
 174
 175 static int spdif_sysclk_ratios[] = {
 176         512, 384, 256,
 177 };
 178
 179 static int spdif_hw_params(struct snd_pcm_substream *substream,
 180                                 struct snd_pcm_hw_params *params,
 181                                 struct snd_soc_dai *socdai)
 182 {
 183         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 184         struct samsung_spdif_info *spdif = to_info(rtd->cpu_dai);
 185         void __iomem *regs = spdif->regs;
 186         struct s3c_dma_params *dma_data;
 187         u32 con, clkcon, cstas;
 188         unsigned long flags;
 189         int i, ratio;
 190
 191         dev_dbg(spdif->dev, "Entered %s\n", __func__);
 192
 193         if (substream->stream == SNDRV_PCM_STREAM_PLAYBACK)
 194                 dma_data = spdif->dma_playback;
 195         else {
 196                 dev_err(spdif->dev, "Capture is not supported\n");
 197                 return -EINVAL;
 198         }
 199
 200         snd_soc_dai_set_dma_data(rtd->cpu_dai, substream, dma_data);
 201
 202         spin_lock_irqsave(&spdif->lock, flags);
 203
 204         con = readl(regs + CON) & CON_MASK;
 205         cstas = readl(regs + CSTAS) & CSTAS_MASK;
 206         clkcon = readl(regs + CLKCON) & CLKCTL_MASK;
 207
 208         con &= ~CON_FIFO_TH_MASK;
 209         con |= (0x7 << CON_FIFO_TH_SHIFT);
 210         con |= CON_USERDATA_23RDBIT;
 211         con |= CON_PCM_DATA;
 212
 213         con &= ~CON_PCM_MASK;
 214         switch (params_format(params)) {
 215         case SNDRV_PCM_FORMAT_S16_LE:
 216                 con |= CON_PCM_16BIT;
 217                 break;
 218         default:
 219                 dev_err(spdif->dev, "Unsupported data size.\n");
 220                 goto err;
 221         }
 222
 223         ratio = spdif->clk_rate / params_rate(params);
 224         for (i = 0; i < ARRAY_SIZE(spdif_sysclk_ratios); i++)
 225                 if (ratio == spdif_sysclk_ratios[i])
 226                         break;
 227         if (i == ARRAY_SIZE(spdif_sysclk_ratios)) {
 228                 dev_err(spdif->dev, "Invalid clock ratio %ld/%d\n",
 229                                 spdif->clk_rate, params_rate(params));
 230                 goto err;
 231         }
 232
 233         con &= ~CON_MCLKDIV_MASK;
 234         switch (ratio) {
 235         case 256:
 236                 con |= CON_MCLKDIV_256FS;
 237                 break;
 238         case 384:
 239                 con |= CON_MCLKDIV_384FS;
 240                 break;
 241         case 512:
 242                 con |= CON_MCLKDIV_512FS;
 243                 break;
 244         }
 245
 246         cstas &= ~CSTAS_SAMP_FREQ_MASK;
 247         switch (params_rate(params)) {
 248         case 44100:
 249                 cstas |= CSTAS_SAMP_FREQ_44;
 250                 break;
 251         case 48000:
 252                 cstas |= CSTAS_SAMP_FREQ_48;
 253                 break;
 254         case 32000:
 255                 cstas |= CSTAS_SAMP_FREQ_32;
 256                 break;
 257         case 96000:
 258                 cstas |= CSTAS_SAMP_FREQ_96;
 259                 break;
 260         default:
 261                 dev_err(spdif->dev, "Invalid sampling rate %d\n",
 262                                 params_rate(params));
 263                 goto err;
 264         }
 265
 266         cstas &= ~CSTAS_CATEGORY_MASK;
 267         cstas |= CSTAS_CATEGORY_CODE_CDP;
 268         cstas |= CSTAS_NO_COPYRIGHT;
 269
 270         writel(con, regs + CON);
 271         writel(cstas, regs + CSTAS);
 272         writel(clkcon, regs + CLKCON);
 273
 274         spin_unlock_irqrestore(&spdif->lock, flags);
 275
 276         return 0;
 277 err:
 278         spin_unlock_irqrestore(&spdif->lock, flags);
 279         return -EINVAL;
 280 }
 281
 282 static void spdif_shutdown(struct snd_pcm_substream *substream,
 283                                 struct snd_soc_dai *dai)
 284 {
 285         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 286         struct samsung_spdif_info *spdif = to_info(rtd->cpu_dai);
 287         void __iomem *regs = spdif->regs;
 288         u32 con, clkcon;
 289
 290         dev_dbg(spdif->dev, "Entered %s\n", __func__);
 291
 292         con = readl(regs + CON) & CON_MASK;
 293         clkcon = readl(regs + CLKCON) & CLKCTL_MASK;
 294
 295         writel(con | CON_SW_RESET, regs + CON);
 296         cpu_relax();
 297
 298         writel(clkcon & ~CLKCTL_PWR_ON, regs + CLKCON);
 299 }
 300
 301 #ifdef CONFIG_PM
 302 static int spdif_suspend(struct snd_soc_dai *cpu_dai)
 303 {
 304         struct samsung_spdif_info *spdif = to_info(cpu_dai);
 305         u32 con = spdif->saved_con;
 306
 307         dev_dbg(spdif->dev, "Entered %s\n", __func__);
 308
 309         spdif->saved_clkcon = readl(spdif->regs + CLKCON) & CLKCTL_MASK;
 310         spdif->saved_con = readl(spdif->regs + CON) & CON_MASK;
 311         spdif->saved_cstas = readl(spdif->regs + CSTAS) & CSTAS_MASK;
 312
 313         writel(con | CON_SW_RESET, spdif->regs + CON);
 314         cpu_relax();
 315
 316         return 0;
 317 }
 318
 319 static int spdif_resume(struct snd_soc_dai *cpu_dai)
 320 {
 321         struct samsung_spdif_info *spdif = to_info(cpu_dai);
 322
 323         dev_dbg(spdif->dev, "Entered %s\n", __func__);
 324
 325         writel(spdif->saved_clkcon, spdif->regs + CLKCON);
 326         writel(spdif->saved_con, spdif->regs + CON);
 327         writel(spdif->saved_cstas, spdif->regs + CSTAS);
 328
 329         return 0;
 330 }
 331 #else
 332 #define spdif_suspend NULL
 333 #define spdif_resume NULL
 334 #endif
 335
 336 static const struct snd_soc_dai_ops spdif_dai_ops = {
 337         .set_sysclk     = spdif_set_sysclk,
 338         .trigger        = spdif_trigger,
 339         .hw_params      = spdif_hw_params,
 340         .shutdown       = spdif_shutdown,
 341 };
 342
 343 static struct snd_soc_dai_driver samsung_spdif_dai = {
 344         .name = "samsung-spdif",
 345         .playback = {
 346                 .stream_name = "S/PDIF Playback",
 347                 .channels_min = 2,
 348                 .channels_max = 2,
 349                 .rates = (SNDRV_PCM_RATE_32000 |
 350                                 SNDRV_PCM_RATE_44100 |
 351                                 SNDRV_PCM_RATE_48000 |
 352                                 SNDRV_PCM_RATE_96000),
 353                 .formats = SNDRV_PCM_FMTBIT_S16_LE, },
 354         .ops = &spdif_dai_ops,
 355         .suspend = spdif_suspend,
 356         .resume = spdif_resume,
 357 };
 358
 359 static const struct snd_soc_component_driver samsung_spdif_component = {
 360         .name           = "samsung-spdif",
 361 };
 362
 363 static int spdif_probe(struct platform_device *pdev)
 364 {
 365         struct s3c_audio_pdata *spdif_pdata;
 366         struct resource *mem_res, *dma_res;
 367         struct samsung_spdif_info *spdif;
 368         int ret;
 369
 370         spdif_pdata = pdev->dev.platform_data;
 371
 372         dev_dbg(&pdev->dev, "Entered %s\n", __func__);
 373
 374         dma_res = platform_get_resource(pdev, IORESOURCE_DMA, 0);
 375         if (!dma_res) {
 376                 dev_err(&pdev->dev, "Unable to get dma resource.\n");
 377                 return -ENXIO;
 378         }
 379
 380         mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 381         if (!mem_res) {
 382                 dev_err(&pdev->dev, "Unable to get register resource.\n");
 383                 return -ENXIO;
 384         }
 385
 386         if (spdif_pdata && spdif_pdata->cfg_gpio
 387                         && spdif_pdata->cfg_gpio(pdev)) {
 388                 dev_err(&pdev->dev, "Unable to configure GPIO pins\n");
 389                 return -EINVAL;
 390         }
 391
 392         spdif = &spdif_info;
 393         spdif->dev = &pdev->dev;
 394
 395         spin_lock_init(&spdif->lock);
 396
 397         spdif->pclk = devm_clk_get(&pdev->dev, "spdif");
 398         if (IS_ERR(spdif->pclk)) {
 399                 dev_err(&pdev->dev, "failed to get peri-clock\n");
 400                 ret = -ENOENT;
 401                 goto err0;
 402         }
 403         clk_prepare_enable(spdif->pclk);
 404
 405         spdif->sclk = devm_clk_get(&pdev->dev, "sclk_spdif");
 406         if (IS_ERR(spdif->sclk)) {
 407                 dev_err(&pdev->dev, "failed to get internal source clock\n");
 408                 ret = -ENOENT;
 409                 goto err1;
 410         }
 411         clk_prepare_enable(spdif->sclk);
 412
 413         /* Request S/PDIF Register's memory region */
 414         if (!request_mem_region(mem_res->start,
 415                                 resource_size(mem_res), "samsung-spdif")) {
 416                 dev_err(&pdev->dev, "Unable to request register region\n");
 417                 ret = -EBUSY;
 418                 goto err2;
 419         }
 420
 421         spdif->regs = ioremap(mem_res->start, 0x100);
 422         if (spdif->regs == NULL) {
 423                 dev_err(&pdev->dev, "Cannot ioremap registers\n");
 424                 ret = -ENXIO;
 425                 goto err3;
 426         }
 427
 428         dev_set_drvdata(&pdev->dev, spdif);
 429
 430         ret = snd_soc_register_component(&pdev->dev, &samsung_spdif_component,
 431                                          &samsung_spdif_dai, 1);
 432         if (ret != 0) {
 433                 dev_err(&pdev->dev, "fail to register dai\n");
 434                 goto err4;
 435         }
 436
 437         spdif_stereo_out.dma_size = 2;
 438         spdif_stereo_out.client = &spdif_dma_client_out;
 439         spdif_stereo_out.dma_addr = mem_res->start + DATA_OUTBUF;
 440         spdif_stereo_out.channel = dma_res->start;
 441
 442         spdif->dma_playback = &spdif_stereo_out;
 443
 444         ret = samsung_asoc_dma_platform_register(&pdev->dev);
 445         if (ret) {
 446                 dev_err(&pdev->dev, "failed to register DMA: %d\n", ret);
 447                 goto err5;
 448         }
 449
 450         return 0;
 451 err5:
 452         snd_soc_unregister_component(&pdev->dev);
 453 err4:
 454         iounmap(spdif->regs);
 455 err3:
 456         release_mem_region(mem_res->start, resource_size(mem_res));
 457 err2:
 458         clk_disable_unprepare(spdif->sclk);
 459 err1:
 460         clk_disable_unprepare(spdif->pclk);
 461 err0:
 462         return ret;
 463 }
 464
 465 static int spdif_remove(struct platform_device *pdev)
 466 {
 467         struct samsung_spdif_info *spdif = &spdif_info;
 468         struct resource *mem_res;
 469
 470         samsung_asoc_dma_platform_unregister(&pdev->dev);
 471         snd_soc_unregister_component(&pdev->dev);
 472
 473         iounmap(spdif->regs);
 474
 475         mem_res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 476         if (mem_res)
 477                 release_mem_region(mem_res->start, resource_size(mem_res));
 478
 479         clk_disable_unprepare(spdif->sclk);
 480         clk_disable_unprepare(spdif->pclk);
 481
 482         return 0;
 483 }
 484
 485 static struct platform_driver samsung_spdif_driver = {
 486         .probe  = spdif_probe,
 487         .remove = spdif_remove,
 488         .driver = {
 489                 .name   = "samsung-spdif",
 490                 .owner  = THIS_MODULE,
 491         },
 492 };
 493
 494 module_platform_driver(samsung_spdif_driver);
 495
 496 MODULE_AUTHOR("Seungwhan Youn, <sw.youn@samsung.com>");
 497 MODULE_DESCRIPTION("Samsung S/PDIF Controller Driver");
 498 MODULE_LICENSE("GPL");
 499 MODULE_ALIAS("platform:samsung-spdif");