2 * arch/arm/plat-omap/include/mach/clockdomain.h
4 * OMAP2/3 clockdomain framework functions
6 * Copyright (C) 2008 Texas Instruments, Inc.
7 * Copyright (C) 2008-2010 Nokia Corporation
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.
16 #ifndef __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H
17 #define __ARCH_ARM_MACH_OMAP2_CLOCKDOMAIN_H
19 #include <linux/init.h>
21 #include "powerdomain.h"
22 #include <plat/clock.h>
25 /* Clockdomain capability flags */
26 #define CLKDM_CAN_FORCE_SLEEP (1 << 0)
27 #define CLKDM_CAN_FORCE_WAKEUP (1 << 1)
28 #define CLKDM_CAN_ENABLE_AUTO (1 << 2)
29 #define CLKDM_CAN_DISABLE_AUTO (1 << 3)
31 #define CLKDM_CAN_HWSUP (CLKDM_CAN_ENABLE_AUTO | CLKDM_CAN_DISABLE_AUTO)
32 #define CLKDM_CAN_SWSUP (CLKDM_CAN_FORCE_SLEEP | CLKDM_CAN_FORCE_WAKEUP)
33 #define CLKDM_CAN_HWSUP_SWSUP (CLKDM_CAN_SWSUP | CLKDM_CAN_HWSUP)
36 * struct clkdm_autodep - clkdm deps to add when entering/exiting hwsup mode
37 * @clkdm: clockdomain to add wkdep+sleepdep on - set name member only
38 * @omap_chip: OMAP chip types that this autodep is valid on
40 * A clockdomain that should have wkdeps and sleepdeps added when a
41 * clockdomain should stay active in hwsup mode; and conversely,
42 * removed when the clockdomain should be allowed to go inactive in
45 * Autodeps are deprecated and should be removed after
46 * omap_hwmod-based fine-grained module idle control is added.
48 struct clkdm_autodep {
51 struct clockdomain *ptr;
53 const struct omap_chip_id omap_chip;
57 * struct clkdm_dep - encode dependencies between clockdomains
58 * @clkdm_name: clockdomain name
59 * @clkdm: pointer to the struct clockdomain of @clkdm_name
60 * @omap_chip: OMAP chip types that this dependency is valid on
61 * @wkdep_usecount: Number of wakeup dependencies causing this clkdm to wake
62 * @sleepdep_usecount: Number of sleep deps that could prevent clkdm from idle
64 * Statically defined. @clkdm is resolved from @clkdm_name at runtime and
65 * should not be pre-initialized.
67 * XXX Should also include hardware (fixed) dependencies.
70 const char *clkdm_name;
71 struct clockdomain *clkdm;
72 atomic_t wkdep_usecount;
73 atomic_t sleepdep_usecount;
74 const struct omap_chip_id omap_chip;
78 * struct clockdomain - OMAP clockdomain
79 * @name: clockdomain name
80 * @pwrdm: powerdomain containing this clockdomain
81 * @clktrctrl_reg: CLKSTCTRL reg for the given clock domain
82 * @clktrctrl_mask: CLKTRCTRL/AUTOSTATE field mask in CM_CLKSTCTRL reg
83 * @flags: Clockdomain capability flags
84 * @dep_bit: Bit shift of this clockdomain's PM_WKDEP/CM_SLEEPDEP bit
85 * @prcm_partition: (OMAP4 only) PRCM partition ID for this clkdm's registers
86 * @cm_inst: (OMAP4 only) CM instance register offset
87 * @clkdm_offs: (OMAP4 only) CM clockdomain register offset
88 * @wkdep_srcs: Clockdomains that can be told to wake this powerdomain up
89 * @sleepdep_srcs: Clockdomains that can be told to keep this clkdm from inact
90 * @omap_chip: OMAP chip types that this clockdomain is valid on
91 * @usecount: Usecount tracking
92 * @node: list_head to link all clockdomains together
94 * @prcm_partition should be a macro from mach-omap2/prcm44xx.h (OMAP4 only)
95 * @cm_inst should be a macro ending in _INST from the OMAP4 CM instance
96 * definitions (OMAP4 only)
97 * @clkdm_offs should be a macro ending in _CDOFFS from the OMAP4 CM instance
98 * definitions (OMAP4 only)
104 struct powerdomain *ptr;
106 const u16 clktrctrl_mask;
109 const u8 prcm_partition;
111 const u16 clkdm_offs;
112 struct clkdm_dep *wkdep_srcs;
113 struct clkdm_dep *sleepdep_srcs;
114 const struct omap_chip_id omap_chip;
116 struct list_head node;
120 * struct clkdm_ops - Arch specfic function implementations
121 * @clkdm_add_wkdep: Add a wakeup dependency between clk domains
122 * @clkdm_del_wkdep: Delete a wakeup dependency between clk domains
123 * @clkdm_read_wkdep: Read wakeup dependency state between clk domains
124 * @clkdm_clear_all_wkdeps: Remove all wakeup dependencies from the clk domain
125 * @clkdm_add_sleepdep: Add a sleep dependency between clk domains
126 * @clkdm_del_sleepdep: Delete a sleep dependency between clk domains
127 * @clkdm_read_sleepdep: Read sleep dependency state between clk domains
128 * @clkdm_clear_all_sleepdeps: Remove all sleep dependencies from the clk domain
129 * @clkdm_sleep: Force a clockdomain to sleep
130 * @clkdm_wakeup: Force a clockdomain to wakeup
131 * @clkdm_allow_idle: Enable hw supervised idle transitions for clock domain
132 * @clkdm_deny_idle: Disable hw supervised idle transitions for clock domain
133 * @clkdm_clk_enable: Put the clkdm in right state for a clock enable
134 * @clkdm_clk_disable: Put the clkdm in right state for a clock disable
137 int (*clkdm_add_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
138 int (*clkdm_del_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
139 int (*clkdm_read_wkdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
140 int (*clkdm_clear_all_wkdeps)(struct clockdomain *clkdm);
141 int (*clkdm_add_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
142 int (*clkdm_del_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
143 int (*clkdm_read_sleepdep)(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
144 int (*clkdm_clear_all_sleepdeps)(struct clockdomain *clkdm);
145 int (*clkdm_sleep)(struct clockdomain *clkdm);
146 int (*clkdm_wakeup)(struct clockdomain *clkdm);
147 void (*clkdm_allow_idle)(struct clockdomain *clkdm);
148 void (*clkdm_deny_idle)(struct clockdomain *clkdm);
149 int (*clkdm_clk_enable)(struct clockdomain *clkdm);
150 int (*clkdm_clk_disable)(struct clockdomain *clkdm);
153 void clkdm_init(struct clockdomain **clkdms, struct clkdm_autodep *autodeps,
154 struct clkdm_ops *custom_funcs);
155 struct clockdomain *clkdm_lookup(const char *name);
157 int clkdm_for_each(int (*fn)(struct clockdomain *clkdm, void *user),
159 struct powerdomain *clkdm_get_pwrdm(struct clockdomain *clkdm);
161 int clkdm_add_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
162 int clkdm_del_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
163 int clkdm_read_wkdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
164 int clkdm_clear_all_wkdeps(struct clockdomain *clkdm);
165 int clkdm_add_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
166 int clkdm_del_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
167 int clkdm_read_sleepdep(struct clockdomain *clkdm1, struct clockdomain *clkdm2);
168 int clkdm_clear_all_sleepdeps(struct clockdomain *clkdm);
170 void omap2_clkdm_allow_idle(struct clockdomain *clkdm);
171 void omap2_clkdm_deny_idle(struct clockdomain *clkdm);
173 int clkdm_wakeup(struct clockdomain *clkdm);
174 int clkdm_sleep(struct clockdomain *clkdm);
176 int omap2_clkdm_clk_enable(struct clockdomain *clkdm, struct clk *clk);
177 int omap2_clkdm_clk_disable(struct clockdomain *clkdm, struct clk *clk);
179 extern void __init omap2xxx_clockdomains_init(void);
180 extern void __init omap3xxx_clockdomains_init(void);
181 extern void __init omap44xx_clockdomains_init(void);
183 extern struct clkdm_ops omap2_clkdm_operations;
184 extern struct clkdm_ops omap3_clkdm_operations;
185 extern struct clkdm_ops omap4_clkdm_operations;