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