sound/soc/sh/rcar/src.c

   1 /*
   2  * Renesas R-Car SRC support
   3  *
   4  * Copyright (C) 2013 Renesas Solutions Corp.
   5  * Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11 #include "rsnd.h"
  12
  13 #define SRC_NAME "src"
  14
  15 /* SRCx_STATUS */
  16 #define OUF_SRCO        ((1 << 12) | (1 << 13))
  17 #define OUF_SRCI        ((1 <<  9) | (1 <<  8))
  18
  19 /* SCU_SYSTEM_STATUS0/1 */
  20 #define OUF_SRC(id)     ((1 << (id + 16)) | (1 << id))
  21
  22 struct rsnd_src {
  23         struct rsnd_mod mod;
  24         struct rsnd_mod *dma;
  25         struct rsnd_kctrl_cfg_s sen;  /* sync convert enable */
  26         struct rsnd_kctrl_cfg_s sync; /* sync convert */
  27         u32 convert_rate; /* sampling rate convert */
  28         int irq;
  29 };
  30
  31 #define RSND_SRC_NAME_SIZE 16
  32
  33 #define rsnd_src_get(priv, id) ((struct rsnd_src *)(priv->src) + id)
  34 #define rsnd_src_to_dma(src) ((src)->dma)
  35 #define rsnd_src_nr(priv) ((priv)->src_nr)
  36 #define rsnd_enable_sync_convert(src) ((src)->sen.val)
  37
  38 #define rsnd_mod_to_src(_mod)                           \
  39         container_of((_mod), struct rsnd_src, mod)
  40
  41 #define for_each_rsnd_src(pos, priv, i)                         \
  42         for ((i) = 0;                                           \
  43              ((i) < rsnd_src_nr(priv)) &&                       \
  44              ((pos) = (struct rsnd_src *)(priv)->src + i);      \
  45              i++)
  46
  47
  48 /*
  49  *              image of SRC (Sampling Rate Converter)
  50  *
  51  * 96kHz   <-> +-----+  48kHz   +-----+  48kHz  +-------+
  52  * 48kHz   <-> | SRC | <------> | SSI | <-----> | codec |
  53  * 44.1kHz <-> +-----+          +-----+         +-------+
  54  * ...
  55  *
  56  */
  57
  58 /*
  59  * src.c is caring...
  60  *
  61  * Gen1
  62  *
  63  * [mem] -> [SRU] -> [SSI]
  64  *        |--------|
  65  *
  66  * Gen2
  67  *
  68  * [mem] -> [SRC] -> [SSIU] -> [SSI]
  69  *        |-----------------|
  70  */
  71
  72 static void rsnd_src_activation(struct rsnd_mod *mod)
  73 {
  74         rsnd_mod_write(mod, SRC_SWRSR, 0);
  75         rsnd_mod_write(mod, SRC_SWRSR, 1);
  76 }
  77
  78 static void rsnd_src_halt(struct rsnd_mod *mod)
  79 {
  80         rsnd_mod_write(mod, SRC_SRCIR, 1);
  81         rsnd_mod_write(mod, SRC_SWRSR, 0);
  82 }
  83
  84 static struct dma_chan *rsnd_src_dma_req(struct rsnd_dai_stream *io,
  85                                          struct rsnd_mod *mod)
  86 {
  87         struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
  88         int is_play = rsnd_io_is_play(io);
  89
  90         return rsnd_dma_request_channel(rsnd_src_of_node(priv),
  91                                         mod,
  92                                         is_play ? "rx" : "tx");
  93 }
  94
  95 static u32 rsnd_src_convert_rate(struct rsnd_dai_stream *io,
  96                                  struct rsnd_src *src)
  97 {
  98         struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
  99         u32 convert_rate;
 100
 101         if (!runtime)
 102                 return 0;
 103
 104         if (!rsnd_enable_sync_convert(src))
 105                 return src->convert_rate;
 106
 107         convert_rate = src->sync.val;
 108
 109         if (!convert_rate)
 110                 convert_rate = src->convert_rate;
 111
 112         if (!convert_rate)
 113                 convert_rate = runtime->rate;
 114
 115         return convert_rate;
 116 }
 117
 118 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
 119                                    struct rsnd_dai_stream *io,
 120                                    struct snd_pcm_runtime *runtime)
 121 {
 122         struct rsnd_mod *src_mod = rsnd_io_to_mod_src(io);
 123         struct rsnd_src *src;
 124         unsigned int rate = 0;
 125
 126         if (src_mod) {
 127                 src = rsnd_mod_to_src(src_mod);
 128
 129                 /*
 130                  * return convert rate if SRC is used,
 131                  * otherwise, return runtime->rate as usual
 132                  */
 133                 rate = rsnd_src_convert_rate(io, src);
 134         }
 135
 136         if (!rate)
 137                 rate = runtime->rate;
 138
 139         return rate;
 140 }
 141
 142 static int rsnd_src_hw_params(struct rsnd_mod *mod,
 143                               struct rsnd_dai_stream *io,
 144                               struct snd_pcm_substream *substream,
 145                               struct snd_pcm_hw_params *fe_params)
 146 {
 147         struct rsnd_src *src = rsnd_mod_to_src(mod);
 148         struct snd_soc_pcm_runtime *fe = substream->private_data;
 149
 150         /*
 151          * SRC assumes that it is used under DPCM if user want to use
 152          * sampling rate convert. Then, SRC should be FE.
 153          * And then, this function will be called *after* BE settings.
 154          * this means, each BE already has fixuped hw_params.
 155          * see
 156          *      dpcm_fe_dai_hw_params()
 157          *      dpcm_be_dai_hw_params()
 158          */
 159         if (fe->dai_link->dynamic) {
 160                 int stream = substream->stream;
 161                 struct snd_soc_dpcm *dpcm;
 162                 struct snd_pcm_hw_params *be_params;
 163
 164                 list_for_each_entry(dpcm, &fe->dpcm[stream].be_clients, list_be) {
 165                         be_params = &dpcm->hw_params;
 166
 167                         if (params_rate(fe_params) != params_rate(be_params))
 168                                 src->convert_rate = params_rate(be_params);
 169                 }
 170         }
 171
 172         return 0;
 173 }
 174
 175 static void rsnd_src_set_convert_rate(struct rsnd_dai_stream *io,
 176                                       struct rsnd_mod *mod)
 177 {
 178         struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
 179         struct device *dev = rsnd_priv_to_dev(priv);
 180         struct snd_pcm_runtime *runtime = rsnd_io_to_runtime(io);
 181         struct rsnd_src *src = rsnd_mod_to_src(mod);
 182         u32 convert_rate = rsnd_src_convert_rate(io, src);
 183         u32 ifscr, fsrate, adinr;
 184         u32 cr, route;
 185         u32 bsdsr, bsisr;
 186         uint ratio;
 187
 188         if (!runtime)
 189                 return;
 190
 191         /* 6 - 1/6 are very enough ratio for SRC_BSDSR */
 192         if (!convert_rate)
 193                 ratio = 0;
 194         else if (convert_rate > runtime->rate)
 195                 ratio = 100 * convert_rate / runtime->rate;
 196         else
 197                 ratio = 100 * runtime->rate / convert_rate;
 198
 199         if (ratio > 600) {
 200                 dev_err(dev, "FSO/FSI ratio error\n");
 201                 return;
 202         }
 203
 204         /*
 205          *      SRC_ADINR
 206          */
 207         adinr = rsnd_get_adinr_bit(mod, io) |
 208                 rsnd_get_adinr_chan(mod, io);
 209
 210         /*
 211          *      SRC_IFSCR / SRC_IFSVR
 212          */
 213         ifscr = 0;
 214         fsrate = 0;
 215         if (convert_rate) {
 216                 ifscr = 1;
 217                 fsrate = 0x0400000 / convert_rate * runtime->rate;
 218         }
 219
 220         /*
 221          *      SRC_SRCCR / SRC_ROUTE_MODE0
 222          */
 223         cr      = 0x00011110;
 224         route   = 0x0;
 225         if (convert_rate) {
 226                 route   = 0x1;
 227
 228                 if (rsnd_enable_sync_convert(src)) {
 229                         cr |= 0x1;
 230                         route |= rsnd_io_is_play(io) ?
 231                                 (0x1 << 24) : (0x1 << 25);
 232                 }
 233         }
 234
 235         /*
 236          * SRC_BSDSR / SRC_BSISR
 237          */
 238         switch (rsnd_mod_id(mod)) {
 239         case 5:
 240         case 6:
 241         case 7:
 242         case 8:
 243                 bsdsr = 0x02400000; /* 6 - 1/6 */
 244                 bsisr = 0x00100060; /* 6 - 1/6 */
 245                 break;
 246         default:
 247                 bsdsr = 0x01800000; /* 6 - 1/6 */
 248                 bsisr = 0x00100060 ;/* 6 - 1/6 */
 249                 break;
 250         }
 251
 252         rsnd_mod_write(mod, SRC_SRCIR, 1);      /* initialize */
 253         rsnd_mod_write(mod, SRC_ADINR, adinr);
 254         rsnd_mod_write(mod, SRC_IFSCR, ifscr);
 255         rsnd_mod_write(mod, SRC_IFSVR, fsrate);
 256         rsnd_mod_write(mod, SRC_SRCCR, cr);
 257         rsnd_mod_write(mod, SRC_BSDSR, bsdsr);
 258         rsnd_mod_write(mod, SRC_BSISR, bsisr);
 259         rsnd_mod_write(mod, SRC_SRCIR, 0);      /* cancel initialize */
 260
 261         rsnd_mod_write(mod, SRC_ROUTE_MODE0, route);
 262         rsnd_mod_write(mod, SRC_I_BUSIF_MODE, 1);
 263         rsnd_mod_write(mod, SRC_O_BUSIF_MODE, 1);
 264         rsnd_mod_write(mod, SRC_BUSIF_DALIGN, rsnd_get_dalign(mod, io));
 265
 266         if (convert_rate)
 267                 rsnd_adg_set_convert_clk_gen2(mod, io,
 268                                               runtime->rate,
 269                                               convert_rate);
 270         else
 271                 rsnd_adg_set_convert_timing_gen2(mod, io);
 272 }
 273
 274 static int rsnd_src_irq(struct rsnd_mod *mod,
 275                         struct rsnd_dai_stream *io,
 276                         struct rsnd_priv *priv,
 277                         int enable)
 278 {
 279         struct rsnd_src *src = rsnd_mod_to_src(mod);
 280         u32 sys_int_val, int_val, sys_int_mask;
 281         int irq = src->irq;
 282         int id = rsnd_mod_id(mod);
 283
 284         sys_int_val =
 285         sys_int_mask = OUF_SRC(id);
 286         int_val = 0x3300;
 287
 288         /*
 289          * IRQ is not supported on non-DT
 290          * see
 291          *      rsnd_src_probe_()
 292          */
 293         if ((irq <= 0) || !enable) {
 294                 sys_int_val = 0;
 295                 int_val = 0;
 296         }
 297
 298         /*
 299          * WORKAROUND
 300          *
 301          * ignore over flow error when rsnd_enable_sync_convert()
 302          */
 303         if (rsnd_enable_sync_convert(src))
 304                 sys_int_val = sys_int_val & 0xffff;
 305
 306         rsnd_mod_write(mod, SRC_INT_ENABLE0, int_val);
 307         rsnd_mod_bset(mod, SCU_SYS_INT_EN0, sys_int_mask, sys_int_val);
 308         rsnd_mod_bset(mod, SCU_SYS_INT_EN1, sys_int_mask, sys_int_val);
 309
 310         return 0;
 311 }
 312
 313 static void rsnd_src_status_clear(struct rsnd_mod *mod)
 314 {
 315         u32 val = OUF_SRC(rsnd_mod_id(mod));
 316
 317         rsnd_mod_bset(mod, SCU_SYS_STATUS0, val, val);
 318         rsnd_mod_bset(mod, SCU_SYS_STATUS1, val, val);
 319 }
 320
 321 static bool rsnd_src_error_occurred(struct rsnd_mod *mod)
 322 {
 323         struct rsnd_src *src = rsnd_mod_to_src(mod);
 324         u32 val0, val1;
 325         bool ret = false;
 326
 327         val0 = val1 = OUF_SRC(rsnd_mod_id(mod));
 328
 329         /*
 330          * WORKAROUND
 331          *
 332          * ignore over flow error when rsnd_enable_sync_convert()
 333          */
 334         if (rsnd_enable_sync_convert(src))
 335                 val0 = val0 & 0xffff;
 336
 337         if ((rsnd_mod_read(mod, SCU_SYS_STATUS0) & val0) ||
 338             (rsnd_mod_read(mod, SCU_SYS_STATUS1) & val1))
 339                 ret = true;
 340
 341         return ret;
 342 }
 343
 344 static int rsnd_src_start(struct rsnd_mod *mod,
 345                           struct rsnd_dai_stream *io,
 346                           struct rsnd_priv *priv)
 347 {
 348         struct rsnd_src *src = rsnd_mod_to_src(mod);
 349         u32 val;
 350
 351         /*
 352          * WORKAROUND
 353          *
 354          * Enable SRC output if you want to use sync convert together with DVC
 355          */
 356         val = (rsnd_io_to_mod_dvc(io) && !rsnd_enable_sync_convert(src)) ?
 357                 0x01 : 0x11;
 358
 359         rsnd_mod_write(mod, SRC_CTRL, val);
 360
 361         return 0;
 362 }
 363
 364 static int rsnd_src_stop(struct rsnd_mod *mod,
 365                          struct rsnd_dai_stream *io,
 366                          struct rsnd_priv *priv)
 367 {
 368         rsnd_mod_write(mod, SRC_CTRL, 0);
 369
 370         return 0;
 371 }
 372
 373 static int rsnd_src_init(struct rsnd_mod *mod,
 374                          struct rsnd_dai_stream *io,
 375                          struct rsnd_priv *priv)
 376 {
 377         struct rsnd_src *src = rsnd_mod_to_src(mod);
 378
 379         rsnd_mod_power_on(mod);
 380
 381         rsnd_src_activation(mod);
 382
 383         rsnd_src_set_convert_rate(io, mod);
 384
 385         rsnd_src_status_clear(mod);
 386
 387         /* reset sync convert_rate */
 388         src->sync.val = 0;
 389
 390         return 0;
 391 }
 392
 393 static int rsnd_src_quit(struct rsnd_mod *mod,
 394                          struct rsnd_dai_stream *io,
 395                          struct rsnd_priv *priv)
 396 {
 397         struct rsnd_src *src = rsnd_mod_to_src(mod);
 398
 399         rsnd_src_halt(mod);
 400
 401         rsnd_mod_power_off(mod);
 402
 403         src->convert_rate = 0;
 404
 405         /* reset sync convert_rate */
 406         src->sync.val = 0;
 407
 408         return 0;
 409 }
 410
 411 static void __rsnd_src_interrupt(struct rsnd_mod *mod,
 412                                  struct rsnd_dai_stream *io)
 413 {
 414         struct rsnd_priv *priv = rsnd_mod_to_priv(mod);
 415         bool stop = false;
 416
 417         spin_lock(&priv->lock);
 418
 419         /* ignore all cases if not working */
 420         if (!rsnd_io_is_working(io))
 421                 goto rsnd_src_interrupt_out;
 422
 423         if (rsnd_src_error_occurred(mod))
 424                 stop = true;
 425
 426         rsnd_src_status_clear(mod);
 427 rsnd_src_interrupt_out:
 428
 429         spin_unlock(&priv->lock);
 430
 431         if (stop)
 432                 snd_pcm_stop_xrun(io->substream);
 433 }
 434
 435 static irqreturn_t rsnd_src_interrupt(int irq, void *data)
 436 {
 437         struct rsnd_mod *mod = data;
 438
 439         rsnd_mod_interrupt(mod, __rsnd_src_interrupt);
 440
 441         return IRQ_HANDLED;
 442 }
 443
 444 static int rsnd_src_probe_(struct rsnd_mod *mod,
 445                            struct rsnd_dai_stream *io,
 446                            struct rsnd_priv *priv)
 447 {
 448         struct rsnd_src *src = rsnd_mod_to_src(mod);
 449         struct device *dev = rsnd_priv_to_dev(priv);
 450         int irq = src->irq;
 451         int ret;
 452
 453         if (irq > 0) {
 454                 /*
 455                  * IRQ is not supported on non-DT
 456                  * see
 457                  *      rsnd_src_irq()
 458                  */
 459                 ret = devm_request_irq(dev, irq,
 460                                        rsnd_src_interrupt,
 461                                        IRQF_SHARED,
 462                                        dev_name(dev), mod);
 463                 if (ret)
 464                         return ret;
 465         }
 466
 467         ret = rsnd_dma_attach(io, mod, &src->dma, 0);
 468
 469         return ret;
 470 }
 471
 472 static int rsnd_src_pcm_new(struct rsnd_mod *mod,
 473                             struct rsnd_dai_stream *io,
 474                             struct snd_soc_pcm_runtime *rtd)
 475 {
 476         struct rsnd_dai *rdai = rsnd_io_to_rdai(io);
 477         struct rsnd_mod *dvc = rsnd_io_to_mod_dvc(io);
 478         struct rsnd_src *src = rsnd_mod_to_src(mod);
 479         int ret;
 480
 481         /*
 482          * enable SRC sync convert if possible
 483          */
 484
 485         /*
 486          * SRC sync convert needs clock master
 487          */
 488         if (!rsnd_rdai_is_clk_master(rdai))
 489                 return 0;
 490
 491         /*
 492          * SRC In doesn't work if DVC was enabled
 493          */
 494         if (dvc && !rsnd_io_is_play(io))
 495                 return 0;
 496
 497         /*
 498          * enable sync convert
 499          */
 500         ret = rsnd_kctrl_new_s(mod, io, rtd,
 501                                rsnd_io_is_play(io) ?
 502                                "SRC Out Rate Switch" :
 503                                "SRC In Rate Switch",
 504                                rsnd_src_set_convert_rate,
 505                                &src->sen, 1);
 506         if (ret < 0)
 507                 return ret;
 508
 509         ret = rsnd_kctrl_new_s(mod, io, rtd,
 510                                rsnd_io_is_play(io) ?
 511                                "SRC Out Rate" :
 512                                "SRC In Rate",
 513                                rsnd_src_set_convert_rate,
 514                                &src->sync, 192000);
 515
 516         return ret;
 517 }
 518
 519 static struct rsnd_mod_ops rsnd_src_ops = {
 520         .name   = SRC_NAME,
 521         .dma_req = rsnd_src_dma_req,
 522         .probe  = rsnd_src_probe_,
 523         .init   = rsnd_src_init,
 524         .quit   = rsnd_src_quit,
 525         .start  = rsnd_src_start,
 526         .stop   = rsnd_src_stop,
 527         .irq    = rsnd_src_irq,
 528         .hw_params = rsnd_src_hw_params,
 529         .pcm_new = rsnd_src_pcm_new,
 530 };
 531
 532 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id)
 533 {
 534         if (WARN_ON(id < 0 || id >= rsnd_src_nr(priv)))
 535                 id = 0;
 536
 537         return rsnd_mod_get(rsnd_src_get(priv, id));
 538 }
 539
 540 int rsnd_src_probe(struct rsnd_priv *priv)
 541 {
 542         struct device_node *node;
 543         struct device_node *np;
 544         struct device *dev = rsnd_priv_to_dev(priv);
 545         struct rsnd_src *src;
 546         struct clk *clk;
 547         char name[RSND_SRC_NAME_SIZE];
 548         int i, nr, ret;
 549
 550         /* This driver doesn't support Gen1 at this point */
 551         if (rsnd_is_gen1(priv))
 552                 return 0;
 553
 554         node = rsnd_src_of_node(priv);
 555         if (!node)
 556                 return 0; /* not used is not error */
 557
 558         nr = of_get_child_count(node);
 559         if (!nr) {
 560                 ret = -EINVAL;
 561                 goto rsnd_src_probe_done;
 562         }
 563
 564         src     = devm_kzalloc(dev, sizeof(*src) * nr, GFP_KERNEL);
 565         if (!src) {
 566                 ret = -ENOMEM;
 567                 goto rsnd_src_probe_done;
 568         }
 569
 570         priv->src_nr    = nr;
 571         priv->src       = src;
 572
 573         i = 0;
 574         for_each_child_of_node(node, np) {
 575                 src = rsnd_src_get(priv, i);
 576
 577                 snprintf(name, RSND_SRC_NAME_SIZE, "%s.%d",
 578                          SRC_NAME, i);
 579
 580                 src->irq = irq_of_parse_and_map(np, 0);
 581                 if (!src->irq) {
 582                         ret = -EINVAL;
 583                         goto rsnd_src_probe_done;
 584                 }
 585
 586                 clk = devm_clk_get(dev, name);
 587                 if (IS_ERR(clk)) {
 588                         ret = PTR_ERR(clk);
 589                         goto rsnd_src_probe_done;
 590                 }
 591
 592                 ret = rsnd_mod_init(priv, rsnd_mod_get(src),
 593                                     &rsnd_src_ops, clk, rsnd_mod_get_status,
 594                                     RSND_MOD_SRC, i);
 595                 if (ret)
 596                         goto rsnd_src_probe_done;
 597
 598                 i++;
 599         }
 600
 601         ret = 0;
 602
 603 rsnd_src_probe_done:
 604         of_node_put(node);
 605
 606         return ret;
 607 }
 608
 609 void rsnd_src_remove(struct rsnd_priv *priv)
 610 {
 611         struct rsnd_src *src;
 612         int i;
 613
 614         for_each_rsnd_src(src, priv, i) {
 615                 rsnd_mod_quit(rsnd_mod_get(src));
 616         }
 617 }