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  * devm_clk_notifier_register - register a managed rate-change notifier callback
 114  * @dev: device for clock "consumer"
 115  * @clk: clock whose rate we are interested in
 116  * @nb: notifier block with callback function pointer
 117  *
 118  * Returns 0 on success, -EERROR otherwise
 119  */
 120 int devm_clk_notifier_register(struct device *dev, struct clk *clk,
 121                                struct notifier_block *nb);
 122
 123 /**
 124  * clk_get_accuracy - obtain the clock accuracy in ppb (parts per billion)
 125  *                    for a clock source.
 126  * @clk: clock source
 127  *
 128  * This gets the clock source accuracy expressed in ppb.
 129  * A perfect clock returns 0.
 130  */
 131 long clk_get_accuracy(struct clk *clk);
 132
 133 /**
 134  * clk_set_phase - adjust the phase shift of a clock signal
 135  * @clk: clock signal source
 136  * @degrees: number of degrees the signal is shifted
 137  *
 138  * Shifts the phase of a clock signal by the specified degrees. Returns 0 on
 139  * success, -EERROR otherwise.
 140  */
 141 int clk_set_phase(struct clk *clk, int degrees);
 142
 143 /**
 144  * clk_get_phase - return the phase shift of a clock signal
 145  * @clk: clock signal source
 146  *
 147  * Returns the phase shift of a clock node in degrees, otherwise returns
 148  * -EERROR.
 149  */
 150 int clk_get_phase(struct clk *clk);
 151
 152 /**
 153  * clk_set_duty_cycle - adjust the duty cycle ratio of a clock signal
 154  * @clk: clock signal source
 155  * @num: numerator of the duty cycle ratio to be applied
 156  * @den: denominator of the duty cycle ratio to be applied
 157  *
 158  * Adjust the duty cycle of a clock signal by the specified ratio. Returns 0 on
 159  * success, -EERROR otherwise.
 160  */
 161 int clk_set_duty_cycle(struct clk *clk, unsigned int num, unsigned int den);
 162
 163 /**
 164  * clk_get_scaled_duty_cycle - return the duty cycle ratio of a clock signal
 165  * @clk: clock signal source
 166  * @scale: scaling factor to be applied to represent the ratio as an integer
 167  *
 168  * Returns the duty cycle ratio multiplied by the scale provided, otherwise
 169  * returns -EERROR.
 170  */
 171 int clk_get_scaled_duty_cycle(struct clk *clk, unsigned int scale);
 172
 173 /**
 174  * clk_is_match - check if two clk's point to the same hardware clock
 175  * @p: clk compared against q
 176  * @q: clk compared against p
 177  *
 178  * Returns true if the two struct clk pointers both point to the same hardware
 179  * clock node. Put differently, returns true if @p and @q
 180  * share the same &struct clk_core object.
 181  *
 182  * Returns false otherwise. Note that two NULL clks are treated as matching.
 183  */
 184 bool clk_is_match(const struct clk *p, const struct clk *q);
 185
 186 #else
 187
 188 static inline int clk_notifier_register(struct clk *clk,
 189                                         struct notifier_block *nb)
 190 {
 191         return -ENOTSUPP;
 192 }
 193
 194 static inline int clk_notifier_unregister(struct clk *clk,
 195                                           struct notifier_block *nb)
 196 {
 197         return -ENOTSUPP;
 198 }
 199
 200 static inline int devm_clk_notifier_register(struct device *dev,
 201                                              struct clk *clk,
 202                                              struct notifier_block *nb)
 203 {
 204         return -ENOTSUPP;
 205 }
 206
 207 static inline long clk_get_accuracy(struct clk *clk)
 208 {
 209         return -ENOTSUPP;
 210 }
 211
 212 static inline long clk_set_phase(struct clk *clk, int phase)
 213 {
 214         return -ENOTSUPP;
 215 }
 216
 217 static inline long clk_get_phase(struct clk *clk)
 218 {
 219         return -ENOTSUPP;
 220 }
 221
 222 static inline int clk_set_duty_cycle(struct clk *clk, unsigned int num,
 223                                      unsigned int den)
 224 {
 225         return -ENOTSUPP;
 226 }
 227
 228 static inline unsigned int clk_get_scaled_duty_cycle(struct clk *clk,
 229                                                      unsigned int scale)
 230 {
 231         return 0;
 232 }
 233
 234 static inline bool clk_is_match(const struct clk *p, const struct clk *q)
 235 {
 236         return p == q;
 237 }
 238
 239 #endif
 240
 241 #ifdef CONFIG_HAVE_CLK_PREPARE
 242 /**
 243  * clk_prepare - prepare a clock source
 244  * @clk: clock source
 245  *
 246  * This prepares the clock source for use.
 247  *
 248  * Must not be called from within atomic context.
 249  */
 250 int clk_prepare(struct clk *clk);
 251 int __must_check clk_bulk_prepare(int num_clks,
 252                                   const struct clk_bulk_data *clks);
 253
 254 /**
 255  * clk_is_enabled_when_prepared - indicate if preparing a clock also enables it.
 256  * @clk: clock source
 257  *
 258  * Returns true if clk_prepare() implicitly enables the clock, effectively
 259  * making clk_enable()/clk_disable() no-ops, false otherwise.
 260  *
 261  * This is of interest mainly to the power management code where actually
 262  * disabling the clock also requires unpreparing it to have any material
 263  * effect.
 264  *
 265  * Regardless of the value returned here, the caller must always invoke
 266  * clk_enable() or clk_prepare_enable()  and counterparts for usage counts
 267  * to be right.
 268  */
 269 bool clk_is_enabled_when_prepared(struct clk *clk);
 270 #else
 271 static inline int clk_prepare(struct clk *clk)
 272 {
 273         might_sleep();
 274         return 0;
 275 }
 276
 277 static inline int __must_check
 278 clk_bulk_prepare(int num_clks, const struct clk_bulk_data *clks)
 279 {
 280         might_sleep();
 281         return 0;
 282 }
 283
 284 static inline bool clk_is_enabled_when_prepared(struct clk *clk)
 285 {
 286         return false;
 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  * clk_rate_exclusive_get - get exclusivity over the rate control of a
 575  *                          producer
 576  * @clk: clock source
 577  *
 578  * This function allows drivers to get exclusive control over the rate of a
 579  * provider. It prevents any other consumer to execute, even indirectly,
 580  * opereation which could alter the rate of the provider or cause glitches
 581  *
 582  * If exlusivity is claimed more than once on clock, even by the same driver,
 583  * the rate effectively gets locked as exclusivity can't be preempted.
 584  *
 585  * Must not be called from within atomic context.
 586  *
 587  * Returns success (0) or negative errno.
 588  */
 589 int clk_rate_exclusive_get(struct clk *clk);
 590
 591 /**
 592  * clk_rate_exclusive_put - release exclusivity over the rate control of a
 593  *                          producer
 594  * @clk: clock source
 595  *
 596  * This function allows drivers to release the exclusivity it previously got
 597  * from clk_rate_exclusive_get()
 598  *
 599  * The caller must balance the number of clk_rate_exclusive_get() and
 600  * clk_rate_exclusive_put() calls.
 601  *
 602  * Must not be called from within atomic context.
 603  */
 604 void clk_rate_exclusive_put(struct clk *clk);
 605
 606 /**
 607  * clk_enable - inform the system when the clock source should be running.
 608  * @clk: clock source
 609  *
 610  * If the clock can not be enabled/disabled, this should return success.
 611  *
 612  * May be called from atomic contexts.
 613  *
 614  * Returns success (0) or negative errno.
 615  */
 616 int clk_enable(struct clk *clk);
 617
 618 /**
 619  * clk_bulk_enable - inform the system when the set of clks should be running.
 620  * @num_clks: the number of clk_bulk_data
 621  * @clks: the clk_bulk_data table of consumer
 622  *
 623  * May be called from atomic contexts.
 624  *
 625  * Returns success (0) or negative errno.
 626  */
 627 int __must_check clk_bulk_enable(int num_clks,
 628                                  const struct clk_bulk_data *clks);
 629
 630 /**
 631  * clk_disable - inform the system when the clock source is no longer required.
 632  * @clk: clock source
 633  *
 634  * Inform the system that a clock source is no longer required by
 635  * a driver and may be shut down.
 636  *
 637  * May be called from atomic contexts.
 638  *
 639  * Implementation detail: if the clock source is shared between
 640  * multiple drivers, clk_enable() calls must be balanced by the
 641  * same number of clk_disable() calls for the clock source to be
 642  * disabled.
 643  */
 644 void clk_disable(struct clk *clk);
 645
 646 /**
 647  * clk_bulk_disable - inform the system when the set of clks is no
 648  *                    longer required.
 649  * @num_clks: the number of clk_bulk_data
 650  * @clks: the clk_bulk_data table of consumer
 651  *
 652  * Inform the system that a set of clks is no longer required by
 653  * a driver and may be shut down.
 654  *
 655  * May be called from atomic contexts.
 656  *
 657  * Implementation detail: if the set of clks is shared between
 658  * multiple drivers, clk_bulk_enable() calls must be balanced by the
 659  * same number of clk_bulk_disable() calls for the clock source to be
 660  * disabled.
 661  */
 662 void clk_bulk_disable(int num_clks, const struct clk_bulk_data *clks);
 663
 664 /**
 665  * clk_get_rate - obtain the current clock rate (in Hz) for a clock source.
 666  *                This is only valid once the clock source has been enabled.
 667  * @clk: clock source
 668  */
 669 unsigned long clk_get_rate(struct clk *clk);
 670
 671 /**
 672  * clk_put      - "free" the clock source
 673  * @clk: clock source
 674  *
 675  * Note: drivers must ensure that all clk_enable calls made on this
 676  * clock source are balanced by clk_disable calls prior to calling
 677  * this function.
 678  *
 679  * clk_put should not be called from within interrupt context.
 680  */
 681 void clk_put(struct clk *clk);
 682
 683 /**
 684  * clk_bulk_put - "free" the clock source
 685  * @num_clks: the number of clk_bulk_data
 686  * @clks: the clk_bulk_data table of consumer
 687  *
 688  * Note: drivers must ensure that all clk_bulk_enable calls made on this
 689  * clock source are balanced by clk_bulk_disable calls prior to calling
 690  * this function.
 691  *
 692  * clk_bulk_put should not be called from within interrupt context.
 693  */
 694 void clk_bulk_put(int num_clks, struct clk_bulk_data *clks);
 695
 696 /**
 697  * clk_bulk_put_all - "free" all the clock source
 698  * @num_clks: the number of clk_bulk_data
 699  * @clks: the clk_bulk_data table of consumer
 700  *
 701  * Note: drivers must ensure that all clk_bulk_enable calls made on this
 702  * clock source are balanced by clk_bulk_disable calls prior to calling
 703  * this function.
 704  *
 705  * clk_bulk_put_all should not be called from within interrupt context.
 706  */
 707 void clk_bulk_put_all(int num_clks, struct clk_bulk_data *clks);
 708
 709 /**
 710  * devm_clk_put - "free" a managed clock source
 711  * @dev: device used to acquire the clock
 712  * @clk: clock source acquired with devm_clk_get()
 713  *
 714  * Note: drivers must ensure that all clk_enable calls made on this
 715  * clock source are balanced by clk_disable calls prior to calling
 716  * this function.
 717  *
 718  * clk_put should not be called from within interrupt context.
 719  */
 720 void devm_clk_put(struct device *dev, struct clk *clk);
 721
 722 /*
 723  * The remaining APIs are optional for machine class support.
 724  */
 725
 726
 727 /**
 728  * clk_round_rate - adjust a rate to the exact rate a clock can provide
 729  * @clk: clock source
 730  * @rate: desired clock rate in Hz
 731  *
 732  * This answers the question "if I were to pass @rate to clk_set_rate(),
 733  * what clock rate would I end up with?" without changing the hardware
 734  * in any way.  In other words:
 735  *
 736  *   rate = clk_round_rate(clk, r);
 737  *
 738  * and:
 739  *
 740  *   clk_set_rate(clk, r);
 741  *   rate = clk_get_rate(clk);
 742  *
 743  * are equivalent except the former does not modify the clock hardware
 744  * in any way.
 745  *
 746  * Returns rounded clock rate in Hz, or negative errno.
 747  */
 748 long clk_round_rate(struct clk *clk, unsigned long rate);
 749
 750 /**
 751  * clk_set_rate - set the clock rate for a clock source
 752  * @clk: clock source
 753  * @rate: desired clock rate in Hz
 754  *
 755  * Updating the rate starts at the top-most affected clock and then
 756  * walks the tree down to the bottom-most clock that needs updating.
 757  *
 758  * Returns success (0) or negative errno.
 759  */
 760 int clk_set_rate(struct clk *clk, unsigned long rate);
 761
 762 /**
 763  * clk_set_rate_exclusive- set the clock rate and claim exclusivity over
 764  *                         clock source
 765  * @clk: clock source
 766  * @rate: desired clock rate in Hz
 767  *
 768  * This helper function allows drivers to atomically set the rate of a producer
 769  * and claim exclusivity over the rate control of the producer.
 770  *
 771  * It is essentially a combination of clk_set_rate() and
 772  * clk_rate_exclusite_get(). Caller must balance this call with a call to
 773  * clk_rate_exclusive_put()
 774  *
 775  * Returns success (0) or negative errno.
 776  */
 777 int clk_set_rate_exclusive(struct clk *clk, unsigned long rate);
 778
 779 /**
 780  * clk_has_parent - check if a clock is a possible parent for another
 781  * @clk: clock source
 782  * @parent: parent clock source
 783  *
 784  * This function can be used in drivers that need to check that a clock can be
 785  * the parent of another without actually changing the parent.
 786  *
 787  * Returns true if @parent is a possible parent for @clk, false otherwise.
 788  */
 789 bool clk_has_parent(struct clk *clk, struct clk *parent);
 790
 791 /**
 792  * clk_set_rate_range - set a rate range for a clock source
 793  * @clk: clock source
 794  * @min: desired minimum clock rate in Hz, inclusive
 795  * @max: desired maximum clock rate in Hz, inclusive
 796  *
 797  * Returns success (0) or negative errno.
 798  */
 799 int clk_set_rate_range(struct clk *clk, unsigned long min, unsigned long max);
 800
 801 /**
 802  * clk_set_min_rate - set a minimum clock rate for a clock source
 803  * @clk: clock source
 804  * @rate: desired minimum clock rate in Hz, inclusive
 805  *
 806  * Returns success (0) or negative errno.
 807  */
 808 int clk_set_min_rate(struct clk *clk, unsigned long rate);
 809
 810 /**
 811  * clk_set_max_rate - set a maximum clock rate for a clock source
 812  * @clk: clock source
 813  * @rate: desired maximum clock rate in Hz, inclusive
 814  *
 815  * Returns success (0) or negative errno.
 816  */
 817 int clk_set_max_rate(struct clk *clk, unsigned long rate);
 818
 819 /**
 820  * clk_set_parent - set the parent clock source for this clock
 821  * @clk: clock source
 822  * @parent: parent clock source
 823  *
 824  * Returns success (0) or negative errno.
 825  */
 826 int clk_set_parent(struct clk *clk, struct clk *parent);
 827
 828 /**
 829  * clk_get_parent - get the parent clock source for this clock
 830  * @clk: clock source
 831  *
 832  * Returns struct clk corresponding to parent clock source, or
 833  * valid IS_ERR() condition containing errno.
 834  */
 835 struct clk *clk_get_parent(struct clk *clk);
 836
 837 /**
 838  * clk_get_sys - get a clock based upon the device name
 839  * @dev_id: device name
 840  * @con_id: connection ID
 841  *
 842  * Returns a struct clk corresponding to the clock producer, or
 843  * valid IS_ERR() condition containing errno.  The implementation
 844  * uses @dev_id and @con_id to determine the clock consumer, and
 845  * thereby the clock producer. In contrast to clk_get() this function
 846  * takes the device name instead of the device itself for identification.
 847  *
 848  * Drivers must assume that the clock source is not enabled.
 849  *
 850  * clk_get_sys should not be called from within interrupt context.
 851  */
 852 struct clk *clk_get_sys(const char *dev_id, const char *con_id);
 853
 854 /**
 855  * clk_save_context - save clock context for poweroff
 856  *
 857  * Saves the context of the clock register for powerstates in which the
 858  * contents of the registers will be lost. Occurs deep within the suspend
 859  * code so locking is not necessary.
 860  */
 861 int clk_save_context(void);
 862
 863 /**
 864  * clk_restore_context - restore clock context after poweroff
 865  *
 866  * This occurs with all clocks enabled. Occurs deep within the resume code
 867  * so locking is not necessary.
 868  */
 869 void clk_restore_context(void);
 870
 871 #else /* !CONFIG_HAVE_CLK */
 872
 873 static inline struct clk *clk_get(struct device *dev, const char *id)
 874 {
 875         return NULL;
 876 }
 877
 878 static inline int __must_check clk_bulk_get(struct device *dev, int num_clks,
 879                                             struct clk_bulk_data *clks)
 880 {
 881         return 0;
 882 }
 883
 884 static inline int __must_check clk_bulk_get_optional(struct device *dev,
 885                                 int num_clks, struct clk_bulk_data *clks)
 886 {
 887         return 0;
 888 }
 889
 890 static inline int __must_check clk_bulk_get_all(struct device *dev,
 891                                          struct clk_bulk_data **clks)
 892 {
 893         return 0;
 894 }
 895
 896 static inline struct clk *devm_clk_get(struct device *dev, const char *id)
 897 {
 898         return NULL;
 899 }
 900
 901 static inline struct clk *devm_clk_get_prepared(struct device *dev,
 902                                                 const char *id)
 903 {
 904         return NULL;
 905 }
 906
 907 static inline struct clk *devm_clk_get_enabled(struct device *dev,
 908                                                const char *id)
 909 {
 910         return NULL;
 911 }
 912
 913 static inline struct clk *devm_clk_get_optional(struct device *dev,
 914                                                 const char *id)
 915 {
 916         return NULL;
 917 }
 918
 919 static inline struct clk *devm_clk_get_optional_prepared(struct device *dev,
 920                                                          const char *id)
 921 {
 922         return NULL;
 923 }
 924
 925 static inline struct clk *devm_clk_get_optional_enabled(struct device *dev,
 926                                                         const char *id)
 927 {
 928         return NULL;
 929 }
 930
 931 static inline int __must_check devm_clk_bulk_get(struct device *dev, int num_clks,
 932                                                  struct clk_bulk_data *clks)
 933 {
 934         return 0;
 935 }
 936
 937 static inline int __must_check devm_clk_bulk_get_optional(struct device *dev,
 938                                 int num_clks, struct clk_bulk_data *clks)
 939 {
 940         return 0;
 941 }
 942
 943 static inline int __must_check devm_clk_bulk_get_all(struct device *dev,
 944                                                      struct clk_bulk_data **clks)
 945 {
 946
 947         return 0;
 948 }
 949
 950 static inline struct clk *devm_get_clk_from_child(struct device *dev,
 951                                 struct device_node *np, const char *con_id)
 952 {
 953         return NULL;
 954 }
 955
 956 static inline void clk_put(struct clk *clk) {}
 957
 958 static inline void clk_bulk_put(int num_clks, struct clk_bulk_data *clks) {}
 959
 960 static inline void clk_bulk_put_all(int num_clks, struct clk_bulk_data *clks) {}
 961
 962 static inline void devm_clk_put(struct device *dev, struct clk *clk) {}
 963
 964
 965 static inline int clk_rate_exclusive_get(struct clk *clk)
 966 {
 967         return 0;
 968 }
 969
 970 static inline void clk_rate_exclusive_put(struct clk *clk) {}
 971
 972 static inline int clk_enable(struct clk *clk)
 973 {
 974         return 0;
 975 }
 976
 977 static inline int __must_check clk_bulk_enable(int num_clks,
 978                                                const struct clk_bulk_data *clks)
 979 {
 980         return 0;
 981 }
 982
 983 static inline void clk_disable(struct clk *clk) {}
 984
 985
 986 static inline void clk_bulk_disable(int num_clks,
 987                                     const struct clk_bulk_data *clks) {}
 988
 989 static inline unsigned long clk_get_rate(struct clk *clk)
 990 {
 991         return 0;
 992 }
 993
 994 static inline int clk_set_rate(struct clk *clk, unsigned long rate)
 995 {
 996         return 0;
 997 }
 998
 999 static inline int clk_set_rate_exclusive(struct clk *clk, unsigned long rate)
1000 {
1001         return 0;
1002 }
1003
1004 static inline long clk_round_rate(struct clk *clk, unsigned long rate)
1005 {
1006         return 0;
1007 }
1008
1009 static inline bool clk_has_parent(struct clk *clk, struct clk *parent)
1010 {
1011         return true;
1012 }
1013
1014 static inline int clk_set_rate_range(struct clk *clk, unsigned long min,
1015                                      unsigned long max)
1016 {
1017         return 0;
1018 }
1019
1020 static inline int clk_set_min_rate(struct clk *clk, unsigned long rate)
1021 {
1022         return 0;
1023 }
1024
1025 static inline int clk_set_max_rate(struct clk *clk, unsigned long rate)
1026 {
1027         return 0;
1028 }
1029
1030 static inline int clk_set_parent(struct clk *clk, struct clk *parent)
1031 {
1032         return 0;
1033 }
1034
1035 static inline struct clk *clk_get_parent(struct clk *clk)
1036 {
1037         return NULL;
1038 }
1039
1040 static inline struct clk *clk_get_sys(const char *dev_id, const char *con_id)
1041 {
1042         return NULL;
1043 }
1044
1045 static inline int clk_save_context(void)
1046 {
1047         return 0;
1048 }
1049
1050 static inline void clk_restore_context(void) {}
1051
1052 #endif
1053
1054 /* clk_prepare_enable helps cases using clk_enable in non-atomic context. */
1055 static inline int clk_prepare_enable(struct clk *clk)
1056 {
1057         int ret;
1058
1059         ret = clk_prepare(clk);
1060         if (ret)
1061                 return ret;
1062         ret = clk_enable(clk);
1063         if (ret)
1064                 clk_unprepare(clk);
1065
1066         return ret;
1067 }
1068
1069 /* clk_disable_unprepare helps cases using clk_disable in non-atomic context. */
1070 static inline void clk_disable_unprepare(struct clk *clk)
1071 {
1072         clk_disable(clk);
1073         clk_unprepare(clk);
1074 }
1075
1076 static inline int __must_check
1077 clk_bulk_prepare_enable(int num_clks, const struct clk_bulk_data *clks)
1078 {
1079         int ret;
1080
1081         ret = clk_bulk_prepare(num_clks, clks);
1082         if (ret)
1083                 return ret;
1084         ret = clk_bulk_enable(num_clks, clks);
1085         if (ret)
1086                 clk_bulk_unprepare(num_clks, clks);
1087
1088         return ret;
1089 }
1090
1091 static inline void clk_bulk_disable_unprepare(int num_clks,
1092                                               const struct clk_bulk_data *clks)
1093 {
1094         clk_bulk_disable(num_clks, clks);
1095         clk_bulk_unprepare(num_clks, clks);
1096 }
1097
1098 /**
1099  * clk_get_optional - lookup and obtain a reference to an optional clock
1100  *                    producer.
1101  * @dev: device for clock "consumer"
1102  * @id: clock consumer ID
1103  *
1104  * Behaves the same as clk_get() except where there is no clock producer. In
1105  * this case, instead of returning -ENOENT, the function returns NULL.
1106  */
1107 static inline struct clk *clk_get_optional(struct device *dev, const char *id)
1108 {
1109         struct clk *clk = clk_get(dev, id);
1110
1111         if (clk == ERR_PTR(-ENOENT))
1112                 return NULL;
1113
1114         return clk;
1115 }
1116
1117 #if defined(CONFIG_OF) && defined(CONFIG_COMMON_CLK)
1118 struct clk *of_clk_get(struct device_node *np, int index);
1119 struct clk *of_clk_get_by_name(struct device_node *np, const char *name);
1120 struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec);
1121 #else
1122 static inline struct clk *of_clk_get(struct device_node *np, int index)
1123 {
1124         return ERR_PTR(-ENOENT);
1125 }
1126 static inline struct clk *of_clk_get_by_name(struct device_node *np,
1127                                              const char *name)
1128 {
1129         return ERR_PTR(-ENOENT);
1130 }
1131 static inline struct clk *of_clk_get_from_provider(struct of_phandle_args *clkspec)
1132 {
1133         return ERR_PTR(-ENOENT);
1134 }
1135 #endif
1136
1137 #endif