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 */ 35 #define CLKDM_CAN_FORCE_SLEEP (1 << 0) 36 #define CLKDM_CAN_FORCE_WAKEUP (1 << 1) 37 #define CLKDM_CAN_ENABLE_AUTO (1 << 2) 38 #define CLKDM_CAN_DISABLE_AUTO (1 << 3) 39 #define CLKDM_NO_AUTODEPS (1 << 4) 40 41 #define CLKDM_CAN_HWSUP (CLKDM_CAN_ENABLE_AUTO | CLKDM_CAN_DISABLE_AUTO) 42 #define CLKDM_CAN_SWSUP (CLKDM_CAN_FORCE_SLEEP | CLKDM_CAN_FORCE_WAKEUP) 43 #define CLKDM_CAN_HWSUP_SWSUP (CLKDM_CAN_SWSUP | CLKDM_CAN_HWSUP) 44 45 /** 46 * struct clkdm_autodep - clkdm deps to add when entering/exiting hwsup mode 47 * @clkdm: clockdomain to add wkdep+sleepdep on - set name member only 48 * @omap_chip: OMAP chip types that this autodep is valid on 49 * 50 * A clockdomain that should have wkdeps and sleepdeps added when a 51 * clockdomain should stay active in hwsup mode; and conversely, 52 * removed when the clockdomain should be allowed to go inactive in 53 * hwsup mode. 54 * 55 * Autodeps are deprecated and should be removed after 56 * omap_hwmod-based fine-grained module idle control is added. 57 */ 58 struct clkdm_autodep { 59 union { 60 const char *name; 61 struct clockdomain *ptr; 62 } clkdm; 63 const struct omap_chip_id omap_chip; 64 }; 65 66 /** 67 * struct clkdm_dep - encode dependencies between clockdomains 68 * @clkdm_name: clockdomain name 69 * @clkdm: pointer to the struct clockdomain of @clkdm_name 70 * @omap_chip: OMAP chip types that this dependency is valid on 71 * @wkdep_usecount: Number of wakeup dependencies causing this clkdm to wake 72 * @sleepdep_usecount: Number of sleep deps that could prevent clkdm from idle 73 * 74 * Statically defined. @clkdm is resolved from @clkdm_name at runtime and 75 * should not be pre-initialized. 76 * 77 * XXX Should also include hardware (fixed) dependencies. 78 */ 79 struct clkdm_dep { 80 const char *clkdm_name; 81 struct clockdomain *clkdm; 82 atomic_t wkdep_usecount; 83 atomic_t sleepdep_usecount; 84 const struct omap_chip_id omap_chip; 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 * @omap_chip: OMAP chip types that this clockdomain is valid on 105 * @usecount: Usecount tracking 106 * @node: list_head to link all clockdomains together 107 * 108 * @prcm_partition should be a macro from mach-omap2/prcm44xx.h (OMAP4 only) 109 * @cm_inst should be a macro ending in _INST from the OMAP4 CM instance 110 * definitions (OMAP4 only) 111 * @clkdm_offs should be a macro ending in _CDOFFS from the OMAP4 CM instance 112 * definitions (OMAP4 only) 113 */ 114 struct clockdomain { 115 const char *name; 116 union { 117 const char *name; 118 struct powerdomain *ptr; 119 } pwrdm; 120 const u16 clktrctrl_mask; 121 const u8 flags; 122 u8 _flags; 123 const u8 dep_bit; 124 const u8 prcm_partition; 125 const s16 cm_inst; 126 const u16 clkdm_offs; 127 struct clkdm_dep *wkdep_srcs; 128 struct clkdm_dep *sleepdep_srcs; 129 const struct omap_chip_id omap_chip; 130 atomic_t usecount; 131 struct list_head node; 132 spinlock_t lock; 133 }; 134 135 /** 136 * struct clkdm_ops - Arch specific function implementations 137 * @clkdm_add_wkdep: Add a wakeup dependency between clk domains 138 * @clkdm_del_wkdep: Delete a wakeup dependency between clk domains 139 * @clkdm_read_wkdep: Read wakeup dependency state between clk domains 140 * @clkdm_clear_all_wkdeps: Remove all wakeup dependencies from the clk domain 141 * @clkdm_add_sleepdep: Add a sleep dependency between clk domains 142 * @clkdm_del_sleepdep: Delete a sleep dependency between clk domains 143 * @clkdm_read_sleepdep: Read sleep dependency state between clk domains 144 * @clkdm_clear_all_sleepdeps: Remove all sleep dependencies from the clk domain 145 * @clkdm_sleep: Force a clockdomain to sleep 146 * @clkdm_wakeup: Force a clockdomain to wakeup 147 * @clkdm_allow_idle: Enable hw supervised idle transitions for clock domain 148 * @clkdm_deny_idle: Disable hw supervised idle transitions for clock domain 149 * @clkdm_clk_enable: Put the clkdm in right state for a clock enable 150 * @clkdm_clk_disable: Put the clkdm in right state for a clock disable 151 */ 152 struct clkdm_ops { 153 int (*clkdm_add_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 154 int (*clkdm_del_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 155 int (*clkdm_read_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 156 int (*clkdm_clear_all_wkdeps)(struct clockdomain *clkdm); 157 int (*clkdm_add_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 158 int (*clkdm_del_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 159 int (*clkdm_read_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 160 int (*clkdm_clear_all_sleepdeps)(struct clockdomain *clkdm); 161 int (*clkdm_sleep)(struct clockdomain *clkdm); 162 int (*clkdm_wakeup)(struct clockdomain *clkdm); 163 void (*clkdm_allow_idle)(struct clockdomain *clkdm); 164 void (*clkdm_deny_idle)(struct clockdomain *clkdm); 165 int (*clkdm_clk_enable)(struct clockdomain *clkdm); 166 int (*clkdm_clk_disable)(struct clockdomain *clkdm); 167 }; 168 169 void clkdm_init(struct clockdomain **clkdms, struct clkdm_autodep *autodeps, 170 struct clkdm_ops *custom_funcs); 171 struct clockdomain *clkdm_lookup(const char *name); 172 173 int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user), 174 void *user); 175 struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm); 176 177 int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 178 int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 179 int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 180 int clkdm_clear_all_wkdeps(struct clockdomain *clkdm); 181 int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 182 int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 183 int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); 184 int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm); 185 186 void clkdm_allow_idle(struct clockdomain *clkdm); 187 void clkdm_deny_idle(struct clockdomain *clkdm); 188 bool clkdm_in_hwsup(struct clockdomain *clkdm); 189 190 int clkdm_wakeup(struct clockdomain *clkdm); 191 int clkdm_sleep(struct clockdomain *clkdm); 192 193 int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk); 194 int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk); 195 int clkdm_hwmod_enable(struct clockdomain *clkdm, struct omap_hwmod *oh); 196 int clkdm_hwmod_disable(struct clockdomain *clkdm, struct omap_hwmod *oh); 197 198 extern void __init omap2xxx_clockdomains_init(void); 199 extern void __init omap3xxx_clockdomains_init(void); 200 extern void __init omap44xx_clockdomains_init(void); 201 extern void _clkdm_add_autodeps(struct clockdomain *clkdm); 202 extern void _clkdm_del_autodeps(struct clockdomain *clkdm); 203 204 extern struct clkdm_ops omap2_clkdm_operations; 205 extern struct clkdm_ops omap3_clkdm_operations; 206 extern struct clkdm_ops omap4_clkdm_operations; 207 208 #endif 209