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_CMD_ROUTE_SLCT,
  48         RSND_REG_DVC_SWRSR,
  49         RSND_REG_DVC_DVUIR,
  50         RSND_REG_DVC_ADINR,
  51         RSND_REG_DVC_DVUCR,
  52         RSND_REG_DVC_ZCMCR,
  53         RSND_REG_DVC_VOL0R,
  54         RSND_REG_DVC_VOL1R,
  55         RSND_REG_DVC_DVUER,
  56
  57         /* ADG */
  58         RSND_REG_BRRA,
  59         RSND_REG_BRRB,
  60         RSND_REG_SSICKR,
  61         RSND_REG_AUDIO_CLK_SEL0,
  62         RSND_REG_AUDIO_CLK_SEL1,
  63
  64         /* SSI */
  65         RSND_REG_SSICR,
  66         RSND_REG_SSISR,
  67         RSND_REG_SSITDR,
  68         RSND_REG_SSIRDR,
  69         RSND_REG_SSIWSR,
  70
  71         /* SHARE see below */
  72         RSND_REG_SHARE01,
  73         RSND_REG_SHARE02,
  74         RSND_REG_SHARE03,
  75         RSND_REG_SHARE04,
  76         RSND_REG_SHARE05,
  77         RSND_REG_SHARE06,
  78         RSND_REG_SHARE07,
  79         RSND_REG_SHARE08,
  80         RSND_REG_SHARE09,
  81         RSND_REG_SHARE10,
  82         RSND_REG_SHARE11,
  83         RSND_REG_SHARE12,
  84         RSND_REG_SHARE13,
  85         RSND_REG_SHARE14,
  86         RSND_REG_SHARE15,
  87         RSND_REG_SHARE16,
  88         RSND_REG_SHARE17,
  89         RSND_REG_SHARE18,
  90         RSND_REG_SHARE19,
  91         RSND_REG_SHARE20,
  92         RSND_REG_SHARE21,
  93
  94         RSND_REG_MAX,
  95 };
  96
  97 /* Gen1 only */
  98 #define RSND_REG_SRC_ROUTE_SEL          RSND_REG_SHARE01
  99 #define RSND_REG_SRC_TMG_SEL0           RSND_REG_SHARE02
 100 #define RSND_REG_SRC_TMG_SEL1           RSND_REG_SHARE03
 101 #define RSND_REG_SRC_TMG_SEL2           RSND_REG_SHARE04
 102 #define RSND_REG_SRC_ROUTE_CTRL         RSND_REG_SHARE05
 103 #define RSND_REG_SRC_MNFSR              RSND_REG_SHARE06
 104 #define RSND_REG_AUDIO_CLK_SEL3         RSND_REG_SHARE07
 105 #define RSND_REG_AUDIO_CLK_SEL4         RSND_REG_SHARE08
 106 #define RSND_REG_AUDIO_CLK_SEL5         RSND_REG_SHARE09
 107
 108 /* Gen2 only */
 109 #define RSND_REG_SRC_CTRL               RSND_REG_SHARE01
 110 #define RSND_REG_SSI_CTRL               RSND_REG_SHARE02
 111 #define RSND_REG_SSI_BUSIF_MODE         RSND_REG_SHARE03
 112 #define RSND_REG_SSI_BUSIF_ADINR        RSND_REG_SHARE04
 113 #define RSND_REG_INT_ENABLE             RSND_REG_SHARE05
 114 #define RSND_REG_SRC_BSDSR              RSND_REG_SHARE06
 115 #define RSND_REG_SRC_BSISR              RSND_REG_SHARE07
 116 #define RSND_REG_DIV_EN                 RSND_REG_SHARE08
 117 #define RSND_REG_SRCIN_TIMSEL0          RSND_REG_SHARE09
 118 #define RSND_REG_SRCIN_TIMSEL1          RSND_REG_SHARE10
 119 #define RSND_REG_SRCIN_TIMSEL2          RSND_REG_SHARE11
 120 #define RSND_REG_SRCIN_TIMSEL3          RSND_REG_SHARE12
 121 #define RSND_REG_SRCIN_TIMSEL4          RSND_REG_SHARE13
 122 #define RSND_REG_SRCOUT_TIMSEL0         RSND_REG_SHARE14
 123 #define RSND_REG_SRCOUT_TIMSEL1         RSND_REG_SHARE15
 124 #define RSND_REG_SRCOUT_TIMSEL2         RSND_REG_SHARE16
 125 #define RSND_REG_SRCOUT_TIMSEL3         RSND_REG_SHARE17
 126 #define RSND_REG_SRCOUT_TIMSEL4         RSND_REG_SHARE18
 127 #define RSND_REG_AUDIO_CLK_SEL2         RSND_REG_SHARE19
 128 #define RSND_REG_CMD_CTRL               RSND_REG_SHARE20
 129 #define RSND_REG_CMDOUT_TIMSEL          RSND_REG_SHARE21
 130
 131 struct rsnd_of_data;
 132 struct rsnd_priv;
 133 struct rsnd_mod;
 134 struct rsnd_dai;
 135 struct rsnd_dai_stream;
 136
 137 /*
 138  *      R-Car basic functions
 139  */
 140 #define rsnd_mod_read(m, r) \
 141         rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
 142 #define rsnd_mod_write(m, r, d) \
 143         rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
 144 #define rsnd_mod_bset(m, r, s, d) \
 145         rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
 146
 147 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
 148 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
 149                 enum rsnd_reg reg, u32 data);
 150 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
 151                     u32 mask, u32 data);
 152 u32 rsnd_get_adinr(struct rsnd_mod *mod);
 153
 154 /*
 155  *      R-Car DMA
 156  */
 157 struct rsnd_dma {
 158         struct sh_dmae_slave    slave;
 159         struct dma_chan         *chan;
 160         enum dma_transfer_direction dir;
 161 };
 162
 163 void rsnd_dma_start(struct rsnd_dma *dma);
 164 void rsnd_dma_stop(struct rsnd_dma *dma);
 165 int rsnd_dma_available(struct rsnd_dma *dma);
 166 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
 167         int is_play, int id);
 168 void  rsnd_dma_quit(struct rsnd_priv *priv,
 169                     struct rsnd_dma *dma);
 170
 171
 172 /*
 173  *      R-Car sound mod
 174  */
 175 enum rsnd_mod_type {
 176         RSND_MOD_SRC = 0,
 177         RSND_MOD_SSI,
 178         RSND_MOD_DVC,
 179         RSND_MOD_MAX,
 180 };
 181
 182 struct rsnd_mod_ops {
 183         char *name;
 184         char* (*dma_name)(struct rsnd_mod *mod);
 185         int (*probe)(struct rsnd_mod *mod,
 186                      struct rsnd_dai *rdai);
 187         int (*remove)(struct rsnd_mod *mod,
 188                       struct rsnd_dai *rdai);
 189         int (*init)(struct rsnd_mod *mod,
 190                     struct rsnd_dai *rdai);
 191         int (*quit)(struct rsnd_mod *mod,
 192                     struct rsnd_dai *rdai);
 193         int (*start)(struct rsnd_mod *mod,
 194                      struct rsnd_dai *rdai);
 195         int (*stop)(struct rsnd_mod *mod,
 196                     struct rsnd_dai *rdai);
 197         int (*pcm_new)(struct rsnd_mod *mod,
 198                        struct rsnd_dai *rdai,
 199                        struct snd_soc_pcm_runtime *rtd);
 200 };
 201
 202 struct rsnd_dai_stream;
 203 struct rsnd_mod {
 204         int id;
 205         enum rsnd_mod_type type;
 206         struct rsnd_priv *priv;
 207         struct rsnd_mod_ops *ops;
 208         struct rsnd_dma dma;
 209         struct rsnd_dai_stream *io;
 210 };
 211
 212 #define rsnd_mod_to_priv(mod) ((mod)->priv)
 213 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
 214 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
 215 #define rsnd_mod_to_io(mod) ((mod)->io)
 216 #define rsnd_mod_id(mod) ((mod)->id)
 217
 218 void rsnd_mod_init(struct rsnd_priv *priv,
 219                    struct rsnd_mod *mod,
 220                    struct rsnd_mod_ops *ops,
 221                    enum rsnd_mod_type type,
 222                    int id);
 223 char *rsnd_mod_name(struct rsnd_mod *mod);
 224 char *rsnd_mod_dma_name(struct rsnd_mod *mod);
 225
 226 /*
 227  *      R-Car sound DAI
 228  */
 229 #define RSND_DAI_NAME_SIZE      16
 230 struct rsnd_dai_stream {
 231         struct snd_pcm_substream *substream;
 232         struct rsnd_mod *mod[RSND_MOD_MAX];
 233         struct rsnd_dai_path_info *info; /* rcar_snd.h */
 234         int byte_pos;
 235         int period_pos;
 236         int byte_per_period;
 237         int next_period_byte;
 238 };
 239 #define rsnd_io_to_mod_ssi(io)  ((io)->mod[RSND_MOD_SSI])
 240 #define rsnd_io_to_mod_src(io)  ((io)->mod[RSND_MOD_SRC])
 241 #define rsnd_io_to_mod_dvc(io)  ((io)->mod[RSND_MOD_DVC])
 242
 243 struct rsnd_dai {
 244         char name[RSND_DAI_NAME_SIZE];
 245         struct rsnd_dai_platform_info *info; /* rcar_snd.h */
 246         struct rsnd_dai_stream playback;
 247         struct rsnd_dai_stream capture;
 248
 249         unsigned int clk_master:1;
 250         unsigned int bit_clk_inv:1;
 251         unsigned int frm_clk_inv:1;
 252         unsigned int sys_delay:1;
 253         unsigned int data_alignment:1;
 254 };
 255
 256 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
 257 #define for_each_rsnd_dai(rdai, priv, i)                \
 258         for (i = 0;                                     \
 259              (i < rsnd_rdai_nr(priv)) &&                \
 260              ((rdai) = rsnd_dai_get(priv, i));          \
 261              i++)
 262
 263 struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id);
 264 int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io);
 265 int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai);
 266 #define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
 267 #define rsnd_io_to_runtime(io) ((io)->substream->runtime)
 268
 269 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
 270 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
 271 #define rsnd_dai_is_clk_master(rdai) ((rdai)->clk_master)
 272
 273 /*
 274  *      R-Car Gen1/Gen2
 275  */
 276 int rsnd_gen_probe(struct platform_device *pdev,
 277                    const struct rsnd_of_data *of_data,
 278                    struct rsnd_priv *priv);
 279 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
 280                                struct rsnd_mod *mod,
 281                                enum rsnd_reg reg);
 282 void rsnd_gen_dma_addr(struct rsnd_priv *priv,
 283                        struct rsnd_dma *dma,
 284                        struct dma_slave_config *cfg,
 285                        int is_play,  int slave_id);
 286
 287 #define rsnd_is_gen1(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
 288 #define rsnd_is_gen2(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
 289
 290 /*
 291  *      R-Car ADG
 292  */
 293 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
 294 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
 295 int rsnd_adg_probe(struct platform_device *pdev,
 296                    const struct rsnd_of_data *of_data,
 297                    struct rsnd_priv *priv);
 298 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
 299                                   struct rsnd_mod *mod,
 300                                   unsigned int src_rate,
 301                                   unsigned int dst_rate);
 302 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
 303                                   struct rsnd_dai *rdai,
 304                                   struct rsnd_dai_stream *io,
 305                                   unsigned int src_rate,
 306                                   unsigned int dst_rate);
 307 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
 308                                      struct rsnd_dai *rdai,
 309                                      struct rsnd_dai_stream *io);
 310 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_dai *rdai,
 311                                  struct rsnd_mod *mod,
 312                                  struct rsnd_dai_stream *io);
 313
 314 /*
 315  *      R-Car sound priv
 316  */
 317 struct rsnd_of_data {
 318         u32 flags;
 319 };
 320
 321 struct rsnd_priv {
 322
 323         struct platform_device *pdev;
 324         struct rcar_snd_info *info;
 325         spinlock_t lock;
 326
 327         /*
 328          * below value will be filled on rsnd_gen_probe()
 329          */
 330         void *gen;
 331
 332         /*
 333          * below value will be filled on rsnd_src_probe()
 334          */
 335         void *src;
 336         int src_nr;
 337
 338         /*
 339          * below value will be filled on rsnd_adg_probe()
 340          */
 341         void *adg;
 342
 343         /*
 344          * below value will be filled on rsnd_ssi_probe()
 345          */
 346         void *ssi;
 347         int ssi_nr;
 348
 349         /*
 350          * below value will be filled on rsnd_dvc_probe()
 351          */
 352         void *dvc;
 353         int dvc_nr;
 354
 355         /*
 356          * below value will be filled on rsnd_dai_probe()
 357          */
 358         struct snd_soc_dai_driver *daidrv;
 359         struct rsnd_dai *rdai;
 360         int rdai_nr;
 361 };
 362
 363 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
 364 #define rsnd_priv_to_dev(priv)  (&(rsnd_priv_to_pdev(priv)->dev))
 365 #define rsnd_priv_to_info(priv) ((priv)->info)
 366 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
 367 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
 368
 369 #define rsnd_info_is_playback(priv, type)                               \
 370 ({                                                                      \
 371         struct rcar_snd_info *info = rsnd_priv_to_info(priv);           \
 372         int i, is_play = 0;                                             \
 373         for (i = 0; i < info->dai_info_nr; i++) {                       \
 374                 if (info->dai_info[i].playback.type == (type)->info) {  \
 375                         is_play = 1;                                    \
 376                         break;                                          \
 377                 }                                                       \
 378         }                                                               \
 379         is_play;                                                        \
 380 })
 381
 382 /*
 383  *      R-Car SRC
 384  */
 385 int rsnd_src_probe(struct platform_device *pdev,
 386                    const struct rsnd_of_data *of_data,
 387                    struct rsnd_priv *priv);
 388 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
 389 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
 390                                    struct rsnd_dai_stream *io,
 391                                    struct snd_pcm_runtime *runtime);
 392 int rsnd_src_ssiu_start(struct rsnd_mod *ssi_mod,
 393                         struct rsnd_dai *rdai,
 394                         int use_busif);
 395 int rsnd_src_ssiu_stop(struct rsnd_mod *ssi_mod,
 396                        struct rsnd_dai *rdai,
 397                        int use_busif);
 398 int rsnd_src_enable_ssi_irq(struct rsnd_mod *ssi_mod,
 399                             struct rsnd_dai *rdai);
 400
 401 #define rsnd_src_nr(priv) ((priv)->src_nr)
 402
 403 /*
 404  *      R-Car SSI
 405  */
 406 int rsnd_ssi_probe(struct platform_device *pdev,
 407                    const struct rsnd_of_data *of_data,
 408                    struct rsnd_priv *priv);
 409 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
 410 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
 411
 412 /*
 413  *      R-Car DVC
 414  */
 415 int rsnd_dvc_probe(struct platform_device *pdev,
 416                    const struct rsnd_of_data *of_data,
 417                    struct rsnd_priv *priv);
 418 void rsnd_dvc_remove(struct platform_device *pdev,
 419                      struct rsnd_priv *priv);
 420 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
 421
 422 #define rsnd_dvc_nr(priv) ((priv)->dvc_nr)
 423
 424
 425 #endif