Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 1 | /* |
Paul Walmsley | 93340a2 | 2010-02-22 22:09:12 -0700 | [diff] [blame^] | 2 | * OMAP clock: data structure definitions, function prototypes, shared macros |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 3 | * |
Paul Walmsley | 93340a2 | 2010-02-22 22:09:12 -0700 | [diff] [blame^] | 4 | * Copyright (C) 2004-2005, 2008-2010 Nokia Corporation |
| 5 | * Written by Tuukka Tikkanen <tuukka.tikkanen@elektrobit.com> |
| 6 | * Based on clocks.h by Tony Lindgren, Gordon McNutt and RidgeRun, Inc |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 7 | * |
| 8 | * This program is free software; you can redistribute it and/or modify |
| 9 | * it under the terms of the GNU General Public License version 2 as |
| 10 | * published by the Free Software Foundation. |
| 11 | */ |
| 12 | |
| 13 | #ifndef __ARCH_ARM_OMAP_CLOCK_H |
| 14 | #define __ARCH_ARM_OMAP_CLOCK_H |
| 15 | |
Paul Walmsley | d8a9445 | 2009-12-08 16:21:29 -0700 | [diff] [blame] | 16 | #include <linux/list.h> |
| 17 | |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 18 | struct module; |
| 19 | struct clk; |
Paul Walmsley | d1b03f6 | 2008-08-19 11:08:44 +0300 | [diff] [blame] | 20 | struct clockdomain; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 21 | |
Russell King | 548d849 | 2008-11-04 14:02:46 +0000 | [diff] [blame] | 22 | struct clkops { |
| 23 | int (*enable)(struct clk *); |
| 24 | void (*disable)(struct clk *); |
Ranjith Lohithakshan | 419cc97 | 2010-02-24 12:05:54 -0700 | [diff] [blame] | 25 | void (*find_idlest)(struct clk *, void __iomem **, |
| 26 | u8 *, u8 *); |
| 27 | void (*find_companion)(struct clk *, void __iomem **, |
| 28 | u8 *); |
Russell King | 548d849 | 2008-11-04 14:02:46 +0000 | [diff] [blame] | 29 | }; |
| 30 | |
Tony Lindgren | 140455f | 2010-02-12 12:26:48 -0800 | [diff] [blame] | 31 | #ifdef CONFIG_ARCH_OMAP2PLUS |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 32 | |
| 33 | struct clksel_rate { |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 34 | u32 val; |
Russell King | ebb8dca | 2008-11-04 21:50:46 +0000 | [diff] [blame] | 35 | u8 div; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 36 | u8 flags; |
| 37 | }; |
| 38 | |
| 39 | struct clksel { |
| 40 | struct clk *parent; |
| 41 | const struct clksel_rate *rates; |
| 42 | }; |
| 43 | |
Paul Walmsley | 93340a2 | 2010-02-22 22:09:12 -0700 | [diff] [blame^] | 44 | /** |
| 45 | * struct dpll_data - DPLL registers and integration data |
| 46 | * @mult_div1_reg: register containing the DPLL M and N bitfields |
| 47 | * @mult_mask: mask of the DPLL M bitfield in @mult_div1_reg |
| 48 | * @div1_mask: mask of the DPLL N bitfield in @mult_div1_reg |
| 49 | * @clk_bypass: struct clk pointer to the clock's bypass clock input |
| 50 | * @clk_ref: struct clk pointer to the clock's reference clock input |
| 51 | * @control_reg: register containing the DPLL mode bitfield |
| 52 | * @enable_mask: mask of the DPLL mode bitfield in @control_reg |
| 53 | * @rate_tolerance: maximum variance allowed from target rate (in Hz) |
| 54 | * @last_rounded_rate: cache of the last rate result of omap2_dpll_round_rate() |
| 55 | * @last_rounded_m: cache of the last M result of omap2_dpll_round_rate() |
| 56 | * @max_multiplier: maximum valid non-bypass multiplier value (actual) |
| 57 | * @last_rounded_n: cache of the last N result of omap2_dpll_round_rate() |
| 58 | * @min_divider: minimum valid non-bypass divider value (actual) |
| 59 | * @max_divider: maximum valid non-bypass divider value (actual) |
| 60 | * @modes: possible values of @enable_mask |
| 61 | * @autoidle_reg: register containing the DPLL autoidle mode bitfield |
| 62 | * @idlest_reg: register containing the DPLL idle status bitfield |
| 63 | * @autoidle_mask: mask of the DPLL autoidle mode bitfield in @autoidle_reg |
| 64 | * @freqsel_mask: mask of the DPLL jitter correction bitfield in @control_reg |
| 65 | * @idlest_mask: mask of the DPLL idle status bitfield in @idlest_reg |
| 66 | * @auto_recal_bit: bitshift of the driftguard enable bit in @control_reg |
| 67 | * @recal_en_bit: bitshift of the PRM_IRQENABLE_* bit for recalibration IRQs |
| 68 | * @recal_st_bit: bitshift of the PRM_IRQSTATUS_* bit for recalibration IRQs |
| 69 | * @flags: DPLL type/features (see below) |
| 70 | * |
| 71 | * Possible values for @flags: |
| 72 | * DPLL_J_TYPE: "J-type DPLL" (only some 36xx, 4xxx DPLLs) |
| 73 | * NO_DCO_SEL: don't program DCO (only for some J-type DPLLs) |
| 74 | |
| 75 | * @freqsel_mask is only used on the OMAP34xx family and AM35xx. |
| 76 | * |
| 77 | * XXX Some DPLLs have multiple bypass inputs, so it's not technically |
| 78 | * correct to only have one @clk_bypass pointer. |
| 79 | * |
| 80 | * XXX @rate_tolerance should probably be deprecated - currently there |
| 81 | * don't seem to be any usecases for DPLL rounding that is not exact. |
| 82 | * |
| 83 | * XXX The runtime-variable fields (@last_rounded_rate, @last_rounded_m, |
| 84 | * @last_rounded_n) should be separated from the runtime-fixed fields |
| 85 | * and placed into a differenct structure, so that the runtime-fixed data |
| 86 | * can be placed into read-only space. |
Richard Woodruff | 358965d | 2010-02-22 22:09:08 -0700 | [diff] [blame] | 87 | */ |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 88 | struct dpll_data { |
| 89 | void __iomem *mult_div1_reg; |
| 90 | u32 mult_mask; |
| 91 | u32 div1_mask; |
Russell King | c0bf313 | 2009-02-19 13:29:22 +0000 | [diff] [blame] | 92 | struct clk *clk_bypass; |
| 93 | struct clk *clk_ref; |
| 94 | void __iomem *control_reg; |
| 95 | u32 enable_mask; |
Russell King | ebb8dca | 2008-11-04 21:50:46 +0000 | [diff] [blame] | 96 | unsigned int rate_tolerance; |
| 97 | unsigned long last_rounded_rate; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 98 | u16 last_rounded_m; |
Paul Walmsley | 93340a2 | 2010-02-22 22:09:12 -0700 | [diff] [blame^] | 99 | u16 max_multiplier; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 100 | u8 last_rounded_n; |
Paul Walmsley | 95f538a | 2009-01-28 12:08:44 -0700 | [diff] [blame] | 101 | u8 min_divider; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 102 | u8 max_divider; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 103 | u8 modes; |
Paul Walmsley | 93340a2 | 2010-02-22 22:09:12 -0700 | [diff] [blame^] | 104 | #if defined(CONFIG_ARCH_OMAP3) || defined(CONFIG_ARCH_OMAP4) |
Russell King | ebb8dca | 2008-11-04 21:50:46 +0000 | [diff] [blame] | 105 | void __iomem *autoidle_reg; |
| 106 | void __iomem *idlest_reg; |
Russell King | ebb8dca | 2008-11-04 21:50:46 +0000 | [diff] [blame] | 107 | u32 autoidle_mask; |
Paul Walmsley | 16c90f0 | 2009-01-27 19:12:47 -0700 | [diff] [blame] | 108 | u32 freqsel_mask; |
Paul Walmsley | c1bd7aa | 2009-01-28 12:08:17 -0700 | [diff] [blame] | 109 | u32 idlest_mask; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 110 | u8 auto_recal_bit; |
| 111 | u8 recal_en_bit; |
| 112 | u8 recal_st_bit; |
Richard Woodruff | 358965d | 2010-02-22 22:09:08 -0700 | [diff] [blame] | 113 | u8 flags; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 114 | # endif |
| 115 | }; |
| 116 | |
| 117 | #endif |
| 118 | |
| 119 | struct clk { |
| 120 | struct list_head node; |
Russell King | 548d849 | 2008-11-04 14:02:46 +0000 | [diff] [blame] | 121 | const struct clkops *ops; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 122 | const char *name; |
| 123 | int id; |
| 124 | struct clk *parent; |
Russell King | 3f0a820 | 2009-01-31 10:05:51 +0000 | [diff] [blame] | 125 | struct list_head children; |
| 126 | struct list_head sibling; /* node for children */ |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 127 | unsigned long rate; |
| 128 | __u32 flags; |
| 129 | void __iomem *enable_reg; |
Russell King | 8b9dbc1 | 2009-02-12 10:12:59 +0000 | [diff] [blame] | 130 | unsigned long (*recalc)(struct clk *); |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 131 | int (*set_rate)(struct clk *, unsigned long); |
| 132 | long (*round_rate)(struct clk *, unsigned long); |
| 133 | void (*init)(struct clk *); |
Russell King | ebb8dca | 2008-11-04 21:50:46 +0000 | [diff] [blame] | 134 | __u8 enable_bit; |
| 135 | __s8 usecount; |
Paul Walmsley | e9b98f6 | 2010-01-26 20:12:57 -0700 | [diff] [blame] | 136 | u8 fixed_div; |
Tony Lindgren | 140455f | 2010-02-12 12:26:48 -0800 | [diff] [blame] | 137 | #ifdef CONFIG_ARCH_OMAP2PLUS |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 138 | void __iomem *clksel_reg; |
| 139 | u32 clksel_mask; |
| 140 | const struct clksel *clksel; |
| 141 | struct dpll_data *dpll_data; |
Paul Walmsley | d1b03f6 | 2008-08-19 11:08:44 +0300 | [diff] [blame] | 142 | const char *clkdm_name; |
| 143 | struct clockdomain *clkdm; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 144 | #else |
| 145 | __u8 rate_offset; |
| 146 | __u8 src_offset; |
| 147 | #endif |
| 148 | #if defined(CONFIG_PM_DEBUG) && defined(CONFIG_DEBUG_FS) |
| 149 | struct dentry *dent; /* For visible tree hierarchy */ |
| 150 | #endif |
| 151 | }; |
| 152 | |
| 153 | struct cpufreq_frequency_table; |
| 154 | |
| 155 | struct clk_functions { |
| 156 | int (*clk_enable)(struct clk *clk); |
| 157 | void (*clk_disable)(struct clk *clk); |
| 158 | long (*clk_round_rate)(struct clk *clk, unsigned long rate); |
| 159 | int (*clk_set_rate)(struct clk *clk, unsigned long rate); |
| 160 | int (*clk_set_parent)(struct clk *clk, struct clk *parent); |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 161 | void (*clk_allow_idle)(struct clk *clk); |
| 162 | void (*clk_deny_idle)(struct clk *clk); |
| 163 | void (*clk_disable_unused)(struct clk *clk); |
| 164 | #ifdef CONFIG_CPU_FREQ |
| 165 | void (*clk_init_cpufreq_table)(struct cpufreq_frequency_table **); |
Paul Walmsley | 4e37c10 | 2010-01-08 15:23:16 -0700 | [diff] [blame] | 166 | void (*clk_exit_cpufreq_table)(struct cpufreq_frequency_table **); |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 167 | #endif |
| 168 | }; |
| 169 | |
Paul Walmsley | d373019 | 2010-01-26 20:13:11 -0700 | [diff] [blame] | 170 | extern int mpurate; |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 171 | |
Paul Walmsley | fecb494 | 2009-01-27 19:12:50 -0700 | [diff] [blame] | 172 | extern int clk_init(struct clk_functions *custom_clocks); |
Paul Walmsley | 7971687 | 2009-05-12 17:50:30 -0600 | [diff] [blame] | 173 | extern void clk_preinit(struct clk *clk); |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 174 | extern int clk_register(struct clk *clk); |
Russell King | 3f0a820 | 2009-01-31 10:05:51 +0000 | [diff] [blame] | 175 | extern void clk_reparent(struct clk *child, struct clk *parent); |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 176 | extern void clk_unregister(struct clk *clk); |
| 177 | extern void propagate_rate(struct clk *clk); |
| 178 | extern void recalculate_root_clocks(void); |
Russell King | 8b9dbc1 | 2009-02-12 10:12:59 +0000 | [diff] [blame] | 179 | extern unsigned long followparent_recalc(struct clk *clk); |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 180 | extern void clk_enable_init_clocks(void); |
Paul Walmsley | e9b98f6 | 2010-01-26 20:12:57 -0700 | [diff] [blame] | 181 | unsigned long omap_fixed_divisor_recalc(struct clk *clk); |
Kevin Hilman | aeec299 | 2009-01-27 19:13:38 -0700 | [diff] [blame] | 182 | #ifdef CONFIG_CPU_FREQ |
| 183 | extern void clk_init_cpufreq_table(struct cpufreq_frequency_table **table); |
Paul Walmsley | 4e37c10 | 2010-01-08 15:23:16 -0700 | [diff] [blame] | 184 | extern void clk_exit_cpufreq_table(struct cpufreq_frequency_table **table); |
Kevin Hilman | aeec299 | 2009-01-27 19:13:38 -0700 | [diff] [blame] | 185 | #endif |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 186 | |
Russell King | 897dcde | 2008-11-04 16:35:03 +0000 | [diff] [blame] | 187 | extern const struct clkops clkops_null; |
| 188 | |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 189 | /* Clock flags */ |
Russell King | d5e6072 | 2009-02-08 16:07:46 +0000 | [diff] [blame] | 190 | /* bit 0 is free */ |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 191 | #define RATE_FIXED (1 << 1) /* Fixed clock rate */ |
Russell King | 3f0a820 | 2009-01-31 10:05:51 +0000 | [diff] [blame] | 192 | /* bits 2-4 are free */ |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 193 | #define ENABLE_REG_32BIT (1 << 5) /* Use 32-bit access */ |
Paul Walmsley | 93340a2 | 2010-02-22 22:09:12 -0700 | [diff] [blame^] | 194 | /* bit 6 is free */ |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 195 | #define CLOCK_IDLE_CONTROL (1 << 7) |
| 196 | #define CLOCK_NO_IDLE_PARENT (1 << 8) |
| 197 | #define DELAYED_APP (1 << 9) /* Delay application of clock */ |
| 198 | #define CONFIG_PARTICIPANT (1 << 10) /* Fundamental clock */ |
| 199 | #define ENABLE_ON_INIT (1 << 11) /* Enable upon framework init */ |
| 200 | #define INVERT_ENABLE (1 << 12) /* 0 enables, 1 disables */ |
Rajendra Nayak | 972c542 | 2009-12-08 18:46:28 -0700 | [diff] [blame] | 201 | #define CLOCK_IN_OMAP4430 (1 << 13) |
| 202 | #define ALWAYS_ENABLED (1 << 14) |
Paul Walmsley | 93340a2 | 2010-02-22 22:09:12 -0700 | [diff] [blame^] | 203 | /* bits 15-31 are currently free */ |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 204 | |
| 205 | /* Clksel_rate flags */ |
| 206 | #define DEFAULT_RATE (1 << 0) |
| 207 | #define RATE_IN_242X (1 << 1) |
| 208 | #define RATE_IN_243X (1 << 2) |
| 209 | #define RATE_IN_343X (1 << 3) /* rates common to all 343X */ |
Paul Walmsley | 93340a2 | 2010-02-22 22:09:12 -0700 | [diff] [blame^] | 210 | #define RATE_IN_3430ES2 (1 << 4) /* 3430ES2 rates only */ |
Vishwanath BS | 678bc9a | 2010-02-22 22:09:09 -0700 | [diff] [blame] | 211 | #define RATE_IN_36XX (1 << 5) |
| 212 | #define RATE_IN_4430 (1 << 6) |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 213 | |
| 214 | #define RATE_IN_24XX (RATE_IN_242X | RATE_IN_243X) |
| 215 | |
| 216 | |
Russell King | a09e64f | 2008-08-05 16:14:15 +0100 | [diff] [blame] | 217 | #endif |