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_SRC_ROUTE_SEL,         /* for Gen1 */
  36         RSND_REG_SRC_TMG_SEL0,          /* for Gen1 */
  37         RSND_REG_SRC_TMG_SEL1,          /* for Gen1 */
  38         RSND_REG_SRC_TMG_SEL2,          /* for Gen1 */
  39         RSND_REG_SRC_ROUTE_CTRL,        /* for Gen1 */
  40         RSND_REG_SRC_CTRL,              /* for Gen2 */
  41         RSND_REG_SSI_CTRL,              /* for Gen2 */
  42         RSND_REG_SSI_CONTROL,
  43         RSND_REG_SSI_BUSIF_MODE,        /* for Gen2 */
  44         RSND_REG_SSI_BUSIF_ADINR,       /* for Gen2 */
  45         RSND_REG_SSI_MODE0,
  46         RSND_REG_SSI_MODE1,
  47         RSND_REG_INT_ENABLE,            /* for Gen2 */
  48         RSND_REG_SRC_BUSIF_MODE,
  49         RSND_REG_SRC_ROUTE_MODE0,
  50         RSND_REG_SRC_SWRSR,
  51         RSND_REG_SRC_SRCIR,
  52         RSND_REG_SRC_ADINR,
  53         RSND_REG_SRC_IFSCR,
  54         RSND_REG_SRC_IFSVR,
  55         RSND_REG_SRC_SRCCR,
  56         RSND_REG_SRC_MNFSR,             /* for Gen1 */
  57         RSND_REG_SRC_BSDSR,             /* for Gen2 */
  58         RSND_REG_SRC_BSISR,             /* for Gen2 */
  59
  60         /* ADG */
  61         RSND_REG_BRRA,
  62         RSND_REG_BRRB,
  63         RSND_REG_SSICKR,
  64         RSND_REG_AUDIO_CLK_SEL0,
  65         RSND_REG_AUDIO_CLK_SEL1,
  66         RSND_REG_AUDIO_CLK_SEL2,
  67         RSND_REG_AUDIO_CLK_SEL3,        /* for Gen1 */
  68         RSND_REG_AUDIO_CLK_SEL4,        /* for Gen1 */
  69         RSND_REG_AUDIO_CLK_SEL5,        /* for Gen1 */
  70         RSND_REG_DIV_EN,                /* for Gen2 */
  71         RSND_REG_SRCIN_TIMSEL0,         /* for Gen2 */
  72         RSND_REG_SRCIN_TIMSEL1,         /* for Gen2 */
  73         RSND_REG_SRCIN_TIMSEL2,         /* for Gen2 */
  74         RSND_REG_SRCIN_TIMSEL3,         /* for Gen2 */
  75         RSND_REG_SRCIN_TIMSEL4,         /* for Gen2 */
  76         RSND_REG_SRCOUT_TIMSEL0,        /* for Gen2 */
  77         RSND_REG_SRCOUT_TIMSEL1,        /* for Gen2 */
  78         RSND_REG_SRCOUT_TIMSEL2,        /* for Gen2 */
  79         RSND_REG_SRCOUT_TIMSEL3,        /* for Gen2 */
  80         RSND_REG_SRCOUT_TIMSEL4,        /* for Gen2 */
  81
  82         /* SSI */
  83         RSND_REG_SSICR,
  84         RSND_REG_SSISR,
  85         RSND_REG_SSITDR,
  86         RSND_REG_SSIRDR,
  87         RSND_REG_SSIWSR,
  88
  89         RSND_REG_MAX,
  90 };
  91
  92 struct rsnd_priv;
  93 struct rsnd_mod;
  94 struct rsnd_dai;
  95 struct rsnd_dai_stream;
  96
  97 /*
  98  *      R-Car basic functions
  99  */
 100 #define rsnd_mod_read(m, r) \
 101         rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
 102 #define rsnd_mod_write(m, r, d) \
 103         rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
 104 #define rsnd_mod_bset(m, r, s, d) \
 105         rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
 106
 107 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
 108 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
 109                 enum rsnd_reg reg, u32 data);
 110 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
 111                     u32 mask, u32 data);
 112
 113 /*
 114  *      R-Car DMA
 115  */
 116 struct rsnd_dma {
 117         struct sh_dmae_slave    slave;
 118         struct work_struct      work;
 119         struct dma_chan         *chan;
 120         enum dma_data_direction dir;
 121
 122         int submit_loop;
 123         int offset; /* it cares A/B plane */
 124 };
 125
 126 void rsnd_dma_start(struct rsnd_dma *dma);
 127 void rsnd_dma_stop(struct rsnd_dma *dma);
 128 int rsnd_dma_available(struct rsnd_dma *dma);
 129 int rsnd_dma_init(struct rsnd_priv *priv, struct rsnd_dma *dma,
 130         int is_play, int id);
 131 void  rsnd_dma_quit(struct rsnd_priv *priv,
 132                     struct rsnd_dma *dma);
 133
 134
 135 /*
 136  *      R-Car sound mod
 137  */
 138 enum rsnd_mod_type {
 139         RSND_MOD_SCU = 0,
 140         RSND_MOD_SSI,
 141         RSND_MOD_MAX,
 142 };
 143
 144 struct rsnd_mod_ops {
 145         char *name;
 146         int (*init)(struct rsnd_mod *mod,
 147                     struct rsnd_dai *rdai,
 148                     struct rsnd_dai_stream *io);
 149         int (*quit)(struct rsnd_mod *mod,
 150                     struct rsnd_dai *rdai,
 151                     struct rsnd_dai_stream *io);
 152         int (*start)(struct rsnd_mod *mod,
 153                      struct rsnd_dai *rdai,
 154                      struct rsnd_dai_stream *io);
 155         int (*stop)(struct rsnd_mod *mod,
 156                     struct rsnd_dai *rdai,
 157                     struct rsnd_dai_stream *io);
 158 };
 159
 160 struct rsnd_dai_stream;
 161 struct rsnd_mod {
 162         int id;
 163         enum rsnd_mod_type type;
 164         struct rsnd_priv *priv;
 165         struct rsnd_mod_ops *ops;
 166         struct rsnd_dma dma;
 167         struct rsnd_dai_stream *io;
 168 };
 169
 170 #define rsnd_mod_to_priv(mod) ((mod)->priv)
 171 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
 172 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
 173 #define rsnd_mod_to_io(mod) ((mod)->io)
 174 #define rsnd_mod_id(mod) ((mod)->id)
 175
 176 void rsnd_mod_init(struct rsnd_priv *priv,
 177                    struct rsnd_mod *mod,
 178                    struct rsnd_mod_ops *ops,
 179                    enum rsnd_mod_type type,
 180                    int id);
 181 char *rsnd_mod_name(struct rsnd_mod *mod);
 182
 183 /*
 184  *      R-Car sound DAI
 185  */
 186 #define RSND_DAI_NAME_SIZE      16
 187 struct rsnd_dai_stream {
 188         struct snd_pcm_substream *substream;
 189         struct rsnd_mod *mod[RSND_MOD_MAX];
 190         int byte_pos;
 191         int period_pos;
 192         int byte_per_period;
 193         int next_period_byte;
 194 };
 195
 196 struct rsnd_dai {
 197         char name[RSND_DAI_NAME_SIZE];
 198         struct rsnd_dai_platform_info *info; /* rcar_snd.h */
 199         struct rsnd_dai_stream playback;
 200         struct rsnd_dai_stream capture;
 201
 202         unsigned int clk_master:1;
 203         unsigned int bit_clk_inv:1;
 204         unsigned int frm_clk_inv:1;
 205         unsigned int sys_delay:1;
 206         unsigned int data_alignment:1;
 207 };
 208
 209 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
 210 #define for_each_rsnd_dai(rdai, priv, i)                \
 211         for (i = 0;                                     \
 212              (i < rsnd_rdai_nr(priv)) &&                \
 213              ((rdai) = rsnd_dai_get(priv, i));          \
 214              i++)
 215
 216 struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id);
 217 int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io);
 218 int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai);
 219 #define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
 220 #define rsnd_io_to_runtime(io) ((io)->substream->runtime)
 221
 222 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
 223 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
 224 #define rsnd_dai_is_clk_master(rdai) ((rdai)->clk_master)
 225
 226 /*
 227  *      R-Car Gen1/Gen2
 228  */
 229 int rsnd_gen_probe(struct platform_device *pdev,
 230                    struct rsnd_priv *priv);
 231 void rsnd_gen_remove(struct platform_device *pdev,
 232                      struct rsnd_priv *priv);
 233 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
 234                                struct rsnd_mod *mod,
 235                                enum rsnd_reg reg);
 236 #define rsnd_is_gen1(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
 237 #define rsnd_is_gen2(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
 238
 239 /*
 240  *      R-Car ADG
 241  */
 242 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
 243 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
 244 int rsnd_adg_probe(struct platform_device *pdev,
 245                    struct rsnd_priv *priv);
 246 void rsnd_adg_remove(struct platform_device *pdev,
 247                    struct rsnd_priv *priv);
 248 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
 249                                   struct rsnd_mod *mod,
 250                                   unsigned int src_rate,
 251                                   unsigned int dst_rate);
 252 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
 253                                   struct rsnd_dai *rdai,
 254                                   struct rsnd_dai_stream *io,
 255                                   unsigned int src_rate,
 256                                   unsigned int dst_rate);
 257 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
 258                                      struct rsnd_dai *rdai,
 259                                      struct rsnd_dai_stream *io);
 260
 261 /*
 262  *      R-Car sound priv
 263  */
 264 struct rsnd_priv {
 265
 266         struct device *dev;
 267         struct rcar_snd_info *info;
 268         spinlock_t lock;
 269
 270         /*
 271          * below value will be filled on rsnd_gen_probe()
 272          */
 273         void *gen;
 274
 275         /*
 276          * below value will be filled on rsnd_scu_probe()
 277          */
 278         void *scu;
 279         int scu_nr;
 280
 281         /*
 282          * below value will be filled on rsnd_adg_probe()
 283          */
 284         void *adg;
 285
 286         /*
 287          * below value will be filled on rsnd_ssi_probe()
 288          */
 289         void *ssi;
 290         int ssi_nr;
 291
 292         /*
 293          * below value will be filled on rsnd_dai_probe()
 294          */
 295         struct snd_soc_dai_driver *daidrv;
 296         struct rsnd_dai *rdai;
 297         int rdai_nr;
 298 };
 299
 300 #define rsnd_priv_to_dev(priv)  ((priv)->dev)
 301 #define rsnd_priv_to_info(priv) ((priv)->info)
 302 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
 303 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
 304
 305 /*
 306  *      R-Car SCU
 307  */
 308 int rsnd_scu_probe(struct platform_device *pdev,
 309                    struct rsnd_priv *priv);
 310 void rsnd_scu_remove(struct platform_device *pdev,
 311                      struct rsnd_priv *priv);
 312 struct rsnd_mod *rsnd_scu_mod_get(struct rsnd_priv *priv, int id);
 313 unsigned int rsnd_scu_get_ssi_rate(struct rsnd_priv *priv,
 314                                    struct rsnd_mod *ssi_mod,
 315                                    struct snd_pcm_runtime *runtime);
 316
 317 #define rsnd_scu_nr(priv) ((priv)->scu_nr)
 318
 319 /*
 320  *      R-Car SSI
 321  */
 322 int rsnd_ssi_probe(struct platform_device *pdev,
 323                    struct rsnd_priv *priv);
 324 void rsnd_ssi_remove(struct platform_device *pdev,
 325                    struct rsnd_priv *priv);
 326 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
 327 struct rsnd_mod *rsnd_ssi_mod_get_frm_dai(struct rsnd_priv *priv,
 328                                           int dai_id, int is_play);
 329 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
 330 int rsnd_ssi_is_play(struct rsnd_mod *mod);
 331
 332 #endif