sound/soc/generic/simple-card-utils.c

   1 // SPDX-License-Identifier: GPL-2.0
   2 //
   3 // simple-card-utils.c
   4 //
   5 // Copyright (c) 2016 Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>
   6
   7 #include <linux/clk.h>
   8 #include <linux/gpio.h>
   9 #include <linux/gpio/consumer.h>
  10 #include <linux/module.h>
  11 #include <linux/of.h>
  12 #include <linux/of_graph.h>
  13 #include <sound/jack.h>
  14 #include <sound/pcm_params.h>
  15 #include <sound/simple_card_utils.h>
  16
  17 static void simple_fixup_sample_fmt(struct simple_util_data *data,
  18                                          struct snd_pcm_hw_params *params)
  19 {
  20         int i;
  21         struct snd_mask *mask = hw_param_mask(params,
  22                                               SNDRV_PCM_HW_PARAM_FORMAT);
  23         struct {
  24                 char *fmt;
  25                 u32 val;
  26         } of_sample_fmt_table[] = {
  27                 { "s8",         SNDRV_PCM_FORMAT_S8},
  28                 { "s16_le",     SNDRV_PCM_FORMAT_S16_LE},
  29                 { "s24_le",     SNDRV_PCM_FORMAT_S24_LE},
  30                 { "s24_3le",    SNDRV_PCM_FORMAT_S24_3LE},
  31                 { "s32_le",     SNDRV_PCM_FORMAT_S32_LE},
  32         };
  33
  34         for (i = 0; i < ARRAY_SIZE(of_sample_fmt_table); i++) {
  35                 if (!strcmp(data->convert_sample_format,
  36                             of_sample_fmt_table[i].fmt)) {
  37                         snd_mask_none(mask);
  38                         snd_mask_set(mask, of_sample_fmt_table[i].val);
  39                         break;
  40                 }
  41         }
  42 }
  43
  44 void simple_util_parse_convert(struct device_node *np,
  45                                char *prefix,
  46                                struct simple_util_data *data)
  47 {
  48         char prop[128];
  49
  50         if (!prefix)
  51                 prefix = "";
  52
  53         /* sampling rate convert */
  54         snprintf(prop, sizeof(prop), "%s%s", prefix, "convert-rate");
  55         of_property_read_u32(np, prop, &data->convert_rate);
  56
  57         /* channels transfer */
  58         snprintf(prop, sizeof(prop), "%s%s", prefix, "convert-channels");
  59         of_property_read_u32(np, prop, &data->convert_channels);
  60
  61         /* convert sample format */
  62         snprintf(prop, sizeof(prop), "%s%s", prefix, "convert-sample-format");
  63         of_property_read_string(np, prop, &data->convert_sample_format);
  64 }
  65 EXPORT_SYMBOL_GPL(simple_util_parse_convert);
  66
  67 /**
  68  * simple_util_is_convert_required() - Query if HW param conversion was requested
  69  * @data: Link data.
  70  *
  71  * Returns true if any HW param conversion was requested for this DAI link with
  72  * any "convert-xxx" properties.
  73  */
  74 bool simple_util_is_convert_required(const struct simple_util_data *data)
  75 {
  76         return data->convert_rate ||
  77                data->convert_channels ||
  78                data->convert_sample_format;
  79 }
  80 EXPORT_SYMBOL_GPL(simple_util_is_convert_required);
  81
  82 int simple_util_parse_daifmt(struct device *dev,
  83                              struct device_node *node,
  84                              struct device_node *codec,
  85                              char *prefix,
  86                              unsigned int *retfmt)
  87 {
  88         struct device_node *bitclkmaster = NULL;
  89         struct device_node *framemaster = NULL;
  90         unsigned int daifmt;
  91
  92         daifmt = snd_soc_daifmt_parse_format(node, prefix);
  93
  94         snd_soc_daifmt_parse_clock_provider_as_phandle(node, prefix, &bitclkmaster, &framemaster);
  95         if (!bitclkmaster && !framemaster) {
  96                 /*
  97                  * No dai-link level and master setting was not found from
  98                  * sound node level, revert back to legacy DT parsing and
  99                  * take the settings from codec node.
 100                  */
 101                 dev_dbg(dev, "Revert to legacy daifmt parsing\n");
 102
 103                 daifmt |= snd_soc_daifmt_parse_clock_provider_as_flag(codec, NULL);
 104         } else {
 105                 daifmt |= snd_soc_daifmt_clock_provider_from_bitmap(
 106                                 ((codec == bitclkmaster) << 4) | (codec == framemaster));
 107         }
 108
 109         of_node_put(bitclkmaster);
 110         of_node_put(framemaster);
 111
 112         *retfmt = daifmt;
 113
 114         return 0;
 115 }
 116 EXPORT_SYMBOL_GPL(simple_util_parse_daifmt);
 117
 118 int simple_util_parse_tdm_width_map(struct device *dev, struct device_node *np,
 119                                     struct simple_util_dai *dai)
 120 {
 121         u32 *array_values, *p;
 122         int n, i, ret;
 123
 124         if (!of_property_read_bool(np, "dai-tdm-slot-width-map"))
 125                 return 0;
 126
 127         n = of_property_count_elems_of_size(np, "dai-tdm-slot-width-map", sizeof(u32));
 128         if (n % 3) {
 129                 dev_err(dev, "Invalid number of cells for dai-tdm-slot-width-map\n");
 130                 return -EINVAL;
 131         }
 132
 133         dai->tdm_width_map = devm_kcalloc(dev, n, sizeof(*dai->tdm_width_map), GFP_KERNEL);
 134         if (!dai->tdm_width_map)
 135                 return -ENOMEM;
 136
 137         array_values = kcalloc(n, sizeof(*array_values), GFP_KERNEL);
 138         if (!array_values)
 139                 return -ENOMEM;
 140
 141         ret = of_property_read_u32_array(np, "dai-tdm-slot-width-map", array_values, n);
 142         if (ret < 0) {
 143                 dev_err(dev, "Could not read dai-tdm-slot-width-map: %d\n", ret);
 144                 goto out;
 145         }
 146
 147         p = array_values;
 148         for (i = 0; i < n / 3; ++i) {
 149                 dai->tdm_width_map[i].sample_bits = *p++;
 150                 dai->tdm_width_map[i].slot_width = *p++;
 151                 dai->tdm_width_map[i].slot_count = *p++;
 152         }
 153
 154         dai->n_tdm_widths = i;
 155         ret = 0;
 156 out:
 157         kfree(array_values);
 158
 159         return ret;
 160 }
 161 EXPORT_SYMBOL_GPL(simple_util_parse_tdm_width_map);
 162
 163 int simple_util_set_dailink_name(struct device *dev,
 164                                  struct snd_soc_dai_link *dai_link,
 165                                  const char *fmt, ...)
 166 {
 167         va_list ap;
 168         char *name = NULL;
 169         int ret = -ENOMEM;
 170
 171         va_start(ap, fmt);
 172         name = devm_kvasprintf(dev, GFP_KERNEL, fmt, ap);
 173         va_end(ap);
 174
 175         if (name) {
 176                 ret = 0;
 177
 178                 dai_link->name          = name;
 179                 dai_link->stream_name   = name;
 180         }
 181
 182         return ret;
 183 }
 184 EXPORT_SYMBOL_GPL(simple_util_set_dailink_name);
 185
 186 int simple_util_parse_card_name(struct snd_soc_card *card,
 187                                 char *prefix)
 188 {
 189         int ret;
 190
 191         if (!prefix)
 192                 prefix = "";
 193
 194         /* Parse the card name from DT */
 195         ret = snd_soc_of_parse_card_name(card, "label");
 196         if (ret < 0 || !card->name) {
 197                 char prop[128];
 198
 199                 snprintf(prop, sizeof(prop), "%sname", prefix);
 200                 ret = snd_soc_of_parse_card_name(card, prop);
 201                 if (ret < 0)
 202                         return ret;
 203         }
 204
 205         if (!card->name && card->dai_link)
 206                 card->name = card->dai_link->name;
 207
 208         return 0;
 209 }
 210 EXPORT_SYMBOL_GPL(simple_util_parse_card_name);
 211
 212 static int simple_clk_enable(struct simple_util_dai *dai)
 213 {
 214         if (dai)
 215                 return clk_prepare_enable(dai->clk);
 216
 217         return 0;
 218 }
 219
 220 static void simple_clk_disable(struct simple_util_dai *dai)
 221 {
 222         if (dai)
 223                 clk_disable_unprepare(dai->clk);
 224 }
 225
 226 int simple_util_parse_clk(struct device *dev,
 227                           struct device_node *node,
 228                           struct simple_util_dai *simple_dai,
 229                           struct snd_soc_dai_link_component *dlc)
 230 {
 231         struct clk *clk;
 232         u32 val;
 233
 234         /*
 235          * Parse dai->sysclk come from "clocks = <&xxx>"
 236          * (if system has common clock)
 237          *  or "system-clock-frequency = <xxx>"
 238          *  or device's module clock.
 239          */
 240         clk = devm_get_clk_from_child(dev, node, NULL);
 241         simple_dai->clk_fixed = of_property_read_bool(
 242                 node, "system-clock-fixed");
 243         if (!IS_ERR(clk)) {
 244                 simple_dai->sysclk = clk_get_rate(clk);
 245
 246                 simple_dai->clk = clk;
 247         } else if (!of_property_read_u32(node, "system-clock-frequency", &val)) {
 248                 simple_dai->sysclk = val;
 249                 simple_dai->clk_fixed = true;
 250         } else {
 251                 clk = devm_get_clk_from_child(dev, dlc->of_node, NULL);
 252                 if (!IS_ERR(clk))
 253                         simple_dai->sysclk = clk_get_rate(clk);
 254         }
 255
 256         if (of_property_read_bool(node, "system-clock-direction-out"))
 257                 simple_dai->clk_direction = SND_SOC_CLOCK_OUT;
 258
 259         return 0;
 260 }
 261 EXPORT_SYMBOL_GPL(simple_util_parse_clk);
 262
 263 static int simple_check_fixed_sysclk(struct device *dev,
 264                                           struct simple_util_dai *dai,
 265                                           unsigned int *fixed_sysclk)
 266 {
 267         if (dai->clk_fixed) {
 268                 if (*fixed_sysclk && *fixed_sysclk != dai->sysclk) {
 269                         dev_err(dev, "inconsistent fixed sysclk rates (%u vs %u)\n",
 270                                 *fixed_sysclk, dai->sysclk);
 271                         return -EINVAL;
 272                 }
 273                 *fixed_sysclk = dai->sysclk;
 274         }
 275
 276         return 0;
 277 }
 278
 279 int simple_util_startup(struct snd_pcm_substream *substream)
 280 {
 281         struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
 282         struct simple_util_priv *priv = snd_soc_card_get_drvdata(rtd->card);
 283         struct simple_dai_props *props = simple_priv_to_props(priv, rtd->num);
 284         struct simple_util_dai *dai;
 285         unsigned int fixed_sysclk = 0;
 286         int i1, i2, i;
 287         int ret;
 288
 289         for_each_prop_dai_cpu(props, i1, dai) {
 290                 ret = simple_clk_enable(dai);
 291                 if (ret)
 292                         goto cpu_err;
 293                 ret = simple_check_fixed_sysclk(rtd->dev, dai, &fixed_sysclk);
 294                 if (ret)
 295                         goto cpu_err;
 296         }
 297
 298         for_each_prop_dai_codec(props, i2, dai) {
 299                 ret = simple_clk_enable(dai);
 300                 if (ret)
 301                         goto codec_err;
 302                 ret = simple_check_fixed_sysclk(rtd->dev, dai, &fixed_sysclk);
 303                 if (ret)
 304                         goto codec_err;
 305         }
 306
 307         if (fixed_sysclk && props->mclk_fs) {
 308                 unsigned int fixed_rate = fixed_sysclk / props->mclk_fs;
 309
 310                 if (fixed_sysclk % props->mclk_fs) {
 311                         dev_err(rtd->dev, "fixed sysclk %u not divisible by mclk_fs %u\n",
 312                                 fixed_sysclk, props->mclk_fs);
 313                         ret = -EINVAL;
 314                         goto codec_err;
 315                 }
 316                 ret = snd_pcm_hw_constraint_minmax(substream->runtime, SNDRV_PCM_HW_PARAM_RATE,
 317                         fixed_rate, fixed_rate);
 318                 if (ret < 0)
 319                         goto codec_err;
 320         }
 321
 322         return 0;
 323
 324 codec_err:
 325         for_each_prop_dai_codec(props, i, dai) {
 326                 if (i >= i2)
 327                         break;
 328                 simple_clk_disable(dai);
 329         }
 330 cpu_err:
 331         for_each_prop_dai_cpu(props, i, dai) {
 332                 if (i >= i1)
 333                         break;
 334                 simple_clk_disable(dai);
 335         }
 336         return ret;
 337 }
 338 EXPORT_SYMBOL_GPL(simple_util_startup);
 339
 340 void simple_util_shutdown(struct snd_pcm_substream *substream)
 341 {
 342         struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
 343         struct simple_util_priv *priv = snd_soc_card_get_drvdata(rtd->card);
 344         struct simple_dai_props *props = simple_priv_to_props(priv, rtd->num);
 345         struct simple_util_dai *dai;
 346         int i;
 347
 348         for_each_prop_dai_cpu(props, i, dai) {
 349                 struct snd_soc_dai *cpu_dai = snd_soc_rtd_to_cpu(rtd, i);
 350
 351                 if (props->mclk_fs && !dai->clk_fixed && !snd_soc_dai_active(cpu_dai))
 352                         snd_soc_dai_set_sysclk(cpu_dai,
 353                                                0, 0, SND_SOC_CLOCK_OUT);
 354
 355                 simple_clk_disable(dai);
 356         }
 357         for_each_prop_dai_codec(props, i, dai) {
 358                 struct snd_soc_dai *codec_dai = snd_soc_rtd_to_codec(rtd, i);
 359
 360                 if (props->mclk_fs && !dai->clk_fixed && !snd_soc_dai_active(codec_dai))
 361                         snd_soc_dai_set_sysclk(codec_dai,
 362                                                0, 0, SND_SOC_CLOCK_IN);
 363
 364                 simple_clk_disable(dai);
 365         }
 366 }
 367 EXPORT_SYMBOL_GPL(simple_util_shutdown);
 368
 369 static int simple_set_clk_rate(struct device *dev,
 370                                     struct simple_util_dai *simple_dai,
 371                                     unsigned long rate)
 372 {
 373         if (!simple_dai)
 374                 return 0;
 375
 376         if (simple_dai->clk_fixed && rate != simple_dai->sysclk) {
 377                 dev_err(dev, "dai %s invalid clock rate %lu\n", simple_dai->name, rate);
 378                 return -EINVAL;
 379         }
 380
 381         if (!simple_dai->clk)
 382                 return 0;
 383
 384         if (clk_get_rate(simple_dai->clk) == rate)
 385                 return 0;
 386
 387         return clk_set_rate(simple_dai->clk, rate);
 388 }
 389
 390 static int simple_set_tdm(struct snd_soc_dai *dai,
 391                                 struct simple_util_dai *simple_dai,
 392                                 struct snd_pcm_hw_params *params)
 393 {
 394         int sample_bits = params_width(params);
 395         int slot_width, slot_count;
 396         int i, ret;
 397
 398         if (!simple_dai || !simple_dai->tdm_width_map)
 399                 return 0;
 400
 401         slot_width = simple_dai->slot_width;
 402         slot_count = simple_dai->slots;
 403
 404         if (slot_width == 0)
 405                 slot_width = sample_bits;
 406
 407         for (i = 0; i < simple_dai->n_tdm_widths; ++i) {
 408                 if (simple_dai->tdm_width_map[i].sample_bits == sample_bits) {
 409                         slot_width = simple_dai->tdm_width_map[i].slot_width;
 410                         slot_count = simple_dai->tdm_width_map[i].slot_count;
 411                         break;
 412                 }
 413         }
 414
 415         ret = snd_soc_dai_set_tdm_slot(dai,
 416                                        simple_dai->tx_slot_mask,
 417                                        simple_dai->rx_slot_mask,
 418                                        slot_count,
 419                                        slot_width);
 420         if (ret && ret != -ENOTSUPP) {
 421                 dev_err(dai->dev, "simple-card: set_tdm_slot error: %d\n", ret);
 422                 return ret;
 423         }
 424
 425         return 0;
 426 }
 427
 428 int simple_util_hw_params(struct snd_pcm_substream *substream,
 429                           struct snd_pcm_hw_params *params)
 430 {
 431         struct snd_soc_pcm_runtime *rtd = snd_soc_substream_to_rtd(substream);
 432         struct simple_util_dai *pdai;
 433         struct snd_soc_dai *sdai;
 434         struct simple_util_priv *priv = snd_soc_card_get_drvdata(rtd->card);
 435         struct simple_dai_props *props = simple_priv_to_props(priv, rtd->num);
 436         unsigned int mclk, mclk_fs = 0;
 437         int i, ret;
 438
 439         if (props->mclk_fs)
 440                 mclk_fs = props->mclk_fs;
 441
 442         if (mclk_fs) {
 443                 struct snd_soc_component *component;
 444                 mclk = params_rate(params) * mclk_fs;
 445
 446                 for_each_prop_dai_codec(props, i, pdai) {
 447                         ret = simple_set_clk_rate(rtd->dev, pdai, mclk);
 448                         if (ret < 0)
 449                                 return ret;
 450                 }
 451
 452                 for_each_prop_dai_cpu(props, i, pdai) {
 453                         ret = simple_set_clk_rate(rtd->dev, pdai, mclk);
 454                         if (ret < 0)
 455                                 return ret;
 456                 }
 457
 458                 /* Ensure sysclk is set on all components in case any
 459                  * (such as platform components) are missed by calls to
 460                  * snd_soc_dai_set_sysclk.
 461                  */
 462                 for_each_rtd_components(rtd, i, component) {
 463                         ret = snd_soc_component_set_sysclk(component, 0, 0,
 464                                                            mclk, SND_SOC_CLOCK_IN);
 465                         if (ret && ret != -ENOTSUPP)
 466                                 return ret;
 467                 }
 468
 469                 for_each_rtd_codec_dais(rtd, i, sdai) {
 470                         ret = snd_soc_dai_set_sysclk(sdai, 0, mclk, SND_SOC_CLOCK_IN);
 471                         if (ret && ret != -ENOTSUPP)
 472                                 return ret;
 473                 }
 474
 475                 for_each_rtd_cpu_dais(rtd, i, sdai) {
 476                         ret = snd_soc_dai_set_sysclk(sdai, 0, mclk, SND_SOC_CLOCK_OUT);
 477                         if (ret && ret != -ENOTSUPP)
 478                                 return ret;
 479                 }
 480         }
 481
 482         for_each_prop_dai_codec(props, i, pdai) {
 483                 sdai = snd_soc_rtd_to_codec(rtd, i);
 484                 ret = simple_set_tdm(sdai, pdai, params);
 485                 if (ret < 0)
 486                         return ret;
 487         }
 488
 489         for_each_prop_dai_cpu(props, i, pdai) {
 490                 sdai = snd_soc_rtd_to_cpu(rtd, i);
 491                 ret = simple_set_tdm(sdai, pdai, params);
 492                 if (ret < 0)
 493                         return ret;
 494         }
 495
 496         return 0;
 497 }
 498 EXPORT_SYMBOL_GPL(simple_util_hw_params);
 499
 500 int simple_util_be_hw_params_fixup(struct snd_soc_pcm_runtime *rtd,
 501                                    struct snd_pcm_hw_params *params)
 502 {
 503         struct simple_util_priv *priv = snd_soc_card_get_drvdata(rtd->card);
 504         struct simple_dai_props *dai_props = simple_priv_to_props(priv, rtd->num);
 505         struct simple_util_data *data = &dai_props->adata;
 506         struct snd_interval *rate = hw_param_interval(params, SNDRV_PCM_HW_PARAM_RATE);
 507         struct snd_interval *channels = hw_param_interval(params, SNDRV_PCM_HW_PARAM_CHANNELS);
 508
 509         if (data->convert_rate)
 510                 rate->min =
 511                 rate->max = data->convert_rate;
 512
 513         if (data->convert_channels)
 514                 channels->min =
 515                 channels->max = data->convert_channels;
 516
 517         if (data->convert_sample_format)
 518                 simple_fixup_sample_fmt(data, params);
 519
 520         return 0;
 521 }
 522 EXPORT_SYMBOL_GPL(simple_util_be_hw_params_fixup);
 523
 524 static int simple_init_dai(struct snd_soc_dai *dai, struct simple_util_dai *simple_dai)
 525 {
 526         int ret;
 527
 528         if (!simple_dai)
 529                 return 0;
 530
 531         if (simple_dai->sysclk) {
 532                 ret = snd_soc_dai_set_sysclk(dai, 0, simple_dai->sysclk,
 533                                              simple_dai->clk_direction);
 534                 if (ret && ret != -ENOTSUPP) {
 535                         dev_err(dai->dev, "simple-card: set_sysclk error\n");
 536                         return ret;
 537                 }
 538         }
 539
 540         if (simple_dai->slots) {
 541                 ret = snd_soc_dai_set_tdm_slot(dai,
 542                                                simple_dai->tx_slot_mask,
 543                                                simple_dai->rx_slot_mask,
 544                                                simple_dai->slots,
 545                                                simple_dai->slot_width);
 546                 if (ret && ret != -ENOTSUPP) {
 547                         dev_err(dai->dev, "simple-card: set_tdm_slot error\n");
 548                         return ret;
 549                 }
 550         }
 551
 552         return 0;
 553 }
 554
 555 static inline int simple_component_is_codec(struct snd_soc_component *component)
 556 {
 557         return component->driver->endianness;
 558 }
 559
 560 static int simple_init_for_codec2codec(struct snd_soc_pcm_runtime *rtd,
 561                                        struct simple_dai_props *dai_props)
 562 {
 563         struct snd_soc_dai_link *dai_link = rtd->dai_link;
 564         struct snd_soc_component *component;
 565         struct snd_soc_pcm_stream *c2c_params;
 566         struct snd_pcm_hardware hw;
 567         int i, ret, stream;
 568
 569         /* Do nothing if it already has Codec2Codec settings */
 570         if (dai_link->c2c_params)
 571                 return 0;
 572
 573         /* Do nothing if it was DPCM :: BE */
 574         if (dai_link->no_pcm)
 575                 return 0;
 576
 577         /* Only Codecs */
 578         for_each_rtd_components(rtd, i, component) {
 579                 if (!simple_component_is_codec(component))
 580                         return 0;
 581         }
 582
 583         /* Assumes the capabilities are the same for all supported streams */
 584         for_each_pcm_streams(stream) {
 585                 ret = snd_soc_runtime_calc_hw(rtd, &hw, stream);
 586                 if (ret == 0)
 587                         break;
 588         }
 589
 590         if (ret < 0) {
 591                 dev_err(rtd->dev, "simple-card: no valid dai_link params\n");
 592                 return ret;
 593         }
 594
 595         c2c_params = devm_kzalloc(rtd->dev, sizeof(*c2c_params), GFP_KERNEL);
 596         if (!c2c_params)
 597                 return -ENOMEM;
 598
 599         c2c_params->formats             = hw.formats;
 600         c2c_params->rates               = hw.rates;
 601         c2c_params->rate_min            = hw.rate_min;
 602         c2c_params->rate_max            = hw.rate_max;
 603         c2c_params->channels_min        = hw.channels_min;
 604         c2c_params->channels_max        = hw.channels_max;
 605
 606         dai_link->c2c_params            = c2c_params;
 607         dai_link->num_c2c_params        = 1;
 608
 609         return 0;
 610 }
 611
 612 int simple_util_dai_init(struct snd_soc_pcm_runtime *rtd)
 613 {
 614         struct simple_util_priv *priv = snd_soc_card_get_drvdata(rtd->card);
 615         struct simple_dai_props *props = simple_priv_to_props(priv, rtd->num);
 616         struct simple_util_dai *dai;
 617         int i, ret;
 618
 619         for_each_prop_dai_codec(props, i, dai) {
 620                 ret = simple_init_dai(snd_soc_rtd_to_codec(rtd, i), dai);
 621                 if (ret < 0)
 622                         return ret;
 623         }
 624         for_each_prop_dai_cpu(props, i, dai) {
 625                 ret = simple_init_dai(snd_soc_rtd_to_cpu(rtd, i), dai);
 626                 if (ret < 0)
 627                         return ret;
 628         }
 629
 630         ret = simple_init_for_codec2codec(rtd, props);
 631         if (ret < 0)
 632                 return ret;
 633
 634         return 0;
 635 }
 636 EXPORT_SYMBOL_GPL(simple_util_dai_init);
 637
 638 void simple_util_canonicalize_platform(struct snd_soc_dai_link_component *platforms,
 639                                        struct snd_soc_dai_link_component *cpus)
 640 {
 641         /*
 642          * Assumes Platform == CPU
 643          *
 644          * Some CPU might be using soc-generic-dmaengine-pcm. This means CPU and Platform
 645          * are different Component, but are sharing same component->dev.
 646          *
 647          * Let's assume Platform is same as CPU if it doesn't identify Platform on DT.
 648          * see
 649          *      simple-card.c :: simple_count_noml()
 650          */
 651         if (!platforms->of_node)
 652                 snd_soc_dlc_use_cpu_as_platform(platforms, cpus);
 653 }
 654 EXPORT_SYMBOL_GPL(simple_util_canonicalize_platform);
 655
 656 void simple_util_canonicalize_cpu(struct snd_soc_dai_link_component *cpus,
 657                                   int is_single_links)
 658 {
 659         /*
 660          * In soc_bind_dai_link() will check cpu name after
 661          * of_node matching if dai_link has cpu_dai_name.
 662          * but, it will never match if name was created by
 663          * fmt_single_name() remove cpu_dai_name if cpu_args
 664          * was 0. See:
 665          *      fmt_single_name()
 666          *      fmt_multiple_name()
 667          */
 668         if (is_single_links)
 669                 cpus->dai_name = NULL;
 670 }
 671 EXPORT_SYMBOL_GPL(simple_util_canonicalize_cpu);
 672
 673 void simple_util_clean_reference(struct snd_soc_card *card)
 674 {
 675         struct snd_soc_dai_link *dai_link;
 676         struct snd_soc_dai_link_component *cpu;
 677         struct snd_soc_dai_link_component *codec;
 678         int i, j;
 679
 680         for_each_card_prelinks(card, i, dai_link) {
 681                 for_each_link_cpus(dai_link, j, cpu)
 682                         of_node_put(cpu->of_node);
 683                 for_each_link_codecs(dai_link, j, codec)
 684                         of_node_put(codec->of_node);
 685         }
 686 }
 687 EXPORT_SYMBOL_GPL(simple_util_clean_reference);
 688
 689 int simple_util_parse_routing(struct snd_soc_card *card,
 690                               char *prefix)
 691 {
 692         struct device_node *node = card->dev->of_node;
 693         char prop[128];
 694
 695         if (!prefix)
 696                 prefix = "";
 697
 698         snprintf(prop, sizeof(prop), "%s%s", prefix, "routing");
 699
 700         if (!of_property_read_bool(node, prop))
 701                 return 0;
 702
 703         return snd_soc_of_parse_audio_routing(card, prop);
 704 }
 705 EXPORT_SYMBOL_GPL(simple_util_parse_routing);
 706
 707 int simple_util_parse_widgets(struct snd_soc_card *card,
 708                               char *prefix)
 709 {
 710         struct device_node *node = card->dev->of_node;
 711         char prop[128];
 712
 713         if (!prefix)
 714                 prefix = "";
 715
 716         snprintf(prop, sizeof(prop), "%s%s", prefix, "widgets");
 717
 718         if (of_property_read_bool(node, prop))
 719                 return snd_soc_of_parse_audio_simple_widgets(card, prop);
 720
 721         /* no widgets is not error */
 722         return 0;
 723 }
 724 EXPORT_SYMBOL_GPL(simple_util_parse_widgets);
 725
 726 int simple_util_parse_pin_switches(struct snd_soc_card *card,
 727                                    char *prefix)
 728 {
 729         char prop[128];
 730
 731         if (!prefix)
 732                 prefix = "";
 733
 734         snprintf(prop, sizeof(prop), "%s%s", prefix, "pin-switches");
 735
 736         return snd_soc_of_parse_pin_switches(card, prop);
 737 }
 738 EXPORT_SYMBOL_GPL(simple_util_parse_pin_switches);
 739
 740 int simple_util_init_jack(struct snd_soc_card *card,
 741                           struct simple_util_jack *sjack,
 742                           int is_hp, char *prefix,
 743                           char *pin)
 744 {
 745         struct device *dev = card->dev;
 746         struct gpio_desc *desc;
 747         char prop[128];
 748         char *pin_name;
 749         char *gpio_name;
 750         int mask;
 751         int error;
 752
 753         if (!prefix)
 754                 prefix = "";
 755
 756         sjack->gpio.gpio = -ENOENT;
 757
 758         if (is_hp) {
 759                 snprintf(prop, sizeof(prop), "%shp-det", prefix);
 760                 pin_name        = pin ? pin : "Headphones";
 761                 gpio_name       = "Headphone detection";
 762                 mask            = SND_JACK_HEADPHONE;
 763         } else {
 764                 snprintf(prop, sizeof(prop), "%smic-det", prefix);
 765                 pin_name        = pin ? pin : "Mic Jack";
 766                 gpio_name       = "Mic detection";
 767                 mask            = SND_JACK_MICROPHONE;
 768         }
 769
 770         desc = gpiod_get_optional(dev, prop, GPIOD_IN);
 771         error = PTR_ERR_OR_ZERO(desc);
 772         if (error)
 773                 return error;
 774
 775         if (desc) {
 776                 error = gpiod_set_consumer_name(desc, gpio_name);
 777                 if (error)
 778                         return error;
 779
 780                 sjack->pin.pin          = pin_name;
 781                 sjack->pin.mask         = mask;
 782
 783                 sjack->gpio.name        = gpio_name;
 784                 sjack->gpio.report      = mask;
 785                 sjack->gpio.desc        = desc;
 786                 sjack->gpio.debounce_time = 150;
 787
 788                 snd_soc_card_jack_new_pins(card, pin_name, mask, &sjack->jack,
 789                                            &sjack->pin, 1);
 790
 791                 snd_soc_jack_add_gpios(&sjack->jack, 1, &sjack->gpio);
 792         }
 793
 794         return 0;
 795 }
 796 EXPORT_SYMBOL_GPL(simple_util_init_jack);
 797
 798 int simple_util_init_aux_jacks(struct simple_util_priv *priv, char *prefix)
 799 {
 800         struct snd_soc_card *card = simple_priv_to_card(priv);
 801         struct snd_soc_component *component;
 802         int found_jack_index = 0;
 803         int type = 0;
 804         int num = 0;
 805         int ret;
 806
 807         if (priv->aux_jacks)
 808                 return 0;
 809
 810         for_each_card_auxs(card, component) {
 811                 type = snd_soc_component_get_jack_type(component);
 812                 if (type > 0)
 813                         num++;
 814         }
 815         if (num < 1)
 816                 return 0;
 817
 818         priv->aux_jacks = devm_kcalloc(card->dev, num,
 819                                        sizeof(struct snd_soc_jack), GFP_KERNEL);
 820         if (!priv->aux_jacks)
 821                 return -ENOMEM;
 822
 823         for_each_card_auxs(card, component) {
 824                 char id[128];
 825                 struct snd_soc_jack *jack;
 826
 827                 if (found_jack_index >= num)
 828                         break;
 829
 830                 type = snd_soc_component_get_jack_type(component);
 831                 if (type <= 0)
 832                         continue;
 833
 834                 /* create jack */
 835                 jack = &(priv->aux_jacks[found_jack_index++]);
 836                 snprintf(id, sizeof(id), "%s-jack", component->name);
 837                 ret = snd_soc_card_jack_new(card, id, type, jack);
 838                 if (ret)
 839                         continue;
 840
 841                 (void)snd_soc_component_set_jack(component, jack, NULL);
 842         }
 843         return 0;
 844 }
 845 EXPORT_SYMBOL_GPL(simple_util_init_aux_jacks);
 846
 847 int simple_util_init_priv(struct simple_util_priv *priv,
 848                           struct link_info *li)
 849 {
 850         struct snd_soc_card *card = simple_priv_to_card(priv);
 851         struct device *dev = simple_priv_to_dev(priv);
 852         struct snd_soc_dai_link *dai_link;
 853         struct simple_dai_props *dai_props;
 854         struct simple_util_dai *dais;
 855         struct snd_soc_dai_link_component *dlcs;
 856         struct snd_soc_codec_conf *cconf = NULL;
 857         int i, dai_num = 0, dlc_num = 0, cnf_num = 0;
 858
 859         dai_props = devm_kcalloc(dev, li->link, sizeof(*dai_props), GFP_KERNEL);
 860         dai_link  = devm_kcalloc(dev, li->link, sizeof(*dai_link),  GFP_KERNEL);
 861         if (!dai_props || !dai_link)
 862                 return -ENOMEM;
 863
 864         /*
 865          * dais (= CPU+Codec)
 866          * dlcs (= CPU+Codec+Platform)
 867          */
 868         for (i = 0; i < li->link; i++) {
 869                 int cc = li->num[i].cpus + li->num[i].codecs;
 870
 871                 dai_num += cc;
 872                 dlc_num += cc + li->num[i].platforms;
 873
 874                 if (!li->num[i].cpus)
 875                         cnf_num += li->num[i].codecs;
 876         }
 877
 878         dais = devm_kcalloc(dev, dai_num, sizeof(*dais), GFP_KERNEL);
 879         dlcs = devm_kcalloc(dev, dlc_num, sizeof(*dlcs), GFP_KERNEL);
 880         if (!dais || !dlcs)
 881                 return -ENOMEM;
 882
 883         if (cnf_num) {
 884                 cconf = devm_kcalloc(dev, cnf_num, sizeof(*cconf), GFP_KERNEL);
 885                 if (!cconf)
 886                         return -ENOMEM;
 887         }
 888
 889         dev_dbg(dev, "link %d, dais %d, ccnf %d\n",
 890                 li->link, dai_num, cnf_num);
 891
 892         priv->dai_props         = dai_props;
 893         priv->dai_link          = dai_link;
 894         priv->dais              = dais;
 895         priv->dlcs              = dlcs;
 896         priv->codec_conf        = cconf;
 897
 898         card->dai_link          = priv->dai_link;
 899         card->num_links         = li->link;
 900         card->codec_conf        = cconf;
 901         card->num_configs       = cnf_num;
 902
 903         for (i = 0; i < li->link; i++) {
 904                 if (li->num[i].cpus) {
 905                         /* Normal CPU */
 906                         dai_link[i].cpus        = dlcs;
 907                         dai_props[i].num.cpus   =
 908                         dai_link[i].num_cpus    = li->num[i].cpus;
 909                         dai_props[i].cpu_dai    = dais;
 910
 911                         dlcs += li->num[i].cpus;
 912                         dais += li->num[i].cpus;
 913                 } else {
 914                         /* DPCM Be's CPU = dummy */
 915                         dai_link[i].cpus        = &snd_soc_dummy_dlc;
 916                         dai_props[i].num.cpus   =
 917                         dai_link[i].num_cpus    = 1;
 918                 }
 919
 920                 if (li->num[i].codecs) {
 921                         /* Normal Codec */
 922                         dai_link[i].codecs      = dlcs;
 923                         dai_props[i].num.codecs =
 924                         dai_link[i].num_codecs  = li->num[i].codecs;
 925                         dai_props[i].codec_dai  = dais;
 926
 927                         dlcs += li->num[i].codecs;
 928                         dais += li->num[i].codecs;
 929
 930                         if (!li->num[i].cpus) {
 931                                 /* DPCM Be's Codec */
 932                                 dai_props[i].codec_conf = cconf;
 933                                 cconf += li->num[i].codecs;
 934                         }
 935                 } else {
 936                         /* DPCM Fe's Codec = dummy */
 937                         dai_link[i].codecs      = &snd_soc_dummy_dlc;
 938                         dai_props[i].num.codecs =
 939                         dai_link[i].num_codecs  = 1;
 940                 }
 941
 942                 if (li->num[i].platforms) {
 943                         /* Have Platform */
 944                         dai_link[i].platforms           = dlcs;
 945                         dai_props[i].num.platforms      =
 946                         dai_link[i].num_platforms       = li->num[i].platforms;
 947
 948                         dlcs += li->num[i].platforms;
 949                 } else {
 950                         /* Doesn't have Platform */
 951                         dai_link[i].platforms           = NULL;
 952                         dai_props[i].num.platforms      =
 953                         dai_link[i].num_platforms       = 0;
 954                 }
 955         }
 956
 957         return 0;
 958 }
 959 EXPORT_SYMBOL_GPL(simple_util_init_priv);
 960
 961 void simple_util_remove(struct platform_device *pdev)
 962 {
 963         struct snd_soc_card *card = platform_get_drvdata(pdev);
 964
 965         simple_util_clean_reference(card);
 966 }
 967 EXPORT_SYMBOL_GPL(simple_util_remove);
 968
 969 int graph_util_card_probe(struct snd_soc_card *card)
 970 {
 971         struct simple_util_priv *priv = snd_soc_card_get_drvdata(card);
 972         int ret;
 973
 974         ret = simple_util_init_hp(card, &priv->hp_jack, NULL);
 975         if (ret < 0)
 976                 return ret;
 977
 978         ret = simple_util_init_mic(card, &priv->mic_jack, NULL);
 979         if (ret < 0)
 980                 return ret;
 981
 982         return 0;
 983 }
 984 EXPORT_SYMBOL_GPL(graph_util_card_probe);
 985
 986 int graph_util_is_ports0(struct device_node *np)
 987 {
 988         struct device_node *port, *ports, *ports0, *top;
 989         int ret;
 990
 991         /* np is "endpoint" or "port" */
 992         if (of_node_name_eq(np, "endpoint")) {
 993                 port = of_get_parent(np);
 994         } else {
 995                 port = np;
 996                 of_node_get(port);
 997         }
 998
 999         ports   = of_get_parent(port);
1000         top     = of_get_parent(ports);
1001         ports0  = of_get_child_by_name(top, "ports");
1002
1003         ret = ports0 == ports;
1004
1005         of_node_put(port);
1006         of_node_put(ports);
1007         of_node_put(ports0);
1008         of_node_put(top);
1009
1010         return ret;
1011 }
1012 EXPORT_SYMBOL_GPL(graph_util_is_ports0);
1013
1014 static int graph_get_dai_id(struct device_node *ep)
1015 {
1016         struct device_node *node;
1017         struct device_node *endpoint;
1018         struct of_endpoint info;
1019         int i, id;
1020         int ret;
1021
1022         /* use driver specified DAI ID if exist */
1023         ret = snd_soc_get_dai_id(ep);
1024         if (ret != -ENOTSUPP)
1025                 return ret;
1026
1027         /* use endpoint/port reg if exist */
1028         ret = of_graph_parse_endpoint(ep, &info);
1029         if (ret == 0) {
1030                 /*
1031                  * Because it will count port/endpoint if it doesn't have "reg".
1032                  * But, we can't judge whether it has "no reg", or "reg = <0>"
1033                  * only of_graph_parse_endpoint().
1034                  * We need to check "reg" property
1035                  */
1036                 if (of_property_present(ep,   "reg"))
1037                         return info.id;
1038
1039                 node = of_get_parent(ep);
1040                 ret = of_property_present(node, "reg");
1041                 of_node_put(node);
1042                 if (ret)
1043                         return info.port;
1044         }
1045         node = of_graph_get_port_parent(ep);
1046
1047         /*
1048          * Non HDMI sound case, counting port/endpoint on its DT
1049          * is enough. Let's count it.
1050          */
1051         i = 0;
1052         id = -1;
1053         for_each_endpoint_of_node(node, endpoint) {
1054                 if (endpoint == ep)
1055                         id = i;
1056                 i++;
1057         }
1058
1059         of_node_put(node);
1060
1061         if (id < 0)
1062                 return -ENODEV;
1063
1064         return id;
1065 }
1066
1067 int graph_util_parse_dai(struct device *dev, struct device_node *ep,
1068                          struct snd_soc_dai_link_component *dlc, int *is_single_link)
1069 {
1070         struct device_node *node;
1071         struct of_phandle_args args = {};
1072         struct snd_soc_dai *dai;
1073         int ret;
1074
1075         if (!ep)
1076                 return 0;
1077
1078         node = of_graph_get_port_parent(ep);
1079
1080         /*
1081          * Try to find from DAI node
1082          */
1083         args.np = ep;
1084         dai = snd_soc_get_dai_via_args(&args);
1085         if (dai) {
1086                 dlc->dai_name = snd_soc_dai_name_get(dai);
1087                 dlc->dai_args = snd_soc_copy_dai_args(dev, &args);
1088                 if (!dlc->dai_args)
1089                         return -ENOMEM;
1090
1091                 goto parse_dai_end;
1092         }
1093
1094         /* Get dai->name */
1095         args.np         = node;
1096         args.args[0]    = graph_get_dai_id(ep);
1097         args.args_count = (of_graph_get_endpoint_count(node) > 1);
1098
1099         /*
1100          * FIXME
1101          *
1102          * Here, dlc->dai_name is pointer to CPU/Codec DAI name.
1103          * If user unbinded CPU or Codec driver, but not for Sound Card,
1104          * dlc->dai_name is keeping unbinded CPU or Codec
1105          * driver's pointer.
1106          *
1107          * If user re-bind CPU or Codec driver again, ALSA SoC will try
1108          * to rebind Card via snd_soc_try_rebind_card(), but because of
1109          * above reason, it might can't bind Sound Card.
1110          * Because Sound Card is pointing to released dai_name pointer.
1111          *
1112          * To avoid this rebind Card issue,
1113          * 1) It needs to alloc memory to keep dai_name eventhough
1114          *    CPU or Codec driver was unbinded, or
1115          * 2) user need to rebind Sound Card everytime
1116          *    if he unbinded CPU or Codec.
1117          */
1118         ret = snd_soc_get_dlc(&args, dlc);
1119         if (ret < 0) {
1120                 of_node_put(node);
1121                 return ret;
1122         }
1123
1124 parse_dai_end:
1125         if (is_single_link)
1126                 *is_single_link = of_graph_get_endpoint_count(node) == 1;
1127
1128         return 0;
1129 }
1130 EXPORT_SYMBOL_GPL(graph_util_parse_dai);
1131
1132 /* Module information */
1133 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>");
1134 MODULE_DESCRIPTION("ALSA SoC Simple Card Utils");
1135 MODULE_LICENSE("GPL v2");