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 work_struct      work;
 160         struct dma_chan         *chan;
 161         enum dma_transfer_direction dir;
 162
 163         int submit_loop;
 164         int offset; /* it cares A/B plane */
 165 };
 166
 167 void rsnd_dma_start(struct rsnd_dma *dma);
 168 void rsnd_dma_stop(struct rsnd_dma *dma);
 169 int rsnd_dma_available(struct rsnd_dma *dma);
 170 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
 171         int is_play, int id);
 172 void  rsnd_dma_quit(struct rsnd_priv *priv,
 173                     struct rsnd_dma *dma);
 174
 175
 176 /*
 177  *      R-Car sound mod
 178  */
 179 enum rsnd_mod_type {
 180         RSND_MOD_SRC = 0,
 181         RSND_MOD_SSI,
 182         RSND_MOD_DVC,
 183         RSND_MOD_MAX,
 184 };
 185
 186 struct rsnd_mod_ops {
 187         char *name;
 188         char* (*dma_name)(struct rsnd_mod *mod);
 189         int (*probe)(struct rsnd_mod *mod,
 190                      struct rsnd_dai *rdai);
 191         int (*remove)(struct rsnd_mod *mod,
 192                       struct rsnd_dai *rdai);
 193         int (*init)(struct rsnd_mod *mod,
 194                     struct rsnd_dai *rdai);
 195         int (*quit)(struct rsnd_mod *mod,
 196                     struct rsnd_dai *rdai);
 197         int (*start)(struct rsnd_mod *mod,
 198                      struct rsnd_dai *rdai);
 199         int (*stop)(struct rsnd_mod *mod,
 200                     struct rsnd_dai *rdai);
 201         int (*pcm_new)(struct rsnd_mod *mod,
 202                        struct rsnd_dai *rdai,
 203                        struct snd_soc_pcm_runtime *rtd);
 204 };
 205
 206 struct rsnd_dai_stream;
 207 struct rsnd_mod {
 208         int id;
 209         enum rsnd_mod_type type;
 210         struct rsnd_priv *priv;
 211         struct rsnd_mod_ops *ops;
 212         struct rsnd_dma dma;
 213         struct rsnd_dai_stream *io;
 214 };
 215
 216 #define rsnd_mod_to_priv(mod) ((mod)->priv)
 217 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
 218 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
 219 #define rsnd_mod_to_io(mod) ((mod)->io)
 220 #define rsnd_mod_id(mod) ((mod)->id)
 221
 222 void rsnd_mod_init(struct rsnd_priv *priv,
 223                    struct rsnd_mod *mod,
 224                    struct rsnd_mod_ops *ops,
 225                    enum rsnd_mod_type type,
 226                    int id);
 227 char *rsnd_mod_name(struct rsnd_mod *mod);
 228 char *rsnd_mod_dma_name(struct rsnd_mod *mod);
 229
 230 /*
 231  *      R-Car sound DAI
 232  */
 233 #define RSND_DAI_NAME_SIZE      16
 234 struct rsnd_dai_stream {
 235         struct snd_pcm_substream *substream;
 236         struct rsnd_mod *mod[RSND_MOD_MAX];
 237         struct rsnd_dai_path_info *info; /* rcar_snd.h */
 238         int byte_pos;
 239         int period_pos;
 240         int byte_per_period;
 241         int next_period_byte;
 242 };
 243 #define rsnd_io_to_mod_ssi(io)  ((io)->mod[RSND_MOD_SSI])
 244 #define rsnd_io_to_mod_src(io)  ((io)->mod[RSND_MOD_SRC])
 245 #define rsnd_io_to_mod_dvc(io)  ((io)->mod[RSND_MOD_DVC])
 246
 247 struct rsnd_dai {
 248         char name[RSND_DAI_NAME_SIZE];
 249         struct rsnd_dai_platform_info *info; /* rcar_snd.h */
 250         struct rsnd_dai_stream playback;
 251         struct rsnd_dai_stream capture;
 252
 253         unsigned int clk_master:1;
 254         unsigned int bit_clk_inv:1;
 255         unsigned int frm_clk_inv:1;
 256         unsigned int sys_delay:1;
 257         unsigned int data_alignment:1;
 258 };
 259
 260 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
 261 #define for_each_rsnd_dai(rdai, priv, i)                \
 262         for (i = 0;                                     \
 263              (i < rsnd_rdai_nr(priv)) &&                \
 264              ((rdai) = rsnd_dai_get(priv, i));          \
 265              i++)
 266
 267 struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id);
 268 int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io);
 269 int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai);
 270 #define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
 271 #define rsnd_io_to_runtime(io) ((io)->substream->runtime)
 272
 273 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
 274 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
 275 #define rsnd_dai_is_clk_master(rdai) ((rdai)->clk_master)
 276
 277 /*
 278  *      R-Car Gen1/Gen2
 279  */
 280 int rsnd_gen_probe(struct platform_device *pdev,
 281                    const struct rsnd_of_data *of_data,
 282                    struct rsnd_priv *priv);
 283 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
 284                                struct rsnd_mod *mod,
 285                                enum rsnd_reg reg);
 286 void rsnd_gen_dma_addr(struct rsnd_priv *priv,
 287                        struct rsnd_dma *dma,
 288                        struct dma_slave_config *cfg,
 289                        int is_play,  int slave_id);
 290
 291 #define rsnd_is_gen1(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
 292 #define rsnd_is_gen2(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
 293
 294 /*
 295  *      R-Car ADG
 296  */
 297 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
 298 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
 299 int rsnd_adg_probe(struct platform_device *pdev,
 300                    const struct rsnd_of_data *of_data,
 301                    struct rsnd_priv *priv);
 302 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
 303                                   struct rsnd_mod *mod,
 304                                   unsigned int src_rate,
 305                                   unsigned int dst_rate);
 306 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
 307                                   struct rsnd_dai *rdai,
 308                                   struct rsnd_dai_stream *io,
 309                                   unsigned int src_rate,
 310                                   unsigned int dst_rate);
 311 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
 312                                      struct rsnd_dai *rdai,
 313                                      struct rsnd_dai_stream *io);
 314 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_dai *rdai,
 315                                  struct rsnd_mod *mod,
 316                                  struct rsnd_dai_stream *io);
 317
 318 /*
 319  *      R-Car sound priv
 320  */
 321 struct rsnd_of_data {
 322         u32 flags;
 323 };
 324
 325 struct rsnd_priv {
 326
 327         struct platform_device *pdev;
 328         struct rcar_snd_info *info;
 329         spinlock_t lock;
 330
 331         /*
 332          * below value will be filled on rsnd_gen_probe()
 333          */
 334         void *gen;
 335
 336         /*
 337          * below value will be filled on rsnd_src_probe()
 338          */
 339         void *src;
 340         int src_nr;
 341
 342         /*
 343          * below value will be filled on rsnd_adg_probe()
 344          */
 345         void *adg;
 346
 347         /*
 348          * below value will be filled on rsnd_ssi_probe()
 349          */
 350         void *ssi;
 351         int ssi_nr;
 352
 353         /*
 354          * below value will be filled on rsnd_dvc_probe()
 355          */
 356         void *dvc;
 357         int dvc_nr;
 358
 359         /*
 360          * below value will be filled on rsnd_dai_probe()
 361          */
 362         struct snd_soc_dai_driver *daidrv;
 363         struct rsnd_dai *rdai;
 364         int rdai_nr;
 365 };
 366
 367 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
 368 #define rsnd_priv_to_dev(priv)  (&(rsnd_priv_to_pdev(priv)->dev))
 369 #define rsnd_priv_to_info(priv) ((priv)->info)
 370 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
 371 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
 372
 373 #define rsnd_info_is_playback(priv, type)                               \
 374 ({                                                                      \
 375         struct rcar_snd_info *info = rsnd_priv_to_info(priv);           \
 376         int i, is_play = 0;                                             \
 377         for (i = 0; i < info->dai_info_nr; i++) {                       \
 378                 if (info->dai_info[i].playback.type == (type)->info) {  \
 379                         is_play = 1;                                    \
 380                         break;                                          \
 381                 }                                                       \
 382         }                                                               \
 383         is_play;                                                        \
 384 })
 385
 386 /*
 387  *      R-Car SRC
 388  */
 389 int rsnd_src_probe(struct platform_device *pdev,
 390                    const struct rsnd_of_data *of_data,
 391                    struct rsnd_priv *priv);
 392 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
 393 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
 394                                    struct rsnd_dai_stream *io,
 395                                    struct snd_pcm_runtime *runtime);
 396 int rsnd_src_ssiu_start(struct rsnd_mod *ssi_mod,
 397                         struct rsnd_dai *rdai,
 398                         int use_busif);
 399 int rsnd_src_ssiu_stop(struct rsnd_mod *ssi_mod,
 400                        struct rsnd_dai *rdai,
 401                        int use_busif);
 402 int rsnd_src_enable_ssi_irq(struct rsnd_mod *ssi_mod,
 403                             struct rsnd_dai *rdai);
 404
 405 #define rsnd_src_nr(priv) ((priv)->src_nr)
 406
 407 /*
 408  *      R-Car SSI
 409  */
 410 int rsnd_ssi_probe(struct platform_device *pdev,
 411                    const struct rsnd_of_data *of_data,
 412                    struct rsnd_priv *priv);
 413 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
 414 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
 415
 416 /*
 417  *      R-Car DVC
 418  */
 419 int rsnd_dvc_probe(struct platform_device *pdev,
 420                    const struct rsnd_of_data *of_data,
 421                    struct rsnd_priv *priv);
 422 void rsnd_dvc_remove(struct platform_device *pdev,
 423                      struct rsnd_priv *priv);
 424 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
 425
 426 #define rsnd_dvc_nr(priv) ((priv)->dvc_nr)
 427
 428
 429 #endif