1 /* 2 * OMAP2/3 clockdomain framework functions 3 * 4 * Copyright (C) 2008, 2012 Texas Instruments, Inc. 5 * Copyright (C) 2008-2011 Nokia Corporation 6 * 7 * Paul Walmsley 8 * 9 * This program is free software; you can redistribute it and/or modify 10 * it under the terms of the GNU General Public License version 2 as 11 * published by the Free Software Foundation. 12 */ 13 14 #ifndef __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H 15 #define __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H 16 17 #include <linux/init.h> 18 19 #include "powerdomain.h" 20 #include "clock.h" 21 22 /* 23 * Clockdomain flags 24 * 25 * XXX Document CLKDM_CAN_* flags 26 * 27 * CLKDM_NO_AUTODEPS: Prevent "autodeps" from being added/removed from this 28 * clockdomain. (Currently, this applies to OMAP3 clockdomains only.) 29 * CLKDM_ACTIVE_WITH_MPU: The PRCM guarantees that this clockdomain is 30 * active whenever the MPU is active. True for interconnects and 31 * the WKUP clockdomains. 32 * CLKDM_MISSING_IDLE_REPORTING: The idle status of the IP blocks and 33 * clocks inside this clockdomain are not taken into account by 34 * the PRCM when determining whether the clockdomain is idle. 35 * Without this flag, if the clockdomain is set to 36 * hardware-supervised idle mode, the PRCM may transition the 37 * enclosing powerdomain to a low power state, even when devices 38 * inside the clockdomain and powerdomain are in use. (An example 39 * of such a clockdomain is the EMU clockdomain on OMAP3/4.) If 40 * this flag is set, and the clockdomain does not support the 41 * force-sleep mode, then the HW_AUTO mode will be used to put the 42 * clockdomain to sleep. Similarly, if the clockdomain supports 43 * the force-wakeup mode, then it will be used whenever a clock or 44 * IP block inside the clockdomain is active, rather than the 45 * HW_AUTO mode. 46 */ 47 #define CLKDM_CAN_FORCE_SLEEP (1 << 0) 48 #define CLKDM_CAN_FORCE_WAKEUP (1 << 1) 49 #define CLKDM_CAN_ENABLE_AUTO (1 << 2) 50 #define CLKDM_CAN_DISABLE_AUTO (1 << 3) 51 #define CLKDM_NO_AUTODEPS (1 << 4) 52 #define CLKDM_ACTIVE_WITH_MPU (1 << 5) 53 #define CLKDM_MISSING_IDLE_REPORTING (1 << 6) 54 55 #define CLKDM_CAN_HWSUP (CLKDM_CAN_ENABLE_AUTO | CLKDM_CAN_DISABLE_AUTO) 56 #define CLKDM_CAN_SWSUP (CLKDM_CAN_FORCE_SLEEP | CLKDM_CAN_FORCE_WAKEUP) 57 #define CLKDM_CAN_HWSUP_SWSUP (CLKDM_CAN_SWSUP | CLKDM_CAN_HWSUP) 58 59 /** 60 * struct clkdm_autodep - clkdm deps to add when entering/exiting hwsup mode 61 * @clkdm: clockdomain to add wkdep+sleepdep on - set name member only 62 * 63 * A clockdomain that should have wkdeps and sleepdeps added when a 64 * clockdomain should stay active in hwsup mode; and conversely, 65 * removed when the clockdomain should be allowed to go inactive in 66 * hwsup mode. 67 * 68 * Autodeps are deprecated and should be removed after 69 * omap_hwmod-based fine-grained module idle control is added. 70 */ 71 struct clkdm_autodep { 72 union { 73 const char *name; 74 struct clockdomain *ptr; 75 } clkdm; 76 }; 77 78 /** 79 * struct clkdm_dep - encode dependencies between clockdomains 80 * @clkdm_name: clockdomain name 81 * @clkdm: pointer to the struct clockdomain of @clkdm_name 82 * @wkdep_usecount: Number of wakeup dependencies causing this clkdm to wake 83 * @sleepdep_usecount: Number of sleep deps that could prevent clkdm from idle 84 * 85 * Statically defined. @clkdm is resolved from @clkdm_name at runtime and 86 * should not be pre-initialized. 87 * 88 * XXX Should also include hardware (fixed) dependencies. 89 */ 90 struct clkdm_dep { 91 const char *clkdm_name; 92 struct clockdomain *clkdm; 93 s16 wkdep_usecount; 94 s16 sleepdep_usecount; 95 }; 96 97 /* Possible flags for struct clockdomain._flags */ 98 #define _CLKDM_FLAG_HWSUP_ENABLED BIT(0) 99 100 struct omap_hwmod; 101 102 /** 103 * struct clockdomain - OMAP clockdomain 104 * @name: clockdomain name 105 * @pwrdm: powerdomain containing this clockdomain 106 * @clktrctrl_reg: CLKSTCTRL reg for the given clock domain 107 * @clktrctrl_mask: CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg 108 * @flags: Clockdomain capability flags 109 * @_flags: Flags for use only by internal clockdomain code 110 * @dep_bit: Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit 111 * @prcm_partition: (OMAP4 only) PRCM partition ID for this clkdm's registers 112 * @cm_inst: (OMAP4 only) CM instance register offset 113 * @clkdm_offs: (OMAP4 only) CM clockdomain register offset 114 * @wkdep_srcs: Clockdomains that can be told to wake this powerdomain up 115 * @sleepdep_srcs: Clockdomains that can be told to keep this clkdm from inact 116 * @usecount: Usecount tracking 117 * @node: list_head to link all clockdomains together 118 * 119 * @prcm_partition should be a macro from mach-omap2/prcm44xx.h (OMAP4 only) 120 * @cm_inst should be a macro ending in _INST from the OMAP4 CM instance 121 * definitions (OMAP4 only) 122 * @clkdm_offs should be a macro ending in _CDOFFS from the OMAP4 CM instance 123 * definitions (OMAP4 only) 124 */ 125 struct clockdomain { 126 const char *name; 127 union { 128 const char *name; 129 struct powerdomain *ptr; 130 } pwrdm; 131 const u16 clktrctrl_mask; 132 const u8 flags; 133 u8 _flags; 134 const u8 dep_bit; 135 const u8 prcm_partition; 136 const u16 cm_inst; 137 const u16 clkdm_offs; 138 struct clkdm_dep *wkdep_srcs; 139 struct clkdm_dep *sleepdep_srcs; 140 int usecount; 141 struct list_head node; 142 }; 143 144 /** 145 * struct clkdm_ops - Arch specific function implementations 146 * @clkdm_add_wkdep: Add a wakeup dependency between clk domains 147 * @clkdm_del_wkdep: Delete a wakeup dependency between clk domains 148 * @clkdm_read_wkdep: Read wakeup dependency state between clk domains 149 * @clkdm_clear_all_wkdeps: Remove all wakeup dependencies from the clk domain 150 * @clkdm_add_sleepdep: Add a sleep dependency between clk domains 151 * @clkdm_del_sleepdep: Delete a sleep dependency between clk domains 152 * @clkdm_read_sleepdep: Read sleep dependency state between clk domains 153 * @clkdm_clear_all_sleepdeps: Remove all sleep dependencies from the clk domain 154 * @clkdm_sleep: Force a clockdomain to sleep 155 * @clkdm_wakeup: Force a clockdomain to wakeup 156 * @clkdm_allow_idle: Enable hw supervised idle transitions for clock domain 157 * @clkdm_deny_idle: Disable hw supervised idle transitions for clock domain 158 * @clkdm_clk_enable: Put the clkdm in right state for a clock enable 159 * @clkdm_clk_disable: Put the clkdm in right state for a clock disable 160 */ 161 struct clkdm_ops { 162 int (*clkdm_add_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 163 int (*clkdm_del_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 164 int (*clkdm_read_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 165 int (*clkdm_clear_all_wkdeps)(struct clockdomain *clkdm); 166 int (*clkdm_add_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 167 int (*clkdm_del_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 168 int (*clkdm_read_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 169 int (*clkdm_clear_all_sleepdeps)(struct clockdomain *clkdm); 170 int (*clkdm_sleep)(struct clockdomain *clkdm); 171 int (*clkdm_wakeup)(struct clockdomain *clkdm); 172 void (*clkdm_allow_idle)(struct clockdomain *clkdm); 173 void (*clkdm_deny_idle)(struct clockdomain *clkdm); 174 int (*clkdm_clk_enable)(struct clockdomain *clkdm); 175 int (*clkdm_clk_disable)(struct clockdomain *clkdm); 176 }; 177 178 int clkdm_register_platform_funcs(struct clkdm_ops *co); 179 int clkdm_register_autodeps(struct clkdm_autodep *ia); 180 int clkdm_register_clkdms(struct clockdomain **c); 181 int clkdm_complete_init(void); 182 183 struct clockdomain *clkdm_lookup(const char *name); 184 185 int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user), 186 void *user); 187 struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm); 188 189 int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 190 int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 191 int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 192 int clkdm_clear_all_wkdeps(struct clockdomain *clkdm); 193 int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 194 int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 195 int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 196 int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm); 197 198 void clkdm_allow_idle_nolock(struct clockdomain *clkdm); 199 void clkdm_allow_idle(struct clockdomain *clkdm); 200 void clkdm_deny_idle_nolock(struct clockdomain *clkdm); 201 void clkdm_deny_idle(struct clockdomain *clkdm); 202 bool clkdm_in_hwsup(struct clockdomain *clkdm); 203 bool clkdm_missing_idle_reporting(struct clockdomain *clkdm); 204 205 int clkdm_wakeup_nolock(struct clockdomain *clkdm); 206 int clkdm_wakeup(struct clockdomain *clkdm); 207 int clkdm_sleep_nolock(struct clockdomain *clkdm); 208 int clkdm_sleep(struct clockdomain *clkdm); 209 210 int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk); 211 int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk); 212 int clkdm_hwmod_enable(struct clockdomain *clkdm, struct omap_hwmod *oh); 213 int clkdm_hwmod_disable(struct clockdomain *clkdm, struct omap_hwmod *oh); 214 215 extern void __init omap242x_clockdomains_init(void); 216 extern void __init omap243x_clockdomains_init(void); 217 extern void __init omap3xxx_clockdomains_init(void); 218 extern void __init am33xx_clockdomains_init(void); 219 extern void __init omap44xx_clockdomains_init(void); 220 extern void __init omap54xx_clockdomains_init(void); 221 extern void __init dra7xx_clockdomains_init(void); 222 void am43xx_clockdomains_init(void); 223 224 extern void clkdm_add_autodeps(struct clockdomain *clkdm); 225 extern void clkdm_del_autodeps(struct clockdomain *clkdm); 226 227 extern struct clkdm_ops omap2_clkdm_operations; 228 extern struct clkdm_ops omap3_clkdm_operations; 229 extern struct clkdm_ops omap4_clkdm_operations; 230 extern struct clkdm_ops am33xx_clkdm_operations; 231 extern struct clkdm_ops am43xx_clkdm_operations; 232 233 extern struct clkdm_dep gfx_24xx_wkdeps[]; 234 extern struct clkdm_dep dsp_24xx_wkdeps[]; 235 extern struct clockdomain wkup_common_clkdm; 236 237 #endif 238