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