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