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/io.h>
  15 #include <linux/of.h>
  16
  17 #ifdef CONFIG_COMMON_CLK
  18
  19 /*
  20  * flags used across common struct clk.  these flags should only affect the
  21  * top-level framework.  custom flags for dealing with hardware specifics
  22  * belong in struct clk_foo
  23  *
  24  * Please update clk_flags[] in drivers/clk/clk.c when making changes here!
  25  */
  26 #define CLK_SET_RATE_GATE       BIT(0) /* must be gated across rate change */
  27 #define CLK_SET_PARENT_GATE     BIT(1) /* must be gated across re-parent */
  28 #define CLK_SET_RATE_PARENT     BIT(2) /* propagate rate change up one level */
  29 #define CLK_IGNORE_UNUSED       BIT(3) /* do not gate even if unused */
  30                                 /* unused */
  31 #define CLK_IS_BASIC            BIT(5) /* Basic clk, can't do a to_clk_foo() */
  32 #define CLK_GET_RATE_NOCACHE    BIT(6) /* do not use the cached clk rate */
  33 #define CLK_SET_RATE_NO_REPARENT BIT(7) /* don't re-parent on rate change */
  34 #define CLK_GET_ACCURACY_NOCACHE BIT(8) /* do not use the cached clk accuracy */
  35 #define CLK_RECALC_NEW_RATES    BIT(9) /* recalc rates after notifications */
  36 #define CLK_SET_RATE_UNGATE     BIT(10) /* clock needs to run to set rate */
  37 #define CLK_IS_CRITICAL         BIT(11) /* do not gate, ever */
  38 /* parents need enable during gate/ungate, set rate and re-parent */
  39 #define CLK_OPS_PARENT_ENABLE   BIT(12)
  40
  41 struct clk;
  42 struct clk_hw;
  43 struct clk_core;
  44 struct dentry;
  45
  46 /**
  47  * struct clk_rate_request - Structure encoding the clk constraints that
  48  * a clock user might require.
  49  *
  50  * @rate:               Requested clock rate. This field will be adjusted by
  51  *                      clock drivers according to hardware capabilities.
  52  * @min_rate:           Minimum rate imposed by clk users.
  53  * @max_rate:           Maximum rate imposed by clk users.
  54  * @best_parent_rate:   The best parent rate a parent can provide to fulfill the
  55  *                      requested constraints.
  56  * @best_parent_hw:     The most appropriate parent clock that fulfills the
  57  *                      requested constraints.
  58  *
  59  */
  60 struct clk_rate_request {
  61         unsigned long rate;
  62         unsigned long min_rate;
  63         unsigned long max_rate;
  64         unsigned long best_parent_rate;
  65         struct clk_hw *best_parent_hw;
  66 };
  67
  68 /**
  69  * struct clk_ops -  Callback operations for hardware clocks; these are to
  70  * be provided by the clock implementation, and will be called by drivers
  71  * through the clk_* api.
  72  *
  73  * @prepare:    Prepare the clock for enabling. This must not return until
  74  *              the clock is fully prepared, and it's safe to call clk_enable.
  75  *              This callback is intended to allow clock implementations to
  76  *              do any initialisation that may sleep. Called with
  77  *              prepare_lock held.
  78  *
  79  * @unprepare:  Release the clock from its prepared state. This will typically
  80  *              undo any work done in the @prepare callback. Called with
  81  *              prepare_lock held.
  82  *
  83  * @is_prepared: Queries the hardware to determine if the clock is prepared.
  84  *              This function is allowed to sleep. Optional, if this op is not
  85  *              set then the prepare count will be used.
  86  *
  87  * @unprepare_unused: Unprepare the clock atomically.  Only called from
  88  *              clk_disable_unused for prepare clocks with special needs.
  89  *              Called with prepare mutex held. This function may sleep.
  90  *
  91  * @enable:     Enable the clock atomically. This must not return until the
  92  *              clock is generating a valid clock signal, usable by consumer
  93  *              devices. Called with enable_lock held. This function must not
  94  *              sleep.
  95  *
  96  * @disable:    Disable the clock atomically. Called with enable_lock held.
  97  *              This function must not sleep.
  98  *
  99  * @is_enabled: Queries the hardware to determine if the clock is enabled.
 100  *              This function must not sleep. Optional, if this op is not
 101  *              set then the enable count will be used.
 102  *
 103  * @disable_unused: Disable the clock atomically.  Only called from
 104  *              clk_disable_unused for gate clocks with special needs.
 105  *              Called with enable_lock held.  This function must not
 106  *              sleep.
 107  *
 108  * @recalc_rate Recalculate the rate of this clock, by querying hardware. The
 109  *              parent rate is an input parameter.  It is up to the caller to
 110  *              ensure that the prepare_mutex is held across this call.
 111  *              Returns the calculated rate.  Optional, but recommended - if
 112  *              this op is not set then clock rate will be initialized to 0.
 113  *
 114  * @round_rate: Given a target rate as input, returns the closest rate actually
 115  *              supported by the clock. The parent rate is an input/output
 116  *              parameter.
 117  *
 118  * @determine_rate: Given a target rate as input, returns the closest rate
 119  *              actually supported by the clock, and optionally the parent clock
 120  *              that should be used to provide the clock rate.
 121  *
 122  * @set_parent: Change the input source of this clock; for clocks with multiple
 123  *              possible parents specify a new parent by passing in the index
 124  *              as a u8 corresponding to the parent in either the .parent_names
 125  *              or .parents arrays.  This function in affect translates an
 126  *              array index into the value programmed into the hardware.
 127  *              Returns 0 on success, -EERROR otherwise.
 128  *
 129  * @get_parent: Queries the hardware to determine the parent of a clock.  The
 130  *              return value is a u8 which specifies the index corresponding to
 131  *              the parent clock.  This index can be applied to either the
 132  *              .parent_names or .parents arrays.  In short, this function
 133  *              translates the parent value read from hardware into an array
 134  *              index.  Currently only called when the clock is initialized by
 135  *              __clk_init.  This callback is mandatory for clocks with
 136  *              multiple parents.  It is optional (and unnecessary) for clocks
 137  *              with 0 or 1 parents.
 138  *
 139  * @set_rate:   Change the rate of this clock. The requested rate is specified
 140  *              by the second argument, which should typically be the return
 141  *              of .round_rate call.  The third argument gives the parent rate
 142  *              which is likely helpful for most .set_rate implementation.
 143  *              Returns 0 on success, -EERROR otherwise.
 144  *
 145  * @set_rate_and_parent: Change the rate and the parent of this clock. The
 146  *              requested rate is specified by the second argument, which
 147  *              should typically be the return of .round_rate call.  The
 148  *              third argument gives the parent rate which is likely helpful
 149  *              for most .set_rate_and_parent implementation. The fourth
 150  *              argument gives the parent index. This callback is optional (and
 151  *              unnecessary) for clocks with 0 or 1 parents as well as
 152  *              for clocks that can tolerate switching the rate and the parent
 153  *              separately via calls to .set_parent and .set_rate.
 154  *              Returns 0 on success, -EERROR otherwise.
 155  *
 156  * @recalc_accuracy: Recalculate the accuracy of this clock. The clock accuracy
 157  *              is expressed in ppb (parts per billion). The parent accuracy is
 158  *              an input parameter.
 159  *              Returns the calculated accuracy.  Optional - if this op is not
 160  *              set then clock accuracy will be initialized to parent accuracy
 161  *              or 0 (perfect clock) if clock has no parent.
 162  *
 163  * @get_phase:  Queries the hardware to get the current phase of a clock.
 164  *              Returned values are 0-359 degrees on success, negative
 165  *              error codes on failure.
 166  *
 167  * @set_phase:  Shift the phase this clock signal in degrees specified
 168  *              by the second argument. Valid values for degrees are
 169  *              0-359. Return 0 on success, otherwise -EERROR.
 170  *
 171  * @init:       Perform platform-specific initialization magic.
 172  *              This is not not used by any of the basic clock types.
 173  *              Please consider other ways of solving initialization problems
 174  *              before using this callback, as its use is discouraged.
 175  *
 176  * @debug_init: Set up type-specific debugfs entries for this clock.  This
 177  *              is called once, after the debugfs directory entry for this
 178  *              clock has been created.  The dentry pointer representing that
 179  *              directory is provided as an argument.  Called with
 180  *              prepare_lock held.  Returns 0 on success, -EERROR otherwise.
 181  *
 182  *
 183  * The clk_enable/clk_disable and clk_prepare/clk_unprepare pairs allow
 184  * implementations to split any work between atomic (enable) and sleepable
 185  * (prepare) contexts.  If enabling a clock requires code that might sleep,
 186  * this must be done in clk_prepare.  Clock enable code that will never be
 187  * called in a sleepable context may be implemented in clk_enable.
 188  *
 189  * Typically, drivers will call clk_prepare when a clock may be needed later
 190  * (eg. when a device is opened), and clk_enable when the clock is actually
 191  * required (eg. from an interrupt). Note that clk_prepare MUST have been
 192  * called before clk_enable.
 193  */
 194 struct clk_ops {
 195         int             (*prepare)(struct clk_hw *hw);
 196         void            (*unprepare)(struct clk_hw *hw);
 197         int             (*is_prepared)(struct clk_hw *hw);
 198         void            (*unprepare_unused)(struct clk_hw *hw);
 199         int             (*enable)(struct clk_hw *hw);
 200         void            (*disable)(struct clk_hw *hw);
 201         int             (*is_enabled)(struct clk_hw *hw);
 202         void            (*disable_unused)(struct clk_hw *hw);
 203         unsigned long   (*recalc_rate)(struct clk_hw *hw,
 204                                         unsigned long parent_rate);
 205         long            (*round_rate)(struct clk_hw *hw, unsigned long rate,
 206                                         unsigned long *parent_rate);
 207         int             (*determine_rate)(struct clk_hw *hw,
 208                                           struct clk_rate_request *req);
 209         int             (*set_parent)(struct clk_hw *hw, u8 index);
 210         u8              (*get_parent)(struct clk_hw *hw);
 211         int             (*set_rate)(struct clk_hw *hw, unsigned long rate,
 212                                     unsigned long parent_rate);
 213         int             (*set_rate_and_parent)(struct clk_hw *hw,
 214                                     unsigned long rate,
 215                                     unsigned long parent_rate, u8 index);
 216         unsigned long   (*recalc_accuracy)(struct clk_hw *hw,
 217                                            unsigned long parent_accuracy);
 218         int             (*get_phase)(struct clk_hw *hw);
 219         int             (*set_phase)(struct clk_hw *hw, int degrees);
 220         void            (*init)(struct clk_hw *hw);
 221         int             (*debug_init)(struct clk_hw *hw, struct dentry *dentry);
 222 };
 223
 224 /**
 225  * struct clk_init_data - holds init data that's common to all clocks and is
 226  * shared between the clock provider and the common clock framework.
 227  *
 228  * @name: clock name
 229  * @ops: operations this clock supports
 230  * @parent_names: array of string names for all possible parents
 231  * @num_parents: number of possible parents
 232  * @flags: framework-level hints and quirks
 233  */
 234 struct clk_init_data {
 235         const char              *name;
 236         const struct clk_ops    *ops;
 237         const char              * const *parent_names;
 238         u8                      num_parents;
 239         unsigned long           flags;
 240 };
 241
 242 /**
 243  * struct clk_hw - handle for traversing from a struct clk to its corresponding
 244  * hardware-specific structure.  struct clk_hw should be declared within struct
 245  * clk_foo and then referenced by the struct clk instance that uses struct
 246  * clk_foo's clk_ops
 247  *
 248  * @core: pointer to the struct clk_core instance that points back to this
 249  * struct clk_hw instance
 250  *
 251  * @clk: pointer to the per-user struct clk instance that can be used to call
 252  * into the clk API
 253  *
 254  * @init: pointer to struct clk_init_data that contains the init data shared
 255  * with the common clock framework.
 256  */
 257 struct clk_hw {
 258         struct clk_core *core;
 259         struct clk *clk;
 260         const struct clk_init_data *init;
 261 };
 262
 263 /*
 264  * DOC: Basic clock implementations common to many platforms
 265  *
 266  * Each basic clock hardware type is comprised of a structure describing the
 267  * clock hardware, implementations of the relevant callbacks in struct clk_ops,
 268  * unique flags for that hardware type, a registration function and an
 269  * alternative macro for static initialization
 270  */
 271
 272 /**
 273  * struct clk_fixed_rate - fixed-rate clock
 274  * @hw:         handle between common and hardware-specific interfaces
 275  * @fixed_rate: constant frequency of clock
 276  */
 277 struct clk_fixed_rate {
 278         struct          clk_hw hw;
 279         unsigned long   fixed_rate;
 280         unsigned long   fixed_accuracy;
 281         u8              flags;
 282 };
 283
 284 #define to_clk_fixed_rate(_hw) container_of(_hw, struct clk_fixed_rate, hw)
 285
 286 extern const struct clk_ops clk_fixed_rate_ops;
 287 struct clk *clk_register_fixed_rate(struct device *dev, const char *name,
 288                 const char *parent_name, unsigned long flags,
 289                 unsigned long fixed_rate);
 290 struct clk_hw *clk_hw_register_fixed_rate(struct device *dev, const char *name,
 291                 const char *parent_name, unsigned long flags,
 292                 unsigned long fixed_rate);
 293 struct clk *clk_register_fixed_rate_with_accuracy(struct device *dev,
 294                 const char *name, const char *parent_name, unsigned long flags,
 295                 unsigned long fixed_rate, unsigned long fixed_accuracy);
 296 void clk_unregister_fixed_rate(struct clk *clk);
 297 struct clk_hw *clk_hw_register_fixed_rate_with_accuracy(struct device *dev,
 298                 const char *name, const char *parent_name, unsigned long flags,
 299                 unsigned long fixed_rate, unsigned long fixed_accuracy);
 300 void clk_hw_unregister_fixed_rate(struct clk_hw *hw);
 301
 302 void of_fixed_clk_setup(struct device_node *np);
 303
 304 /**
 305  * struct clk_gate - gating clock
 306  *
 307  * @hw:         handle between common and hardware-specific interfaces
 308  * @reg:        register controlling gate
 309  * @bit_idx:    single bit controlling gate
 310  * @flags:      hardware-specific flags
 311  * @lock:       register lock
 312  *
 313  * Clock which can gate its output.  Implements .enable & .disable
 314  *
 315  * Flags:
 316  * CLK_GATE_SET_TO_DISABLE - by default this clock sets the bit at bit_idx to
 317  *      enable the clock.  Setting this flag does the opposite: setting the bit
 318  *      disable the clock and clearing it enables the clock
 319  * CLK_GATE_HIWORD_MASK - The gate settings are only in lower 16-bit
 320  *      of this register, and mask of gate bits are in higher 16-bit of this
 321  *      register.  While setting the gate bits, higher 16-bit should also be
 322  *      updated to indicate changing gate bits.
 323  */
 324 struct clk_gate {
 325         struct clk_hw hw;
 326         void __iomem    *reg;
 327         u8              bit_idx;
 328         u8              flags;
 329         spinlock_t      *lock;
 330 };
 331
 332 #define to_clk_gate(_hw) container_of(_hw, struct clk_gate, hw)
 333
 334 #define CLK_GATE_SET_TO_DISABLE         BIT(0)
 335 #define CLK_GATE_HIWORD_MASK            BIT(1)
 336
 337 extern const struct clk_ops clk_gate_ops;
 338 struct clk *clk_register_gate(struct device *dev, const char *name,
 339                 const char *parent_name, unsigned long flags,
 340                 void __iomem *reg, u8 bit_idx,
 341                 u8 clk_gate_flags, spinlock_t *lock);
 342 struct clk_hw *clk_hw_register_gate(struct device *dev, const char *name,
 343                 const char *parent_name, unsigned long flags,
 344                 void __iomem *reg, u8 bit_idx,
 345                 u8 clk_gate_flags, spinlock_t *lock);
 346 void clk_unregister_gate(struct clk *clk);
 347 void clk_hw_unregister_gate(struct clk_hw *hw);
 348 int clk_gate_is_enabled(struct clk_hw *hw);
 349
 350 struct clk_div_table {
 351         unsigned int    val;
 352         unsigned int    div;
 353 };
 354
 355 /**
 356  * struct clk_divider - adjustable divider clock
 357  *
 358  * @hw:         handle between common and hardware-specific interfaces
 359  * @reg:        register containing the divider
 360  * @shift:      shift to the divider bit field
 361  * @width:      width of the divider bit field
 362  * @table:      array of value/divider pairs, last entry should have div = 0
 363  * @lock:       register lock
 364  *
 365  * Clock with an adjustable divider affecting its output frequency.  Implements
 366  * .recalc_rate, .set_rate and .round_rate
 367  *
 368  * Flags:
 369  * CLK_DIVIDER_ONE_BASED - by default the divisor is the value read from the
 370  *      register plus one.  If CLK_DIVIDER_ONE_BASED is set then the divider is
 371  *      the raw value read from the register, with the value of zero considered
 372  *      invalid, unless CLK_DIVIDER_ALLOW_ZERO is set.
 373  * CLK_DIVIDER_POWER_OF_TWO - clock divisor is 2 raised to the value read from
 374  *      the hardware register
 375  * CLK_DIVIDER_ALLOW_ZERO - Allow zero divisors.  For dividers which have
 376  *      CLK_DIVIDER_ONE_BASED set, it is possible to end up with a zero divisor.
 377  *      Some hardware implementations gracefully handle this case and allow a
 378  *      zero divisor by not modifying their input clock
 379  *      (divide by one / bypass).
 380  * CLK_DIVIDER_HIWORD_MASK - The divider settings are only in lower 16-bit
 381  *      of this register, and mask of divider bits are in higher 16-bit of this
 382  *      register.  While setting the divider bits, higher 16-bit should also be
 383  *      updated to indicate changing divider bits.
 384  * CLK_DIVIDER_ROUND_CLOSEST - Makes the best calculated divider to be rounded
 385  *      to the closest integer instead of the up one.
 386  * CLK_DIVIDER_READ_ONLY - The divider settings are preconfigured and should
 387  *      not be changed by the clock framework.
 388  * CLK_DIVIDER_MAX_AT_ZERO - For dividers which are like CLK_DIVIDER_ONE_BASED
 389  *      except when the value read from the register is zero, the divisor is
 390  *      2^width of the field.
 391  */
 392 struct clk_divider {
 393         struct clk_hw   hw;
 394         void __iomem    *reg;
 395         u8              shift;
 396         u8              width;
 397         u8              flags;
 398         const struct clk_div_table      *table;
 399         spinlock_t      *lock;
 400 };
 401
 402 #define clk_div_mask(width)     ((1 << (width)) - 1)
 403 #define to_clk_divider(_hw) container_of(_hw, struct clk_divider, hw)
 404
 405 #define CLK_DIVIDER_ONE_BASED           BIT(0)
 406 #define CLK_DIVIDER_POWER_OF_TWO        BIT(1)
 407 #define CLK_DIVIDER_ALLOW_ZERO          BIT(2)
 408 #define CLK_DIVIDER_HIWORD_MASK         BIT(3)
 409 #define CLK_DIVIDER_ROUND_CLOSEST       BIT(4)
 410 #define CLK_DIVIDER_READ_ONLY           BIT(5)
 411 #define CLK_DIVIDER_MAX_AT_ZERO         BIT(6)
 412
 413 extern const struct clk_ops clk_divider_ops;
 414 extern const struct clk_ops clk_divider_ro_ops;
 415
 416 unsigned long divider_recalc_rate(struct clk_hw *hw, unsigned long parent_rate,
 417                 unsigned int val, const struct clk_div_table *table,
 418                 unsigned long flags, unsigned long width);
 419 long divider_round_rate_parent(struct clk_hw *hw, struct clk_hw *parent,
 420                                unsigned long rate, unsigned long *prate,
 421                                const struct clk_div_table *table,
 422                                u8 width, unsigned long flags);
 423 long divider_ro_round_rate_parent(struct clk_hw *hw, struct clk_hw *parent,
 424                                   unsigned long rate, unsigned long *prate,
 425                                   const struct clk_div_table *table, u8 width,
 426                                   unsigned long flags, unsigned int val);
 427 int divider_get_val(unsigned long rate, unsigned long parent_rate,
 428                 const struct clk_div_table *table, u8 width,
 429                 unsigned long flags);
 430
 431 struct clk *clk_register_divider(struct device *dev, const char *name,
 432                 const char *parent_name, unsigned long flags,
 433                 void __iomem *reg, u8 shift, u8 width,
 434                 u8 clk_divider_flags, spinlock_t *lock);
 435 struct clk_hw *clk_hw_register_divider(struct device *dev, const char *name,
 436                 const char *parent_name, unsigned long flags,
 437                 void __iomem *reg, u8 shift, u8 width,
 438                 u8 clk_divider_flags, spinlock_t *lock);
 439 struct clk *clk_register_divider_table(struct device *dev, const char *name,
 440                 const char *parent_name, unsigned long flags,
 441                 void __iomem *reg, u8 shift, u8 width,
 442                 u8 clk_divider_flags, const struct clk_div_table *table,
 443                 spinlock_t *lock);
 444 struct clk_hw *clk_hw_register_divider_table(struct device *dev,
 445                 const char *name, const char *parent_name, unsigned long flags,
 446                 void __iomem *reg, u8 shift, u8 width,
 447                 u8 clk_divider_flags, const struct clk_div_table *table,
 448                 spinlock_t *lock);
 449 void clk_unregister_divider(struct clk *clk);
 450 void clk_hw_unregister_divider(struct clk_hw *hw);
 451
 452 /**
 453  * struct clk_mux - multiplexer clock
 454  *
 455  * @hw:         handle between common and hardware-specific interfaces
 456  * @reg:        register controlling multiplexer
 457  * @table:      array of register values corresponding to the parent index
 458  * @shift:      shift to multiplexer bit field
 459  * @mask:       mask of mutliplexer bit field
 460  * @flags:      hardware-specific flags
 461  * @lock:       register lock
 462  *
 463  * Clock with multiple selectable parents.  Implements .get_parent, .set_parent
 464  * and .recalc_rate
 465  *
 466  * Flags:
 467  * CLK_MUX_INDEX_ONE - register index starts at 1, not 0
 468  * CLK_MUX_INDEX_BIT - register index is a single bit (power of two)
 469  * CLK_MUX_HIWORD_MASK - The mux settings are only in lower 16-bit of this
 470  *      register, and mask of mux bits are in higher 16-bit of this register.
 471  *      While setting the mux bits, higher 16-bit should also be updated to
 472  *      indicate changing mux bits.
 473  * CLK_MUX_ROUND_CLOSEST - Use the parent rate that is closest to the desired
 474  *      frequency.
 475  */
 476 struct clk_mux {
 477         struct clk_hw   hw;
 478         void __iomem    *reg;
 479         u32             *table;
 480         u32             mask;
 481         u8              shift;
 482         u8              flags;
 483         spinlock_t      *lock;
 484 };
 485
 486 #define to_clk_mux(_hw) container_of(_hw, struct clk_mux, hw)
 487
 488 #define CLK_MUX_INDEX_ONE               BIT(0)
 489 #define CLK_MUX_INDEX_BIT               BIT(1)
 490 #define CLK_MUX_HIWORD_MASK             BIT(2)
 491 #define CLK_MUX_READ_ONLY               BIT(3) /* mux can't be changed */
 492 #define CLK_MUX_ROUND_CLOSEST           BIT(4)
 493
 494 extern const struct clk_ops clk_mux_ops;
 495 extern const struct clk_ops clk_mux_ro_ops;
 496
 497 struct clk *clk_register_mux(struct device *dev, const char *name,
 498                 const char * const *parent_names, u8 num_parents,
 499                 unsigned long flags,
 500                 void __iomem *reg, u8 shift, u8 width,
 501                 u8 clk_mux_flags, spinlock_t *lock);
 502 struct clk_hw *clk_hw_register_mux(struct device *dev, const char *name,
 503                 const char * const *parent_names, u8 num_parents,
 504                 unsigned long flags,
 505                 void __iomem *reg, u8 shift, u8 width,
 506                 u8 clk_mux_flags, spinlock_t *lock);
 507
 508 struct clk *clk_register_mux_table(struct device *dev, const char *name,
 509                 const char * const *parent_names, u8 num_parents,
 510                 unsigned long flags,
 511                 void __iomem *reg, u8 shift, u32 mask,
 512                 u8 clk_mux_flags, u32 *table, spinlock_t *lock);
 513 struct clk_hw *clk_hw_register_mux_table(struct device *dev, const char *name,
 514                 const char * const *parent_names, u8 num_parents,
 515                 unsigned long flags,
 516                 void __iomem *reg, u8 shift, u32 mask,
 517                 u8 clk_mux_flags, u32 *table, spinlock_t *lock);
 518
 519 int clk_mux_val_to_index(struct clk_hw *hw, u32 *table, unsigned int flags,
 520                          unsigned int val);
 521 unsigned int clk_mux_index_to_val(u32 *table, unsigned int flags, u8 index);
 522
 523 void clk_unregister_mux(struct clk *clk);
 524 void clk_hw_unregister_mux(struct clk_hw *hw);
 525
 526 void of_fixed_factor_clk_setup(struct device_node *node);
 527
 528 /**
 529  * struct clk_fixed_factor - fixed multiplier and divider clock
 530  *
 531  * @hw:         handle between common and hardware-specific interfaces
 532  * @mult:       multiplier
 533  * @div:        divider
 534  *
 535  * Clock with a fixed multiplier and divider. The output frequency is the
 536  * parent clock rate divided by div and multiplied by mult.
 537  * Implements .recalc_rate, .set_rate and .round_rate
 538  */
 539
 540 struct clk_fixed_factor {
 541         struct clk_hw   hw;
 542         unsigned int    mult;
 543         unsigned int    div;
 544 };
 545
 546 #define to_clk_fixed_factor(_hw) container_of(_hw, struct clk_fixed_factor, hw)
 547
 548 extern const struct clk_ops clk_fixed_factor_ops;
 549 struct clk *clk_register_fixed_factor(struct device *dev, const char *name,
 550                 const char *parent_name, unsigned long flags,
 551                 unsigned int mult, unsigned int div);
 552 void clk_unregister_fixed_factor(struct clk *clk);
 553 struct clk_hw *clk_hw_register_fixed_factor(struct device *dev,
 554                 const char *name, const char *parent_name, unsigned long flags,
 555                 unsigned int mult, unsigned int div);
 556 void clk_hw_unregister_fixed_factor(struct clk_hw *hw);
 557
 558 /**
 559  * struct clk_fractional_divider - adjustable fractional divider clock
 560  *
 561  * @hw:         handle between common and hardware-specific interfaces
 562  * @reg:        register containing the divider
 563  * @mshift:     shift to the numerator bit field
 564  * @mwidth:     width of the numerator bit field
 565  * @nshift:     shift to the denominator bit field
 566  * @nwidth:     width of the denominator bit field
 567  * @lock:       register lock
 568  *
 569  * Clock with adjustable fractional divider affecting its output frequency.
 570  */
 571 struct clk_fractional_divider {
 572         struct clk_hw   hw;
 573         void __iomem    *reg;
 574         u8              mshift;
 575         u8              mwidth;
 576         u32             mmask;
 577         u8              nshift;
 578         u8              nwidth;
 579         u32             nmask;
 580         u8              flags;
 581         void            (*approximation)(struct clk_hw *hw,
 582                                 unsigned long rate, unsigned long *parent_rate,
 583                                 unsigned long *m, unsigned long *n);
 584         spinlock_t      *lock;
 585 };
 586
 587 #define to_clk_fd(_hw) container_of(_hw, struct clk_fractional_divider, hw)
 588
 589 extern const struct clk_ops clk_fractional_divider_ops;
 590 struct clk *clk_register_fractional_divider(struct device *dev,
 591                 const char *name, const char *parent_name, unsigned long flags,
 592                 void __iomem *reg, u8 mshift, u8 mwidth, u8 nshift, u8 nwidth,
 593                 u8 clk_divider_flags, spinlock_t *lock);
 594 struct clk_hw *clk_hw_register_fractional_divider(struct device *dev,
 595                 const char *name, const char *parent_name, unsigned long flags,
 596                 void __iomem *reg, u8 mshift, u8 mwidth, u8 nshift, u8 nwidth,
 597                 u8 clk_divider_flags, spinlock_t *lock);
 598 void clk_hw_unregister_fractional_divider(struct clk_hw *hw);
 599
 600 /**
 601  * struct clk_multiplier - adjustable multiplier clock
 602  *
 603  * @hw:         handle between common and hardware-specific interfaces
 604  * @reg:        register containing the multiplier
 605  * @shift:      shift to the multiplier bit field
 606  * @width:      width of the multiplier bit field
 607  * @lock:       register lock
 608  *
 609  * Clock with an adjustable multiplier affecting its output frequency.
 610  * Implements .recalc_rate, .set_rate and .round_rate
 611  *
 612  * Flags:
 613  * CLK_MULTIPLIER_ZERO_BYPASS - By default, the multiplier is the value read
 614  *      from the register, with 0 being a valid value effectively
 615  *      zeroing the output clock rate. If CLK_MULTIPLIER_ZERO_BYPASS is
 616  *      set, then a null multiplier will be considered as a bypass,
 617  *      leaving the parent rate unmodified.
 618  * CLK_MULTIPLIER_ROUND_CLOSEST - Makes the best calculated divider to be
 619  *      rounded to the closest integer instead of the down one.
 620  */
 621 struct clk_multiplier {
 622         struct clk_hw   hw;
 623         void __iomem    *reg;
 624         u8              shift;
 625         u8              width;
 626         u8              flags;
 627         spinlock_t      *lock;
 628 };
 629
 630 #define to_clk_multiplier(_hw) container_of(_hw, struct clk_multiplier, hw)
 631
 632 #define CLK_MULTIPLIER_ZERO_BYPASS              BIT(0)
 633 #define CLK_MULTIPLIER_ROUND_CLOSEST    BIT(1)
 634
 635 extern const struct clk_ops clk_multiplier_ops;
 636
 637 /***
 638  * struct clk_composite - aggregate clock of mux, divider and gate clocks
 639  *
 640  * @hw:         handle between common and hardware-specific interfaces
 641  * @mux_hw:     handle between composite and hardware-specific mux clock
 642  * @rate_hw:    handle between composite and hardware-specific rate clock
 643  * @gate_hw:    handle between composite and hardware-specific gate clock
 644  * @mux_ops:    clock ops for mux
 645  * @rate_ops:   clock ops for rate
 646  * @gate_ops:   clock ops for gate
 647  */
 648 struct clk_composite {
 649         struct clk_hw   hw;
 650         struct clk_ops  ops;
 651
 652         struct clk_hw   *mux_hw;
 653         struct clk_hw   *rate_hw;
 654         struct clk_hw   *gate_hw;
 655
 656         const struct clk_ops    *mux_ops;
 657         const struct clk_ops    *rate_ops;
 658         const struct clk_ops    *gate_ops;
 659 };
 660
 661 #define to_clk_composite(_hw) container_of(_hw, struct clk_composite, hw)
 662
 663 struct clk *clk_register_composite(struct device *dev, const char *name,
 664                 const char * const *parent_names, int num_parents,
 665                 struct clk_hw *mux_hw, const struct clk_ops *mux_ops,
 666                 struct clk_hw *rate_hw, const struct clk_ops *rate_ops,
 667                 struct clk_hw *gate_hw, const struct clk_ops *gate_ops,
 668                 unsigned long flags);
 669 void clk_unregister_composite(struct clk *clk);
 670 struct clk_hw *clk_hw_register_composite(struct device *dev, const char *name,
 671                 const char * const *parent_names, int num_parents,
 672                 struct clk_hw *mux_hw, const struct clk_ops *mux_ops,
 673                 struct clk_hw *rate_hw, const struct clk_ops *rate_ops,
 674                 struct clk_hw *gate_hw, const struct clk_ops *gate_ops,
 675                 unsigned long flags);
 676 void clk_hw_unregister_composite(struct clk_hw *hw);
 677
 678 /***
 679  * struct clk_gpio_gate - gpio gated clock
 680  *
 681  * @hw:         handle between common and hardware-specific interfaces
 682  * @gpiod:      gpio descriptor
 683  *
 684  * Clock with a gpio control for enabling and disabling the parent clock.
 685  * Implements .enable, .disable and .is_enabled
 686  */
 687
 688 struct clk_gpio {
 689         struct clk_hw   hw;
 690         struct gpio_desc *gpiod;
 691 };
 692
 693 #define to_clk_gpio(_hw) container_of(_hw, struct clk_gpio, hw)
 694
 695 extern const struct clk_ops clk_gpio_gate_ops;
 696 struct clk *clk_register_gpio_gate(struct device *dev, const char *name,
 697                 const char *parent_name, struct gpio_desc *gpiod,
 698                 unsigned long flags);
 699 struct clk_hw *clk_hw_register_gpio_gate(struct device *dev, const char *name,
 700                 const char *parent_name, struct gpio_desc *gpiod,
 701                 unsigned long flags);
 702 void clk_hw_unregister_gpio_gate(struct clk_hw *hw);
 703
 704 /**
 705  * struct clk_gpio_mux - gpio controlled clock multiplexer
 706  *
 707  * @hw:         see struct clk_gpio
 708  * @gpiod:      gpio descriptor to select the parent of this clock multiplexer
 709  *
 710  * Clock with a gpio control for selecting the parent clock.
 711  * Implements .get_parent, .set_parent and .determine_rate
 712  */
 713
 714 extern const struct clk_ops clk_gpio_mux_ops;
 715 struct clk *clk_register_gpio_mux(struct device *dev, const char *name,
 716                 const char * const *parent_names, u8 num_parents, struct gpio_desc *gpiod,
 717                 unsigned long flags);
 718 struct clk_hw *clk_hw_register_gpio_mux(struct device *dev, const char *name,
 719                 const char * const *parent_names, u8 num_parents, struct gpio_desc *gpiod,
 720                 unsigned long flags);
 721 void clk_hw_unregister_gpio_mux(struct clk_hw *hw);
 722
 723 /**
 724  * clk_register - allocate a new clock, register it and return an opaque cookie
 725  * @dev: device that is registering this clock
 726  * @hw: link to hardware-specific clock data
 727  *
 728  * clk_register is the primary interface for populating the clock tree with new
 729  * clock nodes.  It returns a pointer to the newly allocated struct clk which
 730  * cannot be dereferenced by driver code but may be used in conjuction with the
 731  * rest of the clock API.  In the event of an error clk_register will return an
 732  * error code; drivers must test for an error code after calling clk_register.
 733  */
 734 struct clk *clk_register(struct device *dev, struct clk_hw *hw);
 735 struct clk *devm_clk_register(struct device *dev, struct clk_hw *hw);
 736
 737 int __must_check clk_hw_register(struct device *dev, struct clk_hw *hw);
 738 int __must_check devm_clk_hw_register(struct device *dev, struct clk_hw *hw);
 739
 740 void clk_unregister(struct clk *clk);
 741 void devm_clk_unregister(struct device *dev, struct clk *clk);
 742
 743 void clk_hw_unregister(struct clk_hw *hw);
 744 void devm_clk_hw_unregister(struct device *dev, struct clk_hw *hw);
 745
 746 /* helper functions */
 747 const char *__clk_get_name(const struct clk *clk);
 748 const char *clk_hw_get_name(const struct clk_hw *hw);
 749 struct clk_hw *__clk_get_hw(struct clk *clk);
 750 unsigned int clk_hw_get_num_parents(const struct clk_hw *hw);
 751 struct clk_hw *clk_hw_get_parent(const struct clk_hw *hw);
 752 struct clk_hw *clk_hw_get_parent_by_index(const struct clk_hw *hw,
 753                                           unsigned int index);
 754 unsigned int __clk_get_enable_count(struct clk *clk);
 755 unsigned long clk_hw_get_rate(const struct clk_hw *hw);
 756 unsigned long __clk_get_flags(struct clk *clk);
 757 unsigned long clk_hw_get_flags(const struct clk_hw *hw);
 758 bool clk_hw_is_prepared(const struct clk_hw *hw);
 759 bool clk_hw_rate_is_protected(const struct clk_hw *hw);
 760 bool clk_hw_is_enabled(const struct clk_hw *hw);
 761 bool __clk_is_enabled(struct clk *clk);
 762 struct clk *__clk_lookup(const char *name);
 763 int __clk_mux_determine_rate(struct clk_hw *hw,
 764                              struct clk_rate_request *req);
 765 int __clk_determine_rate(struct clk_hw *core, struct clk_rate_request *req);
 766 int __clk_mux_determine_rate_closest(struct clk_hw *hw,
 767                                      struct clk_rate_request *req);
 768 int clk_mux_determine_rate_flags(struct clk_hw *hw,
 769                                  struct clk_rate_request *req,
 770                                  unsigned long flags);
 771 void clk_hw_reparent(struct clk_hw *hw, struct clk_hw *new_parent);
 772 void clk_hw_set_rate_range(struct clk_hw *hw, unsigned long min_rate,
 773                            unsigned long max_rate);
 774
 775 static inline void __clk_hw_set_clk(struct clk_hw *dst, struct clk_hw *src)
 776 {
 777         dst->clk = src->clk;
 778         dst->core = src->core;
 779 }
 780
 781 static inline long divider_round_rate(struct clk_hw *hw, unsigned long rate,
 782                                       unsigned long *prate,
 783                                       const struct clk_div_table *table,
 784                                       u8 width, unsigned long flags)
 785 {
 786         return divider_round_rate_parent(hw, clk_hw_get_parent(hw),
 787                                          rate, prate, table, width, flags);
 788 }
 789
 790 static inline long divider_ro_round_rate(struct clk_hw *hw, unsigned long rate,
 791                                          unsigned long *prate,
 792                                          const struct clk_div_table *table,
 793                                          u8 width, unsigned long flags,
 794                                          unsigned int val)
 795 {
 796         return divider_ro_round_rate_parent(hw, clk_hw_get_parent(hw),
 797                                             rate, prate, table, width, flags,
 798                                             val);
 799 }
 800
 801 /*
 802  * FIXME clock api without lock protection
 803  */
 804 unsigned long clk_hw_round_rate(struct clk_hw *hw, unsigned long rate);
 805
 806 struct of_device_id;
 807
 808 typedef void (*of_clk_init_cb_t)(struct device_node *);
 809
 810 struct clk_onecell_data {
 811         struct clk **clks;
 812         unsigned int clk_num;
 813 };
 814
 815 struct clk_hw_onecell_data {
 816         unsigned int num;
 817         struct clk_hw *hws[];
 818 };
 819
 820 extern struct of_device_id __clk_of_table;
 821
 822 #define CLK_OF_DECLARE(name, compat, fn) OF_DECLARE_1(clk, name, compat, fn)
 823
 824 /*
 825  * Use this macro when you have a driver that requires two initialization
 826  * routines, one at of_clk_init(), and one at platform device probe
 827  */
 828 #define CLK_OF_DECLARE_DRIVER(name, compat, fn) \
 829         static void __init name##_of_clk_init_driver(struct device_node *np) \
 830         {                                                               \
 831                 of_node_clear_flag(np, OF_POPULATED);                   \
 832                 fn(np);                                                 \
 833         }                                                               \
 834         OF_DECLARE_1(clk, name, compat, name##_of_clk_init_driver)
 835
 836 #define CLK_HW_INIT(_name, _parent, _ops, _flags)               \
 837         (&(struct clk_init_data) {                              \
 838                 .flags          = _flags,                       \
 839                 .name           = _name,                        \
 840                 .parent_names   = (const char *[]) { _parent }, \
 841                 .num_parents    = 1,                            \
 842                 .ops            = _ops,                         \
 843         })
 844
 845 #define CLK_HW_INIT_PARENTS(_name, _parents, _ops, _flags)      \
 846         (&(struct clk_init_data) {                              \
 847                 .flags          = _flags,                       \
 848                 .name           = _name,                        \
 849                 .parent_names   = _parents,                     \
 850                 .num_parents    = ARRAY_SIZE(_parents),         \
 851                 .ops            = _ops,                         \
 852         })
 853
 854 #define CLK_HW_INIT_NO_PARENT(_name, _ops, _flags)      \
 855         (&(struct clk_init_data) {                      \
 856                 .flags          = _flags,               \
 857                 .name           = _name,                \
 858                 .parent_names   = NULL,                 \
 859                 .num_parents    = 0,                    \
 860                 .ops            = _ops,                 \
 861         })
 862
 863 #define CLK_FIXED_FACTOR(_struct, _name, _parent,                       \
 864                         _div, _mult, _flags)                            \
 865         struct clk_fixed_factor _struct = {                             \
 866                 .div            = _div,                                 \
 867                 .mult           = _mult,                                \
 868                 .hw.init        = CLK_HW_INIT(_name,                    \
 869                                               _parent,                  \
 870                                               &clk_fixed_factor_ops,    \
 871                                               _flags),                  \
 872         }
 873
 874 #ifdef CONFIG_OF
 875 int of_clk_add_provider(struct device_node *np,
 876                         struct clk *(*clk_src_get)(struct of_phandle_args *args,
 877                                                    void *data),
 878                         void *data);
 879 int of_clk_add_hw_provider(struct device_node *np,
 880                            struct clk_hw *(*get)(struct of_phandle_args *clkspec,
 881                                                  void *data),
 882                            void *data);
 883 int devm_of_clk_add_hw_provider(struct device *dev,
 884                            struct clk_hw *(*get)(struct of_phandle_args *clkspec,
 885                                                  void *data),
 886                            void *data);
 887 void of_clk_del_provider(struct device_node *np);
 888 void devm_of_clk_del_provider(struct device *dev);
 889 struct clk *of_clk_src_simple_get(struct of_phandle_args *clkspec,
 890                                   void *data);
 891 struct clk_hw *of_clk_hw_simple_get(struct of_phandle_args *clkspec,
 892                                     void *data);
 893 struct clk *of_clk_src_onecell_get(struct of_phandle_args *clkspec, void *data);
 894 struct clk_hw *of_clk_hw_onecell_get(struct of_phandle_args *clkspec,
 895                                      void *data);
 896 unsigned int of_clk_get_parent_count(struct device_node *np);
 897 int of_clk_parent_fill(struct device_node *np, const char **parents,
 898                        unsigned int size);
 899 const char *of_clk_get_parent_name(struct device_node *np, int index);
 900 int of_clk_detect_critical(struct device_node *np, int index,
 901                             unsigned long *flags);
 902 void of_clk_init(const struct of_device_id *matches);
 903
 904 #else /* !CONFIG_OF */
 905
 906 static inline int of_clk_add_provider(struct device_node *np,
 907                         struct clk *(*clk_src_get)(struct of_phandle_args *args,
 908                                                    void *data),
 909                         void *data)
 910 {
 911         return 0;
 912 }
 913 static inline int of_clk_add_hw_provider(struct device_node *np,
 914                         struct clk_hw *(*get)(struct of_phandle_args *clkspec,
 915                                               void *data),
 916                         void *data)
 917 {
 918         return 0;
 919 }
 920 static inline int devm_of_clk_add_hw_provider(struct device *dev,
 921                            struct clk_hw *(*get)(struct of_phandle_args *clkspec,
 922                                                  void *data),
 923                            void *data)
 924 {
 925         return 0;
 926 }
 927 static inline void of_clk_del_provider(struct device_node *np) {}
 928 static inline void devm_of_clk_del_provider(struct device *dev) {}
 929 static inline struct clk *of_clk_src_simple_get(
 930         struct of_phandle_args *clkspec, void *data)
 931 {
 932         return ERR_PTR(-ENOENT);
 933 }
 934 static inline struct clk_hw *
 935 of_clk_hw_simple_get(struct of_phandle_args *clkspec, void *data)
 936 {
 937         return ERR_PTR(-ENOENT);
 938 }
 939 static inline struct clk *of_clk_src_onecell_get(
 940         struct of_phandle_args *clkspec, void *data)
 941 {
 942         return ERR_PTR(-ENOENT);
 943 }
 944 static inline struct clk_hw *
 945 of_clk_hw_onecell_get(struct of_phandle_args *clkspec, void *data)
 946 {
 947         return ERR_PTR(-ENOENT);
 948 }
 949 static inline unsigned int of_clk_get_parent_count(struct device_node *np)
 950 {
 951         return 0;
 952 }
 953 static inline int of_clk_parent_fill(struct device_node *np,
 954                                      const char **parents, unsigned int size)
 955 {
 956         return 0;
 957 }
 958 static inline const char *of_clk_get_parent_name(struct device_node *np,
 959                                                  int index)
 960 {
 961         return NULL;
 962 }
 963 static inline int of_clk_detect_critical(struct device_node *np, int index,
 964                                           unsigned long *flags)
 965 {
 966         return 0;
 967 }
 968 static inline void of_clk_init(const struct of_device_id *matches) {}
 969 #endif /* CONFIG_OF */
 970
 971 /*
 972  * wrap access to peripherals in accessor routines
 973  * for improved portability across platforms
 974  */
 975
 976 #if IS_ENABLED(CONFIG_PPC)
 977
 978 static inline u32 clk_readl(u32 __iomem *reg)
 979 {
 980         return ioread32be(reg);
 981 }
 982
 983 static inline void clk_writel(u32 val, u32 __iomem *reg)
 984 {
 985         iowrite32be(val, reg);
 986 }
 987
 988 #else   /* platform dependent I/O accessors */
 989
 990 static inline u32 clk_readl(u32 __iomem *reg)
 991 {
 992         return readl(reg);
 993 }
 994
 995 static inline void clk_writel(u32 val, u32 __iomem *reg)
 996 {
 997         writel(val, reg);
 998 }
 999
1000 #endif  /* platform dependent I/O accessors */
1001
1002 #ifdef CONFIG_DEBUG_FS
1003 struct dentry *clk_debugfs_add_file(struct clk_hw *hw, char *name, umode_t mode,
1004                                 void *data, const struct file_operations *fops);
1005 #endif
1006
1007 #endif /* CONFIG_COMMON_CLK */
1008 #endif /* CLK_PROVIDER_H */