Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 1 | /* |
Paul Walmsley | 5b74c67 | 2009-02-03 02:10:03 -0700 | [diff] [blame] | 2 | * arch/arm/plat-omap/include/mach/clockdomain.h |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 3 | * |
| 4 | * OMAP2/3 clockdomain framework functions |
| 5 | * |
| 6 | * Copyright (C) 2008 Texas Instruments, Inc. |
Paul Walmsley | 570b54c | 2011-03-10 03:50:09 -0700 | [diff] [blame] | 7 | * Copyright (C) 2008-2011 Nokia Corporation |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 8 | * |
Paul Walmsley | dc0b3a7 | 2010-12-21 20:01:20 -0700 | [diff] [blame] | 9 | * Paul Walmsley |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 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 | |
Paul Walmsley | 1540f214 | 2010-12-21 21:05:15 -0700 | [diff] [blame] | 16 | #ifndef __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H |
| 17 | #define __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 18 | |
Paul Walmsley | dc0b3a7 | 2010-12-21 20:01:20 -0700 | [diff] [blame] | 19 | #include <linux/init.h> |
Rajendra Nayak | 555e74e | 2011-07-10 05:56:55 -0600 | [diff] [blame] | 20 | #include <linux/spinlock.h> |
Paul Walmsley | dc0b3a7 | 2010-12-21 20:01:20 -0700 | [diff] [blame] | 21 | |
Paul Walmsley | 72e06d0 | 2010-12-21 21:05:16 -0700 | [diff] [blame] | 22 | #include "powerdomain.h" |
Tony Lindgren | ce491cf | 2009-10-20 09:40:47 -0700 | [diff] [blame] | 23 | #include <plat/clock.h> |
Benoit Cousson | 113a741 | 2011-07-10 05:56:54 -0600 | [diff] [blame] | 24 | #include <plat/omap_hwmod.h> |
Tony Lindgren | ce491cf | 2009-10-20 09:40:47 -0700 | [diff] [blame] | 25 | #include <plat/cpu.h> |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 26 | |
Paul Walmsley | 570b54c | 2011-03-10 03:50:09 -0700 | [diff] [blame] | 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 | */ |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 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) |
Paul Walmsley | 570b54c | 2011-03-10 03:50:09 -0700 | [diff] [blame] | 39 | #define CLKDM_NO_AUTODEPS (1 << 4) |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 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 | |
Paul Walmsley | f0271d6 | 2010-01-26 20:13:02 -0700 | [diff] [blame] | 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 |
Paul Walmsley | f0271d6 | 2010-01-26 20:13:02 -0700 | [diff] [blame] | 48 | * |
| 49 | * A clockdomain that should have wkdeps and sleepdeps added when a |
| 50 | * clockdomain should stay active in hwsup mode; and conversely, |
| 51 | * removed when the clockdomain should be allowed to go inactive in |
| 52 | * hwsup mode. |
| 53 | * |
| 54 | * Autodeps are deprecated and should be removed after |
| 55 | * omap_hwmod-based fine-grained module idle control is added. |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 56 | */ |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 57 | struct clkdm_autodep { |
Paul Walmsley | 5b74c67 | 2009-02-03 02:10:03 -0700 | [diff] [blame] | 58 | union { |
Paul Walmsley | 5b74c67 | 2009-02-03 02:10:03 -0700 | [diff] [blame] | 59 | const char *name; |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 60 | struct clockdomain *ptr; |
| 61 | } clkdm; |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 62 | }; |
| 63 | |
Paul Walmsley | f0271d6 | 2010-01-26 20:13:02 -0700 | [diff] [blame] | 64 | /** |
| 65 | * struct clkdm_dep - encode dependencies between clockdomains |
| 66 | * @clkdm_name: clockdomain name |
| 67 | * @clkdm: pointer to the struct clockdomain of @clkdm_name |
Paul Walmsley | f0271d6 | 2010-01-26 20:13:02 -0700 | [diff] [blame] | 68 | * @wkdep_usecount: Number of wakeup dependencies causing this clkdm to wake |
| 69 | * @sleepdep_usecount: Number of sleep deps that could prevent clkdm from idle |
| 70 | * |
| 71 | * Statically defined. @clkdm is resolved from @clkdm_name at runtime and |
| 72 | * should not be pre-initialized. |
| 73 | * |
| 74 | * XXX Should also include hardware (fixed) dependencies. |
| 75 | */ |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 76 | struct clkdm_dep { |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 77 | const char *clkdm_name; |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 78 | struct clockdomain *clkdm; |
Paul Walmsley | 369d561 | 2010-01-26 20:13:01 -0700 | [diff] [blame] | 79 | atomic_t wkdep_usecount; |
Paul Walmsley | 369d561 | 2010-01-26 20:13:01 -0700 | [diff] [blame] | 80 | atomic_t sleepdep_usecount; |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 81 | }; |
| 82 | |
Paul Walmsley | 32a363c | 2011-07-10 05:56:54 -0600 | [diff] [blame] | 83 | /* Possible flags for struct clockdomain._flags */ |
| 84 | #define _CLKDM_FLAG_HWSUP_ENABLED BIT(0) |
| 85 | |
Paul Walmsley | f0271d6 | 2010-01-26 20:13:02 -0700 | [diff] [blame] | 86 | /** |
| 87 | * struct clockdomain - OMAP clockdomain |
| 88 | * @name: clockdomain name |
| 89 | * @pwrdm: powerdomain containing this clockdomain |
| 90 | * @clktrctrl_reg: CLKSTCTRL reg for the given clock domain |
| 91 | * @clktrctrl_mask: CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg |
| 92 | * @flags: Clockdomain capability flags |
Paul Walmsley | 32a363c | 2011-07-10 05:56:54 -0600 | [diff] [blame] | 93 | * @_flags: Flags for use only by internal clockdomain code |
Paul Walmsley | f0271d6 | 2010-01-26 20:13:02 -0700 | [diff] [blame] | 94 | * @dep_bit: Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit |
Paul Walmsley | bd2122c | 2010-12-21 21:05:15 -0700 | [diff] [blame] | 95 | * @prcm_partition: (OMAP4 only) PRCM partition ID for this clkdm's registers |
| 96 | * @cm_inst: (OMAP4 only) CM instance register offset |
| 97 | * @clkdm_offs: (OMAP4 only) CM clockdomain register offset |
Paul Walmsley | f0271d6 | 2010-01-26 20:13:02 -0700 | [diff] [blame] | 98 | * @wkdep_srcs: Clockdomains that can be told to wake this powerdomain up |
| 99 | * @sleepdep_srcs: Clockdomains that can be told to keep this clkdm from inact |
Paul Walmsley | f0271d6 | 2010-01-26 20:13:02 -0700 | [diff] [blame] | 100 | * @usecount: Usecount tracking |
| 101 | * @node: list_head to link all clockdomains together |
Paul Walmsley | bd2122c | 2010-12-21 21:05:15 -0700 | [diff] [blame] | 102 | * |
| 103 | * @prcm_partition should be a macro from mach-omap2/prcm44xx.h (OMAP4 only) |
| 104 | * @cm_inst should be a macro ending in _INST from the OMAP4 CM instance |
| 105 | * definitions (OMAP4 only) |
| 106 | * @clkdm_offs should be a macro ending in _CDOFFS from the OMAP4 CM instance |
| 107 | * definitions (OMAP4 only) |
Paul Walmsley | f0271d6 | 2010-01-26 20:13:02 -0700 | [diff] [blame] | 108 | */ |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 109 | struct clockdomain { |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 110 | const char *name; |
Paul Walmsley | 5b74c67 | 2009-02-03 02:10:03 -0700 | [diff] [blame] | 111 | union { |
Paul Walmsley | 5b74c67 | 2009-02-03 02:10:03 -0700 | [diff] [blame] | 112 | const char *name; |
Paul Walmsley | 5b74c67 | 2009-02-03 02:10:03 -0700 | [diff] [blame] | 113 | struct powerdomain *ptr; |
| 114 | } pwrdm; |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 115 | const u16 clktrctrl_mask; |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 116 | const u8 flags; |
Paul Walmsley | 32a363c | 2011-07-10 05:56:54 -0600 | [diff] [blame] | 117 | u8 _flags; |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 118 | const u8 dep_bit; |
Paul Walmsley | bd2122c | 2010-12-21 21:05:15 -0700 | [diff] [blame] | 119 | const u8 prcm_partition; |
| 120 | const s16 cm_inst; |
| 121 | const u16 clkdm_offs; |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 122 | struct clkdm_dep *wkdep_srcs; |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 123 | struct clkdm_dep *sleepdep_srcs; |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 124 | atomic_t usecount; |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 125 | struct list_head node; |
Rajendra Nayak | 555e74e | 2011-07-10 05:56:55 -0600 | [diff] [blame] | 126 | spinlock_t lock; |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 127 | }; |
| 128 | |
Rajendra Nayak | 32d4034 | 2011-02-25 16:06:47 -0700 | [diff] [blame] | 129 | /** |
Lucas De Marchi | 25985ed | 2011-03-30 22:57:33 -0300 | [diff] [blame] | 130 | * struct clkdm_ops - Arch specific function implementations |
Rajendra Nayak | 32d4034 | 2011-02-25 16:06:47 -0700 | [diff] [blame] | 131 | * @clkdm_add_wkdep: Add a wakeup dependency between clk domains |
| 132 | * @clkdm_del_wkdep: Delete a wakeup dependency between clk domains |
| 133 | * @clkdm_read_wkdep: Read wakeup dependency state between clk domains |
| 134 | * @clkdm_clear_all_wkdeps: Remove all wakeup dependencies from the clk domain |
| 135 | * @clkdm_add_sleepdep: Add a sleep dependency between clk domains |
| 136 | * @clkdm_del_sleepdep: Delete a sleep dependency between clk domains |
| 137 | * @clkdm_read_sleepdep: Read sleep dependency state between clk domains |
| 138 | * @clkdm_clear_all_sleepdeps: Remove all sleep dependencies from the clk domain |
| 139 | * @clkdm_sleep: Force a clockdomain to sleep |
| 140 | * @clkdm_wakeup: Force a clockdomain to wakeup |
| 141 | * @clkdm_allow_idle: Enable hw supervised idle transitions for clock domain |
| 142 | * @clkdm_deny_idle: Disable hw supervised idle transitions for clock domain |
| 143 | * @clkdm_clk_enable: Put the clkdm in right state for a clock enable |
| 144 | * @clkdm_clk_disable: Put the clkdm in right state for a clock disable |
| 145 | */ |
| 146 | struct clkdm_ops { |
| 147 | int (*clkdm_add_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
| 148 | int (*clkdm_del_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
| 149 | int (*clkdm_read_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
| 150 | int (*clkdm_clear_all_wkdeps)(struct clockdomain *clkdm); |
| 151 | int (*clkdm_add_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
| 152 | int (*clkdm_del_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
| 153 | int (*clkdm_read_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
| 154 | int (*clkdm_clear_all_sleepdeps)(struct clockdomain *clkdm); |
| 155 | int (*clkdm_sleep)(struct clockdomain *clkdm); |
| 156 | int (*clkdm_wakeup)(struct clockdomain *clkdm); |
| 157 | void (*clkdm_allow_idle)(struct clockdomain *clkdm); |
| 158 | void (*clkdm_deny_idle)(struct clockdomain *clkdm); |
| 159 | int (*clkdm_clk_enable)(struct clockdomain *clkdm); |
| 160 | int (*clkdm_clk_disable)(struct clockdomain *clkdm); |
| 161 | }; |
| 162 | |
Paul Walmsley | 08cb970 | 2011-09-14 16:01:20 -0600 | [diff] [blame] | 163 | int clkdm_register_platform_funcs(struct clkdm_ops *co); |
| 164 | int clkdm_register_autodeps(struct clkdm_autodep *ia); |
| 165 | int clkdm_register_clkdms(struct clockdomain **c); |
| 166 | int clkdm_complete_init(void); |
| 167 | |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 168 | struct clockdomain *clkdm_lookup(const char *name); |
| 169 | |
Peter 'p2' De Schrijver | a23456e | 2008-10-15 18:13:47 +0300 | [diff] [blame] | 170 | int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user), |
| 171 | void *user); |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 172 | struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm); |
| 173 | |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 174 | int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
| 175 | int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
| 176 | int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
Paul Walmsley | 369d561 | 2010-01-26 20:13:01 -0700 | [diff] [blame] | 177 | int clkdm_clear_all_wkdeps(struct clockdomain *clkdm); |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 178 | int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
| 179 | int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
| 180 | int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
Paul Walmsley | 369d561 | 2010-01-26 20:13:01 -0700 | [diff] [blame] | 181 | int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm); |
Paul Walmsley | 55ed969 | 2010-01-26 20:12:59 -0700 | [diff] [blame] | 182 | |
Rajendra Nayak | 5cd1937 | 2011-02-25 16:06:48 -0700 | [diff] [blame] | 183 | void clkdm_allow_idle(struct clockdomain *clkdm); |
| 184 | void clkdm_deny_idle(struct clockdomain *clkdm); |
Paul Walmsley | 32a363c | 2011-07-10 05:56:54 -0600 | [diff] [blame] | 185 | bool clkdm_in_hwsup(struct clockdomain *clkdm); |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 186 | |
Rajendra Nayak | 68b921a | 2011-02-25 16:06:47 -0700 | [diff] [blame] | 187 | int clkdm_wakeup(struct clockdomain *clkdm); |
| 188 | int clkdm_sleep(struct clockdomain *clkdm); |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 189 | |
Rajendra Nayak | 4da71ae | 2011-02-25 16:06:48 -0700 | [diff] [blame] | 190 | int clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk); |
| 191 | int clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk); |
Benoit Cousson | 113a741 | 2011-07-10 05:56:54 -0600 | [diff] [blame] | 192 | int clkdm_hwmod_enable(struct clockdomain *clkdm, struct omap_hwmod *oh); |
| 193 | int clkdm_hwmod_disable(struct clockdomain *clkdm, struct omap_hwmod *oh); |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 194 | |
Paul Walmsley | a5ffef6 | 2011-09-14 16:01:21 -0600 | [diff] [blame] | 195 | extern void __init omap242x_clockdomains_init(void); |
| 196 | extern void __init omap243x_clockdomains_init(void); |
Rajendra Nayak | 4aef7a2 | 2011-02-25 16:06:47 -0700 | [diff] [blame] | 197 | extern void __init omap3xxx_clockdomains_init(void); |
Paul Walmsley | dc0b3a7 | 2010-12-21 20:01:20 -0700 | [diff] [blame] | 198 | extern void __init omap44xx_clockdomains_init(void); |
Rajendra Nayak | 5cd1937 | 2011-02-25 16:06:48 -0700 | [diff] [blame] | 199 | extern void _clkdm_add_autodeps(struct clockdomain *clkdm); |
| 200 | extern void _clkdm_del_autodeps(struct clockdomain *clkdm); |
Paul Walmsley | dc0b3a7 | 2010-12-21 20:01:20 -0700 | [diff] [blame] | 201 | |
Rajendra Nayak | 4aef7a2 | 2011-02-25 16:06:47 -0700 | [diff] [blame] | 202 | extern struct clkdm_ops omap2_clkdm_operations; |
| 203 | extern struct clkdm_ops omap3_clkdm_operations; |
Rajendra Nayak | 68b921a | 2011-02-25 16:06:47 -0700 | [diff] [blame] | 204 | extern struct clkdm_ops omap4_clkdm_operations; |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 205 | |
Paul Walmsley | a5ffef6 | 2011-09-14 16:01:21 -0600 | [diff] [blame] | 206 | extern struct clkdm_dep gfx_24xx_wkdeps[]; |
| 207 | extern struct clkdm_dep dsp_24xx_wkdeps[]; |
| 208 | extern struct clockdomain wkup_common_clkdm; |
| 209 | extern struct clockdomain prm_common_clkdm; |
| 210 | extern struct clockdomain cm_common_clkdm; |
| 211 | |
Paul Walmsley | d459bfe | 2008-08-19 11:08:43 +0300 | [diff] [blame] | 212 | #endif |