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