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 PREFIX  "simple-audio-card,"
  48
  49 #define asoc_simple_card_init_hp(card, sjack, prefix)\
  50         asoc_simple_card_init_jack(card, sjack, 1, prefix)
  51 #define asoc_simple_card_init_mic(card, sjack, prefix)\
  52         asoc_simple_card_init_jack(card, sjack, 0, prefix)
  53 static int asoc_simple_card_init_jack(struct snd_soc_card *card,
  54                                       struct asoc_simple_jack *sjack,
  55                                       int is_hp, char *prefix)
  56 {
  57         struct device *dev = card->dev;
  58         enum of_gpio_flags flags;
  59         char prop[128];
  60         char *pin_name;
  61         char *gpio_name;
  62         int mask;
  63         int det;
  64
  65         sjack->gpio.gpio = -ENOENT;
  66
  67         if (is_hp) {
  68                 snprintf(prop, sizeof(prop), "%shp-det-gpio", prefix);
  69                 pin_name        = "Headphones";
  70                 gpio_name       = "Headphone detection";
  71                 mask            = SND_JACK_HEADPHONE;
  72         } else {
  73                 snprintf(prop, sizeof(prop), "%smic-det-gpio", prefix);
  74                 pin_name        = "Mic Jack";
  75                 gpio_name       = "Mic detection";
  76                 mask            = SND_JACK_MICROPHONE;
  77         }
  78
  79         det = of_get_named_gpio_flags(dev->of_node, prop, 0, &flags);
  80         if (det == -EPROBE_DEFER)
  81                 return -EPROBE_DEFER;
  82
  83         if (gpio_is_valid(det)) {
  84                 sjack->pin.pin          = pin_name;
  85                 sjack->pin.mask         = mask;
  86
  87                 sjack->gpio.name        = gpio_name;
  88                 sjack->gpio.report      = mask;
  89                 sjack->gpio.gpio        = det;
  90                 sjack->gpio.invert      = !!(flags & OF_GPIO_ACTIVE_LOW);
  91                 sjack->gpio.debounce_time = 150;
  92
  93                 snd_soc_card_jack_new(card, pin_name, mask,
  94                                       &sjack->jack,
  95                                       &sjack->pin, 1);
  96
  97                 snd_soc_jack_add_gpios(&sjack->jack, 1,
  98                                        &sjack->gpio);
  99         }
 100
 101         return 0;
 102 }
 103
 104 static void asoc_simple_card_remove_jack(struct asoc_simple_jack *sjack)
 105 {
 106         if (gpio_is_valid(sjack->gpio.gpio))
 107                 snd_soc_jack_free_gpios(&sjack->jack, 1, &sjack->gpio);
 108 }
 109
 110 static int asoc_simple_card_startup(struct snd_pcm_substream *substream)
 111 {
 112         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 113         struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
 114         struct simple_dai_props *dai_props =
 115                 &priv->dai_props[rtd->num];
 116         int ret;
 117
 118         ret = clk_prepare_enable(dai_props->cpu_dai.clk);
 119         if (ret)
 120                 return ret;
 121
 122         ret = clk_prepare_enable(dai_props->codec_dai.clk);
 123         if (ret)
 124                 clk_disable_unprepare(dai_props->cpu_dai.clk);
 125
 126         return ret;
 127 }
 128
 129 static void asoc_simple_card_shutdown(struct snd_pcm_substream *substream)
 130 {
 131         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 132         struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
 133         struct simple_dai_props *dai_props =
 134                 &priv->dai_props[rtd->num];
 135
 136         clk_disable_unprepare(dai_props->cpu_dai.clk);
 137
 138         clk_disable_unprepare(dai_props->codec_dai.clk);
 139 }
 140
 141 static int asoc_simple_card_hw_params(struct snd_pcm_substream *substream,
 142                                       struct snd_pcm_hw_params *params)
 143 {
 144         struct snd_soc_pcm_runtime *rtd = substream->private_data;
 145         struct snd_soc_dai *codec_dai = rtd->codec_dai;
 146         struct snd_soc_dai *cpu_dai = rtd->cpu_dai;
 147         struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
 148         struct simple_dai_props *dai_props = &priv->dai_props[rtd->num];
 149         unsigned int mclk, mclk_fs = 0;
 150         int ret = 0;
 151
 152         if (priv->mclk_fs)
 153                 mclk_fs = priv->mclk_fs;
 154         else if (dai_props->mclk_fs)
 155                 mclk_fs = dai_props->mclk_fs;
 156
 157         if (mclk_fs) {
 158                 mclk = params_rate(params) * mclk_fs;
 159                 ret = snd_soc_dai_set_sysclk(codec_dai, 0, mclk,
 160                                              SND_SOC_CLOCK_IN);
 161                 if (ret && ret != -ENOTSUPP)
 162                         goto err;
 163
 164                 ret = snd_soc_dai_set_sysclk(cpu_dai, 0, mclk,
 165                                              SND_SOC_CLOCK_OUT);
 166                 if (ret && ret != -ENOTSUPP)
 167                         goto err;
 168         }
 169         return 0;
 170 err:
 171         return ret;
 172 }
 173
 174 static struct snd_soc_ops asoc_simple_card_ops = {
 175         .startup = asoc_simple_card_startup,
 176         .shutdown = asoc_simple_card_shutdown,
 177         .hw_params = asoc_simple_card_hw_params,
 178 };
 179
 180 static int __asoc_simple_card_dai_init(struct snd_soc_dai *dai,
 181                                        struct asoc_simple_dai *set)
 182 {
 183         int ret;
 184
 185         if (set->sysclk) {
 186                 ret = snd_soc_dai_set_sysclk(dai, 0, set->sysclk, 0);
 187                 if (ret && ret != -ENOTSUPP) {
 188                         dev_err(dai->dev, "simple-card: set_sysclk error\n");
 189                         goto err;
 190                 }
 191         }
 192
 193         if (set->slots) {
 194                 ret = snd_soc_dai_set_tdm_slot(dai,
 195                                                set->tx_slot_mask,
 196                                                set->rx_slot_mask,
 197                                                 set->slots,
 198                                                 set->slot_width);
 199                 if (ret && ret != -ENOTSUPP) {
 200                         dev_err(dai->dev, "simple-card: set_tdm_slot error\n");
 201                         goto err;
 202                 }
 203         }
 204
 205         ret = 0;
 206
 207 err:
 208         return ret;
 209 }
 210
 211 static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime *rtd)
 212 {
 213         struct simple_card_data *priv = snd_soc_card_get_drvdata(rtd->card);
 214         struct snd_soc_dai *codec = rtd->codec_dai;
 215         struct snd_soc_dai *cpu = rtd->cpu_dai;
 216         struct simple_dai_props *dai_props;
 217         int ret;
 218
 219         dai_props = &priv->dai_props[rtd->num];
 220         ret = __asoc_simple_card_dai_init(codec, &dai_props->codec_dai);
 221         if (ret < 0)
 222                 return ret;
 223
 224         ret = __asoc_simple_card_dai_init(cpu, &dai_props->cpu_dai);
 225         if (ret < 0)
 226                 return ret;
 227
 228         ret = asoc_simple_card_init_hp(rtd->card, &priv->hp_jack, PREFIX);
 229         if (ret < 0)
 230                 return ret;
 231
 232         ret = asoc_simple_card_init_mic(rtd->card, &priv->hp_jack, PREFIX);
 233         if (ret < 0)
 234                 return ret;
 235
 236         return 0;
 237 }
 238
 239 static int
 240 asoc_simple_card_sub_parse_of(struct device_node *np,
 241                               struct asoc_simple_dai *dai,
 242                               struct device_node **p_node,
 243                               const char **name,
 244                               int *args_count)
 245 {
 246         struct of_phandle_args args;
 247         struct clk *clk;
 248         u32 val;
 249         int ret;
 250
 251         if (!np)
 252                 return 0;
 253
 254         /*
 255          * Get node via "sound-dai = <&phandle port>"
 256          * it will be used as xxx_of_node on soc_bind_dai_link()
 257          */
 258         ret = of_parse_phandle_with_args(np, "sound-dai",
 259                                          "#sound-dai-cells", 0, &args);
 260         if (ret)
 261                 return ret;
 262
 263         *p_node = args.np;
 264
 265         if (args_count)
 266                 *args_count = args.args_count;
 267
 268         /* Get dai->name */
 269         if (name) {
 270                 ret = snd_soc_of_get_dai_name(np, name);
 271                 if (ret < 0)
 272                         return ret;
 273         }
 274
 275         if (!dai)
 276                 return 0;
 277
 278         /* Parse TDM slot */
 279         ret = snd_soc_of_parse_tdm_slot(np, &dai->tx_slot_mask,
 280                                         &dai->rx_slot_mask,
 281                                         &dai->slots, &dai->slot_width);
 282         if (ret)
 283                 return ret;
 284
 285         /*
 286          * Parse dai->sysclk come from "clocks = <&xxx>"
 287          * (if system has common clock)
 288          *  or "system-clock-frequency = <xxx>"
 289          *  or device's module clock.
 290          */
 291         if (of_property_read_bool(np, "clocks")) {
 292                 clk = of_clk_get(np, 0);
 293                 if (IS_ERR(clk)) {
 294                         ret = PTR_ERR(clk);
 295                         return ret;
 296                 }
 297
 298                 dai->sysclk = clk_get_rate(clk);
 299                 dai->clk = clk;
 300         } else if (!of_property_read_u32(np, "system-clock-frequency", &val)) {
 301                 dai->sysclk = val;
 302         } else {
 303                 clk = of_clk_get(args.np, 0);
 304                 if (!IS_ERR(clk))
 305                         dai->sysclk = clk_get_rate(clk);
 306         }
 307
 308         return 0;
 309 }
 310
 311 static int asoc_simple_card_dai_link_of(struct device_node *node,
 312                                         struct simple_card_data *priv,
 313                                         int idx,
 314                                         bool is_top_level_node)
 315 {
 316         struct device *dev = simple_priv_to_dev(priv);
 317         struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, idx);
 318         struct simple_dai_props *dai_props = simple_priv_to_props(priv, idx);
 319         struct device_node *cpu = NULL;
 320         struct device_node *plat = NULL;
 321         struct device_node *codec = NULL;
 322         char *name;
 323         char prop[128];
 324         char *prefix = "";
 325         int ret, cpu_args;
 326         u32 val;
 327
 328         /* For single DAI link & old style of DT node */
 329         if (is_top_level_node)
 330                 prefix = PREFIX;
 331
 332         snprintf(prop, sizeof(prop), "%scpu", prefix);
 333         cpu = of_get_child_by_name(node, prop);
 334
 335         snprintf(prop, sizeof(prop), "%splat", prefix);
 336         plat = of_get_child_by_name(node, prop);
 337
 338         snprintf(prop, sizeof(prop), "%scodec", prefix);
 339         codec = of_get_child_by_name(node, prop);
 340
 341         if (!cpu || !codec) {
 342                 ret = -EINVAL;
 343                 dev_err(dev, "%s: Can't find %s DT node\n", __func__, prop);
 344                 goto dai_link_of_err;
 345         }
 346
 347         ret = asoc_simple_card_parse_daifmt(dev, node, codec,
 348                                             prefix, &dai_link->dai_fmt);
 349         if (ret < 0)
 350                 goto dai_link_of_err;
 351
 352         if (!of_property_read_u32(node, "mclk-fs", &val))
 353                 dai_props->mclk_fs = val;
 354
 355         ret = asoc_simple_card_sub_parse_of(cpu, &dai_props->cpu_dai,
 356                                             &dai_link->cpu_of_node,
 357                                             &dai_link->cpu_dai_name,
 358                                             &cpu_args);
 359         if (ret < 0)
 360                 goto dai_link_of_err;
 361
 362         ret = asoc_simple_card_sub_parse_of(codec, &dai_props->codec_dai,
 363                                             &dai_link->codec_of_node,
 364                                             &dai_link->codec_dai_name, NULL);
 365         if (ret < 0)
 366                 goto dai_link_of_err;
 367
 368         ret = asoc_simple_card_sub_parse_of(plat, NULL,
 369                                             &dai_link->platform_of_node,
 370                                             NULL, NULL);
 371         if (ret < 0)
 372                 goto dai_link_of_err;
 373
 374         if (!dai_link->cpu_dai_name || !dai_link->codec_dai_name) {
 375                 ret = -EINVAL;
 376                 goto dai_link_of_err;
 377         }
 378
 379         /* Assumes platform == cpu */
 380         if (!dai_link->platform_of_node)
 381                 dai_link->platform_of_node = dai_link->cpu_of_node;
 382
 383         /* DAI link name is created from CPU/CODEC dai name */
 384         name = devm_kzalloc(dev,
 385                             strlen(dai_link->cpu_dai_name)   +
 386                             strlen(dai_link->codec_dai_name) + 2,
 387                             GFP_KERNEL);
 388         if (!name) {
 389                 ret = -ENOMEM;
 390                 goto dai_link_of_err;
 391         }
 392
 393         sprintf(name, "%s-%s", dai_link->cpu_dai_name,
 394                                 dai_link->codec_dai_name);
 395         dai_link->name = dai_link->stream_name = name;
 396         dai_link->ops = &asoc_simple_card_ops;
 397         dai_link->init = asoc_simple_card_dai_init;
 398
 399         dev_dbg(dev, "\tname : %s\n", dai_link->stream_name);
 400         dev_dbg(dev, "\tformat : %04x\n", dai_link->dai_fmt);
 401         dev_dbg(dev, "\tcpu : %s / %d\n",
 402                 dai_link->cpu_dai_name,
 403                 dai_props->cpu_dai.sysclk);
 404         dev_dbg(dev, "\tcodec : %s / %d\n",
 405                 dai_link->codec_dai_name,
 406                 dai_props->codec_dai.sysclk);
 407
 408         /*
 409          * In soc_bind_dai_link() will check cpu name after
 410          * of_node matching if dai_link has cpu_dai_name.
 411          * but, it will never match if name was created by
 412          * fmt_single_name() remove cpu_dai_name if cpu_args
 413          * was 0. See:
 414          *      fmt_single_name()
 415          *      fmt_multiple_name()
 416          */
 417         if (!cpu_args)
 418                 dai_link->cpu_dai_name = NULL;
 419
 420 dai_link_of_err:
 421         of_node_put(cpu);
 422         of_node_put(codec);
 423
 424         return ret;
 425 }
 426
 427 static int asoc_simple_card_parse_of(struct device_node *node,
 428                                      struct simple_card_data *priv)
 429 {
 430         struct device *dev = simple_priv_to_dev(priv);
 431         u32 val;
 432         int ret;
 433
 434         if (!node)
 435                 return -EINVAL;
 436
 437         /* Parse the card name from DT */
 438         snd_soc_of_parse_card_name(&priv->snd_card, PREFIX "name");
 439
 440         /* The off-codec widgets */
 441         if (of_property_read_bool(node, PREFIX "widgets")) {
 442                 ret = snd_soc_of_parse_audio_simple_widgets(&priv->snd_card,
 443                                         PREFIX "widgets");
 444                 if (ret)
 445                         return ret;
 446         }
 447
 448         /* DAPM routes */
 449         if (of_property_read_bool(node, PREFIX "routing")) {
 450                 ret = snd_soc_of_parse_audio_routing(&priv->snd_card,
 451                                         PREFIX "routing");
 452                 if (ret)
 453                         return ret;
 454         }
 455
 456         /* Factor to mclk, used in hw_params() */
 457         ret = of_property_read_u32(node, PREFIX "mclk-fs", &val);
 458         if (ret == 0)
 459                 priv->mclk_fs = val;
 460
 461         dev_dbg(dev, "New simple-card: %s\n", priv->snd_card.name ?
 462                 priv->snd_card.name : "");
 463
 464         /* Single/Muti DAI link(s) & New style of DT node */
 465         if (of_get_child_by_name(node, PREFIX "dai-link")) {
 466                 struct device_node *np = NULL;
 467                 int i = 0;
 468
 469                 for_each_child_of_node(node, np) {
 470                         dev_dbg(dev, "\tlink %d:\n", i);
 471                         ret = asoc_simple_card_dai_link_of(np, priv,
 472                                                            i, false);
 473                         if (ret < 0) {
 474                                 of_node_put(np);
 475                                 return ret;
 476                         }
 477                         i++;
 478                 }
 479         } else {
 480                 /* For single DAI link & old style of DT node */
 481                 ret = asoc_simple_card_dai_link_of(node, priv, 0, true);
 482                 if (ret < 0)
 483                         return ret;
 484         }
 485
 486         if (!priv->snd_card.name)
 487                 priv->snd_card.name = priv->snd_card.dai_link->name;
 488
 489         return 0;
 490 }
 491
 492 /* Decrease the reference count of the device nodes */
 493 static int asoc_simple_card_unref(struct snd_soc_card *card)
 494 {
 495         struct snd_soc_dai_link *dai_link;
 496         int num_links;
 497
 498         for (num_links = 0, dai_link = card->dai_link;
 499              num_links < card->num_links;
 500              num_links++, dai_link++) {
 501                 of_node_put(dai_link->cpu_of_node);
 502                 of_node_put(dai_link->codec_of_node);
 503         }
 504         return 0;
 505 }
 506
 507 static int asoc_simple_card_probe(struct platform_device *pdev)
 508 {
 509         struct simple_card_data *priv;
 510         struct snd_soc_dai_link *dai_link;
 511         struct device_node *np = pdev->dev.of_node;
 512         struct device *dev = &pdev->dev;
 513         int num_links, ret;
 514
 515         /* Get the number of DAI links */
 516         if (np && of_get_child_by_name(np, PREFIX "dai-link"))
 517                 num_links = of_get_child_count(np);
 518         else
 519                 num_links = 1;
 520
 521         /* Allocate the private data and the DAI link array */
 522         priv = devm_kzalloc(dev,
 523                         sizeof(*priv) + sizeof(*dai_link) * num_links,
 524                         GFP_KERNEL);
 525         if (!priv)
 526                 return -ENOMEM;
 527
 528         /* Init snd_soc_card */
 529         priv->snd_card.owner = THIS_MODULE;
 530         priv->snd_card.dev = dev;
 531         dai_link = priv->dai_link;
 532         priv->snd_card.dai_link = dai_link;
 533         priv->snd_card.num_links = num_links;
 534
 535         /* Get room for the other properties */
 536         priv->dai_props = devm_kzalloc(dev,
 537                         sizeof(*priv->dai_props) * num_links,
 538                         GFP_KERNEL);
 539         if (!priv->dai_props)
 540                 return -ENOMEM;
 541
 542         if (np && of_device_is_available(np)) {
 543
 544                 ret = asoc_simple_card_parse_of(np, priv);
 545                 if (ret < 0) {
 546                         if (ret != -EPROBE_DEFER)
 547                                 dev_err(dev, "parse error %d\n", ret);
 548                         goto err;
 549                 }
 550
 551         } else {
 552                 struct asoc_simple_card_info *cinfo;
 553
 554                 cinfo = dev->platform_data;
 555                 if (!cinfo) {
 556                         dev_err(dev, "no info for asoc-simple-card\n");
 557                         return -EINVAL;
 558                 }
 559
 560                 if (!cinfo->name ||
 561                     !cinfo->codec_dai.name ||
 562                     !cinfo->codec ||
 563                     !cinfo->platform ||
 564                     !cinfo->cpu_dai.name) {
 565                         dev_err(dev, "insufficient asoc_simple_card_info settings\n");
 566                         return -EINVAL;
 567                 }
 568
 569                 priv->snd_card.name     = (cinfo->card) ? cinfo->card : cinfo->name;
 570                 dai_link->name          = cinfo->name;
 571                 dai_link->stream_name   = cinfo->name;
 572                 dai_link->platform_name = cinfo->platform;
 573                 dai_link->codec_name    = cinfo->codec;
 574                 dai_link->cpu_dai_name  = cinfo->cpu_dai.name;
 575                 dai_link->codec_dai_name = cinfo->codec_dai.name;
 576                 dai_link->dai_fmt       = cinfo->daifmt;
 577                 dai_link->init          = asoc_simple_card_dai_init;
 578                 memcpy(&priv->dai_props->cpu_dai, &cinfo->cpu_dai,
 579                                         sizeof(priv->dai_props->cpu_dai));
 580                 memcpy(&priv->dai_props->codec_dai, &cinfo->codec_dai,
 581                                         sizeof(priv->dai_props->codec_dai));
 582
 583         }
 584
 585         snd_soc_card_set_drvdata(&priv->snd_card, priv);
 586
 587         ret = devm_snd_soc_register_card(&pdev->dev, &priv->snd_card);
 588         if (ret >= 0)
 589                 return ret;
 590
 591 err:
 592         asoc_simple_card_unref(&priv->snd_card);
 593         return ret;
 594 }
 595
 596 static int asoc_simple_card_remove(struct platform_device *pdev)
 597 {
 598         struct snd_soc_card *card = platform_get_drvdata(pdev);
 599         struct simple_card_data *priv = snd_soc_card_get_drvdata(card);
 600
 601         asoc_simple_card_remove_jack(&priv->hp_jack);
 602         asoc_simple_card_remove_jack(&priv->mic_jack);
 603
 604         return asoc_simple_card_unref(card);
 605 }
 606
 607 static const struct of_device_id asoc_simple_of_match[] = {
 608         { .compatible = "simple-audio-card", },
 609         {},
 610 };
 611 MODULE_DEVICE_TABLE(of, asoc_simple_of_match);
 612
 613 static struct platform_driver asoc_simple_card = {
 614         .driver = {
 615                 .name = "asoc-simple-card",
 616                 .pm = &snd_soc_pm_ops,
 617                 .of_match_table = asoc_simple_of_match,
 618         },
 619         .probe = asoc_simple_card_probe,
 620         .remove = asoc_simple_card_remove,
 621 };
 622
 623 module_platform_driver(asoc_simple_card);
 624
 625 MODULE_ALIAS("platform:asoc-simple-card");
 626 MODULE_LICENSE("GPL");
 627 MODULE_DESCRIPTION("ASoC Simple Sound Card");
 628 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");