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