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