1 /* 2 * TI Clock driver internal definitions 3 * 4 * Copyright (C) 2014 Texas Instruments, Inc 5 * Tero Kristo (t-kristo@ti.com) 6 * 7 * This program is free software; you can redistribute it and/or 8 * modify it under the terms of the GNU General Public License as 9 * published by the Free Software Foundation version 2. 10 * 11 * This program is distributed "as is" WITHOUT ANY WARRANTY of any 12 * kind, whether express or implied; without even the implied warranty 13 * of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 14 * GNU General Public License for more details. 15 */ 16 #ifndef __DRIVERS_CLK_TI_CLOCK__ 17 #define __DRIVERS_CLK_TI_CLOCK__ 18 19 struct clk_omap_divider { 20 struct clk_hw hw; 21 struct clk_omap_reg reg; 22 u8 shift; 23 u8 width; 24 u8 flags; 25 const struct clk_div_table *table; 26 }; 27 28 #define to_clk_omap_divider(_hw) container_of(_hw, struct clk_omap_divider, hw) 29 30 struct clk_omap_mux { 31 struct clk_hw hw; 32 struct clk_omap_reg reg; 33 u32 *table; 34 u32 mask; 35 u8 shift; 36 u8 flags; 37 }; 38 39 #define to_clk_omap_mux(_hw) container_of(_hw, struct clk_omap_mux, hw) 40 41 enum { 42 TI_CLK_FIXED, 43 TI_CLK_MUX, 44 TI_CLK_DIVIDER, 45 TI_CLK_COMPOSITE, 46 TI_CLK_FIXED_FACTOR, 47 TI_CLK_GATE, 48 TI_CLK_DPLL, 49 }; 50 51 /* Global flags */ 52 #define CLKF_INDEX_POWER_OF_TWO (1 << 0) 53 #define CLKF_INDEX_STARTS_AT_ONE (1 << 1) 54 #define CLKF_SET_RATE_PARENT (1 << 2) 55 #define CLKF_OMAP3 (1 << 3) 56 #define CLKF_AM35XX (1 << 4) 57 58 /* Gate flags */ 59 #define CLKF_SET_BIT_TO_DISABLE (1 << 5) 60 #define CLKF_INTERFACE (1 << 6) 61 #define CLKF_SSI (1 << 7) 62 #define CLKF_DSS (1 << 8) 63 #define CLKF_HSOTGUSB (1 << 9) 64 #define CLKF_WAIT (1 << 10) 65 #define CLKF_NO_WAIT (1 << 11) 66 #define CLKF_HSDIV (1 << 12) 67 #define CLKF_CLKDM (1 << 13) 68 69 /* DPLL flags */ 70 #define CLKF_LOW_POWER_STOP (1 << 5) 71 #define CLKF_LOCK (1 << 6) 72 #define CLKF_LOW_POWER_BYPASS (1 << 7) 73 #define CLKF_PER (1 << 8) 74 #define CLKF_CORE (1 << 9) 75 #define CLKF_J_TYPE (1 << 10) 76 77 #define CLK(dev, con, ck) \ 78 { \ 79 .lk = { \ 80 .dev_id = dev, \ 81 .con_id = con, \ 82 }, \ 83 .clk = ck, \ 84 } 85 86 struct ti_clk { 87 const char *name; 88 const char *clkdm_name; 89 int type; 90 void *data; 91 struct ti_clk *patch; 92 struct clk *clk; 93 }; 94 95 struct ti_clk_alias { 96 struct ti_clk *clk; 97 struct clk_lookup lk; 98 struct list_head link; 99 }; 100 101 struct ti_clk_fixed { 102 u32 frequency; 103 u16 flags; 104 }; 105 106 struct ti_clk_mux { 107 u8 bit_shift; 108 int num_parents; 109 u16 reg; 110 u8 module; 111 const char * const *parents; 112 u16 flags; 113 }; 114 115 struct ti_clk_divider { 116 const char *parent; 117 u8 bit_shift; 118 u16 max_div; 119 u16 reg; 120 u8 module; 121 int *dividers; 122 int num_dividers; 123 u16 flags; 124 }; 125 126 struct ti_clk_fixed_factor { 127 const char *parent; 128 u16 div; 129 u16 mult; 130 u16 flags; 131 }; 132 133 struct ti_clk_gate { 134 const char *parent; 135 u8 bit_shift; 136 u16 reg; 137 u8 module; 138 u16 flags; 139 }; 140 141 struct ti_clk_composite { 142 struct ti_clk_divider *divider; 143 struct ti_clk_mux *mux; 144 struct ti_clk_gate *gate; 145 u16 flags; 146 }; 147 148 struct ti_clk_clkdm_gate { 149 const char *parent; 150 u16 flags; 151 }; 152 153 struct ti_clk_dpll { 154 int num_parents; 155 u16 control_reg; 156 u16 idlest_reg; 157 u16 autoidle_reg; 158 u16 mult_div1_reg; 159 u8 module; 160 const char **parents; 161 u16 flags; 162 u8 modes; 163 u32 mult_mask; 164 u32 div1_mask; 165 u32 enable_mask; 166 u32 autoidle_mask; 167 u32 freqsel_mask; 168 u32 idlest_mask; 169 u32 dco_mask; 170 u32 sddiv_mask; 171 u16 max_multiplier; 172 u16 max_divider; 173 u8 min_divider; 174 u8 auto_recal_bit; 175 u8 recal_en_bit; 176 u8 recal_st_bit; 177 }; 178 179 /* Composite clock component types */ 180 enum { 181 CLK_COMPONENT_TYPE_GATE = 0, 182 CLK_COMPONENT_TYPE_DIVIDER, 183 CLK_COMPONENT_TYPE_MUX, 184 CLK_COMPONENT_TYPE_MAX, 185 }; 186 187 /** 188 * struct ti_dt_clk - OMAP DT clock alias declarations 189 * @lk: clock lookup definition 190 * @node_name: clock DT node to map to 191 */ 192 struct ti_dt_clk { 193 struct clk_lookup lk; 194 char *node_name; 195 }; 196 197 #define DT_CLK(dev, con, name) \ 198 { \ 199 .lk = { \ 200 .dev_id = dev, \ 201 .con_id = con, \ 202 }, \ 203 .node_name = name, \ 204 } 205 206 /* CLKCTRL type definitions */ 207 struct omap_clkctrl_div_data { 208 const int *dividers; 209 int max_div; 210 u32 flags; 211 }; 212 213 struct omap_clkctrl_bit_data { 214 u8 bit; 215 u8 type; 216 const char * const *parents; 217 const void *data; 218 }; 219 220 struct omap_clkctrl_reg_data { 221 u16 offset; 222 const struct omap_clkctrl_bit_data *bit_data; 223 u16 flags; 224 const char *parent; 225 const char *clkdm_name; 226 }; 227 228 struct omap_clkctrl_data { 229 u32 addr; 230 const struct omap_clkctrl_reg_data *regs; 231 }; 232 233 extern const struct omap_clkctrl_data omap4_clkctrl_data[]; 234 extern const struct omap_clkctrl_data omap5_clkctrl_data[]; 235 extern const struct omap_clkctrl_data dra7_clkctrl_data[]; 236 extern const struct omap_clkctrl_data am3_clkctrl_data[]; 237 extern const struct omap_clkctrl_data am4_clkctrl_data[]; 238 extern const struct omap_clkctrl_data am438x_clkctrl_data[]; 239 extern const struct omap_clkctrl_data dm814_clkctrl_data[]; 240 extern const struct omap_clkctrl_data dm816_clkctrl_data[]; 241 242 #define CLKF_SW_SUP BIT(0) 243 #define CLKF_HW_SUP BIT(1) 244 #define CLKF_NO_IDLEST BIT(2) 245 246 typedef void (*ti_of_clk_init_cb_t)(void *, struct device_node *); 247 248 struct clk *ti_clk_register_gate(struct ti_clk *setup); 249 struct clk *ti_clk_register_interface(struct ti_clk *setup); 250 struct clk *ti_clk_register_mux(struct ti_clk *setup); 251 struct clk *ti_clk_register_divider(struct ti_clk *setup); 252 struct clk *ti_clk_register_composite(struct ti_clk *setup); 253 struct clk *ti_clk_register_dpll(struct ti_clk *setup); 254 struct clk *ti_clk_register(struct device *dev, struct clk_hw *hw, 255 const char *con); 256 int ti_clk_add_alias(struct device *dev, struct clk *clk, const char *con); 257 void ti_clk_add_aliases(void); 258 259 struct clk_hw *ti_clk_build_component_div(struct ti_clk_divider *setup); 260 struct clk_hw *ti_clk_build_component_gate(struct ti_clk_gate *setup); 261 struct clk_hw *ti_clk_build_component_mux(struct ti_clk_mux *setup); 262 263 int ti_clk_parse_divider_data(int *div_table, int num_dividers, int max_div, 264 u8 flags, u8 *width, 265 const struct clk_div_table **table); 266 267 void ti_clk_patch_legacy_clks(struct ti_clk **patch); 268 struct clk *ti_clk_register_clk(struct ti_clk *setup); 269 int ti_clk_register_legacy_clks(struct ti_clk_alias *clks); 270 271 int ti_clk_get_reg_addr(struct device_node *node, int index, 272 struct clk_omap_reg *reg); 273 void ti_dt_clocks_register(struct ti_dt_clk *oclks); 274 int ti_clk_retry_init(struct device_node *node, void *user, 275 ti_of_clk_init_cb_t func); 276 int ti_clk_add_component(struct device_node *node, struct clk_hw *hw, int type); 277 278 void omap2_init_clk_hw_omap_clocks(struct clk_hw *hw); 279 int of_ti_clk_autoidle_setup(struct device_node *node); 280 void omap2_clk_enable_init_clocks(const char **clk_names, u8 num_clocks); 281 282 extern const struct clk_hw_omap_ops clkhwops_omap3_dpll; 283 extern const struct clk_hw_omap_ops clkhwops_omap4_dpllmx; 284 extern const struct clk_hw_omap_ops clkhwops_wait; 285 extern const struct clk_hw_omap_ops clkhwops_iclk; 286 extern const struct clk_hw_omap_ops clkhwops_iclk_wait; 287 extern const struct clk_hw_omap_ops clkhwops_omap2430_i2chs_wait; 288 extern const struct clk_hw_omap_ops clkhwops_omap3430es2_dss_usbhost_wait; 289 extern const struct clk_hw_omap_ops clkhwops_omap3430es2_iclk_hsotgusb_wait; 290 extern const struct clk_hw_omap_ops clkhwops_omap3430es2_iclk_dss_usbhost_wait; 291 extern const struct clk_hw_omap_ops clkhwops_omap3430es2_iclk_ssi_wait; 292 extern const struct clk_hw_omap_ops clkhwops_am35xx_ipss_module_wait; 293 extern const struct clk_hw_omap_ops clkhwops_am35xx_ipss_wait; 294 295 extern const struct clk_ops ti_clk_divider_ops; 296 extern const struct clk_ops ti_clk_mux_ops; 297 extern const struct clk_ops omap_gate_clk_ops; 298 299 void omap2_init_clk_clkdm(struct clk_hw *hw); 300 int omap2_clkops_enable_clkdm(struct clk_hw *hw); 301 void omap2_clkops_disable_clkdm(struct clk_hw *hw); 302 303 int omap2_dflt_clk_enable(struct clk_hw *hw); 304 void omap2_dflt_clk_disable(struct clk_hw *hw); 305 int omap2_dflt_clk_is_enabled(struct clk_hw *hw); 306 void omap2_clk_dflt_find_companion(struct clk_hw_omap *clk, 307 struct clk_omap_reg *other_reg, 308 u8 *other_bit); 309 void omap2_clk_dflt_find_idlest(struct clk_hw_omap *clk, 310 struct clk_omap_reg *idlest_reg, 311 u8 *idlest_bit, u8 *idlest_val); 312 313 void omap2_clkt_iclk_allow_idle(struct clk_hw_omap *clk); 314 void omap2_clkt_iclk_deny_idle(struct clk_hw_omap *clk); 315 316 u8 omap2_init_dpll_parent(struct clk_hw *hw); 317 int omap3_noncore_dpll_enable(struct clk_hw *hw); 318 void omap3_noncore_dpll_disable(struct clk_hw *hw); 319 int omap3_noncore_dpll_set_parent(struct clk_hw *hw, u8 index); 320 int omap3_noncore_dpll_set_rate(struct clk_hw *hw, unsigned long rate, 321 unsigned long parent_rate); 322 int omap3_noncore_dpll_set_rate_and_parent(struct clk_hw *hw, 323 unsigned long rate, 324 unsigned long parent_rate, 325 u8 index); 326 int omap3_noncore_dpll_determine_rate(struct clk_hw *hw, 327 struct clk_rate_request *req); 328 long omap2_dpll_round_rate(struct clk_hw *hw, unsigned long target_rate, 329 unsigned long *parent_rate); 330 unsigned long omap3_clkoutx2_recalc(struct clk_hw *hw, 331 unsigned long parent_rate); 332 333 /* 334 * OMAP3_DPLL5_FREQ_FOR_USBHOST: USBHOST and USBTLL are the only clocks 335 * that are sourced by DPLL5, and both of these require this clock 336 * to be at 120 MHz for proper operation. 337 */ 338 #define OMAP3_DPLL5_FREQ_FOR_USBHOST 120000000 339 340 unsigned long omap3_dpll_recalc(struct clk_hw *hw, unsigned long parent_rate); 341 int omap3_dpll4_set_rate(struct clk_hw *clk, unsigned long rate, 342 unsigned long parent_rate); 343 int omap3_dpll4_set_rate_and_parent(struct clk_hw *hw, unsigned long rate, 344 unsigned long parent_rate, u8 index); 345 int omap3_dpll5_set_rate(struct clk_hw *hw, unsigned long rate, 346 unsigned long parent_rate); 347 void omap3_clk_lock_dpll5(void); 348 349 unsigned long omap4_dpll_regm4xen_recalc(struct clk_hw *hw, 350 unsigned long parent_rate); 351 long omap4_dpll_regm4xen_round_rate(struct clk_hw *hw, 352 unsigned long target_rate, 353 unsigned long *parent_rate); 354 int omap4_dpll_regm4xen_determine_rate(struct clk_hw *hw, 355 struct clk_rate_request *req); 356 357 extern struct ti_clk_ll_ops *ti_clk_ll_ops; 358 359 #endif 360