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        SSI_SYS_INT_ENABLE0,
 193        SSI_SYS_INT_ENABLE1,
 194        SSI_SYS_INT_ENABLE2,
 195        SSI_SYS_INT_ENABLE3,
 196        SSI_SYS_INT_ENABLE4,
 197        SSI_SYS_INT_ENABLE5,
 198        SSI_SYS_INT_ENABLE6,
 199        SSI_SYS_INT_ENABLE7,
 200        HDMI0_SEL,
 201        HDMI1_SEL,
 202        SSI9_BUSIF0_MODE,
 203        SSI9_BUSIF1_MODE,
 204        SSI9_BUSIF2_MODE,
 205        SSI9_BUSIF3_MODE,
 206        SSI9_BUSIF4_MODE,
 207        SSI9_BUSIF5_MODE,
 208        SSI9_BUSIF6_MODE,
 209        SSI9_BUSIF7_MODE,
 210        SSI9_BUSIF0_ADINR,
 211        SSI9_BUSIF1_ADINR,
 212        SSI9_BUSIF2_ADINR,
 213        SSI9_BUSIF3_ADINR,
 214        SSI9_BUSIF4_ADINR,
 215        SSI9_BUSIF5_ADINR,
 216        SSI9_BUSIF6_ADINR,
 217        SSI9_BUSIF7_ADINR,
 218        SSI9_BUSIF0_DALIGN,
 219        SSI9_BUSIF1_DALIGN,
 220        SSI9_BUSIF2_DALIGN,
 221        SSI9_BUSIF3_DALIGN,
 222        SSI9_BUSIF4_DALIGN,
 223        SSI9_BUSIF5_DALIGN,
 224        SSI9_BUSIF6_DALIGN,
 225        SSI9_BUSIF7_DALIGN,
 226
 227        /* SSI */
 228        SSICR,
 229        SSISR,
 230        SSITDR,
 231        SSIRDR,
 232        SSIWSR,
 233
 234        REG_MAX,
 235};
 236#define SRCIN_TIMSEL(i)         (SRCIN_TIMSEL0 + (i))
 237#define SRCOUT_TIMSEL(i)        (SRCOUT_TIMSEL0 + (i))
 238#define CTU_SVxxR(i, j)         (CTU_SV00R + (i * 8) + (j))
 239#define DVC_VOLxR(i)            (DVC_VOL0R + (i))
 240#define AUDIO_CLK_SEL(i)        (AUDIO_CLK_SEL0 + (i))
 241#define SSI_BUSIF_MODE(i)       (SSI_BUSIF0_MODE + (i))
 242#define SSI_BUSIF_ADINR(i)      (SSI_BUSIF0_ADINR + (i))
 243#define SSI_BUSIF_DALIGN(i)     (SSI_BUSIF0_DALIGN + (i))
 244#define SSI9_BUSIF_MODE(i)      (SSI9_BUSIF0_MODE + (i))
 245#define SSI9_BUSIF_ADINR(i)     (SSI9_BUSIF0_ADINR + (i))
 246#define SSI9_BUSIF_DALIGN(i)    (SSI9_BUSIF0_DALIGN + (i))
 247#define SSI_SYS_STATUS(i)       (SSI_SYS_STATUS0 + (i))
 248#define SSI_SYS_INT_ENABLE(i) (SSI_SYS_INT_ENABLE0 + (i))
 249
 250
 251struct rsnd_priv;
 252struct rsnd_mod;
 253struct rsnd_dai;
 254struct rsnd_dai_stream;
 255
 256/*
 257 *      R-Car basic functions
 258 */
 259u32 rsnd_mod_read(struct rsnd_mod *mod, enum rsnd_reg reg);
 260void rsnd_mod_write(struct rsnd_mod *mod, enum rsnd_reg reg, u32 data);
 261void rsnd_mod_bset(struct rsnd_mod *mod, enum rsnd_reg reg, u32 mask, u32 data);
 262u32 rsnd_get_adinr_bit(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
 263u32 rsnd_get_dalign(struct rsnd_mod *mod, struct rsnd_dai_stream *io);
 264u32 rsnd_get_busif_shift(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
 265
 266/*
 267 *      R-Car DMA
 268 */
 269int rsnd_dma_attach(struct rsnd_dai_stream *io,
 270                    struct rsnd_mod *mod, struct rsnd_mod **dma_mod);
 271int rsnd_dma_probe(struct rsnd_priv *priv);
 272struct dma_chan *rsnd_dma_request_channel(struct device_node *of_node,
 273                                          struct rsnd_mod *mod, char *name);
 274
 275/*
 276 *      R-Car sound mod
 277 */
 278enum rsnd_mod_type {
 279        RSND_MOD_AUDMAPP,
 280        RSND_MOD_AUDMA,
 281        RSND_MOD_DVC,
 282        RSND_MOD_MIX,
 283        RSND_MOD_CTU,
 284        RSND_MOD_CMD,
 285        RSND_MOD_SRC,
 286        RSND_MOD_SSIM3,         /* SSI multi 3 */
 287        RSND_MOD_SSIM2,         /* SSI multi 2 */
 288        RSND_MOD_SSIM1,         /* SSI multi 1 */
 289        RSND_MOD_SSIP,          /* SSI parent */
 290        RSND_MOD_SSI,
 291        RSND_MOD_SSIU,
 292        RSND_MOD_MAX,
 293};
 294
 295struct rsnd_mod_ops {
 296        char *name;
 297        struct dma_chan* (*dma_req)(struct rsnd_dai_stream *io,
 298                                    struct rsnd_mod *mod);
 299        int (*probe)(struct rsnd_mod *mod,
 300                     struct rsnd_dai_stream *io,
 301                     struct rsnd_priv *priv);
 302        int (*remove)(struct rsnd_mod *mod,
 303                      struct rsnd_dai_stream *io,
 304                      struct rsnd_priv *priv);
 305        int (*init)(struct rsnd_mod *mod,
 306                    struct rsnd_dai_stream *io,
 307                    struct rsnd_priv *priv);
 308        int (*quit)(struct rsnd_mod *mod,
 309                    struct rsnd_dai_stream *io,
 310                    struct rsnd_priv *priv);
 311        int (*start)(struct rsnd_mod *mod,
 312                     struct rsnd_dai_stream *io,
 313                     struct rsnd_priv *priv);
 314        int (*stop)(struct rsnd_mod *mod,
 315                    struct rsnd_dai_stream *io,
 316                    struct rsnd_priv *priv);
 317        int (*irq)(struct rsnd_mod *mod,
 318                   struct rsnd_dai_stream *io,
 319                   struct rsnd_priv *priv, int enable);
 320        int (*pcm_new)(struct rsnd_mod *mod,
 321                       struct rsnd_dai_stream *io,
 322                       struct snd_soc_pcm_runtime *rtd);
 323        int (*hw_params)(struct rsnd_mod *mod,
 324                         struct rsnd_dai_stream *io,
 325                         struct snd_pcm_substream *substream,
 326                         struct snd_pcm_hw_params *hw_params);
 327        int (*pointer)(struct rsnd_mod *mod,
 328                       struct rsnd_dai_stream *io,
 329                       snd_pcm_uframes_t *pointer);
 330        int (*fallback)(struct rsnd_mod *mod,
 331                        struct rsnd_dai_stream *io,
 332                        struct rsnd_priv *priv);
 333        int (*prepare)(struct rsnd_mod *mod,
 334                       struct rsnd_dai_stream *io,
 335                       struct rsnd_priv *priv);
 336        int (*cleanup)(struct rsnd_mod *mod,
 337                       struct rsnd_dai_stream *io,
 338                       struct rsnd_priv *priv);
 339        int (*hw_free)(struct rsnd_mod *mod,
 340                       struct rsnd_dai_stream *io,
 341                       struct snd_pcm_substream *substream);
 342        u32 *(*get_status)(struct rsnd_mod *mod,
 343                           struct rsnd_dai_stream *io,
 344                           enum rsnd_mod_type type);
 345        int (*id)(struct rsnd_mod *mod);
 346        int (*id_sub)(struct rsnd_mod *mod);
 347        int (*id_cmd)(struct rsnd_mod *mod);
 348};
 349
 350struct rsnd_dai_stream;
 351struct rsnd_mod {
 352        int id;
 353        enum rsnd_mod_type type;
 354        struct rsnd_mod_ops *ops;
 355        struct rsnd_priv *priv;
 356        struct clk *clk;
 357        u32 status;
 358};
 359/*
 360 * status
 361 *
 362 * 0xH0000CB0
 363 *
 364 * B    0: init         1: quit
 365 * C    0: start        1: stop
 366 * D    0: hw_params    1: hw_free
 367 *
 368 * H is always called (see __rsnd_mod_call)
 369 * H    0: probe        1: remove
 370 * H    0: pcm_new
 371 * H    0: fallback
 372 * H    0: pointer
 373 * H    0: prepare
 374 * H    0: cleanup
 375 */
 376#define __rsnd_mod_shift_init           4
 377#define __rsnd_mod_shift_quit           4
 378#define __rsnd_mod_shift_start          8
 379#define __rsnd_mod_shift_stop           8
 380#define __rsnd_mod_shift_hw_params      12
 381#define __rsnd_mod_shift_hw_free        12
 382#define __rsnd_mod_shift_probe          28 /* always called */
 383#define __rsnd_mod_shift_remove         28 /* always called */
 384#define __rsnd_mod_shift_irq            28 /* always called */
 385#define __rsnd_mod_shift_pcm_new        28 /* always called */
 386#define __rsnd_mod_shift_fallback       28 /* always called */
 387#define __rsnd_mod_shift_pointer        28 /* always called */
 388#define __rsnd_mod_shift_prepare        28 /* always called */
 389#define __rsnd_mod_shift_cleanup        28 /* always called */
 390
 391#define __rsnd_mod_add_probe            0
 392#define __rsnd_mod_add_remove           0
 393#define __rsnd_mod_add_prepare          0
 394#define __rsnd_mod_add_cleanup          0
 395#define __rsnd_mod_add_init              1
 396#define __rsnd_mod_add_quit             -1
 397#define __rsnd_mod_add_start             1
 398#define __rsnd_mod_add_stop             -1
 399#define __rsnd_mod_add_hw_params        1
 400#define __rsnd_mod_add_hw_free          -1
 401#define __rsnd_mod_add_irq              0
 402#define __rsnd_mod_add_pcm_new          0
 403#define __rsnd_mod_add_fallback         0
 404#define __rsnd_mod_add_pointer          0
 405
 406#define __rsnd_mod_call_probe           0
 407#define __rsnd_mod_call_remove          0
 408#define __rsnd_mod_call_prepare         0
 409#define __rsnd_mod_call_cleanup         0
 410#define __rsnd_mod_call_init            0
 411#define __rsnd_mod_call_quit            1
 412#define __rsnd_mod_call_start           0
 413#define __rsnd_mod_call_stop            1
 414#define __rsnd_mod_call_irq             0
 415#define __rsnd_mod_call_pcm_new         0
 416#define __rsnd_mod_call_fallback        0
 417#define __rsnd_mod_call_hw_params       0
 418#define __rsnd_mod_call_pointer         0
 419#define __rsnd_mod_call_hw_free         1
 420
 421#define rsnd_mod_to_priv(mod)   ((mod)->priv)
 422#define rsnd_mod_power_on(mod)  clk_enable((mod)->clk)
 423#define rsnd_mod_power_off(mod) clk_disable((mod)->clk)
 424#define rsnd_mod_get(ip)        (&(ip)->mod)
 425
 426int rsnd_mod_init(struct rsnd_priv *priv,
 427                  struct rsnd_mod *mod,
 428                  struct rsnd_mod_ops *ops,
 429                  struct clk *clk,
 430                  enum rsnd_mod_type type,
 431                  int id);
 432void rsnd_mod_quit(struct rsnd_mod *mod);
 433struct dma_chan *rsnd_mod_dma_req(struct rsnd_dai_stream *io,
 434                                  struct rsnd_mod *mod);
 435void rsnd_mod_interrupt(struct rsnd_mod *mod,
 436                        void (*callback)(struct rsnd_mod *mod,
 437                                         struct rsnd_dai_stream *io));
 438u32 *rsnd_mod_get_status(struct rsnd_mod *mod,
 439                         struct rsnd_dai_stream *io,
 440                         enum rsnd_mod_type type);
 441int rsnd_mod_id(struct rsnd_mod *mod);
 442int rsnd_mod_id_raw(struct rsnd_mod *mod);
 443int rsnd_mod_id_sub(struct rsnd_mod *mod);
 444char *rsnd_mod_name(struct rsnd_mod *mod);
 445struct rsnd_mod *rsnd_mod_next(int *iterator,
 446                               struct rsnd_dai_stream *io,
 447                               enum rsnd_mod_type *array,
 448                               int array_size);
 449#define for_each_rsnd_mod(iterator, pos, io)                            \
 450        for (iterator = 0;                                              \
 451             (pos = rsnd_mod_next(&iterator, io, NULL, 0)); iterator++)
 452#define for_each_rsnd_mod_arrays(iterator, pos, io, array, size)        \
 453        for (iterator = 0;                                              \
 454             (pos = rsnd_mod_next(&iterator, io, array, size)); iterator++)
 455#define for_each_rsnd_mod_array(iterator, pos, io, array)               \
 456        for_each_rsnd_mod_arrays(iterator, pos, io, array, ARRAY_SIZE(array))
 457
 458void rsnd_parse_connect_common(struct rsnd_dai *rdai,
 459                struct rsnd_mod* (*mod_get)(struct rsnd_priv *priv, int id),
 460                struct device_node *node,
 461                struct device_node *playback,
 462                struct device_node *capture);
 463
 464int rsnd_channel_normalization(int chan);
 465#define rsnd_runtime_channel_original(io) \
 466        rsnd_runtime_channel_original_with_params(io, NULL)
 467int rsnd_runtime_channel_original_with_params(struct rsnd_dai_stream *io,
 468                                struct snd_pcm_hw_params *params);
 469#define rsnd_runtime_channel_after_ctu(io)                      \
 470        rsnd_runtime_channel_after_ctu_with_params(io, NULL)
 471int rsnd_runtime_channel_after_ctu_with_params(struct rsnd_dai_stream *io,
 472                                struct snd_pcm_hw_params *params);
 473#define rsnd_runtime_channel_for_ssi(io) \
 474        rsnd_runtime_channel_for_ssi_with_params(io, NULL)
 475int rsnd_runtime_channel_for_ssi_with_params(struct rsnd_dai_stream *io,
 476                                 struct snd_pcm_hw_params *params);
 477int rsnd_runtime_is_multi_ssi(struct rsnd_dai_stream *io);
 478int rsnd_runtime_is_tdm(struct rsnd_dai_stream *io);
 479int rsnd_runtime_is_tdm_split(struct rsnd_dai_stream *io);
 480
 481/*
 482 * DT
 483 */
 484#define rsnd_parse_of_node(priv, node)                                  \
 485        of_get_child_by_name(rsnd_priv_to_dev(priv)->of_node, node)
 486#define RSND_NODE_DAI   "rcar_sound,dai"
 487#define RSND_NODE_SSI   "rcar_sound,ssi"
 488#define RSND_NODE_SSIU  "rcar_sound,ssiu"
 489#define RSND_NODE_SRC   "rcar_sound,src"
 490#define RSND_NODE_CTU   "rcar_sound,ctu"
 491#define RSND_NODE_MIX   "rcar_sound,mix"
 492#define RSND_NODE_DVC   "rcar_sound,dvc"
 493
 494/*
 495 *      R-Car sound DAI
 496 */
 497#define RSND_DAI_NAME_SIZE      16
 498struct rsnd_dai_stream {
 499        char name[RSND_DAI_NAME_SIZE];
 500        struct snd_pcm_substream *substream;
 501        struct rsnd_mod *mod[RSND_MOD_MAX];
 502        struct rsnd_mod *dma;
 503        struct rsnd_dai *rdai;
 504        struct device *dmac_dev; /* for IPMMU */
 505        u32 converted_rate;      /* converted sampling rate */
 506        int converted_chan;      /* converted channels */
 507        u32 parent_ssi_status;
 508        u32 flags;
 509};
 510
 511/* flags */
 512#define RSND_STREAM_HDMI0       (1 << 0) /* for HDMI0 */
 513#define RSND_STREAM_HDMI1       (1 << 1) /* for HDMI1 */
 514#define RSND_STREAM_TDM_SPLIT   (1 << 2) /* for TDM split mode */
 515
 516#define rsnd_io_to_mod(io, i)   ((i) < RSND_MOD_MAX ? (io)->mod[(i)] : NULL)
 517#define rsnd_io_to_mod_ssi(io)  rsnd_io_to_mod((io), RSND_MOD_SSI)
 518#define rsnd_io_to_mod_ssiu(io) rsnd_io_to_mod((io), RSND_MOD_SSIU)
 519#define rsnd_io_to_mod_ssip(io) rsnd_io_to_mod((io), RSND_MOD_SSIP)
 520#define rsnd_io_to_mod_src(io)  rsnd_io_to_mod((io), RSND_MOD_SRC)
 521#define rsnd_io_to_mod_ctu(io)  rsnd_io_to_mod((io), RSND_MOD_CTU)
 522#define rsnd_io_to_mod_mix(io)  rsnd_io_to_mod((io), RSND_MOD_MIX)
 523#define rsnd_io_to_mod_dvc(io)  rsnd_io_to_mod((io), RSND_MOD_DVC)
 524#define rsnd_io_to_mod_cmd(io)  rsnd_io_to_mod((io), RSND_MOD_CMD)
 525#define rsnd_io_to_rdai(io)     ((io)->rdai)
 526#define rsnd_io_to_priv(io)     (rsnd_rdai_to_priv(rsnd_io_to_rdai(io)))
 527#define rsnd_io_is_play(io)     (&rsnd_io_to_rdai(io)->playback == io)
 528#define rsnd_io_to_runtime(io) ((io)->substream ? \
 529                                (io)->substream->runtime : NULL)
 530#define rsnd_io_converted_rate(io)      ((io)->converted_rate)
 531#define rsnd_io_converted_chan(io)      ((io)->converted_chan)
 532int rsnd_io_is_working(struct rsnd_dai_stream *io);
 533
 534struct rsnd_dai {
 535        char name[RSND_DAI_NAME_SIZE];
 536        struct rsnd_dai_stream playback;
 537        struct rsnd_dai_stream capture;
 538        struct rsnd_priv *priv;
 539        struct snd_pcm_hw_constraint_list constraint;
 540
 541        int max_channels;       /* 2ch - 16ch */
 542        int ssi_lane;           /* 1lane - 4lane */
 543        int chan_width;         /* 16/24/32 bit width */
 544
 545        unsigned int clk_master:1;
 546        unsigned int bit_clk_inv:1;
 547        unsigned int frm_clk_inv:1;
 548        unsigned int sys_delay:1;
 549        unsigned int data_alignment:1;
 550};
 551
 552#define rsnd_rdai_nr(priv) ((priv)->rdai_nr)
 553#define rsnd_rdai_is_clk_master(rdai) ((rdai)->clk_master)
 554#define rsnd_rdai_to_priv(rdai) ((rdai)->priv)
 555#define for_each_rsnd_dai(rdai, priv, i)                \
 556        for (i = 0;                                     \
 557             (i < rsnd_rdai_nr(priv)) &&                \
 558             ((rdai) = rsnd_rdai_get(priv, i));         \
 559             i++)
 560
 561struct rsnd_dai *rsnd_rdai_get(struct rsnd_priv *priv, int id);
 562
 563#define rsnd_rdai_channels_set(rdai, max_channels) \
 564        rsnd_rdai_channels_ctrl(rdai, max_channels)
 565#define rsnd_rdai_channels_get(rdai) \
 566        rsnd_rdai_channels_ctrl(rdai, 0)
 567int rsnd_rdai_channels_ctrl(struct rsnd_dai *rdai,
 568                            int max_channels);
 569
 570#define rsnd_rdai_ssi_lane_set(rdai, ssi_lane) \
 571        rsnd_rdai_ssi_lane_ctrl(rdai, ssi_lane)
 572#define rsnd_rdai_ssi_lane_get(rdai) \
 573        rsnd_rdai_ssi_lane_ctrl(rdai, 0)
 574int rsnd_rdai_ssi_lane_ctrl(struct rsnd_dai *rdai,
 575                            int ssi_lane);
 576
 577#define rsnd_rdai_width_set(rdai, width) \
 578        rsnd_rdai_width_ctrl(rdai, width)
 579#define rsnd_rdai_width_get(rdai) \
 580        rsnd_rdai_width_ctrl(rdai, 0)
 581int rsnd_rdai_width_ctrl(struct rsnd_dai *rdai, int width);
 582void rsnd_dai_period_elapsed(struct rsnd_dai_stream *io);
 583int rsnd_dai_connect(struct rsnd_mod *mod,
 584                     struct rsnd_dai_stream *io,
 585                     enum rsnd_mod_type type);
 586
 587/*
 588 *      R-Car Gen1/Gen2
 589 */
 590int rsnd_gen_probe(struct rsnd_priv *priv);
 591void __iomem *rsnd_gen_reg_get(struct rsnd_priv *priv,
 592                               struct rsnd_mod *mod,
 593                               enum rsnd_reg reg);
 594phys_addr_t rsnd_gen_get_phy_addr(struct rsnd_priv *priv, int reg_id);
 595
 596/*
 597 *      R-Car ADG
 598 */
 599int rsnd_adg_clk_query(struct rsnd_priv *priv, unsigned int rate);
 600int rsnd_adg_ssi_clk_stop(struct rsnd_mod *mod);
 601int rsnd_adg_ssi_clk_try_start(struct rsnd_mod *mod, unsigned int rate);
 602int rsnd_adg_probe(struct rsnd_priv *priv);
 603void rsnd_adg_remove(struct rsnd_priv *priv);
 604int rsnd_adg_set_src_timesel_gen2(struct rsnd_mod *src_mod,
 605                                  struct rsnd_dai_stream *io,
 606                                  unsigned int in_rate,
 607                                  unsigned int out_rate);
 608int rsnd_adg_set_cmd_timsel_gen2(struct rsnd_mod *mod,
 609                                 struct rsnd_dai_stream *io);
 610#define rsnd_adg_clk_enable(priv)       rsnd_adg_clk_control(priv, 1)
 611#define rsnd_adg_clk_disable(priv)      rsnd_adg_clk_control(priv, 0)
 612void rsnd_adg_clk_control(struct rsnd_priv *priv, int enable);
 613
 614/*
 615 *      R-Car sound priv
 616 */
 617struct rsnd_priv {
 618
 619        struct platform_device *pdev;
 620        spinlock_t lock;
 621        unsigned long flags;
 622#define RSND_GEN_MASK   (0xF << 0)
 623#define RSND_GEN1       (1 << 0)
 624#define RSND_GEN2       (2 << 0)
 625#define RSND_GEN3       (3 << 0)
 626#define RSND_SOC_MASK   (0xFF << 4)
 627#define RSND_SOC_E      (1 << 4) /* E1/E2/E3 */
 628
 629        /*
 630         * below value will be filled on rsnd_gen_probe()
 631         */
 632        void *gen;
 633
 634        /*
 635         * below value will be filled on rsnd_adg_probe()
 636         */
 637        void *adg;
 638
 639        /*
 640         * below value will be filled on rsnd_dma_probe()
 641         */
 642        void *dma;
 643
 644        /*
 645         * below value will be filled on rsnd_ssi_probe()
 646         */
 647        void *ssi;
 648        int ssi_nr;
 649
 650        /*
 651         * below value will be filled on rsnd_ssiu_probe()
 652         */
 653        void *ssiu;
 654        int ssiu_nr;
 655
 656        /*
 657         * below value will be filled on rsnd_src_probe()
 658         */
 659        void *src;
 660        int src_nr;
 661
 662        /*
 663         * below value will be filled on rsnd_ctu_probe()
 664         */
 665        void *ctu;
 666        int ctu_nr;
 667
 668        /*
 669         * below value will be filled on rsnd_mix_probe()
 670         */
 671        void *mix;
 672        int mix_nr;
 673
 674        /*
 675         * below value will be filled on rsnd_dvc_probe()
 676         */
 677        void *dvc;
 678        int dvc_nr;
 679
 680        /*
 681         * below value will be filled on rsnd_cmd_probe()
 682         */
 683        void *cmd;
 684        int cmd_nr;
 685
 686        /*
 687         * below value will be filled on rsnd_dai_probe()
 688         */
 689        struct snd_soc_dai_driver *daidrv;
 690        struct rsnd_dai *rdai;
 691        int rdai_nr;
 692};
 693
 694#define rsnd_priv_to_pdev(priv) ((priv)->pdev)
 695#define rsnd_priv_to_dev(priv)  (&(rsnd_priv_to_pdev(priv)->dev))
 696
 697#define rsnd_is_gen1(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN1)
 698#define rsnd_is_gen2(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN2)
 699#define rsnd_is_gen3(priv)      (((priv)->flags & RSND_GEN_MASK) == RSND_GEN3)
 700#define rsnd_is_e3(priv)        (((priv)->flags & \
 701                                        (RSND_GEN_MASK | RSND_SOC_MASK)) == \
 702                                        (RSND_GEN3 | RSND_SOC_E))
 703
 704#define rsnd_flags_has(p, f) ((p)->flags & (f))
 705#define rsnd_flags_set(p, f) ((p)->flags |= (f))
 706#define rsnd_flags_del(p, f) ((p)->flags &= ~(f))
 707
 708/*
 709 *      rsnd_kctrl
 710 */
 711struct rsnd_kctrl_cfg {
 712        unsigned int max;
 713        unsigned int size;
 714        u32 *val;
 715        const char * const *texts;
 716        int (*accept)(struct rsnd_dai_stream *io);
 717        void (*update)(struct rsnd_dai_stream *io, struct rsnd_mod *mod);
 718        struct rsnd_dai_stream *io;
 719        struct snd_card *card;
 720        struct snd_kcontrol *kctrl;
 721        struct rsnd_mod *mod;
 722};
 723
 724#define RSND_MAX_CHANNELS       8
 725struct rsnd_kctrl_cfg_m {
 726        struct rsnd_kctrl_cfg cfg;
 727        u32 val[RSND_MAX_CHANNELS];
 728};
 729
 730struct rsnd_kctrl_cfg_s {
 731        struct rsnd_kctrl_cfg cfg;
 732        u32 val;
 733};
 734#define rsnd_kctrl_size(x)      ((x).cfg.size)
 735#define rsnd_kctrl_max(x)       ((x).cfg.max)
 736#define rsnd_kctrl_valm(x, i)   ((x).val[i])    /* = (x).cfg.val[i] */
 737#define rsnd_kctrl_vals(x)      ((x).val)       /* = (x).cfg.val[0] */
 738
 739int rsnd_kctrl_accept_anytime(struct rsnd_dai_stream *io);
 740int rsnd_kctrl_accept_runtime(struct rsnd_dai_stream *io);
 741struct rsnd_kctrl_cfg *rsnd_kctrl_init_m(struct rsnd_kctrl_cfg_m *cfg);
 742struct rsnd_kctrl_cfg *rsnd_kctrl_init_s(struct rsnd_kctrl_cfg_s *cfg);
 743int rsnd_kctrl_new(struct rsnd_mod *mod,
 744                   struct rsnd_dai_stream *io,
 745                   struct snd_soc_pcm_runtime *rtd,
 746                   const unsigned char *name,
 747                   int (*accept)(struct rsnd_dai_stream *io),
 748                   void (*update)(struct rsnd_dai_stream *io,
 749                                  struct rsnd_mod *mod),
 750                   struct rsnd_kctrl_cfg *cfg,
 751                   const char * const *texts,
 752                   int size,
 753                   u32 max);
 754
 755#define rsnd_kctrl_new_m(mod, io, rtd, name, accept, update, cfg, size, max) \
 756        rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_m(cfg), \
 757                       NULL, size, max)
 758
 759#define rsnd_kctrl_new_s(mod, io, rtd, name, accept, update, cfg, max)  \
 760        rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
 761                       NULL, 1, max)
 762
 763#define rsnd_kctrl_new_e(mod, io, rtd, name, accept, update, cfg, texts, size) \
 764        rsnd_kctrl_new(mod, io, rtd, name, accept, update, rsnd_kctrl_init_s(cfg), \
 765                       texts, 1, size)
 766
 767extern const char * const volume_ramp_rate[];
 768#define VOLUME_RAMP_MAX_DVC     (0x17 + 1)
 769#define VOLUME_RAMP_MAX_MIX     (0x0a + 1)
 770
 771/*
 772 *      R-Car SSI
 773 */
 774int rsnd_ssi_probe(struct rsnd_priv *priv);
 775void rsnd_ssi_remove(struct rsnd_priv *priv);
 776struct rsnd_mod *rsnd_ssi_mod_get(struct rsnd_priv *priv, int id);
 777int rsnd_ssi_use_busif(struct rsnd_dai_stream *io);
 778u32 rsnd_ssi_multi_secondaries_runtime(struct rsnd_dai_stream *io);
 779
 780#define rsnd_ssi_is_pin_sharing(io)     \
 781        __rsnd_ssi_is_pin_sharing(rsnd_io_to_mod_ssi(io))
 782int __rsnd_ssi_is_pin_sharing(struct rsnd_mod *mod);
 783
 784#define rsnd_ssi_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSI)
 785void rsnd_parse_connect_ssi(struct rsnd_dai *rdai,
 786                            struct device_node *playback,
 787                            struct device_node *capture);
 788unsigned int rsnd_ssi_clk_query(struct rsnd_dai *rdai,
 789                       int param1, int param2, int *idx);
 790
 791/*
 792 *      R-Car SSIU
 793 */
 794int rsnd_ssiu_attach(struct rsnd_dai_stream *io,
 795                     struct rsnd_mod *mod);
 796int rsnd_ssiu_probe(struct rsnd_priv *priv);
 797void rsnd_ssiu_remove(struct rsnd_priv *priv);
 798void rsnd_parse_connect_ssiu(struct rsnd_dai *rdai,
 799                             struct device_node *playback,
 800                             struct device_node *capture);
 801#define rsnd_ssiu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SSIU)
 802
 803/*
 804 *      R-Car SRC
 805 */
 806int rsnd_src_probe(struct rsnd_priv *priv);
 807void rsnd_src_remove(struct rsnd_priv *priv);
 808struct rsnd_mod *rsnd_src_mod_get(struct rsnd_priv *priv, int id);
 809
 810#define rsnd_src_get_in_rate(priv, io) rsnd_src_get_rate(priv, io, 1)
 811#define rsnd_src_get_out_rate(priv, io) rsnd_src_get_rate(priv, io, 0)
 812unsigned int rsnd_src_get_rate(struct rsnd_priv *priv,
 813                               struct rsnd_dai_stream *io,
 814                               int is_in);
 815
 816#define rsnd_src_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_SRC)
 817#define rsnd_parse_connect_src(rdai, playback, capture)                 \
 818        rsnd_parse_connect_common(rdai, rsnd_src_mod_get,               \
 819                                  rsnd_src_of_node(rsnd_rdai_to_priv(rdai)), \
 820                                                   playback, capture)
 821
 822/*
 823 *      R-Car CTU
 824 */
 825int rsnd_ctu_probe(struct rsnd_priv *priv);
 826void rsnd_ctu_remove(struct rsnd_priv *priv);
 827struct rsnd_mod *rsnd_ctu_mod_get(struct rsnd_priv *priv, int id);
 828#define rsnd_ctu_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_CTU)
 829#define rsnd_parse_connect_ctu(rdai, playback, capture)                 \
 830        rsnd_parse_connect_common(rdai, rsnd_ctu_mod_get,               \
 831                                  rsnd_ctu_of_node(rsnd_rdai_to_priv(rdai)), \
 832                                                   playback, capture)
 833
 834/*
 835 *      R-Car MIX
 836 */
 837int rsnd_mix_probe(struct rsnd_priv *priv);
 838void rsnd_mix_remove(struct rsnd_priv *priv);
 839struct rsnd_mod *rsnd_mix_mod_get(struct rsnd_priv *priv, int id);
 840#define rsnd_mix_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_MIX)
 841#define rsnd_parse_connect_mix(rdai, playback, capture)                 \
 842        rsnd_parse_connect_common(rdai, rsnd_mix_mod_get,               \
 843                                  rsnd_mix_of_node(rsnd_rdai_to_priv(rdai)), \
 844                                                   playback, capture)
 845
 846/*
 847 *      R-Car DVC
 848 */
 849int rsnd_dvc_probe(struct rsnd_priv *priv);
 850void rsnd_dvc_remove(struct rsnd_priv *priv);
 851struct rsnd_mod *rsnd_dvc_mod_get(struct rsnd_priv *priv, int id);
 852#define rsnd_dvc_of_node(priv) rsnd_parse_of_node(priv, RSND_NODE_DVC)
 853#define rsnd_parse_connect_dvc(rdai, playback, capture)                 \
 854        rsnd_parse_connect_common(rdai, rsnd_dvc_mod_get,               \
 855                                  rsnd_dvc_of_node(rsnd_rdai_to_priv(rdai)), \
 856                                                   playback, capture)
 857
 858/*
 859 *      R-Car CMD
 860 */
 861int rsnd_cmd_probe(struct rsnd_priv *priv);
 862void rsnd_cmd_remove(struct rsnd_priv *priv);
 863int rsnd_cmd_attach(struct rsnd_dai_stream *io, int id);
 864
 865void rsnd_mod_make_sure(struct rsnd_mod *mod, enum rsnd_mod_type type);
 866#ifdef DEBUG
 867#define rsnd_mod_confirm_ssi(mssi)      rsnd_mod_make_sure(mssi, RSND_MOD_SSI)
 868#define rsnd_mod_confirm_src(msrc)      rsnd_mod_make_sure(msrc, RSND_MOD_SRC)
 869#define rsnd_mod_confirm_dvc(mdvc)      rsnd_mod_make_sure(mdvc, RSND_MOD_DVC)
 870#else
 871#define rsnd_mod_confirm_ssi(mssi)
 872#define rsnd_mod_confirm_src(msrc)
 873#define rsnd_mod_confirm_dvc(mdvc)
 874#endif
 875
 876/*
 877 * If you don't need interrupt status debug message,
 878 * define RSND_DEBUG_NO_IRQ_STATUS as 1 on top of src.c/ssi.c
 879 *
 880 * #define RSND_DEBUG_NO_IRQ_STATUS 1
 881 */
 882#define rsnd_dbg_irq_status(dev, param...)              \
 883        if (!IS_BUILTIN(RSND_DEBUG_NO_IRQ_STATUS))      \
 884                dev_dbg(dev, param)
 885
 886/*
 887 * If you don't need rsnd_dai_call debug message,
 888 * define RSND_DEBUG_NO_DAI_CALL as 1 on top of core.c
 889 *
 890 * #define RSND_DEBUG_NO_DAI_CALL 1
 891 */
 892#define rsnd_dbg_dai_call(dev, param...)                \
 893        if (!IS_BUILTIN(RSND_DEBUG_NO_DAI_CALL))        \
 894                dev_dbg(dev, param)
 895
 896#endif
 897