include/linux/clk.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  *  linux/include/linux/clk.h
   4  *
   5  *  Copyright (C) 2004 ARM Limited.
   6  *  Written by Deep Blue Solutions Limited.
   7  *  Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
   8  */
   9 #ifndef __LINUX_CLK_H
  10 #define __LINUX_CLK_H
  11
  12 #include <linux/err.h>
  13 #include <linux/kernel.h>
  14 #include <linux/notifier.h>
  15
  16 struct device;
  17 struct clk;
  18 struct device_node;
  19 struct of_phandle_args;
  20
  21 /**
  22  * DOC: clk notifier callback types
  23  *
  24  * PRE_RATE_CHANGE - called immediately before the clk rate is changed,
  25  *     to indicate that the rate change will proceed.  Drivers must
  26  *     immediately terminate any operations that will be affected by the
  27  *     rate change.  Callbacks may either return NOTIFY_DONE, NOTIFY_OK,
  28  *     NOTIFY_STOP or NOTIFY_BAD.
  29  *
  30  * ABORT_RATE_CHANGE: called if the rate change failed for some reason
  31  *     after PRE_RATE_CHANGE.  In this case, all registered notifiers on
  32  *     the clk will be called with ABORT_RATE_CHANGE. Callbacks must
  33  *     always return NOTIFY_DONE or NOTIFY_OK.
  34  *
  35  * POST_RATE_CHANGE - called after the clk rate change has successfully
  36  *     completed.  Callbacks must always return NOTIFY_DONE or NOTIFY_OK.
  37  *
  38  */
  39 #define PRE_RATE_CHANGE                 BIT(0)
  40 #define POST_RATE_CHANGE                BIT(1)
  41 #define ABORT_RATE_CHANGE               BIT(2)
  42
  43 /**
  44  * struct clk_notifier - associate a clk with a notifier
  45  * @clk: struct clk * to associate the notifier with
  46  * @notifier_head: a blocking_notifier_head for this clk
  47  * @node: linked list pointers
  48  *
  49  * A list of struct clk_notifier is maintained by the notifier code.
  50  * An entry is created whenever code registers the first notifier on a
  51  * particular @clk.  Future notifiers on that @clk are added to the
  52  * @notifier_head.
  53  */
  54 struct clk_notifier {
  55         struct clk                      *clk;
  56         struct srcu_notifier_head       notifier_head;
  57         struct list_head                node;
  58 };
  59
  60 /**
  61  * struct clk_notifier_data - rate data to pass to the notifier callback
  62  * @clk: struct clk * being changed
  63  * @old_rate: previous rate of this clk
  64  * @new_rate: new rate of this clk
  65  *
  66  * For a pre-notifier, old_rate is the clk's rate before this rate
  67  * change, and new_rate is what the rate will be in the future.  For a
  68  * post-notifier, old_rate and new_rate are both set to the clk's
  69  * current rate (this was done to optimize the implementation).
  70  */
  71 struct clk_notifier_data {
  72         struct clk              *clk;
  73         unsigned long           old_rate;
  74         unsigned long           new_rate;
  75 };
  76
  77 /**
  78  * struct clk_bulk_data - Data used for bulk clk operations.
  79  *
  80  * @id: clock consumer ID
  81  * @clk: struct clk * to store the associated clock
  82  *
  83  * The CLK APIs provide a series of clk_bulk_() API calls as
  84  * a convenience to consumers which require multiple clks.  This
  85  * structure is used to manage data for these calls.
  86  */
  87 struct clk_bulk_data {
  88         const char              *id;
  89         struct clk              *clk;
  90 };
  91
  92 #ifdef CONFIG_COMMON_CLK
  93
  94 /**
  95  * clk_notifier_register: register a clock rate-change notifier callback
  96  * @clk: clock whose rate we are interested in
  97  * @nb: notifier block with callback function pointer
  98  *
  99  * ProTip: debugging across notifier chains can be frustrating. Make sure that
 100  * your notifier callback function prints a nice big warning in case of
 101  * failure.
 102  */
 103 int clk_notifier_register(struct clk *clk, struct notifier_block *nb);
 104
 105 /**
 106  * clk_notifier_unregister: unregister a clock rate-change notifier callback
 107  * @clk: clock whose rate we are no longer interested in
 108  * @nb: notifier block which will be unregistered
 109  */
 110 int clk_notifier_unregister(struct clk *clk, struct notifier_block *nb);
 111
 112 /**
 113  * clk_get_accuracy - obtain the clock accuracy in ppb (parts per billion)
 114  *                    for a clock source.
 115  * @clk: clock source
 116  *
 117  * This gets the clock source accuracy expressed in ppb.
 118  * A perfect clock returns 0.
 119  */
 120 long clk_get_accuracy(struct clk *clk);
 121
 122 /**
 123  * clk_set_phase - adjust the phase shift of a clock signal
 124  * @clk: clock signal source
 125  * @degrees: number of degrees the signal is shifted
 126  *
 127  * Shifts the phase of a clock signal by the specified degrees. Returns 0 on
 128  * success, -EERROR otherwise.
 129  */
 130 int clk_set_phase(struct clk *clk, int degrees);
 131
 132 /**
 133  * clk_get_phase - return the phase shift of a clock signal
 134  * @clk: clock signal source
 135  *
 136  * Returns the phase shift of a clock node in degrees, otherwise returns
 137  * -EERROR.
 138  */
 139 int clk_get_phase(struct clk *clk);
 140
 141 /**
 142  * clk_set_duty_cycle - adjust the duty cycle ratio of a clock signal
 143  * @clk: clock signal source
 144  * @num: numerator of the duty cycle ratio to be applied
 145  * @den: denominator of the duty cycle ratio to be applied
 146  *
 147  * Adjust the duty cycle of a clock signal by the specified ratio. Returns 0 on
 148  * success, -EERROR otherwise.
 149  */
 150 int clk_set_duty_cycle(struct clk *clk, unsigned int num, unsigned int den);
 151
 152 /**
 153  * clk_get_duty_cycle - return the duty cycle ratio of a clock signal
 154  * @clk: clock signal source
 155  * @scale: scaling factor to be applied to represent the ratio as an integer
 156  *
 157  * Returns the duty cycle ratio multiplied by the scale provided, otherwise
 158  * returns -EERROR.
 159  */
 160 int clk_get_scaled_duty_cycle(struct clk *clk, unsigned int scale);
 161
 162 /**
 163  * clk_is_match - check if two clk's point to the same hardware clock
 164  * @p: clk compared against q
 165  * @q: clk compared against p
 166  *
 167  * Returns true if the two struct clk pointers both point to the same hardware
 168  * clock node. Put differently, returns true if @p and @q
 169  * share the same &struct clk_core object.
 170  *
 171  * Returns false otherwise. Note that two NULL clks are treated as matching.
 172  */
 173 bool clk_is_match(const struct clk *p, const struct clk *q);
 174
 175 /**
 176  * clk_rate_exclusive_get - get exclusivity over the rate control of a
 177  *                          producer
 178  * @clk: clock source
 179  *
 180  * This function allows drivers to get exclusive control over the rate of a
 181  * provider. It prevents any other consumer to execute, even indirectly,
 182  * opereation which could alter the rate of the provider or cause glitches
 183  *
 184  * If exlusivity is claimed more than once on clock, even by the same driver,
 185  * the rate effectively gets locked as exclusivity can't be preempted.
 186  *
 187  * Must not be called from within atomic context.
 188  *
 189  * Returns success (0) or negative errno.
 190  */
 191 int clk_rate_exclusive_get(struct clk *clk);
 192
 193 /**
 194  * clk_rate_exclusive_put - release exclusivity over the rate control of a
 195  *                          producer
 196  * @clk: clock source
 197  *
 198  * This function allows drivers to release the exclusivity it previously got
 199  * from clk_rate_exclusive_get()
 200  *
 201  * The caller must balance the number of clk_rate_exclusive_get() and
 202  * clk_rate_exclusive_put() calls.
 203  *
 204  * Must not be called from within atomic context.
 205  */
 206 void clk_rate_exclusive_put(struct clk *clk);
 207
 208 #else
 209
 210 static inline int clk_notifier_register(struct clk *clk,
 211                                         struct notifier_block *nb)
 212 {
 213         return -ENOTSUPP;
 214 }
 215
 216 static inline int clk_notifier_unregister(struct clk *clk,
 217                                           struct notifier_block *nb)
 218 {
 219         return -ENOTSUPP;
 220 }
 221
 222 static inline long clk_get_accuracy(struct clk *clk)
 223 {
 224         return -ENOTSUPP;
 225 }
 226
 227 static inline long clk_set_phase(struct clk *clk, int phase)
 228 {
 229         return -ENOTSUPP;
 230 }
 231
 232 static inline long clk_get_phase(struct clk *clk)
 233 {
 234         return -ENOTSUPP;
 235 }
 236
 237 static inline int clk_set_duty_cycle(struct clk *clk, unsigned int num,
 238                                      unsigned int den)
 239 {
 240         return -ENOTSUPP;
 241 }
 242
 243 static inline unsigned int clk_get_scaled_duty_cycle(struct clk *clk,
 244                                                      unsigned int scale)
 245 {
 246         return 0;
 247 }
 248
 249 static inline bool clk_is_match(const struct clk *p, const struct clk *q)
 250 {
 251         return p == q;
 252 }
 253
 254 static inline int clk_rate_exclusive_get(struct clk *clk)
 255 {
 256         return 0;
 257 }
 258
 259 static inline void clk_rate_exclusive_put(struct clk *clk) {}
 260
 261 #endif
 262
 263 /**
 264  * clk_prepare - prepare a clock source
 265  * @clk: clock source
 266  *
 267  * This prepares the clock source for use.
 268  *
 269  * Must not be called from within atomic context.
 270  */
 271 #ifdef CONFIG_HAVE_CLK_PREPARE
 272 int clk_prepare(struct clk *clk);
 273 int __must_check clk_bulk_prepare(int num_clks,
 274                                   const struct clk_bulk_data *clks);
 275 #else
 276 static inline int clk_prepare(struct clk *clk)
 277 {
 278         might_sleep();
 279         return 0;
 280 }
 281
 282 static inline int __must_check
 283 clk_bulk_prepare(int num_clks, const struct clk_bulk_data *clks)
 284 {
 285         might_sleep();
 286         return 0;
 287 }
 288 #endif
 289
 290 /**
 291  * clk_unprepare - undo preparation of a clock source
 292  * @clk: clock source
 293  *
 294  * This undoes a previously prepared clock.  The caller must balance
 295  * the number of prepare and unprepare calls.
 296  *
 297  * Must not be called from within atomic context.
 298  */
 299 #ifdef CONFIG_HAVE_CLK_PREPARE
 300 void clk_unprepare(struct clk *clk);
 301 void clk_bulk_unprepare(int num_clks, const struct clk_bulk_data *clks);
 302 #else
 303 static inline void clk_unprepare(struct clk *clk)
 304 {
 305         might_sleep();
 306 }
 307 static inline void clk_bulk_unprepare(int num_clks,
 308                                       const struct clk_bulk_data *clks)
 309 {
 310         might_sleep();
 311 }
 312 #endif
 313
 314 #ifdef CONFIG_HAVE_CLK
 315 /**
 316  * clk_get - lookup and obtain a reference to a clock producer.
 317  * @dev: device for clock "consumer"
 318  * @id: clock consumer ID
 319  *
 320  * Returns a struct clk corresponding to the clock producer, or
 321  * valid IS_ERR() condition containing errno.  The implementation
 322  * uses @dev and @id to determine the clock consumer, and thereby
 323  * the clock producer.  (IOW, @id may be identical strings, but
 324  * clk_get may return different clock producers depending on @dev.)
 325  *
 326  * Drivers must assume that the clock source is not enabled.
 327  *
 328  * clk_get should not be called from within interrupt context.
 329  */
 330 struct clk *clk_get(struct device *dev, const char *id);
 331
 332 /**
 333  * clk_bulk_get - lookup and obtain a number of references to clock producer.
 334  * @dev: device for clock "consumer"
 335  * @num_clks: the number of clk_bulk_data
 336  * @clks: the clk_bulk_data table of consumer
 337  *
 338  * This helper function allows drivers to get several clk consumers in one
 339  * operation. If any of the clk cannot be acquired then any clks
 340  * that were obtained will be freed before returning to the caller.
 341  *
 342  * Returns 0 if all clocks specified in clk_bulk_data table are obtained
 343  * successfully, or valid IS_ERR() condition containing errno.
 344  * The implementation uses @dev and @clk_bulk_data.id to determine the
 345  * clock consumer, and thereby the clock producer.
 346  * The clock returned is stored in each @clk_bulk_data.clk field.
 347  *
 348  * Drivers must assume that the clock source is not enabled.
 349  *
 350  * clk_bulk_get should not be called from within interrupt context.
 351  */
 352 int __must_check clk_bulk_get(struct device *dev, int num_clks,
 353                               struct clk_bulk_data *clks);
 354 /**
 355  * clk_bulk_get_all - lookup and obtain all available references to clock
 356  *                    producer.
 357  * @dev: device for clock "consumer"
 358  * @clks: pointer to the clk_bulk_data table of consumer
 359  *
 360  * This helper function allows drivers to get all clk consumers in one
 361  * operation. If any of the clk cannot be acquired then any clks
 362  * that were obtained will be freed before returning to the caller.
 363  *
 364  * Returns a positive value for the number of clocks obtained while the
 365  * clock references are stored in the clk_bulk_data table in @clks field.
 366  * Returns 0 if there're none and a negative value if something failed.
 367  *
 368  * Drivers must assume that the clock source is not enabled.
 369  *
 370  * clk_bulk_get should not be called from within interrupt context.
 371  */
 372 int __must_check clk_bulk_get_all(struct device *dev,
 373                                   struct clk_bulk_data **clks);
 374
 375 /**
 376  * clk_bulk_get_optional - lookup and obtain a number of references to clock producer
 377  * @dev: device for clock "consumer"
 378  * @num_clks: the number of clk_bulk_data
 379  * @clks: the clk_bulk_data table of consumer
 380  *
 381  * Behaves the same as clk_bulk_get() except where there is no clock producer.
 382  * In this case, instead of returning -ENOENT, the function returns 0 and
 383  * NULL for a clk for which a clock producer could not be determined.
 384  */
 385 int __must_check clk_bulk_get_optional(struct device *dev, int num_clks,
 386                                        struct clk_bulk_data *clks);
 387 /**
 388  * devm_clk_bulk_get - managed get multiple clk consumers
 389  * @dev: device for clock "consumer"
 390  * @num_clks: the number of clk_bulk_data
 391  * @clks: the clk_bulk_data table of consumer
 392  *
 393  * Return 0 on success, an errno on failure.
 394  *
 395  * This helper function allows drivers to get several clk
 396  * consumers in one operation with management, the clks will
 397  * automatically be freed when the device is unbound.
 398  */
 399 int __must_check devm_clk_bulk_get(struct device *dev, int num_clks,
 400                                    struct clk_bulk_data *clks);
 401 /**
 402  * devm_clk_bulk_get_optional - managed get multiple optional consumer clocks
 403  * @dev: device for clock "consumer"
 404  * @num_clks: the number of clk_bulk_data
 405  * @clks: pointer to the clk_bulk_data table of consumer
 406  *
 407  * Behaves the same as devm_clk_bulk_get() except where there is no clock
 408  * producer.  In this case, instead of returning -ENOENT, the function returns
 409  * NULL for given clk. It is assumed all clocks in clk_bulk_data are optional.
 410  *
 411  * Returns 0 if all clocks specified in clk_bulk_data table are obtained
 412  * successfully or for any clk there was no clk provider available, otherwise
 413  * returns valid IS_ERR() condition containing errno.
 414  * The implementation uses @dev and @clk_bulk_data.id to determine the
 415  * clock consumer, and thereby the clock producer.
 416  * The clock returned is stored in each @clk_bulk_data.clk field.
 417  *
 418  * Drivers must assume that the clock source is not enabled.
 419  *
 420  * clk_bulk_get should not be called from within interrupt context.
 421  */
 422 int __must_check devm_clk_bulk_get_optional(struct device *dev, int num_clks,
 423                                             struct clk_bulk_data *clks);
 424 /**
 425  * devm_clk_bulk_get_all - managed get multiple clk consumers
 426  * @dev: device for clock "consumer"
 427  * @clks: pointer to the clk_bulk_data table of consumer
 428  *
 429  * Returns a positive value for the number of clocks obtained while the
 430  * clock references are stored in the clk_bulk_data table in @clks field.
 431  * Returns 0 if there're none and a negative value if something failed.
 432  *
 433  * This helper function allows drivers to get several clk
 434  * consumers in one operation with management, the clks will
 435  * automatically be freed when the device is unbound.
 436  */
 437
 438 int __must_check devm_clk_bulk_get_all(struct device *dev,
 439                                        struct clk_bulk_data **clks);
 440
 441 /**
 442  * devm_clk_get - lookup and obtain a managed reference to a clock producer.
 443  * @dev: device for clock "consumer"
 444  * @id: clock consumer ID
 445  *
 446  * Returns a struct clk corresponding to the clock producer, or
 447  * valid IS_ERR() condition containing errno.  The implementation
 448  * uses @dev and @id to determine the clock consumer, and thereby
 449  * the clock producer.  (IOW, @id may be identical strings, but
 450  * clk_get may return different clock producers depending on @dev.)
 451  *
 452  * Drivers must assume that the clock source is not enabled.
 453  *
 454  * devm_clk_get should not be called from within interrupt context.
 455  *
 456  * The clock will automatically be freed when the device is unbound
 457  * from the bus.
 458  */
 459 struct clk *devm_clk_get(struct device *dev, const char *id);
 460
 461 /**
 462  * devm_clk_get_prepared - devm_clk_get() + clk_prepare()
 463  * @dev: device for clock "consumer"
 464  * @id: clock consumer ID
 465  *
 466  * Context: May sleep.
 467  *
 468  * Return: a struct clk corresponding to the clock producer, or
 469  * valid IS_ERR() condition containing errno.  The implementation
 470  * uses @dev and @id to determine the clock consumer, and thereby
 471  * the clock producer.  (IOW, @id may be identical strings, but
 472  * clk_get may return different clock producers depending on @dev.)
 473  *
 474  * The returned clk (if valid) is prepared. Drivers must however assume
 475  * that the clock is not enabled.
 476  *
 477  * The clock will automatically be unprepared and freed when the device
 478  * is unbound from the bus.
 479  */
 480 struct clk *devm_clk_get_prepared(struct device *dev, const char *id);
 481
 482 /**
 483  * devm_clk_get_enabled - devm_clk_get() + clk_prepare_enable()
 484  * @dev: device for clock "consumer"
 485  * @id: clock consumer ID
 486  *
 487  * Context: May sleep.
 488  *
 489  * Return: a struct clk corresponding to the clock producer, or
 490  * valid IS_ERR() condition containing errno.  The implementation
 491  * uses @dev and @id to determine the clock consumer, and thereby
 492  * the clock producer.  (IOW, @id may be identical strings, but
 493  * clk_get may return different clock producers depending on @dev.)
 494  *
 495  * The returned clk (if valid) is prepared and enabled.
 496  *
 497  * The clock will automatically be disabled, unprepared and freed
 498  * when the device is unbound from the bus.
 499  */
 500 struct clk *devm_clk_get_enabled(struct device *dev, const char *id);
 501
 502 /**
 503  * devm_clk_get_optional - lookup and obtain a managed reference to an optional
 504  *                         clock producer.
 505  * @dev: device for clock "consumer"
 506  * @id: clock consumer ID
 507  *
 508  * Behaves the same as devm_clk_get() except where there is no clock producer.
 509  * In this case, instead of returning -ENOENT, the function returns NULL.
 510  */
 511 struct clk *devm_clk_get_optional(struct device *dev, const char *id);
 512
 513 /**
 514  * devm_clk_get_optional_prepared - devm_clk_get_optional() + clk_prepare()
 515  * @dev: device for clock "consumer"
 516  * @id: clock consumer ID
 517  *
 518  * Context: May sleep.
 519  *
 520  * Return: a struct clk corresponding to the clock producer, or
 521  * valid IS_ERR() condition containing errno.  The implementation
 522  * uses @dev and @id to determine the clock consumer, and thereby
 523  * the clock producer.  If no such clk is found, it returns NULL
 524  * which serves as a dummy clk.  That's the only difference compared
 525  * to devm_clk_get_prepared().
 526  *
 527  * The returned clk (if valid) is prepared. Drivers must however
 528  * assume that the clock is not enabled.
 529  *
 530  * The clock will automatically be unprepared and freed when the
 531  * device is unbound from the bus.
 532  */
 533 struct clk *devm_clk_get_optional_prepared(struct device *dev, const char *id);
 534
 535 /**
 536  * devm_clk_get_optional_enabled - devm_clk_get_optional() +
 537  *                                 clk_prepare_enable()
 538  * @dev: device for clock "consumer"
 539  * @id: clock consumer ID
 540  *
 541  * Context: May sleep.
 542  *
 543  * Return: a struct clk corresponding to the clock producer, or
 544  * valid IS_ERR() condition containing errno.  The implementation
 545  * uses @dev and @id to determine the clock consumer, and thereby
 546  * the clock producer.  If no such clk is found, it returns NULL
 547  * which serves as a dummy clk.  That's the only difference compared
 548  * to devm_clk_get_enabled().
 549  *
 550  * The returned clk (if valid) is prepared and enabled.
 551  *
 552  * The clock will automatically be disabled, unprepared and freed
 553  * when the device is unbound from the bus.
 554  */
 555 struct clk *devm_clk_get_optional_enabled(struct device *dev, const char *id);
 556
 557 /**
 558  * devm_get_clk_from_child - lookup and obtain a managed reference to a
 559  *                           clock producer from child node.
 560  * @dev: device for clock "consumer"
 561  * @np: pointer to clock consumer node
 562  * @con_id: clock consumer ID
 563  *
 564  * This function parses the clocks, and uses them to look up the
 565  * struct clk from the registered list of clock providers by using
 566  * @np and @con_id
 567  *
 568  * The clock will automatically be freed when the device is unbound
 569  * from the bus.
 570  */
 571 struct clk *devm_get_clk_from_child(struct device *dev,
 572                                     struct device_node *np, const char *con_id);
 573
 574 /**
 575  * clk_enable - inform the system when the clock source should be running.
 576  * @clk: clock source
 577  *
 578  * If the clock can not be enabled/disabled, this should return success.
 579  *
 580  * May be called from atomic contexts.
 581  *
 582  * Returns success (0) or negative errno.
 583  */
 584 int clk_enable(struct clk *clk);
 585
 586 /**
 587  * clk_bulk_enable - inform the system when the set of clks should be running.
 588  * @num_clks: the number of clk_bulk_data
 589  * @clks: the clk_bulk_data table of consumer
 590  *
 591  * May be called from atomic contexts.
 592  *
 593  * Returns success (0) or negative errno.
 594  */
 595 int __must_check clk_bulk_enable(int num_clks,
 596                                  const struct clk_bulk_data *clks);
 597
 598 /**
 599  * clk_disable - inform the system when the clock source is no longer required.
 600  * @clk: clock source
 601  *
 602  * Inform the system that a clock source is no longer required by
 603  * a driver and may be shut down.
 604  *
 605  * May be called from atomic contexts.
 606  *
 607  * Implementation detail: if the clock source is shared between
 608  * multiple drivers, clk_enable() calls must be balanced by the
 609  * same number of clk_disable() calls for the clock source to be
 610  * disabled.
 611  */
 612 void clk_disable(struct clk *clk);
 613
 614 /**
 615  * clk_bulk_disable - inform the system when the set of clks is no
 616  *                    longer required.
 617  * @num_clks: the number of clk_bulk_data
 618  * @clks: the clk_bulk_data table of consumer
 619  *
 620  * Inform the system that a set of clks is no longer required by
 621  * a driver and may be shut down.
 622  *
 623  * May be called from atomic contexts.
 624  *
 625  * Implementation detail: if the set of clks is shared between
 626  * multiple drivers, clk_bulk_enable() calls must be balanced by the
 627  * same number of clk_bulk_disable() calls for the clock source to be
 628  * disabled.
 629  */
 630 void clk_bulk_disable(int num_clks, const struct clk_bulk_data *clks);
 631
 632 /**
 633  * clk_get_rate - obtain the current clock rate (in Hz) for a clock source.
 634  *                This is only valid once the clock source has been enabled.
 635  * @clk: clock source
 636  */
 637 unsigned long clk_get_rate(struct clk *clk);
 638
 639 /**
 640  * clk_put      - "free" the clock source
 641  * @clk: clock source
 642  *
 643  * Note: drivers must ensure that all clk_enable calls made on this
 644  * clock source are balanced by clk_disable calls prior to calling
 645  * this function.
 646  *
 647  * clk_put should not be called from within interrupt context.
 648  */
 649 void clk_put(struct clk *clk);
 650
 651 /**
 652  * clk_bulk_put - "free" the clock source
 653  * @num_clks: the number of clk_bulk_data
 654  * @clks: the clk_bulk_data table of consumer
 655  *
 656  * Note: drivers must ensure that all clk_bulk_enable calls made on this
 657  * clock source are balanced by clk_bulk_disable calls prior to calling
 658  * this function.
 659  *
 660  * clk_bulk_put should not be called from within interrupt context.
 661  */
 662 void clk_bulk_put(int num_clks, struct clk_bulk_data *clks);
 663
 664 /**
 665  * clk_bulk_put_all - "free" all the clock source
 666  * @num_clks: the number of clk_bulk_data
 667  * @clks: the clk_bulk_data table of consumer
 668  *
 669  * Note: drivers must ensure that all clk_bulk_enable calls made on this
 670  * clock source are balanced by clk_bulk_disable calls prior to calling
 671  * this function.
 672  *
 673  * clk_bulk_put_all should not be called from within interrupt context.
 674  */
 675 void clk_bulk_put_all(int num_clks, struct clk_bulk_data *clks);
 676
 677 /**
 678  * devm_clk_put - "free" a managed clock source
 679  * @dev: device used to acquire the clock
 680  * @clk: clock source acquired with devm_clk_get()
 681  *
 682  * Note: drivers must ensure that all clk_enable calls made on this
 683  * clock source are balanced by clk_disable calls prior to calling
 684  * this function.
 685  *
 686  * clk_put should not be called from within interrupt context.
 687  */
 688 void devm_clk_put(struct device *dev, struct clk *clk);
 689
 690 /*
 691  * The remaining APIs are optional for machine class support.
 692  */
 693
 694
 695 /**
 696  * clk_round_rate - adjust a rate to the exact rate a clock can provide
 697  * @clk: clock source
 698  * @rate: desired clock rate in Hz
 699  *
 700  * This answers the question "if I were to pass @rate to clk_set_rate(),
 701  * what clock rate would I end up with?" without changing the hardware
 702  * in any way.  In other words:
 703  *
 704  *   rate = clk_round_rate(clk, r);
 705  *
 706  * and:
 707  *
 708  *   clk_set_rate(clk, r);
 709  *   rate = clk_get_rate(clk);
 710  *
 711  * are equivalent except the former does not modify the clock hardware
 712  * in any way.
 713  *
 714  * Returns rounded clock rate in Hz, or negative errno.
 715  */
 716 long clk_round_rate(struct clk *clk, unsigned long rate);
 717
 718 /**
 719  * clk_set_rate - set the clock rate for a clock source
 720  * @clk: clock source
 721  * @rate: desired clock rate in Hz
 722  *
 723  * Updating the rate starts at the top-most affected clock and then
 724  * walks the tree down to the bottom-most clock that needs updating.
 725  *
 726  * Returns success (0) or negative errno.
 727  */
 728 int clk_set_rate(struct clk *clk, unsigned long rate);
 729
 730 /**
 731  * clk_set_rate_exclusive- set the clock rate and claim exclusivity over
 732  *                         clock source
 733  * @clk: clock source
 734  * @rate: desired clock rate in Hz
 735  *
 736  * This helper function allows drivers to atomically set the rate of a producer
 737  * and claim exclusivity over the rate control of the producer.
 738  *
 739  * It is essentially a combination of clk_set_rate() and
 740  * clk_rate_exclusite_get(). Caller must balance this call with a call to
 741  * clk_rate_exclusive_put()
 742  *
 743  * Returns success (0) or negative errno.
 744  */
 745 int clk_set_rate_exclusive(struct clk *clk, unsigned long rate);
 746
 747 /**
 748  * clk_has_parent - check if a clock is a possible parent for another
 749  * @clk: clock source
 750  * @parent: parent clock source
 751  *
 752  * This function can be used in drivers that need to check that a clock can be
 753  * the parent of another without actually changing the parent.
 754  *
 755  * Returns true if @parent is a possible parent for @clk, false otherwise.
 756  */
 757 bool clk_has_parent(struct clk *clk, struct clk *parent);
 758
 759 /**
 760  * clk_set_rate_range - set a rate range for a clock source
 761  * @clk: clock source
 762  * @min: desired minimum clock rate in Hz, inclusive
 763  * @max: desired maximum clock rate in Hz, inclusive
 764  *
 765  * Returns success (0) or negative errno.
 766  */
 767 int clk_set_rate_range(struct clk *clk, unsigned long min, unsigned long max);
 768
 769 /**
 770  * clk_set_min_rate - set a minimum clock rate for a clock source
 771  * @clk: clock source
 772  * @rate: desired minimum clock rate in Hz, inclusive
 773  *
 774  * Returns success (0) or negative errno.
 775  */
 776 int clk_set_min_rate(struct clk *clk, unsigned long rate);
 777
 778 /**
 779  * clk_set_max_rate - set a maximum clock rate for a clock source
 780  * @clk: clock source
 781  * @rate: desired maximum clock rate in Hz, inclusive
 782  *
 783  * Returns success (0) or negative errno.
 784  */
 785 int clk_set_max_rate(struct clk *clk, unsigned long rate);
 786
 787 /**
 788  * clk_set_parent - set the parent clock source for this clock
 789  * @clk: clock source
 790  * @parent: parent clock source
 791  *
 792  * Returns success (0) or negative errno.
 793  */
 794 int clk_set_parent(struct clk *clk, struct clk *parent);
 795
 796 /**
 797  * clk_get_parent - get the parent clock source for this clock
 798  * @clk: clock source
 799  *
 800  * Returns struct clk corresponding to parent clock source, or
 801  * valid IS_ERR() condition containing errno.
 802  */
 803 struct clk *clk_get_parent(struct clk *clk);
 804
 805 /**
 806  * clk_get_sys - get a clock based upon the device name
 807  * @dev_id: device name
 808  * @con_id: connection ID
 809  *
 810  * Returns a struct clk corresponding to the clock producer, or
 811  * valid IS_ERR() condition containing errno.  The implementation
 812  * uses @dev_id and @con_id to determine the clock consumer, and
 813  * thereby the clock producer. In contrast to clk_get() this function
 814  * takes the device name instead of the device itself for identification.
 815  *
 816  * Drivers must assume that the clock source is not enabled.
 817  *
 818  * clk_get_sys should not be called from within interrupt context.
 819  */
 820 struct clk *clk_get_sys(const char *dev_id, const char *con_id);
 821
 822 /**
 823  * clk_save_context - save clock context for poweroff
 824  *
 825  * Saves the context of the clock register for powerstates in which the
 826  * contents of the registers will be lost. Occurs deep within the suspend
 827  * code so locking is not necessary.
 828  */
 829 int clk_save_context(void);
 830
 831 /**
 832  * clk_restore_context - restore clock context after poweroff
 833  *
 834  * This occurs with all clocks enabled. Occurs deep within the resume code
 835  * so locking is not necessary.
 836  */
 837 void clk_restore_context(void);
 838
 839 #else /* !CONFIG_HAVE_CLK */
 840
 841 static inline struct clk *clk_get(struct device *dev, const char *id)
 842 {
 843         return NULL;
 844 }
 845
 846 static inline int __must_check clk_bulk_get(struct device *dev, int num_clks,
 847                                             struct clk_bulk_data *clks)
 848 {
 849         return 0;
 850 }
 851
 852 static inline int __must_check clk_bulk_get_optional(struct device *dev,
 853                                 int num_clks, struct clk_bulk_data *clks)
 854 {
 855         return 0;
 856 }
 857
 858 static inline int __must_check clk_bulk_get_all(struct device *dev,
 859                                          struct clk_bulk_data **clks)
 860 {
 861         return 0;
 862 }
 863
 864 static inline struct clk *devm_clk_get(struct device *dev, const char *id)
 865 {
 866         return NULL;
 867 }
 868
 869 static inline struct clk *devm_clk_get_prepared(struct device *dev,
 870                                                 const char *id)
 871 {
 872         return NULL;
 873 }
 874
 875 static inline struct clk *devm_clk_get_enabled(struct device *dev,
 876                                                const char *id)
 877 {
 878         return NULL;
 879 }
 880
 881 static inline struct clk *devm_clk_get_optional(struct device *dev,
 882                                                 const char *id)
 883 {
 884         return NULL;
 885 }
 886
 887 static inline struct clk *devm_clk_get_optional_prepared(struct device *dev,
 888                                                          const char *id)
 889 {
 890         return NULL;
 891 }
 892
 893 static inline struct clk *devm_clk_get_optional_enabled(struct device *dev,
 894                                                         const char *id)
 895 {
 896         return NULL;
 897 }
 898
 899 static inline int __must_check devm_clk_bulk_get(struct device *dev, int num_clks,
 900                                                  struct clk_bulk_data *clks)
 901 {
 902         return 0;
 903 }
 904
 905 static inline int __must_check devm_clk_bulk_get_optional(struct device *dev,
 906                                 int num_clks, struct clk_bulk_data *clks)
 907 {
 908         return 0;
 909 }
 910
 911 static inline int __must_check devm_clk_bulk_get_all(struct device *dev,
 912                                                      struct clk_bulk_data **clks)
 913 {
 914
 915         return 0;
 916 }
 917
 918 static inline struct clk *devm_get_clk_from_child(struct device *dev,
 919                                 struct device_node *np, const char *con_id)
 920 {
 921         return NULL;
 922 }
 923
 924 static inline void clk_put(struct clk *clk) {}
 925
 926 static inline void clk_bulk_put(int num_clks, struct clk_bulk_data *clks) {}
 927
 928 static inline void clk_bulk_put_all(int num_clks, struct clk_bulk_data *clks) {}
 929
 930 static inline void devm_clk_put(struct device *dev, struct clk *clk) {}
 931
 932 static inline int clk_enable(struct clk *clk)
 933 {
 934         return 0;
 935 }
 936
 937 static inline int __must_check clk_bulk_enable(int num_clks,
 938                                                const struct clk_bulk_data *clks)
 939 {
 940         return 0;
 941 }
 942
 943 static inline void clk_disable(struct clk *clk) {}
 944
 945
 946 static inline void clk_bulk_disable(int num_clks,
 947                                     const struct clk_bulk_data *clks) {}
 948
 949 static inline unsigned long clk_get_rate(struct clk *clk)
 950 {
 951         return 0;
 952 }
 953
 954 static inline int clk_set_rate(struct clk *clk, unsigned long rate)
 955 {
 956         return 0;
 957 }
 958
 959 static inline int clk_set_rate_exclusive(struct clk *clk, unsigned long rate)
 960 {
 961         return 0;
 962 }
 963
 964 static inline long clk_round_rate(struct clk *clk, unsigned long rate)
 965 {
 966         return 0;
 967 }
 968
 969 static inline bool clk_has_parent(struct clk *clk, struct clk *parent)
 970 {
 971         return true;
 972 }
 973
 974 static inline int clk_set_rate_range(struct clk *clk, unsigned long min,
 975                                      unsigned long max)
 976 {
 977         return 0;
 978 }
 979
 980 static inline int clk_set_min_rate(struct clk *clk, unsigned long rate)
 981 {
 982         return 0;
 983 }
 984
 985 static inline int clk_set_max_rate(struct clk *clk, unsigned long rate)
 986 {
 987         return 0;
 988 }
 989
 990 static inline int clk_set_parent(struct clk *clk, struct clk *parent)
 991 {
 992         return 0;
 993 }
 994
 995 static inline struct clk *clk_get_parent(struct clk *clk)
 996 {
 997         return NULL;
 998 }
 999
1000 static inline struct clk *clk_get_sys(const char *dev_id, const char *con_id)
1001 {
1002         return NULL;
1003 }
1004
1005 static inline int clk_save_context(void)
1006 {
1007         return 0;
1008 }
1009
1010 static inline void clk_restore_context(void) {}
1011
1012 #endif
1013
1014 /* clk_prepare_enable helps cases using clk_enable in non-atomic context. */
1015 static inline int clk_prepare_enable(struct clk *clk)
1016 {
1017         int ret;
1018
1019         ret = clk_prepare(clk);
1020         if (ret)
1021                 return ret;
1022         ret = clk_enable(clk);
1023         if (ret)
1024                 clk_unprepare(clk);
1025
1026         return ret;
1027 }
1028
1029 /* clk_disable_unprepare helps cases using clk_disable in non-atomic context. */
1030 static inline void clk_disable_unprepare(struct clk *clk)
1031 {
1032         clk_disable(clk);
1033         clk_unprepare(clk);
1034 }
1035
1036 static inline int __must_check
1037 clk_bulk_prepare_enable(int num_clks, const struct clk_bulk_data *clks)
1038 {
1039         int ret;
1040
1041         ret = clk_bulk_prepare(num_clks, clks);
1042         if (ret)
1043                 return ret;
1044         ret = clk_bulk_enable(num_clks, clks);
1045         if (ret)
1046                 clk_bulk_unprepare(num_clks, clks);
1047
1048         return ret;
1049 }
1050
1051 static inline void clk_bulk_disable_unprepare(int num_clks,
1052                                               const struct clk_bulk_data *clks)
1053 {
1054         clk_bulk_disable(num_clks, clks);
1055         clk_bulk_unprepare(num_clks, clks);
1056 }
1057
1058 /**
1059  * clk_get_optional - lookup and obtain a reference to an optional clock
1060  *                    producer.
1061  * @dev: device for clock "consumer"
1062  * @id: clock consumer ID
1063  *
1064  * Behaves the same as clk_get() except where there is no clock producer. In
1065  * this case, instead of returning -ENOENT, the function returns NULL.
1066  */
1067 static inline struct clk *clk_get_optional(struct device *dev, const char *id)
1068 {
1069         struct clk *clk = clk_get(dev, id);
1070
1071         if (clk == ERR_PTR(-ENOENT))
1072                 return NULL;
1073
1074         return clk;
1075 }
1076
1077 #if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
1078 struct clk *of_clk_get(struct device_node *np, int index);
1079 struct clk *of_clk_get_by_name(struct device_node *np, const char *name);
1080 struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec);
1081 #else
1082 static inline struct clk *of_clk_get(struct device_node *np, int index)
1083 {
1084         return ERR_PTR(-ENOENT);
1085 }
1086 static inline struct clk *of_clk_get_by_name(struct device_node *np,
1087                                              const char *name)
1088 {
1089         return ERR_PTR(-ENOENT);
1090 }
1091 static inline struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec)
1092 {
1093         return ERR_PTR(-ENOENT);
1094 }
1095 #endif
1096
1097 #endif