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_SCU = 0,
 164         RSND_MOD_SSI,
 165         RSND_MOD_MAX,
 166 };
 167
 168 struct rsnd_mod_ops {
 169         char *name;
 170         int (*init)(struct rsnd_mod *mod,
 171                     struct rsnd_dai *rdai,
 172                     struct rsnd_dai_stream *io);
 173         int (*quit)(struct rsnd_mod *mod,
 174                     struct rsnd_dai *rdai,
 175                     struct rsnd_dai_stream *io);
 176         int (*start)(struct rsnd_mod *mod,
 177                      struct rsnd_dai *rdai,
 178                      struct rsnd_dai_stream *io);
 179         int (*stop)(struct rsnd_mod *mod,
 180                     struct rsnd_dai *rdai,
 181                     struct rsnd_dai_stream *io);
 182 };
 183
 184 struct rsnd_dai_stream;
 185 struct rsnd_mod {
 186         int id;
 187         enum rsnd_mod_type type;
 188         struct rsnd_priv *priv;
 189         struct rsnd_mod_ops *ops;
 190         struct rsnd_dma dma;
 191         struct rsnd_dai_stream *io;
 192 };
 193
 194 #define rsnd_mod_to_priv(mod) ((mod)->priv)
 195 #define rsnd_mod_to_dma(mod) (&(mod)->dma)
 196 #define rsnd_dma_to_mod(_dma) container_of((_dma), struct rsnd_mod, dma)
 197 #define rsnd_mod_to_io(mod) ((mod)->io)
 198 #define rsnd_mod_id(mod) ((mod)->id)
 199
 200 void rsnd_mod_init(struct rsnd_priv *priv,
 201                    struct rsnd_mod *mod,
 202                    struct rsnd_mod_ops *ops,
 203                    enum rsnd_mod_type type,
 204                    int id);
 205 char *rsnd_mod_name(struct rsnd_mod *mod);
 206
 207 /*
 208  *      R-Car sound DAI
 209  */
 210 #define RSND_DAI_NAME_SIZE      16
 211 struct rsnd_dai_stream {
 212         struct snd_pcm_substream *substream;
 213         struct rsnd_mod *mod[RSND_MOD_MAX];
 214         int byte_pos;
 215         int period_pos;
 216         int byte_per_period;
 217         int next_period_byte;
 218 };
 219 #define rsnd_io_to_mod_ssi(io)  ((io)->mod[RSND_MOD_SSI])
 220 #define rsnd_io_to_mod_scu(io)  ((io)->mod[RSND_MOD_SCU])
 221
 222 struct rsnd_dai {
 223         char name[RSND_DAI_NAME_SIZE];
 224         struct rsnd_dai_platform_info *info; /* rcar_snd.h */
 225         struct rsnd_dai_stream playback;
 226         struct rsnd_dai_stream capture;
 227
 228         unsigned int clk_master:1;
 229         unsigned int bit_clk_inv:1;
 230         unsigned int frm_clk_inv:1;
 231         unsigned int sys_delay:1;
 232         unsigned int data_alignment:1;
 233 };
 234
 235 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
 236 #define for_each_rsnd_dai(rdai, priv, i)                \
 237         for (i = 0;                                     \
 238              (i < rsnd_rdai_nr(priv)) &&                \
 239              ((rdai) = rsnd_dai_get(priv, i));          \
 240              i++)
 241
 242 struct rsnd_dai *rsnd_dai_get(struct rsnd_priv *priv, int id);
 243 int rsnd_dai_is_play(struct rsnd_dai *rdai, struct rsnd_dai_stream *io);
 244 int rsnd_dai_id(struct rsnd_priv *priv, struct rsnd_dai *rdai);
 245 #define rsnd_dai_get_platform_info(rdai) ((rdai)->info)
 246 #define rsnd_io_to_runtime(io) ((io)->substream->runtime)
 247
 248 void rsnd_dai_pointer_update(struct rsnd_dai_stream *io, int cnt);
 249 int rsnd_dai_pointer_offset(struct rsnd_dai_stream *io, int additional);
 250 #define rsnd_dai_is_clk_master(rdai) ((rdai)->clk_master)
 251
 252 /*
 253  *      R-Car Gen1/Gen2
 254  */
 255 int rsnd_gen_probe(struct platform_device *pdev,
 256                    struct rsnd_priv *priv);
 257 void rsnd_gen_remove(struct platform_device *pdev,
 258                      struct rsnd_priv *priv);
 259 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
 260                                struct rsnd_mod *mod,
 261                                enum rsnd_reg reg);
 262 #define rsnd_is_gen1(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN1)
 263 #define rsnd_is_gen2(s)         (((s)->info->flags & RSND_GEN_MASK) == RSND_GEN2)
 264
 265 /*
 266  *      R-Car ADG
 267  */
 268 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
 269 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
 270 int rsnd_adg_probe(struct platform_device *pdev,
 271                    struct rsnd_priv *priv);
 272 void rsnd_adg_remove(struct platform_device *pdev,
 273                    struct rsnd_priv *priv);
 274 int rsnd_adg_set_convert_clk_gen1(struct rsnd_priv *priv,
 275                                   struct rsnd_mod *mod,
 276                                   unsigned int src_rate,
 277                                   unsigned int dst_rate);
 278 int rsnd_adg_set_convert_clk_gen2(struct rsnd_mod *mod,
 279                                   struct rsnd_dai *rdai,
 280                                   struct rsnd_dai_stream *io,
 281                                   unsigned int src_rate,
 282                                   unsigned int dst_rate);
 283 int rsnd_adg_set_convert_timing_gen2(struct rsnd_mod *mod,
 284                                      struct rsnd_dai *rdai,
 285                                      struct rsnd_dai_stream *io);
 286
 287 /*
 288  *      R-Car sound priv
 289  */
 290 struct rsnd_priv {
 291
 292         struct device *dev;
 293         struct rcar_snd_info *info;
 294         spinlock_t lock;
 295
 296         /*
 297          * below value will be filled on rsnd_gen_probe()
 298          */
 299         void *gen;
 300
 301         /*
 302          * below value will be filled on rsnd_scu_probe()
 303          */
 304         void *scu;
 305         int scu_nr;
 306
 307         /*
 308          * below value will be filled on rsnd_adg_probe()
 309          */
 310         void *adg;
 311
 312         /*
 313          * below value will be filled on rsnd_ssi_probe()
 314          */
 315         void *ssi;
 316         int ssi_nr;
 317
 318         /*
 319          * below value will be filled on rsnd_dai_probe()
 320          */
 321         struct snd_soc_dai_driver *daidrv;
 322         struct rsnd_dai *rdai;
 323         int rdai_nr;
 324 };
 325
 326 #define rsnd_priv_to_dev(priv)  ((priv)->dev)
 327 #define rsnd_priv_to_info(priv) ((priv)->info)
 328 #define rsnd_lock(priv, flags) spin_lock_irqsave(&priv->lock, flags)
 329 #define rsnd_unlock(priv, flags) spin_unlock_irqrestore(&priv->lock, flags)
 330
 331 /*
 332  *      R-Car SCU
 333  */
 334 int rsnd_scu_probe(struct platform_device *pdev,
 335                    struct rsnd_priv *priv);
 336 void rsnd_scu_remove(struct platform_device *pdev,
 337                      struct rsnd_priv *priv);
 338 struct rsnd_mod *rsnd_scu_mod_get(struct rsnd_priv *priv, int id);
 339 unsigned int rsnd_scu_get_ssi_rate(struct rsnd_priv *priv,
 340                                    struct rsnd_dai_stream *io,
 341                                    struct snd_pcm_runtime *runtime);
 342
 343 #define rsnd_scu_nr(priv) ((priv)->scu_nr)
 344
 345 /*
 346  *      R-Car SSI
 347  */
 348 int rsnd_ssi_probe(struct platform_device *pdev,
 349                    struct rsnd_priv *priv);
 350 void rsnd_ssi_remove(struct platform_device *pdev,
 351                    struct rsnd_priv *priv);
 352 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
 353 struct rsnd_mod *rsnd_ssi_mod_get_frm_dai(struct rsnd_priv *priv,
 354                                           int dai_id, int is_play);
 355 int rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
 356 int rsnd_ssi_is_play(struct rsnd_mod *mod);
 357
 358 #endif