include/linux/clk-provider.h

   1 /* SPDX-License-Identifier: GPL-2.0+ */
   2 /*
   3  * Copyright (C) 2019 DENX Software Engineering
   4  * Lukasz Majewski, DENX Software Engineering, lukma@denx.de
   5  *
   6  * Copyright (c) 2010-2011 Jeremy Kerr <jeremy.kerr@canonical.com>
   7  * Copyright (C) 2011-2012 Linaro Ltd <mturquette@linaro.org>
   8  */
   9 #ifndef __LINUX_CLK_PROVIDER_H
  10 #define __LINUX_CLK_PROVIDER_H
  11 #include <clk-uclass.h>
  12
  13 static inline void clk_dm(ulong id, struct clk *clk)
  14 {
  15         if (!IS_ERR(clk))
  16                 clk->id = id;
  17 }
  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 /* duty cycle call may be forwarded to the parent clock */
  41 #define CLK_DUTY_CYCLE_PARENT   BIT(13)
  42
  43 #define CLK_MUX_INDEX_ONE               BIT(0)
  44 #define CLK_MUX_INDEX_BIT               BIT(1)
  45 #define CLK_MUX_HIWORD_MASK             BIT(2)
  46 #define CLK_MUX_READ_ONLY               BIT(3) /* mux can't be changed */
  47 #define CLK_MUX_ROUND_CLOSEST           BIT(4)
  48
  49 struct clk_mux {
  50         struct clk      clk;
  51         void __iomem    *reg;
  52         u32             *table;
  53         u32             mask;
  54         u8              shift;
  55         u8              flags;
  56
  57         /*
  58          * Fields from struct clk_init_data - this struct has been
  59          * omitted to avoid too deep level of CCF for bootloader
  60          */
  61         const char      * const *parent_names;
  62         u8              num_parents;
  63 #if CONFIG_IS_ENABLED(SANDBOX_CLK_CCF)
  64         u32             io_mux_val;
  65 #endif
  66
  67 };
  68
  69 #define to_clk_mux(_clk) container_of(_clk, struct clk_mux, clk)
  70 extern const struct clk_ops clk_mux_ops;
  71 u8 clk_mux_get_parent(struct clk *clk);
  72
  73 struct clk_gate {
  74         struct clk      clk;
  75         void __iomem    *reg;
  76         u8              bit_idx;
  77         u8              flags;
  78 };
  79
  80 #define to_clk_gate(_clk) container_of(_clk, struct clk_gate, clk)
  81
  82 #define CLK_GATE_SET_TO_DISABLE         BIT(0)
  83 #define CLK_GATE_HIWORD_MASK            BIT(1)
  84
  85 extern const struct clk_ops clk_gate_ops;
  86 struct clk *clk_register_gate(struct device *dev, const char *name,
  87                               const char *parent_name, unsigned long flags,
  88                               void __iomem *reg, u8 bit_idx,
  89                               u8 clk_gate_flags, spinlock_t *lock);
  90
  91 struct clk_div_table {
  92         unsigned int    val;
  93         unsigned int    div;
  94 };
  95
  96 struct clk_divider {
  97         struct clk      clk;
  98         void __iomem    *reg;
  99         u8              shift;
 100         u8              width;
 101         u8              flags;
 102         const struct clk_div_table      *table;
 103 #if CONFIG_IS_ENABLED(SANDBOX_CLK_CCF)
 104         u32             io_divider_val;
 105 #endif
 106 };
 107
 108 #define clk_div_mask(width)     ((1 << (width)) - 1)
 109 #define to_clk_divider(_clk) container_of(_clk, struct clk_divider, clk)
 110
 111 #define CLK_DIVIDER_ONE_BASED           BIT(0)
 112 #define CLK_DIVIDER_POWER_OF_TWO        BIT(1)
 113 #define CLK_DIVIDER_ALLOW_ZERO          BIT(2)
 114 #define CLK_DIVIDER_HIWORD_MASK         BIT(3)
 115 #define CLK_DIVIDER_ROUND_CLOSEST       BIT(4)
 116 #define CLK_DIVIDER_READ_ONLY           BIT(5)
 117 #define CLK_DIVIDER_MAX_AT_ZERO         BIT(6)
 118 extern const struct clk_ops clk_divider_ops;
 119 unsigned long divider_recalc_rate(struct clk *hw, unsigned long parent_rate,
 120                                   unsigned int val,
 121                                   const struct clk_div_table *table,
 122                                   unsigned long flags, unsigned long width);
 123
 124 struct clk_fixed_factor {
 125         struct clk      clk;
 126         unsigned int    mult;
 127         unsigned int    div;
 128 };
 129
 130 #define to_clk_fixed_factor(_clk) container_of(_clk, struct clk_fixed_factor,\
 131                                                clk)
 132
 133 struct clk_fixed_rate {
 134         struct clk clk;
 135         unsigned long fixed_rate;
 136 };
 137
 138 #define to_clk_fixed_rate(dev)  ((struct clk_fixed_rate *)dev_get_platdata(dev))
 139
 140 struct clk_composite {
 141         struct clk      clk;
 142         struct clk_ops  ops;
 143
 144         struct clk      *mux;
 145         struct clk      *rate;
 146         struct clk      *gate;
 147
 148         const struct clk_ops    *mux_ops;
 149         const struct clk_ops    *rate_ops;
 150         const struct clk_ops    *gate_ops;
 151 };
 152
 153 #define to_clk_composite(_clk) container_of(_clk, struct clk_composite, clk)
 154
 155 struct clk *clk_register_composite(struct device *dev, const char *name,
 156                 const char * const *parent_names, int num_parents,
 157                 struct clk *mux_clk, const struct clk_ops *mux_ops,
 158                 struct clk *rate_clk, const struct clk_ops *rate_ops,
 159                 struct clk *gate_clk, const struct clk_ops *gate_ops,
 160                 unsigned long flags);
 161
 162 int clk_register(struct clk *clk, const char *drv_name, const char *name,
 163                  const char *parent_name);
 164
 165 struct clk *clk_register_fixed_factor(struct device *dev, const char *name,
 166                 const char *parent_name, unsigned long flags,
 167                 unsigned int mult, unsigned int div);
 168
 169 struct clk *clk_register_divider(struct device *dev, const char *name,
 170                 const char *parent_name, unsigned long flags,
 171                 void __iomem *reg, u8 shift, u8 width,
 172                 u8 clk_divider_flags);
 173
 174 struct clk *clk_register_mux(struct device *dev, const char *name,
 175                 const char * const *parent_names, u8 num_parents,
 176                 unsigned long flags,
 177                 void __iomem *reg, u8 shift, u8 width,
 178                 u8 clk_mux_flags);
 179
 180 const char *clk_hw_get_name(const struct clk *hw);
 181 ulong clk_generic_get_rate(struct clk *clk);
 182
 183 static inline struct clk *dev_get_clk_ptr(struct udevice *dev)
 184 {
 185         return (struct clk *)dev_get_uclass_priv(dev);
 186 }
 187 #endif /* __LINUX_CLK_PROVIDER_H */