aboutsummaryrefslogtreecommitdiffstats
path: root/arch/arm/mach-omap2/powerdomain.h
diff options
context:
space:
mode:
Diffstat (limited to 'arch/arm/mach-omap2/powerdomain.h')
-rw-r--r--arch/arm/mach-omap2/powerdomain.h232
1 files changed, 232 insertions, 0 deletions
diff --git a/arch/arm/mach-omap2/powerdomain.h b/arch/arm/mach-omap2/powerdomain.h
new file mode 100644
index 000000000000..35b5b4800a43
--- /dev/null
+++ b/arch/arm/mach-omap2/powerdomain.h
@@ -0,0 +1,232 @@
1/*
2 * OMAP2/3/4 powerdomain control
3 *
4 * Copyright (C) 2007-2008, 2010 Texas Instruments, Inc.
5 * Copyright (C) 2007-2010 Nokia Corporation
6 *
7 * Paul Walmsley
8 *
9 * This program is free software; you can redistribute it and/or modify
10 * it under the terms of the GNU General Public License version 2 as
11 * published by the Free Software Foundation.
12 *
13 * XXX This should be moved to the mach-omap2/ directory at the earliest
14 * opportunity.
15 */
16
17#ifndef __ARCH_ARM_MACH_OMAP2_POWERDOMAIN_H
18#define __ARCH_ARM_MACH_OMAP2_POWERDOMAIN_H
19
20#include <linux/types.h>
21#include <linux/list.h>
22
23#include <linux/atomic.h>
24
25#include <plat/cpu.h>
26
27/* Powerdomain basic power states */
28#define PWRDM_POWER_OFF 0x0
29#define PWRDM_POWER_RET 0x1
30#define PWRDM_POWER_INACTIVE 0x2
31#define PWRDM_POWER_ON 0x3
32
33#define PWRDM_MAX_PWRSTS 4
34
35/* Powerdomain allowable state bitfields */
36#define PWRSTS_ON (1 << PWRDM_POWER_ON)
37#define PWRSTS_OFF (1 << PWRDM_POWER_OFF)
38#define PWRSTS_OFF_ON ((1 << PWRDM_POWER_OFF) | \
39 (1 << PWRDM_POWER_ON))
40
41#define PWRSTS_OFF_RET ((1 << PWRDM_POWER_OFF) | \
42 (1 << PWRDM_POWER_RET))
43
44#define PWRSTS_RET_ON ((1 << PWRDM_POWER_RET) | \
45 (1 << PWRDM_POWER_ON))
46
47#define PWRSTS_OFF_RET_ON (PWRSTS_OFF_RET | (1 << PWRDM_POWER_ON))
48
49
50/* Powerdomain flags */
51#define PWRDM_HAS_HDWR_SAR (1 << 0) /* hardware save-and-restore support */
52#define PWRDM_HAS_MPU_QUIRK (1 << 1) /* MPU pwr domain has MEM bank 0 bits
53 * in MEM bank 1 position. This is
54 * true for OMAP3430
55 */
56#define PWRDM_HAS_LOWPOWERSTATECHANGE (1 << 2) /*
57 * support to transition from a
58 * sleep state to a lower sleep
59 * state without waking up the
60 * powerdomain
61 */
62
63/*
64 * Number of memory banks that are power-controllable. On OMAP4430, the
65 * maximum is 5.
66 */
67#define PWRDM_MAX_MEM_BANKS 5
68
69/*
70 * Maximum number of clockdomains that can be associated with a powerdomain.
71 * CORE powerdomain on OMAP4 is the worst case
72 */
73#define PWRDM_MAX_CLKDMS 9
74
75/* XXX A completely arbitrary number. What is reasonable here? */
76#define PWRDM_TRANSITION_BAILOUT 100000
77
78struct clockdomain;
79struct powerdomain;
80
81/**
82 * struct powerdomain - OMAP powerdomain
83 * @name: Powerdomain name
84 * @omap_chip: represents the OMAP chip types containing this pwrdm
85 * @prcm_offs: the address offset from CM_BASE/PRM_BASE
86 * @prcm_partition: (OMAP4 only) the PRCM partition ID containing @prcm_offs
87 * @pwrsts: Possible powerdomain power states
88 * @pwrsts_logic_ret: Possible logic power states when pwrdm in RETENTION
89 * @flags: Powerdomain flags
90 * @banks: Number of software-controllable memory banks in this powerdomain
91 * @pwrsts_mem_ret: Possible memory bank pwrstates when pwrdm in RETENTION
92 * @pwrsts_mem_on: Possible memory bank pwrstates when pwrdm in ON
93 * @pwrdm_clkdms: Clockdomains in this powerdomain
94 * @node: list_head linking all powerdomains
95 * @state:
96 * @state_counter:
97 * @timer:
98 * @state_timer:
99 *
100 * @prcm_partition possible values are defined in mach-omap2/prcm44xx.h.
101 */
102struct powerdomain {
103 const char *name;
104 const struct omap_chip_id omap_chip;
105 const s16 prcm_offs;
106 const u8 pwrsts;
107 const u8 pwrsts_logic_ret;
108 const u8 flags;
109 const u8 banks;
110 const u8 pwrsts_mem_ret[PWRDM_MAX_MEM_BANKS];
111 const u8 pwrsts_mem_on[PWRDM_MAX_MEM_BANKS];
112 const u8 prcm_partition;
113 struct clockdomain *pwrdm_clkdms[PWRDM_MAX_CLKDMS];
114 struct list_head node;
115 int state;
116 unsigned state_counter[PWRDM_MAX_PWRSTS];
117 unsigned ret_logic_off_counter;
118 unsigned ret_mem_off_counter[PWRDM_MAX_MEM_BANKS];
119
120#ifdef CONFIG_PM_DEBUG
121 s64 timer;
122 s64 state_timer[PWRDM_MAX_PWRSTS];
123#endif
124};
125
126/**
127 * struct pwrdm_ops - Arch specfic function implementations
128 * @pwrdm_set_next_pwrst: Set the target power state for a pd
129 * @pwrdm_read_next_pwrst: Read the target power state set for a pd
130 * @pwrdm_read_pwrst: Read the current power state of a pd
131 * @pwrdm_read_prev_pwrst: Read the prev power state entered by the pd
132 * @pwrdm_set_logic_retst: Set the logic state in RET for a pd
133 * @pwrdm_set_mem_onst: Set the Memory state in ON for a pd
134 * @pwrdm_set_mem_retst: Set the Memory state in RET for a pd
135 * @pwrdm_read_logic_pwrst: Read the current logic state of a pd
136 * @pwrdm_read_prev_logic_pwrst: Read the previous logic state entered by a pd
137 * @pwrdm_read_logic_retst: Read the logic state in RET for a pd
138 * @pwrdm_read_mem_pwrst: Read the current memory state of a pd
139 * @pwrdm_read_prev_mem_pwrst: Read the previous memory state entered by a pd
140 * @pwrdm_read_mem_retst: Read the memory state in RET for a pd
141 * @pwrdm_clear_all_prev_pwrst: Clear all previous power states logged for a pd
142 * @pwrdm_enable_hdwr_sar: Enable Hardware Save-Restore feature for the pd
143 * @pwrdm_disable_hdwr_sar: Disable Hardware Save-Restore feature for a pd
144 * @pwrdm_set_lowpwrstchange: Enable pd transitions from a shallow to deep sleep
145 * @pwrdm_wait_transition: Wait for a pd state transition to complete
146 */
147struct pwrdm_ops {
148 int (*pwrdm_set_next_pwrst)(struct powerdomain *pwrdm, u8 pwrst);
149 int (*pwrdm_read_next_pwrst)(struct powerdomain *pwrdm);
150 int (*pwrdm_read_pwrst)(struct powerdomain *pwrdm);
151 int (*pwrdm_read_prev_pwrst)(struct powerdomain *pwrdm);
152 int (*pwrdm_set_logic_retst)(struct powerdomain *pwrdm, u8 pwrst);
153 int (*pwrdm_set_mem_onst)(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
154 int (*pwrdm_set_mem_retst)(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
155 int (*pwrdm_read_logic_pwrst)(struct powerdomain *pwrdm);
156 int (*pwrdm_read_prev_logic_pwrst)(struct powerdomain *pwrdm);
157 int (*pwrdm_read_logic_retst)(struct powerdomain *pwrdm);
158 int (*pwrdm_read_mem_pwrst)(struct powerdomain *pwrdm, u8 bank);
159 int (*pwrdm_read_prev_mem_pwrst)(struct powerdomain *pwrdm, u8 bank);
160 int (*pwrdm_read_mem_retst)(struct powerdomain *pwrdm, u8 bank);
161 int (*pwrdm_clear_all_prev_pwrst)(struct powerdomain *pwrdm);
162 int (*pwrdm_enable_hdwr_sar)(struct powerdomain *pwrdm);
163 int (*pwrdm_disable_hdwr_sar)(struct powerdomain *pwrdm);
164 int (*pwrdm_set_lowpwrstchange)(struct powerdomain *pwrdm);
165 int (*pwrdm_wait_transition)(struct powerdomain *pwrdm);
166};
167
168void pwrdm_fw_init(void);
169void pwrdm_init(struct powerdomain **pwrdm_list, struct pwrdm_ops *custom_funcs);
170
171struct powerdomain *pwrdm_lookup(const char *name);
172
173int pwrdm_for_each(int (*fn)(struct powerdomain *pwrdm, void *user),
174 void *user);
175int pwrdm_for_each_nolock(int (*fn)(struct powerdomain *pwrdm, void *user),
176 void *user);
177
178int pwrdm_add_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm);
179int pwrdm_del_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm);
180int pwrdm_for_each_clkdm(struct powerdomain *pwrdm,
181 int (*fn)(struct powerdomain *pwrdm,
182 struct clockdomain *clkdm));
183
184int pwrdm_get_mem_bank_count(struct powerdomain *pwrdm);
185
186int pwrdm_set_next_pwrst(struct powerdomain *pwrdm, u8 pwrst);
187int pwrdm_read_next_pwrst(struct powerdomain *pwrdm);
188int pwrdm_read_pwrst(struct powerdomain *pwrdm);
189int pwrdm_read_prev_pwrst(struct powerdomain *pwrdm);
190int pwrdm_clear_all_prev_pwrst(struct powerdomain *pwrdm);
191
192int pwrdm_set_logic_retst(struct powerdomain *pwrdm, u8 pwrst);
193int pwrdm_set_mem_onst(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
194int pwrdm_set_mem_retst(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
195
196int pwrdm_read_logic_pwrst(struct powerdomain *pwrdm);
197int pwrdm_read_prev_logic_pwrst(struct powerdomain *pwrdm);
198int pwrdm_read_logic_retst(struct powerdomain *pwrdm);
199int pwrdm_read_mem_pwrst(struct powerdomain *pwrdm, u8 bank);
200int pwrdm_read_prev_mem_pwrst(struct powerdomain *pwrdm, u8 bank);
201int pwrdm_read_mem_retst(struct powerdomain *pwrdm, u8 bank);
202
203int pwrdm_enable_hdwr_sar(struct powerdomain *pwrdm);
204int pwrdm_disable_hdwr_sar(struct powerdomain *pwrdm);
205bool pwrdm_has_hdwr_sar(struct powerdomain *pwrdm);
206
207int pwrdm_wait_transition(struct powerdomain *pwrdm);
208
209int pwrdm_state_switch(struct powerdomain *pwrdm);
210int pwrdm_clkdm_state_switch(struct clockdomain *clkdm);
211int pwrdm_pre_transition(void);
212int pwrdm_post_transition(void);
213int pwrdm_set_lowpwrstchange(struct powerdomain *pwrdm);
214
215extern void omap2xxx_powerdomains_init(void);
216extern void omap3xxx_powerdomains_init(void);
217extern void omap44xx_powerdomains_init(void);
218
219extern struct pwrdm_ops omap2_pwrdm_operations;
220extern struct pwrdm_ops omap3_pwrdm_operations;
221extern struct pwrdm_ops omap4_pwrdm_operations;
222
223/* Common Internal functions used across OMAP rev's */
224extern u32 omap2_pwrdm_get_mem_bank_onstate_mask(u8 bank);
225extern u32 omap2_pwrdm_get_mem_bank_retst_mask(u8 bank);
226extern u32 omap2_pwrdm_get_mem_bank_stst_mask(u8 bank);
227
228extern struct powerdomain wkup_omap2_pwrdm;
229extern struct powerdomain gfx_omap2_pwrdm;
230
231
232#endif