include/clk.h

   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  */
   7
   8 #ifndef _CLK_H_
   9 #define _CLK_H_
  10
  11 #include <dm/ofnode.h>
  12 #include <linux/err.h>
  13 #include <linux/errno.h>
  14 #include <linux/types.h>
  15
  16 /**
  17  * DOC: Overview
  18  *
  19  * A clock is a hardware signal that oscillates autonomously at a specific
  20  * frequency and duty cycle. Most hardware modules require one or more clock
  21  * signal to drive their operation. Clock signals are typically generated
  22  * externally to the HW module consuming them, by an entity this API calls a
  23  * clock provider. This API provides a standard means for drivers to enable and
  24  * disable clocks, and to set the rate at which they oscillate.
  25  *
  26  * A driver that implements UCLASS_CLK is a clock provider. A provider will
  27  * often implement multiple separate clocks, since the hardware it manages
  28  * often has this capability. clk-uclass.h describes the interface which
  29  * clock providers must implement.
  30  *
  31  * Clock consumers/clients are the HW modules driven by the clock signals. This
  32  * header file describes the API used by drivers for those HW modules.
  33  */
  34
  35 struct udevice;
  36
  37 /**
  38  * struct clk - A handle to (allowing control of) a single clock.
  39  * @dev: The device which implements the clock signal.
  40  * @rate: The clock rate (in HZ).
  41  * @flags: Flags used across common clock structure (e.g. %CLK_)
  42  *         Clock IP blocks specific flags (i.e. mux, div, gate, etc) are defined
  43  *         in struct's for those devices (e.g. &struct clk_mux).
  44  * @enable_count: The number of times this clock has been enabled.
  45  * @id: The clock signal ID within the provider.
  46  * @data: An optional data field for scenarios where a single integer ID is not
  47  *        sufficient. If used, it can be populated through an .of_xlate op and
  48  *        processed during the various clock ops.
  49  *
  50  * Clients provide storage for clock handles. The content of the structure is
  51  * managed solely by the clock API and clock drivers. A clock struct is
  52  * initialized by "get"ing the clock struct. The clock struct is passed to all
  53  * other clock APIs to identify which clock signal to operate upon.
  54  *
  55  * Should additional information to identify and configure any clock signal
  56  * for any provider be required in the future, the struct could be expanded to
  57  * either (a) add more fields to allow clock providers to store additional
  58  * information, or (b) replace the id field with an opaque pointer, which the
  59  * provider would dynamically allocated during its .of_xlate op, and process
  60  * during is .request op. This may require the addition of an extra op to clean
  61  * up the allocation.
  62  */
  63 struct clk {
  64         struct udevice *dev;
  65         long long rate; /* in HZ */
  66         u32 flags;
  67         int enable_count;
  68         /*
  69          * Written by of_xlate. In the future, we might add more fields here.
  70          */
  71         unsigned long id;
  72         unsigned long data;
  73 };
  74
  75 /**
  76  * struct clk_bulk - A handle to (allowing control of) a bulk of clocks.
  77  * @clks: An array of clock handles.
  78  * @count: The number of clock handles in the clks array.
  79  *
  80  * Clients provide storage for the clock bulk. The content of the structure is
  81  * managed solely by the clock API. A clock bulk struct is
  82  * initialized by "get"ing the clock bulk struct.
  83  * The clock bulk struct is passed to all other bulk clock APIs to apply
  84  * the API to all the clock in the bulk struct.
  85  */
  86 struct clk_bulk {
  87         struct clk *clks;
  88         unsigned int count;
  89 };
  90
  91 #if CONFIG_IS_ENABLED(OF_CONTROL) && CONFIG_IS_ENABLED(CLK)
  92 struct phandle_1_arg;
  93 /**
  94  * clk_get_by_phandle() - Get a clock by its phandle information (of-platadata)
  95  * @dev: Device containing the phandle
  96  * @cells: Phandle info
  97  * @clk: A pointer to a clock struct to initialise
  98  *
  99  * This function is used when of-platdata is enabled.
 100  *
 101  * This looks up a clock using the phandle info. With dtoc, each phandle in the
 102  * 'clocks' property is transformed into an idx representing the device.
 103  * For example::
 104  *
 105  *      clocks = <&dpll_mpu_ck 23>;
 106  *
 107  * might result in::
 108  *
 109  *      .clocks = {1, {23}},},
 110  *
 111  * indicating that the clock is udevice idx 1 in dt-plat.c with an argument of
 112  * 23. This function can return a valid clock given the above information. In
 113  * this example it would return a clock containing the 'dpll_mpu_ck' device and
 114  * the clock ID 23.
 115  *
 116  * Return: 0 if OK, or a negative error code.
 117  */
 118 int clk_get_by_phandle(struct udevice *dev, const struct phandle_1_arg *cells,
 119                        struct clk *clk);
 120
 121 /**
 122  * clk_get_by_index() - Get/request a clock by integer index.
 123  * @dev:        The client device.
 124  * @index:      The index of the clock to request, within the client's list of
 125  *              clocks.
 126  * @clk:        A pointer to a clock struct to initialize.
 127  *
 128  * This looks up and requests a clock. The index is relative to the client
 129  * device; each device is assumed to have n clocks associated with it somehow,
 130  * and this function finds and requests one of them. The mapping of client
 131  * device clock indices to provider clocks may be via device-tree properties,
 132  * board-provided mapping tables, or some other mechanism.
 133  *
 134  * Return: 0 if OK, or a negative error code.
 135  */
 136 int clk_get_by_index(struct udevice *dev, int index, struct clk *clk);
 137
 138 /**
 139  * clk_get_by_index_nodev() - Get/request a clock by integer index without a
 140  *                            device.
 141  * @node:       The client ofnode.
 142  * @index:      The index of the clock to request, within the client's list of
 143  *              clocks.
 144  * @clk:        A pointer to a clock struct to initialize.
 145  *
 146  * Return: 0 if OK, or a negative error code.
 147  */
 148 int clk_get_by_index_nodev(ofnode node, int index, struct clk *clk);
 149
 150 /**
 151  * clk_get_bulk() - Get/request all clocks of a device.
 152  * @dev:        The client device.
 153  * @bulk:       A pointer to a clock bulk struct to initialize.
 154  *
 155  * This looks up and requests all clocks of the client device; each device is
 156  * assumed to have n clocks associated with it somehow, and this function finds
 157  * and requests all of them in a separate structure. The mapping of client
 158  * device clock indices to provider clocks may be via device-tree properties,
 159  * board-provided mapping tables, or some other mechanism.
 160  *
 161  * Return: 0 if OK, or a negative error code.
 162  */
 163 int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk);
 164
 165 /**
 166  * clk_get_by_name() - Get/request a clock by name.
 167  * @dev:        The client device.
 168  * @name:       The name of the clock to request, within the client's list of
 169  *              clocks.
 170  * @clk:        A pointer to a clock struct to initialize.
 171  *
 172  * This looks up and requests a clock. The name is relative to the client
 173  * device; each device is assumed to have n clocks associated with it somehow,
 174  * and this function finds and requests one of them. The mapping of client
 175  * device clock names to provider clocks may be via device-tree properties,
 176  * board-provided mapping tables, or some other mechanism.
 177  *
 178  * Return: 0 if OK, or a negative error code.
 179  */
 180 int clk_get_by_name(struct udevice *dev, const char *name, struct clk *clk);
 181
 182 /**
 183  * clk_get_by_name_nodev - Get/request a clock by name without a device.
 184  * @node:       The client ofnode.
 185  * @name:       The name of the clock to request, within the client's list of
 186  *              clocks.
 187  * @clk:        A pointer to a clock struct to initialize.
 188  *
 189  * Return: 0 if OK, or a negative error code.
 190  */
 191 int clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk);
 192
 193 /**
 194  * devm_clk_get() - lookup and obtain a managed reference to a clock producer.
 195  * @dev: device for clock "consumer"
 196  * @id: clock consumer ID
 197  *
 198  * The implementation uses @dev and @id to determine the clock consumer, and
 199  * thereby the clock producer. (IOW, @id may be identical strings, but clk_get
 200  * may return different clock producers depending on @dev.)
 201  *
 202  * Drivers must assume that the clock source is not enabled.
 203  *
 204  * The clock will automatically be freed when the device is unbound
 205  * from the bus.
 206  *
 207  * Return:
 208  * a struct clk corresponding to the clock producer, or
 209  * valid IS_ERR() condition containing errno
 210  */
 211 struct clk *devm_clk_get(struct udevice *dev, const char *id);
 212
 213 /**
 214  * devm_clk_get_optional() - lookup and obtain a managed reference to an
 215  *                           optional clock producer.
 216  * @dev: device for clock "consumer"
 217  * @id: clock consumer ID
 218  *
 219  * Behaves the same as devm_clk_get() except where there is no clock producer.
 220  * In this case, instead of returning -%ENOENT, the function returns NULL.
 221  */
 222 static inline struct clk *devm_clk_get_optional(struct udevice *dev,
 223                                                 const char *id)
 224 {
 225         struct clk *clk = devm_clk_get(dev, id);
 226
 227         if (PTR_ERR(clk) == -ENODATA)
 228                 return NULL;
 229
 230         return clk;
 231 }
 232
 233 /**
 234  * clk_release_all() - Disable (turn off)/Free an array of previously
 235  * requested clocks.
 236  * @clk:        A clock struct array that was previously successfully
 237  *              requested by clk_request/get_by_*().
 238  * @count:      Number of clock contained in the array
 239  *
 240  * For each clock contained in the clock array, this function will check if
 241  * clock has been previously requested and then will disable and free it.
 242  *
 243  * Return: zero on success, or -ve error code.
 244  */
 245 int clk_release_all(struct clk *clk, int count);
 246
 247 /**
 248  * devm_clk_put - "free" a managed clock source
 249  * @dev: device used to acquire the clock
 250  * @clk: clock source acquired with devm_clk_get()
 251  *
 252  * Note: drivers must ensure that all clk_enable calls made on this
 253  * clock source are balanced by clk_disable calls prior to calling
 254  * this function.
 255  *
 256  * clk_put should not be called from within interrupt context.
 257  */
 258 void devm_clk_put(struct udevice *dev, struct clk *clk);
 259
 260 #else
 261 static inline int clk_get_by_index(struct udevice *dev, int index,
 262                                    struct clk *clk)
 263 {
 264         return -ENOSYS;
 265 }
 266
 267 static inline int clk_get_bulk(struct udevice *dev, struct clk_bulk *bulk)
 268 {
 269         return -ENOSYS;
 270 }
 271
 272 static inline int clk_get_by_name(struct udevice *dev, const char *name,
 273                            struct clk *clk)
 274 {
 275         return -ENOSYS;
 276 }
 277
 278 static inline int
 279 clk_get_by_name_nodev(ofnode node, const char *name, struct clk *clk)
 280 {
 281         return -ENOSYS;
 282 }
 283
 284 static inline int clk_release_all(struct clk *clk, int count)
 285 {
 286         return -ENOSYS;
 287 }
 288 #endif
 289
 290 /**
 291  * clk_get_by_name_optional() - Get/request a optional clock by name.
 292  * @dev:        The client device.
 293  * @name:       The name of the clock to request, within the client's list of
 294  *              clocks.
 295  * @clk:        A pointer to a clock struct to initialize.
 296  *
 297  * Behaves the same as clk_get_by_name(), except when there is no clock
 298  * provider. In the latter case, return 0.
 299  *
 300  * Return: 0 if OK, or a negative error code.
 301  */
 302 static inline int clk_get_by_name_optional(struct udevice *dev,
 303                                            const char *name, struct clk *clk)
 304 {
 305         int ret;
 306
 307         ret = clk_get_by_name(dev, name, clk);
 308         if (ret == -ENODATA)
 309                 return 0;
 310
 311         return ret;
 312 }
 313
 314 /**
 315  * clk_get_by_name_nodev_optional - Get/request an optinonal clock by name
 316  *              without a device.
 317  * @node:       The client ofnode.
 318  * @name:       The name of the clock to request, within the client's list of
 319  *              clocks.
 320  * @clk:        A pointer to a clock struct to initialize.
 321  *
 322  * Behaves the same as clk_get_by_name_nodev() except where there is
 323  * no clock producer, in this case, skip the error number -%ENODATA, and
 324  * the function returns 0.
 325  */
 326 static inline int clk_get_by_name_nodev_optional(ofnode node, const char *name,
 327                                                  struct clk *clk)
 328 {
 329         int ret;
 330
 331         ret = clk_get_by_name_nodev(node, name, clk);
 332         if (ret == -ENODATA)
 333                 return 0;
 334
 335         return ret;
 336 }
 337
 338 /**
 339  * enum clk_defaults_stage - What stage clk_set_defaults() is called at
 340  * @CLK_DEFAULTS_PRE: Called before probe. Setting of defaults for clocks owned
 341  *                    by this clock driver will be defered until after probing.
 342  * @CLK_DEFAULTS_POST: Called after probe. Only defaults for clocks owned by
 343  *                     this clock driver will be set.
 344  * @CLK_DEFAULTS_POST_FORCE: Called after probe, and always set defaults, even
 345  *                           before relocation. Usually, defaults are not set
 346  *                           pre-relocation to avoid setting them twice (when
 347  *                           the device is probed again post-relocation). This
 348  *                           may incur a performance cost as device tree
 349  *                           properties must be parsed for a second time.
 350  *                           However, when not using SPL, pre-relocation may be
 351  *                           the only time we can set defaults for some clocks
 352  *                           (such as those used for the RAM we will relocate
 353  *                           into).
 354  */
 355 enum clk_defaults_stage {
 356         CLK_DEFAULTS_PRE = 0,
 357         CLK_DEFAULTS_POST = 1,
 358         CLK_DEFAULTS_POST_FORCE,
 359 };
 360
 361 #if CONFIG_IS_ENABLED(OF_REAL) && CONFIG_IS_ENABLED(CLK)
 362 /**
 363  * clk_set_defaults - Process ``assigned-{clocks/clock-parents/clock-rates}``
 364  *                    properties to configure clocks
 365  * @dev:        A device to process (the ofnode associated with this device
 366  *              will be processed).
 367  * @stage:      The stage of the probing process this function is called during.
 368  *
 369  * Return: zero on success, or -ve error code.
 370  */
 371 int clk_set_defaults(struct udevice *dev, enum clk_defaults_stage stage);
 372 #else
 373 static inline int clk_set_defaults(struct udevice *dev, int stage)
 374 {
 375         return 0;
 376 }
 377 #endif
 378
 379 /**
 380  * clk_release_bulk() - Disable (turn off)/Free an array of previously
 381  * requested clocks in a clock bulk struct.
 382  * @bulk:       A clock bulk struct that was previously successfully
 383  *              requested by clk_get_bulk().
 384  *
 385  * For each clock contained in the clock bulk struct, this function will check
 386  * if clock has been previously requested and then will disable and free it.
 387  *
 388  * Return: zero on success, or -ve error code.
 389  */
 390 static inline int clk_release_bulk(struct clk_bulk *bulk)
 391 {
 392         return clk_release_all(bulk->clks, bulk->count);
 393 }
 394
 395 #if CONFIG_IS_ENABLED(CLK)
 396 /**
 397  * clk_request() - Request a clock by provider-specific ID.
 398  * @dev:        The clock provider device.
 399  * @clk:        A pointer to a clock struct to initialize. The caller must
 400  *              have already initialized any field in this struct which the
 401  *              clock provider uses to identify the clock.
 402  *
 403  * This requests a clock using a provider-specific ID. Generally, this function
 404  * should not be used, since clk_get_by_index/name() provide an interface that
 405  * better separates clients from intimate knowledge of clock providers.
 406  * However, this function may be useful in core SoC-specific code.
 407  *
 408  * Return: 0 if OK, or a negative error code.
 409  */
 410 int clk_request(struct udevice *dev, struct clk *clk);
 411
 412 /**
 413  * clk_free() - Free a previously requested clock.
 414  * @clk:        A clock struct that was previously successfully requested by
 415  *              clk_request/get_by_*().
 416  *
 417  * Free resources allocated by clk_request() (or any clk_get_* function).
 418  */
 419 void clk_free(struct clk *clk);
 420
 421 /**
 422  * clk_get_rate() - Get current clock rate.
 423  * @clk:        A clock struct that was previously successfully requested by
 424  *              clk_request/get_by_*().
 425  *
 426  * Return: clock rate in Hz on success, 0 for invalid clock, or -ve error code
 427  *         for other errors.
 428  */
 429 ulong clk_get_rate(struct clk *clk);
 430
 431 /**
 432  * clk_get_parent() - Get current clock's parent.
 433  * @clk:        A clock struct that was previously successfully requested by
 434  *              clk_request/get_by_*().
 435  *
 436  * Return: pointer to parent's struct clk, or error code passed as pointer
 437  */
 438 struct clk *clk_get_parent(struct clk *clk);
 439
 440 /**
 441  * clk_get_parent_rate() - Get parent of current clock rate.
 442  * @clk:        A clock struct that was previously successfully requested by
 443  *              clk_request/get_by_*().
 444  *
 445  * Return: clock rate in Hz, or -ve error code.
 446  */
 447 long long clk_get_parent_rate(struct clk *clk);
 448
 449 /**
 450  * clk_round_rate() - Adjust a rate to the exact rate a clock can provide
 451  * @clk: A clock struct that was previously successfully requested by
 452  *       clk_request/get_by_*().
 453  * @rate: desired clock rate in Hz.
 454  *
 455  * This answers the question "if I were to pass @rate to clk_set_rate(),
 456  * what clock rate would I end up with?" without changing the hardware
 457  * in any way. In other words::
 458  *
 459  *   rate = clk_round_rate(clk, r);
 460  *
 461  * and::
 462  *
 463  *   rate = clk_set_rate(clk, r);
 464  *
 465  * are equivalent except the former does not modify the clock hardware
 466  * in any way.
 467  *
 468  * Return: rounded rate in Hz, or -ve error code.
 469  */
 470 ulong clk_round_rate(struct clk *clk, ulong rate);
 471
 472 /**
 473  * clk_set_rate() - Set current clock rate.
 474  * @clk:        A clock struct that was previously successfully requested by
 475  *              clk_request/get_by_*().
 476  * @rate:       New clock rate in Hz.
 477  *
 478  * Return: new rate, or -ve error code.
 479  */
 480 ulong clk_set_rate(struct clk *clk, ulong rate);
 481
 482 /**
 483  * clk_set_parent() - Set current clock parent.
 484  * @clk:        A clock struct that was previously successfully requested by
 485  *              clk_request/get_by_*().
 486  * @parent:     A clock struct that was previously successfully requested by
 487  *              clk_request/get_by_*().
 488  *
 489  * Return: new rate, or -ve error code.
 490  */
 491 int clk_set_parent(struct clk *clk, struct clk *parent);
 492
 493 /**
 494  * clk_enable() - Enable (turn on) a clock.
 495  * @clk:        A clock struct that was previously successfully requested by
 496  *              clk_request/get_by_*().
 497  *
 498  * Return: zero on success, or -ve error code.
 499  */
 500 int clk_enable(struct clk *clk);
 501
 502 /**
 503  * clk_enable_bulk() - Enable (turn on) all clocks in a clock bulk struct.
 504  * @bulk:       A clock bulk struct that was previously successfully requested
 505  *              by clk_get_bulk().
 506  *
 507  * Return: zero on success, or -ve error code.
 508  */
 509 int clk_enable_bulk(struct clk_bulk *bulk);
 510
 511 /**
 512  * clk_disable() - Disable (turn off) a clock.
 513  * @clk:        A clock struct that was previously successfully requested by
 514  *              clk_request/get_by_*().
 515  *
 516  * Return: zero on success, or -ve error code.
 517  */
 518 int clk_disable(struct clk *clk);
 519
 520 /**
 521  * clk_disable_bulk() - Disable (turn off) all clocks in a clock bulk struct.
 522  * @bulk:       A clock bulk struct that was previously successfully requested
 523  *              by clk_get_bulk().
 524  *
 525  * Return: zero on success, or -ve error code.
 526  */
 527 int clk_disable_bulk(struct clk_bulk *bulk);
 528
 529 /**
 530  * clk_is_match - check if two clk's point to the same hardware clock
 531  * @p: clk compared against q
 532  * @q: clk compared against p
 533  *
 534  * Return:
 535  * %true if the two struct clk pointers both point to the same hardware clock
 536  * node, and %false otherwise. Note that two %NULL clks are treated as matching.
 537  */
 538 bool clk_is_match(const struct clk *p, const struct clk *q);
 539
 540 /**
 541  * clk_get_by_id() - Get the clock by its ID
 542  * @id: The clock ID to search for
 543  * @clkp:       A pointer to clock struct that has been found among added clocks
 544  *              to UCLASS_CLK
 545  *
 546  * Return: zero on success, or -ENOENT on error
 547  */
 548 int clk_get_by_id(ulong id, struct clk **clkp);
 549
 550 /**
 551  * clk_dev_binded() - Check whether the clk has a device binded
 552  * @clk:        A pointer to the clk
 553  *
 554  * Return: true on binded, or false on no
 555  */
 556 bool clk_dev_binded(struct clk *clk);
 557
 558 #else /* CONFIG_IS_ENABLED(CLK) */
 559
 560 static inline int clk_request(struct udevice *dev, struct clk *clk)
 561 {
 562         return -ENOSYS;
 563 }
 564
 565 static inline void clk_free(struct clk *clk)
 566 {
 567         return;
 568 }
 569
 570 static inline ulong clk_get_rate(struct clk *clk)
 571 {
 572         return -ENOSYS;
 573 }
 574
 575 static inline struct clk *clk_get_parent(struct clk *clk)
 576 {
 577         return ERR_PTR(-ENOSYS);
 578 }
 579
 580 static inline long long clk_get_parent_rate(struct clk *clk)
 581 {
 582         return -ENOSYS;
 583 }
 584
 585 static inline ulong clk_round_rate(struct clk *clk, ulong rate)
 586 {
 587         return -ENOSYS;
 588 }
 589
 590 static inline ulong clk_set_rate(struct clk *clk, ulong rate)
 591 {
 592         return -ENOSYS;
 593 }
 594
 595 static inline int clk_set_parent(struct clk *clk, struct clk *parent)
 596 {
 597         return -ENOSYS;
 598 }
 599
 600 static inline int clk_enable(struct clk *clk)
 601 {
 602         return 0;
 603 }
 604
 605 static inline int clk_enable_bulk(struct clk_bulk *bulk)
 606 {
 607         return 0;
 608 }
 609
 610 static inline int clk_disable(struct clk *clk)
 611 {
 612         return 0;
 613 }
 614
 615 static inline int clk_disable_bulk(struct clk_bulk *bulk)
 616 {
 617         return 0;
 618 }
 619
 620 static inline bool clk_is_match(const struct clk *p, const struct clk *q)
 621 {
 622         return false;
 623 }
 624
 625 static inline int clk_get_by_id(ulong id, struct clk **clkp)
 626 {
 627         return -ENOSYS;
 628 }
 629
 630 static inline bool clk_dev_binded(struct clk *clk)
 631 {
 632         return false;
 633 }
 634 #endif /* CONFIG_IS_ENABLED(CLK) */
 635
 636 /**
 637  * clk_valid() - check if clk is valid
 638  * @clk:        the clock to check
 639  *
 640  * Return: true if valid, or false
 641  */
 642 static inline bool clk_valid(struct clk *clk)
 643 {
 644         return clk && !!clk->dev;
 645 }
 646
 647 int soc_clk_dump(void);
 648
 649 #endif
 650
 651 #define clk_prepare_enable(clk) clk_enable(clk)
 652 #define clk_disable_unprepare(clk) clk_disable(clk)