sound/soc/generic/simple-card.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 //
   3 // ASoC simple sound card support
   4 //
   5 // Copyright (C) 2012 Renesas Solutions Corp.
   6 // Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
   7
   8 #include <linux/clk.h>
   9 #include <linux/device.h>
  10 #include <linux/module.h>
  11 #include <linux/of.h>
  12 #include <linux/platform_device.h>
  13 #include <linux/string.h>
  14 #include <sound/simple_card.h>
  15 #include <sound/soc-dai.h>
  16 #include <sound/soc.h>
  17
  18 struct simple_card_data {
  19         struct snd_soc_card snd_card;
  20         struct simple_dai_props {
  21                 struct asoc_simple_dai cpu_dai;
  22                 struct asoc_simple_dai codec_dai;
  23                 struct snd_soc_dai_link_component codecs; /* single codec */
  24                 unsigned int mclk_fs;
  25         } *dai_props;
  26         unsigned int mclk_fs;
  27         struct asoc_simple_jack hp_jack;
  28         struct asoc_simple_jack mic_jack;
  29         struct snd_soc_dai_link *dai_link;
  30 };
  31
  32 #define simple_priv_to_card(priv) (&(priv)->snd_card)
  33 #define simple_priv_to_props(priv, i) ((priv)->dai_props + (i))
  34 #define simple_priv_to_dev(priv) (simple_priv_to_card(priv)->dev)
  35 #define simple_priv_to_link(priv, i) (simple_priv_to_card(priv)->dai_link + (i))
  36
  37 #define DAI     "sound-dai"
  38 #define CELL    "#sound-dai-cells"
  39 #define PREFIX  "simple-audio-card,"
  40
  41 static int asoc_simple_card_startup(struct snd_pcm_substream *substream)
  42 {
  43         struct snd_soc_pcm_runtime *rtd = substream->private_data;
  44         struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
  45         struct simple_dai_props *dai_props =
  46                 simple_priv_to_props(priv, rtd->num);
  47         int ret;
  48
  49         ret = asoc_simple_card_clk_enable(&dai_props->cpu_dai);
  50         if (ret)
  51                 return ret;
  52
  53         ret = asoc_simple_card_clk_enable(&dai_props->codec_dai);
  54         if (ret)
  55                 asoc_simple_card_clk_disable(&dai_props->cpu_dai);
  56
  57         return ret;
  58 }
  59
  60 static void asoc_simple_card_shutdown(struct snd_pcm_substream *substream)
  61 {
  62         struct snd_soc_pcm_runtime *rtd = substream->private_data;
  63         struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
  64         struct simple_dai_props *dai_props =
  65                 simple_priv_to_props(priv, rtd->num);
  66
  67         asoc_simple_card_clk_disable(&dai_props->cpu_dai);
  68
  69         asoc_simple_card_clk_disable(&dai_props->codec_dai);
  70 }
  71
  72 static int asoc_simple_set_clk_rate(struct asoc_simple_dai *simple_dai,
  73                                     unsigned long rate)
  74 {
  75         if (!simple_dai->clk)
  76                 return 0;
  77
  78         if (clk_get_rate(simple_dai->clk) == rate)
  79                 return 0;
  80
  81         return clk_set_rate(simple_dai->clk, rate);
  82 }
  83
  84 static int asoc_simple_card_hw_params(struct snd_pcm_substream *substream,
  85                                       struct snd_pcm_hw_params *params)
  86 {
  87         struct snd_soc_pcm_runtime *rtd = substream->private_data;
  88         struct snd_soc_dai *codec_dai = rtd->codec_dai;
  89         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
  90         struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
  91         struct simple_dai_props *dai_props =
  92                 simple_priv_to_props(priv, rtd->num);
  93         unsigned int mclk, mclk_fs = 0;
  94         int ret = 0;
  95
  96         if (priv->mclk_fs)
  97                 mclk_fs = priv->mclk_fs;
  98         else if (dai_props->mclk_fs)
  99                 mclk_fs = dai_props->mclk_fs;
 100
 101         if (mclk_fs) {
 102                 mclk = params_rate(params) * mclk_fs;
 103
 104                 ret = asoc_simple_set_clk_rate(&dai_props->codec_dai, mclk);
 105                 if (ret < 0)
 106                         return ret;
 107
 108                 ret = asoc_simple_set_clk_rate(&dai_props->cpu_dai, mclk);
 109                 if (ret < 0)
 110                         return ret;
 111
 112                 ret = snd_soc_dai_set_sysclk(codec_dai, 0, mclk,
 113                                              SND_SOC_CLOCK_IN);
 114                 if (ret && ret != -ENOTSUPP)
 115                         goto err;
 116
 117                 ret = snd_soc_dai_set_sysclk(cpu_dai, 0, mclk,
 118                                              SND_SOC_CLOCK_OUT);
 119                 if (ret && ret != -ENOTSUPP)
 120                         goto err;
 121         }
 122         return 0;
 123 err:
 124         return ret;
 125 }
 126
 127 static const struct snd_soc_ops asoc_simple_card_ops = {
 128         .startup = asoc_simple_card_startup,
 129         .shutdown = asoc_simple_card_shutdown,
 130         .hw_params = asoc_simple_card_hw_params,
 131 };
 132
 133 static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime *rtd)
 134 {
 135         struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
 136         struct snd_soc_dai *codec = rtd->codec_dai;
 137         struct snd_soc_dai *cpu = rtd->cpu_dai;
 138         struct simple_dai_props *dai_props =
 139                 simple_priv_to_props(priv, rtd->num);
 140         int ret;
 141
 142         ret = asoc_simple_card_init_dai(codec, &dai_props->codec_dai);
 143         if (ret < 0)
 144                 return ret;
 145
 146         ret = asoc_simple_card_init_dai(cpu, &dai_props->cpu_dai);
 147         if (ret < 0)
 148                 return ret;
 149
 150         return 0;
 151 }
 152
 153 static int asoc_simple_card_dai_link_of(struct device_node *node,
 154                                         struct simple_card_data *priv,
 155                                         int idx,
 156                                         bool is_top_level_node)
 157 {
 158         struct device *dev = simple_priv_to_dev(priv);
 159         struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, idx);
 160         struct simple_dai_props *dai_props = simple_priv_to_props(priv, idx);
 161         struct asoc_simple_dai *cpu_dai = &dai_props->cpu_dai;
 162         struct asoc_simple_dai *codec_dai = &dai_props->codec_dai;
 163         struct device_node *cpu = NULL;
 164         struct device_node *plat = NULL;
 165         struct device_node *codec = NULL;
 166         char prop[128];
 167         char *prefix = "";
 168         int ret, single_cpu;
 169
 170         /* For single DAI link & old style of DT node */
 171         if (is_top_level_node)
 172                 prefix = PREFIX;
 173
 174         snprintf(prop, sizeof(prop), "%scpu", prefix);
 175         cpu = of_get_child_by_name(node, prop);
 176
 177         if (!cpu) {
 178                 ret = -EINVAL;
 179                 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
 180                 goto dai_link_of_err;
 181         }
 182
 183         snprintf(prop, sizeof(prop), "%splat", prefix);
 184         plat = of_get_child_by_name(node, prop);
 185
 186         snprintf(prop, sizeof(prop), "%scodec", prefix);
 187         codec = of_get_child_by_name(node, prop);
 188
 189         if (!codec) {
 190                 ret = -EINVAL;
 191                 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
 192                 goto dai_link_of_err;
 193         }
 194
 195         ret = asoc_simple_card_parse_daifmt(dev, node, codec,
 196                                             prefix, &dai_link->dai_fmt);
 197         if (ret < 0)
 198                 goto dai_link_of_err;
 199
 200         of_property_read_u32(node, "mclk-fs", &dai_props->mclk_fs);
 201
 202         ret = asoc_simple_card_parse_cpu(cpu, dai_link,
 203                                          DAI, CELL, &single_cpu);
 204         if (ret < 0)
 205                 goto dai_link_of_err;
 206
 207         ret = asoc_simple_card_parse_codec(codec, dai_link, DAI, CELL);
 208         if (ret < 0)
 209                 goto dai_link_of_err;
 210
 211         ret = asoc_simple_card_parse_platform(plat, dai_link, DAI, CELL);
 212         if (ret < 0)
 213                 goto dai_link_of_err;
 214
 215         ret = asoc_simple_card_of_parse_tdm(cpu, cpu_dai);
 216         if (ret < 0)
 217                 goto dai_link_of_err;
 218
 219         ret = asoc_simple_card_of_parse_tdm(codec, codec_dai);
 220         if (ret < 0)
 221                 goto dai_link_of_err;
 222
 223         ret = asoc_simple_card_parse_clk_cpu(dev, cpu, dai_link, cpu_dai);
 224         if (ret < 0)
 225                 goto dai_link_of_err;
 226
 227         ret = asoc_simple_card_parse_clk_codec(dev, codec, dai_link, codec_dai);
 228         if (ret < 0)
 229                 goto dai_link_of_err;
 230
 231         ret = asoc_simple_card_canonicalize_dailink(dai_link);
 232         if (ret < 0)
 233                 goto dai_link_of_err;
 234
 235         ret = asoc_simple_card_set_dailink_name(dev, dai_link,
 236                                                 "%s-%s",
 237                                                 dai_link->cpu_dai_name,
 238                                                 dai_link->codecs->dai_name);
 239         if (ret < 0)
 240                 goto dai_link_of_err;
 241
 242         dai_link->ops = &asoc_simple_card_ops;
 243         dai_link->init = asoc_simple_card_dai_init;
 244
 245         asoc_simple_card_canonicalize_cpu(dai_link, single_cpu);
 246
 247 dai_link_of_err:
 248         of_node_put(cpu);
 249         of_node_put(codec);
 250
 251         return ret;
 252 }
 253
 254 static int asoc_simple_card_parse_aux_devs(struct device_node *node,
 255                                            struct simple_card_data *priv)
 256 {
 257         struct device *dev = simple_priv_to_dev(priv);
 258         struct device_node *aux_node;
 259         struct snd_soc_card *card = simple_priv_to_card(priv);
 260         int i, n, len;
 261
 262         if (!of_find_property(node, PREFIX "aux-devs", &len))
 263                 return 0;               /* Ok to have no aux-devs */
 264
 265         n = len / sizeof(__be32);
 266         if (n <= 0)
 267                 return -EINVAL;
 268
 269         card->aux_dev = devm_kcalloc(dev,
 270                         n, sizeof(*card->aux_dev), GFP_KERNEL);
 271         if (!card->aux_dev)
 272                 return -ENOMEM;
 273
 274         for (i = 0; i < n; i++) {
 275                 aux_node = of_parse_phandle(node, PREFIX "aux-devs", i);
 276                 if (!aux_node)
 277                         return -EINVAL;
 278                 card->aux_dev[i].codec_of_node = aux_node;
 279         }
 280
 281         card->num_aux_devs = n;
 282         return 0;
 283 }
 284
 285 static int asoc_simple_card_parse_of(struct simple_card_data *priv)
 286 {
 287         struct device *dev = simple_priv_to_dev(priv);
 288         struct snd_soc_card *card = simple_priv_to_card(priv);
 289         struct device_node *dai_link;
 290         struct device_node *node = dev->of_node;
 291         int ret;
 292
 293         if (!node)
 294                 return -EINVAL;
 295
 296         dai_link = of_get_child_by_name(node, PREFIX "dai-link");
 297
 298         ret = asoc_simple_card_of_parse_widgets(card, PREFIX);
 299         if (ret < 0)
 300                 goto card_parse_end;
 301
 302         ret = asoc_simple_card_of_parse_routing(card, PREFIX, 1);
 303         if (ret < 0)
 304                 goto card_parse_end;
 305
 306         /* Factor to mclk, used in hw_params() */
 307         of_property_read_u32(node, PREFIX "mclk-fs", &priv->mclk_fs);
 308
 309         /* Single/Muti DAI link(s) & New style of DT node */
 310         if (dai_link) {
 311                 struct device_node *np = NULL;
 312                 int i = 0;
 313
 314                 for_each_child_of_node(node, np) {
 315                         dev_dbg(dev, "\tlink %d:\n", i);
 316                         ret = asoc_simple_card_dai_link_of(np, priv,
 317                                                            i, false);
 318                         if (ret < 0) {
 319                                 of_node_put(np);
 320                                 goto card_parse_end;
 321                         }
 322                         i++;
 323                 }
 324         } else {
 325                 /* For single DAI link & old style of DT node */
 326                 ret = asoc_simple_card_dai_link_of(node, priv, 0, true);
 327                 if (ret < 0)
 328                         goto card_parse_end;
 329         }
 330
 331         ret = asoc_simple_card_parse_card_name(card, PREFIX);
 332         if (ret < 0)
 333                 goto card_parse_end;
 334
 335         ret = asoc_simple_card_parse_aux_devs(node, priv);
 336
 337 card_parse_end:
 338         of_node_put(dai_link);
 339
 340         return ret;
 341 }
 342
 343 static int asoc_simple_soc_card_probe(struct snd_soc_card *card)
 344 {
 345         struct simple_card_data *priv = snd_soc_card_get_drvdata(card);
 346         int ret;
 347
 348         ret = asoc_simple_card_init_hp(card, &priv->hp_jack, PREFIX);
 349         if (ret < 0)
 350                 return ret;
 351
 352         ret = asoc_simple_card_init_mic(card, &priv->mic_jack, PREFIX);
 353         if (ret < 0)
 354                 return ret;
 355
 356         return 0;
 357 }
 358
 359 static int asoc_simple_card_probe(struct platform_device *pdev)
 360 {
 361         struct simple_card_data *priv;
 362         struct snd_soc_dai_link *dai_link;
 363         struct simple_dai_props *dai_props;
 364         struct device *dev = &pdev->dev;
 365         struct device_node *np = dev->of_node;
 366         struct snd_soc_card *card;
 367         int num, ret, i;
 368
 369         /* Get the number of DAI links */
 370         if (np && of_get_child_by_name(np, PREFIX "dai-link"))
 371                 num = of_get_child_count(np);
 372         else
 373                 num = 1;
 374
 375         /* Allocate the private data and the DAI link array */
 376         priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL);
 377         if (!priv)
 378                 return -ENOMEM;
 379
 380         dai_props = devm_kcalloc(dev, num, sizeof(*dai_props), GFP_KERNEL);
 381         dai_link  = devm_kcalloc(dev, num, sizeof(*dai_link), GFP_KERNEL);
 382         if (!dai_props || !dai_link)
 383                 return -ENOMEM;
 384
 385         /*
 386          * Use snd_soc_dai_link_component instead of legacy style
 387          * It is codec only. but cpu/platform will be supported in the future.
 388          * see
 389          *      soc-core.c :: snd_soc_init_multicodec()
 390          */
 391         for (i = 0; i < num; i++) {
 392                 dai_link[i].codecs      = &dai_props[i].codecs;
 393                 dai_link[i].num_codecs  = 1;
 394         }
 395
 396         priv->dai_props                 = dai_props;
 397         priv->dai_link                  = dai_link;
 398
 399         /* Init snd_soc_card */
 400         card = simple_priv_to_card(priv);
 401         card->owner             = THIS_MODULE;
 402         card->dev               = dev;
 403         card->dai_link          = priv->dai_link;
 404         card->num_links         = num;
 405         card->probe             = asoc_simple_soc_card_probe;
 406
 407         if (np && of_device_is_available(np)) {
 408
 409                 ret = asoc_simple_card_parse_of(priv);
 410                 if (ret < 0) {
 411                         if (ret != -EPROBE_DEFER)
 412                                 dev_err(dev, "parse error %d\n", ret);
 413                         goto err;
 414                 }
 415
 416         } else {
 417                 struct asoc_simple_card_info *cinfo;
 418                 struct snd_soc_dai_link_component *codecs;
 419
 420                 cinfo = dev->platform_data;
 421                 if (!cinfo) {
 422                         dev_err(dev, "no info for asoc-simple-card\n");
 423                         return -EINVAL;
 424                 }
 425
 426                 if (!cinfo->name ||
 427                     !cinfo->codec_dai.name ||
 428                     !cinfo->codec ||
 429                     !cinfo->platform ||
 430                     !cinfo->cpu_dai.name) {
 431                         dev_err(dev, "insufficient asoc_simple_card_info settings\n");
 432                         return -EINVAL;
 433                 }
 434
 435                 codecs                  = dai_link->codecs;
 436                 codecs->name            = cinfo->codec;
 437                 codecs->dai_name        = cinfo->codec_dai.name;
 438
 439                 card->name              = (cinfo->card) ? cinfo->card : cinfo->name;
 440                 dai_link->name          = cinfo->name;
 441                 dai_link->stream_name   = cinfo->name;
 442                 dai_link->platform_name = cinfo->platform;
 443                 dai_link->cpu_dai_name  = cinfo->cpu_dai.name;
 444                 dai_link->dai_fmt       = cinfo->daifmt;
 445                 dai_link->init          = asoc_simple_card_dai_init;
 446                 memcpy(&priv->dai_props->cpu_dai, &cinfo->cpu_dai,
 447                                         sizeof(priv->dai_props->cpu_dai));
 448                 memcpy(&priv->dai_props->codec_dai, &cinfo->codec_dai,
 449                                         sizeof(priv->dai_props->codec_dai));
 450         }
 451
 452         snd_soc_card_set_drvdata(card, priv);
 453
 454         ret = devm_snd_soc_register_card(dev, card);
 455         if (ret < 0)
 456                 goto err;
 457
 458         return 0;
 459 err:
 460         asoc_simple_card_clean_reference(card);
 461
 462         return ret;
 463 }
 464
 465 static int asoc_simple_card_remove(struct platform_device *pdev)
 466 {
 467         struct snd_soc_card *card = platform_get_drvdata(pdev);
 468
 469         return asoc_simple_card_clean_reference(card);
 470 }
 471
 472 static const struct of_device_id asoc_simple_of_match[] = {
 473         { .compatible = "simple-audio-card", },
 474         {},
 475 };
 476 MODULE_DEVICE_TABLE(of, asoc_simple_of_match);
 477
 478 static struct platform_driver asoc_simple_card = {
 479         .driver = {
 480                 .name = "asoc-simple-card",
 481                 .pm = &snd_soc_pm_ops,
 482                 .of_match_table = asoc_simple_of_match,
 483         },
 484         .probe = asoc_simple_card_probe,
 485         .remove = asoc_simple_card_remove,
 486 };
 487
 488 module_platform_driver(asoc_simple_card);
 489
 490 MODULE_ALIAS("platform:asoc-simple-card");
 491 MODULE_LICENSE("GPL v2");
 492 MODULE_DESCRIPTION("ASoC Simple Sound Card");
 493 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");