drivers/remoteproc/qcom_q6v5_pas.c

   1 // SPDX-License-Identifier: GPL-2.0-only
   2 /*
   3  * Qualcomm ADSP/SLPI Peripheral Image Loader for MSM8974 and MSM8996
   4  *
   5  * Copyright (C) 2016 Linaro Ltd
   6  * Copyright (C) 2014 Sony Mobile Communications AB
   7  * Copyright (c) 2012-2013, The Linux Foundation. All rights reserved.
   8  */
   9
  10 #include <linux/clk.h>
  11 #include <linux/firmware.h>
  12 #include <linux/interrupt.h>
  13 #include <linux/kernel.h>
  14 #include <linux/module.h>
  15 #include <linux/of_address.h>
  16 #include <linux/of_device.h>
  17 #include <linux/platform_device.h>
  18 #include <linux/pm_domain.h>
  19 #include <linux/pm_runtime.h>
  20 #include <linux/qcom_scm.h>
  21 #include <linux/regulator/consumer.h>
  22 #include <linux/remoteproc.h>
  23 #include <linux/soc/qcom/mdt_loader.h>
  24 #include <linux/soc/qcom/smem.h>
  25 #include <linux/soc/qcom/smem_state.h>
  26
  27 #include "qcom_common.h"
  28 #include "qcom_q6v5.h"
  29 #include "remoteproc_internal.h"
  30
  31 struct adsp_data {
  32         int crash_reason_smem;
  33         const char *firmware_name;
  34         int pas_id;
  35         bool has_aggre2_clk;
  36
  37         char **active_pd_names;
  38         char **proxy_pd_names;
  39
  40         const char *ssr_name;
  41         const char *sysmon_name;
  42         int ssctl_id;
  43 };
  44
  45 struct qcom_adsp {
  46         struct device *dev;
  47         struct rproc *rproc;
  48
  49         struct qcom_q6v5 q6v5;
  50
  51         struct clk *xo;
  52         struct clk *aggre2_clk;
  53
  54         struct regulator *cx_supply;
  55         struct regulator *px_supply;
  56
  57         struct device *active_pds[1];
  58         struct device *proxy_pds[3];
  59
  60         int active_pd_count;
  61         int proxy_pd_count;
  62
  63         int pas_id;
  64         int crash_reason_smem;
  65         bool has_aggre2_clk;
  66
  67         struct completion start_done;
  68         struct completion stop_done;
  69
  70         phys_addr_t mem_phys;
  71         phys_addr_t mem_reloc;
  72         void *mem_region;
  73         size_t mem_size;
  74
  75         struct qcom_rproc_glink glink_subdev;
  76         struct qcom_rproc_subdev smd_subdev;
  77         struct qcom_rproc_ssr ssr_subdev;
  78         struct qcom_sysmon *sysmon;
  79 };
  80
  81 static int adsp_pds_enable(struct qcom_adsp *adsp, struct device **pds,
  82                            size_t pd_count)
  83 {
  84         int ret;
  85         int i;
  86
  87         for (i = 0; i < pd_count; i++) {
  88                 dev_pm_genpd_set_performance_state(pds[i], INT_MAX);
  89                 ret = pm_runtime_get_sync(pds[i]);
  90                 if (ret < 0)
  91                         goto unroll_pd_votes;
  92         }
  93
  94         return 0;
  95
  96 unroll_pd_votes:
  97         for (i--; i >= 0; i--) {
  98                 dev_pm_genpd_set_performance_state(pds[i], 0);
  99                 pm_runtime_put(pds[i]);
 100         }
 101
 102         return ret;
 103 };
 104
 105 static void adsp_pds_disable(struct qcom_adsp *adsp, struct device **pds,
 106                              size_t pd_count)
 107 {
 108         int i;
 109
 110         for (i = 0; i < pd_count; i++) {
 111                 dev_pm_genpd_set_performance_state(pds[i], 0);
 112                 pm_runtime_put(pds[i]);
 113         }
 114 }
 115
 116 static int adsp_load(struct rproc *rproc, const struct firmware *fw)
 117 {
 118         struct qcom_adsp *adsp = (struct qcom_adsp *)rproc->priv;
 119
 120         return qcom_mdt_load(adsp->dev, fw, rproc->firmware, adsp->pas_id,
 121                              adsp->mem_region, adsp->mem_phys, adsp->mem_size,
 122                              &adsp->mem_reloc);
 123
 124 }
 125
 126 static int adsp_start(struct rproc *rproc)
 127 {
 128         struct qcom_adsp *adsp = (struct qcom_adsp *)rproc->priv;
 129         int ret;
 130
 131         qcom_q6v5_prepare(&adsp->q6v5);
 132
 133         ret = adsp_pds_enable(adsp, adsp->active_pds, adsp->active_pd_count);
 134         if (ret < 0)
 135                 goto disable_irqs;
 136
 137         ret = adsp_pds_enable(adsp, adsp->proxy_pds, adsp->proxy_pd_count);
 138         if (ret < 0)
 139                 goto disable_active_pds;
 140
 141         ret = clk_prepare_enable(adsp->xo);
 142         if (ret)
 143                 goto disable_proxy_pds;
 144
 145         ret = clk_prepare_enable(adsp->aggre2_clk);
 146         if (ret)
 147                 goto disable_xo_clk;
 148
 149         ret = regulator_enable(adsp->cx_supply);
 150         if (ret)
 151                 goto disable_aggre2_clk;
 152
 153         ret = regulator_enable(adsp->px_supply);
 154         if (ret)
 155                 goto disable_cx_supply;
 156
 157         ret = qcom_scm_pas_auth_and_reset(adsp->pas_id);
 158         if (ret) {
 159                 dev_err(adsp->dev,
 160                         "failed to authenticate image and release reset\n");
 161                 goto disable_px_supply;
 162         }
 163
 164         ret = qcom_q6v5_wait_for_start(&adsp->q6v5, msecs_to_jiffies(5000));
 165         if (ret == -ETIMEDOUT) {
 166                 dev_err(adsp->dev, "start timed out\n");
 167                 qcom_scm_pas_shutdown(adsp->pas_id);
 168                 goto disable_px_supply;
 169         }
 170
 171         return 0;
 172
 173 disable_px_supply:
 174         regulator_disable(adsp->px_supply);
 175 disable_cx_supply:
 176         regulator_disable(adsp->cx_supply);
 177 disable_aggre2_clk:
 178         clk_disable_unprepare(adsp->aggre2_clk);
 179 disable_xo_clk:
 180         clk_disable_unprepare(adsp->xo);
 181 disable_proxy_pds:
 182         adsp_pds_disable(adsp, adsp->proxy_pds, adsp->proxy_pd_count);
 183 disable_active_pds:
 184         adsp_pds_disable(adsp, adsp->active_pds, adsp->active_pd_count);
 185 disable_irqs:
 186         qcom_q6v5_unprepare(&adsp->q6v5);
 187
 188         return ret;
 189 }
 190
 191 static void qcom_pas_handover(struct qcom_q6v5 *q6v5)
 192 {
 193         struct qcom_adsp *adsp = container_of(q6v5, struct qcom_adsp, q6v5);
 194
 195         regulator_disable(adsp->px_supply);
 196         regulator_disable(adsp->cx_supply);
 197         clk_disable_unprepare(adsp->aggre2_clk);
 198         clk_disable_unprepare(adsp->xo);
 199         adsp_pds_disable(adsp, adsp->proxy_pds, adsp->proxy_pd_count);
 200 }
 201
 202 static int adsp_stop(struct rproc *rproc)
 203 {
 204         struct qcom_adsp *adsp = (struct qcom_adsp *)rproc->priv;
 205         int handover;
 206         int ret;
 207
 208         ret = qcom_q6v5_request_stop(&adsp->q6v5);
 209         if (ret == -ETIMEDOUT)
 210                 dev_err(adsp->dev, "timed out on wait\n");
 211
 212         ret = qcom_scm_pas_shutdown(adsp->pas_id);
 213         if (ret)
 214                 dev_err(adsp->dev, "failed to shutdown: %d\n", ret);
 215
 216         adsp_pds_disable(adsp, adsp->active_pds, adsp->active_pd_count);
 217         handover = qcom_q6v5_unprepare(&adsp->q6v5);
 218         if (handover)
 219                 qcom_pas_handover(&adsp->q6v5);
 220
 221         return ret;
 222 }
 223
 224 static void *adsp_da_to_va(struct rproc *rproc, u64 da, int len)
 225 {
 226         struct qcom_adsp *adsp = (struct qcom_adsp *)rproc->priv;
 227         int offset;
 228
 229         offset = da - adsp->mem_reloc;
 230         if (offset < 0 || offset + len > adsp->mem_size)
 231                 return NULL;
 232
 233         return adsp->mem_region + offset;
 234 }
 235
 236 static const struct rproc_ops adsp_ops = {
 237         .start = adsp_start,
 238         .stop = adsp_stop,
 239         .da_to_va = adsp_da_to_va,
 240         .parse_fw = qcom_register_dump_segments,
 241         .load = adsp_load,
 242 };
 243
 244 static int adsp_init_clock(struct qcom_adsp *adsp)
 245 {
 246         int ret;
 247
 248         adsp->xo = devm_clk_get(adsp->dev, "xo");
 249         if (IS_ERR(adsp->xo)) {
 250                 ret = PTR_ERR(adsp->xo);
 251                 if (ret != -EPROBE_DEFER)
 252                         dev_err(adsp->dev, "failed to get xo clock");
 253                 return ret;
 254         }
 255
 256         if (adsp->has_aggre2_clk) {
 257                 adsp->aggre2_clk = devm_clk_get(adsp->dev, "aggre2");
 258                 if (IS_ERR(adsp->aggre2_clk)) {
 259                         ret = PTR_ERR(adsp->aggre2_clk);
 260                         if (ret != -EPROBE_DEFER)
 261                                 dev_err(adsp->dev,
 262                                         "failed to get aggre2 clock");
 263                         return ret;
 264                 }
 265         }
 266
 267         return 0;
 268 }
 269
 270 static int adsp_init_regulator(struct qcom_adsp *adsp)
 271 {
 272         adsp->cx_supply = devm_regulator_get(adsp->dev, "cx");
 273         if (IS_ERR(adsp->cx_supply))
 274                 return PTR_ERR(adsp->cx_supply);
 275
 276         regulator_set_load(adsp->cx_supply, 100000);
 277
 278         adsp->px_supply = devm_regulator_get(adsp->dev, "px");
 279         return PTR_ERR_OR_ZERO(adsp->px_supply);
 280 }
 281
 282 static int adsp_pds_attach(struct device *dev, struct device **devs,
 283                            char **pd_names)
 284 {
 285         size_t num_pds = 0;
 286         int ret;
 287         int i;
 288
 289         if (!pd_names)
 290                 return 0;
 291
 292         /* Handle single power domain */
 293         if (dev->pm_domain) {
 294                 devs[0] = dev;
 295                 pm_runtime_enable(dev);
 296                 return 1;
 297         }
 298
 299         while (pd_names[num_pds])
 300                 num_pds++;
 301
 302         for (i = 0; i < num_pds; i++) {
 303                 devs[i] = dev_pm_domain_attach_by_name(dev, pd_names[i]);
 304                 if (IS_ERR_OR_NULL(devs[i])) {
 305                         ret = PTR_ERR(devs[i]) ? : -ENODATA;
 306                         goto unroll_attach;
 307                 }
 308         }
 309
 310         return num_pds;
 311
 312 unroll_attach:
 313         for (i--; i >= 0; i--)
 314                 dev_pm_domain_detach(devs[i], false);
 315
 316         return ret;
 317 };
 318
 319 static void adsp_pds_detach(struct qcom_adsp *adsp, struct device **pds,
 320                             size_t pd_count)
 321 {
 322         struct device *dev = adsp->dev;
 323         int i;
 324
 325         /* Handle single power domain */
 326         if (dev->pm_domain && pd_count) {
 327                 pm_runtime_disable(dev);
 328                 return;
 329         }
 330
 331         for (i = 0; i < pd_count; i++)
 332                 dev_pm_domain_detach(pds[i], false);
 333 }
 334
 335 static int adsp_alloc_memory_region(struct qcom_adsp *adsp)
 336 {
 337         struct device_node *node;
 338         struct resource r;
 339         int ret;
 340
 341         node = of_parse_phandle(adsp->dev->of_node, "memory-region", 0);
 342         if (!node) {
 343                 dev_err(adsp->dev, "no memory-region specified\n");
 344                 return -EINVAL;
 345         }
 346
 347         ret = of_address_to_resource(node, 0, &r);
 348         if (ret)
 349                 return ret;
 350
 351         adsp->mem_phys = adsp->mem_reloc = r.start;
 352         adsp->mem_size = resource_size(&r);
 353         adsp->mem_region = devm_ioremap_wc(adsp->dev, adsp->mem_phys, adsp->mem_size);
 354         if (!adsp->mem_region) {
 355                 dev_err(adsp->dev, "unable to map memory region: %pa+%zx\n",
 356                         &r.start, adsp->mem_size);
 357                 return -EBUSY;
 358         }
 359
 360         return 0;
 361 }
 362
 363 static int adsp_probe(struct platform_device *pdev)
 364 {
 365         const struct adsp_data *desc;
 366         struct qcom_adsp *adsp;
 367         struct rproc *rproc;
 368         const char *fw_name;
 369         int ret;
 370
 371         desc = of_device_get_match_data(&pdev->dev);
 372         if (!desc)
 373                 return -EINVAL;
 374
 375         if (!qcom_scm_is_available())
 376                 return -EPROBE_DEFER;
 377
 378         fw_name = desc->firmware_name;
 379         ret = of_property_read_string(pdev->dev.of_node, "firmware-name",
 380                                       &fw_name);
 381         if (ret < 0 && ret != -EINVAL)
 382                 return ret;
 383
 384         rproc = rproc_alloc(&pdev->dev, pdev->name, &adsp_ops,
 385                             fw_name, sizeof(*adsp));
 386         if (!rproc) {
 387                 dev_err(&pdev->dev, "unable to allocate remoteproc\n");
 388                 return -ENOMEM;
 389         }
 390
 391         adsp = (struct qcom_adsp *)rproc->priv;
 392         adsp->dev = &pdev->dev;
 393         adsp->rproc = rproc;
 394         adsp->pas_id = desc->pas_id;
 395         adsp->has_aggre2_clk = desc->has_aggre2_clk;
 396         platform_set_drvdata(pdev, adsp);
 397
 398         ret = adsp_alloc_memory_region(adsp);
 399         if (ret)
 400                 goto free_rproc;
 401
 402         ret = adsp_init_clock(adsp);
 403         if (ret)
 404                 goto free_rproc;
 405
 406         ret = adsp_init_regulator(adsp);
 407         if (ret)
 408                 goto free_rproc;
 409
 410         ret = adsp_pds_attach(&pdev->dev, adsp->active_pds,
 411                               desc->active_pd_names);
 412         if (ret < 0)
 413                 goto free_rproc;
 414         adsp->active_pd_count = ret;
 415
 416         ret = adsp_pds_attach(&pdev->dev, adsp->proxy_pds,
 417                               desc->proxy_pd_names);
 418         if (ret < 0)
 419                 goto detach_active_pds;
 420         adsp->proxy_pd_count = ret;
 421
 422         ret = qcom_q6v5_init(&adsp->q6v5, pdev, rproc, desc->crash_reason_smem,
 423                              qcom_pas_handover);
 424         if (ret)
 425                 goto detach_proxy_pds;
 426
 427         qcom_add_glink_subdev(rproc, &adsp->glink_subdev);
 428         qcom_add_smd_subdev(rproc, &adsp->smd_subdev);
 429         qcom_add_ssr_subdev(rproc, &adsp->ssr_subdev, desc->ssr_name);
 430         adsp->sysmon = qcom_add_sysmon_subdev(rproc,
 431                                               desc->sysmon_name,
 432                                               desc->ssctl_id);
 433         if (IS_ERR(adsp->sysmon)) {
 434                 ret = PTR_ERR(adsp->sysmon);
 435                 goto detach_proxy_pds;
 436         }
 437
 438         ret = rproc_add(rproc);
 439         if (ret)
 440                 goto detach_proxy_pds;
 441
 442         return 0;
 443
 444 detach_proxy_pds:
 445         adsp_pds_detach(adsp, adsp->proxy_pds, adsp->proxy_pd_count);
 446 detach_active_pds:
 447         adsp_pds_detach(adsp, adsp->active_pds, adsp->active_pd_count);
 448 free_rproc:
 449         rproc_free(rproc);
 450
 451         return ret;
 452 }
 453
 454 static int adsp_remove(struct platform_device *pdev)
 455 {
 456         struct qcom_adsp *adsp = platform_get_drvdata(pdev);
 457
 458         rproc_del(adsp->rproc);
 459
 460         qcom_remove_glink_subdev(adsp->rproc, &adsp->glink_subdev);
 461         qcom_remove_sysmon_subdev(adsp->sysmon);
 462         qcom_remove_smd_subdev(adsp->rproc, &adsp->smd_subdev);
 463         qcom_remove_ssr_subdev(adsp->rproc, &adsp->ssr_subdev);
 464         rproc_free(adsp->rproc);
 465
 466         return 0;
 467 }
 468
 469 static const struct adsp_data adsp_resource_init = {
 470                 .crash_reason_smem = 423,
 471                 .firmware_name = "adsp.mdt",
 472                 .pas_id = 1,
 473                 .has_aggre2_clk = false,
 474                 .ssr_name = "lpass",
 475                 .sysmon_name = "adsp",
 476                 .ssctl_id = 0x14,
 477 };
 478
 479 static const struct adsp_data sm8150_adsp_resource = {
 480                 .crash_reason_smem = 423,
 481                 .firmware_name = "adsp.mdt",
 482                 .pas_id = 1,
 483                 .has_aggre2_clk = false,
 484                 .active_pd_names = (char*[]){
 485                         "load_state",
 486                         NULL
 487                 },
 488                 .proxy_pd_names = (char*[]){
 489                         "cx",
 490                         NULL
 491                 },
 492                 .ssr_name = "lpass",
 493                 .sysmon_name = "adsp",
 494                 .ssctl_id = 0x14,
 495 };
 496
 497 static const struct adsp_data cdsp_resource_init = {
 498         .crash_reason_smem = 601,
 499         .firmware_name = "cdsp.mdt",
 500         .pas_id = 18,
 501         .has_aggre2_clk = false,
 502         .ssr_name = "cdsp",
 503         .sysmon_name = "cdsp",
 504         .ssctl_id = 0x17,
 505 };
 506
 507 static const struct adsp_data sm8150_cdsp_resource = {
 508         .crash_reason_smem = 601,
 509         .firmware_name = "cdsp.mdt",
 510         .pas_id = 18,
 511         .has_aggre2_clk = false,
 512         .active_pd_names = (char*[]){
 513                 "load_state",
 514                 NULL
 515         },
 516         .proxy_pd_names = (char*[]){
 517                 "cx",
 518                 NULL
 519         },
 520         .ssr_name = "cdsp",
 521         .sysmon_name = "cdsp",
 522         .ssctl_id = 0x17,
 523 };
 524
 525 static const struct adsp_data mpss_resource_init = {
 526         .crash_reason_smem = 421,
 527         .firmware_name = "modem.mdt",
 528         .pas_id = 4,
 529         .has_aggre2_clk = false,
 530         .active_pd_names = (char*[]){
 531                 "load_state",
 532                 NULL
 533         },
 534         .proxy_pd_names = (char*[]){
 535                 "cx",
 536                 "mss",
 537                 NULL
 538         },
 539         .ssr_name = "mpss",
 540         .sysmon_name = "modem",
 541         .ssctl_id = 0x12,
 542 };
 543
 544 static const struct adsp_data slpi_resource_init = {
 545                 .crash_reason_smem = 424,
 546                 .firmware_name = "slpi.mdt",
 547                 .pas_id = 12,
 548                 .has_aggre2_clk = true,
 549                 .ssr_name = "dsps",
 550                 .sysmon_name = "slpi",
 551                 .ssctl_id = 0x16,
 552 };
 553
 554 static const struct adsp_data sm8150_slpi_resource = {
 555                 .crash_reason_smem = 424,
 556                 .firmware_name = "slpi.mdt",
 557                 .pas_id = 12,
 558                 .has_aggre2_clk = false,
 559                 .active_pd_names = (char*[]){
 560                         "load_state",
 561                         NULL
 562                 },
 563                 .proxy_pd_names = (char*[]){
 564                         "lcx",
 565                         "lmx",
 566                         NULL
 567                 },
 568                 .ssr_name = "dsps",
 569                 .sysmon_name = "slpi",
 570                 .ssctl_id = 0x16,
 571 };
 572
 573 static const struct adsp_data wcss_resource_init = {
 574         .crash_reason_smem = 421,
 575         .firmware_name = "wcnss.mdt",
 576         .pas_id = 6,
 577         .ssr_name = "mpss",
 578         .sysmon_name = "wcnss",
 579         .ssctl_id = 0x12,
 580 };
 581
 582 static const struct of_device_id adsp_of_match[] = {
 583         { .compatible = "qcom,msm8974-adsp-pil", .data = &adsp_resource_init},
 584         { .compatible = "qcom,msm8996-adsp-pil", .data = &adsp_resource_init},
 585         { .compatible = "qcom,msm8996-slpi-pil", .data = &slpi_resource_init},
 586         { .compatible = "qcom,qcs404-adsp-pas", .data = &adsp_resource_init },
 587         { .compatible = "qcom,qcs404-cdsp-pas", .data = &cdsp_resource_init },
 588         { .compatible = "qcom,qcs404-wcss-pas", .data = &wcss_resource_init },
 589         { .compatible = "qcom,sdm845-adsp-pas", .data = &adsp_resource_init},
 590         { .compatible = "qcom,sdm845-cdsp-pas", .data = &cdsp_resource_init},
 591         { .compatible = "qcom,sm8150-adsp-pas", .data = &sm8150_adsp_resource},
 592         { .compatible = "qcom,sm8150-cdsp-pas", .data = &sm8150_cdsp_resource},
 593         { .compatible = "qcom,sm8150-mpss-pas", .data = &mpss_resource_init},
 594         { .compatible = "qcom,sm8150-slpi-pas", .data = &sm8150_slpi_resource},
 595         { },
 596 };
 597 MODULE_DEVICE_TABLE(of, adsp_of_match);
 598
 599 static struct platform_driver adsp_driver = {
 600         .probe = adsp_probe,
 601         .remove = adsp_remove,
 602         .driver = {
 603                 .name = "qcom_q6v5_pas",
 604                 .of_match_table = adsp_of_match,
 605         },
 606 };
 607
 608 module_platform_driver(adsp_driver);
 609 MODULE_DESCRIPTION("Qualcomm Hexagon v5 Peripheral Authentication Service driver");
 610 MODULE_LICENSE("GPL v2");