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[];     /* dynamically allocated */
  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                 &priv->dai_props[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                 &priv->dai_props[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 = &priv->dai_props[rtd->num];
 151         unsigned int mclk, mclk_fs = 0;
 152         int ret = 0;
 153
 154         if (priv->mclk_fs)
 155                 mclk_fs = priv->mclk_fs;
 156         else if (dai_props->mclk_fs)
 157                 mclk_fs = dai_props->mclk_fs;
 158
 159         if (mclk_fs) {
 160                 mclk = params_rate(params) * mclk_fs;
 161                 ret = snd_soc_dai_set_sysclk(codec_dai, 0, mclk,
 162                                              SND_SOC_CLOCK_IN);
 163                 if (ret && ret != -ENOTSUPP)
 164                         goto err;
 165
 166                 ret = snd_soc_dai_set_sysclk(cpu_dai, 0, mclk,
 167                                              SND_SOC_CLOCK_OUT);
 168                 if (ret && ret != -ENOTSUPP)
 169                         goto err;
 170         }
 171         return 0;
 172 err:
 173         return ret;
 174 }
 175
 176 static struct snd_soc_ops asoc_simple_card_ops = {
 177         .startup = asoc_simple_card_startup,
 178         .shutdown = asoc_simple_card_shutdown,
 179         .hw_params = asoc_simple_card_hw_params,
 180 };
 181
 182 static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime *rtd)
 183 {
 184         struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
 185         struct snd_soc_dai *codec = rtd->codec_dai;
 186         struct snd_soc_dai *cpu = rtd->cpu_dai;
 187         struct simple_dai_props *dai_props = &priv->dai_props[rtd->num];
 188         int ret;
 189
 190         ret = asoc_simple_card_init_dai(codec, &dai_props->codec_dai);
 191         if (ret < 0)
 192                 return ret;
 193
 194         ret = asoc_simple_card_init_dai(cpu, &dai_props->cpu_dai);
 195         if (ret < 0)
 196                 return ret;
 197
 198         ret = asoc_simple_card_init_hp(rtd->card, &priv->hp_jack, PREFIX);
 199         if (ret < 0)
 200                 return ret;
 201
 202         ret = asoc_simple_card_init_mic(rtd->card, &priv->hp_jack, PREFIX);
 203         if (ret < 0)
 204                 return ret;
 205
 206         return 0;
 207 }
 208
 209 static int asoc_simple_card_dai_link_of(struct device_node *node,
 210                                         struct simple_card_data *priv,
 211                                         int idx,
 212                                         bool is_top_level_node)
 213 {
 214         struct device *dev = simple_priv_to_dev(priv);
 215         struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, idx);
 216         struct simple_dai_props *dai_props = simple_priv_to_props(priv, idx);
 217         struct asoc_simple_dai *cpu_dai = &dai_props->cpu_dai;
 218         struct asoc_simple_dai *codec_dai = &dai_props->codec_dai;
 219         struct device_node *cpu = NULL;
 220         struct device_node *plat = NULL;
 221         struct device_node *codec = NULL;
 222         char prop[128];
 223         char *prefix = "";
 224         int ret, single_cpu;
 225
 226         /* For single DAI link & old style of DT node */
 227         if (is_top_level_node)
 228                 prefix = PREFIX;
 229
 230         snprintf(prop, sizeof(prop), "%scpu", prefix);
 231         cpu = of_get_child_by_name(node, prop);
 232
 233         snprintf(prop, sizeof(prop), "%splat", prefix);
 234         plat = of_get_child_by_name(node, prop);
 235
 236         snprintf(prop, sizeof(prop), "%scodec", prefix);
 237         codec = of_get_child_by_name(node, prop);
 238
 239         if (!cpu || !codec) {
 240                 ret = -EINVAL;
 241                 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
 242                 goto dai_link_of_err;
 243         }
 244
 245         ret = asoc_simple_card_parse_daifmt(dev, node, codec,
 246                                             prefix, &dai_link->dai_fmt);
 247         if (ret < 0)
 248                 goto dai_link_of_err;
 249
 250         of_property_read_u32(node, "mclk-fs", &dai_props->mclk_fs);
 251
 252         ret = asoc_simple_card_parse_cpu(cpu, dai_link,
 253                                          DAI, CELL, &single_cpu);
 254         if (ret < 0)
 255                 goto dai_link_of_err;
 256
 257         ret = asoc_simple_card_parse_codec(codec, dai_link, DAI, CELL);
 258         if (ret < 0)
 259                 goto dai_link_of_err;
 260
 261         ret = asoc_simple_card_parse_platform(plat, dai_link, DAI, CELL);
 262         if (ret < 0)
 263                 goto dai_link_of_err;
 264
 265         ret = snd_soc_of_parse_tdm_slot(cpu,    &cpu_dai->tx_slot_mask,
 266                                                 &cpu_dai->rx_slot_mask,
 267                                                 &cpu_dai->slots,
 268                                                 &cpu_dai->slot_width);
 269         if (ret < 0)
 270                 goto dai_link_of_err;
 271
 272         ret = snd_soc_of_parse_tdm_slot(codec,  &codec_dai->tx_slot_mask,
 273                                                 &codec_dai->rx_slot_mask,
 274                                                 &codec_dai->slots,
 275                                                 &codec_dai->slot_width);
 276         if (ret < 0)
 277                 goto dai_link_of_err;
 278
 279         ret = asoc_simple_card_parse_clk_cpu(cpu, dai_link, cpu_dai);
 280         if (ret < 0)
 281                 goto dai_link_of_err;
 282
 283         ret = asoc_simple_card_parse_clk_codec(codec, dai_link, codec_dai);
 284         if (ret < 0)
 285                 goto dai_link_of_err;
 286
 287         ret = asoc_simple_card_canonicalize_dailink(dai_link);
 288         if (ret < 0)
 289                 goto dai_link_of_err;
 290
 291         ret = asoc_simple_card_set_dailink_name(dev, dai_link,
 292                                                 "%s-%s",
 293                                                 dai_link->cpu_dai_name,
 294                                                 dai_link->codec_dai_name);
 295         if (ret < 0)
 296                 goto dai_link_of_err;
 297
 298         dai_link->ops = &asoc_simple_card_ops;
 299         dai_link->init = asoc_simple_card_dai_init;
 300
 301         dev_dbg(dev, "\tname : %s\n", dai_link->stream_name);
 302         dev_dbg(dev, "\tformat : %04x\n", dai_link->dai_fmt);
 303         dev_dbg(dev, "\tcpu : %s / %d\n",
 304                 dai_link->cpu_dai_name,
 305                 dai_props->cpu_dai.sysclk);
 306         dev_dbg(dev, "\tcodec : %s / %d\n",
 307                 dai_link->codec_dai_name,
 308                 dai_props->codec_dai.sysclk);
 309
 310         asoc_simple_card_canonicalize_cpu(dai_link, single_cpu);
 311
 312 dai_link_of_err:
 313         of_node_put(cpu);
 314         of_node_put(codec);
 315
 316         return ret;
 317 }
 318
 319 static int asoc_simple_card_parse_of(struct device_node *node,
 320                                      struct simple_card_data *priv)
 321 {
 322         struct device *dev = simple_priv_to_dev(priv);
 323         struct device_node *dai_link;
 324         int ret;
 325
 326         if (!node)
 327                 return -EINVAL;
 328
 329         dai_link = of_get_child_by_name(node, PREFIX "dai-link");
 330
 331         /* The off-codec widgets */
 332         if (of_property_read_bool(node, PREFIX "widgets")) {
 333                 ret = snd_soc_of_parse_audio_simple_widgets(&priv->snd_card,
 334                                         PREFIX "widgets");
 335                 if (ret)
 336                         goto card_parse_end;
 337         }
 338
 339         /* DAPM routes */
 340         if (of_property_read_bool(node, PREFIX "routing")) {
 341                 ret = snd_soc_of_parse_audio_routing(&priv->snd_card,
 342                                         PREFIX "routing");
 343                 if (ret)
 344                         goto card_parse_end;
 345         }
 346
 347         /* Factor to mclk, used in hw_params() */
 348         of_property_read_u32(node, PREFIX "mclk-fs", &priv->mclk_fs);
 349
 350         /* Single/Muti DAI link(s) & New style of DT node */
 351         if (dai_link) {
 352                 struct device_node *np = NULL;
 353                 int i = 0;
 354
 355                 for_each_child_of_node(node, np) {
 356                         dev_dbg(dev, "\tlink %d:\n", i);
 357                         ret = asoc_simple_card_dai_link_of(np, priv,
 358                                                            i, false);
 359                         if (ret < 0) {
 360                                 of_node_put(np);
 361                                 goto card_parse_end;
 362                         }
 363                         i++;
 364                 }
 365         } else {
 366                 /* For single DAI link & old style of DT node */
 367                 ret = asoc_simple_card_dai_link_of(node, priv, 0, true);
 368                 if (ret < 0)
 369                         goto card_parse_end;
 370         }
 371
 372         ret = asoc_simple_card_parse_card_name(&priv->snd_card, PREFIX);
 373
 374 card_parse_end:
 375         of_node_put(dai_link);
 376
 377         return ret;
 378 }
 379
 380 static int asoc_simple_card_probe(struct platform_device *pdev)
 381 {
 382         struct simple_card_data *priv;
 383         struct snd_soc_dai_link *dai_link;
 384         struct device_node *np = pdev->dev.of_node;
 385         struct device *dev = &pdev->dev;
 386         int num_links, ret;
 387
 388         /* Get the number of DAI links */
 389         if (np && of_get_child_by_name(np, PREFIX "dai-link"))
 390                 num_links = of_get_child_count(np);
 391         else
 392                 num_links = 1;
 393
 394         /* Allocate the private data and the DAI link array */
 395         priv = devm_kzalloc(dev,
 396                         sizeof(*priv) + sizeof(*dai_link) * num_links,
 397                         GFP_KERNEL);
 398         if (!priv)
 399                 return -ENOMEM;
 400
 401         /* Init snd_soc_card */
 402         priv->snd_card.owner = THIS_MODULE;
 403         priv->snd_card.dev = dev;
 404         dai_link = priv->dai_link;
 405         priv->snd_card.dai_link = dai_link;
 406         priv->snd_card.num_links = num_links;
 407
 408         /* Get room for the other properties */
 409         priv->dai_props = devm_kzalloc(dev,
 410                         sizeof(*priv->dai_props) * num_links,
 411                         GFP_KERNEL);
 412         if (!priv->dai_props)
 413                 return -ENOMEM;
 414
 415         if (np && of_device_is_available(np)) {
 416
 417                 ret = asoc_simple_card_parse_of(np, priv);
 418                 if (ret < 0) {
 419                         if (ret != -EPROBE_DEFER)
 420                                 dev_err(dev, "parse error %d\n", ret);
 421                         goto err;
 422                 }
 423
 424         } else {
 425                 struct asoc_simple_card_info *cinfo;
 426
 427                 cinfo = dev->platform_data;
 428                 if (!cinfo) {
 429                         dev_err(dev, "no info for asoc-simple-card\n");
 430                         return -EINVAL;
 431                 }
 432
 433                 if (!cinfo->name ||
 434                     !cinfo->codec_dai.name ||
 435                     !cinfo->codec ||
 436                     !cinfo->platform ||
 437                     !cinfo->cpu_dai.name) {
 438                         dev_err(dev, "insufficient asoc_simple_card_info settings\n");
 439                         return -EINVAL;
 440                 }
 441
 442                 priv->snd_card.name     = (cinfo->card) ? cinfo->card : cinfo->name;
 443                 dai_link->name          = cinfo->name;
 444                 dai_link->stream_name   = cinfo->name;
 445                 dai_link->platform_name = cinfo->platform;
 446                 dai_link->codec_name    = cinfo->codec;
 447                 dai_link->cpu_dai_name  = cinfo->cpu_dai.name;
 448                 dai_link->codec_dai_name = cinfo->codec_dai.name;
 449                 dai_link->dai_fmt       = cinfo->daifmt;
 450                 dai_link->init          = asoc_simple_card_dai_init;
 451                 memcpy(&priv->dai_props->cpu_dai, &cinfo->cpu_dai,
 452                                         sizeof(priv->dai_props->cpu_dai));
 453                 memcpy(&priv->dai_props->codec_dai, &cinfo->codec_dai,
 454                                         sizeof(priv->dai_props->codec_dai));
 455
 456         }
 457
 458         snd_soc_card_set_drvdata(&priv->snd_card, priv);
 459
 460         ret = devm_snd_soc_register_card(&pdev->dev, &priv->snd_card);
 461         if (ret >= 0)
 462                 return ret;
 463
 464 err:
 465         asoc_simple_card_clean_reference(&priv->snd_card);
 466         return ret;
 467 }
 468
 469 static int asoc_simple_card_remove(struct platform_device *pdev)
 470 {
 471         struct snd_soc_card *card = platform_get_drvdata(pdev);
 472         struct simple_card_data *priv = snd_soc_card_get_drvdata(card);
 473
 474         asoc_simple_card_remove_jack(&priv->hp_jack);
 475         asoc_simple_card_remove_jack(&priv->mic_jack);
 476
 477         return asoc_simple_card_clean_reference(card);
 478 }
 479
 480 static const struct of_device_id asoc_simple_of_match[] = {
 481         { .compatible = "simple-audio-card", },
 482         {},
 483 };
 484 MODULE_DEVICE_TABLE(of, asoc_simple_of_match);
 485
 486 static struct platform_driver asoc_simple_card = {
 487         .driver = {
 488                 .name = "asoc-simple-card",
 489                 .pm = &snd_soc_pm_ops,
 490                 .of_match_table = asoc_simple_of_match,
 491         },
 492         .probe = asoc_simple_card_probe,
 493         .remove = asoc_simple_card_remove,
 494 };
 495
 496 module_platform_driver(asoc_simple_card);
 497
 498 MODULE_ALIAS("platform:asoc-simple-card");
 499 MODULE_LICENSE("GPL");
 500 MODULE_DESCRIPTION("ASoC Simple Sound Card");
 501 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");