sound/soc/generic/simple-card.c

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