sound/soc/meson/axg-spdifout.c

   1 // SPDX-License-Identifier: (GPL-2.0 OR MIT)
   2 //
   3 // Copyright (c) 2018 BayLibre, SAS.
   4 // Author: Jerome Brunet <jbrunet@baylibre.com>
   5
   6 #include <linux/clk.h>
   7 #include <linux/module.h>
   8 #include <linux/of_platform.h>
   9 #include <linux/regmap.h>
  10 #include <sound/soc.h>
  11 #include <sound/soc-dai.h>
  12 #include <sound/pcm_params.h>
  13 #include <sound/pcm_iec958.h>
  14
  15 /*
  16  * NOTE:
  17  * The meaning of bits SPDIFOUT_CTRL0_XXX_SEL is actually the opposite
  18  * of what the documentation says. Manual control on V, U and C bits is
  19  * applied when the related sel bits are cleared
  20  */
  21
  22 #define SPDIFOUT_STAT                   0x00
  23 #define SPDIFOUT_GAIN0                  0x04
  24 #define SPDIFOUT_GAIN1                  0x08
  25 #define SPDIFOUT_CTRL0                  0x0c
  26 #define  SPDIFOUT_CTRL0_EN              BIT(31)
  27 #define  SPDIFOUT_CTRL0_RST_OUT         BIT(29)
  28 #define  SPDIFOUT_CTRL0_RST_IN          BIT(28)
  29 #define  SPDIFOUT_CTRL0_USEL            BIT(26)
  30 #define  SPDIFOUT_CTRL0_USET            BIT(25)
  31 #define  SPDIFOUT_CTRL0_CHSTS_SEL       BIT(24)
  32 #define  SPDIFOUT_CTRL0_DATA_SEL        BIT(20)
  33 #define  SPDIFOUT_CTRL0_MSB_FIRST       BIT(19)
  34 #define  SPDIFOUT_CTRL0_VSEL            BIT(18)
  35 #define  SPDIFOUT_CTRL0_VSET            BIT(17)
  36 #define  SPDIFOUT_CTRL0_MASK_MASK       GENMASK(11, 4)
  37 #define  SPDIFOUT_CTRL0_MASK(x)         ((x) << 4)
  38 #define SPDIFOUT_CTRL1                  0x10
  39 #define  SPDIFOUT_CTRL1_MSB_POS_MASK    GENMASK(12, 8)
  40 #define  SPDIFOUT_CTRL1_MSB_POS(x)      ((x) << 8)
  41 #define  SPDIFOUT_CTRL1_TYPE_MASK       GENMASK(6, 4)
  42 #define  SPDIFOUT_CTRL1_TYPE(x)         ((x) << 4)
  43 #define SPDIFOUT_PREAMB                 0x14
  44 #define SPDIFOUT_SWAP                   0x18
  45 #define SPDIFOUT_CHSTS0                 0x1c
  46 #define SPDIFOUT_CHSTS1                 0x20
  47 #define SPDIFOUT_CHSTS2                 0x24
  48 #define SPDIFOUT_CHSTS3                 0x28
  49 #define SPDIFOUT_CHSTS4                 0x2c
  50 #define SPDIFOUT_CHSTS5                 0x30
  51 #define SPDIFOUT_CHSTS6                 0x34
  52 #define SPDIFOUT_CHSTS7                 0x38
  53 #define SPDIFOUT_CHSTS8                 0x3c
  54 #define SPDIFOUT_CHSTS9                 0x40
  55 #define SPDIFOUT_CHSTSA                 0x44
  56 #define SPDIFOUT_CHSTSB                 0x48
  57 #define SPDIFOUT_MUTE_VAL               0x4c
  58
  59 struct axg_spdifout {
  60         struct regmap *map;
  61         struct clk *mclk;
  62         struct clk *pclk;
  63 };
  64
  65 static void axg_spdifout_enable(struct regmap *map)
  66 {
  67         /* Apply both reset */
  68         regmap_update_bits(map, SPDIFOUT_CTRL0,
  69                            SPDIFOUT_CTRL0_RST_OUT | SPDIFOUT_CTRL0_RST_IN,
  70                            0);
  71
  72         /* Clear out reset before in reset */
  73         regmap_update_bits(map, SPDIFOUT_CTRL0,
  74                            SPDIFOUT_CTRL0_RST_OUT, SPDIFOUT_CTRL0_RST_OUT);
  75         regmap_update_bits(map, SPDIFOUT_CTRL0,
  76                            SPDIFOUT_CTRL0_RST_IN,  SPDIFOUT_CTRL0_RST_IN);
  77
  78         /* Enable spdifout */
  79         regmap_update_bits(map, SPDIFOUT_CTRL0, SPDIFOUT_CTRL0_EN,
  80                            SPDIFOUT_CTRL0_EN);
  81 }
  82
  83 static void axg_spdifout_disable(struct regmap *map)
  84 {
  85         regmap_update_bits(map, SPDIFOUT_CTRL0, SPDIFOUT_CTRL0_EN, 0);
  86 }
  87
  88 static int axg_spdifout_trigger(struct snd_pcm_substream *substream, int cmd,
  89                                 struct snd_soc_dai *dai)
  90 {
  91         struct axg_spdifout *priv = snd_soc_dai_get_drvdata(dai);
  92
  93         switch (cmd) {
  94         case SNDRV_PCM_TRIGGER_START:
  95         case SNDRV_PCM_TRIGGER_RESUME:
  96         case SNDRV_PCM_TRIGGER_PAUSE_RELEASE:
  97                 axg_spdifout_enable(priv->map);
  98                 return 0;
  99
 100         case SNDRV_PCM_TRIGGER_STOP:
 101         case SNDRV_PCM_TRIGGER_SUSPEND:
 102         case SNDRV_PCM_TRIGGER_PAUSE_PUSH:
 103                 axg_spdifout_disable(priv->map);
 104                 return 0;
 105
 106         default:
 107                 return -EINVAL;
 108         }
 109 }
 110
 111 static int axg_spdifout_digital_mute(struct snd_soc_dai *dai, int mute)
 112 {
 113         struct axg_spdifout *priv = snd_soc_dai_get_drvdata(dai);
 114
 115         /* Use spdif valid bit to perform digital mute */
 116         regmap_update_bits(priv->map, SPDIFOUT_CTRL0, SPDIFOUT_CTRL0_VSET,
 117                            mute ? SPDIFOUT_CTRL0_VSET : 0);
 118
 119         return 0;
 120 }
 121
 122 static int axg_spdifout_sample_fmt(struct snd_pcm_hw_params *params,
 123                                    struct snd_soc_dai *dai)
 124 {
 125         struct axg_spdifout *priv = snd_soc_dai_get_drvdata(dai);
 126         unsigned int val;
 127
 128         /* Set the samples spdifout will pull from the FIFO */
 129         switch (params_channels(params)) {
 130         case 1:
 131                 val = SPDIFOUT_CTRL0_MASK(0x1);
 132                 break;
 133         case 2:
 134                 val = SPDIFOUT_CTRL0_MASK(0x3);
 135                 break;
 136         default:
 137                 dev_err(dai->dev, "too many channels for spdif dai: %u\n",
 138                         params_channels(params));
 139                 return -EINVAL;
 140         }
 141
 142         regmap_update_bits(priv->map, SPDIFOUT_CTRL0,
 143                            SPDIFOUT_CTRL0_MASK_MASK, val);
 144
 145         /* FIFO data are arranged in chunks of 64bits */
 146         switch (params_physical_width(params)) {
 147         case 8:
 148                 /* 8 samples of 8 bits */
 149                 val = SPDIFOUT_CTRL1_TYPE(0);
 150                 break;
 151         case 16:
 152                 /* 4 samples of 16 bits - right justified */
 153                 val = SPDIFOUT_CTRL1_TYPE(2);
 154                 break;
 155         case 32:
 156                 /* 2 samples of 32 bits - right justified */
 157                 val = SPDIFOUT_CTRL1_TYPE(4);
 158                 break;
 159         default:
 160                 dev_err(dai->dev, "Unsupported physical width: %u\n",
 161                         params_physical_width(params));
 162                 return -EINVAL;
 163         }
 164
 165         /* Position of the MSB in FIFO samples */
 166         val |= SPDIFOUT_CTRL1_MSB_POS(params_width(params) - 1);
 167
 168         regmap_update_bits(priv->map, SPDIFOUT_CTRL1,
 169                            SPDIFOUT_CTRL1_MSB_POS_MASK |
 170                            SPDIFOUT_CTRL1_TYPE_MASK, val);
 171
 172         regmap_update_bits(priv->map, SPDIFOUT_CTRL0,
 173                            SPDIFOUT_CTRL0_MSB_FIRST | SPDIFOUT_CTRL0_DATA_SEL,
 174                            0);
 175
 176         return 0;
 177 }
 178
 179 static int axg_spdifout_set_chsts(struct snd_pcm_hw_params *params,
 180                                   struct snd_soc_dai *dai)
 181 {
 182         struct axg_spdifout *priv = snd_soc_dai_get_drvdata(dai);
 183         unsigned int offset;
 184         int ret;
 185         u8 cs[4];
 186         u32 val;
 187
 188         ret = snd_pcm_create_iec958_consumer_hw_params(params, cs, 4);
 189         if (ret < 0) {
 190                 dev_err(dai->dev, "Creating IEC958 channel status failed %d\n",
 191                         ret);
 192                 return ret;
 193         }
 194         val = cs[0] | cs[1] << 8 | cs[2] << 16 | cs[3] << 24;
 195
 196         /* Setup channel status A bits [31 - 0]*/
 197         regmap_write(priv->map, SPDIFOUT_CHSTS0, val);
 198
 199         /* Clear channel status A bits [191 - 32] */
 200         for (offset = SPDIFOUT_CHSTS1; offset <= SPDIFOUT_CHSTS5;
 201              offset += regmap_get_reg_stride(priv->map))
 202                 regmap_write(priv->map, offset, 0);
 203
 204         /* Setup channel status B bits [31 - 0]*/
 205         regmap_write(priv->map, SPDIFOUT_CHSTS6, val);
 206
 207         /* Clear channel status B bits [191 - 32] */
 208         for (offset = SPDIFOUT_CHSTS7; offset <= SPDIFOUT_CHSTSB;
 209              offset += regmap_get_reg_stride(priv->map))
 210                 regmap_write(priv->map, offset, 0);
 211
 212         return 0;
 213 }
 214
 215 static int axg_spdifout_hw_params(struct snd_pcm_substream *substream,
 216                                   struct snd_pcm_hw_params *params,
 217                                   struct snd_soc_dai *dai)
 218 {
 219         struct axg_spdifout *priv = snd_soc_dai_get_drvdata(dai);
 220         unsigned int rate = params_rate(params);
 221         int ret;
 222
 223         /* 2 * 32bits per subframe * 2 channels = 128 */
 224         ret = clk_set_rate(priv->mclk, rate * 128);
 225         if (ret) {
 226                 dev_err(dai->dev, "failed to set spdif clock\n");
 227                 return ret;
 228         }
 229
 230         ret = axg_spdifout_sample_fmt(params, dai);
 231         if (ret) {
 232                 dev_err(dai->dev, "failed to setup sample format\n");
 233                 return ret;
 234         }
 235
 236         ret = axg_spdifout_set_chsts(params, dai);
 237         if (ret) {
 238                 dev_err(dai->dev, "failed to setup channel status words\n");
 239                 return ret;
 240         }
 241
 242         return 0;
 243 }
 244
 245 static int axg_spdifout_startup(struct snd_pcm_substream *substream,
 246                                 struct snd_soc_dai *dai)
 247 {
 248         struct axg_spdifout *priv = snd_soc_dai_get_drvdata(dai);
 249         int ret;
 250
 251         /* Clock the spdif output block */
 252         ret = clk_prepare_enable(priv->pclk);
 253         if (ret) {
 254                 dev_err(dai->dev, "failed to enable pclk\n");
 255                 return ret;
 256         }
 257
 258         /* Make sure the block is initially stopped */
 259         axg_spdifout_disable(priv->map);
 260
 261         /* Insert data from bit 27 lsb first */
 262         regmap_update_bits(priv->map, SPDIFOUT_CTRL0,
 263                            SPDIFOUT_CTRL0_MSB_FIRST | SPDIFOUT_CTRL0_DATA_SEL,
 264                            0);
 265
 266         /* Manual control of V, C and U, U = 0 */
 267         regmap_update_bits(priv->map, SPDIFOUT_CTRL0,
 268                            SPDIFOUT_CTRL0_CHSTS_SEL | SPDIFOUT_CTRL0_VSEL |
 269                            SPDIFOUT_CTRL0_USEL | SPDIFOUT_CTRL0_USET,
 270                            0);
 271
 272         /* Static SWAP configuration ATM */
 273         regmap_write(priv->map, SPDIFOUT_SWAP, 0x10);
 274
 275         return 0;
 276 }
 277
 278 static void axg_spdifout_shutdown(struct snd_pcm_substream *substream,
 279                                   struct snd_soc_dai *dai)
 280 {
 281         struct axg_spdifout *priv = snd_soc_dai_get_drvdata(dai);
 282
 283         clk_disable_unprepare(priv->pclk);
 284 }
 285
 286 static const struct snd_soc_dai_ops axg_spdifout_ops = {
 287         .trigger        = axg_spdifout_trigger,
 288         .digital_mute   = axg_spdifout_digital_mute,
 289         .hw_params      = axg_spdifout_hw_params,
 290         .startup        = axg_spdifout_startup,
 291         .shutdown       = axg_spdifout_shutdown,
 292 };
 293
 294 static struct snd_soc_dai_driver axg_spdifout_dai_drv[] = {
 295         {
 296                 .name = "SPDIF Output",
 297                 .playback = {
 298                         .stream_name    = "Playback",
 299                         .channels_min   = 1,
 300                         .channels_max   = 2,
 301                         .rates          = (SNDRV_PCM_RATE_32000  |
 302                                            SNDRV_PCM_RATE_44100  |
 303                                            SNDRV_PCM_RATE_48000  |
 304                                            SNDRV_PCM_RATE_88200  |
 305                                            SNDRV_PCM_RATE_96000  |
 306                                            SNDRV_PCM_RATE_176400 |
 307                                            SNDRV_PCM_RATE_192000),
 308                         .formats        = (SNDRV_PCM_FMTBIT_S8     |
 309                                            SNDRV_PCM_FMTBIT_S16_LE |
 310                                            SNDRV_PCM_FMTBIT_S20_LE |
 311                                            SNDRV_PCM_FMTBIT_S24_LE),
 312                 },
 313                 .ops = &axg_spdifout_ops,
 314         },
 315 };
 316
 317 static const char * const spdifout_sel_texts[] = {
 318         "IN 0", "IN 1", "IN 2",
 319 };
 320
 321 static SOC_ENUM_SINGLE_DECL(axg_spdifout_sel_enum, SPDIFOUT_CTRL1, 24,
 322                             spdifout_sel_texts);
 323
 324 static const struct snd_kcontrol_new axg_spdifout_in_mux =
 325         SOC_DAPM_ENUM("Input Source", axg_spdifout_sel_enum);
 326
 327 static const struct snd_soc_dapm_widget axg_spdifout_dapm_widgets[] = {
 328         SND_SOC_DAPM_AIF_IN("IN 0", NULL, 0, SND_SOC_NOPM, 0, 0),
 329         SND_SOC_DAPM_AIF_IN("IN 1", NULL, 0, SND_SOC_NOPM, 0, 0),
 330         SND_SOC_DAPM_AIF_IN("IN 2", NULL, 0, SND_SOC_NOPM, 0, 0),
 331         SND_SOC_DAPM_MUX("SRC SEL", SND_SOC_NOPM, 0, 0, &axg_spdifout_in_mux),
 332 };
 333
 334 static const struct snd_soc_dapm_route axg_spdifout_dapm_routes[] = {
 335         { "SRC SEL", "IN 0", "IN 0" },
 336         { "SRC SEL", "IN 1", "IN 1" },
 337         { "SRC SEL", "IN 2", "IN 2" },
 338         { "Playback", NULL, "SRC SEL" },
 339 };
 340
 341 static const struct snd_kcontrol_new axg_spdifout_controls[] = {
 342         SOC_DOUBLE("Playback Volume", SPDIFOUT_GAIN0,  0,  8, 255, 0),
 343         SOC_DOUBLE("Playback Switch", SPDIFOUT_CTRL0, 22, 21, 1, 1),
 344         SOC_SINGLE("Playback Gain Enable Switch",
 345                    SPDIFOUT_CTRL1, 26, 1, 0),
 346         SOC_SINGLE("Playback Channels Mix Switch",
 347                    SPDIFOUT_CTRL0, 23, 1, 0),
 348 };
 349
 350 static int axg_spdifout_set_bias_level(struct snd_soc_component *component,
 351                                        enum snd_soc_bias_level level)
 352 {
 353         struct axg_spdifout *priv = snd_soc_component_get_drvdata(component);
 354         enum snd_soc_bias_level now =
 355                 snd_soc_component_get_bias_level(component);
 356         int ret = 0;
 357
 358         switch (level) {
 359         case SND_SOC_BIAS_PREPARE:
 360                 if (now == SND_SOC_BIAS_STANDBY)
 361                         ret = clk_prepare_enable(priv->mclk);
 362                 break;
 363
 364         case SND_SOC_BIAS_STANDBY:
 365                 if (now == SND_SOC_BIAS_PREPARE)
 366                         clk_disable_unprepare(priv->mclk);
 367                 break;
 368
 369         case SND_SOC_BIAS_OFF:
 370         case SND_SOC_BIAS_ON:
 371                 break;
 372         }
 373
 374         return ret;
 375 }
 376
 377 static const struct snd_soc_component_driver axg_spdifout_component_drv = {
 378         .controls               = axg_spdifout_controls,
 379         .num_controls           = ARRAY_SIZE(axg_spdifout_controls),
 380         .dapm_widgets           = axg_spdifout_dapm_widgets,
 381         .num_dapm_widgets       = ARRAY_SIZE(axg_spdifout_dapm_widgets),
 382         .dapm_routes            = axg_spdifout_dapm_routes,
 383         .num_dapm_routes        = ARRAY_SIZE(axg_spdifout_dapm_routes),
 384         .set_bias_level         = axg_spdifout_set_bias_level,
 385 };
 386
 387 static const struct regmap_config axg_spdifout_regmap_cfg = {
 388         .reg_bits       = 32,
 389         .val_bits       = 32,
 390         .reg_stride     = 4,
 391         .max_register   = SPDIFOUT_MUTE_VAL,
 392 };
 393
 394 static const struct of_device_id axg_spdifout_of_match[] = {
 395         { .compatible = "amlogic,axg-spdifout", },
 396         {}
 397 };
 398 MODULE_DEVICE_TABLE(of, axg_spdifout_of_match);
 399
 400 static int axg_spdifout_probe(struct platform_device *pdev)
 401 {
 402         struct device *dev = &pdev->dev;
 403         struct axg_spdifout *priv;
 404         struct resource *res;
 405         void __iomem *regs;
 406         int ret;
 407
 408         priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 409         if (!priv)
 410                 return -ENOMEM;
 411         platform_set_drvdata(pdev, priv);
 412
 413         res = platform_get_resource(pdev, IORESOURCE_MEM, 0);
 414         regs = devm_ioremap_resource(dev, res);
 415         if (IS_ERR(regs))
 416                 return PTR_ERR(regs);
 417
 418         priv->map = devm_regmap_init_mmio(dev, regs, &axg_spdifout_regmap_cfg);
 419         if (IS_ERR(priv->map)) {
 420                 dev_err(dev, "failed to init regmap: %ld\n",
 421                         PTR_ERR(priv->map));
 422                 return PTR_ERR(priv->map);
 423         }
 424
 425         priv->pclk = devm_clk_get(dev, "pclk");
 426         if (IS_ERR(priv->pclk)) {
 427                 ret = PTR_ERR(priv->pclk);
 428                 if (ret != -EPROBE_DEFER)
 429                         dev_err(dev, "failed to get pclk: %d\n", ret);
 430                 return ret;
 431         }
 432
 433         priv->mclk = devm_clk_get(dev, "mclk");
 434         if (IS_ERR(priv->mclk)) {
 435                 ret = PTR_ERR(priv->mclk);
 436                 if (ret != -EPROBE_DEFER)
 437                         dev_err(dev, "failed to get mclk: %d\n", ret);
 438                 return ret;
 439         }
 440
 441         return devm_snd_soc_register_component(dev, &axg_spdifout_component_drv,
 442                         axg_spdifout_dai_drv, ARRAY_SIZE(axg_spdifout_dai_drv));
 443 }
 444
 445 static struct platform_driver axg_spdifout_pdrv = {
 446         .probe = axg_spdifout_probe,
 447         .driver = {
 448                 .name = "axg-spdifout",
 449                 .of_match_table = axg_spdifout_of_match,
 450         },
 451 };
 452 module_platform_driver(axg_spdifout_pdrv);
 453
 454 MODULE_DESCRIPTION("Amlogic AXG SPDIF Output driver");
 455 MODULE_AUTHOR("Jerome Brunet <jbrunet@baylibre.com>");
 456 MODULE_LICENSE("GPL v2");