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/sh_dma.h>
  21 #include <linux/workqueue.h>
  22 #include <sound/rcar_snd.h>
  23 #include <sound/soc.h>
  24 #include <sound/pcm_params.h>
  25
  26 /*
  27  *      pseudo register
  28  *
  29  * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
  30  * This driver uses pseudo register in order to hide it.
  31  * see gen1/gen2 for detail
  32  */
  33 enum rsnd_reg {
  34         /* SRU/SCU/SSIU */
  35         RSND_REG_SSI_MODE0,
  36         RSND_REG_SSI_MODE1,
  37         RSND_REG_SRC_BUSIF_MODE,
  38         RSND_REG_SRC_ROUTE_MODE0,
  39         RSND_REG_SRC_SWRSR,
  40         RSND_REG_SRC_SRCIR,
  41         RSND_REG_SRC_ADINR,
  42         RSND_REG_SRC_IFSCR,
  43         RSND_REG_SRC_IFSVR,
  44         RSND_REG_SRC_SRCCR,
  45
  46         /* ADG */
  47         RSND_REG_BRRA,
  48         RSND_REG_BRRB,
  49         RSND_REG_SSICKR,
  50         RSND_REG_AUDIO_CLK_SEL0,
  51         RSND_REG_AUDIO_CLK_SEL1,
  52
  53         /* SSI */
  54         RSND_REG_SSICR,
  55         RSND_REG_SSISR,
  56         RSND_REG_SSITDR,
  57         RSND_REG_SSIRDR,
  58         RSND_REG_SSIWSR,
  59
  60         /* SHARE see below */
  61         RSND_REG_SHARE01,
  62         RSND_REG_SHARE02,
  63         RSND_REG_SHARE03,
  64         RSND_REG_SHARE04,
  65         RSND_REG_SHARE05,
  66         RSND_REG_SHARE06,
  67         RSND_REG_SHARE07,
  68         RSND_REG_SHARE08,
  69         RSND_REG_SHARE09,
  70         RSND_REG_SHARE10,
  71         RSND_REG_SHARE11,
  72         RSND_REG_SHARE12,
  73         RSND_REG_SHARE13,
  74         RSND_REG_SHARE14,
  75         RSND_REG_SHARE15,
  76         RSND_REG_SHARE16,
  77         RSND_REG_SHARE17,
  78         RSND_REG_SHARE18,
  79         RSND_REG_SHARE19,
  80
  81         RSND_REG_MAX,
  82 };
  83
  84 /* Gen1 only */
  85 #define RSND_REG_SRC_ROUTE_SEL          RSND_REG_SHARE01
  86 #define RSND_REG_SRC_TMG_SEL0           RSND_REG_SHARE02
  87 #define RSND_REG_SRC_TMG_SEL1           RSND_REG_SHARE03
  88 #define RSND_REG_SRC_TMG_SEL2           RSND_REG_SHARE04
  89 #define RSND_REG_SRC_ROUTE_CTRL         RSND_REG_SHARE05
  90 #define RSND_REG_SRC_MNFSR              RSND_REG_SHARE06
  91 #define RSND_REG_AUDIO_CLK_SEL3         RSND_REG_SHARE07
  92 #define RSND_REG_AUDIO_CLK_SEL4         RSND_REG_SHARE08
  93 #define RSND_REG_AUDIO_CLK_SEL5         RSND_REG_SHARE09
  94
  95 /* Gen2 only */
  96 #define RSND_REG_SRC_CTRL               RSND_REG_SHARE01
  97 #define RSND_REG_SSI_CTRL               RSND_REG_SHARE02
  98 #define RSND_REG_SSI_BUSIF_MODE         RSND_REG_SHARE03
  99 #define RSND_REG_SSI_BUSIF_ADINR        RSND_REG_SHARE04
 100 #define RSND_REG_INT_ENABLE             RSND_REG_SHARE05
 101 #define RSND_REG_SRC_BSDSR              RSND_REG_SHARE06
 102 #define RSND_REG_SRC_BSISR              RSND_REG_SHARE07
 103 #define RSND_REG_DIV_EN                 RSND_REG_SHARE08
 104 #define RSND_REG_SRCIN_TIMSEL0          RSND_REG_SHARE09
 105 #define RSND_REG_SRCIN_TIMSEL1          RSND_REG_SHARE10
 106 #define RSND_REG_SRCIN_TIMSEL2          RSND_REG_SHARE11
 107 #define RSND_REG_SRCIN_TIMSEL3          RSND_REG_SHARE12
 108 #define RSND_REG_SRCIN_TIMSEL4          RSND_REG_SHARE13
 109 #define RSND_REG_SRCOUT_TIMSEL0         RSND_REG_SHARE14
 110 #define RSND_REG_SRCOUT_TIMSEL1         RSND_REG_SHARE15
 111 #define RSND_REG_SRCOUT_TIMSEL2         RSND_REG_SHARE16
 112 #define RSND_REG_SRCOUT_TIMSEL3         RSND_REG_SHARE17
 113 #define RSND_REG_SRCOUT_TIMSEL4         RSND_REG_SHARE18
 114 #define RSND_REG_AUDIO_CLK_SEL2         RSND_REG_SHARE19
 115
 116 struct rsnd_priv;
 117 struct rsnd_mod;
 118 struct rsnd_dai;
 119 struct rsnd_dai_stream;
 120
 121 /*
 122  *      R-Car basic functions
 123  */
 124 #define rsnd_mod_read(m, r) \
 125         rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
 126 #define rsnd_mod_write(m, r, d) \
 127         rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
 128 #define rsnd_mod_bset(m, r, s, d) \
 129         rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
 130
 131 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
 132 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
 133                 enum rsnd_reg reg, u32 data);
 134 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
 135                     u32 mask, u32 data);
 136
 137 /*
 138  *      R-Car DMA
 139  */
 140 struct rsnd_dma {
 141         struct sh_dmae_slave    slave;
 142         struct work_struct      work;
 143         struct dma_chan         *chan;
 144         enum dma_data_direction dir;
 145
 146         int submit_loop;
 147         int offset; /* it cares A/B plane */
 148 };
 149
 150 void rsnd_dma_start(struct rsnd_dma *dma);
 151 void rsnd_dma_stop(struct rsnd_dma *dma);
 152 int rsnd_dma_available(struct rsnd_dma *dma);
 153 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
 154         int is_play, int id);
 155 void  rsnd_dma_quit(struct rsnd_priv *priv,
 156                     struct rsnd_dma *dma);
 157
 158
 159 /*
 160  *      R-Car sound mod
 161  */
 162 enum rsnd_mod_type {
 163         RSND_MOD_SRC = 0,
 164         RSND_MOD_SSI,
 165         RSND_MOD_MAX,
 166 };
 167
 168 struct rsnd_mod_ops {
 169         char *name;
 170         int (*probe)(struct rsnd_mod *mod,
 171                      struct rsnd_dai *rdai,
 172                      struct rsnd_dai_stream *io);
 173         int (*remove)(struct rsnd_mod *mod,
 174                       struct rsnd_dai *rdai,
 175                       struct rsnd_dai_stream *io);
 176         int (*init)(struct rsnd_mod *mod,
 177                     struct rsnd_dai *rdai,
 178                     struct rsnd_dai_stream *io);
 179         int (*quit)(struct rsnd_mod *mod,
 180                     struct rsnd_dai *rdai,
 181                     struct rsnd_dai_stream *io);
 182         int (*start)(struct rsnd_mod *mod,
 183                      struct rsnd_dai *rdai,
 184                      struct rsnd_dai_stream *io);
 185         int (*stop)(struct rsnd_mod *mod,
 186                     struct rsnd_dai *rdai,
 187                     struct rsnd_dai_stream *io);
 188 };
 189
 190 struct rsnd_dai_stream;
 191 struct rsnd_mod {
 192         int id;
 193         enum rsnd_mod_type type;
 194         struct rsnd_priv *priv;
 195         struct rsnd_mod_ops *ops;
 196         struct rsnd_dma dma;
 197         struct rsnd_dai_stream *io;
 198 };
 199
 200 #define rsnd_mod_to_priv(mod) ((mod)->priv)
 201 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
 202 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
 203 #define rsnd_mod_to_io(mod) ((mod)->io)
 204 #define rsnd_mod_id(mod) ((mod)->id)
 205
 206 void rsnd_mod_init(struct rsnd_priv *priv,
 207                    struct rsnd_mod *mod,
 208                    struct rsnd_mod_ops *ops,
 209                    enum rsnd_mod_type type,
 210                    int id);
 211 char *rsnd_mod_name(struct rsnd_mod *mod);
 212
 213 /*
 214  *      R-Car sound DAI
 215  */
 216 #define RSND_DAI_NAME_SIZE      16
 217 struct rsnd_dai_stream {
 218         struct snd_pcm_substream *substream;
 219         struct rsnd_mod *mod[RSND_MOD_MAX];
 220         struct rsnd_dai_path_info *info; /* rcar_snd.h */
 221         int byte_pos;
 222         int period_pos;
 223         int byte_per_period;
 224         int next_period_byte;
 225 };
 226 #define rsnd_io_to_mod_ssi(io)  ((io)->mod[RSND_MOD_SSI])
 227 #define rsnd_io_to_mod_src(io)  ((io)->mod[RSND_MOD_SRC])
 228
 229 struct rsnd_dai {
 230         char name[RSND_DAI_NAME_SIZE];
 231         struct rsnd_dai_platform_info *info; /* rcar_snd.h */
 232         struct rsnd_dai_stream playback;
 233         struct rsnd_dai_stream capture;
 234
 235         unsigned int clk_master:1;
 236         unsigned int bit_clk_inv:1;
 237         unsigned int frm_clk_inv:1;
 238         unsigned int sys_delay:1;
 239         unsigned int data_alignment:1;
 240 };
 241
 242 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
 243 #define for_each_rsnd_dai(rdai, priv, i)                \
 244         for (i = 0;                                     \
 245              (i < rsnd_rdai_nr(priv)) &&                \
 246              ((rdai) = rsnd_dai_get(priv, i));          \
 247              i++)
 248
 249 struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id);
 250 int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io);
 251 int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai);
 252 #define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
 253 #define rsnd_io_to_runtime(io) ((io)->substream->runtime)
 254
 255 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
 256 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
 257 #define rsnd_dai_is_clk_master(rdai) ((rdai)->clk_master)
 258
 259 /*
 260  *      R-Car Gen1/Gen2
 261  */
 262 int rsnd_gen_probe(struct platform_device *pdev,
 263                    struct rsnd_priv *priv);
 264 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
 265                                struct rsnd_mod *mod,
 266                                enum rsnd_reg reg);
 267 #define rsnd_is_gen1(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
 268 #define rsnd_is_gen2(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
 269
 270 /*
 271  *      R-Car ADG
 272  */
 273 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
 274 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
 275 int rsnd_adg_probe(struct platform_device *pdev,
 276                    struct rsnd_priv *priv);
 277 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
 278                                   struct rsnd_mod *mod,
 279                                   unsigned int src_rate,
 280                                   unsigned int dst_rate);
 281 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
 282                                   struct rsnd_dai *rdai,
 283                                   struct rsnd_dai_stream *io,
 284                                   unsigned int src_rate,
 285                                   unsigned int dst_rate);
 286 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
 287                                      struct rsnd_dai *rdai,
 288                                      struct rsnd_dai_stream *io);
 289
 290 /*
 291  *      R-Car sound priv
 292  */
 293 struct rsnd_priv {
 294
 295         struct device *dev;
 296         struct rcar_snd_info *info;
 297         spinlock_t lock;
 298
 299         /*
 300          * below value will be filled on rsnd_gen_probe()
 301          */
 302         void *gen;
 303
 304         /*
 305          * below value will be filled on rsnd_src_probe()
 306          */
 307         void *src;
 308         int src_nr;
 309
 310         /*
 311          * below value will be filled on rsnd_adg_probe()
 312          */
 313         void *adg;
 314
 315         /*
 316          * below value will be filled on rsnd_ssi_probe()
 317          */
 318         void *ssi;
 319         int ssi_nr;
 320
 321         /*
 322          * below value will be filled on rsnd_dai_probe()
 323          */
 324         struct snd_soc_dai_driver *daidrv;
 325         struct rsnd_dai *rdai;
 326         int rdai_nr;
 327 };
 328
 329 #define rsnd_priv_to_dev(priv)  ((priv)->dev)
 330 #define rsnd_priv_to_info(priv) ((priv)->info)
 331 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
 332 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
 333
 334 #define rsnd_info_is_playback(priv, type)                               \
 335 ({                                                                      \
 336         struct rcar_snd_info *info = rsnd_priv_to_info(priv);           \
 337         int i, is_play = 0;                                             \
 338         for (i = 0; i < info->dai_info_nr; i++) {                       \
 339                 if (info->dai_info[i].playback.type == (type)->info) {  \
 340                         is_play = 1;                                    \
 341                         break;                                          \
 342                 }                                                       \
 343         }                                                               \
 344         is_play;                                                        \
 345 })
 346
 347 /*
 348  *      R-Car SRC
 349  */
 350 int rsnd_src_probe(struct platform_device *pdev,
 351                    struct rsnd_priv *priv);
 352 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
 353 unsigned int rsnd_src_get_ssi_rate(struct rsnd_priv *priv,
 354                                    struct rsnd_dai_stream *io,
 355                                    struct snd_pcm_runtime *runtime);
 356 int rsnd_src_ssi_mode_init(struct rsnd_mod *ssi_mod,
 357                            struct rsnd_dai *rdai,
 358                            struct rsnd_dai_stream *io);
 359 int rsnd_src_enable_ssi_irq(struct rsnd_mod *ssi_mod,
 360                             struct rsnd_dai *rdai,
 361                             struct rsnd_dai_stream *io);
 362
 363 #define rsnd_src_nr(priv) ((priv)->src_nr)
 364
 365 /*
 366  *      R-Car SSI
 367  */
 368 int rsnd_ssi_probe(struct platform_device *pdev,
 369                    struct rsnd_priv *priv);
 370 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
 371 struct rsnd_mod *rsnd_ssi_mod_get_frm_dai(struct rsnd_priv *priv,
 372                                           int dai_id, int is_play);
 373 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
 374 int rsnd_ssi_is_play(struct rsnd_mod *mod);
 375
 376 #endif