drivers/clk/clk-uclass.c

   1 // SPDX-License-Identifier: GPL-2.0+
   2 /*
   3  * Copyright (C) 2015 Google, Inc
   4  * Written by Simon Glass <sjg@chromium.org>
   5  * Copyright (c) 2016, NVIDIA CORPORATION.
   6  * Copyright (c) 2018, Theobroma Systems Design und Consulting GmbH
   7  */
   8
   9 #include <common.h>
  10 #include <clk.h>
  11 #include <clk-uclass.h>
  12 #include <dm.h>
  13 #include <dm/read.h>
  14 #include <dt-structs.h>
  15 #include <errno.h>
  16 #include <linux/clk-provider.h>
  17
  18 static inline const struct clk_ops *clk_dev_ops(struct udevice *dev)
  19 {
  20         return (const struct clk_ops *)dev->driver->ops;
  21 }
  22
  23 #if CONFIG_IS_ENABLED(OF_CONTROL)
  24 # if CONFIG_IS_ENABLED(OF_PLATDATA)
  25 int clk_get_by_index_platdata(struct udevice *dev, int index,
  26                               struct phandle_1_arg *cells, struct clk *clk)
  27 {
  28         int ret;
  29
  30         if (index != 0)
  31                 return -ENOSYS;
  32         ret = uclass_get_device(UCLASS_CLK, 0, &clk->dev);
  33         if (ret)
  34                 return ret;
  35         clk->id = cells[0].arg[0];
  36
  37         return 0;
  38 }
  39 # else
  40 static int clk_of_xlate_default(struct clk *clk,
  41                                 struct ofnode_phandle_args *args)
  42 {
  43         debug("%s(clk=%p)\n", __func__, clk);
  44
  45         if (args->args_count > 1) {
  46                 debug("Invaild args_count: %d\n", args->args_count);
  47                 return -EINVAL;
  48         }
  49
  50         if (args->args_count)
  51                 clk->id = args->args[0];
  52         else
  53                 clk->id = 0;
  54
  55         clk->data = 0;
  56
  57         return 0;
  58 }
  59
  60 static int clk_get_by_index_tail(int ret, ofnode node,
  61                                  struct ofnode_phandle_args *args,
  62                                  const char *list_name, int index,
  63                                  struct clk *clk)
  64 {
  65         struct udevice *dev_clk;
  66         const struct clk_ops *ops;
  67
  68         assert(clk);
  69         clk->dev = NULL;
  70         if (ret)
  71                 goto err;
  72
  73         ret = uclass_get_device_by_ofnode(UCLASS_CLK, args->node, &dev_clk);
  74         if (ret) {
  75                 debug("%s: uclass_get_device_by_of_offset failed: err=%d\n",
  76                       __func__, ret);
  77                 return ret;
  78         }
  79
  80         clk->dev = dev_clk;
  81
  82         ops = clk_dev_ops(dev_clk);
  83
  84         if (ops->of_xlate)
  85                 ret = ops->of_xlate(clk, args);
  86         else
  87                 ret = clk_of_xlate_default(clk, args);
  88         if (ret) {
  89                 debug("of_xlate() failed: %d\n", ret);
  90                 return ret;
  91         }
  92
  93         return clk_request(dev_clk, clk);
  94 err:
  95         debug("%s: Node '%s', property '%s', failed to request CLK index %d: %d\n",
  96               __func__, ofnode_get_name(node), list_name, index, ret);
  97         return ret;
  98 }
  99
 100 static int clk_get_by_indexed_prop(struct udevice *dev, const char *prop_name,
 101                                    int index, struct clk *clk)
 102 {
 103         int ret;
 104         struct ofnode_phandle_args args;
 105
 106         debug("%s(dev=%p, index=%d, clk=%p)\n", __func__, dev, index, clk);
 107
 108         assert(clk);
 109         clk->dev = NULL;
 110
 111         ret = dev_read_phandle_with_args(dev, prop_name, "#clock-cells", 0,
 112                                          index, &args);
 113         if (ret) {
 114                 debug("%s: fdtdec_parse_phandle_with_args failed: err=%d\n",
 115                       __func__, ret);
 116                 return ret;
 117         }
 118
 119
 120         return clk_get_by_index_tail(ret, dev_ofnode(dev), &args, "clocks",
 121                                      index > 0, clk);
 122 }
 123
 124 int clk_get_by_index(struct udevice *dev, int index, struct clk *clk)
 125 {
 126         struct ofnode_phandle_args args;
 127         int ret;
 128
 129         ret = dev_read_phandle_with_args(dev, "clocks", "#clock-cells", 0,
 130                                          index, &args);
 131
 132         return clk_get_by_index_tail(ret, dev_ofnode(dev), &args, "clocks",
 133                                      index > 0, clk);
 134 }
 135
 136 int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk)
 137 {
 138         struct ofnode_phandle_args args;
 139         int ret;
 140
 141         ret = ofnode_parse_phandle_with_args(node, "clocks", "#clock-cells", 0,
 142                                              index > 0, &args);
 143
 144         return clk_get_by_index_tail(ret, node, &args, "clocks",
 145                                      index > 0, clk);
 146 }
 147
 148 int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk)
 149 {
 150         int i, ret, err, count;
 151
 152         bulk->count = 0;
 153
 154         count = dev_count_phandle_with_args(dev, "clocks", "#clock-cells");
 155         if (count < 1)
 156                 return count;
 157
 158         bulk->clks = devm_kcalloc(dev, count, sizeof(struct clk), GFP_KERNEL);
 159         if (!bulk->clks)
 160                 return -ENOMEM;
 161
 162         for (i = 0; i < count; i++) {
 163                 ret = clk_get_by_index(dev, i, &bulk->clks[i]);
 164                 if (ret < 0)
 165                         goto bulk_get_err;
 166
 167                 ++bulk->count;
 168         }
 169
 170         return 0;
 171
 172 bulk_get_err:
 173         err = clk_release_all(bulk->clks, bulk->count);
 174         if (err)
 175                 debug("%s: could release all clocks for %p\n",
 176                       __func__, dev);
 177
 178         return ret;
 179 }
 180
 181 static int clk_set_default_parents(struct udevice *dev)
 182 {
 183         struct clk clk, parent_clk;
 184         int index;
 185         int num_parents;
 186         int ret;
 187
 188         num_parents = dev_count_phandle_with_args(dev, "assigned-clock-parents",
 189                                                   "#clock-cells");
 190         if (num_parents < 0) {
 191                 debug("%s: could not read assigned-clock-parents for %p\n",
 192                       __func__, dev);
 193                 return 0;
 194         }
 195
 196         for (index = 0; index < num_parents; index++) {
 197                 ret = clk_get_by_indexed_prop(dev, "assigned-clock-parents",
 198                                               index, &parent_clk);
 199                 /* If -ENOENT, this is a no-op entry */
 200                 if (ret == -ENOENT)
 201                         continue;
 202
 203                 if (ret) {
 204                         debug("%s: could not get parent clock %d for %s\n",
 205                               __func__, index, dev_read_name(dev));
 206                         return ret;
 207                 }
 208
 209                 ret = clk_get_by_indexed_prop(dev, "assigned-clocks",
 210                                               index, &clk);
 211                 if (ret) {
 212                         debug("%s: could not get assigned clock %d for %s\n",
 213                               __func__, index, dev_read_name(dev));
 214                         return ret;
 215                 }
 216
 217                 ret = clk_set_parent(&clk, &parent_clk);
 218
 219                 /*
 220                  * Not all drivers may support clock-reparenting (as of now).
 221                  * Ignore errors due to this.
 222                  */
 223                 if (ret == -ENOSYS)
 224                         continue;
 225
 226                 if (ret < 0) {
 227                         debug("%s: failed to reparent clock %d for %s\n",
 228                               __func__, index, dev_read_name(dev));
 229                         return ret;
 230                 }
 231         }
 232
 233         return 0;
 234 }
 235
 236 static int clk_set_default_rates(struct udevice *dev)
 237 {
 238         struct clk clk;
 239         int index;
 240         int num_rates;
 241         int size;
 242         int ret = 0;
 243         u32 *rates = NULL;
 244
 245         size = dev_read_size(dev, "assigned-clock-rates");
 246         if (size < 0)
 247                 return 0;
 248
 249         num_rates = size / sizeof(u32);
 250         rates = calloc(num_rates, sizeof(u32));
 251         if (!rates)
 252                 return -ENOMEM;
 253
 254         ret = dev_read_u32_array(dev, "assigned-clock-rates", rates, num_rates);
 255         if (ret)
 256                 goto fail;
 257
 258         for (index = 0; index < num_rates; index++) {
 259                 /* If 0 is passed, this is a no-op */
 260                 if (!rates[index])
 261                         continue;
 262
 263                 ret = clk_get_by_indexed_prop(dev, "assigned-clocks",
 264                                               index, &clk);
 265                 if (ret) {
 266                         debug("%s: could not get assigned clock %d for %s\n",
 267                               __func__, index, dev_read_name(dev));
 268                         continue;
 269                 }
 270
 271                 ret = clk_set_rate(&clk, rates[index]);
 272                 if (ret < 0) {
 273                         debug("%s: failed to set rate on clock index %d (%ld) for %s\n",
 274                               __func__, index, clk.id, dev_read_name(dev));
 275                         break;
 276                 }
 277         }
 278
 279 fail:
 280         free(rates);
 281         return ret;
 282 }
 283
 284 int clk_set_defaults(struct udevice *dev)
 285 {
 286         int ret;
 287
 288         if (!dev_of_valid(dev))
 289                 return 0;
 290
 291         /* If this not in SPL and pre-reloc state, don't take any action. */
 292         if (!(IS_ENABLED(CONFIG_SPL_BUILD) || (gd->flags & GD_FLG_RELOC)))
 293                 return 0;
 294
 295         debug("%s(%s)\n", __func__, dev_read_name(dev));
 296
 297         ret = clk_set_default_parents(dev);
 298         if (ret)
 299                 return ret;
 300
 301         ret = clk_set_default_rates(dev);
 302         if (ret < 0)
 303                 return ret;
 304
 305         return 0;
 306 }
 307 # endif /* OF_PLATDATA */
 308
 309 int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk)
 310 {
 311         int index;
 312
 313         debug("%s(dev=%p, name=%s, clk=%p)\n", __func__, dev, name, clk);
 314         clk->dev = NULL;
 315
 316         index = dev_read_stringlist_search(dev, "clock-names", name);
 317         if (index < 0) {
 318                 debug("fdt_stringlist_search() failed: %d\n", index);
 319                 return index;
 320         }
 321
 322         return clk_get_by_index(dev, index, clk);
 323 }
 324
 325 int clk_release_all(struct clk *clk, int count)
 326 {
 327         int i, ret;
 328
 329         for (i = 0; i < count; i++) {
 330                 debug("%s(clk[%d]=%p)\n", __func__, i, &clk[i]);
 331
 332                 /* check if clock has been previously requested */
 333                 if (!clk[i].dev)
 334                         continue;
 335
 336                 ret = clk_disable(&clk[i]);
 337                 if (ret && ret != -ENOSYS)
 338                         return ret;
 339
 340                 ret = clk_free(&clk[i]);
 341                 if (ret && ret != -ENOSYS)
 342                         return ret;
 343         }
 344
 345         return 0;
 346 }
 347
 348 #endif /* OF_CONTROL */
 349
 350 int clk_request(struct udevice *dev, struct clk *clk)
 351 {
 352         const struct clk_ops *ops = clk_dev_ops(dev);
 353
 354         debug("%s(dev=%p, clk=%p)\n", __func__, dev, clk);
 355
 356         clk->dev = dev;
 357
 358         if (!ops->request)
 359                 return 0;
 360
 361         return ops->request(clk);
 362 }
 363
 364 int clk_free(struct clk *clk)
 365 {
 366         const struct clk_ops *ops = clk_dev_ops(clk->dev);
 367
 368         debug("%s(clk=%p)\n", __func__, clk);
 369
 370         if (!ops->free)
 371                 return 0;
 372
 373         return ops->free(clk);
 374 }
 375
 376 ulong clk_get_rate(struct clk *clk)
 377 {
 378         const struct clk_ops *ops = clk_dev_ops(clk->dev);
 379
 380         debug("%s(clk=%p)\n", __func__, clk);
 381
 382         if (!ops->get_rate)
 383                 return -ENOSYS;
 384
 385         return ops->get_rate(clk);
 386 }
 387
 388 struct clk *clk_get_parent(struct clk *clk)
 389 {
 390         struct udevice *pdev;
 391         struct clk *pclk;
 392
 393         debug("%s(clk=%p)\n", __func__, clk);
 394
 395         pdev = dev_get_parent(clk->dev);
 396         pclk = dev_get_clk_ptr(pdev);
 397         if (!pclk)
 398                 return ERR_PTR(-ENODEV);
 399
 400         return pclk;
 401 }
 402
 403 long long clk_get_parent_rate(struct clk *clk)
 404 {
 405         const struct clk_ops *ops;
 406         struct clk *pclk;
 407
 408         debug("%s(clk=%p)\n", __func__, clk);
 409
 410         pclk = clk_get_parent(clk);
 411         if (IS_ERR(pclk))
 412                 return -ENODEV;
 413
 414         ops = clk_dev_ops(pclk->dev);
 415         if (!ops->get_rate)
 416                 return -ENOSYS;
 417
 418         /* Read the 'rate' if not already set or if proper flag set*/
 419         if (!pclk->rate || pclk->flags & CLK_GET_RATE_NOCACHE)
 420                 pclk->rate = clk_get_rate(pclk);
 421
 422         return pclk->rate;
 423 }
 424
 425 ulong clk_set_rate(struct clk *clk, ulong rate)
 426 {
 427         const struct clk_ops *ops = clk_dev_ops(clk->dev);
 428
 429         debug("%s(clk=%p, rate=%lu)\n", __func__, clk, rate);
 430
 431         if (!ops->set_rate)
 432                 return -ENOSYS;
 433
 434         return ops->set_rate(clk, rate);
 435 }
 436
 437 int clk_set_parent(struct clk *clk, struct clk *parent)
 438 {
 439         const struct clk_ops *ops = clk_dev_ops(clk->dev);
 440
 441         debug("%s(clk=%p, parent=%p)\n", __func__, clk, parent);
 442
 443         if (!ops->set_parent)
 444                 return -ENOSYS;
 445
 446         return ops->set_parent(clk, parent);
 447 }
 448
 449 int clk_enable(struct clk *clk)
 450 {
 451         const struct clk_ops *ops = clk_dev_ops(clk->dev);
 452         struct clk *clkp = NULL;
 453         int ret;
 454
 455         debug("%s(clk=%p)\n", __func__, clk);
 456
 457         if (CONFIG_IS_ENABLED(CLK_CCF)) {
 458                 /* Take id 0 as a non-valid clk, such as dummy */
 459                 if (clk->id && !clk_get_by_id(clk->id, &clkp)) {
 460                         if (clkp->enable_count) {
 461                                 clkp->enable_count++;
 462                                 return 0;
 463                         }
 464                         if (clkp->dev->parent &&
 465                             device_get_uclass_id(clkp->dev) == UCLASS_CLK) {
 466                                 ret = clk_enable(dev_get_clk_ptr(clkp->dev->parent));
 467                                 if (ret) {
 468                                         printf("Enable %s failed\n",
 469                                                clkp->dev->parent->name);
 470                                         return ret;
 471                                 }
 472                         }
 473                 }
 474
 475                 if (ops->enable) {
 476                         ret = ops->enable(clk);
 477                         if (ret) {
 478                                 printf("Enable %s failed\n", clk->dev->name);
 479                                 return ret;
 480                         }
 481                 }
 482                 if (clkp)
 483                         clkp->enable_count++;
 484         } else {
 485                 if (!ops->enable)
 486                         return -ENOSYS;
 487                 return ops->enable(clk);
 488         }
 489
 490         return 0;
 491 }
 492
 493 int clk_enable_bulk(struct clk_bulk *bulk)
 494 {
 495         int i, ret;
 496
 497         for (i = 0; i < bulk->count; i++) {
 498                 ret = clk_enable(&bulk->clks[i]);
 499                 if (ret < 0 && ret != -ENOSYS)
 500                         return ret;
 501         }
 502
 503         return 0;
 504 }
 505
 506 int clk_disable(struct clk *clk)
 507 {
 508         const struct clk_ops *ops = clk_dev_ops(clk->dev);
 509         struct clk *clkp = NULL;
 510         int ret;
 511
 512         debug("%s(clk=%p)\n", __func__, clk);
 513
 514         if (CONFIG_IS_ENABLED(CLK_CCF)) {
 515                 if (clk->id && !clk_get_by_id(clk->id, &clkp)) {
 516                         if (clkp->enable_count == 0) {
 517                                 printf("clk %s already disabled\n",
 518                                        clkp->dev->name);
 519                                 return 0;
 520                         }
 521
 522                         if (--clkp->enable_count > 0)
 523                                 return 0;
 524                 }
 525
 526                 if (ops->disable) {
 527                         ret = ops->disable(clk);
 528                         if (ret)
 529                                 return ret;
 530                 }
 531
 532                 if (clkp && clkp->dev->parent &&
 533                     device_get_uclass_id(clkp->dev) == UCLASS_CLK) {
 534                         ret = clk_disable(dev_get_clk_ptr(clkp->dev->parent));
 535                         if (ret) {
 536                                 printf("Disable %s failed\n",
 537                                        clkp->dev->parent->name);
 538                                 return ret;
 539                         }
 540                 }
 541         } else {
 542                 if (!ops->disable)
 543                         return -ENOSYS;
 544
 545                 return ops->disable(clk);
 546         }
 547
 548         return 0;
 549 }
 550
 551 int clk_disable_bulk(struct clk_bulk *bulk)
 552 {
 553         int i, ret;
 554
 555         for (i = 0; i < bulk->count; i++) {
 556                 ret = clk_disable(&bulk->clks[i]);
 557                 if (ret < 0 && ret != -ENOSYS)
 558                         return ret;
 559         }
 560
 561         return 0;
 562 }
 563
 564 int clk_get_by_id(ulong id, struct clk **clkp)
 565 {
 566         struct udevice *dev;
 567         struct uclass *uc;
 568         int ret;
 569
 570         ret = uclass_get(UCLASS_CLK, &uc);
 571         if (ret)
 572                 return ret;
 573
 574         uclass_foreach_dev(dev, uc) {
 575                 struct clk *clk = dev_get_clk_ptr(dev);
 576
 577                 if (clk && clk->id == id) {
 578                         *clkp = clk;
 579                         return 0;
 580                 }
 581         }
 582
 583         return -ENOENT;
 584 }
 585
 586 bool clk_is_match(const struct clk *p, const struct clk *q)
 587 {
 588         /* trivial case: identical struct clk's or both NULL */
 589         if (p == q)
 590                 return true;
 591
 592         /* same device, id and data */
 593         if (p->dev == q->dev && p->id == q->id && p->data == q->data)
 594                 return true;
 595
 596         return false;
 597 }
 598
 599 UCLASS_DRIVER(clk) = {
 600         .id             = UCLASS_CLK,
 601         .name           = "clk",
 602 };