include/linux/clk-provider.h

   1 /*
   2  *  linux/include/linux/clk-provider.h
   3  *
   4  *  Copyright (c) 2010-2011 Jeremy Kerr <jeremy.kerr@canonical.com>
   5  *  Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
   6  *
   7  * This program is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License version 2 as
   9  * published by the Free Software Foundation.
  10  */
  11 #ifndef __LINUX_CLK_PROVIDER_H
  12 #define __LINUX_CLK_PROVIDER_H
  13
  14 #include <linux/clk.h>
  15 #include <linux/io.h>
  16 #include <linux/of.h>
  17
  18 #ifdef CONFIG_COMMON_CLK
  19
  20 /*
  21  * flags used across common struct clk.  these flags should only affect the
  22  * top-level framework.  custom flags for dealing with hardware specifics
  23  * belong in struct clk_foo
  24  */
  25 #define CLK_SET_RATE_GATE       BIT(0) /* must be gated across rate change */
  26 #define CLK_SET_PARENT_GATE     BIT(1) /* must be gated across re-parent */
  27 #define CLK_SET_RATE_PARENT     BIT(2) /* propagate rate change up one level */
  28 #define CLK_IGNORE_UNUSED       BIT(3) /* do not gate even if unused */
  29 #define CLK_IS_ROOT             BIT(4) /* root clk, has no parent */
  30 #define CLK_IS_BASIC            BIT(5) /* Basic clk, can't do a to_clk_foo() */
  31 #define CLK_GET_RATE_NOCACHE    BIT(6) /* do not use the cached clk rate */
  32 #define CLK_SET_RATE_NO_REPARENT BIT(7) /* don't re-parent on rate change */
  33 #define CLK_GET_ACCURACY_NOCACHE BIT(8) /* do not use the cached clk accuracy */
  34
  35 struct clk_hw;
  36 struct dentry;
  37
  38 /**
  39  * struct clk_ops -  Callback operations for hardware clocks; these are to
  40  * be provided by the clock implementation, and will be called by drivers
  41  * through the clk_* api.
  42  *
  43  * @prepare:    Prepare the clock for enabling. This must not return until
  44  *              the clock is fully prepared, and it's safe to call clk_enable.
  45  *              This callback is intended to allow clock implementations to
  46  *              do any initialisation that may sleep. Called with
  47  *              prepare_lock held.
  48  *
  49  * @unprepare:  Release the clock from its prepared state. This will typically
  50  *              undo any work done in the @prepare callback. Called with
  51  *              prepare_lock held.
  52  *
  53  * @is_prepared: Queries the hardware to determine if the clock is prepared.
  54  *              This function is allowed to sleep. Optional, if this op is not
  55  *              set then the prepare count will be used.
  56  *
  57  * @unprepare_unused: Unprepare the clock atomically.  Only called from
  58  *              clk_disable_unused for prepare clocks with special needs.
  59  *              Called with prepare mutex held. This function may sleep.
  60  *
  61  * @enable:     Enable the clock atomically. This must not return until the
  62  *              clock is generating a valid clock signal, usable by consumer
  63  *              devices. Called with enable_lock held. This function must not
  64  *              sleep.
  65  *
  66  * @disable:    Disable the clock atomically. Called with enable_lock held.
  67  *              This function must not sleep.
  68  *
  69  * @is_enabled: Queries the hardware to determine if the clock is enabled.
  70  *              This function must not sleep. Optional, if this op is not
  71  *              set then the enable count will be used.
  72  *
  73  * @disable_unused: Disable the clock atomically.  Only called from
  74  *              clk_disable_unused for gate clocks with special needs.
  75  *              Called with enable_lock held.  This function must not
  76  *              sleep.
  77  *
  78  * @recalc_rate Recalculate the rate of this clock, by querying hardware. The
  79  *              parent rate is an input parameter.  It is up to the caller to
  80  *              ensure that the prepare_mutex is held across this call.
  81  *              Returns the calculated rate.  Optional, but recommended - if
  82  *              this op is not set then clock rate will be initialized to 0.
  83  *
  84  * @round_rate: Given a target rate as input, returns the closest rate actually
  85  *              supported by the clock. The parent rate is an input/output
  86  *              parameter.
  87  *
  88  * @determine_rate: Given a target rate as input, returns the closest rate
  89  *              actually supported by the clock, and optionally the parent clock
  90  *              that should be used to provide the clock rate.
  91  *
  92  * @set_parent: Change the input source of this clock; for clocks with multiple
  93  *              possible parents specify a new parent by passing in the index
  94  *              as a u8 corresponding to the parent in either the .parent_names
  95  *              or .parents arrays.  This function in affect translates an
  96  *              array index into the value programmed into the hardware.
  97  *              Returns 0 on success, -EERROR otherwise.
  98  *
  99  * @get_parent: Queries the hardware to determine the parent of a clock.  The
 100  *              return value is a u8 which specifies the index corresponding to
 101  *              the parent clock.  This index can be applied to either the
 102  *              .parent_names or .parents arrays.  In short, this function
 103  *              translates the parent value read from hardware into an array
 104  *              index.  Currently only called when the clock is initialized by
 105  *              __clk_init.  This callback is mandatory for clocks with
 106  *              multiple parents.  It is optional (and unnecessary) for clocks
 107  *              with 0 or 1 parents.
 108  *
 109  * @set_rate:   Change the rate of this clock. The requested rate is specified
 110  *              by the second argument, which should typically be the return
 111  *              of .round_rate call.  The third argument gives the parent rate
 112  *              which is likely helpful for most .set_rate implementation.
 113  *              Returns 0 on success, -EERROR otherwise.
 114  *
 115  * @set_rate_and_parent: Change the rate and the parent of this clock. The
 116  *              requested rate is specified by the second argument, which
 117  *              should typically be the return of .round_rate call.  The
 118  *              third argument gives the parent rate which is likely helpful
 119  *              for most .set_rate_and_parent implementation. The fourth
 120  *              argument gives the parent index. This callback is optional (and
 121  *              unnecessary) for clocks with 0 or 1 parents as well as
 122  *              for clocks that can tolerate switching the rate and the parent
 123  *              separately via calls to .set_parent and .set_rate.
 124  *              Returns 0 on success, -EERROR otherwise.
 125  *
 126  * @recalc_accuracy: Recalculate the accuracy of this clock. The clock accuracy
 127  *              is expressed in ppb (parts per billion). The parent accuracy is
 128  *              an input parameter.
 129  *              Returns the calculated accuracy.  Optional - if this op is not
 130  *              set then clock accuracy will be initialized to parent accuracy
 131  *              or 0 (perfect clock) if clock has no parent.
 132  *
 133  * @get_phase:  Queries the hardware to get the current phase of a clock.
 134  *              Returned values are 0-359 degrees on success, negative
 135  *              error codes on failure.
 136  *
 137  * @set_phase:  Shift the phase this clock signal in degrees specified
 138  *              by the second argument. Valid values for degrees are
 139  *              0-359. Return 0 on success, otherwise -EERROR.
 140  *
 141  * @init:       Perform platform-specific initialization magic.
 142  *              This is not not used by any of the basic clock types.
 143  *              Please consider other ways of solving initialization problems
 144  *              before using this callback, as its use is discouraged.
 145  *
 146  * @debug_init: Set up type-specific debugfs entries for this clock.  This
 147  *              is called once, after the debugfs directory entry for this
 148  *              clock has been created.  The dentry pointer representing that
 149  *              directory is provided as an argument.  Called with
 150  *              prepare_lock held.  Returns 0 on success, -EERROR otherwise.
 151  *
 152  *
 153  * The clk_enable/clk_disable and clk_prepare/clk_unprepare pairs allow
 154  * implementations to split any work between atomic (enable) and sleepable
 155  * (prepare) contexts.  If enabling a clock requires code that might sleep,
 156  * this must be done in clk_prepare.  Clock enable code that will never be
 157  * called in a sleepable context may be implemented in clk_enable.
 158  *
 159  * Typically, drivers will call clk_prepare when a clock may be needed later
 160  * (eg. when a device is opened), and clk_enable when the clock is actually
 161  * required (eg. from an interrupt). Note that clk_prepare MUST have been
 162  * called before clk_enable.
 163  */
 164 struct clk_ops {
 165         int             (*prepare)(struct clk_hw *hw);
 166         void            (*unprepare)(struct clk_hw *hw);
 167         int             (*is_prepared)(struct clk_hw *hw);
 168         void            (*unprepare_unused)(struct clk_hw *hw);
 169         int             (*enable)(struct clk_hw *hw);
 170         void            (*disable)(struct clk_hw *hw);
 171         int             (*is_enabled)(struct clk_hw *hw);
 172         void            (*disable_unused)(struct clk_hw *hw);
 173         unsigned long   (*recalc_rate)(struct clk_hw *hw,
 174                                         unsigned long parent_rate);
 175         long            (*round_rate)(struct clk_hw *hw, unsigned long rate,
 176                                         unsigned long *parent_rate);
 177         long            (*determine_rate)(struct clk_hw *hw, unsigned long rate,
 178                                         unsigned long *best_parent_rate,
 179                                         struct clk_hw **best_parent_hw);
 180         int             (*set_parent)(struct clk_hw *hw, u8 index);
 181         u8              (*get_parent)(struct clk_hw *hw);
 182         int             (*set_rate)(struct clk_hw *hw, unsigned long rate,
 183                                     unsigned long parent_rate);
 184         int             (*set_rate_and_parent)(struct clk_hw *hw,
 185                                     unsigned long rate,
 186                                     unsigned long parent_rate, u8 index);
 187         unsigned long   (*recalc_accuracy)(struct clk_hw *hw,
 188                                            unsigned long parent_accuracy);
 189         int             (*get_phase)(struct clk_hw *hw);
 190         int             (*set_phase)(struct clk_hw *hw, int degrees);
 191         void            (*init)(struct clk_hw *hw);
 192         int             (*debug_init)(struct clk_hw *hw, struct dentry *dentry);
 193 };
 194
 195 /**
 196  * struct clk_init_data - holds init data that's common to all clocks and is
 197  * shared between the clock provider and the common clock framework.
 198  *
 199  * @name: clock name
 200  * @ops: operations this clock supports
 201  * @parent_names: array of string names for all possible parents
 202  * @num_parents: number of possible parents
 203  * @flags: framework-level hints and quirks
 204  */
 205 struct clk_init_data {
 206         const char              *name;
 207         const struct clk_ops    *ops;
 208         const char              **parent_names;
 209         u8                      num_parents;
 210         unsigned long           flags;
 211 };
 212
 213 /**
 214  * struct clk_hw - handle for traversing from a struct clk to its corresponding
 215  * hardware-specific structure.  struct clk_hw should be declared within struct
 216  * clk_foo and then referenced by the struct clk instance that uses struct
 217  * clk_foo's clk_ops
 218  *
 219  * @clk: pointer to the struct clk instance that points back to this struct
 220  * clk_hw instance
 221  *
 222  * @init: pointer to struct clk_init_data that contains the init data shared
 223  * with the common clock framework.
 224  */
 225 struct clk_hw {
 226         struct clk *clk;
 227         const struct clk_init_data *init;
 228 };
 229
 230 /*
 231  * DOC: Basic clock implementations common to many platforms
 232  *
 233  * Each basic clock hardware type is comprised of a structure describing the
 234  * clock hardware, implementations of the relevant callbacks in struct clk_ops,
 235  * unique flags for that hardware type, a registration function and an
 236  * alternative macro for static initialization
 237  */
 238
 239 /**
 240  * struct clk_fixed_rate - fixed-rate clock
 241  * @hw:         handle between common and hardware-specific interfaces
 242  * @fixed_rate: constant frequency of clock
 243  */
 244 struct clk_fixed_rate {
 245         struct          clk_hw hw;
 246         unsigned long   fixed_rate;
 247         unsigned long   fixed_accuracy;
 248         u8              flags;
 249 };
 250
 251 extern const struct clk_ops clk_fixed_rate_ops;
 252 struct clk *clk_register_fixed_rate(struct device *dev, const char *name,
 253                 const char *parent_name, unsigned long flags,
 254                 unsigned long fixed_rate);
 255 struct clk *clk_register_fixed_rate_with_accuracy(struct device *dev,
 256                 const char *name, const char *parent_name, unsigned long flags,
 257                 unsigned long fixed_rate, unsigned long fixed_accuracy);
 258
 259 void of_fixed_clk_setup(struct device_node *np);
 260
 261 /**
 262  * struct clk_gate - gating clock
 263  *
 264  * @hw:         handle between common and hardware-specific interfaces
 265  * @reg:        register controlling gate
 266  * @bit_idx:    single bit controlling gate
 267  * @flags:      hardware-specific flags
 268  * @lock:       register lock
 269  *
 270  * Clock which can gate its output.  Implements .enable & .disable
 271  *
 272  * Flags:
 273  * CLK_GATE_SET_TO_DISABLE - by default this clock sets the bit at bit_idx to
 274  *      enable the clock.  Setting this flag does the opposite: setting the bit
 275  *      disable the clock and clearing it enables the clock
 276  * CLK_GATE_HIWORD_MASK - The gate settings are only in lower 16-bit
 277  *      of this register, and mask of gate bits are in higher 16-bit of this
 278  *      register.  While setting the gate bits, higher 16-bit should also be
 279  *      updated to indicate changing gate bits.
 280  */
 281 struct clk_gate {
 282         struct clk_hw hw;
 283         void __iomem    *reg;
 284         u8              bit_idx;
 285         u8              flags;
 286         spinlock_t      *lock;
 287 };
 288
 289 #define CLK_GATE_SET_TO_DISABLE         BIT(0)
 290 #define CLK_GATE_HIWORD_MASK            BIT(1)
 291
 292 extern const struct clk_ops clk_gate_ops;
 293 struct clk *clk_register_gate(struct device *dev, const char *name,
 294                 const char *parent_name, unsigned long flags,
 295                 void __iomem *reg, u8 bit_idx,
 296                 u8 clk_gate_flags, spinlock_t *lock);
 297 void clk_unregister_gate(struct clk *clk);
 298
 299 struct clk_div_table {
 300         unsigned int    val;
 301         unsigned int    div;
 302 };
 303
 304 /**
 305  * struct clk_divider - adjustable divider clock
 306  *
 307  * @hw:         handle between common and hardware-specific interfaces
 308  * @reg:        register containing the divider
 309  * @shift:      shift to the divider bit field
 310  * @width:      width of the divider bit field
 311  * @table:      array of value/divider pairs, last entry should have div = 0
 312  * @lock:       register lock
 313  *
 314  * Clock with an adjustable divider affecting its output frequency.  Implements
 315  * .recalc_rate, .set_rate and .round_rate
 316  *
 317  * Flags:
 318  * CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the
 319  *      register plus one.  If CLK_DIVIDER_ONE_BASED is set then the divider is
 320  *      the raw value read from the register, with the value of zero considered
 321  *      invalid, unless CLK_DIVIDER_ALLOW_ZERO is set.
 322  * CLK_DIVIDER_POWER_OF_TWO - clock divisor is 2 raised to the value read from
 323  *      the hardware register
 324  * CLK_DIVIDER_ALLOW_ZERO - Allow zero divisors.  For dividers which have
 325  *      CLK_DIVIDER_ONE_BASED set, it is possible to end up with a zero divisor.
 326  *      Some hardware implementations gracefully handle this case and allow a
 327  *      zero divisor by not modifying their input clock
 328  *      (divide by one / bypass).
 329  * CLK_DIVIDER_HIWORD_MASK - The divider settings are only in lower 16-bit
 330  *      of this register, and mask of divider bits are in higher 16-bit of this
 331  *      register.  While setting the divider bits, higher 16-bit should also be
 332  *      updated to indicate changing divider bits.
 333  * CLK_DIVIDER_ROUND_CLOSEST - Makes the best calculated divider to be rounded
 334  *      to the closest integer instead of the up one.
 335  * CLK_DIVIDER_READ_ONLY - The divider settings are preconfigured and should
 336  *      not be changed by the clock framework.
 337  */
 338 struct clk_divider {
 339         struct clk_hw   hw;
 340         void __iomem    *reg;
 341         u8              shift;
 342         u8              width;
 343         u8              flags;
 344         const struct clk_div_table      *table;
 345         spinlock_t      *lock;
 346 };
 347
 348 #define CLK_DIVIDER_ONE_BASED           BIT(0)
 349 #define CLK_DIVIDER_POWER_OF_TWO        BIT(1)
 350 #define CLK_DIVIDER_ALLOW_ZERO          BIT(2)
 351 #define CLK_DIVIDER_HIWORD_MASK         BIT(3)
 352 #define CLK_DIVIDER_ROUND_CLOSEST       BIT(4)
 353 #define CLK_DIVIDER_READ_ONLY           BIT(5)
 354
 355 extern const struct clk_ops clk_divider_ops;
 356
 357 unsigned long divider_recalc_rate(struct clk_hw *hw, unsigned long parent_rate,
 358                 unsigned int val, const struct clk_div_table *table,
 359                 unsigned long flags);
 360 long divider_round_rate(struct clk_hw *hw, unsigned long rate,
 361                 unsigned long *prate, const struct clk_div_table *table,
 362                 u8 width, unsigned long flags);
 363 int divider_get_val(unsigned long rate, unsigned long parent_rate,
 364                 const struct clk_div_table *table, u8 width,
 365                 unsigned long flags);
 366
 367 struct clk *clk_register_divider(struct device *dev, const char *name,
 368                 const char *parent_name, unsigned long flags,
 369                 void __iomem *reg, u8 shift, u8 width,
 370                 u8 clk_divider_flags, spinlock_t *lock);
 371 struct clk *clk_register_divider_table(struct device *dev, const char *name,
 372                 const char *parent_name, unsigned long flags,
 373                 void __iomem *reg, u8 shift, u8 width,
 374                 u8 clk_divider_flags, const struct clk_div_table *table,
 375                 spinlock_t *lock);
 376 void clk_unregister_divider(struct clk *clk);
 377
 378 /**
 379  * struct clk_mux - multiplexer clock
 380  *
 381  * @hw:         handle between common and hardware-specific interfaces
 382  * @reg:        register controlling multiplexer
 383  * @shift:      shift to multiplexer bit field
 384  * @width:      width of mutliplexer bit field
 385  * @flags:      hardware-specific flags
 386  * @lock:       register lock
 387  *
 388  * Clock with multiple selectable parents.  Implements .get_parent, .set_parent
 389  * and .recalc_rate
 390  *
 391  * Flags:
 392  * CLK_MUX_INDEX_ONE - register index starts at 1, not 0
 393  * CLK_MUX_INDEX_BIT - register index is a single bit (power of two)
 394  * CLK_MUX_HIWORD_MASK - The mux settings are only in lower 16-bit of this
 395  *      register, and mask of mux bits are in higher 16-bit of this register.
 396  *      While setting the mux bits, higher 16-bit should also be updated to
 397  *      indicate changing mux bits.
 398  * CLK_MUX_ROUND_CLOSEST - Use the parent rate that is closest to the desired
 399  *      frequency.
 400  */
 401 struct clk_mux {
 402         struct clk_hw   hw;
 403         void __iomem    *reg;
 404         u32             *table;
 405         u32             mask;
 406         u8              shift;
 407         u8              flags;
 408         spinlock_t      *lock;
 409 };
 410
 411 #define CLK_MUX_INDEX_ONE               BIT(0)
 412 #define CLK_MUX_INDEX_BIT               BIT(1)
 413 #define CLK_MUX_HIWORD_MASK             BIT(2)
 414 #define CLK_MUX_READ_ONLY               BIT(3) /* mux can't be changed */
 415 #define CLK_MUX_ROUND_CLOSEST           BIT(4)
 416
 417 extern const struct clk_ops clk_mux_ops;
 418 extern const struct clk_ops clk_mux_ro_ops;
 419
 420 struct clk *clk_register_mux(struct device *dev, const char *name,
 421                 const char **parent_names, u8 num_parents, unsigned long flags,
 422                 void __iomem *reg, u8 shift, u8 width,
 423                 u8 clk_mux_flags, spinlock_t *lock);
 424
 425 struct clk *clk_register_mux_table(struct device *dev, const char *name,
 426                 const char **parent_names, u8 num_parents, unsigned long flags,
 427                 void __iomem *reg, u8 shift, u32 mask,
 428                 u8 clk_mux_flags, u32 *table, spinlock_t *lock);
 429
 430 void clk_unregister_mux(struct clk *clk);
 431
 432 void of_fixed_factor_clk_setup(struct device_node *node);
 433
 434 /**
 435  * struct clk_fixed_factor - fixed multiplier and divider clock
 436  *
 437  * @hw:         handle between common and hardware-specific interfaces
 438  * @mult:       multiplier
 439  * @div:        divider
 440  *
 441  * Clock with a fixed multiplier and divider. The output frequency is the
 442  * parent clock rate divided by div and multiplied by mult.
 443  * Implements .recalc_rate, .set_rate and .round_rate
 444  */
 445
 446 struct clk_fixed_factor {
 447         struct clk_hw   hw;
 448         unsigned int    mult;
 449         unsigned int    div;
 450 };
 451
 452 extern struct clk_ops clk_fixed_factor_ops;
 453 struct clk *clk_register_fixed_factor(struct device *dev, const char *name,
 454                 const char *parent_name, unsigned long flags,
 455                 unsigned int mult, unsigned int div);
 456
 457 /**
 458  * struct clk_fractional_divider - adjustable fractional divider clock
 459  *
 460  * @hw:         handle between common and hardware-specific interfaces
 461  * @reg:        register containing the divider
 462  * @mshift:     shift to the numerator bit field
 463  * @mwidth:     width of the numerator bit field
 464  * @nshift:     shift to the denominator bit field
 465  * @nwidth:     width of the denominator bit field
 466  * @lock:       register lock
 467  *
 468  * Clock with adjustable fractional divider affecting its output frequency.
 469  */
 470
 471 struct clk_fractional_divider {
 472         struct clk_hw   hw;
 473         void __iomem    *reg;
 474         u8              mshift;
 475         u32             mmask;
 476         u8              nshift;
 477         u32             nmask;
 478         u8              flags;
 479         spinlock_t      *lock;
 480 };
 481
 482 extern const struct clk_ops clk_fractional_divider_ops;
 483 struct clk *clk_register_fractional_divider(struct device *dev,
 484                 const char *name, const char *parent_name, unsigned long flags,
 485                 void __iomem *reg, u8 mshift, u8 mwidth, u8 nshift, u8 nwidth,
 486                 u8 clk_divider_flags, spinlock_t *lock);
 487
 488 /***
 489  * struct clk_composite - aggregate clock of mux, divider and gate clocks
 490  *
 491  * @hw:         handle between common and hardware-specific interfaces
 492  * @mux_hw:     handle between composite and hardware-specific mux clock
 493  * @rate_hw:    handle between composite and hardware-specific rate clock
 494  * @gate_hw:    handle between composite and hardware-specific gate clock
 495  * @mux_ops:    clock ops for mux
 496  * @rate_ops:   clock ops for rate
 497  * @gate_ops:   clock ops for gate
 498  */
 499 struct clk_composite {
 500         struct clk_hw   hw;
 501         struct clk_ops  ops;
 502
 503         struct clk_hw   *mux_hw;
 504         struct clk_hw   *rate_hw;
 505         struct clk_hw   *gate_hw;
 506
 507         const struct clk_ops    *mux_ops;
 508         const struct clk_ops    *rate_ops;
 509         const struct clk_ops    *gate_ops;
 510 };
 511
 512 struct clk *clk_register_composite(struct device *dev, const char *name,
 513                 const char **parent_names, int num_parents,
 514                 struct clk_hw *mux_hw, const struct clk_ops *mux_ops,
 515                 struct clk_hw *rate_hw, const struct clk_ops *rate_ops,
 516                 struct clk_hw *gate_hw, const struct clk_ops *gate_ops,
 517                 unsigned long flags);
 518
 519 /***
 520  * struct clk_gpio_gate - gpio gated clock
 521  *
 522  * @hw:         handle between common and hardware-specific interfaces
 523  * @gpiod:      gpio descriptor
 524  *
 525  * Clock with a gpio control for enabling and disabling the parent clock.
 526  * Implements .enable, .disable and .is_enabled
 527  */
 528
 529 struct clk_gpio {
 530         struct clk_hw   hw;
 531         struct gpio_desc *gpiod;
 532 };
 533
 534 extern const struct clk_ops clk_gpio_gate_ops;
 535 struct clk *clk_register_gpio_gate(struct device *dev, const char *name,
 536                 const char *parent_name, struct gpio_desc *gpio,
 537                 unsigned long flags);
 538
 539 void of_gpio_clk_gate_setup(struct device_node *node);
 540
 541 /**
 542  * clk_register - allocate a new clock, register it and return an opaque cookie
 543  * @dev: device that is registering this clock
 544  * @hw: link to hardware-specific clock data
 545  *
 546  * clk_register is the primary interface for populating the clock tree with new
 547  * clock nodes.  It returns a pointer to the newly allocated struct clk which
 548  * cannot be dereferenced by driver code but may be used in conjuction with the
 549  * rest of the clock API.  In the event of an error clk_register will return an
 550  * error code; drivers must test for an error code after calling clk_register.
 551  */
 552 struct clk *clk_register(struct device *dev, struct clk_hw *hw);
 553 struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw);
 554
 555 void clk_unregister(struct clk *clk);
 556 void devm_clk_unregister(struct device *dev, struct clk *clk);
 557
 558 /* helper functions */
 559 const char *__clk_get_name(struct clk *clk);
 560 struct clk_hw *__clk_get_hw(struct clk *clk);
 561 u8 __clk_get_num_parents(struct clk *clk);
 562 struct clk *__clk_get_parent(struct clk *clk);
 563 struct clk *clk_get_parent_by_index(struct clk *clk, u8 index);
 564 unsigned int __clk_get_enable_count(struct clk *clk);
 565 unsigned long __clk_get_rate(struct clk *clk);
 566 unsigned long __clk_get_flags(struct clk *clk);
 567 bool __clk_is_prepared(struct clk *clk);
 568 bool __clk_is_enabled(struct clk *clk);
 569 struct clk *__clk_lookup(const char *name);
 570 long __clk_mux_determine_rate(struct clk_hw *hw, unsigned long rate,
 571                               unsigned long *best_parent_rate,
 572                               struct clk_hw **best_parent_p);
 573 long __clk_mux_determine_rate_closest(struct clk_hw *hw, unsigned long rate,
 574                               unsigned long *best_parent_rate,
 575                               struct clk_hw **best_parent_p);
 576
 577 /*
 578  * FIXME clock api without lock protection
 579  */
 580 int __clk_prepare(struct clk *clk);
 581 void __clk_unprepare(struct clk *clk);
 582 void __clk_reparent(struct clk *clk, struct clk *new_parent);
 583 unsigned long __clk_round_rate(struct clk *clk, unsigned long rate);
 584
 585 struct of_device_id;
 586
 587 typedef void (*of_clk_init_cb_t)(struct device_node *);
 588
 589 struct clk_onecell_data {
 590         struct clk **clks;
 591         unsigned int clk_num;
 592 };
 593
 594 extern struct of_device_id __clk_of_table;
 595
 596 #define CLK_OF_DECLARE(name, compat, fn) OF_DECLARE_1(clk, name, compat, fn)
 597
 598 #ifdef CONFIG_OF
 599 int of_clk_add_provider(struct device_node *np,
 600                         struct clk *(*clk_src_get)(struct of_phandle_args *args,
 601                                                    void *data),
 602                         void *data);
 603 void of_clk_del_provider(struct device_node *np);
 604 struct clk *of_clk_src_simple_get(struct of_phandle_args *clkspec,
 605                                   void *data);
 606 struct clk *of_clk_src_onecell_get(struct of_phandle_args *clkspec, void *data);
 607 int of_clk_get_parent_count(struct device_node *np);
 608 const char *of_clk_get_parent_name(struct device_node *np, int index);
 609
 610 void of_clk_init(const struct of_device_id *matches);
 611
 612 #else /* !CONFIG_OF */
 613
 614 static inline int of_clk_add_provider(struct device_node *np,
 615                         struct clk *(*clk_src_get)(struct of_phandle_args *args,
 616                                                    void *data),
 617                         void *data)
 618 {
 619         return 0;
 620 }
 621 #define of_clk_del_provider(np) \
 622         { while (0); }
 623 static inline struct clk *of_clk_src_simple_get(
 624         struct of_phandle_args *clkspec, void *data)
 625 {
 626         return ERR_PTR(-ENOENT);
 627 }
 628 static inline struct clk *of_clk_src_onecell_get(
 629         struct of_phandle_args *clkspec, void *data)
 630 {
 631         return ERR_PTR(-ENOENT);
 632 }
 633 static inline const char *of_clk_get_parent_name(struct device_node *np,
 634                                                  int index)
 635 {
 636         return NULL;
 637 }
 638 #define of_clk_init(matches) \
 639         { while (0); }
 640 #endif /* CONFIG_OF */
 641
 642 /*
 643  * wrap access to peripherals in accessor routines
 644  * for improved portability across platforms
 645  */
 646
 647 #if IS_ENABLED(CONFIG_PPC)
 648
 649 static inline u32 clk_readl(u32 __iomem *reg)
 650 {
 651         return ioread32be(reg);
 652 }
 653
 654 static inline void clk_writel(u32 val, u32 __iomem *reg)
 655 {
 656         iowrite32be(val, reg);
 657 }
 658
 659 #else   /* platform dependent I/O accessors */
 660
 661 static inline u32 clk_readl(u32 __iomem *reg)
 662 {
 663         return readl(reg);
 664 }
 665
 666 static inline void clk_writel(u32 val, u32 __iomem *reg)
 667 {
 668         writel(val, reg);
 669 }
 670
 671 #endif  /* platform dependent I/O accessors */
 672
 673 #ifdef CONFIG_DEBUG_FS
 674 struct dentry *clk_debugfs_add_file(struct clk_hw *hw, char *name, umode_t mode,
 675                                 void *data, const struct file_operations *fops);
 676 #endif
 677
 678 #endif /* CONFIG_COMMON_CLK */
 679 #endif /* CLK_PROVIDER_H */