1 // SPDX-License-Identifier: GPL-2.0 2 // 3 // ASoC audio graph sound card support 4 // 5 // Copyright (C) 2016 Renesas Solutions Corp. 6 // Kuninori Morimoto <kuninori.morimoto.gx@renesas.com> 7 // 8 // based on ${LINUX}/sound/soc/generic/simple-card.c 9 10 #include <linux/cleanup.h> 11 #include <linux/clk.h> 12 #include <linux/device.h> 13 #include <linux/gpio/consumer.h> 14 #include <linux/module.h> 15 #include <linux/of.h> 16 #include <linux/of_graph.h> 17 #include <linux/platform_device.h> 18 #include <linux/string.h> 19 #include <sound/graph_card.h> 20 21 #define DPCM_SELECTABLE 1 22 23 #define ep_to_port(ep) of_get_parent(ep) 24 static struct device_node *port_to_ports(struct device_node *port) 25 { 26 struct device_node *ports = of_get_parent(port); 27 28 if (!of_node_name_eq(ports, "ports")) { 29 of_node_put(ports); 30 return NULL; 31 } 32 return ports; 33 } 34 35 static int graph_outdrv_event(struct snd_soc_dapm_widget *w, 36 struct snd_kcontrol *kcontrol, 37 int event) 38 { 39 struct snd_soc_dapm_context *dapm = w->dapm; 40 struct simple_util_priv *priv = snd_soc_card_get_drvdata(dapm->card); 41 42 switch (event) { 43 case SND_SOC_DAPM_POST_PMU: 44 gpiod_set_value_cansleep(priv->pa_gpio, 1); 45 break; 46 case SND_SOC_DAPM_PRE_PMD: 47 gpiod_set_value_cansleep(priv->pa_gpio, 0); 48 break; 49 default: 50 return -EINVAL; 51 } 52 53 return 0; 54 } 55 56 static const struct snd_soc_dapm_widget graph_dapm_widgets[] = { 57 SND_SOC_DAPM_OUT_DRV_E("Amplifier", SND_SOC_NOPM, 58 0, 0, NULL, 0, graph_outdrv_event, 59 SND_SOC_DAPM_POST_PMU | SND_SOC_DAPM_PRE_PMD), 60 }; 61 62 static const struct snd_soc_ops graph_ops = { 63 .startup = simple_util_startup, 64 .shutdown = simple_util_shutdown, 65 .hw_params = simple_util_hw_params, 66 }; 67 68 static bool soc_component_is_pcm(struct snd_soc_dai_link_component *dlc) 69 { 70 struct snd_soc_dai *dai = snd_soc_find_dai_with_mutex(dlc); 71 72 if (dai && (dai->component->driver->pcm_construct || 73 (dai->driver->ops && dai->driver->ops->pcm_new))) 74 return true; 75 76 return false; 77 } 78 79 static void graph_parse_convert(struct device *dev, 80 struct device_node *ep, 81 struct simple_util_data *adata) 82 { 83 struct device_node *top = dev->of_node; 84 struct device_node *port __free(device_node) = ep_to_port(ep); 85 struct device_node *ports __free(device_node) = port_to_ports(port); 86 struct device_node *node __free(device_node) = of_graph_get_port_parent(ep); 87 88 simple_util_parse_convert(top, NULL, adata); 89 simple_util_parse_convert(ports, NULL, adata); 90 simple_util_parse_convert(port, NULL, adata); 91 simple_util_parse_convert(ep, NULL, adata); 92 } 93 94 static int graph_parse_node(struct simple_util_priv *priv, 95 struct device_node *ep, 96 struct link_info *li, 97 int *cpu) 98 { 99 struct device *dev = simple_priv_to_dev(priv); 100 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link); 101 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link); 102 struct snd_soc_dai_link_component *dlc; 103 struct simple_util_dai *dai; 104 int ret; 105 106 if (cpu) { 107 dlc = snd_soc_link_to_cpu(dai_link, 0); 108 dai = simple_props_to_dai_cpu(dai_props, 0); 109 } else { 110 dlc = snd_soc_link_to_codec(dai_link, 0); 111 dai = simple_props_to_dai_codec(dai_props, 0); 112 } 113 114 ret = graph_util_parse_dai(dev, ep, dlc, cpu); 115 if (ret < 0) 116 return ret; 117 118 ret = simple_util_parse_tdm(ep, dai); 119 if (ret < 0) 120 return ret; 121 122 ret = simple_util_parse_clk(dev, ep, dai, dlc); 123 if (ret < 0) 124 return ret; 125 126 return 0; 127 } 128 129 static int graph_link_init(struct simple_util_priv *priv, 130 struct device_node *ep_cpu, 131 struct device_node *ep_codec, 132 struct link_info *li, 133 char *name) 134 { 135 struct device *dev = simple_priv_to_dev(priv); 136 struct device_node *top = dev->of_node; 137 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link); 138 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link); 139 struct device_node *port_cpu __free(device_node) = ep_to_port(ep_cpu); 140 struct device_node *port_codec __free(device_node) = ep_to_port(ep_codec); 141 struct device_node *ports_cpu __free(device_node) = port_to_ports(port_cpu); 142 struct device_node *ports_codec __free(device_node) = port_to_ports(port_codec); 143 enum snd_soc_trigger_order trigger_start = SND_SOC_TRIGGER_ORDER_DEFAULT; 144 enum snd_soc_trigger_order trigger_stop = SND_SOC_TRIGGER_ORDER_DEFAULT; 145 bool playback_only = 0, capture_only = 0; 146 int ret; 147 148 ret = simple_util_parse_daifmt(dev, ep_cpu, ep_codec, 149 NULL, &dai_link->dai_fmt); 150 if (ret < 0) 151 return ret; 152 153 graph_util_parse_link_direction(top, &playback_only, &capture_only); 154 graph_util_parse_link_direction(port_cpu, &playback_only, &capture_only); 155 graph_util_parse_link_direction(port_codec, &playback_only, &capture_only); 156 graph_util_parse_link_direction(ep_cpu, &playback_only, &capture_only); 157 graph_util_parse_link_direction(ep_codec, &playback_only, &capture_only); 158 159 of_property_read_u32(top, "mclk-fs", &dai_props->mclk_fs); 160 of_property_read_u32(ports_cpu, "mclk-fs", &dai_props->mclk_fs); 161 of_property_read_u32(ports_codec, "mclk-fs", &dai_props->mclk_fs); 162 of_property_read_u32(port_cpu, "mclk-fs", &dai_props->mclk_fs); 163 of_property_read_u32(port_codec, "mclk-fs", &dai_props->mclk_fs); 164 of_property_read_u32(ep_cpu, "mclk-fs", &dai_props->mclk_fs); 165 of_property_read_u32(ep_codec, "mclk-fs", &dai_props->mclk_fs); 166 167 graph_util_parse_trigger_order(priv, top, &trigger_start, &trigger_stop); 168 graph_util_parse_trigger_order(priv, ports_cpu, &trigger_start, &trigger_stop); 169 graph_util_parse_trigger_order(priv, ports_codec, &trigger_start, &trigger_stop); 170 graph_util_parse_trigger_order(priv, port_cpu, &trigger_start, &trigger_stop); 171 graph_util_parse_trigger_order(priv, port_cpu, &trigger_start, &trigger_stop); 172 graph_util_parse_trigger_order(priv, ep_cpu, &trigger_start, &trigger_stop); 173 graph_util_parse_trigger_order(priv, ep_codec, &trigger_start, &trigger_stop); 174 175 dai_link->playback_only = playback_only; 176 dai_link->capture_only = capture_only; 177 178 dai_link->trigger_start = trigger_start; 179 dai_link->trigger_stop = trigger_stop; 180 181 dai_link->init = simple_util_dai_init; 182 dai_link->ops = &graph_ops; 183 if (priv->ops) 184 dai_link->ops = priv->ops; 185 186 return simple_util_set_dailink_name(dev, dai_link, name); 187 } 188 189 static int graph_dai_link_of_dpcm(struct simple_util_priv *priv, 190 struct device_node *cpu_ep, 191 struct device_node *codec_ep, 192 struct link_info *li) 193 { 194 struct device *dev = simple_priv_to_dev(priv); 195 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link); 196 struct simple_dai_props *dai_props = simple_priv_to_props(priv, li->link); 197 struct device_node *top = dev->of_node; 198 struct device_node *ep = li->cpu ? cpu_ep : codec_ep; 199 char dai_name[64]; 200 int ret; 201 202 dev_dbg(dev, "link_of DPCM (%pOF)\n", ep); 203 204 if (li->cpu) { 205 struct snd_soc_card *card = simple_priv_to_card(priv); 206 struct snd_soc_dai_link_component *cpus = snd_soc_link_to_cpu(dai_link, 0); 207 struct snd_soc_dai_link_component *platforms = snd_soc_link_to_platform(dai_link, 0); 208 int is_single_links = 0; 209 210 /* Codec is dummy */ 211 212 /* FE settings */ 213 dai_link->dynamic = 1; 214 dai_link->dpcm_merged_format = 1; 215 216 ret = graph_parse_node(priv, cpu_ep, li, &is_single_links); 217 if (ret) 218 return ret; 219 220 snprintf(dai_name, sizeof(dai_name), 221 "fe.%pOFP.%s", cpus->of_node, cpus->dai_name); 222 /* 223 * In BE<->BE connections it is not required to create 224 * PCM devices at CPU end of the dai link and thus 'no_pcm' 225 * flag needs to be set. It is useful when there are many 226 * BE components and some of these have to be connected to 227 * form a valid audio path. 228 * 229 * For example: FE <-> BE1 <-> BE2 <-> ... <-> BEn where 230 * there are 'n' BE components in the path. 231 */ 232 if (card->component_chaining && !soc_component_is_pcm(cpus)) { 233 dai_link->no_pcm = 1; 234 dai_link->be_hw_params_fixup = simple_util_be_hw_params_fixup; 235 } 236 237 simple_util_canonicalize_cpu(cpus, is_single_links); 238 simple_util_canonicalize_platform(platforms, cpus); 239 } else { 240 struct snd_soc_codec_conf *cconf = simple_props_to_codec_conf(dai_props, 0); 241 struct snd_soc_dai_link_component *codecs = snd_soc_link_to_codec(dai_link, 0); 242 243 /* CPU is dummy */ 244 245 /* BE settings */ 246 dai_link->no_pcm = 1; 247 dai_link->be_hw_params_fixup = simple_util_be_hw_params_fixup; 248 249 ret = graph_parse_node(priv, codec_ep, li, NULL); 250 if (ret < 0) 251 return ret; 252 253 snprintf(dai_name, sizeof(dai_name), 254 "be.%pOFP.%s", codecs->of_node, codecs->dai_name); 255 256 /* check "prefix" from top node */ 257 struct device_node *port __free(device_node) = ep_to_port(ep); 258 struct device_node *ports __free(device_node) = port_to_ports(port); 259 260 snd_soc_of_parse_node_prefix(top, cconf, codecs->of_node, "prefix"); 261 snd_soc_of_parse_node_prefix(ports, cconf, codecs->of_node, "prefix"); 262 snd_soc_of_parse_node_prefix(port, cconf, codecs->of_node, "prefix"); 263 } 264 265 graph_parse_convert(dev, ep, &dai_props->adata); 266 267 ret = graph_link_init(priv, cpu_ep, codec_ep, li, dai_name); 268 269 li->link++; 270 271 return ret; 272 } 273 274 static int graph_dai_link_of(struct simple_util_priv *priv, 275 struct device_node *cpu_ep, 276 struct device_node *codec_ep, 277 struct link_info *li) 278 { 279 struct device *dev = simple_priv_to_dev(priv); 280 struct snd_soc_dai_link *dai_link = simple_priv_to_link(priv, li->link); 281 struct snd_soc_dai_link_component *cpus = snd_soc_link_to_cpu(dai_link, 0); 282 struct snd_soc_dai_link_component *codecs = snd_soc_link_to_codec(dai_link, 0); 283 struct snd_soc_dai_link_component *platforms = snd_soc_link_to_platform(dai_link, 0); 284 char dai_name[64]; 285 int ret, is_single_links = 0; 286 287 dev_dbg(dev, "link_of (%pOF)\n", cpu_ep); 288 289 ret = graph_parse_node(priv, cpu_ep, li, &is_single_links); 290 if (ret < 0) 291 return ret; 292 293 ret = graph_parse_node(priv, codec_ep, li, NULL); 294 if (ret < 0) 295 return ret; 296 297 snprintf(dai_name, sizeof(dai_name), 298 "%s-%s", cpus->dai_name, codecs->dai_name); 299 300 simple_util_canonicalize_cpu(cpus, is_single_links); 301 simple_util_canonicalize_platform(platforms, cpus); 302 303 ret = graph_link_init(priv, cpu_ep, codec_ep, li, dai_name); 304 if (ret < 0) 305 return ret; 306 307 li->link++; 308 309 return 0; 310 } 311 312 static inline bool parse_as_dpcm_link(struct simple_util_priv *priv, 313 struct device_node *codec_port, 314 struct simple_util_data *adata) 315 { 316 if (priv->force_dpcm) 317 return true; 318 319 if (!priv->dpcm_selectable) 320 return false; 321 322 /* 323 * It is DPCM 324 * if Codec port has many endpoints, 325 * or has convert-xxx property 326 */ 327 if ((of_get_child_count(codec_port) > 1) || 328 simple_util_is_convert_required(adata)) 329 return true; 330 331 return false; 332 } 333 334 static int __graph_for_each_link(struct simple_util_priv *priv, 335 struct link_info *li, 336 int (*func_noml)(struct simple_util_priv *priv, 337 struct device_node *cpu_ep, 338 struct device_node *codec_ep, 339 struct link_info *li), 340 int (*func_dpcm)(struct simple_util_priv *priv, 341 struct device_node *cpu_ep, 342 struct device_node *codec_ep, 343 struct link_info *li)) 344 { 345 struct of_phandle_iterator it; 346 struct device *dev = simple_priv_to_dev(priv); 347 struct device_node *node = dev->of_node; 348 struct device_node *cpu_port; 349 struct device_node *codec_port_old = NULL; 350 struct simple_util_data adata; 351 int rc, ret = 0; 352 353 /* loop for all listed CPU port */ 354 of_for_each_phandle(&it, rc, node, "dais", NULL, 0) { 355 cpu_port = it.node; 356 357 /* loop for all CPU endpoint */ 358 for_each_of_graph_port_endpoint(cpu_port, cpu_ep) { 359 /* get codec */ 360 struct device_node *codec_ep __free(device_node) = of_graph_get_remote_endpoint(cpu_ep); 361 struct device_node *codec_port __free(device_node) = ep_to_port(codec_ep); 362 363 /* get convert-xxx property */ 364 memset(&adata, 0, sizeof(adata)); 365 graph_parse_convert(dev, codec_ep, &adata); 366 graph_parse_convert(dev, cpu_ep, &adata); 367 368 /* check if link requires DPCM parsing */ 369 if (parse_as_dpcm_link(priv, codec_port, &adata)) { 370 /* 371 * Codec endpoint can be NULL for pluggable audio HW. 372 * Platform DT can populate the Codec endpoint depending on the 373 * plugged HW. 374 */ 375 /* Do it all CPU endpoint, and 1st Codec endpoint */ 376 if (li->cpu || 377 ((codec_port_old != codec_port) && codec_ep)) 378 ret = func_dpcm(priv, cpu_ep, codec_ep, li); 379 /* else normal sound */ 380 } else { 381 if (li->cpu) 382 ret = func_noml(priv, cpu_ep, codec_ep, li); 383 } 384 385 if (ret < 0) 386 return ret; 387 388 codec_port_old = codec_port; 389 } 390 } 391 392 return 0; 393 } 394 395 static int graph_for_each_link(struct simple_util_priv *priv, 396 struct link_info *li, 397 int (*func_noml)(struct simple_util_priv *priv, 398 struct device_node *cpu_ep, 399 struct device_node *codec_ep, 400 struct link_info *li), 401 int (*func_dpcm)(struct simple_util_priv *priv, 402 struct device_node *cpu_ep, 403 struct device_node *codec_ep, 404 struct link_info *li)) 405 { 406 int ret; 407 /* 408 * Detect all CPU first, and Detect all Codec 2nd. 409 * 410 * In Normal sound case, all DAIs are detected 411 * as "CPU-Codec". 412 * 413 * In DPCM sound case, 414 * all CPUs are detected as "CPU-dummy", and 415 * all Codecs are detected as "dummy-Codec". 416 * To avoid random sub-device numbering, 417 * detect "dummy-Codec" in last; 418 */ 419 for (li->cpu = 1; li->cpu >= 0; li->cpu--) { 420 ret = __graph_for_each_link(priv, li, func_noml, func_dpcm); 421 if (ret < 0) 422 break; 423 } 424 425 return ret; 426 } 427 428 static int graph_count_noml(struct simple_util_priv *priv, 429 struct device_node *cpu_ep, 430 struct device_node *codec_ep, 431 struct link_info *li) 432 { 433 struct device *dev = simple_priv_to_dev(priv); 434 435 if (li->link >= SNDRV_MAX_LINKS) { 436 dev_err(dev, "too many links\n"); 437 return -EINVAL; 438 } 439 440 /* 441 * DON'T REMOVE platforms 442 * see 443 * simple-card.c :: simple_count_noml() 444 */ 445 li->num[li->link].cpus = 1; 446 li->num[li->link].platforms = 1; 447 448 li->num[li->link].codecs = 1; 449 450 li->link += 1; /* 1xCPU-Codec */ 451 452 dev_dbg(dev, "Count As Normal\n"); 453 454 return 0; 455 } 456 457 static int graph_count_dpcm(struct simple_util_priv *priv, 458 struct device_node *cpu_ep, 459 struct device_node *codec_ep, 460 struct link_info *li) 461 { 462 struct device *dev = simple_priv_to_dev(priv); 463 464 if (li->link >= SNDRV_MAX_LINKS) { 465 dev_err(dev, "too many links\n"); 466 return -EINVAL; 467 } 468 469 if (li->cpu) { 470 /* 471 * DON'T REMOVE platforms 472 * see 473 * simple-card.c :: simple_count_noml() 474 */ 475 li->num[li->link].cpus = 1; 476 li->num[li->link].platforms = 1; 477 478 li->link++; /* 1xCPU-dummy */ 479 } else { 480 li->num[li->link].codecs = 1; 481 482 li->link++; /* 1xdummy-Codec */ 483 } 484 485 dev_dbg(dev, "Count As DPCM\n"); 486 487 return 0; 488 } 489 490 static int graph_get_dais_count(struct simple_util_priv *priv, 491 struct link_info *li) 492 { 493 /* 494 * link_num : number of links. 495 * CPU-Codec / CPU-dummy / dummy-Codec 496 * dais_num : number of DAIs 497 * ccnf_num : number of codec_conf 498 * same number for "dummy-Codec" 499 * 500 * ex1) 501 * CPU0 --- Codec0 link : 5 502 * CPU1 --- Codec1 dais : 7 503 * CPU2 -/ ccnf : 1 504 * CPU3 --- Codec2 505 * 506 * => 5 links = 2xCPU-Codec + 2xCPU-dummy + 1xdummy-Codec 507 * => 7 DAIs = 4xCPU + 3xCodec 508 * => 1 ccnf = 1xdummy-Codec 509 * 510 * ex2) 511 * CPU0 --- Codec0 link : 5 512 * CPU1 --- Codec1 dais : 6 513 * CPU2 -/ ccnf : 1 514 * CPU3 -/ 515 * 516 * => 5 links = 1xCPU-Codec + 3xCPU-dummy + 1xdummy-Codec 517 * => 6 DAIs = 4xCPU + 2xCodec 518 * => 1 ccnf = 1xdummy-Codec 519 * 520 * ex3) 521 * CPU0 --- Codec0 link : 6 522 * CPU1 -/ dais : 6 523 * CPU2 --- Codec1 ccnf : 2 524 * CPU3 -/ 525 * 526 * => 6 links = 0xCPU-Codec + 4xCPU-dummy + 2xdummy-Codec 527 * => 6 DAIs = 4xCPU + 2xCodec 528 * => 2 ccnf = 2xdummy-Codec 529 * 530 * ex4) 531 * CPU0 --- Codec0 (convert-rate) link : 3 532 * CPU1 --- Codec1 dais : 4 533 * ccnf : 1 534 * 535 * => 3 links = 1xCPU-Codec + 1xCPU-dummy + 1xdummy-Codec 536 * => 4 DAIs = 2xCPU + 2xCodec 537 * => 1 ccnf = 1xdummy-Codec 538 */ 539 return graph_for_each_link(priv, li, 540 graph_count_noml, 541 graph_count_dpcm); 542 } 543 544 int audio_graph_parse_of(struct simple_util_priv *priv, struct device *dev) 545 { 546 struct snd_soc_card *card = simple_priv_to_card(priv); 547 int ret; 548 549 struct link_info *li __free(kfree) = kzalloc(sizeof(*li), GFP_KERNEL); 550 if (!li) 551 return -ENOMEM; 552 553 card->owner = THIS_MODULE; 554 card->dev = dev; 555 556 ret = graph_get_dais_count(priv, li); 557 if (ret < 0) 558 return ret; 559 560 if (!li->link) 561 return -EINVAL; 562 563 ret = simple_util_init_priv(priv, li); 564 if (ret < 0) 565 return ret; 566 567 priv->pa_gpio = devm_gpiod_get_optional(dev, "pa", GPIOD_OUT_LOW); 568 if (IS_ERR(priv->pa_gpio)) { 569 ret = PTR_ERR(priv->pa_gpio); 570 dev_err(dev, "failed to get amplifier gpio: %d\n", ret); 571 return ret; 572 } 573 574 ret = simple_util_parse_widgets(card, NULL); 575 if (ret < 0) 576 return ret; 577 578 ret = simple_util_parse_routing(card, NULL); 579 if (ret < 0) 580 return ret; 581 582 memset(li, 0, sizeof(*li)); 583 ret = graph_for_each_link(priv, li, 584 graph_dai_link_of, 585 graph_dai_link_of_dpcm); 586 if (ret < 0) 587 goto err; 588 589 ret = simple_util_parse_card_name(card, NULL); 590 if (ret < 0) 591 goto err; 592 593 snd_soc_card_set_drvdata(card, priv); 594 595 simple_util_debug_info(priv); 596 597 ret = devm_snd_soc_register_card(dev, card); 598 if (ret < 0) 599 goto err; 600 601 return 0; 602 603 err: 604 simple_util_clean_reference(card); 605 606 return dev_err_probe(dev, ret, "parse error\n"); 607 } 608 EXPORT_SYMBOL_GPL(audio_graph_parse_of); 609 610 static int graph_probe(struct platform_device *pdev) 611 { 612 struct simple_util_priv *priv; 613 struct device *dev = &pdev->dev; 614 struct snd_soc_card *card; 615 616 /* Allocate the private data and the DAI link array */ 617 priv = devm_kzalloc(dev, sizeof(*priv), GFP_KERNEL); 618 if (!priv) 619 return -ENOMEM; 620 621 card = simple_priv_to_card(priv); 622 card->dapm_widgets = graph_dapm_widgets; 623 card->num_dapm_widgets = ARRAY_SIZE(graph_dapm_widgets); 624 card->probe = graph_util_card_probe; 625 626 if (of_device_get_match_data(dev)) 627 priv->dpcm_selectable = 1; 628 629 return audio_graph_parse_of(priv, dev); 630 } 631 632 static const struct of_device_id graph_of_match[] = { 633 { .compatible = "audio-graph-card", }, 634 { .compatible = "audio-graph-scu-card", 635 .data = (void *)DPCM_SELECTABLE }, 636 {}, 637 }; 638 MODULE_DEVICE_TABLE(of, graph_of_match); 639 640 static struct platform_driver graph_card = { 641 .driver = { 642 .name = "asoc-audio-graph-card", 643 .pm = &snd_soc_pm_ops, 644 .of_match_table = graph_of_match, 645 }, 646 .probe = graph_probe, 647 .remove = simple_util_remove, 648 }; 649 module_platform_driver(graph_card); 650 651 MODULE_ALIAS("platform:asoc-audio-graph-card"); 652 MODULE_LICENSE("GPL v2"); 653 MODULE_DESCRIPTION("ASoC Audio Graph Sound Card"); 654 MODULE_AUTHOR("Kuninori Morimoto <kuninori.morimoto.gx@renesas.com>"); 655