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