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.h>
  18 #include <linux/sh_dma.h>
  19 #include <linux/workqueue.h>
  20 #include <sound/soc.h>
  21 #include <sound/pcm_params.h>
  22
  23 #define RSND_GEN1_SRU   0
  24 #define RSND_GEN1_ADG   1
  25 #define RSND_GEN1_SSI   2
  26
  27 #define RSND_GEN2_SCU   0
  28 #define RSND_GEN2_ADG   1
  29 #define RSND_GEN2_SSIU  2
  30 #define RSND_GEN2_SSI   3
  31
  32 #define RSND_GEN4_ADG   0
  33 #define RSND_GEN4_SSIU  1
  34 #define RSND_GEN4_SSI   2
  35 #define RSND_GEN4_SDMC  3
  36
  37 #define RSND_BASE_MAX   4
  38
  39 /*
  40  *      pseudo register
  41  *
  42  * The register address offsets SRU/SCU/SSIU on Gen1/Gen2 are very different.
  43  * This driver uses pseudo register in order to hide it.
  44  * see gen1/gen2 for detail
  45  */
  46 enum rsnd_reg {
  47         /* SCU (MIX/CTU/DVC) */
  48         SRC_I_BUSIF_MODE,
  49         SRC_O_BUSIF_MODE,
  50         SRC_ROUTE_MODE0,
  51         SRC_SWRSR,
  52         SRC_SRCIR,
  53         SRC_ADINR,
  54         SRC_IFSCR,
  55         SRC_IFSVR,
  56         SRC_SRCCR,
  57         SRC_CTRL,
  58         SRC_BSDSR,
  59         SRC_BSISR,
  60         SRC_INT_ENABLE0,
  61         SRC_BUSIF_DALIGN,
  62         SRCIN_TIMSEL0,
  63         SRCIN_TIMSEL1,
  64         SRCIN_TIMSEL2,
  65         SRCIN_TIMSEL3,
  66         SRCIN_TIMSEL4,
  67         SRCOUT_TIMSEL0,
  68         SRCOUT_TIMSEL1,
  69         SRCOUT_TIMSEL2,
  70         SRCOUT_TIMSEL3,
  71         SRCOUT_TIMSEL4,
  72         SCU_SYS_STATUS0,
  73         SCU_SYS_STATUS1,
  74         SCU_SYS_INT_EN0,
  75         SCU_SYS_INT_EN1,
  76         CMD_CTRL,
  77         CMD_BUSIF_MODE,
  78         CMD_BUSIF_DALIGN,
  79         CMD_ROUTE_SLCT,
  80         CMDOUT_TIMSEL,
  81         CTU_SWRSR,
  82         CTU_CTUIR,
  83         CTU_ADINR,
  84         CTU_CPMDR,
  85         CTU_SCMDR,
  86         CTU_SV00R,
  87         CTU_SV01R,
  88         CTU_SV02R,
  89         CTU_SV03R,
  90         CTU_SV04R,
  91         CTU_SV05R,
  92         CTU_SV06R,
  93         CTU_SV07R,
  94         CTU_SV10R,
  95         CTU_SV11R,
  96         CTU_SV12R,
  97         CTU_SV13R,
  98         CTU_SV14R,
  99         CTU_SV15R,
 100         CTU_SV16R,
 101         CTU_SV17R,
 102         CTU_SV20R,
 103         CTU_SV21R,
 104         CTU_SV22R,
 105         CTU_SV23R,
 106         CTU_SV24R,
 107         CTU_SV25R,
 108         CTU_SV26R,
 109         CTU_SV27R,
 110         CTU_SV30R,
 111         CTU_SV31R,
 112         CTU_SV32R,
 113         CTU_SV33R,
 114         CTU_SV34R,
 115         CTU_SV35R,
 116         CTU_SV36R,
 117         CTU_SV37R,
 118         MIX_SWRSR,
 119         MIX_MIXIR,
 120         MIX_ADINR,
 121         MIX_MIXMR,
 122         MIX_MVPDR,
 123         MIX_MDBAR,
 124         MIX_MDBBR,
 125         MIX_MDBCR,
 126         MIX_MDBDR,
 127         MIX_MDBER,
 128         DVC_SWRSR,
 129         DVC_DVUIR,
 130         DVC_ADINR,
 131         DVC_DVUCR,
 132         DVC_ZCMCR,
 133         DVC_VOL0R,
 134         DVC_VOL1R,
 135         DVC_VOL2R,
 136         DVC_VOL3R,
 137         DVC_VOL4R,
 138         DVC_VOL5R,
 139         DVC_VOL6R,
 140         DVC_VOL7R,
 141         DVC_DVUER,
 142         DVC_VRCTR,
 143         DVC_VRPDR,
 144         DVC_VRDBR,
 145
 146         /* ADG */
 147         BRRA,
 148         BRRB,
 149         BRGCKR,
 150         DIV_EN,
 151         AUDIO_CLK_SEL0,
 152         AUDIO_CLK_SEL1,
 153         AUDIO_CLK_SEL2,
 154
 155         /* SSIU */
 156         SSI_MODE,
 157         SSI_MODE0,
 158         SSI_MODE1,
 159         SSI_MODE2,
 160         SSI_CONTROL,
 161         SSI_CTRL,
 162         SSI_BUSIF0_MODE,
 163         SSI_BUSIF1_MODE,
 164         SSI_BUSIF2_MODE,
 165         SSI_BUSIF3_MODE,
 166         SSI_BUSIF4_MODE,
 167         SSI_BUSIF5_MODE,
 168         SSI_BUSIF6_MODE,
 169         SSI_BUSIF7_MODE,
 170         SSI_BUSIF0_ADINR,
 171         SSI_BUSIF1_ADINR,
 172         SSI_BUSIF2_ADINR,
 173         SSI_BUSIF3_ADINR,
 174         SSI_BUSIF4_ADINR,
 175         SSI_BUSIF5_ADINR,
 176         SSI_BUSIF6_ADINR,
 177         SSI_BUSIF7_ADINR,
 178         SSI_BUSIF0_DALIGN,
 179         SSI_BUSIF1_DALIGN,
 180         SSI_BUSIF2_DALIGN,
 181         SSI_BUSIF3_DALIGN,
 182         SSI_BUSIF4_DALIGN,
 183         SSI_BUSIF5_DALIGN,
 184         SSI_BUSIF6_DALIGN,
 185         SSI_BUSIF7_DALIGN,
 186         SSI_INT_ENABLE,
 187         SSI_SYS_STATUS0,
 188         SSI_SYS_STATUS1,
 189         SSI_SYS_STATUS2,
 190         SSI_SYS_STATUS3,
 191         SSI_SYS_STATUS4,
 192         SSI_SYS_STATUS5,
 193         SSI_SYS_STATUS6,
 194         SSI_SYS_STATUS7,
 195         SSI_SYS_INT_ENABLE0,
 196         SSI_SYS_INT_ENABLE1,
 197         SSI_SYS_INT_ENABLE2,
 198         SSI_SYS_INT_ENABLE3,
 199         SSI_SYS_INT_ENABLE4,
 200         SSI_SYS_INT_ENABLE5,
 201         SSI_SYS_INT_ENABLE6,
 202         SSI_SYS_INT_ENABLE7,
 203         SSI_BUSIF,
 204         HDMI0_SEL,
 205         HDMI1_SEL,
 206         SSI9_BUSIF0_MODE,
 207         SSI9_BUSIF1_MODE,
 208         SSI9_BUSIF2_MODE,
 209         SSI9_BUSIF3_MODE,
 210         SSI9_BUSIF4_MODE,
 211         SSI9_BUSIF5_MODE,
 212         SSI9_BUSIF6_MODE,
 213         SSI9_BUSIF7_MODE,
 214         SSI9_BUSIF0_ADINR,
 215         SSI9_BUSIF1_ADINR,
 216         SSI9_BUSIF2_ADINR,
 217         SSI9_BUSIF3_ADINR,
 218         SSI9_BUSIF4_ADINR,
 219         SSI9_BUSIF5_ADINR,
 220         SSI9_BUSIF6_ADINR,
 221         SSI9_BUSIF7_ADINR,
 222         SSI9_BUSIF0_DALIGN,
 223         SSI9_BUSIF1_DALIGN,
 224         SSI9_BUSIF2_DALIGN,
 225         SSI9_BUSIF3_DALIGN,
 226         SSI9_BUSIF4_DALIGN,
 227         SSI9_BUSIF5_DALIGN,
 228         SSI9_BUSIF6_DALIGN,
 229         SSI9_BUSIF7_DALIGN,
 230
 231         /* SSI */
 232         SSICR,
 233         SSISR,
 234         SSITDR,
 235         SSIRDR,
 236         SSIWSR,
 237
 238         REG_MAX,
 239 };
 240 #define SRCIN_TIMSEL(i)         (SRCIN_TIMSEL0 + (i))
 241 #define SRCOUT_TIMSEL(i)        (SRCOUT_TIMSEL0 + (i))
 242 #define CTU_SVxxR(i, j)         (CTU_SV00R + (i * 8) + (j))
 243 #define DVC_VOLxR(i)            (DVC_VOL0R + (i))
 244 #define AUDIO_CLK_SEL(i)        (AUDIO_CLK_SEL0 + (i))
 245 #define SSI_BUSIF_MODE(i)       (SSI_BUSIF0_MODE + (i))
 246 #define SSI_BUSIF_ADINR(i)      (SSI_BUSIF0_ADINR + (i))
 247 #define SSI_BUSIF_DALIGN(i)     (SSI_BUSIF0_DALIGN + (i))
 248 #define SSI9_BUSIF_MODE(i)      (SSI9_BUSIF0_MODE + (i))
 249 #define SSI9_BUSIF_ADINR(i)     (SSI9_BUSIF0_ADINR + (i))
 250 #define SSI9_BUSIF_DALIGN(i)    (SSI9_BUSIF0_DALIGN + (i))
 251 #define SSI_SYS_STATUS(i)       (SSI_SYS_STATUS0 + (i))
 252 #define SSI_SYS_INT_ENABLE(i) (SSI_SYS_INT_ENABLE0 + (i))
 253
 254
 255 struct rsnd_priv;
 256 struct rsnd_mod;
 257 struct rsnd_dai;
 258 struct rsnd_dai_stream;
 259
 260 /*
 261  *      R-Car basic functions
 262  */
 263 u32 rsnd_mod_read(struct rsnd_mod *mod, enum rsnd_reg reg);
 264 void rsnd_mod_write(struct rsnd_mod *mod, enum rsnd_reg reg, u32 data);
 265 void rsnd_mod_bset(struct rsnd_mod *mod, enum rsnd_reg reg, u32 mask, u32 data);
 266 u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
 267 u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
 268 u32 rsnd_get_busif_shift(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
 269
 270 /*
 271  *      R-Car DMA
 272  */
 273 int rsnd_dma_attach(struct rsnd_dai_stream *io,
 274                     struct rsnd_mod *mod, struct rsnd_mod **dma_mod);
 275 int rsnd_dma_probe(struct rsnd_priv *priv);
 276 struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node, char *name,
 277                                           struct rsnd_mod *mod, char *x);
 278
 279 /*
 280  *      R-Car sound mod
 281  */
 282 enum rsnd_mod_type {
 283         RSND_MOD_AUDMAPP,
 284         RSND_MOD_AUDMA,
 285         RSND_MOD_DVC,
 286         RSND_MOD_MIX,
 287         RSND_MOD_CTU,
 288         RSND_MOD_CMD,
 289         RSND_MOD_SRC,
 290         RSND_MOD_SSIM3,         /* SSI multi 3 */
 291         RSND_MOD_SSIM2,         /* SSI multi 2 */
 292         RSND_MOD_SSIM1,         /* SSI multi 1 */
 293         RSND_MOD_SSIP,          /* SSI parent */
 294         RSND_MOD_SSI,
 295         RSND_MOD_SSIU,
 296         RSND_MOD_MAX,
 297 };
 298
 299 struct rsnd_mod_ops {
 300         char *name;
 301         struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
 302                                     struct rsnd_mod *mod);
 303         int (*probe)(struct rsnd_mod *mod,
 304                      struct rsnd_dai_stream *io,
 305                      struct rsnd_priv *priv);
 306         int (*remove)(struct rsnd_mod *mod,
 307                       struct rsnd_dai_stream *io,
 308                       struct rsnd_priv *priv);
 309         int (*init)(struct rsnd_mod *mod,
 310                     struct rsnd_dai_stream *io,
 311                     struct rsnd_priv *priv);
 312         int (*quit)(struct rsnd_mod *mod,
 313                     struct rsnd_dai_stream *io,
 314                     struct rsnd_priv *priv);
 315         int (*start)(struct rsnd_mod *mod,
 316                      struct rsnd_dai_stream *io,
 317                      struct rsnd_priv *priv);
 318         int (*stop)(struct rsnd_mod *mod,
 319                     struct rsnd_dai_stream *io,
 320                     struct rsnd_priv *priv);
 321         int (*irq)(struct rsnd_mod *mod,
 322                    struct rsnd_dai_stream *io,
 323                    struct rsnd_priv *priv, int enable);
 324         int (*pcm_new)(struct rsnd_mod *mod,
 325                        struct rsnd_dai_stream *io,
 326                        struct snd_soc_pcm_runtime *rtd);
 327         int (*hw_params)(struct rsnd_mod *mod,
 328                          struct rsnd_dai_stream *io,
 329                          struct snd_pcm_substream *substream,
 330                          struct snd_pcm_hw_params *hw_params);
 331         int (*pointer)(struct rsnd_mod *mod,
 332                        struct rsnd_dai_stream *io,
 333                        snd_pcm_uframes_t *pointer);
 334         int (*fallback)(struct rsnd_mod *mod,
 335                         struct rsnd_dai_stream *io,
 336                         struct rsnd_priv *priv);
 337         int (*prepare)(struct rsnd_mod *mod,
 338                        struct rsnd_dai_stream *io,
 339                        struct rsnd_priv *priv);
 340         int (*cleanup)(struct rsnd_mod *mod,
 341                        struct rsnd_dai_stream *io,
 342                        struct rsnd_priv *priv);
 343         int (*hw_free)(struct rsnd_mod *mod,
 344                        struct rsnd_dai_stream *io,
 345                        struct snd_pcm_substream *substream);
 346         u32 *(*get_status)(struct rsnd_mod *mod,
 347                            struct rsnd_dai_stream *io,
 348                            enum rsnd_mod_type type);
 349         int (*id)(struct rsnd_mod *mod);
 350         int (*id_sub)(struct rsnd_mod *mod);
 351         int (*id_cmd)(struct rsnd_mod *mod);
 352
 353 #ifdef CONFIG_DEBUG_FS
 354         void (*debug_info)(struct seq_file *m,
 355                            struct rsnd_dai_stream *io, struct rsnd_mod *mod);
 356 #endif
 357 };
 358
 359 struct rsnd_dai_stream;
 360 struct rsnd_mod {
 361         int id;
 362         enum rsnd_mod_type type;
 363         struct rsnd_mod_ops *ops;
 364         struct rsnd_priv *priv;
 365         struct clk *clk;
 366         u32 status;
 367 };
 368 /*
 369  * status
 370  *
 371  * 0xH000DCB0
 372  *
 373  * B    0: init         1: quit
 374  * C    0: start        1: stop
 375  * D    0: hw_params    1: hw_free
 376  *
 377  * H is always called (see __rsnd_mod_call)
 378  */
 379 #define __rsnd_mod_shift_init           4
 380 #define __rsnd_mod_shift_quit           4
 381 #define __rsnd_mod_shift_start          8
 382 #define __rsnd_mod_shift_stop           8
 383 #define __rsnd_mod_shift_hw_params      12
 384 #define __rsnd_mod_shift_hw_free        12
 385 #define __rsnd_mod_shift_probe          28 /* always called */
 386 #define __rsnd_mod_shift_remove         28 /* always called */
 387 #define __rsnd_mod_shift_irq            28 /* always called */
 388 #define __rsnd_mod_shift_pcm_new        28 /* always called */
 389 #define __rsnd_mod_shift_fallback       28 /* always called */
 390 #define __rsnd_mod_shift_pointer        28 /* always called */
 391 #define __rsnd_mod_shift_prepare        28 /* always called */
 392 #define __rsnd_mod_shift_cleanup        28 /* always called */
 393
 394 #define __rsnd_mod_add_probe            0
 395 #define __rsnd_mod_add_remove           0
 396 #define __rsnd_mod_add_prepare          0
 397 #define __rsnd_mod_add_cleanup          0
 398 #define __rsnd_mod_add_init              1 /* needs protect */
 399 #define __rsnd_mod_add_quit             -1 /* needs protect */
 400 #define __rsnd_mod_add_start             1 /* needs protect */
 401 #define __rsnd_mod_add_stop             -1 /* needs protect */
 402 #define __rsnd_mod_add_hw_params         1 /* needs protect */
 403 #define __rsnd_mod_add_hw_free          -1 /* needs protect */
 404 #define __rsnd_mod_add_irq              0
 405 #define __rsnd_mod_add_pcm_new          0
 406 #define __rsnd_mod_add_fallback         0
 407 #define __rsnd_mod_add_pointer          0
 408
 409 #define __rsnd_mod_call_probe           0
 410 #define __rsnd_mod_call_remove          0
 411 #define __rsnd_mod_call_prepare         0
 412 #define __rsnd_mod_call_cleanup         0
 413 #define __rsnd_mod_call_init            0 /* needs protect */
 414 #define __rsnd_mod_call_quit            1 /* needs protect */
 415 #define __rsnd_mod_call_start           0 /* needs protect */
 416 #define __rsnd_mod_call_stop            1 /* needs protect */
 417 #define __rsnd_mod_call_hw_params       0 /* needs protect */
 418 #define __rsnd_mod_call_hw_free         1 /* needs protect */
 419 #define __rsnd_mod_call_irq             0
 420 #define __rsnd_mod_call_pcm_new         0
 421 #define __rsnd_mod_call_fallback        0
 422 #define __rsnd_mod_call_pointer         0
 423
 424 #define rsnd_mod_to_priv(mod)   ((mod)->priv)
 425 #define rsnd_mod_power_on(mod)  clk_enable((mod)->clk)
 426 #define rsnd_mod_power_off(mod) clk_disable((mod)->clk)
 427 #define rsnd_mod_get(ip)        (&(ip)->mod)
 428
 429 int rsnd_mod_init(struct rsnd_priv *priv,
 430                   struct rsnd_mod *mod,
 431                   struct rsnd_mod_ops *ops,
 432                   struct clk *clk,
 433                   enum rsnd_mod_type type,
 434                   int id);
 435 void rsnd_mod_quit(struct rsnd_mod *mod);
 436 struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
 437                                   struct rsnd_mod *mod);
 438 void rsnd_mod_interrupt(struct rsnd_mod *mod,
 439                         void (*callback)(struct rsnd_mod *mod,
 440                                          struct rsnd_dai_stream *io));
 441 u32 *rsnd_mod_get_status(struct rsnd_mod *mod,
 442                          struct rsnd_dai_stream *io,
 443                          enum rsnd_mod_type type);
 444 int rsnd_mod_id(struct rsnd_mod *mod);
 445 int rsnd_mod_id_raw(struct rsnd_mod *mod);
 446 int rsnd_mod_id_sub(struct rsnd_mod *mod);
 447 char *rsnd_mod_name(struct rsnd_mod *mod);
 448 struct rsnd_mod *rsnd_mod_next(int *iterator,
 449                                struct rsnd_dai_stream *io,
 450                                enum rsnd_mod_type *array,
 451                                int array_size);
 452 #define for_each_rsnd_mod(iterator, pos, io)                            \
 453         for (iterator = 0;                                              \
 454              (pos = rsnd_mod_next(&iterator, io, NULL, 0)); iterator++)
 455 #define for_each_rsnd_mod_arrays(iterator, pos, io, array, size)        \
 456         for (iterator = 0;                                              \
 457              (pos = rsnd_mod_next(&iterator, io, array, size)); iterator++)
 458 #define for_each_rsnd_mod_array(iterator, pos, io, array)               \
 459         for_each_rsnd_mod_arrays(iterator, pos, io, array, ARRAY_SIZE(array))
 460
 461 void rsnd_parse_connect_common(struct rsnd_dai *rdai, char *name,
 462                 struct rsnd_mod* (*mod_get)(struct rsnd_priv *priv, int id),
 463                 struct device_node *node,
 464                 struct device_node *playback,
 465                 struct device_node *capture);
 466 int rsnd_node_count(struct rsnd_priv *priv, struct device_node *node, char *name);
 467 int rsnd_node_fixed_index(struct device *dev, struct device_node *node, char *name, int idx);
 468
 469 int rsnd_channel_normalization(int chan);
 470 #define rsnd_runtime_channel_original(io) \
 471         rsnd_runtime_channel_original_with_params(io, NULL)
 472 int rsnd_runtime_channel_original_with_params(struct rsnd_dai_stream *io,
 473                                 struct snd_pcm_hw_params *params);
 474 #define rsnd_runtime_channel_after_ctu(io)                      \
 475         rsnd_runtime_channel_after_ctu_with_params(io, NULL)
 476 int rsnd_runtime_channel_after_ctu_with_params(struct rsnd_dai_stream *io,
 477                                 struct snd_pcm_hw_params *params);
 478 #define rsnd_runtime_channel_for_ssi(io) \
 479         rsnd_runtime_channel_for_ssi_with_params(io, NULL)
 480 int rsnd_runtime_channel_for_ssi_with_params(struct rsnd_dai_stream *io,
 481                                  struct snd_pcm_hw_params *params);
 482 int rsnd_runtime_is_multi_ssi(struct rsnd_dai_stream *io);
 483 int rsnd_runtime_is_tdm(struct rsnd_dai_stream *io);
 484 int rsnd_runtime_is_tdm_split(struct rsnd_dai_stream *io);
 485
 486 /*
 487  * DT
 488  */
 489 #define rsnd_parse_of_node(priv, node)                                  \
 490         of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, node)
 491 #define RSND_NODE_DAI   "rcar_sound,dai"
 492 #define RSND_NODE_SSI   "rcar_sound,ssi"
 493 #define RSND_NODE_SSIU  "rcar_sound,ssiu"
 494 #define RSND_NODE_SRC   "rcar_sound,src"
 495 #define RSND_NODE_CTU   "rcar_sound,ctu"
 496 #define RSND_NODE_MIX   "rcar_sound,mix"
 497 #define RSND_NODE_DVC   "rcar_sound,dvc"
 498
 499 /*
 500  *      R-Car sound DAI
 501  */
 502 #define RSND_DAI_NAME_SIZE      16
 503 struct rsnd_dai_stream {
 504         char name[RSND_DAI_NAME_SIZE];
 505         struct snd_pcm_substream *substream;
 506         struct rsnd_mod *mod[RSND_MOD_MAX];
 507         struct rsnd_mod *dma;
 508         struct rsnd_dai *rdai;
 509         struct device *dmac_dev; /* for IPMMU */
 510         u32 converted_rate;      /* converted sampling rate */
 511         int converted_chan;      /* converted channels */
 512         u32 parent_ssi_status;
 513         u32 flags;
 514 };
 515
 516 /* flags */
 517 #define RSND_STREAM_HDMI0       (1 << 0) /* for HDMI0 */
 518 #define RSND_STREAM_HDMI1       (1 << 1) /* for HDMI1 */
 519 #define RSND_STREAM_TDM_SPLIT   (1 << 2) /* for TDM split mode */
 520 #define RSND_HW_RULE_ERR        (1 << 3) /* hw_rule error */
 521
 522 #define rsnd_io_to_mod(io, i)   ((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
 523 #define rsnd_io_to_mod_ssi(io)  rsnd_io_to_mod((io), RSND_MOD_SSI)
 524 #define rsnd_io_to_mod_ssiu(io) rsnd_io_to_mod((io), RSND_MOD_SSIU)
 525 #define rsnd_io_to_mod_ssip(io) rsnd_io_to_mod((io), RSND_MOD_SSIP)
 526 #define rsnd_io_to_mod_src(io)  rsnd_io_to_mod((io), RSND_MOD_SRC)
 527 #define rsnd_io_to_mod_ctu(io)  rsnd_io_to_mod((io), RSND_MOD_CTU)
 528 #define rsnd_io_to_mod_mix(io)  rsnd_io_to_mod((io), RSND_MOD_MIX)
 529 #define rsnd_io_to_mod_dvc(io)  rsnd_io_to_mod((io), RSND_MOD_DVC)
 530 #define rsnd_io_to_mod_cmd(io)  rsnd_io_to_mod((io), RSND_MOD_CMD)
 531 #define rsnd_io_to_rdai(io)     ((io)->rdai)
 532 #define rsnd_io_to_priv(io)     (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
 533 #define rsnd_io_is_play(io)     (&rsnd_io_to_rdai(io)->playback == io)
 534 #define rsnd_io_to_runtime(io) ((io)->substream ? \
 535                                 (io)->substream->runtime : NULL)
 536 #define rsnd_io_converted_rate(io)      ((io)->converted_rate)
 537 #define rsnd_io_converted_chan(io)      ((io)->converted_chan)
 538 int rsnd_io_is_working(struct rsnd_dai_stream *io);
 539
 540 struct rsnd_dai {
 541         char name[RSND_DAI_NAME_SIZE];
 542         struct rsnd_dai_stream playback;
 543         struct rsnd_dai_stream capture;
 544         struct rsnd_priv *priv;
 545         struct snd_pcm_hw_constraint_list constraint;
 546         struct of_phandle_args dai_args;
 547
 548         int max_channels;       /* 2ch - 16ch */
 549         int ssi_lane;           /* 1lane - 4lane */
 550         int chan_width;         /* 16/24/32 bit width */
 551
 552         unsigned int clk_master:1;
 553         unsigned int bit_clk_inv:1;
 554         unsigned int frm_clk_inv:1;
 555         unsigned int sys_delay:1;
 556         unsigned int data_alignment:1;
 557 };
 558
 559 #define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
 560 #define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
 561 #define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
 562 #define for_each_rsnd_dai(rdai, priv, i)                \
 563         for (i = 0;                                     \
 564              (i < rsnd_rdai_nr(priv)) &&                \
 565              ((rdai) = rsnd_rdai_get(priv, i));         \
 566              i++)
 567
 568 struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
 569
 570 #define rsnd_rdai_channels_set(rdai, max_channels) \
 571         rsnd_rdai_channels_ctrl(rdai, max_channels)
 572 #define rsnd_rdai_channels_get(rdai) \
 573         rsnd_rdai_channels_ctrl(rdai, 0)
 574 int rsnd_rdai_channels_ctrl(struct rsnd_dai *rdai,
 575                             int max_channels);
 576
 577 #define rsnd_rdai_ssi_lane_set(rdai, ssi_lane) \
 578         rsnd_rdai_ssi_lane_ctrl(rdai, ssi_lane)
 579 #define rsnd_rdai_ssi_lane_get(rdai) \
 580         rsnd_rdai_ssi_lane_ctrl(rdai, 0)
 581 int rsnd_rdai_ssi_lane_ctrl(struct rsnd_dai *rdai,
 582                             int ssi_lane);
 583
 584 #define rsnd_rdai_width_set(rdai, width) \
 585         rsnd_rdai_width_ctrl(rdai, width)
 586 #define rsnd_rdai_width_get(rdai) \
 587         rsnd_rdai_width_ctrl(rdai, 0)
 588 int rsnd_rdai_width_ctrl(struct rsnd_dai *rdai, int width);
 589 void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
 590 int rsnd_dai_connect(struct rsnd_mod *mod,
 591                      struct rsnd_dai_stream *io,
 592                      enum rsnd_mod_type type);
 593
 594 /*
 595  *      R-Car Gen1/Gen2
 596  */
 597 int rsnd_gen_probe(struct rsnd_priv *priv);
 598 void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
 599                                struct rsnd_mod *mod,
 600                                enum rsnd_reg reg);
 601 phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
 602 #ifdef CONFIG_DEBUG_FS
 603 void __iomem *rsnd_gen_get_base_addr(struct rsnd_priv *priv, int reg_id);
 604 #endif
 605
 606 /*
 607  *      R-Car ADG
 608  */
 609 int rsnd_adg_clk_query(struct rsnd_priv *priv, unsigned int rate);
 610 int rsnd_adg_ssi_clk_stop(struct rsnd_mod *ssi_mod);
 611 int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *ssi_mod, unsigned int rate);
 612 int rsnd_adg_probe(struct rsnd_priv *priv);
 613 void rsnd_adg_remove(struct rsnd_priv *priv);
 614 int rsnd_adg_set_src_timesel_gen2(struct rsnd_mod *src_mod,
 615                                   struct rsnd_dai_stream *io,
 616                                   unsigned int in_rate,
 617                                   unsigned int out_rate);
 618 int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *cmd_mod,
 619                                  struct rsnd_dai_stream *io);
 620 #define rsnd_adg_clk_enable(priv)       rsnd_adg_clk_control(priv, 1)
 621 #define rsnd_adg_clk_disable(priv)      rsnd_adg_clk_control(priv, 0)
 622 void rsnd_adg_clk_control(struct rsnd_priv *priv, int enable);
 623 void rsnd_adg_clk_dbg_info(struct rsnd_priv *priv, struct seq_file *m);
 624
 625 /*
 626  *      R-Car sound priv
 627  */
 628 struct rsnd_priv {
 629
 630         struct platform_device *pdev;
 631         spinlock_t lock;
 632         unsigned long flags;
 633 #define RSND_GEN_MASK   (0xF << 0)
 634 #define RSND_GEN1       (1 << 0)
 635 #define RSND_GEN2       (2 << 0)
 636 #define RSND_GEN3       (3 << 0)
 637 #define RSND_GEN4       (4 << 0)
 638 #define RSND_SOC_MASK   (0xFF << 4)
 639 #define RSND_SOC_E      (1 << 4) /* E1/E2/E3 */
 640
 641         /*
 642          * below value will be filled on rsnd_gen_probe()
 643          */
 644         void *gen;
 645
 646         /*
 647          * below value will be filled on rsnd_adg_probe()
 648          */
 649         void *adg;
 650
 651         /*
 652          * below value will be filled on rsnd_dma_probe()
 653          */
 654         void *dma;
 655
 656         /*
 657          * below value will be filled on rsnd_ssi_probe()
 658          */
 659         void *ssi;
 660         int ssi_nr;
 661
 662         /*
 663          * below value will be filled on rsnd_ssiu_probe()
 664          */
 665         void *ssiu;
 666         int ssiu_nr;
 667
 668         /*
 669          * below value will be filled on rsnd_src_probe()
 670          */
 671         void *src;
 672         int src_nr;
 673
 674         /*
 675          * below value will be filled on rsnd_ctu_probe()
 676          */
 677         void *ctu;
 678         int ctu_nr;
 679
 680         /*
 681          * below value will be filled on rsnd_mix_probe()
 682          */
 683         void *mix;
 684         int mix_nr;
 685
 686         /*
 687          * below value will be filled on rsnd_dvc_probe()
 688          */
 689         void *dvc;
 690         int dvc_nr;
 691
 692         /*
 693          * below value will be filled on rsnd_cmd_probe()
 694          */
 695         void *cmd;
 696         int cmd_nr;
 697
 698         /*
 699          * below value will be filled on rsnd_dai_probe()
 700          */
 701         struct snd_soc_dai_driver *daidrv;
 702         struct rsnd_dai *rdai;
 703         int rdai_nr;
 704
 705 #define RSND_MAX_COMPONENT 3
 706         int component_dais[RSND_MAX_COMPONENT];
 707 };
 708
 709 #define rsnd_priv_to_pdev(priv) ((priv)->pdev)
 710 #define rsnd_priv_to_dev(priv)  (&(rsnd_priv_to_pdev(priv)->dev))
 711
 712 #define rsnd_is_gen1(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
 713 #define rsnd_is_gen2(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
 714 #define rsnd_is_gen3(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN3)
 715 #define rsnd_is_gen4(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN4)
 716 #define rsnd_is_e3(priv)        (((priv)->flags & \
 717                                         (RSND_GEN_MASK | RSND_SOC_MASK)) == \
 718                                         (RSND_GEN3 | RSND_SOC_E))
 719
 720 #define rsnd_flags_has(p, f) ((p)->flags & (f))
 721 #define rsnd_flags_set(p, f) ((p)->flags |= (f))
 722 #define rsnd_flags_del(p, f) ((p)->flags &= ~(f))
 723
 724 /*
 725  *      rsnd_kctrl
 726  */
 727 struct rsnd_kctrl_cfg {
 728         unsigned int max;
 729         unsigned int size;
 730         u32 *val;
 731         const char * const *texts;
 732         int (*accept)(struct rsnd_dai_stream *io);
 733         void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
 734         struct rsnd_dai_stream *io;
 735         struct snd_card *card;
 736         struct snd_kcontrol *kctrl;
 737         struct rsnd_mod *mod;
 738 };
 739
 740 #define RSND_MAX_CHANNELS       8
 741 struct rsnd_kctrl_cfg_m {
 742         struct rsnd_kctrl_cfg cfg;
 743         u32 val[RSND_MAX_CHANNELS];
 744 };
 745
 746 struct rsnd_kctrl_cfg_s {
 747         struct rsnd_kctrl_cfg cfg;
 748         u32 val;
 749 };
 750 #define rsnd_kctrl_size(x)      ((x).cfg.size)
 751 #define rsnd_kctrl_max(x)       ((x).cfg.max)
 752 #define rsnd_kctrl_valm(x, i)   ((x).val[i])    /* = (x).cfg.val[i] */
 753 #define rsnd_kctrl_vals(x)      ((x).val)       /* = (x).cfg.val[0] */
 754
 755 int rsnd_kctrl_accept_anytime(struct rsnd_dai_stream *io);
 756 int rsnd_kctrl_accept_runtime(struct rsnd_dai_stream *io);
 757 struct rsnd_kctrl_cfg *rsnd_kctrl_init_m(struct rsnd_kctrl_cfg_m *cfg);
 758 struct rsnd_kctrl_cfg *rsnd_kctrl_init_s(struct rsnd_kctrl_cfg_s *cfg);
 759 int rsnd_kctrl_new(struct rsnd_mod *mod,
 760                    struct rsnd_dai_stream *io,
 761                    struct snd_soc_pcm_runtime *rtd,
 762                    const unsigned char *name,
 763                    int (*accept)(struct rsnd_dai_stream *io),
 764                    void (*update)(struct rsnd_dai_stream *io,
 765                                   struct rsnd_mod *mod),
 766                    struct rsnd_kctrl_cfg *cfg,
 767                    const char * const *texts,
 768                    int size,
 769                    u32 max);
 770
 771 #define rsnd_kctrl_new_m(mod, io, rtd, name, accept, update, cfg, size, max) \
 772         rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_m(cfg), \
 773                        NULL, size, max)
 774
 775 #define rsnd_kctrl_new_s(mod, io, rtd, name, accept, update, cfg, max)  \
 776         rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
 777                        NULL, 1, max)
 778
 779 #define rsnd_kctrl_new_e(mod, io, rtd, name, accept, update, cfg, texts, size) \
 780         rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
 781                        texts, 1, size)
 782
 783 extern const char * const volume_ramp_rate[];
 784 #define VOLUME_RAMP_MAX_DVC     (0x17 + 1)
 785 #define VOLUME_RAMP_MAX_MIX     (0x0a + 1)
 786
 787 /*
 788  *      R-Car SSI
 789  */
 790 int rsnd_ssi_probe(struct rsnd_priv *priv);
 791 void rsnd_ssi_remove(struct rsnd_priv *priv);
 792 struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
 793 int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
 794 u32 rsnd_ssi_multi_secondaries_runtime(struct rsnd_dai_stream *io);
 795 int rsnd_ssi_is_dma_mode(struct rsnd_mod *mod);
 796
 797 #define rsnd_ssi_is_pin_sharing(io)     \
 798         __rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
 799 int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
 800
 801 #define rsnd_ssi_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSI)
 802 void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
 803                             struct device_node *playback,
 804                             struct device_node *capture);
 805 unsigned int rsnd_ssi_clk_query(struct rsnd_dai *rdai,
 806                        int param1, int param2, int *idx);
 807
 808 /*
 809  *      R-Car SSIU
 810  */
 811 int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
 812                      struct rsnd_mod *mod);
 813 int rsnd_ssiu_probe(struct rsnd_priv *priv);
 814 void rsnd_ssiu_remove(struct rsnd_priv *priv);
 815 void rsnd_parse_connect_ssiu(struct rsnd_dai *rdai,
 816                              struct device_node *playback,
 817                              struct device_node *capture);
 818 #define rsnd_ssiu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSIU)
 819 bool rsnd_ssiu_busif_err_status_clear(struct rsnd_mod *mod);
 820
 821 /*
 822  *      R-Car SRC
 823  */
 824 int rsnd_src_probe(struct rsnd_priv *priv);
 825 void rsnd_src_remove(struct rsnd_priv *priv);
 826 struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
 827
 828 #define rsnd_src_get_in_rate(priv, io) rsnd_src_get_rate(priv, io, 1)
 829 #define rsnd_src_get_out_rate(priv, io) rsnd_src_get_rate(priv, io, 0)
 830 unsigned int rsnd_src_get_rate(struct rsnd_priv *priv,
 831                                struct rsnd_dai_stream *io,
 832                                int is_in);
 833
 834 #define rsnd_src_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SRC)
 835 #define rsnd_parse_connect_src(rdai, playback, capture)                 \
 836         rsnd_parse_connect_common(rdai, "src", rsnd_src_mod_get,        \
 837                                   rsnd_src_of_node(rsnd_rdai_to_priv(rdai)), \
 838                                                    playback, capture)
 839
 840 /*
 841  *      R-Car CTU
 842  */
 843 int rsnd_ctu_probe(struct rsnd_priv *priv);
 844 void rsnd_ctu_remove(struct rsnd_priv *priv);
 845 struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
 846 #define rsnd_ctu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_CTU)
 847 #define rsnd_parse_connect_ctu(rdai, playback, capture)                 \
 848         rsnd_parse_connect_common(rdai, "ctu", rsnd_ctu_mod_get,        \
 849                                   rsnd_ctu_of_node(rsnd_rdai_to_priv(rdai)), \
 850                                                    playback, capture)
 851
 852 /*
 853  *      R-Car MIX
 854  */
 855 int rsnd_mix_probe(struct rsnd_priv *priv);
 856 void rsnd_mix_remove(struct rsnd_priv *priv);
 857 struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
 858 #define rsnd_mix_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_MIX)
 859 #define rsnd_parse_connect_mix(rdai, playback, capture)                 \
 860         rsnd_parse_connect_common(rdai, "mix", rsnd_mix_mod_get,        \
 861                                   rsnd_mix_of_node(rsnd_rdai_to_priv(rdai)), \
 862                                                    playback, capture)
 863
 864 /*
 865  *      R-Car DVC
 866  */
 867 int rsnd_dvc_probe(struct rsnd_priv *priv);
 868 void rsnd_dvc_remove(struct rsnd_priv *priv);
 869 struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
 870 #define rsnd_dvc_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_DVC)
 871 #define rsnd_parse_connect_dvc(rdai, playback, capture)                 \
 872         rsnd_parse_connect_common(rdai, "dvc", rsnd_dvc_mod_get,        \
 873                                   rsnd_dvc_of_node(rsnd_rdai_to_priv(rdai)), \
 874                                                    playback, capture)
 875
 876 /*
 877  *      R-Car CMD
 878  */
 879 int rsnd_cmd_probe(struct rsnd_priv *priv);
 880 void rsnd_cmd_remove(struct rsnd_priv *priv);
 881 int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
 882
 883 void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
 884 #ifdef DEBUG
 885 #define rsnd_mod_confirm_ssi(mssi)      rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
 886 #define rsnd_mod_confirm_src(msrc)      rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
 887 #define rsnd_mod_confirm_dvc(mdvc)      rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
 888 #else
 889 #define rsnd_mod_confirm_ssi(mssi)
 890 #define rsnd_mod_confirm_src(msrc)
 891 #define rsnd_mod_confirm_dvc(mdvc)
 892 #endif
 893
 894 /*
 895  * If you don't need interrupt status debug message,
 896  * define RSND_DEBUG_NO_IRQ_STATUS as 1 on top of src.c/ssi.c
 897  *
 898  * #define RSND_DEBUG_NO_IRQ_STATUS 1
 899  */
 900 #define rsnd_print_irq_status(dev, param...) do {       \
 901         if (!IS_BUILTIN(RSND_DEBUG_NO_IRQ_STATUS))      \
 902                 dev_info(dev, param);                   \
 903 } while (0)
 904
 905 #ifdef CONFIG_DEBUG_FS
 906 int rsnd_debugfs_probe(struct snd_soc_component *component);
 907 void rsnd_debugfs_reg_show(struct seq_file *m, phys_addr_t _addr,
 908                            void __iomem *base, int offset, int size);
 909 void rsnd_debugfs_mod_reg_show(struct seq_file *m, struct rsnd_mod *mod,
 910                                int reg_id, int offset, int size);
 911
 912 #else
 913 #define rsnd_debugfs_probe  NULL
 914 #endif
 915
 916 #endif /* RSND_H */