Commit | Line | Data |
---|---|---|
d459bfe0 | 1 | /* |
5b74c676 | 2 | * arch/arm/plat-omap/include/mach/clockdomain.h |
d459bfe0 PW |
3 | * |
4 | * OMAP2/3 clockdomain framework functions | |
5 | * | |
6 | * Copyright (C) 2008 Texas Instruments, Inc. | |
55ed9694 | 7 | * Copyright (C) 2008-2009 Nokia Corporation |
d459bfe0 PW |
8 | * |
9 | * Written by 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 __ASM_ARM_ARCH_OMAP_CLOCKDOMAIN_H | |
17 | #define __ASM_ARM_ARCH_OMAP_CLOCKDOMAIN_H | |
18 | ||
ce491cf8 TL |
19 | #include <plat/powerdomain.h> |
20 | #include <plat/clock.h> | |
21 | #include <plat/cpu.h> | |
d459bfe0 PW |
22 | |
23 | /* Clockdomain capability flags */ | |
24 | #define CLKDM_CAN_FORCE_SLEEP (1 << 0) | |
25 | #define CLKDM_CAN_FORCE_WAKEUP (1 << 1) | |
26 | #define CLKDM_CAN_ENABLE_AUTO (1 << 2) | |
27 | #define CLKDM_CAN_DISABLE_AUTO (1 << 3) | |
28 | ||
29 | #define CLKDM_CAN_HWSUP (CLKDM_CAN_ENABLE_AUTO | CLKDM_CAN_DISABLE_AUTO) | |
30 | #define CLKDM_CAN_SWSUP (CLKDM_CAN_FORCE_SLEEP | CLKDM_CAN_FORCE_WAKEUP) | |
31 | #define CLKDM_CAN_HWSUP_SWSUP (CLKDM_CAN_SWSUP | CLKDM_CAN_HWSUP) | |
32 | ||
33 | /* OMAP24XX CM_CLKSTCTRL_*.AUTOSTATE_* register bit values */ | |
34 | #define OMAP24XX_CLKSTCTRL_DISABLE_AUTO 0x0 | |
35 | #define OMAP24XX_CLKSTCTRL_ENABLE_AUTO 0x1 | |
36 | ||
37 | /* OMAP3XXX CM_CLKSTCTRL_*.CLKTRCTRL_* register bit values */ | |
38 | #define OMAP34XX_CLKSTCTRL_DISABLE_AUTO 0x0 | |
39 | #define OMAP34XX_CLKSTCTRL_FORCE_SLEEP 0x1 | |
40 | #define OMAP34XX_CLKSTCTRL_FORCE_WAKEUP 0x2 | |
41 | #define OMAP34XX_CLKSTCTRL_ENABLE_AUTO 0x3 | |
42 | ||
f0271d65 PW |
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. | |
d459bfe0 | 55 | */ |
55ed9694 | 56 | struct clkdm_autodep { |
5b74c676 | 57 | union { |
5b74c676 | 58 | const char *name; |
55ed9694 PW |
59 | struct clockdomain *ptr; |
60 | } clkdm; | |
d459bfe0 | 61 | const struct omap_chip_id omap_chip; |
d459bfe0 PW |
62 | }; |
63 | ||
f0271d65 PW |
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 | */ | |
55ed9694 | 77 | struct clkdm_dep { |
55ed9694 | 78 | const char *clkdm_name; |
55ed9694 | 79 | struct clockdomain *clkdm; |
369d5614 | 80 | atomic_t wkdep_usecount; |
369d5614 | 81 | atomic_t sleepdep_usecount; |
55ed9694 | 82 | const struct omap_chip_id omap_chip; |
55ed9694 PW |
83 | }; |
84 | ||
f0271d65 PW |
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 | * @wkdep_srcs: Clockdomains that can be told to wake this powerdomain up | |
94 | * @sleepdep_srcs: Clockdomains that can be told to keep this clkdm from inact | |
95 | * @omap_chip: OMAP chip types that this clockdomain is valid on | |
96 | * @usecount: Usecount tracking | |
97 | * @node: list_head to link all clockdomains together | |
98 | */ | |
d459bfe0 | 99 | struct clockdomain { |
d459bfe0 | 100 | const char *name; |
5b74c676 | 101 | union { |
5b74c676 | 102 | const char *name; |
5b74c676 PW |
103 | struct powerdomain *ptr; |
104 | } pwrdm; | |
84c0c39a | 105 | void __iomem *clkstctrl_reg; |
d459bfe0 | 106 | const u16 clktrctrl_mask; |
d459bfe0 | 107 | const u8 flags; |
55ed9694 | 108 | const u8 dep_bit; |
55ed9694 | 109 | struct clkdm_dep *wkdep_srcs; |
55ed9694 | 110 | struct clkdm_dep *sleepdep_srcs; |
d459bfe0 | 111 | const struct omap_chip_id omap_chip; |
d459bfe0 | 112 | atomic_t usecount; |
d459bfe0 | 113 | struct list_head node; |
d459bfe0 PW |
114 | }; |
115 | ||
55ed9694 | 116 | void clkdm_init(struct clockdomain **clkdms, struct clkdm_autodep *autodeps); |
d459bfe0 PW |
117 | struct clockdomain *clkdm_lookup(const char *name); |
118 | ||
a23456e9 PDS |
119 | int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user), |
120 | void *user); | |
d459bfe0 PW |
121 | struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm); |
122 | ||
55ed9694 PW |
123 | int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
124 | int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
125 | int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
369d5614 | 126 | int clkdm_clear_all_wkdeps(struct clockdomain *clkdm); |
55ed9694 PW |
127 | int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); |
128 | int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
129 | int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2); | |
369d5614 | 130 | int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm); |
55ed9694 | 131 | |
d459bfe0 PW |
132 | void omap2_clkdm_allow_idle(struct clockdomain *clkdm); |
133 | void omap2_clkdm_deny_idle(struct clockdomain *clkdm); | |
134 | ||
135 | int omap2_clkdm_wakeup(struct clockdomain *clkdm); | |
136 | int omap2_clkdm_sleep(struct clockdomain *clkdm); | |
137 | ||
138 | int omap2_clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk); | |
139 | int omap2_clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk); | |
140 | ||
141 | #endif |