sound/soc/sh/rcar/rsnd.h

   1 // SPDX-License-Identifier: GPL-2.0
   2 //
   3 // Renesas R-Car
   4 //
   5 // Copyright (C) 2013 Renesas Solutions Corp.
   6 // Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
   7
   8 #ifndef RSND_H
   9 #define RSND_H
  10
  11 #include <linux/clk.h>
  12 #include <linux/device.h>
  13 #include <linux/dma-mapping.h>
  14 #include <linux/io.h>
  15 #include <linux/list.h>
  16 #include <linux/module.h>
  17 #include <linux/of_device.h>
  18 #include <linux/of_graph.h>
  19 #include <linux/of_irq.h>
  20 #include <linux/sh_dma.h>
  21 #include <linux/workqueue.h>
  22 #include <sound/soc.h>
  23 #include <sound/pcm_params.h>
  24
  25 #define RSND_GEN1_SRU   0
  26 #define RSND_GEN1_ADG   1
  27 #define RSND_GEN1_SSI   2
  28
  29 #define RSND_GEN2_SCU   0
  30 #define RSND_GEN2_ADG   1
  31 #define RSND_GEN2_SSIU  2
  32 #define RSND_GEN2_SSI   3
  33
  34 #define RSND_BASE_MAX   4
  35
  36 /*
  37  *      pseudo register
  38  *
  39  * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
  40  * This driver uses pseudo register in order to hide it.
  41  * see gen1/gen2 for detail
  42  */
  43 enum rsnd_reg {
  44         /* SCU (MIX/CTU/DVC) */
  45         RSND_REG_SRC_I_BUSIF_MODE,
  46         RSND_REG_SRC_O_BUSIF_MODE,
  47         RSND_REG_SRC_ROUTE_MODE0,
  48         RSND_REG_SRC_SWRSR,
  49         RSND_REG_SRC_SRCIR,
  50         RSND_REG_SRC_ADINR,
  51         RSND_REG_SRC_IFSCR,
  52         RSND_REG_SRC_IFSVR,
  53         RSND_REG_SRC_SRCCR,
  54         RSND_REG_SRC_CTRL,
  55         RSND_REG_SRC_BSDSR,
  56         RSND_REG_SRC_BSISR,
  57         RSND_REG_SRC_INT_ENABLE0,
  58         RSND_REG_SRC_BUSIF_DALIGN,
  59         RSND_REG_SRCIN_TIMSEL0,
  60         RSND_REG_SRCIN_TIMSEL1,
  61         RSND_REG_SRCIN_TIMSEL2,
  62         RSND_REG_SRCIN_TIMSEL3,
  63         RSND_REG_SRCIN_TIMSEL4,
  64         RSND_REG_SRCOUT_TIMSEL0,
  65         RSND_REG_SRCOUT_TIMSEL1,
  66         RSND_REG_SRCOUT_TIMSEL2,
  67         RSND_REG_SRCOUT_TIMSEL3,
  68         RSND_REG_SRCOUT_TIMSEL4,
  69         RSND_REG_SCU_SYS_STATUS0,
  70         RSND_REG_SCU_SYS_STATUS1,
  71         RSND_REG_SCU_SYS_INT_EN0,
  72         RSND_REG_SCU_SYS_INT_EN1,
  73         RSND_REG_CMD_CTRL,
  74         RSND_REG_CMD_BUSIF_MODE,
  75         RSND_REG_CMD_BUSIF_DALIGN,
  76         RSND_REG_CMD_ROUTE_SLCT,
  77         RSND_REG_CMDOUT_TIMSEL,
  78         RSND_REG_CTU_SWRSR,
  79         RSND_REG_CTU_CTUIR,
  80         RSND_REG_CTU_ADINR,
  81         RSND_REG_CTU_CPMDR,
  82         RSND_REG_CTU_SCMDR,
  83         RSND_REG_CTU_SV00R,
  84         RSND_REG_CTU_SV01R,
  85         RSND_REG_CTU_SV02R,
  86         RSND_REG_CTU_SV03R,
  87         RSND_REG_CTU_SV04R,
  88         RSND_REG_CTU_SV05R,
  89         RSND_REG_CTU_SV06R,
  90         RSND_REG_CTU_SV07R,
  91         RSND_REG_CTU_SV10R,
  92         RSND_REG_CTU_SV11R,
  93         RSND_REG_CTU_SV12R,
  94         RSND_REG_CTU_SV13R,
  95         RSND_REG_CTU_SV14R,
  96         RSND_REG_CTU_SV15R,
  97         RSND_REG_CTU_SV16R,
  98         RSND_REG_CTU_SV17R,
  99         RSND_REG_CTU_SV20R,
 100         RSND_REG_CTU_SV21R,
 101         RSND_REG_CTU_SV22R,
 102         RSND_REG_CTU_SV23R,
 103         RSND_REG_CTU_SV24R,
 104         RSND_REG_CTU_SV25R,
 105         RSND_REG_CTU_SV26R,
 106         RSND_REG_CTU_SV27R,
 107         RSND_REG_CTU_SV30R,
 108         RSND_REG_CTU_SV31R,
 109         RSND_REG_CTU_SV32R,
 110         RSND_REG_CTU_SV33R,
 111         RSND_REG_CTU_SV34R,
 112         RSND_REG_CTU_SV35R,
 113         RSND_REG_CTU_SV36R,
 114         RSND_REG_CTU_SV37R,
 115         RSND_REG_MIX_SWRSR,
 116         RSND_REG_MIX_MIXIR,
 117         RSND_REG_MIX_ADINR,
 118         RSND_REG_MIX_MIXMR,
 119         RSND_REG_MIX_MVPDR,
 120         RSND_REG_MIX_MDBAR,
 121         RSND_REG_MIX_MDBBR,
 122         RSND_REG_MIX_MDBCR,
 123         RSND_REG_MIX_MDBDR,
 124         RSND_REG_MIX_MDBER,
 125         RSND_REG_DVC_SWRSR,
 126         RSND_REG_DVC_DVUIR,
 127         RSND_REG_DVC_ADINR,
 128         RSND_REG_DVC_DVUCR,
 129         RSND_REG_DVC_ZCMCR,
 130         RSND_REG_DVC_VOL0R,
 131         RSND_REG_DVC_VOL1R,
 132         RSND_REG_DVC_VOL2R,
 133         RSND_REG_DVC_VOL3R,
 134         RSND_REG_DVC_VOL4R,
 135         RSND_REG_DVC_VOL5R,
 136         RSND_REG_DVC_VOL6R,
 137         RSND_REG_DVC_VOL7R,
 138         RSND_REG_DVC_DVUER,
 139         RSND_REG_DVC_VRCTR,
 140         RSND_REG_DVC_VRPDR,
 141         RSND_REG_DVC_VRDBR,
 142
 143         /* ADG */
 144         RSND_REG_BRRA,
 145         RSND_REG_BRRB,
 146         RSND_REG_BRGCKR,
 147         RSND_REG_DIV_EN,
 148         RSND_REG_AUDIO_CLK_SEL0,
 149         RSND_REG_AUDIO_CLK_SEL1,
 150         RSND_REG_AUDIO_CLK_SEL2,
 151
 152         /* SSIU */
 153         RSND_REG_SSI_MODE,
 154         RSND_REG_SSI_MODE0,
 155         RSND_REG_SSI_MODE1,
 156         RSND_REG_SSI_MODE2,
 157         RSND_REG_SSI_CONTROL,
 158         RSND_REG_SSI_CTRL,
 159         RSND_REG_SSI_BUSIF0_MODE,
 160         RSND_REG_SSI_BUSIF0_ADINR,
 161         RSND_REG_SSI_BUSIF0_DALIGN,
 162         RSND_REG_SSI_BUSIF1_MODE,
 163         RSND_REG_SSI_BUSIF1_ADINR,
 164         RSND_REG_SSI_BUSIF1_DALIGN,
 165         RSND_REG_SSI_BUSIF2_MODE,
 166         RSND_REG_SSI_BUSIF2_ADINR,
 167         RSND_REG_SSI_BUSIF2_DALIGN,
 168         RSND_REG_SSI_BUSIF3_MODE,
 169         RSND_REG_SSI_BUSIF3_ADINR,
 170         RSND_REG_SSI_BUSIF3_DALIGN,
 171         RSND_REG_SSI_BUSIF4_MODE,
 172         RSND_REG_SSI_BUSIF4_ADINR,
 173         RSND_REG_SSI_BUSIF4_DALIGN,
 174         RSND_REG_SSI_BUSIF5_MODE,
 175         RSND_REG_SSI_BUSIF5_ADINR,
 176         RSND_REG_SSI_BUSIF5_DALIGN,
 177         RSND_REG_SSI_BUSIF6_MODE,
 178         RSND_REG_SSI_BUSIF6_ADINR,
 179         RSND_REG_SSI_BUSIF6_DALIGN,
 180         RSND_REG_SSI_BUSIF7_MODE,
 181         RSND_REG_SSI_BUSIF7_ADINR,
 182         RSND_REG_SSI_BUSIF7_DALIGN,
 183         RSND_REG_SSI_INT_ENABLE,
 184         RSND_REG_SSI_SYS_STATUS0,
 185         RSND_REG_SSI_SYS_STATUS1,
 186         RSND_REG_SSI_SYS_STATUS2,
 187         RSND_REG_SSI_SYS_STATUS3,
 188         RSND_REG_SSI_SYS_STATUS4,
 189         RSND_REG_SSI_SYS_STATUS5,
 190         RSND_REG_SSI_SYS_STATUS6,
 191         RSND_REG_SSI_SYS_STATUS7,
 192         RSND_REG_HDMI0_SEL,
 193         RSND_REG_HDMI1_SEL,
 194
 195         /* SSI */
 196         RSND_REG_SSICR,
 197         RSND_REG_SSISR,
 198         RSND_REG_SSITDR,
 199         RSND_REG_SSIRDR,
 200         RSND_REG_SSIWSR,
 201
 202         RSND_REG_MAX,
 203 };
 204
 205 struct rsnd_priv;
 206 struct rsnd_mod;
 207 struct rsnd_dai;
 208 struct rsnd_dai_stream;
 209
 210 /*
 211  *      R-Car basic functions
 212  */
 213 #define rsnd_mod_read(m, r) \
 214         rsnd_read(rsnd_mod_to_priv(m), m, RSND_REG_##r)
 215 #define rsnd_mod_write(m, r, d) \
 216         rsnd_write(rsnd_mod_to_priv(m), m, RSND_REG_##r, d)
 217 #define rsnd_mod_bset(m, r, s, d) \
 218         rsnd_bset(rsnd_mod_to_priv(m), m, RSND_REG_##r, s, d)
 219
 220 u32 rsnd_read(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg);
 221 void rsnd_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
 222                 enum rsnd_reg reg, u32 data);
 223 void rsnd_force_write(struct rsnd_priv *priv, struct rsnd_mod *mod,
 224                 enum rsnd_reg reg, u32 data);
 225 void rsnd_bset(struct rsnd_priv *priv, struct rsnd_mod *mod, enum rsnd_reg reg,
 226                     u32 mask, u32 data);
 227 u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
 228 u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
 229 u32 rsnd_get_busif_shift(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
 230
 231 /*
 232  *      R-Car DMA
 233  */
 234 int rsnd_dma_attach(struct rsnd_dai_stream *io,
 235                     struct rsnd_mod *mod, struct rsnd_mod **dma_mod);
 236 int rsnd_dma_probe(struct rsnd_priv *priv);
 237 struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node,
 238                                           struct rsnd_mod *mod, char *name);
 239
 240 /*
 241  *      R-Car sound mod
 242  */
 243 enum rsnd_mod_type {
 244         RSND_MOD_AUDMAPP,
 245         RSND_MOD_AUDMA,
 246         RSND_MOD_DVC,
 247         RSND_MOD_MIX,
 248         RSND_MOD_CTU,
 249         RSND_MOD_CMD,
 250         RSND_MOD_SRC,
 251         RSND_MOD_SSIM3,         /* SSI multi 3 */
 252         RSND_MOD_SSIM2,         /* SSI multi 2 */
 253         RSND_MOD_SSIM1,         /* SSI multi 1 */
 254         RSND_MOD_SSIP,          /* SSI parent */
 255         RSND_MOD_SSI,
 256         RSND_MOD_SSIU,
 257         RSND_MOD_MAX,
 258 };
 259
 260 struct rsnd_mod_ops {
 261         char *name;
 262         struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
 263                                     struct rsnd_mod *mod);
 264         int (*probe)(struct rsnd_mod *mod,
 265                      struct rsnd_dai_stream *io,
 266                      struct rsnd_priv *priv);
 267         int (*remove)(struct rsnd_mod *mod,
 268                       struct rsnd_dai_stream *io,
 269                       struct rsnd_priv *priv);
 270         int (*init)(struct rsnd_mod *mod,
 271                     struct rsnd_dai_stream *io,
 272                     struct rsnd_priv *priv);
 273         int (*quit)(struct rsnd_mod *mod,
 274                     struct rsnd_dai_stream *io,
 275                     struct rsnd_priv *priv);
 276         int (*start)(struct rsnd_mod *mod,
 277                      struct rsnd_dai_stream *io,
 278                      struct rsnd_priv *priv);
 279         int (*stop)(struct rsnd_mod *mod,
 280                     struct rsnd_dai_stream *io,
 281                     struct rsnd_priv *priv);
 282         int (*irq)(struct rsnd_mod *mod,
 283                    struct rsnd_dai_stream *io,
 284                    struct rsnd_priv *priv, int enable);
 285         int (*pcm_new)(struct rsnd_mod *mod,
 286                        struct rsnd_dai_stream *io,
 287                        struct snd_soc_pcm_runtime *rtd);
 288         int (*hw_params)(struct rsnd_mod *mod,
 289                          struct rsnd_dai_stream *io,
 290                          struct snd_pcm_substream *substream,
 291                          struct snd_pcm_hw_params *hw_params);
 292         int (*pointer)(struct rsnd_mod *mod,
 293                        struct rsnd_dai_stream *io,
 294                        snd_pcm_uframes_t *pointer);
 295         int (*fallback)(struct rsnd_mod *mod,
 296                         struct rsnd_dai_stream *io,
 297                         struct rsnd_priv *priv);
 298         int (*nolock_start)(struct rsnd_mod *mod,
 299                     struct rsnd_dai_stream *io,
 300                     struct rsnd_priv *priv);
 301         int (*nolock_stop)(struct rsnd_mod *mod,
 302                     struct rsnd_dai_stream *io,
 303                     struct rsnd_priv *priv);
 304         int (*prepare)(struct rsnd_mod *mod,
 305                        struct rsnd_dai_stream *io,
 306                        struct rsnd_priv *priv);
 307 };
 308
 309 struct rsnd_dai_stream;
 310 struct rsnd_mod {
 311         int id;
 312         enum rsnd_mod_type type;
 313         struct rsnd_mod_ops *ops;
 314         struct rsnd_priv *priv;
 315         struct clk *clk;
 316         u32 *(*get_status)(struct rsnd_dai_stream *io,
 317                            struct rsnd_mod *mod,
 318                            enum rsnd_mod_type type);
 319         u32 status;
 320 };
 321 /*
 322  * status
 323  *
 324  * 0xH0000CBA
 325  *
 326  * A    0: nolock_start 1: nolock_stop
 327  * B    0: init         1: quit
 328  * C    0: start        1: stop
 329  *
 330  * H is always called (see __rsnd_mod_call)
 331  * H    0: probe        1: remove
 332  * H    0: pcm_new
 333  * H    0: fallback
 334  * H    0: hw_params
 335  * H    0: pointer
 336  * H    0: prepare
 337  */
 338 #define __rsnd_mod_shift_nolock_start   0
 339 #define __rsnd_mod_shift_nolock_stop    0
 340 #define __rsnd_mod_shift_init           4
 341 #define __rsnd_mod_shift_quit           4
 342 #define __rsnd_mod_shift_start          8
 343 #define __rsnd_mod_shift_stop           8
 344 #define __rsnd_mod_shift_probe          28 /* always called */
 345 #define __rsnd_mod_shift_remove         28 /* always called */
 346 #define __rsnd_mod_shift_irq            28 /* always called */
 347 #define __rsnd_mod_shift_pcm_new        28 /* always called */
 348 #define __rsnd_mod_shift_fallback       28 /* always called */
 349 #define __rsnd_mod_shift_hw_params      28 /* always called */
 350 #define __rsnd_mod_shift_pointer        28 /* always called */
 351 #define __rsnd_mod_shift_prepare        28 /* always called */
 352
 353 #define __rsnd_mod_add_probe            0
 354 #define __rsnd_mod_add_remove           0
 355 #define __rsnd_mod_add_nolock_start      1
 356 #define __rsnd_mod_add_nolock_stop      -1
 357 #define __rsnd_mod_add_init              1
 358 #define __rsnd_mod_add_quit             -1
 359 #define __rsnd_mod_add_start             1
 360 #define __rsnd_mod_add_stop             -1
 361 #define __rsnd_mod_add_irq              0
 362 #define __rsnd_mod_add_pcm_new          0
 363 #define __rsnd_mod_add_fallback         0
 364 #define __rsnd_mod_add_hw_params        0
 365 #define __rsnd_mod_add_pointer          0
 366 #define __rsnd_mod_add_prepare          0
 367
 368 #define __rsnd_mod_call_probe           0
 369 #define __rsnd_mod_call_remove          0
 370 #define __rsnd_mod_call_init            0
 371 #define __rsnd_mod_call_quit            1
 372 #define __rsnd_mod_call_start           0
 373 #define __rsnd_mod_call_stop            1
 374 #define __rsnd_mod_call_irq             0
 375 #define __rsnd_mod_call_pcm_new         0
 376 #define __rsnd_mod_call_fallback        0
 377 #define __rsnd_mod_call_hw_params       0
 378 #define __rsnd_mod_call_pointer         0
 379 #define __rsnd_mod_call_nolock_start    0
 380 #define __rsnd_mod_call_nolock_stop     1
 381 #define __rsnd_mod_call_prepare         0
 382
 383 #define rsnd_mod_to_priv(mod)   ((mod)->priv)
 384 #define rsnd_mod_name(mod)      ((mod)->ops->name)
 385 #define rsnd_mod_id(mod)        ((mod)->id)
 386 #define rsnd_mod_power_on(mod)  clk_enable((mod)->clk)
 387 #define rsnd_mod_power_off(mod) clk_disable((mod)->clk)
 388 #define rsnd_mod_get(ip)        (&(ip)->mod)
 389
 390 int rsnd_mod_init(struct rsnd_priv *priv,
 391                   struct rsnd_mod *mod,
 392                   struct rsnd_mod_ops *ops,
 393                   struct clk *clk,
 394                   u32* (*get_status)(struct rsnd_dai_stream *io,
 395                                      struct rsnd_mod *mod,
 396                                      enum rsnd_mod_type type),
 397                   enum rsnd_mod_type type,
 398                   int id);
 399 void rsnd_mod_quit(struct rsnd_mod *mod);
 400 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
 401                                   struct rsnd_mod *mod);
 402 void rsnd_mod_interrupt(struct rsnd_mod *mod,
 403                         void (*callback)(struct rsnd_mod *mod,
 404                                          struct rsnd_dai_stream *io));
 405 u32 *rsnd_mod_get_status(struct rsnd_dai_stream *io,
 406                          struct rsnd_mod *mod,
 407                          enum rsnd_mod_type type);
 408 struct rsnd_mod *rsnd_mod_next(int *iterator,
 409                                struct rsnd_dai_stream *io,
 410                                enum rsnd_mod_type *array,
 411                                int array_size);
 412 #define for_each_rsnd_mod(iterator, pos, io)                            \
 413         for (iterator = 0;                                              \
 414              (pos = rsnd_mod_next(&iterator, io, NULL, 0)); iterator++)
 415 #define for_each_rsnd_mod_arrays(iterator, pos, io, array, size)        \
 416         for (iterator = 0;                                              \
 417              (pos = rsnd_mod_next(&iterator, io, array, size)); iterator++)
 418 #define for_each_rsnd_mod_array(iterator, pos, io, array)               \
 419         for_each_rsnd_mod_arrays(iterator, pos, io, array, ARRAY_SIZE(array))
 420
 421 void rsnd_parse_connect_common(struct rsnd_dai *rdai,
 422                 struct rsnd_mod* (*mod_get)(struct rsnd_priv *priv, int id),
 423                 struct device_node *node,
 424                 struct device_node *playback,
 425                 struct device_node *capture);
 426
 427 #define rsnd_runtime_channel_original(io) \
 428         rsnd_runtime_channel_original_with_params(io, NULL)
 429 int rsnd_runtime_channel_original_with_params(struct rsnd_dai_stream *io,
 430                                 struct snd_pcm_hw_params *params);
 431 #define rsnd_runtime_channel_after_ctu(io)                      \
 432         rsnd_runtime_channel_after_ctu_with_params(io, NULL)
 433 int rsnd_runtime_channel_after_ctu_with_params(struct rsnd_dai_stream *io,
 434                                 struct snd_pcm_hw_params *params);
 435 #define rsnd_runtime_channel_for_ssi(io) \
 436         rsnd_runtime_channel_for_ssi_with_params(io, NULL)
 437 int rsnd_runtime_channel_for_ssi_with_params(struct rsnd_dai_stream *io,
 438                                  struct snd_pcm_hw_params *params);
 439 int rsnd_runtime_is_ssi_multi(struct rsnd_dai_stream *io);
 440 int rsnd_runtime_is_ssi_tdm(struct rsnd_dai_stream *io);
 441
 442 /*
 443  * DT
 444  */
 445 #define rsnd_parse_of_node(priv, node)                                  \
 446         of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, node)
 447 #define RSND_NODE_DAI   "rcar_sound,dai"
 448 #define RSND_NODE_SSI   "rcar_sound,ssi"
 449 #define RSND_NODE_SRC   "rcar_sound,src"
 450 #define RSND_NODE_CTU   "rcar_sound,ctu"
 451 #define RSND_NODE_MIX   "rcar_sound,mix"
 452 #define RSND_NODE_DVC   "rcar_sound,dvc"
 453
 454 /*
 455  *      R-Car sound DAI
 456  */
 457 #define RSND_DAI_NAME_SIZE      16
 458 struct rsnd_dai_stream {
 459         char name[RSND_DAI_NAME_SIZE];
 460         struct snd_pcm_substream *substream;
 461         struct rsnd_mod *mod[RSND_MOD_MAX];
 462         struct rsnd_mod *dma;
 463         struct rsnd_dai *rdai;
 464         struct device *dmac_dev; /* for IPMMU */
 465         u32 parent_ssi_status;
 466 };
 467 #define rsnd_io_to_mod(io, i)   ((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
 468 #define rsnd_io_to_mod_ssi(io)  rsnd_io_to_mod((io), RSND_MOD_SSI)
 469 #define rsnd_io_to_mod_ssiu(io) rsnd_io_to_mod((io), RSND_MOD_SSIU)
 470 #define rsnd_io_to_mod_ssip(io) rsnd_io_to_mod((io), RSND_MOD_SSIP)
 471 #define rsnd_io_to_mod_src(io)  rsnd_io_to_mod((io), RSND_MOD_SRC)
 472 #define rsnd_io_to_mod_ctu(io)  rsnd_io_to_mod((io), RSND_MOD_CTU)
 473 #define rsnd_io_to_mod_mix(io)  rsnd_io_to_mod((io), RSND_MOD_MIX)
 474 #define rsnd_io_to_mod_dvc(io)  rsnd_io_to_mod((io), RSND_MOD_DVC)
 475 #define rsnd_io_to_mod_cmd(io)  rsnd_io_to_mod((io), RSND_MOD_CMD)
 476 #define rsnd_io_to_rdai(io)     ((io)->rdai)
 477 #define rsnd_io_to_priv(io)     (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
 478 #define rsnd_io_is_play(io)     (&rsnd_io_to_rdai(io)->playback == io)
 479 #define rsnd_io_to_runtime(io) ((io)->substream ? \
 480                                 (io)->substream->runtime : NULL)
 481 int rsnd_io_is_working(struct rsnd_dai_stream *io);
 482
 483 struct rsnd_dai {
 484         char name[RSND_DAI_NAME_SIZE];
 485         struct rsnd_dai_stream playback;
 486         struct rsnd_dai_stream capture;
 487         struct rsnd_priv *priv;
 488         struct snd_pcm_hw_constraint_list constraint;
 489
 490         int max_channels;       /* 2ch - 16ch */
 491         int ssi_lane;           /* 1lane - 4lane */
 492         int chan_width;         /* 16/24/32 bit width */
 493
 494         unsigned int clk_master:1;
 495         unsigned int bit_clk_inv:1;
 496         unsigned int frm_clk_inv:1;
 497         unsigned int sys_delay:1;
 498         unsigned int data_alignment:1;
 499 };
 500
 501 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
 502 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
 503 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
 504 #define for_each_rsnd_dai(rdai, priv, i)                \
 505         for (i = 0;                                     \
 506              (i < rsnd_rdai_nr(priv)) &&                \
 507              ((rdai) = rsnd_rdai_get(priv, i));         \
 508              i++)
 509
 510 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
 511
 512 #define rsnd_rdai_channels_set(rdai, max_channels) \
 513         rsnd_rdai_channels_ctrl(rdai, max_channels)
 514 #define rsnd_rdai_channels_get(rdai) \
 515         rsnd_rdai_channels_ctrl(rdai, 0)
 516 int rsnd_rdai_channels_ctrl(struct rsnd_dai *rdai,
 517                             int max_channels);
 518
 519 #define rsnd_rdai_ssi_lane_set(rdai, ssi_lane) \
 520         rsnd_rdai_ssi_lane_ctrl(rdai, ssi_lane)
 521 #define rsnd_rdai_ssi_lane_get(rdai) \
 522         rsnd_rdai_ssi_lane_ctrl(rdai, 0)
 523 int rsnd_rdai_ssi_lane_ctrl(struct rsnd_dai *rdai,
 524                             int ssi_lane);
 525
 526 #define rsnd_rdai_width_set(rdai, width) \
 527         rsnd_rdai_width_ctrl(rdai, width)
 528 #define rsnd_rdai_width_get(rdai) \
 529         rsnd_rdai_width_ctrl(rdai, 0)
 530 int rsnd_rdai_width_ctrl(struct rsnd_dai *rdai, int width);
 531 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
 532 int rsnd_dai_connect(struct rsnd_mod *mod,
 533                      struct rsnd_dai_stream *io,
 534                      enum rsnd_mod_type type);
 535
 536 /*
 537  *      R-Car Gen1/Gen2
 538  */
 539 int rsnd_gen_probe(struct rsnd_priv *priv);
 540 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
 541                                struct rsnd_mod *mod,
 542                                enum rsnd_reg reg);
 543 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
 544
 545 /*
 546  *      R-Car ADG
 547  */
 548 int rsnd_adg_clk_query(struct rsnd_priv *priv, unsigned int rate);
 549 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
 550 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
 551 int rsnd_adg_probe(struct rsnd_priv *priv);
 552 void rsnd_adg_remove(struct rsnd_priv *priv);
 553 int rsnd_adg_set_src_timesel_gen2(struct rsnd_mod *src_mod,
 554                                   struct rsnd_dai_stream *io,
 555                                   unsigned int in_rate,
 556                                   unsigned int out_rate);
 557 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
 558                                  struct rsnd_dai_stream *io);
 559 #define rsnd_adg_clk_enable(priv)       rsnd_adg_clk_control(priv, 1)
 560 #define rsnd_adg_clk_disable(priv)      rsnd_adg_clk_control(priv, 0)
 561 void rsnd_adg_clk_control(struct rsnd_priv *priv, int enable);
 562
 563 /*
 564  *      R-Car sound priv
 565  */
 566 struct rsnd_priv {
 567
 568         struct platform_device *pdev;
 569         spinlock_t lock;
 570         unsigned long flags;
 571 #define RSND_GEN_MASK   (0xF << 0)
 572 #define RSND_GEN1       (1 << 0)
 573 #define RSND_GEN2       (2 << 0)
 574 #define RSND_GEN3       (3 << 0)
 575
 576         /*
 577          * below value will be filled on rsnd_gen_probe()
 578          */
 579         void *gen;
 580
 581         /*
 582          * below value will be filled on rsnd_adg_probe()
 583          */
 584         void *adg;
 585
 586         /*
 587          * below value will be filled on rsnd_dma_probe()
 588          */
 589         void *dma;
 590
 591         /*
 592          * below value will be filled on rsnd_ssi_probe()
 593          */
 594         void *ssi;
 595         int ssi_nr;
 596
 597         /*
 598          * below value will be filled on rsnd_ssiu_probe()
 599          */
 600         void *ssiu;
 601         int ssiu_nr;
 602
 603         /*
 604          * below value will be filled on rsnd_src_probe()
 605          */
 606         void *src;
 607         int src_nr;
 608
 609         /*
 610          * below value will be filled on rsnd_ctu_probe()
 611          */
 612         void *ctu;
 613         int ctu_nr;
 614
 615         /*
 616          * below value will be filled on rsnd_mix_probe()
 617          */
 618         void *mix;
 619         int mix_nr;
 620
 621         /*
 622          * below value will be filled on rsnd_dvc_probe()
 623          */
 624         void *dvc;
 625         int dvc_nr;
 626
 627         /*
 628          * below value will be filled on rsnd_cmd_probe()
 629          */
 630         void *cmd;
 631         int cmd_nr;
 632
 633         /*
 634          * below value will be filled on rsnd_dai_probe()
 635          */
 636         struct snd_soc_dai_driver *daidrv;
 637         struct rsnd_dai *rdai;
 638         int rdai_nr;
 639 };
 640
 641 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
 642 #define rsnd_priv_to_dev(priv)  (&(rsnd_priv_to_pdev(priv)->dev))
 643
 644 #define rsnd_is_gen1(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
 645 #define rsnd_is_gen2(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
 646 #define rsnd_is_gen3(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN3)
 647
 648 #define rsnd_flags_has(p, f) ((p)->flags & (f))
 649 #define rsnd_flags_set(p, f) ((p)->flags |= (f))
 650 #define rsnd_flags_del(p, f) ((p)->flags &= ~(f))
 651
 652 /*
 653  *      rsnd_kctrl
 654  */
 655 struct rsnd_kctrl_cfg {
 656         unsigned int max;
 657         unsigned int size;
 658         u32 *val;
 659         const char * const *texts;
 660         int (*accept)(struct rsnd_dai_stream *io);
 661         void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
 662         struct rsnd_dai_stream *io;
 663         struct snd_card *card;
 664         struct snd_kcontrol *kctrl;
 665         struct rsnd_mod *mod;
 666 };
 667
 668 #define RSND_MAX_CHANNELS       8
 669 struct rsnd_kctrl_cfg_m {
 670         struct rsnd_kctrl_cfg cfg;
 671         u32 val[RSND_MAX_CHANNELS];
 672 };
 673
 674 struct rsnd_kctrl_cfg_s {
 675         struct rsnd_kctrl_cfg cfg;
 676         u32 val;
 677 };
 678 #define rsnd_kctrl_size(x)      ((x).cfg.size)
 679 #define rsnd_kctrl_max(x)       ((x).cfg.max)
 680 #define rsnd_kctrl_valm(x, i)   ((x).val[i])    /* = (x).cfg.val[i] */
 681 #define rsnd_kctrl_vals(x)      ((x).val)       /* = (x).cfg.val[0] */
 682
 683 int rsnd_kctrl_accept_anytime(struct rsnd_dai_stream *io);
 684 int rsnd_kctrl_accept_runtime(struct rsnd_dai_stream *io);
 685 struct rsnd_kctrl_cfg *rsnd_kctrl_init_m(struct rsnd_kctrl_cfg_m *cfg);
 686 struct rsnd_kctrl_cfg *rsnd_kctrl_init_s(struct rsnd_kctrl_cfg_s *cfg);
 687 int rsnd_kctrl_new(struct rsnd_mod *mod,
 688                    struct rsnd_dai_stream *io,
 689                    struct snd_soc_pcm_runtime *rtd,
 690                    const unsigned char *name,
 691                    int (*accept)(struct rsnd_dai_stream *io),
 692                    void (*update)(struct rsnd_dai_stream *io,
 693                                   struct rsnd_mod *mod),
 694                    struct rsnd_kctrl_cfg *cfg,
 695                    const char * const *texts,
 696                    int size,
 697                    u32 max);
 698
 699 #define rsnd_kctrl_new_m(mod, io, rtd, name, accept, update, cfg, size, max) \
 700         rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_m(cfg), \
 701                        NULL, size, max)
 702
 703 #define rsnd_kctrl_new_s(mod, io, rtd, name, accept, update, cfg, max)  \
 704         rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
 705                        NULL, 1, max)
 706
 707 #define rsnd_kctrl_new_e(mod, io, rtd, name, accept, update, cfg, texts, size) \
 708         rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
 709                        texts, 1, size)
 710
 711 extern const char * const volume_ramp_rate[];
 712 #define VOLUME_RAMP_MAX_DVC     (0x17 + 1)
 713 #define VOLUME_RAMP_MAX_MIX     (0x0a + 1)
 714
 715 /*
 716  *      R-Car SSI
 717  */
 718 int rsnd_ssi_probe(struct rsnd_priv *priv);
 719 void rsnd_ssi_remove(struct rsnd_priv *priv);
 720 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
 721 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
 722 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
 723 int rsnd_ssi_get_busif(struct rsnd_dai_stream *io);
 724 u32 rsnd_ssi_multi_slaves_runtime(struct rsnd_dai_stream *io);
 725
 726 #define RSND_SSI_HDMI_PORT0     0xf0
 727 #define RSND_SSI_HDMI_PORT1     0xf1
 728 int rsnd_ssi_hdmi_port(struct rsnd_dai_stream *io);
 729 void rsnd_ssi_parse_hdmi_connection(struct rsnd_priv *priv,
 730                                     struct device_node *endpoint,
 731                                     int dai_i);
 732
 733 #define rsnd_ssi_is_pin_sharing(io)     \
 734         __rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
 735 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
 736
 737 #define rsnd_ssi_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSI)
 738 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
 739                             struct device_node *playback,
 740                             struct device_node *capture);
 741 unsigned int rsnd_ssi_clk_query(struct rsnd_dai *rdai,
 742                        int param1, int param2, int *idx);
 743
 744 /*
 745  *      R-Car SSIU
 746  */
 747 int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
 748                      struct rsnd_mod *mod);
 749 int rsnd_ssiu_probe(struct rsnd_priv *priv);
 750 void rsnd_ssiu_remove(struct rsnd_priv *priv);
 751
 752 /*
 753  *      R-Car SRC
 754  */
 755 int rsnd_src_probe(struct rsnd_priv *priv);
 756 void rsnd_src_remove(struct rsnd_priv *priv);
 757 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
 758
 759 #define rsnd_src_get_in_rate(priv, io) rsnd_src_get_rate(priv, io, 1)
 760 #define rsnd_src_get_out_rate(priv, io) rsnd_src_get_rate(priv, io, 0)
 761 unsigned int rsnd_src_get_rate(struct rsnd_priv *priv,
 762                                struct rsnd_dai_stream *io,
 763                                int is_in);
 764
 765 #define rsnd_src_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SRC)
 766 #define rsnd_parse_connect_src(rdai, playback, capture)                 \
 767         rsnd_parse_connect_common(rdai, rsnd_src_mod_get,               \
 768                                   rsnd_src_of_node(rsnd_rdai_to_priv(rdai)), \
 769                                                    playback, capture)
 770
 771 /*
 772  *      R-Car CTU
 773  */
 774 int rsnd_ctu_probe(struct rsnd_priv *priv);
 775 void rsnd_ctu_remove(struct rsnd_priv *priv);
 776 int rsnd_ctu_converted_channel(struct rsnd_mod *mod);
 777 struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
 778 #define rsnd_ctu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_CTU)
 779 #define rsnd_parse_connect_ctu(rdai, playback, capture)                 \
 780         rsnd_parse_connect_common(rdai, rsnd_ctu_mod_get,               \
 781                                   rsnd_ctu_of_node(rsnd_rdai_to_priv(rdai)), \
 782                                                    playback, capture)
 783
 784 /*
 785  *      R-Car MIX
 786  */
 787 int rsnd_mix_probe(struct rsnd_priv *priv);
 788 void rsnd_mix_remove(struct rsnd_priv *priv);
 789 struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
 790 #define rsnd_mix_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_MIX)
 791 #define rsnd_parse_connect_mix(rdai, playback, capture)                 \
 792         rsnd_parse_connect_common(rdai, rsnd_mix_mod_get,               \
 793                                   rsnd_mix_of_node(rsnd_rdai_to_priv(rdai)), \
 794                                                    playback, capture)
 795
 796 /*
 797  *      R-Car DVC
 798  */
 799 int rsnd_dvc_probe(struct rsnd_priv *priv);
 800 void rsnd_dvc_remove(struct rsnd_priv *priv);
 801 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
 802 #define rsnd_dvc_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_DVC)
 803 #define rsnd_parse_connect_dvc(rdai, playback, capture)                 \
 804         rsnd_parse_connect_common(rdai, rsnd_dvc_mod_get,               \
 805                                   rsnd_dvc_of_node(rsnd_rdai_to_priv(rdai)), \
 806                                                    playback, capture)
 807
 808 /*
 809  *      R-Car CMD
 810  */
 811 int rsnd_cmd_probe(struct rsnd_priv *priv);
 812 void rsnd_cmd_remove(struct rsnd_priv *priv);
 813 int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
 814
 815 void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
 816 #ifdef DEBUG
 817 #define rsnd_mod_confirm_ssi(mssi)      rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
 818 #define rsnd_mod_confirm_src(msrc)      rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
 819 #define rsnd_mod_confirm_dvc(mdvc)      rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
 820 #else
 821 #define rsnd_mod_confirm_ssi(mssi)
 822 #define rsnd_mod_confirm_src(msrc)
 823 #define rsnd_mod_confirm_dvc(mdvc)
 824 #endif
 825
 826 /*
 827  * If you don't need interrupt status debug message,
 828  * define RSND_DEBUG_NO_IRQ_STATUS as 1 on top of src.c/ssi.c
 829  *
 830  * #define RSND_DEBUG_NO_IRQ_STATUS 1
 831  */
 832 #define rsnd_dbg_irq_status(dev, param...)              \
 833         if (!IS_BUILTIN(RSND_DEBUG_NO_IRQ_STATUS))      \
 834                 dev_dbg(dev, param)
 835
 836 /*
 837  * If you don't need rsnd_dai_call debug message,
 838  * define RSND_DEBUG_NO_DAI_CALL as 1 on top of core.c
 839  *
 840  * #define RSND_DEBUG_NO_DAI_CALL 1
 841  */
 842 #define rsnd_dbg_dai_call(dev, param...)                \
 843         if (!IS_BUILTIN(RSND_DEBUG_NO_DAI_CALL))        \
 844                 dev_dbg(dev, param)
 845
 846 #endif