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/module.h>
  14 #include <linux/of.h>
  15 #include <linux/platform_device.h>
  16 #include <linux/string.h>
  17 #include <sound/simple_card.h>
  18 #include <sound/soc-dai.h>
  19 #include <sound/soc.h>
  20
  21 struct simple_card_data {
  22         struct snd_soc_card snd_card;
  23         struct simple_dai_props {
  24                 struct asoc_simple_dai cpu_dai;
  25                 struct asoc_simple_dai codec_dai;
  26         } *dai_props;
  27         struct snd_soc_dai_link dai_link[];     /* dynamically allocated */
  28 };
  29
  30 static int __asoc_simple_card_dai_init(struct snd_soc_dai *dai,
  31                                        struct asoc_simple_dai *set)
  32 {
  33         int ret;
  34
  35         if (set->fmt) {
  36                 ret = snd_soc_dai_set_fmt(dai, set->fmt);
  37                 if (ret && ret != -ENOTSUPP) {
  38                         dev_err(dai->dev, "simple-card: set_fmt error\n");
  39                         goto err;
  40                 }
  41         }
  42
  43         if (set->sysclk) {
  44                 ret = snd_soc_dai_set_sysclk(dai, 0, set->sysclk, 0);
  45                 if (ret && ret != -ENOTSUPP) {
  46                         dev_err(dai->dev, "simple-card: set_sysclk error\n");
  47                         goto err;
  48                 }
  49         }
  50
  51         if (set->slots) {
  52                 ret = snd_soc_dai_set_tdm_slot(dai, 0, 0,
  53                                                 set->slots,
  54                                                 set->slot_width);
  55                 if (ret && ret != -ENOTSUPP) {
  56                         dev_err(dai->dev, "simple-card: set_tdm_slot error\n");
  57                         goto err;
  58                 }
  59         }
  60
  61         ret = 0;
  62
  63 err:
  64         return ret;
  65 }
  66
  67 static int asoc_simple_card_dai_init(struct snd_soc_pcm_runtime *rtd)
  68 {
  69         struct simple_card_data *priv =
  70                                 snd_soc_card_get_drvdata(rtd->card);
  71         struct snd_soc_dai *codec = rtd->codec_dai;
  72         struct snd_soc_dai *cpu = rtd->cpu_dai;
  73         int ret;
  74
  75         ret = __asoc_simple_card_dai_init(codec, &priv->dai_props->codec_dai);
  76         if (ret < 0)
  77                 return ret;
  78
  79         ret = __asoc_simple_card_dai_init(cpu, &priv->dai_props->cpu_dai);
  80         if (ret < 0)
  81                 return ret;
  82
  83         return 0;
  84 }
  85
  86 static int
  87 asoc_simple_card_sub_parse_of(struct device_node *np,
  88                               unsigned int daifmt,
  89                               struct asoc_simple_dai *dai,
  90                               const struct device_node **p_node,
  91                               const char **name)
  92 {
  93         struct device_node *node;
  94         struct clk *clk;
  95         int ret;
  96
  97         /*
  98          * get node via "sound-dai = <&phandle port>"
  99          * it will be used as xxx_of_node on soc_bind_dai_link()
 100          */
 101         node = of_parse_phandle(np, "sound-dai", 0);
 102         if (!node)
 103                 return -ENODEV;
 104         *p_node = node;
 105
 106         /* get dai->name */
 107         ret = snd_soc_of_get_dai_name(np, name);
 108         if (ret < 0)
 109                 return ret;
 110
 111         /* parse TDM slot */
 112         ret = snd_soc_of_parse_tdm_slot(np, &dai->slots, &dai->slot_width);
 113         if (ret)
 114                 return ret;
 115
 116         /*
 117          * bitclock-inversion, frame-inversion
 118          * bitclock-master,    frame-master
 119          * and specific "format" if it has
 120          */
 121         dai->fmt = snd_soc_of_parse_daifmt(np, NULL);
 122         dai->fmt |= daifmt;
 123
 124         /*
 125          * dai->sysclk come from
 126          *  "clocks = <&xxx>" (if system has common clock)
 127          *  or "system-clock-frequency = <xxx>"
 128          *  or device's module clock.
 129          */
 130         if (of_property_read_bool(np, "clocks")) {
 131                 clk = of_clk_get(np, 0);
 132                 if (IS_ERR(clk)) {
 133                         ret = PTR_ERR(clk);
 134                         return ret;
 135                 }
 136
 137                 dai->sysclk = clk_get_rate(clk);
 138         } else if (of_property_read_bool(np, "system-clock-frequency")) {
 139                 of_property_read_u32(np,
 140                                      "system-clock-frequency",
 141                                      &dai->sysclk);
 142         } else {
 143                 clk = of_clk_get(node, 0);
 144                 if (!IS_ERR(clk))
 145                         dai->sysclk = clk_get_rate(clk);
 146         }
 147
 148         return 0;
 149 }
 150
 151 static int asoc_simple_card_parse_of(struct device_node *node,
 152                                      struct simple_card_data *priv,
 153                                      struct device *dev)
 154 {
 155         struct snd_soc_dai_link *dai_link = priv->snd_card.dai_link;
 156         struct asoc_simple_dai *codec_dai = &priv->dai_props->codec_dai;
 157         struct asoc_simple_dai *cpu_dai = &priv->dai_props->cpu_dai;
 158         struct device_node *np;
 159         char *name;
 160         unsigned int daifmt;
 161         int ret;
 162
 163         /* parsing the card name from DT */
 164         snd_soc_of_parse_card_name(&priv->snd_card, "simple-audio-card,name");
 165
 166         /* get CPU/CODEC common format via simple-audio-card,format */
 167         daifmt = snd_soc_of_parse_daifmt(node, "simple-audio-card,") &
 168                 (SND_SOC_DAIFMT_FORMAT_MASK | SND_SOC_DAIFMT_INV_MASK);
 169
 170         /* off-codec widgets */
 171         if (of_property_read_bool(node, "simple-audio-card,widgets")) {
 172                 ret = snd_soc_of_parse_audio_simple_widgets(&priv->snd_card,
 173                                         "simple-audio-card,widgets");
 174                 if (ret)
 175                         return ret;
 176         }
 177
 178         /* DAPM routes */
 179         if (of_property_read_bool(node, "simple-audio-card,routing")) {
 180                 ret = snd_soc_of_parse_audio_routing(&priv->snd_card,
 181                                         "simple-audio-card,routing");
 182                 if (ret)
 183                         return ret;
 184         }
 185
 186         /* CPU sub-node */
 187         ret = -EINVAL;
 188         np = of_get_child_by_name(node, "simple-audio-card,cpu");
 189         if (np) {
 190                 ret = asoc_simple_card_sub_parse_of(np, daifmt,
 191                                                   cpu_dai,
 192                                                   &dai_link->cpu_of_node,
 193                                                   &dai_link->cpu_dai_name);
 194                 of_node_put(np);
 195         }
 196         if (ret < 0)
 197                 return ret;
 198
 199         /* CODEC sub-node */
 200         ret = -EINVAL;
 201         np = of_get_child_by_name(node, "simple-audio-card,codec");
 202         if (np) {
 203                 ret = asoc_simple_card_sub_parse_of(np, daifmt,
 204                                                   codec_dai,
 205                                                   &dai_link->codec_of_node,
 206                                                   &dai_link->codec_dai_name);
 207                 of_node_put(np);
 208         }
 209         if (ret < 0)
 210                 return ret;
 211
 212         /*
 213          * overwrite cpu_dai->fmt as its DAIFMT_MASTER bit is based on CODEC
 214          * while the other bits should be identical unless buggy SW/HW design.
 215          */
 216         cpu_dai->fmt = codec_dai->fmt;
 217
 218         if (!dai_link->cpu_dai_name || !dai_link->codec_dai_name)
 219                 return -EINVAL;
 220
 221         /* card name is created from CPU/CODEC dai name */
 222         name = devm_kzalloc(dev,
 223                             strlen(dai_link->cpu_dai_name)   +
 224                             strlen(dai_link->codec_dai_name) + 2,
 225                             GFP_KERNEL);
 226         sprintf(name, "%s-%s", dai_link->cpu_dai_name,
 227                                 dai_link->codec_dai_name);
 228         if (!priv->snd_card.name)
 229                 priv->snd_card.name = name;
 230         dai_link->name = dai_link->stream_name = name;
 231
 232         /* simple-card assumes platform == cpu */
 233         dai_link->platform_of_node = dai_link->cpu_of_node;
 234
 235         dev_dbg(dev, "card-name : %s\n", name);
 236         dev_dbg(dev, "platform : %04x\n", daifmt);
 237         dev_dbg(dev, "cpu : %s / %04x / %d\n",
 238                 dai_link->cpu_dai_name,
 239                 cpu_dai->fmt,
 240                 cpu_dai->sysclk);
 241         dev_dbg(dev, "codec : %s / %04x / %d\n",
 242                 dai_link->codec_dai_name,
 243                 codec_dai->fmt,
 244                 codec_dai->sysclk);
 245
 246         /*
 247          * soc_bind_dai_link() will check cpu name
 248          * after of_node matching if dai_link has cpu_dai_name.
 249          * but, it will never match if name was created by fmt_single_name()
 250          * remove cpu_dai_name to escape name matching.
 251          * see
 252          *      fmt_single_name()
 253          *      fmt_multiple_name()
 254          */
 255         dai_link->cpu_dai_name = NULL;
 256
 257         return 0;
 258 }
 259
 260 /* update the reference count of the devices nodes at end of probe */
 261 static int asoc_simple_card_unref(struct platform_device *pdev)
 262 {
 263         struct snd_soc_card *card = platform_get_drvdata(pdev);
 264         struct snd_soc_dai_link *dai_link;
 265         struct device_node *np;
 266         int num_links;
 267
 268         for (num_links = 0, dai_link = card->dai_link;
 269              num_links < card->num_links;
 270              num_links++, dai_link++) {
 271                 np = (struct device_node *) dai_link->cpu_of_node;
 272                 if (np)
 273                         of_node_put(np);
 274                 np = (struct device_node *) dai_link->codec_of_node;
 275                 if (np)
 276                         of_node_put(np);
 277         }
 278         return 0;
 279 }
 280
 281 static int asoc_simple_card_probe(struct platform_device *pdev)
 282 {
 283         struct simple_card_data *priv;
 284         struct snd_soc_dai_link *dai_link;
 285         struct device_node *np = pdev->dev.of_node;
 286         struct device *dev = &pdev->dev;
 287         int ret;
 288
 289         /* allocate the private data and the DAI link array */
 290         priv = devm_kzalloc(dev,
 291                         sizeof(*priv) + sizeof(*dai_link),
 292                         GFP_KERNEL);
 293         if (!priv)
 294                 return -ENOMEM;
 295
 296         /*
 297          * init snd_soc_card
 298          */
 299         priv->snd_card.owner = THIS_MODULE;
 300         priv->snd_card.dev = dev;
 301         dai_link = priv->dai_link;
 302         priv->snd_card.dai_link = dai_link;
 303         priv->snd_card.num_links = 1;
 304
 305         /* get room for the other properties */
 306         priv->dai_props = devm_kzalloc(dev,
 307                         sizeof(*priv->dai_props),
 308                         GFP_KERNEL);
 309         if (!priv->dai_props)
 310                 return -ENOMEM;
 311
 312         if (np && of_device_is_available(np)) {
 313
 314                 ret = asoc_simple_card_parse_of(np, priv, dev);
 315                 if (ret < 0) {
 316                         if (ret != -EPROBE_DEFER)
 317                                 dev_err(dev, "parse error %d\n", ret);
 318                         goto err;
 319                 }
 320         } else {
 321                 struct asoc_simple_card_info *cinfo;
 322
 323                 cinfo = dev->platform_data;
 324                 if (!cinfo) {
 325                         dev_err(dev, "no info for asoc-simple-card\n");
 326                         return -EINVAL;
 327                 }
 328
 329                 if (!cinfo->name        ||
 330                     !cinfo->codec_dai.name      ||
 331                     !cinfo->codec       ||
 332                     !cinfo->platform    ||
 333                     !cinfo->cpu_dai.name) {
 334                         dev_err(dev, "insufficient asoc_simple_card_info settings\n");
 335                         return -EINVAL;
 336                 }
 337
 338                 priv->snd_card.name     = (cinfo->card) ? cinfo->card : cinfo->name;
 339                 dai_link->name          = cinfo->name;
 340                 dai_link->stream_name   = cinfo->name;
 341                 dai_link->platform_name = cinfo->platform;
 342                 dai_link->codec_name    = cinfo->codec;
 343                 dai_link->cpu_dai_name  = cinfo->cpu_dai.name;
 344                 dai_link->codec_dai_name = cinfo->codec_dai.name;
 345                 memcpy(&priv->dai_props->cpu_dai, &cinfo->cpu_dai,
 346                                         sizeof(priv->dai_props->cpu_dai));
 347                 memcpy(&priv->dai_props->codec_dai, &cinfo->codec_dai,
 348                                         sizeof(priv->dai_props->codec_dai));
 349
 350                 priv->dai_props->cpu_dai.fmt    |= cinfo->daifmt;
 351                 priv->dai_props->codec_dai.fmt  |= cinfo->daifmt;
 352         }
 353
 354         /*
 355          * init snd_soc_dai_link
 356          */
 357         dai_link->init = asoc_simple_card_dai_init;
 358
 359         snd_soc_card_set_drvdata(&priv->snd_card, priv);
 360
 361         ret = devm_snd_soc_register_card(&pdev->dev, &priv->snd_card);
 362
 363 err:
 364         asoc_simple_card_unref(pdev);
 365         return ret;
 366 }
 367
 368 static const struct of_device_id asoc_simple_of_match[] = {
 369         { .compatible = "simple-audio-card", },
 370         {},
 371 };
 372 MODULE_DEVICE_TABLE(of, asoc_simple_of_match);
 373
 374 static struct platform_driver asoc_simple_card = {
 375         .driver = {
 376                 .name   = "asoc-simple-card",
 377                 .owner = THIS_MODULE,
 378                 .of_match_table = asoc_simple_of_match,
 379         },
 380         .probe          = asoc_simple_card_probe,
 381 };
 382
 383 module_platform_driver(asoc_simple_card);
 384
 385 MODULE_ALIAS("platform:asoc-simple-card");
 386 MODULE_LICENSE("GPL");
 387 MODULE_DESCRIPTION("ASoC Simple Sound Card");
 388 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");