sound/soc/sh/rcar/rsnd.h

   1 /*
   2  * Renesas R-Car
   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 #ifndef RSND_H
  12 #define RSND_H
  13
  14 #include <linux/clk.h>
  15 #include <linux/device.h>
  16 #include <linux/dma-mapping.h>
  17 #include <linux/io.h>
  18 #include <linux/list.h>
  19 #include <linux/module.h>
  20 #include <linux/of_device.h>
  21 #include <linux/of_irq.h>
  22 #include <linux/sh_dma.h>
  23 #include <linux/workqueue.h>
  24 #include <sound/rcar_snd.h>
  25 #include <sound/soc.h>
  26 #include <sound/pcm_params.h>
  27
  28 /*
  29  *      pseudo register
  30  *
  31  * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
  32  * This driver uses pseudo register in order to hide it.
  33  * see gen1/gen2 for detail
  34  */
  35 enum rsnd_reg {
  36         /* SRU/SCU/SSIU */
  37         RSND_REG_SSI_MODE0,
  38         RSND_REG_SSI_MODE1,
  39         RSND_REG_SRC_BUSIF_MODE,
  40         RSND_REG_SRC_ROUTE_MODE0,
  41         RSND_REG_SRC_SWRSR,
  42         RSND_REG_SRC_SRCIR,
  43         RSND_REG_SRC_ADINR,
  44         RSND_REG_SRC_IFSCR,
  45         RSND_REG_SRC_IFSVR,
  46         RSND_REG_SRC_SRCCR,
  47         RSND_REG_SCU_SYS_STATUS0,
  48         RSND_REG_SCU_SYS_INT_EN0,
  49         RSND_REG_CMD_ROUTE_SLCT,
  50         RSND_REG_DVC_SWRSR,
  51         RSND_REG_DVC_DVUIR,
  52         RSND_REG_DVC_ADINR,
  53         RSND_REG_DVC_DVUCR,
  54         RSND_REG_DVC_ZCMCR,
  55         RSND_REG_DVC_VOL0R,
  56         RSND_REG_DVC_VOL1R,
  57         RSND_REG_DVC_DVUER,
  58
  59         /* ADG */
  60         RSND_REG_BRRA,
  61         RSND_REG_BRRB,
  62         RSND_REG_SSICKR,
  63         RSND_REG_AUDIO_CLK_SEL0,
  64         RSND_REG_AUDIO_CLK_SEL1,
  65
  66         /* SSI */
  67         RSND_REG_SSICR,
  68         RSND_REG_SSISR,
  69         RSND_REG_SSITDR,
  70         RSND_REG_SSIRDR,
  71         RSND_REG_SSIWSR,
  72
  73         /* SHARE see below */
  74         RSND_REG_SHARE01,
  75         RSND_REG_SHARE02,
  76         RSND_REG_SHARE03,
  77         RSND_REG_SHARE04,
  78         RSND_REG_SHARE05,
  79         RSND_REG_SHARE06,
  80         RSND_REG_SHARE07,
  81         RSND_REG_SHARE08,
  82         RSND_REG_SHARE09,
  83         RSND_REG_SHARE10,
  84         RSND_REG_SHARE11,
  85         RSND_REG_SHARE12,
  86         RSND_REG_SHARE13,
  87         RSND_REG_SHARE14,
  88         RSND_REG_SHARE15,
  89         RSND_REG_SHARE16,
  90         RSND_REG_SHARE17,
  91         RSND_REG_SHARE18,
  92         RSND_REG_SHARE19,
  93         RSND_REG_SHARE20,
  94         RSND_REG_SHARE21,
  95         RSND_REG_SHARE22,
  96         RSND_REG_SHARE23,
  97         RSND_REG_SHARE24,
  98         RSND_REG_SHARE25,
  99         RSND_REG_SHARE26,
 100         RSND_REG_SHARE27,
 101         RSND_REG_SHARE28,
 102
 103         RSND_REG_MAX,
 104 };
 105
 106 /* Gen1 only */
 107 #define RSND_REG_SRC_ROUTE_SEL          RSND_REG_SHARE01
 108 #define RSND_REG_SRC_TMG_SEL0           RSND_REG_SHARE02
 109 #define RSND_REG_SRC_TMG_SEL1           RSND_REG_SHARE03
 110 #define RSND_REG_SRC_TMG_SEL2           RSND_REG_SHARE04
 111 #define RSND_REG_SRC_ROUTE_CTRL         RSND_REG_SHARE05
 112 #define RSND_REG_SRC_MNFSR              RSND_REG_SHARE06
 113 #define RSND_REG_AUDIO_CLK_SEL3         RSND_REG_SHARE07
 114 #define RSND_REG_AUDIO_CLK_SEL4         RSND_REG_SHARE08
 115 #define RSND_REG_AUDIO_CLK_SEL5         RSND_REG_SHARE09
 116
 117 /* Gen2 only */
 118 #define RSND_REG_SRC_CTRL               RSND_REG_SHARE01
 119 #define RSND_REG_SSI_CTRL               RSND_REG_SHARE02
 120 #define RSND_REG_SSI_BUSIF_MODE         RSND_REG_SHARE03
 121 #define RSND_REG_SSI_BUSIF_ADINR        RSND_REG_SHARE04
 122 #define RSND_REG_INT_ENABLE             RSND_REG_SHARE05
 123 #define RSND_REG_SRC_BSDSR              RSND_REG_SHARE06
 124 #define RSND_REG_SRC_BSISR              RSND_REG_SHARE07
 125 #define RSND_REG_DIV_EN                 RSND_REG_SHARE08
 126 #define RSND_REG_SRCIN_TIMSEL0          RSND_REG_SHARE09
 127 #define RSND_REG_SRCIN_TIMSEL1          RSND_REG_SHARE10
 128 #define RSND_REG_SRCIN_TIMSEL2          RSND_REG_SHARE11
 129 #define RSND_REG_SRCIN_TIMSEL3          RSND_REG_SHARE12
 130 #define RSND_REG_SRCIN_TIMSEL4          RSND_REG_SHARE13
 131 #define RSND_REG_SRCOUT_TIMSEL0         RSND_REG_SHARE14
 132 #define RSND_REG_SRCOUT_TIMSEL1         RSND_REG_SHARE15
 133 #define RSND_REG_SRCOUT_TIMSEL2         RSND_REG_SHARE16
 134 #define RSND_REG_SRCOUT_TIMSEL3         RSND_REG_SHARE17
 135 #define RSND_REG_SRCOUT_TIMSEL4         RSND_REG_SHARE18
 136 #define RSND_REG_AUDIO_CLK_SEL2         RSND_REG_SHARE19
 137 #define RSND_REG_CMD_CTRL               RSND_REG_SHARE20
 138 #define RSND_REG_CMDOUT_TIMSEL          RSND_REG_SHARE21
 139 #define RSND_REG_BUSIF_DALIGN           RSND_REG_SHARE22
 140 #define RSND_REG_DVC_VRCTR              RSND_REG_SHARE23
 141 #define RSND_REG_DVC_VRPDR              RSND_REG_SHARE24
 142 #define RSND_REG_DVC_VRDBR              RSND_REG_SHARE25
 143 #define RSND_REG_SCU_SYS_STATUS1        RSND_REG_SHARE26
 144 #define RSND_REG_SCU_SYS_INT_EN1        RSND_REG_SHARE27
 145 #define RSND_REG_SRC_INT_ENABLE0        RSND_REG_SHARE28
 146
 147 struct rsnd_of_data;
 148 struct rsnd_priv;
 149 struct rsnd_mod;
 150 struct rsnd_dai;
 151 struct rsnd_dai_stream;
 152
 153 /*
 154  *      R-Car basic functions
 155  */
 156 #define rsnd_mod_read(m, r) \
 157         rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
 158 #define rsnd_mod_write(m, r, d) \
 159         rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
 160 #define rsnd_mod_bset(m, r, s, d) \
 161         rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
 162
 163 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
 164 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
 165                 enum rsnd_reg reg, u32 data);
 166 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
 167                     u32 mask, u32 data);
 168 u32 rsnd_get_adinr(struct rsnd_mod *mod);
 169
 170 /*
 171  *      R-Car DMA
 172  */
 173 struct rsnd_dma {
 174         struct sh_dmae_slave    slave;
 175         struct dma_chan         *chan;
 176         enum dma_transfer_direction dir;
 177         dma_addr_t              addr;
 178 };
 179
 180 void rsnd_dma_start(struct rsnd_dma *dma);
 181 void rsnd_dma_stop(struct rsnd_dma *dma);
 182 int rsnd_dma_available(struct rsnd_dma *dma);
 183 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
 184         int is_play, int id);
 185 void  rsnd_dma_quit(struct rsnd_priv *priv,
 186                     struct rsnd_dma *dma);
 187
 188
 189 /*
 190  *      R-Car sound mod
 191  */
 192 enum rsnd_mod_type {
 193         RSND_MOD_DVC = 0,
 194         RSND_MOD_SRC,
 195         RSND_MOD_SSI,
 196         RSND_MOD_MAX,
 197 };
 198
 199 struct rsnd_mod_ops {
 200         char *name;
 201         char* (*dma_name)(struct rsnd_mod *mod);
 202         int (*probe)(struct rsnd_mod *mod,
 203                      struct rsnd_priv *priv);
 204         int (*remove)(struct rsnd_mod *mod,
 205                       struct rsnd_priv *priv);
 206         int (*init)(struct rsnd_mod *mod,
 207                     struct rsnd_priv *priv);
 208         int (*quit)(struct rsnd_mod *mod,
 209                     struct rsnd_priv *priv);
 210         int (*start)(struct rsnd_mod *mod,
 211                      struct rsnd_priv *priv);
 212         int (*stop)(struct rsnd_mod *mod,
 213                     struct rsnd_priv *priv);
 214         int (*pcm_new)(struct rsnd_mod *mod,
 215                        struct snd_soc_pcm_runtime *rtd);
 216         int (*fallback)(struct rsnd_mod *mod,
 217                         struct rsnd_priv *priv);
 218 };
 219
 220 struct rsnd_dai_stream;
 221 struct rsnd_mod {
 222         int id;
 223         enum rsnd_mod_type type;
 224         struct rsnd_mod_ops *ops;
 225         struct rsnd_dma dma;
 226         struct rsnd_dai_stream *io;
 227         struct clk *clk;
 228         u32 status;
 229 };
 230 /*
 231  * status
 232  *
 233  * bit
 234  * 0    0: probe        1: remove
 235  * 1    0: init         1: quit
 236  * 2    0: start        1: stop
 237  * 3    0: pcm_new
 238  * 4    0: fallback
 239  */
 240 #define __rsnd_mod_shift_probe          0
 241 #define __rsnd_mod_shift_remove         0
 242 #define __rsnd_mod_shift_init           1
 243 #define __rsnd_mod_shift_quit           1
 244 #define __rsnd_mod_shift_start          2
 245 #define __rsnd_mod_shift_stop           2
 246 #define __rsnd_mod_shift_pcm_new        3
 247 #define __rsnd_mod_shift_fallback       4
 248
 249 #define __rsnd_mod_call_probe           0
 250 #define __rsnd_mod_call_remove          1
 251 #define __rsnd_mod_call_init            0
 252 #define __rsnd_mod_call_quit            1
 253 #define __rsnd_mod_call_start           0
 254 #define __rsnd_mod_call_stop            1
 255 #define __rsnd_mod_call_pcm_new         0
 256 #define __rsnd_mod_call_fallback        0
 257
 258 #define rsnd_mod_to_priv(mod) (rsnd_io_to_priv(rsnd_mod_to_io(mod)))
 259 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
 260 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
 261 #define rsnd_mod_to_io(mod) ((mod)->io)
 262 #define rsnd_mod_id(mod) ((mod)->id)
 263 #define rsnd_mod_hw_start(mod)  clk_enable((mod)->clk)
 264 #define rsnd_mod_hw_stop(mod)   clk_disable((mod)->clk)
 265
 266 int rsnd_mod_init(struct rsnd_mod *mod,
 267                    struct rsnd_mod_ops *ops,
 268                    struct clk *clk,
 269                    enum rsnd_mod_type type,
 270                    int id);
 271 void rsnd_mod_quit(struct rsnd_mod *mod);
 272 char *rsnd_mod_name(struct rsnd_mod *mod);
 273 char *rsnd_mod_dma_name(struct rsnd_mod *mod);
 274
 275 /*
 276  *      R-Car sound DAI
 277  */
 278 #define RSND_DAI_NAME_SIZE      16
 279 struct rsnd_dai_stream {
 280         struct snd_pcm_substream *substream;
 281         struct rsnd_mod *mod[RSND_MOD_MAX];
 282         struct rsnd_dai_path_info *info; /* rcar_snd.h */
 283         struct rsnd_dai *rdai;
 284         int byte_pos;
 285         int period_pos;
 286         int byte_per_period;
 287         int next_period_byte;
 288 };
 289 #define rsnd_io_to_mod_ssi(io)  ((io)->mod[RSND_MOD_SSI])
 290 #define rsnd_io_to_mod_src(io)  ((io)->mod[RSND_MOD_SRC])
 291 #define rsnd_io_to_mod_dvc(io)  ((io)->mod[RSND_MOD_DVC])
 292 #define rsnd_io_to_rdai(io)     ((io)->rdai)
 293 #define rsnd_io_to_priv(io)     (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
 294 #define rsnd_io_is_play(io)     (&rsnd_io_to_rdai(io)->playback == io)
 295 #define rsnd_io_to_runtime(io) ((io)->substream ? \
 296                                 (io)->substream->runtime : NULL)
 297
 298
 299 struct rsnd_dai {
 300         char name[RSND_DAI_NAME_SIZE];
 301         struct rsnd_dai_stream playback;
 302         struct rsnd_dai_stream capture;
 303         struct rsnd_priv *priv;
 304
 305         unsigned int clk_master:1;
 306         unsigned int bit_clk_inv:1;
 307         unsigned int frm_clk_inv:1;
 308         unsigned int sys_delay:1;
 309         unsigned int data_alignment:1;
 310 };
 311
 312 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
 313 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
 314 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
 315 #define for_each_rsnd_dai(rdai, priv, i)                \
 316         for (i = 0;                                     \
 317              (i < rsnd_rdai_nr(priv)) &&                \
 318              ((rdai) = rsnd_rdai_get(priv, i));         \
 319              i++)
 320
 321 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
 322
 323 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
 324 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
 325
 326 /*
 327  *      R-Car Gen1/Gen2
 328  */
 329 int rsnd_gen_probe(struct platform_device *pdev,
 330                    const struct rsnd_of_data *of_data,
 331                    struct rsnd_priv *priv);
 332 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
 333                                struct rsnd_mod *mod,
 334                                enum rsnd_reg reg);
 335 dma_addr_t rsnd_gen_dma_addr(struct rsnd_priv *priv,
 336                        struct rsnd_mod *mod,
 337                        int is_play,  int is_from);
 338
 339 #define rsnd_is_gen1(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
 340 #define rsnd_is_gen2(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
 341
 342 /*
 343  *      R-Car ADG
 344  */
 345 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
 346 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
 347 int rsnd_adg_probe(struct platform_device *pdev,
 348                    const struct rsnd_of_data *of_data,
 349                    struct rsnd_priv *priv);
 350 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
 351                                   struct rsnd_mod *mod,
 352                                   unsigned int src_rate,
 353                                   unsigned int dst_rate);
 354 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
 355                                   struct rsnd_dai_stream *io,
 356                                   unsigned int src_rate,
 357                                   unsigned int dst_rate);
 358 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
 359                                      struct rsnd_dai_stream *io);
 360 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
 361                                  struct rsnd_dai_stream *io);
 362
 363 /*
 364  *      R-Car sound priv
 365  */
 366 struct rsnd_of_data {
 367         u32 flags;
 368 };
 369
 370 struct rsnd_priv {
 371
 372         struct platform_device *pdev;
 373         struct rcar_snd_info *info;
 374         spinlock_t lock;
 375
 376         /*
 377          * below value will be filled on rsnd_gen_probe()
 378          */
 379         void *gen;
 380
 381         /*
 382          * below value will be filled on rsnd_src_probe()
 383          */
 384         void *src;
 385         int src_nr;
 386
 387         /*
 388          * below value will be filled on rsnd_adg_probe()
 389          */
 390         void *adg;
 391
 392         /*
 393          * below value will be filled on rsnd_ssi_probe()
 394          */
 395         void *ssi;
 396         int ssi_nr;
 397
 398         /*
 399          * below value will be filled on rsnd_dvc_probe()
 400          */
 401         void *dvc;
 402         int dvc_nr;
 403
 404         /*
 405          * below value will be filled on rsnd_dai_probe()
 406          */
 407         struct snd_soc_dai_driver *daidrv;
 408         struct rsnd_dai *rdai;
 409         int rdai_nr;
 410 };
 411
 412 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
 413 #define rsnd_priv_to_dev(priv)  (&(rsnd_priv_to_pdev(priv)->dev))
 414 #define rsnd_priv_to_info(priv) ((priv)->info)
 415 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
 416 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
 417
 418 #define rsnd_info_is_playback(priv, type)                               \
 419 ({                                                                      \
 420         struct rcar_snd_info *info = rsnd_priv_to_info(priv);           \
 421         int i, is_play = 0;                                             \
 422         for (i = 0; i < info->dai_info_nr; i++) {                       \
 423                 if (info->dai_info[i].playback.type == (type)->info) {  \
 424                         is_play = 1;                                    \
 425                         break;                                          \
 426                 }                                                       \
 427         }                                                               \
 428         is_play;                                                        \
 429 })
 430
 431 /*
 432  *      rsnd_kctrl
 433  */
 434 struct rsnd_kctrl_cfg {
 435         unsigned int max;
 436         unsigned int size;
 437         u32 *val;
 438         const char * const *texts;
 439         void (*update)(struct rsnd_mod *mod);
 440         struct snd_card *card;
 441         struct snd_kcontrol *kctrl;
 442 };
 443
 444 #define RSND_DVC_CHANNELS       2
 445 struct rsnd_kctrl_cfg_m {
 446         struct rsnd_kctrl_cfg cfg;
 447         u32 val[RSND_DVC_CHANNELS];
 448 };
 449
 450 struct rsnd_kctrl_cfg_s {
 451         struct rsnd_kctrl_cfg cfg;
 452         u32 val;
 453 };
 454
 455 void _rsnd_kctrl_remove(struct rsnd_kctrl_cfg *cfg);
 456 #define rsnd_kctrl_remove(_cfg) _rsnd_kctrl_remove(&((_cfg).cfg))
 457
 458 int rsnd_kctrl_new_m(struct rsnd_mod *mod,
 459                      struct snd_soc_pcm_runtime *rtd,
 460                      const unsigned char *name,
 461                      void (*update)(struct rsnd_mod *mod),
 462                      struct rsnd_kctrl_cfg_m *_cfg,
 463                      u32 max);
 464 int rsnd_kctrl_new_s(struct rsnd_mod *mod,
 465                      struct snd_soc_pcm_runtime *rtd,
 466                      const unsigned char *name,
 467                      void (*update)(struct rsnd_mod *mod),
 468                      struct rsnd_kctrl_cfg_s *_cfg,
 469                      u32 max);
 470 int rsnd_kctrl_new_e(struct rsnd_mod *mod,
 471                      struct snd_soc_pcm_runtime *rtd,
 472                      const unsigned char *name,
 473                      struct rsnd_kctrl_cfg_s *_cfg,
 474                      void (*update)(struct rsnd_mod *mod),
 475                      const char * const *texts,
 476                      u32 max);
 477
 478 /*
 479  *      R-Car SRC
 480  */
 481 int rsnd_src_probe(struct platform_device *pdev,
 482                    const struct rsnd_of_data *of_data,
 483                    struct rsnd_priv *priv);
 484 void rsnd_src_remove(struct platform_device *pdev,
 485                      struct rsnd_priv *priv);
 486 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
 487 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
 488                                    struct rsnd_dai_stream *io,
 489                                    struct snd_pcm_runtime *runtime);
 490 int rsnd_src_ssiu_start(struct rsnd_mod *ssi_mod,
 491                         int use_busif);
 492 int rsnd_src_ssiu_stop(struct rsnd_mod *ssi_mod);
 493 int rsnd_src_ssi_irq_enable(struct rsnd_mod *ssi_mod);
 494 int rsnd_src_ssi_irq_disable(struct rsnd_mod *ssi_mod);
 495
 496 #define rsnd_src_nr(priv) ((priv)->src_nr)
 497
 498 /*
 499  *      R-Car SSI
 500  */
 501 int rsnd_ssi_probe(struct platform_device *pdev,
 502                    const struct rsnd_of_data *of_data,
 503                    struct rsnd_priv *priv);
 504 void rsnd_ssi_remove(struct platform_device *pdev,
 505                      struct rsnd_priv *priv);
 506 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
 507 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
 508 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
 509
 510 /*
 511  *      R-Car DVC
 512  */
 513 int rsnd_dvc_probe(struct platform_device *pdev,
 514                    const struct rsnd_of_data *of_data,
 515                    struct rsnd_priv *priv);
 516 void rsnd_dvc_remove(struct platform_device *pdev,
 517                      struct rsnd_priv *priv);
 518 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
 519
 520 #define rsnd_dvc_nr(priv) ((priv)->dvc_nr)
 521
 522
 523 #endif