linux/sound/soc/fsl/fsl_xcvr.c
<<
>>
Prefs
   1// SPDX-License-Identifier: GPL-2.0
   2// Copyright 2019 NXP
   3
   4#include <linux/bitrev.h>
   5#include <linux/clk.h>
   6#include <linux/firmware.h>
   7#include <linux/interrupt.h>
   8#include <linux/module.h>
   9#include <linux/of_platform.h>
  10#include <linux/pm_runtime.h>
  11#include <linux/regmap.h>
  12#include <linux/reset.h>
  13#include <sound/dmaengine_pcm.h>
  14#include <sound/pcm_iec958.h>
  15#include <sound/pcm_params.h>
  16
  17#include "fsl_xcvr.h"
  18#include "imx-pcm.h"
  19
  20#define FSL_XCVR_CAPDS_SIZE     256
  21
  22struct fsl_xcvr_soc_data {
  23        const char *fw_name;
  24};
  25
  26struct fsl_xcvr {
  27        const struct fsl_xcvr_soc_data *soc_data;
  28        struct platform_device *pdev;
  29        struct regmap *regmap;
  30        struct clk *ipg_clk;
  31        struct clk *pll_ipg_clk;
  32        struct clk *phy_clk;
  33        struct clk *spba_clk;
  34        struct reset_control *reset;
  35        u8 streams;
  36        u32 mode;
  37        u32 arc_mode;
  38        void __iomem *ram_addr;
  39        struct snd_dmaengine_dai_dma_data dma_prms_rx;
  40        struct snd_dmaengine_dai_dma_data dma_prms_tx;
  41        struct snd_aes_iec958 rx_iec958;
  42        struct snd_aes_iec958 tx_iec958;
  43        u8 cap_ds[FSL_XCVR_CAPDS_SIZE];
  44};
  45
  46static const struct fsl_xcvr_pll_conf {
  47        u8 mfi;   /* min=0x18, max=0x38 */
  48        u32 mfn;  /* signed int, 2's compl., min=0x3FFF0000, max=0x00010000 */
  49        u32 mfd;  /* unsigned int */
  50        u32 fout; /* Fout = Fref*(MFI + MFN/MFD), Fref is 24MHz */
  51} fsl_xcvr_pll_cfg[] = {
  52        { .mfi = 54, .mfn = 1,  .mfd = 6,   .fout = 1300000000, }, /* 1.3 GHz */
  53        { .mfi = 32, .mfn = 96, .mfd = 125, .fout = 786432000, },  /* 8000 Hz */
  54        { .mfi = 30, .mfn = 66, .mfd = 625, .fout = 722534400, },  /* 11025 Hz */
  55        { .mfi = 29, .mfn = 1,  .mfd = 6,   .fout = 700000000, },  /* 700 MHz */
  56};
  57
  58/*
  59 * HDMI2.1 spec defines 6- and 12-channels layout for one bit audio
  60 * stream. Todo: to check how this case can be considered below
  61 */
  62static const u32 fsl_xcvr_earc_channels[] = { 1, 2, 8, 16, 32, };
  63static const struct snd_pcm_hw_constraint_list fsl_xcvr_earc_channels_constr = {
  64        .count = ARRAY_SIZE(fsl_xcvr_earc_channels),
  65        .list = fsl_xcvr_earc_channels,
  66};
  67
  68static const u32 fsl_xcvr_earc_rates[] = {
  69        32000, 44100, 48000, 64000, 88200, 96000,
  70        128000, 176400, 192000, 256000, 352800, 384000,
  71        512000, 705600, 768000, 1024000, 1411200, 1536000,
  72};
  73static const struct snd_pcm_hw_constraint_list fsl_xcvr_earc_rates_constr = {
  74        .count = ARRAY_SIZE(fsl_xcvr_earc_rates),
  75        .list = fsl_xcvr_earc_rates,
  76};
  77
  78static const u32 fsl_xcvr_spdif_channels[] = { 2, };
  79static const struct snd_pcm_hw_constraint_list fsl_xcvr_spdif_channels_constr = {
  80        .count = ARRAY_SIZE(fsl_xcvr_spdif_channels),
  81        .list = fsl_xcvr_spdif_channels,
  82};
  83
  84static const u32 fsl_xcvr_spdif_rates[] = {
  85        32000, 44100, 48000, 88200, 96000, 176400, 192000,
  86};
  87static const struct snd_pcm_hw_constraint_list fsl_xcvr_spdif_rates_constr = {
  88        .count = ARRAY_SIZE(fsl_xcvr_spdif_rates),
  89        .list = fsl_xcvr_spdif_rates,
  90};
  91
  92static int fsl_xcvr_arc_mode_put(struct snd_kcontrol *kcontrol,
  93                                 struct snd_ctl_elem_value *ucontrol)
  94{
  95        struct snd_soc_dai *dai = snd_kcontrol_chip(kcontrol);
  96        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
  97        struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
  98        unsigned int *item = ucontrol->value.enumerated.item;
  99
 100        xcvr->arc_mode = snd_soc_enum_item_to_val(e, item[0]);
 101
 102        return 0;
 103}
 104
 105static int fsl_xcvr_arc_mode_get(struct snd_kcontrol *kcontrol,
 106                                 struct snd_ctl_elem_value *ucontrol)
 107{
 108        struct snd_soc_dai *dai = snd_kcontrol_chip(kcontrol);
 109        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 110
 111        ucontrol->value.enumerated.item[0] = xcvr->arc_mode;
 112
 113        return 0;
 114}
 115
 116static const u32 fsl_xcvr_phy_arc_cfg[] = {
 117        FSL_XCVR_PHY_CTRL_ARC_MODE_SE_EN, FSL_XCVR_PHY_CTRL_ARC_MODE_CM_EN,
 118};
 119
 120static const char * const fsl_xcvr_arc_mode[] = { "Single Ended", "Common", };
 121static const struct soc_enum fsl_xcvr_arc_mode_enum =
 122        SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(fsl_xcvr_arc_mode), fsl_xcvr_arc_mode);
 123static struct snd_kcontrol_new fsl_xcvr_arc_mode_kctl =
 124        SOC_ENUM_EXT("ARC Mode", fsl_xcvr_arc_mode_enum,
 125                     fsl_xcvr_arc_mode_get, fsl_xcvr_arc_mode_put);
 126
 127/* Capabilities data structure, bytes */
 128static int fsl_xcvr_type_capds_bytes_info(struct snd_kcontrol *kcontrol,
 129                                          struct snd_ctl_elem_info *uinfo)
 130{
 131        uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
 132        uinfo->count = FSL_XCVR_CAPDS_SIZE;
 133
 134        return 0;
 135}
 136
 137static int fsl_xcvr_capds_get(struct snd_kcontrol *kcontrol,
 138                              struct snd_ctl_elem_value *ucontrol)
 139{
 140        struct snd_soc_dai *dai = snd_kcontrol_chip(kcontrol);
 141        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 142
 143        memcpy(ucontrol->value.bytes.data, xcvr->cap_ds, FSL_XCVR_CAPDS_SIZE);
 144
 145        return 0;
 146}
 147
 148static int fsl_xcvr_capds_put(struct snd_kcontrol *kcontrol,
 149                              struct snd_ctl_elem_value *ucontrol)
 150{
 151        struct snd_soc_dai *dai = snd_kcontrol_chip(kcontrol);
 152        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 153
 154        memcpy(xcvr->cap_ds, ucontrol->value.bytes.data, FSL_XCVR_CAPDS_SIZE);
 155
 156        return 0;
 157}
 158
 159static struct snd_kcontrol_new fsl_xcvr_earc_capds_kctl = {
 160        .iface = SNDRV_CTL_ELEM_IFACE_PCM,
 161        .name = "Capabilities Data Structure",
 162        .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
 163        .info = fsl_xcvr_type_capds_bytes_info,
 164        .get = fsl_xcvr_capds_get,
 165        .put = fsl_xcvr_capds_put,
 166};
 167
 168static int fsl_xcvr_activate_ctl(struct snd_soc_dai *dai, const char *name,
 169                                 bool active)
 170{
 171        struct snd_soc_card *card = dai->component->card;
 172        struct snd_kcontrol *kctl;
 173        bool enabled;
 174
 175        kctl = snd_soc_card_get_kcontrol(card, name);
 176        if (kctl == NULL)
 177                return -ENOENT;
 178
 179        enabled = ((kctl->vd[0].access & SNDRV_CTL_ELEM_ACCESS_WRITE) != 0);
 180        if (active == enabled)
 181                return 0; /* nothing to do */
 182
 183        if (active)
 184                kctl->vd[0].access |=  SNDRV_CTL_ELEM_ACCESS_WRITE;
 185        else
 186                kctl->vd[0].access &= ~SNDRV_CTL_ELEM_ACCESS_WRITE;
 187
 188        snd_ctl_notify(card->snd_card, SNDRV_CTL_EVENT_MASK_INFO, &kctl->id);
 189
 190        return 1;
 191}
 192
 193static int fsl_xcvr_mode_put(struct snd_kcontrol *kcontrol,
 194                             struct snd_ctl_elem_value *ucontrol)
 195{
 196        struct snd_soc_dai *dai = snd_kcontrol_chip(kcontrol);
 197        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 198        struct soc_enum *e = (struct soc_enum *)kcontrol->private_value;
 199        unsigned int *item = ucontrol->value.enumerated.item;
 200        struct snd_soc_card *card = dai->component->card;
 201        struct snd_soc_pcm_runtime *rtd;
 202
 203        xcvr->mode = snd_soc_enum_item_to_val(e, item[0]);
 204
 205        fsl_xcvr_activate_ctl(dai, fsl_xcvr_arc_mode_kctl.name,
 206                              (xcvr->mode == FSL_XCVR_MODE_ARC));
 207        fsl_xcvr_activate_ctl(dai, fsl_xcvr_earc_capds_kctl.name,
 208                              (xcvr->mode == FSL_XCVR_MODE_EARC));
 209        /* Allow playback for SPDIF only */
 210        rtd = snd_soc_get_pcm_runtime(card, card->dai_link);
 211        rtd->pcm->streams[SNDRV_PCM_STREAM_PLAYBACK].substream_count =
 212                (xcvr->mode == FSL_XCVR_MODE_SPDIF ? 1 : 0);
 213        return 0;
 214}
 215
 216static int fsl_xcvr_mode_get(struct snd_kcontrol *kcontrol,
 217                             struct snd_ctl_elem_value *ucontrol)
 218{
 219        struct snd_soc_dai *dai = snd_kcontrol_chip(kcontrol);
 220        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 221
 222        ucontrol->value.enumerated.item[0] = xcvr->mode;
 223
 224        return 0;
 225}
 226
 227static const char * const fsl_xcvr_mode[] = { "SPDIF", "ARC RX", "eARC", };
 228static const struct soc_enum fsl_xcvr_mode_enum =
 229        SOC_ENUM_SINGLE_EXT(ARRAY_SIZE(fsl_xcvr_mode), fsl_xcvr_mode);
 230static struct snd_kcontrol_new fsl_xcvr_mode_kctl =
 231        SOC_ENUM_EXT("XCVR Mode", fsl_xcvr_mode_enum,
 232                     fsl_xcvr_mode_get, fsl_xcvr_mode_put);
 233
 234/** phy: true => phy, false => pll */
 235static int fsl_xcvr_ai_write(struct fsl_xcvr *xcvr, u8 reg, u32 data, bool phy)
 236{
 237        struct device *dev = &xcvr->pdev->dev;
 238        u32 val, idx, tidx;
 239        int ret;
 240
 241        idx  = BIT(phy ? 26 : 24);
 242        tidx = BIT(phy ? 27 : 25);
 243
 244        regmap_write(xcvr->regmap, FSL_XCVR_PHY_AI_CTRL_CLR, 0xFF);
 245        regmap_write(xcvr->regmap, FSL_XCVR_PHY_AI_CTRL_SET, reg);
 246        regmap_write(xcvr->regmap, FSL_XCVR_PHY_AI_WDATA, data);
 247        regmap_write(xcvr->regmap, FSL_XCVR_PHY_AI_CTRL_TOG, idx);
 248
 249        ret = regmap_read_poll_timeout(xcvr->regmap, FSL_XCVR_PHY_AI_CTRL, val,
 250                                       (val & idx) == ((val & tidx) >> 1),
 251                                       10, 10000);
 252        if (ret)
 253                dev_err(dev, "AI timeout: failed to set %s reg 0x%02x=0x%08x\n",
 254                        phy ? "PHY" : "PLL", reg, data);
 255        return ret;
 256}
 257
 258static int fsl_xcvr_en_phy_pll(struct fsl_xcvr *xcvr, u32 freq, bool tx)
 259{
 260        struct device *dev = &xcvr->pdev->dev;
 261        u32 i, div = 0, log2;
 262        int ret;
 263
 264        for (i = 0; i < ARRAY_SIZE(fsl_xcvr_pll_cfg); i++) {
 265                if (fsl_xcvr_pll_cfg[i].fout % freq == 0) {
 266                        div = fsl_xcvr_pll_cfg[i].fout / freq;
 267                        break;
 268                }
 269        }
 270
 271        if (!div || i >= ARRAY_SIZE(fsl_xcvr_pll_cfg))
 272                return -EINVAL;
 273
 274        log2 = ilog2(div);
 275
 276        /* Release AI interface from reset */
 277        ret = regmap_write(xcvr->regmap, FSL_XCVR_PHY_AI_CTRL_SET,
 278                           FSL_XCVR_PHY_AI_CTRL_AI_RESETN);
 279        if (ret < 0) {
 280                dev_err(dev, "Error while setting IER0: %d\n", ret);
 281                return ret;
 282        }
 283
 284        /* PLL: BANDGAP_SET: EN_VBG (enable bandgap) */
 285        fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_BANDGAP_SET,
 286                          FSL_XCVR_PLL_BANDGAP_EN_VBG, 0);
 287
 288        /* PLL: CTRL0: DIV_INTEGER */
 289        fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_CTRL0, fsl_xcvr_pll_cfg[i].mfi, 0);
 290        /* PLL: NUMERATOR: MFN */
 291        fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_NUM, fsl_xcvr_pll_cfg[i].mfn, 0);
 292        /* PLL: DENOMINATOR: MFD */
 293        fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_DEN, fsl_xcvr_pll_cfg[i].mfd, 0);
 294        /* PLL: CTRL0_SET: HOLD_RING_OFF, POWER_UP */
 295        fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_CTRL0_SET,
 296                          FSL_XCVR_PLL_CTRL0_HROFF | FSL_XCVR_PLL_CTRL0_PWP, 0);
 297        udelay(25);
 298        /* PLL: CTRL0: Clear Hold Ring Off */
 299        fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_CTRL0_CLR,
 300                          FSL_XCVR_PLL_CTRL0_HROFF, 0);
 301        udelay(100);
 302        if (tx) { /* TX is enabled for SPDIF only */
 303                /* PLL: POSTDIV: PDIV0 */
 304                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_PDIV,
 305                                  FSL_XCVR_PLL_PDIVx(log2, 0), 0);
 306                /* PLL: CTRL_SET: CLKMUX0_EN */
 307                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_CTRL0_SET,
 308                                  FSL_XCVR_PLL_CTRL0_CM0_EN, 0);
 309        } else if (xcvr->mode == FSL_XCVR_MODE_EARC) { /* eARC RX */
 310                /* PLL: POSTDIV: PDIV1 */
 311                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_PDIV,
 312                                  FSL_XCVR_PLL_PDIVx(log2, 1), 0);
 313                /* PLL: CTRL_SET: CLKMUX1_EN */
 314                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_CTRL0_SET,
 315                                  FSL_XCVR_PLL_CTRL0_CM1_EN, 0);
 316        } else { /* SPDIF / ARC RX */
 317                /* PLL: POSTDIV: PDIV2 */
 318                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_PDIV,
 319                                  FSL_XCVR_PLL_PDIVx(log2, 2), 0);
 320                /* PLL: CTRL_SET: CLKMUX2_EN */
 321                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PLL_CTRL0_SET,
 322                                  FSL_XCVR_PLL_CTRL0_CM2_EN, 0);
 323        }
 324
 325        if (xcvr->mode == FSL_XCVR_MODE_EARC) { /* eARC mode */
 326                /* PHY: CTRL_SET: TX_DIFF_OE, PHY_EN */
 327                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PHY_CTRL_SET,
 328                                  FSL_XCVR_PHY_CTRL_TSDIFF_OE |
 329                                  FSL_XCVR_PHY_CTRL_PHY_EN, 1);
 330                /* PHY: CTRL2_SET: EARC_TX_MODE */
 331                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PHY_CTRL2_SET,
 332                                  FSL_XCVR_PHY_CTRL2_EARC_TXMS, 1);
 333        } else if (!tx) { /* SPDIF / ARC RX mode */
 334                if (xcvr->mode == FSL_XCVR_MODE_SPDIF)
 335                        /* PHY: CTRL_SET: SPDIF_EN */
 336                        fsl_xcvr_ai_write(xcvr, FSL_XCVR_PHY_CTRL_SET,
 337                                          FSL_XCVR_PHY_CTRL_SPDIF_EN, 1);
 338                else    /* PHY: CTRL_SET: ARC RX setup */
 339                        fsl_xcvr_ai_write(xcvr, FSL_XCVR_PHY_CTRL_SET,
 340                                          FSL_XCVR_PHY_CTRL_PHY_EN |
 341                                          FSL_XCVR_PHY_CTRL_RX_CM_EN |
 342                                          fsl_xcvr_phy_arc_cfg[xcvr->arc_mode], 1);
 343        }
 344
 345        dev_dbg(dev, "PLL Fexp: %u, Fout: %u, mfi: %u, mfn: %u, mfd: %d, div: %u, pdiv0: %u\n",
 346                freq, fsl_xcvr_pll_cfg[i].fout, fsl_xcvr_pll_cfg[i].mfi,
 347                fsl_xcvr_pll_cfg[i].mfn, fsl_xcvr_pll_cfg[i].mfd, div, log2);
 348        return 0;
 349}
 350
 351static int fsl_xcvr_en_aud_pll(struct fsl_xcvr *xcvr, u32 freq)
 352{
 353        struct device *dev = &xcvr->pdev->dev;
 354        int ret;
 355
 356        clk_disable_unprepare(xcvr->phy_clk);
 357        ret = clk_set_rate(xcvr->phy_clk, freq);
 358        if (ret < 0) {
 359                dev_err(dev, "Error while setting AUD PLL rate: %d\n", ret);
 360                return ret;
 361        }
 362        ret = clk_prepare_enable(xcvr->phy_clk);
 363        if (ret) {
 364                dev_err(dev, "failed to start PHY clock: %d\n", ret);
 365                return ret;
 366        }
 367
 368        /* Release AI interface from reset */
 369        ret = regmap_write(xcvr->regmap, FSL_XCVR_PHY_AI_CTRL_SET,
 370                           FSL_XCVR_PHY_AI_CTRL_AI_RESETN);
 371        if (ret < 0) {
 372                dev_err(dev, "Error while setting IER0: %d\n", ret);
 373                return ret;
 374        }
 375
 376        if (xcvr->mode == FSL_XCVR_MODE_EARC) { /* eARC mode */
 377                /* PHY: CTRL_SET: TX_DIFF_OE, PHY_EN */
 378                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PHY_CTRL_SET,
 379                                  FSL_XCVR_PHY_CTRL_TSDIFF_OE |
 380                                  FSL_XCVR_PHY_CTRL_PHY_EN, 1);
 381                /* PHY: CTRL2_SET: EARC_TX_MODE */
 382                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PHY_CTRL2_SET,
 383                                  FSL_XCVR_PHY_CTRL2_EARC_TXMS, 1);
 384        } else { /* SPDIF mode */
 385                /* PHY: CTRL_SET: TX_CLK_AUD_SS | SPDIF_EN */
 386                fsl_xcvr_ai_write(xcvr, FSL_XCVR_PHY_CTRL_SET,
 387                                  FSL_XCVR_PHY_CTRL_TX_CLK_AUD_SS |
 388                                  FSL_XCVR_PHY_CTRL_SPDIF_EN, 1);
 389        }
 390
 391        dev_dbg(dev, "PLL Fexp: %u\n", freq);
 392
 393        return 0;
 394}
 395
 396#define FSL_XCVR_SPDIF_RX_FREQ  175000000
 397static int fsl_xcvr_prepare(struct snd_pcm_substream *substream,
 398                            struct snd_soc_dai *dai)
 399{
 400        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 401        bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
 402        u32 m_ctl = 0, v_ctl = 0;
 403        u32 r = substream->runtime->rate, ch = substream->runtime->channels;
 404        u32 fout = 32 * r * ch * 10 * 2;
 405        int ret = 0;
 406
 407        switch (xcvr->mode) {
 408        case FSL_XCVR_MODE_SPDIF:
 409        case FSL_XCVR_MODE_ARC:
 410                if (tx) {
 411                        ret = fsl_xcvr_en_aud_pll(xcvr, fout);
 412                        if (ret < 0) {
 413                                dev_err(dai->dev, "Failed to set TX freq %u: %d\n",
 414                                        fout, ret);
 415                                return ret;
 416                        }
 417
 418                        ret = regmap_write(xcvr->regmap, FSL_XCVR_TX_DPTH_CTRL_SET,
 419                                           FSL_XCVR_TX_DPTH_CTRL_FRM_FMT);
 420                        if (ret < 0) {
 421                                dev_err(dai->dev, "Failed to set TX_DPTH: %d\n", ret);
 422                                return ret;
 423                        }
 424
 425                        /**
 426                         * set SPDIF MODE - this flag is used to gate
 427                         * SPDIF output, useless for SPDIF RX
 428                         */
 429                        m_ctl |= FSL_XCVR_EXT_CTRL_SPDIF_MODE;
 430                        v_ctl |= FSL_XCVR_EXT_CTRL_SPDIF_MODE;
 431                } else {
 432                        /**
 433                         * Clear RX FIFO, flip RX FIFO bits,
 434                         * disable eARC related HW mode detects
 435                         */
 436                        ret = regmap_write(xcvr->regmap, FSL_XCVR_RX_DPTH_CTRL_SET,
 437                                           FSL_XCVR_RX_DPTH_CTRL_STORE_FMT |
 438                                           FSL_XCVR_RX_DPTH_CTRL_CLR_RX_FIFO |
 439                                           FSL_XCVR_RX_DPTH_CTRL_COMP |
 440                                           FSL_XCVR_RX_DPTH_CTRL_LAYB_CTRL);
 441                        if (ret < 0) {
 442                                dev_err(dai->dev, "Failed to set RX_DPTH: %d\n", ret);
 443                                return ret;
 444                        }
 445
 446                        ret = fsl_xcvr_en_phy_pll(xcvr, FSL_XCVR_SPDIF_RX_FREQ, tx);
 447                        if (ret < 0) {
 448                                dev_err(dai->dev, "Failed to set RX freq %u: %d\n",
 449                                        FSL_XCVR_SPDIF_RX_FREQ, ret);
 450                                return ret;
 451                        }
 452                }
 453                break;
 454        case FSL_XCVR_MODE_EARC:
 455                if (!tx) {
 456                        /** Clear RX FIFO, flip RX FIFO bits */
 457                        ret = regmap_write(xcvr->regmap, FSL_XCVR_RX_DPTH_CTRL_SET,
 458                                           FSL_XCVR_RX_DPTH_CTRL_STORE_FMT |
 459                                           FSL_XCVR_RX_DPTH_CTRL_CLR_RX_FIFO);
 460                        if (ret < 0) {
 461                                dev_err(dai->dev, "Failed to set RX_DPTH: %d\n", ret);
 462                                return ret;
 463                        }
 464
 465                        /** Enable eARC related HW mode detects */
 466                        ret = regmap_write(xcvr->regmap, FSL_XCVR_RX_DPTH_CTRL_CLR,
 467                                           FSL_XCVR_RX_DPTH_CTRL_COMP |
 468                                           FSL_XCVR_RX_DPTH_CTRL_LAYB_CTRL);
 469                        if (ret < 0) {
 470                                dev_err(dai->dev, "Failed to clr TX_DPTH: %d\n", ret);
 471                                return ret;
 472                        }
 473                }
 474
 475                /* clear CMDC RESET */
 476                m_ctl |= FSL_XCVR_EXT_CTRL_CMDC_RESET(tx);
 477                /* set TX_RX_MODE */
 478                m_ctl |= FSL_XCVR_EXT_CTRL_TX_RX_MODE;
 479                v_ctl |= (tx ? FSL_XCVR_EXT_CTRL_TX_RX_MODE : 0);
 480                break;
 481        }
 482
 483        ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_IER0,
 484                                 FSL_XCVR_IRQ_EARC_ALL, FSL_XCVR_IRQ_EARC_ALL);
 485        if (ret < 0) {
 486                dev_err(dai->dev, "Error while setting IER0: %d\n", ret);
 487                return ret;
 488        }
 489
 490        /* set DPATH RESET */
 491        m_ctl |= FSL_XCVR_EXT_CTRL_DPTH_RESET(tx);
 492        v_ctl |= FSL_XCVR_EXT_CTRL_DPTH_RESET(tx);
 493        ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_CTRL, m_ctl, v_ctl);
 494        if (ret < 0) {
 495                dev_err(dai->dev, "Error while setting EXT_CTRL: %d\n", ret);
 496                return ret;
 497        }
 498
 499        return 0;
 500}
 501
 502static int fsl_xcvr_constr(const struct snd_pcm_substream *substream,
 503                           const struct snd_pcm_hw_constraint_list *channels,
 504                           const struct snd_pcm_hw_constraint_list *rates)
 505{
 506        struct snd_pcm_runtime *rt = substream->runtime;
 507        int ret;
 508
 509        ret = snd_pcm_hw_constraint_list(rt, 0, SNDRV_PCM_HW_PARAM_CHANNELS,
 510                                         channels);
 511        if (ret < 0)
 512                return ret;
 513
 514        ret = snd_pcm_hw_constraint_list(rt, 0, SNDRV_PCM_HW_PARAM_RATE,
 515                                         rates);
 516        if (ret < 0)
 517                return ret;
 518
 519        return 0;
 520}
 521
 522static int fsl_xcvr_startup(struct snd_pcm_substream *substream,
 523                            struct snd_soc_dai *dai)
 524{
 525        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 526        bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
 527        int ret = 0;
 528
 529        if (xcvr->streams & BIT(substream->stream)) {
 530                dev_err(dai->dev, "%sX busy\n", tx ? "T" : "R");
 531                return -EBUSY;
 532        }
 533
 534        switch (xcvr->mode) {
 535        case FSL_XCVR_MODE_SPDIF:
 536        case FSL_XCVR_MODE_ARC:
 537                ret = fsl_xcvr_constr(substream, &fsl_xcvr_spdif_channels_constr,
 538                                      &fsl_xcvr_spdif_rates_constr);
 539                break;
 540        case FSL_XCVR_MODE_EARC:
 541                ret = fsl_xcvr_constr(substream, &fsl_xcvr_earc_channels_constr,
 542                                      &fsl_xcvr_earc_rates_constr);
 543                break;
 544        }
 545        if (ret < 0)
 546                return ret;
 547
 548        xcvr->streams |= BIT(substream->stream);
 549
 550        /* Disable XCVR controls if there is stream started */
 551        fsl_xcvr_activate_ctl(dai, fsl_xcvr_mode_kctl.name, false);
 552        fsl_xcvr_activate_ctl(dai, fsl_xcvr_arc_mode_kctl.name, false);
 553        fsl_xcvr_activate_ctl(dai, fsl_xcvr_earc_capds_kctl.name, false);
 554
 555        return 0;
 556}
 557
 558static void fsl_xcvr_shutdown(struct snd_pcm_substream *substream,
 559                              struct snd_soc_dai *dai)
 560{
 561        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 562        bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
 563        u32 mask = 0, val = 0;
 564        int ret;
 565
 566        xcvr->streams &= ~BIT(substream->stream);
 567
 568        /* Enable XCVR controls if there is no stream started */
 569        if (!xcvr->streams) {
 570                fsl_xcvr_activate_ctl(dai, fsl_xcvr_mode_kctl.name, true);
 571                fsl_xcvr_activate_ctl(dai, fsl_xcvr_arc_mode_kctl.name,
 572                                      (xcvr->mode == FSL_XCVR_MODE_ARC));
 573                fsl_xcvr_activate_ctl(dai, fsl_xcvr_earc_capds_kctl.name,
 574                                      (xcvr->mode == FSL_XCVR_MODE_EARC));
 575
 576                ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_IER0,
 577                                         FSL_XCVR_IRQ_EARC_ALL, 0);
 578                if (ret < 0) {
 579                        dev_err(dai->dev, "Failed to set IER0: %d\n", ret);
 580                        return;
 581                }
 582
 583                /* clear SPDIF MODE */
 584                if (xcvr->mode == FSL_XCVR_MODE_SPDIF)
 585                        mask |= FSL_XCVR_EXT_CTRL_SPDIF_MODE;
 586        }
 587
 588        if (xcvr->mode == FSL_XCVR_MODE_EARC) {
 589                /* set CMDC RESET */
 590                mask |= FSL_XCVR_EXT_CTRL_CMDC_RESET(tx);
 591                val  |= FSL_XCVR_EXT_CTRL_CMDC_RESET(tx);
 592        }
 593
 594        ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_CTRL, mask, val);
 595        if (ret < 0) {
 596                dev_err(dai->dev, "Err setting DPATH RESET: %d\n", ret);
 597                return;
 598        }
 599}
 600
 601static int fsl_xcvr_trigger(struct snd_pcm_substream *substream, int cmd,
 602                            struct snd_soc_dai *dai)
 603{
 604        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 605        bool tx = substream->stream == SNDRV_PCM_STREAM_PLAYBACK;
 606        int ret;
 607
 608        switch (cmd) {
 609        case SNDRV_PCM_TRIGGER_START:
 610        case SNDRV_PCM_TRIGGER_RESUME:
 611        case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
 612                if (tx) {
 613                        switch (xcvr->mode) {
 614                        case FSL_XCVR_MODE_EARC:
 615                                /* set isr_cmdc_tx_en, w1c */
 616                                ret = regmap_write(xcvr->regmap,
 617                                                   FSL_XCVR_ISR_SET,
 618                                                   FSL_XCVR_ISR_CMDC_TX_EN);
 619                                if (ret < 0) {
 620                                        dev_err(dai->dev, "err updating isr %d\n", ret);
 621                                        return ret;
 622                                }
 623                                fallthrough;
 624                        case FSL_XCVR_MODE_SPDIF:
 625                                ret = regmap_write(xcvr->regmap,
 626                                         FSL_XCVR_TX_DPTH_CTRL_SET,
 627                                         FSL_XCVR_TX_DPTH_CTRL_STRT_DATA_TX);
 628                                if (ret < 0) {
 629                                        dev_err(dai->dev, "Failed to start DATA_TX: %d\n", ret);
 630                                        return ret;
 631                                }
 632                                break;
 633                        }
 634                }
 635
 636                /* enable DMA RD/WR */
 637                ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_CTRL,
 638                                         FSL_XCVR_EXT_CTRL_DMA_DIS(tx), 0);
 639                if (ret < 0) {
 640                        dev_err(dai->dev, "Failed to enable DMA: %d\n", ret);
 641                        return ret;
 642                }
 643
 644                /* clear DPATH RESET */
 645                ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_CTRL,
 646                                         FSL_XCVR_EXT_CTRL_DPTH_RESET(tx),
 647                                         0);
 648                if (ret < 0) {
 649                        dev_err(dai->dev, "Failed to clear DPATH RESET: %d\n", ret);
 650                        return ret;
 651                }
 652
 653                break;
 654        case SNDRV_PCM_TRIGGER_STOP:
 655        case SNDRV_PCM_TRIGGER_SUSPEND:
 656        case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
 657                /* disable DMA RD/WR */
 658                ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_CTRL,
 659                                         FSL_XCVR_EXT_CTRL_DMA_DIS(tx),
 660                                         FSL_XCVR_EXT_CTRL_DMA_DIS(tx));
 661                if (ret < 0) {
 662                        dev_err(dai->dev, "Failed to disable DMA: %d\n", ret);
 663                        return ret;
 664                }
 665
 666                if (tx) {
 667                        switch (xcvr->mode) {
 668                        case FSL_XCVR_MODE_SPDIF:
 669                                ret = regmap_write(xcvr->regmap,
 670                                         FSL_XCVR_TX_DPTH_CTRL_CLR,
 671                                         FSL_XCVR_TX_DPTH_CTRL_STRT_DATA_TX);
 672                                if (ret < 0) {
 673                                        dev_err(dai->dev, "Failed to stop DATA_TX: %d\n", ret);
 674                                        return ret;
 675                                }
 676                                fallthrough;
 677                        case FSL_XCVR_MODE_EARC:
 678                                /* clear ISR_CMDC_TX_EN, W1C */
 679                                ret = regmap_write(xcvr->regmap,
 680                                                   FSL_XCVR_ISR_CLR,
 681                                                   FSL_XCVR_ISR_CMDC_TX_EN);
 682                                if (ret < 0) {
 683                                        dev_err(dai->dev,
 684                                                "Err updating ISR %d\n", ret);
 685                                        return ret;
 686                                }
 687                                break;
 688                        }
 689                }
 690                break;
 691        default:
 692                return -EINVAL;
 693        }
 694
 695        return 0;
 696}
 697
 698static int fsl_xcvr_load_firmware(struct fsl_xcvr *xcvr)
 699{
 700        struct device *dev = &xcvr->pdev->dev;
 701        const struct firmware *fw;
 702        int ret = 0, rem, off, out, page = 0, size = FSL_XCVR_REG_OFFSET;
 703        u32 mask, val;
 704
 705        ret = request_firmware(&fw, xcvr->soc_data->fw_name, dev);
 706        if (ret) {
 707                dev_err(dev, "failed to request firmware.\n");
 708                return ret;
 709        }
 710
 711        rem = fw->size;
 712
 713        /* RAM is 20KiB = 16KiB code + 4KiB data => max 10 pages 2KiB each */
 714        if (rem > 16384) {
 715                dev_err(dev, "FW size %d is bigger than 16KiB.\n", rem);
 716                release_firmware(fw);
 717                return -ENOMEM;
 718        }
 719
 720        for (page = 0; page < 10; page++) {
 721                ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_CTRL,
 722                                         FSL_XCVR_EXT_CTRL_PAGE_MASK,
 723                                         FSL_XCVR_EXT_CTRL_PAGE(page));
 724                if (ret < 0) {
 725                        dev_err(dev, "FW: failed to set page %d, err=%d\n",
 726                                page, ret);
 727                        goto err_firmware;
 728                }
 729
 730                off = page * size;
 731                out = min(rem, size);
 732                /* IPG clock is assumed to be running, otherwise it will hang */
 733                if (out > 0) {
 734                        /* write firmware into code memory */
 735                        memcpy_toio(xcvr->ram_addr, fw->data + off, out);
 736                        rem -= out;
 737                        if (rem == 0) {
 738                                /* last part of firmware written */
 739                                /* clean remaining part of code memory page */
 740                                memset_io(xcvr->ram_addr + out, 0, size - out);
 741                        }
 742                } else {
 743                        /* clean current page, including data memory */
 744                        memset_io(xcvr->ram_addr, 0, size);
 745                }
 746        }
 747
 748err_firmware:
 749        release_firmware(fw);
 750        if (ret < 0)
 751                return ret;
 752
 753        /* configure watermarks */
 754        mask = FSL_XCVR_EXT_CTRL_RX_FWM_MASK | FSL_XCVR_EXT_CTRL_TX_FWM_MASK;
 755        val  = FSL_XCVR_EXT_CTRL_RX_FWM(FSL_XCVR_FIFO_WMK_RX);
 756        val |= FSL_XCVR_EXT_CTRL_TX_FWM(FSL_XCVR_FIFO_WMK_TX);
 757        /* disable DMA RD/WR */
 758        mask |= FSL_XCVR_EXT_CTRL_DMA_RD_DIS | FSL_XCVR_EXT_CTRL_DMA_WR_DIS;
 759        val  |= FSL_XCVR_EXT_CTRL_DMA_RD_DIS | FSL_XCVR_EXT_CTRL_DMA_WR_DIS;
 760        /* Data RAM is 4KiB, last two pages: 8 and 9. Select page 8. */
 761        mask |= FSL_XCVR_EXT_CTRL_PAGE_MASK;
 762        val  |= FSL_XCVR_EXT_CTRL_PAGE(8);
 763
 764        ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_CTRL, mask, val);
 765        if (ret < 0) {
 766                dev_err(dev, "Failed to set watermarks: %d\n", ret);
 767                return ret;
 768        }
 769
 770        /* Store Capabilities Data Structure into Data RAM */
 771        memcpy_toio(xcvr->ram_addr + FSL_XCVR_CAP_DATA_STR, xcvr->cap_ds,
 772                    FSL_XCVR_CAPDS_SIZE);
 773        return 0;
 774}
 775
 776static int fsl_xcvr_type_iec958_info(struct snd_kcontrol *kcontrol,
 777                                     struct snd_ctl_elem_info *uinfo)
 778{
 779        uinfo->type = SNDRV_CTL_ELEM_TYPE_IEC958;
 780        uinfo->count = 1;
 781
 782        return 0;
 783}
 784
 785static int fsl_xcvr_type_iec958_bytes_info(struct snd_kcontrol *kcontrol,
 786                                           struct snd_ctl_elem_info *uinfo)
 787{
 788        uinfo->type = SNDRV_CTL_ELEM_TYPE_BYTES;
 789        uinfo->count = sizeof_field(struct snd_aes_iec958, status);
 790
 791        return 0;
 792}
 793
 794static int fsl_xcvr_rx_cs_get(struct snd_kcontrol *kcontrol,
 795                              struct snd_ctl_elem_value *ucontrol)
 796{
 797        struct snd_soc_dai *dai = snd_kcontrol_chip(kcontrol);
 798        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 799
 800        memcpy(ucontrol->value.iec958.status, xcvr->rx_iec958.status, 24);
 801
 802        return 0;
 803}
 804
 805static int fsl_xcvr_tx_cs_get(struct snd_kcontrol *kcontrol,
 806                              struct snd_ctl_elem_value *ucontrol)
 807{
 808        struct snd_soc_dai *dai = snd_kcontrol_chip(kcontrol);
 809        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 810
 811        memcpy(ucontrol->value.iec958.status, xcvr->tx_iec958.status, 24);
 812
 813        return 0;
 814}
 815
 816static int fsl_xcvr_tx_cs_put(struct snd_kcontrol *kcontrol,
 817                              struct snd_ctl_elem_value *ucontrol)
 818{
 819        struct snd_soc_dai *dai = snd_kcontrol_chip(kcontrol);
 820        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 821
 822        memcpy(xcvr->tx_iec958.status, ucontrol->value.iec958.status, 24);
 823
 824        return 0;
 825}
 826
 827static struct snd_kcontrol_new fsl_xcvr_rx_ctls[] = {
 828        /* Channel status controller */
 829        {
 830                .iface = SNDRV_CTL_ELEM_IFACE_PCM,
 831                .name = SNDRV_CTL_NAME_IEC958("", CAPTURE, DEFAULT),
 832                .access = SNDRV_CTL_ELEM_ACCESS_READ,
 833                .info = fsl_xcvr_type_iec958_info,
 834                .get = fsl_xcvr_rx_cs_get,
 835        },
 836        /* Capture channel status, bytes */
 837        {
 838                .iface = SNDRV_CTL_ELEM_IFACE_PCM,
 839                .name = "Capture Channel Status",
 840                .access = SNDRV_CTL_ELEM_ACCESS_READ,
 841                .info = fsl_xcvr_type_iec958_bytes_info,
 842                .get = fsl_xcvr_rx_cs_get,
 843        },
 844};
 845
 846static struct snd_kcontrol_new fsl_xcvr_tx_ctls[] = {
 847        /* Channel status controller */
 848        {
 849                .iface = SNDRV_CTL_ELEM_IFACE_PCM,
 850                .name = SNDRV_CTL_NAME_IEC958("", PLAYBACK, DEFAULT),
 851                .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
 852                .info = fsl_xcvr_type_iec958_info,
 853                .get = fsl_xcvr_tx_cs_get,
 854                .put = fsl_xcvr_tx_cs_put,
 855        },
 856        /* Playback channel status, bytes */
 857        {
 858                .iface = SNDRV_CTL_ELEM_IFACE_PCM,
 859                .name = "Playback Channel Status",
 860                .access = SNDRV_CTL_ELEM_ACCESS_READWRITE,
 861                .info = fsl_xcvr_type_iec958_bytes_info,
 862                .get = fsl_xcvr_tx_cs_get,
 863                .put = fsl_xcvr_tx_cs_put,
 864        },
 865};
 866
 867static const struct snd_soc_dai_ops fsl_xcvr_dai_ops = {
 868        .prepare = fsl_xcvr_prepare,
 869        .startup = fsl_xcvr_startup,
 870        .shutdown = fsl_xcvr_shutdown,
 871        .trigger = fsl_xcvr_trigger,
 872};
 873
 874static int fsl_xcvr_dai_probe(struct snd_soc_dai *dai)
 875{
 876        struct fsl_xcvr *xcvr = snd_soc_dai_get_drvdata(dai);
 877
 878        snd_soc_dai_init_dma_data(dai, &xcvr->dma_prms_tx, &xcvr->dma_prms_rx);
 879
 880        snd_soc_add_dai_controls(dai, &fsl_xcvr_mode_kctl, 1);
 881        snd_soc_add_dai_controls(dai, &fsl_xcvr_arc_mode_kctl, 1);
 882        snd_soc_add_dai_controls(dai, &fsl_xcvr_earc_capds_kctl, 1);
 883        snd_soc_add_dai_controls(dai, fsl_xcvr_tx_ctls,
 884                                 ARRAY_SIZE(fsl_xcvr_tx_ctls));
 885        snd_soc_add_dai_controls(dai, fsl_xcvr_rx_ctls,
 886                                 ARRAY_SIZE(fsl_xcvr_rx_ctls));
 887        return 0;
 888}
 889
 890static struct snd_soc_dai_driver fsl_xcvr_dai = {
 891        .probe  = fsl_xcvr_dai_probe,
 892        .ops = &fsl_xcvr_dai_ops,
 893        .playback = {
 894                .stream_name = "CPU-Playback",
 895                .channels_min = 1,
 896                .channels_max = 32,
 897                .rate_min = 32000,
 898                .rate_max = 1536000,
 899                .rates = SNDRV_PCM_RATE_KNOT,
 900                .formats = SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE,
 901        },
 902        .capture = {
 903                .stream_name = "CPU-Capture",
 904                .channels_min = 1,
 905                .channels_max = 32,
 906                .rate_min = 32000,
 907                .rate_max = 1536000,
 908                .rates = SNDRV_PCM_RATE_KNOT,
 909                .formats = SNDRV_PCM_FMTBIT_IEC958_SUBFRAME_LE,
 910        },
 911};
 912
 913static const struct snd_soc_component_driver fsl_xcvr_comp = {
 914        .name = "fsl-xcvr-dai",
 915};
 916
 917static const struct reg_default fsl_xcvr_reg_defaults[] = {
 918        { FSL_XCVR_VERSION,     0x00000000 },
 919        { FSL_XCVR_EXT_CTRL,    0xF8204040 },
 920        { FSL_XCVR_EXT_STATUS,  0x00000000 },
 921        { FSL_XCVR_EXT_IER0,    0x00000000 },
 922        { FSL_XCVR_EXT_IER1,    0x00000000 },
 923        { FSL_XCVR_EXT_ISR,     0x00000000 },
 924        { FSL_XCVR_EXT_ISR_SET, 0x00000000 },
 925        { FSL_XCVR_EXT_ISR_CLR, 0x00000000 },
 926        { FSL_XCVR_EXT_ISR_TOG, 0x00000000 },
 927        { FSL_XCVR_IER,         0x00000000 },
 928        { FSL_XCVR_ISR,         0x00000000 },
 929        { FSL_XCVR_ISR_SET,     0x00000000 },
 930        { FSL_XCVR_ISR_CLR,     0x00000000 },
 931        { FSL_XCVR_ISR_TOG,     0x00000000 },
 932        { FSL_XCVR_RX_DPTH_CTRL,        0x00002C89 },
 933        { FSL_XCVR_RX_DPTH_CTRL_SET,    0x00002C89 },
 934        { FSL_XCVR_RX_DPTH_CTRL_CLR,    0x00002C89 },
 935        { FSL_XCVR_RX_DPTH_CTRL_TOG,    0x00002C89 },
 936        { FSL_XCVR_TX_DPTH_CTRL,        0x00000000 },
 937        { FSL_XCVR_TX_DPTH_CTRL_SET,    0x00000000 },
 938        { FSL_XCVR_TX_DPTH_CTRL_CLR,    0x00000000 },
 939        { FSL_XCVR_TX_DPTH_CTRL_TOG,    0x00000000 },
 940        { FSL_XCVR_TX_CS_DATA_0,        0x00000000 },
 941        { FSL_XCVR_TX_CS_DATA_1,        0x00000000 },
 942        { FSL_XCVR_TX_CS_DATA_2,        0x00000000 },
 943        { FSL_XCVR_TX_CS_DATA_3,        0x00000000 },
 944        { FSL_XCVR_TX_CS_DATA_4,        0x00000000 },
 945        { FSL_XCVR_TX_CS_DATA_5,        0x00000000 },
 946        { FSL_XCVR_DEBUG_REG_0,         0x00000000 },
 947        { FSL_XCVR_DEBUG_REG_1,         0x00000000 },
 948};
 949
 950static bool fsl_xcvr_readable_reg(struct device *dev, unsigned int reg)
 951{
 952        switch (reg) {
 953        case FSL_XCVR_VERSION:
 954        case FSL_XCVR_EXT_CTRL:
 955        case FSL_XCVR_EXT_STATUS:
 956        case FSL_XCVR_EXT_IER0:
 957        case FSL_XCVR_EXT_IER1:
 958        case FSL_XCVR_EXT_ISR:
 959        case FSL_XCVR_EXT_ISR_SET:
 960        case FSL_XCVR_EXT_ISR_CLR:
 961        case FSL_XCVR_EXT_ISR_TOG:
 962        case FSL_XCVR_IER:
 963        case FSL_XCVR_ISR:
 964        case FSL_XCVR_ISR_SET:
 965        case FSL_XCVR_ISR_CLR:
 966        case FSL_XCVR_ISR_TOG:
 967        case FSL_XCVR_PHY_AI_CTRL:
 968        case FSL_XCVR_PHY_AI_CTRL_SET:
 969        case FSL_XCVR_PHY_AI_CTRL_CLR:
 970        case FSL_XCVR_PHY_AI_CTRL_TOG:
 971        case FSL_XCVR_PHY_AI_RDATA:
 972        case FSL_XCVR_CLK_CTRL:
 973        case FSL_XCVR_RX_DPTH_CTRL:
 974        case FSL_XCVR_RX_DPTH_CTRL_SET:
 975        case FSL_XCVR_RX_DPTH_CTRL_CLR:
 976        case FSL_XCVR_RX_DPTH_CTRL_TOG:
 977        case FSL_XCVR_TX_DPTH_CTRL:
 978        case FSL_XCVR_TX_DPTH_CTRL_SET:
 979        case FSL_XCVR_TX_DPTH_CTRL_CLR:
 980        case FSL_XCVR_TX_DPTH_CTRL_TOG:
 981        case FSL_XCVR_TX_CS_DATA_0:
 982        case FSL_XCVR_TX_CS_DATA_1:
 983        case FSL_XCVR_TX_CS_DATA_2:
 984        case FSL_XCVR_TX_CS_DATA_3:
 985        case FSL_XCVR_TX_CS_DATA_4:
 986        case FSL_XCVR_TX_CS_DATA_5:
 987        case FSL_XCVR_DEBUG_REG_0:
 988        case FSL_XCVR_DEBUG_REG_1:
 989                return true;
 990        default:
 991                return false;
 992        }
 993}
 994
 995static bool fsl_xcvr_writeable_reg(struct device *dev, unsigned int reg)
 996{
 997        switch (reg) {
 998        case FSL_XCVR_EXT_CTRL:
 999        case FSL_XCVR_EXT_IER0:
1000        case FSL_XCVR_EXT_IER1:
1001        case FSL_XCVR_EXT_ISR:
1002        case FSL_XCVR_EXT_ISR_SET:
1003        case FSL_XCVR_EXT_ISR_CLR:
1004        case FSL_XCVR_EXT_ISR_TOG:
1005        case FSL_XCVR_IER:
1006        case FSL_XCVR_ISR_SET:
1007        case FSL_XCVR_ISR_CLR:
1008        case FSL_XCVR_ISR_TOG:
1009        case FSL_XCVR_PHY_AI_CTRL:
1010        case FSL_XCVR_PHY_AI_CTRL_SET:
1011        case FSL_XCVR_PHY_AI_CTRL_CLR:
1012        case FSL_XCVR_PHY_AI_CTRL_TOG:
1013        case FSL_XCVR_PHY_AI_WDATA:
1014        case FSL_XCVR_CLK_CTRL:
1015        case FSL_XCVR_RX_DPTH_CTRL:
1016        case FSL_XCVR_RX_DPTH_CTRL_SET:
1017        case FSL_XCVR_RX_DPTH_CTRL_CLR:
1018        case FSL_XCVR_RX_DPTH_CTRL_TOG:
1019        case FSL_XCVR_TX_DPTH_CTRL_SET:
1020        case FSL_XCVR_TX_DPTH_CTRL_CLR:
1021        case FSL_XCVR_TX_DPTH_CTRL_TOG:
1022        case FSL_XCVR_TX_CS_DATA_0:
1023        case FSL_XCVR_TX_CS_DATA_1:
1024        case FSL_XCVR_TX_CS_DATA_2:
1025        case FSL_XCVR_TX_CS_DATA_3:
1026        case FSL_XCVR_TX_CS_DATA_4:
1027        case FSL_XCVR_TX_CS_DATA_5:
1028                return true;
1029        default:
1030                return false;
1031        }
1032}
1033
1034static bool fsl_xcvr_volatile_reg(struct device *dev, unsigned int reg)
1035{
1036        return fsl_xcvr_readable_reg(dev, reg);
1037}
1038
1039static const struct regmap_config fsl_xcvr_regmap_cfg = {
1040        .reg_bits = 32,
1041        .reg_stride = 4,
1042        .val_bits = 32,
1043        .max_register = FSL_XCVR_MAX_REG,
1044        .reg_defaults = fsl_xcvr_reg_defaults,
1045        .num_reg_defaults = ARRAY_SIZE(fsl_xcvr_reg_defaults),
1046        .readable_reg = fsl_xcvr_readable_reg,
1047        .volatile_reg = fsl_xcvr_volatile_reg,
1048        .writeable_reg = fsl_xcvr_writeable_reg,
1049        .cache_type = REGCACHE_FLAT,
1050};
1051
1052static irqreturn_t irq0_isr(int irq, void *devid)
1053{
1054        struct fsl_xcvr *xcvr = (struct fsl_xcvr *)devid;
1055        struct device *dev = &xcvr->pdev->dev;
1056        struct regmap *regmap = xcvr->regmap;
1057        void __iomem *reg_ctrl, *reg_buff;
1058        u32 isr, isr_clr = 0, val, i;
1059
1060        regmap_read(regmap, FSL_XCVR_EXT_ISR, &isr);
1061
1062        if (isr & FSL_XCVR_IRQ_NEW_CS) {
1063                dev_dbg(dev, "Received new CS block\n");
1064                isr_clr |= FSL_XCVR_IRQ_NEW_CS;
1065                /* Data RAM is 4KiB, last two pages: 8 and 9. Select page 8. */
1066                regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_CTRL,
1067                                   FSL_XCVR_EXT_CTRL_PAGE_MASK,
1068                                   FSL_XCVR_EXT_CTRL_PAGE(8));
1069
1070                /* Find updated CS buffer */
1071                reg_ctrl = xcvr->ram_addr + FSL_XCVR_RX_CS_CTRL_0;
1072                reg_buff = xcvr->ram_addr + FSL_XCVR_RX_CS_BUFF_0;
1073                memcpy_fromio(&val, reg_ctrl, sizeof(val));
1074                if (!val) {
1075                        reg_ctrl = xcvr->ram_addr + FSL_XCVR_RX_CS_CTRL_1;
1076                        reg_buff = xcvr->ram_addr + FSL_XCVR_RX_CS_BUFF_1;
1077                        memcpy_fromio(&val, reg_ctrl, sizeof(val));
1078                }
1079
1080                if (val) {
1081                        /* copy CS buffer */
1082                        memcpy_fromio(&xcvr->rx_iec958.status, reg_buff,
1083                                      sizeof(xcvr->rx_iec958.status));
1084                        for (i = 0; i < 6; i++) {
1085                                val = *(u32 *)(xcvr->rx_iec958.status + i*4);
1086                                *(u32 *)(xcvr->rx_iec958.status + i*4) =
1087                                        bitrev32(val);
1088                        }
1089                        /* clear CS control register */
1090                        memset_io(reg_ctrl, 0, sizeof(val));
1091                }
1092        }
1093        if (isr & FSL_XCVR_IRQ_NEW_UD) {
1094                dev_dbg(dev, "Received new UD block\n");
1095                isr_clr |= FSL_XCVR_IRQ_NEW_UD;
1096        }
1097        if (isr & FSL_XCVR_IRQ_MUTE) {
1098                dev_dbg(dev, "HW mute bit detected\n");
1099                isr_clr |= FSL_XCVR_IRQ_MUTE;
1100        }
1101        if (isr & FSL_XCVR_IRQ_FIFO_UOFL_ERR) {
1102                dev_dbg(dev, "RX/TX FIFO full/empty\n");
1103                isr_clr |= FSL_XCVR_IRQ_FIFO_UOFL_ERR;
1104        }
1105        if (isr & FSL_XCVR_IRQ_ARC_MODE) {
1106                dev_dbg(dev, "CMDC SM falls out of eARC mode\n");
1107                isr_clr |= FSL_XCVR_IRQ_ARC_MODE;
1108        }
1109        if (isr & FSL_XCVR_IRQ_DMA_RD_REQ) {
1110                dev_dbg(dev, "DMA read request\n");
1111                isr_clr |= FSL_XCVR_IRQ_DMA_RD_REQ;
1112        }
1113        if (isr & FSL_XCVR_IRQ_DMA_WR_REQ) {
1114                dev_dbg(dev, "DMA write request\n");
1115                isr_clr |= FSL_XCVR_IRQ_DMA_WR_REQ;
1116        }
1117
1118        if (isr_clr) {
1119                regmap_write(regmap, FSL_XCVR_EXT_ISR_CLR, isr_clr);
1120                return IRQ_HANDLED;
1121        }
1122
1123        return IRQ_NONE;
1124}
1125
1126static const struct fsl_xcvr_soc_data fsl_xcvr_imx8mp_data = {
1127        .fw_name = "imx/xcvr/xcvr-imx8mp.bin",
1128};
1129
1130static const struct of_device_id fsl_xcvr_dt_ids[] = {
1131        { .compatible = "fsl,imx8mp-xcvr", .data = &fsl_xcvr_imx8mp_data },
1132        { /* sentinel */ }
1133};
1134MODULE_DEVICE_TABLE(of, fsl_xcvr_dt_ids);
1135
1136static int fsl_xcvr_probe(struct platform_device *pdev)
1137{
1138        struct device *dev = &pdev->dev;
1139        struct fsl_xcvr *xcvr;
1140        struct resource *rx_res, *tx_res;
1141        void __iomem *regs;
1142        int ret, irq;
1143
1144        xcvr = devm_kzalloc(dev, sizeof(*xcvr), GFP_KERNEL);
1145        if (!xcvr)
1146                return -ENOMEM;
1147
1148        xcvr->pdev = pdev;
1149        xcvr->soc_data = of_device_get_match_data(&pdev->dev);
1150
1151        xcvr->ipg_clk = devm_clk_get(dev, "ipg");
1152        if (IS_ERR(xcvr->ipg_clk)) {
1153                dev_err(dev, "failed to get ipg clock\n");
1154                return PTR_ERR(xcvr->ipg_clk);
1155        }
1156
1157        xcvr->phy_clk = devm_clk_get(dev, "phy");
1158        if (IS_ERR(xcvr->phy_clk)) {
1159                dev_err(dev, "failed to get phy clock\n");
1160                return PTR_ERR(xcvr->phy_clk);
1161        }
1162
1163        xcvr->spba_clk = devm_clk_get(dev, "spba");
1164        if (IS_ERR(xcvr->spba_clk)) {
1165                dev_err(dev, "failed to get spba clock\n");
1166                return PTR_ERR(xcvr->spba_clk);
1167        }
1168
1169        xcvr->pll_ipg_clk = devm_clk_get(dev, "pll_ipg");
1170        if (IS_ERR(xcvr->pll_ipg_clk)) {
1171                dev_err(dev, "failed to get pll_ipg clock\n");
1172                return PTR_ERR(xcvr->pll_ipg_clk);
1173        }
1174
1175        xcvr->ram_addr = devm_platform_ioremap_resource_byname(pdev, "ram");
1176        if (IS_ERR(xcvr->ram_addr))
1177                return PTR_ERR(xcvr->ram_addr);
1178
1179        regs = devm_platform_ioremap_resource_byname(pdev, "regs");
1180        if (IS_ERR(regs))
1181                return PTR_ERR(regs);
1182
1183        xcvr->regmap = devm_regmap_init_mmio_clk(dev, NULL, regs,
1184                                                 &fsl_xcvr_regmap_cfg);
1185        if (IS_ERR(xcvr->regmap)) {
1186                dev_err(dev, "failed to init XCVR regmap: %ld\n",
1187                        PTR_ERR(xcvr->regmap));
1188                return PTR_ERR(xcvr->regmap);
1189        }
1190
1191        xcvr->reset = devm_reset_control_get_exclusive(dev, NULL);
1192        if (IS_ERR(xcvr->reset)) {
1193                dev_err(dev, "failed to get XCVR reset control\n");
1194                return PTR_ERR(xcvr->reset);
1195        }
1196
1197        /* get IRQs */
1198        irq = platform_get_irq(pdev, 0);
1199        if (irq < 0)
1200                return irq;
1201
1202        ret = devm_request_irq(dev, irq, irq0_isr, 0, pdev->name, xcvr);
1203        if (ret) {
1204                dev_err(dev, "failed to claim IRQ0: %i\n", ret);
1205                return ret;
1206        }
1207
1208        rx_res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "rxfifo");
1209        tx_res = platform_get_resource_byname(pdev, IORESOURCE_MEM, "txfifo");
1210        if (!rx_res || !tx_res) {
1211                dev_err(dev, "could not find rxfifo or txfifo resource\n");
1212                return -EINVAL;
1213        }
1214        xcvr->dma_prms_rx.chan_name = "rx";
1215        xcvr->dma_prms_tx.chan_name = "tx";
1216        xcvr->dma_prms_rx.addr = rx_res->start;
1217        xcvr->dma_prms_tx.addr = tx_res->start;
1218        xcvr->dma_prms_rx.maxburst = FSL_XCVR_MAXBURST_RX;
1219        xcvr->dma_prms_tx.maxburst = FSL_XCVR_MAXBURST_TX;
1220
1221        platform_set_drvdata(pdev, xcvr);
1222        pm_runtime_enable(dev);
1223        regcache_cache_only(xcvr->regmap, true);
1224
1225        /*
1226         * Register platform component before registering cpu dai for there
1227         * is not defer probe for platform component in snd_soc_add_pcm_runtime().
1228         */
1229        ret = devm_snd_dmaengine_pcm_register(dev, NULL, 0);
1230        if (ret) {
1231                dev_err(dev, "failed to pcm register\n");
1232                return ret;
1233        }
1234
1235        ret = devm_snd_soc_register_component(dev, &fsl_xcvr_comp,
1236                                              &fsl_xcvr_dai, 1);
1237        if (ret) {
1238                dev_err(dev, "failed to register component %s\n",
1239                        fsl_xcvr_comp.name);
1240        }
1241
1242        return ret;
1243}
1244
1245static __maybe_unused int fsl_xcvr_runtime_suspend(struct device *dev)
1246{
1247        struct fsl_xcvr *xcvr = dev_get_drvdata(dev);
1248        int ret;
1249
1250        /*
1251         * Clear interrupts, when streams starts or resumes after
1252         * suspend, interrupts are enabled in prepare(), so no need
1253         * to enable interrupts in resume().
1254         */
1255        ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_IER0,
1256                                 FSL_XCVR_IRQ_EARC_ALL, 0);
1257        if (ret < 0)
1258                dev_err(dev, "Failed to clear IER0: %d\n", ret);
1259
1260        /* Assert M0+ reset */
1261        ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_CTRL,
1262                                 FSL_XCVR_EXT_CTRL_CORE_RESET,
1263                                 FSL_XCVR_EXT_CTRL_CORE_RESET);
1264        if (ret < 0)
1265                dev_err(dev, "Failed to assert M0+ core: %d\n", ret);
1266
1267        regcache_cache_only(xcvr->regmap, true);
1268
1269        clk_disable_unprepare(xcvr->spba_clk);
1270        clk_disable_unprepare(xcvr->phy_clk);
1271        clk_disable_unprepare(xcvr->pll_ipg_clk);
1272        clk_disable_unprepare(xcvr->ipg_clk);
1273
1274        return 0;
1275}
1276
1277static __maybe_unused int fsl_xcvr_runtime_resume(struct device *dev)
1278{
1279        struct fsl_xcvr *xcvr = dev_get_drvdata(dev);
1280        int ret;
1281
1282        ret = reset_control_assert(xcvr->reset);
1283        if (ret < 0) {
1284                dev_err(dev, "Failed to assert M0+ reset: %d\n", ret);
1285                return ret;
1286        }
1287
1288        ret = clk_prepare_enable(xcvr->ipg_clk);
1289        if (ret) {
1290                dev_err(dev, "failed to start IPG clock.\n");
1291                return ret;
1292        }
1293
1294        ret = clk_prepare_enable(xcvr->pll_ipg_clk);
1295        if (ret) {
1296                dev_err(dev, "failed to start PLL IPG clock.\n");
1297                goto stop_ipg_clk;
1298        }
1299
1300        ret = clk_prepare_enable(xcvr->phy_clk);
1301        if (ret) {
1302                dev_err(dev, "failed to start PHY clock: %d\n", ret);
1303                goto stop_pll_ipg_clk;
1304        }
1305
1306        ret = clk_prepare_enable(xcvr->spba_clk);
1307        if (ret) {
1308                dev_err(dev, "failed to start SPBA clock.\n");
1309                goto stop_phy_clk;
1310        }
1311
1312        regcache_cache_only(xcvr->regmap, false);
1313        regcache_mark_dirty(xcvr->regmap);
1314        ret = regcache_sync(xcvr->regmap);
1315
1316        if (ret) {
1317                dev_err(dev, "failed to sync regcache.\n");
1318                goto stop_spba_clk;
1319        }
1320
1321        ret = reset_control_deassert(xcvr->reset);
1322        if (ret) {
1323                dev_err(dev, "failed to deassert M0+ reset.\n");
1324                goto stop_spba_clk;
1325        }
1326
1327        ret = fsl_xcvr_load_firmware(xcvr);
1328        if (ret) {
1329                dev_err(dev, "failed to load firmware.\n");
1330                goto stop_spba_clk;
1331        }
1332
1333        /* Release M0+ reset */
1334        ret = regmap_update_bits(xcvr->regmap, FSL_XCVR_EXT_CTRL,
1335                                 FSL_XCVR_EXT_CTRL_CORE_RESET, 0);
1336        if (ret < 0) {
1337                dev_err(dev, "M0+ core release failed: %d\n", ret);
1338                goto stop_spba_clk;
1339        }
1340
1341        /* Let M0+ core complete firmware initialization */
1342        msleep(50);
1343
1344        return 0;
1345
1346stop_spba_clk:
1347        clk_disable_unprepare(xcvr->spba_clk);
1348stop_phy_clk:
1349        clk_disable_unprepare(xcvr->phy_clk);
1350stop_pll_ipg_clk:
1351        clk_disable_unprepare(xcvr->pll_ipg_clk);
1352stop_ipg_clk:
1353        clk_disable_unprepare(xcvr->ipg_clk);
1354
1355        return ret;
1356}
1357
1358static const struct dev_pm_ops fsl_xcvr_pm_ops = {
1359        SET_RUNTIME_PM_OPS(fsl_xcvr_runtime_suspend,
1360                           fsl_xcvr_runtime_resume,
1361                           NULL)
1362        SET_SYSTEM_SLEEP_PM_OPS(pm_runtime_force_suspend,
1363                                pm_runtime_force_resume)
1364};
1365
1366static struct platform_driver fsl_xcvr_driver = {
1367        .probe = fsl_xcvr_probe,
1368        .driver = {
1369                .name = "fsl,imx8mp-audio-xcvr",
1370                .pm = &fsl_xcvr_pm_ops,
1371                .of_match_table = fsl_xcvr_dt_ids,
1372        },
1373};
1374module_platform_driver(fsl_xcvr_driver);
1375
1376MODULE_AUTHOR("Viorel Suman <viorel.suman@nxp.com>");
1377MODULE_DESCRIPTION("NXP Audio Transceiver (XCVR) driver");
1378MODULE_LICENSE("GPL v2");
1379