2 * TI Clock driver internal definitions
4 * Copyright (C) 2014 Texas Instruments, Inc
5 * Tero Kristo (t-kristo@ti.com)
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.
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.
16 #ifndef __DRIVERS_CLK_TI_CLOCK__
17 #define __DRIVERS_CLK_TI_CLOCK__
19 struct clk_omap_divider {
21 struct clk_omap_reg reg;
25 const struct clk_div_table *table;
28 #define to_clk_omap_divider(_hw) container_of(_hw, struct clk_omap_divider, hw)
32 struct clk_omap_reg reg;
39 #define to_clk_omap_mux(_hw) container_of(_hw, struct clk_omap_mux, hw)
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)
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)
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)
77 #define CLK(dev, con, ck) \
88 const char *clkdm_name;
98 struct list_head link;
101 struct ti_clk_fixed {
111 const char * const *parents;
115 struct ti_clk_divider {
126 struct ti_clk_fixed_factor {
141 struct ti_clk_composite {
142 struct ti_clk_divider *divider;
143 struct ti_clk_mux *mux;
144 struct ti_clk_gate *gate;
148 struct ti_clk_clkdm_gate {
160 const char **parents;
179 /* Composite clock component types */
181 CLK_COMPONENT_TYPE_GATE = 0,
182 CLK_COMPONENT_TYPE_DIVIDER,
183 CLK_COMPONENT_TYPE_MUX,
184 CLK_COMPONENT_TYPE_MAX,
188 * struct ti_dt_clk - OMAP DT clock alias declarations
189 * @lk: clock lookup definition
190 * @node_name: clock DT node to map to
193 struct clk_lookup lk;
197 #define DT_CLK(dev, con, name) \
206 /* CLKCTRL type definitions */
207 struct omap_clkctrl_div_data {
212 struct omap_clkctrl_bit_data {
215 const char * const *parents;
219 struct omap_clkctrl_reg_data {
221 const struct omap_clkctrl_bit_data *bit_data;
226 struct omap_clkctrl_data {
228 const struct omap_clkctrl_reg_data *regs;
231 extern const struct omap_clkctrl_data omap4_clkctrl_data[];
233 #define CLKF_SW_SUP BIT(0)
234 #define CLKF_HW_SUP BIT(1)
235 #define CLKF_NO_IDLEST BIT(2)
237 typedef void (*ti_of_clk_init_cb_t)(struct clk_hw *, struct device_node *);
239 struct clk *ti_clk_register_gate(struct ti_clk *setup);
240 struct clk *ti_clk_register_interface(struct ti_clk *setup);
241 struct clk *ti_clk_register_mux(struct ti_clk *setup);
242 struct clk *ti_clk_register_divider(struct ti_clk *setup);
243 struct clk *ti_clk_register_composite(struct ti_clk *setup);
244 struct clk *ti_clk_register_dpll(struct ti_clk *setup);
245 struct clk *ti_clk_register(struct device *dev, struct clk_hw *hw,
247 int ti_clk_add_alias(struct device *dev, struct clk *clk, const char *con);
248 void ti_clk_add_aliases(void);
250 struct clk_hw *ti_clk_build_component_div(struct ti_clk_divider *setup);
251 struct clk_hw *ti_clk_build_component_gate(struct ti_clk_gate *setup);
252 struct clk_hw *ti_clk_build_component_mux(struct ti_clk_mux *setup);
254 int ti_clk_parse_divider_data(int *div_table, int num_dividers, int max_div,
256 const struct clk_div_table **table);
258 void ti_clk_patch_legacy_clks(struct ti_clk **patch);
259 struct clk *ti_clk_register_clk(struct ti_clk *setup);
260 int ti_clk_register_legacy_clks(struct ti_clk_alias *clks);
262 int ti_clk_get_reg_addr(struct device_node *node, int index,
263 struct clk_omap_reg *reg);
264 void ti_dt_clocks_register(struct ti_dt_clk *oclks);
265 int ti_clk_retry_init(struct device_node *node, struct clk_hw *hw,
266 ti_of_clk_init_cb_t func);
267 int ti_clk_add_component(struct device_node *node, struct clk_hw *hw, int type);
269 void omap2_init_clk_hw_omap_clocks(struct clk_hw *hw);
270 int of_ti_clk_autoidle_setup(struct device_node *node);
271 void omap2_clk_enable_init_clocks(const char **clk_names, u8 num_clocks);
273 extern const struct clk_hw_omap_ops clkhwops_omap3_dpll;
274 extern const struct clk_hw_omap_ops clkhwops_omap4_dpllmx;
275 extern const struct clk_hw_omap_ops clkhwops_wait;
276 extern const struct clk_hw_omap_ops clkhwops_iclk;
277 extern const struct clk_hw_omap_ops clkhwops_iclk_wait;
278 extern const struct clk_hw_omap_ops clkhwops_omap2430_i2chs_wait;
279 extern const struct clk_hw_omap_ops clkhwops_omap3430es2_dss_usbhost_wait;
280 extern const struct clk_hw_omap_ops clkhwops_omap3430es2_iclk_hsotgusb_wait;
281 extern const struct clk_hw_omap_ops clkhwops_omap3430es2_iclk_dss_usbhost_wait;
282 extern const struct clk_hw_omap_ops clkhwops_omap3430es2_iclk_ssi_wait;
283 extern const struct clk_hw_omap_ops clkhwops_am35xx_ipss_module_wait;
284 extern const struct clk_hw_omap_ops clkhwops_am35xx_ipss_wait;
286 extern const struct clk_ops ti_clk_divider_ops;
287 extern const struct clk_ops ti_clk_mux_ops;
288 extern const struct clk_ops omap_gate_clk_ops;
290 void omap2_init_clk_clkdm(struct clk_hw *hw);
291 int omap2_clkops_enable_clkdm(struct clk_hw *hw);
292 void omap2_clkops_disable_clkdm(struct clk_hw *hw);
294 int omap2_dflt_clk_enable(struct clk_hw *hw);
295 void omap2_dflt_clk_disable(struct clk_hw *hw);
296 int omap2_dflt_clk_is_enabled(struct clk_hw *hw);
297 void omap2_clk_dflt_find_companion(struct clk_hw_omap *clk,
298 struct clk_omap_reg *other_reg,
300 void omap2_clk_dflt_find_idlest(struct clk_hw_omap *clk,
301 struct clk_omap_reg *idlest_reg,
302 u8 *idlest_bit, u8 *idlest_val);
304 void omap2_clkt_iclk_allow_idle(struct clk_hw_omap *clk);
305 void omap2_clkt_iclk_deny_idle(struct clk_hw_omap *clk);
307 u8 omap2_init_dpll_parent(struct clk_hw *hw);
308 int omap3_noncore_dpll_enable(struct clk_hw *hw);
309 void omap3_noncore_dpll_disable(struct clk_hw *hw);
310 int omap3_noncore_dpll_set_parent(struct clk_hw *hw, u8 index);
311 int omap3_noncore_dpll_set_rate(struct clk_hw *hw, unsigned long rate,
312 unsigned long parent_rate);
313 int omap3_noncore_dpll_set_rate_and_parent(struct clk_hw *hw,
315 unsigned long parent_rate,
317 int omap3_noncore_dpll_determine_rate(struct clk_hw *hw,
318 struct clk_rate_request *req);
319 long omap2_dpll_round_rate(struct clk_hw *hw, unsigned long target_rate,
320 unsigned long *parent_rate);
321 unsigned long omap3_clkoutx2_recalc(struct clk_hw *hw,
322 unsigned long parent_rate);
325 * OMAP3_DPLL5_FREQ_FOR_USBHOST: USBHOST and USBTLL are the only clocks
326 * that are sourced by DPLL5, and both of these require this clock
327 * to be at 120 MHz for proper operation.
329 #define OMAP3_DPLL5_FREQ_FOR_USBHOST 120000000
331 unsigned long omap3_dpll_recalc(struct clk_hw *hw, unsigned long parent_rate);
332 int omap3_dpll4_set_rate(struct clk_hw *clk, unsigned long rate,
333 unsigned long parent_rate);
334 int omap3_dpll4_set_rate_and_parent(struct clk_hw *hw, unsigned long rate,
335 unsigned long parent_rate, u8 index);
336 int omap3_dpll5_set_rate(struct clk_hw *hw, unsigned long rate,
337 unsigned long parent_rate);
338 void omap3_clk_lock_dpll5(void);
340 unsigned long omap4_dpll_regm4xen_recalc(struct clk_hw *hw,
341 unsigned long parent_rate);
342 long omap4_dpll_regm4xen_round_rate(struct clk_hw *hw,
343 unsigned long target_rate,
344 unsigned long *parent_rate);
345 int omap4_dpll_regm4xen_determine_rate(struct clk_hw *hw,
346 struct clk_rate_request *req);
348 extern struct ti_clk_ll_ops *ti_clk_ll_ops;