net: cpsw: halt network stack before halting the device during suspend
[deliverable/linux.git] / arch / arm / mach-omap2 / powerdomain.h
CommitLineData
ad67ef68 1/*
a64bb9cd 2 * OMAP2/3/4 powerdomain control
ad67ef68 3 *
72e06d08 4 * Copyright (C) 2007-2008, 2010 Texas Instruments, Inc.
694606c4 5 * Copyright (C) 2007-2011 Nokia Corporation
ad67ef68 6 *
72e06d08 7 * Paul Walmsley
ad67ef68
PW
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.
6e01478a
PW
12 *
13 * XXX This should be moved to the mach-omap2/ directory at the earliest
14 * opportunity.
ad67ef68
PW
15 */
16
72e06d08
PW
17#ifndef __ARCH_ARM_MACH_OMAP2_POWERDOMAIN_H
18#define __ARCH_ARM_MACH_OMAP2_POWERDOMAIN_H
ad67ef68
PW
19
20#include <linux/types.h>
21#include <linux/list.h>
22
72e06d08 23#include <linux/atomic.h>
ad67ef68 24
ce491cf8 25#include <plat/cpu.h>
ad67ef68 26
8f1bec24
KH
27#include "voltage.h"
28
ad67ef68
PW
29/* Powerdomain basic power states */
30#define PWRDM_POWER_OFF 0x0
31#define PWRDM_POWER_RET 0x1
32#define PWRDM_POWER_INACTIVE 0x2
33#define PWRDM_POWER_ON 0x3
34
2354eb5a
PW
35#define PWRDM_MAX_PWRSTS 4
36
ad67ef68 37/* Powerdomain allowable state bitfields */
d3353e16 38#define PWRSTS_ON (1 << PWRDM_POWER_ON)
694606c4
PW
39#define PWRSTS_INACTIVE (1 << PWRDM_POWER_INACTIVE)
40#define PWRSTS_RET (1 << PWRDM_POWER_RET)
bb722f33 41#define PWRSTS_OFF (1 << PWRDM_POWER_OFF)
ad67ef68 42
694606c4
PW
43#define PWRSTS_OFF_ON (PWRSTS_OFF | PWRSTS_ON)
44#define PWRSTS_OFF_RET (PWRSTS_OFF | PWRSTS_RET)
45#define PWRSTS_RET_ON (PWRSTS_RET | PWRSTS_ON)
46#define PWRSTS_OFF_RET_ON (PWRSTS_OFF_RET | PWRSTS_ON)
ad67ef68
PW
47
48
0b7cbfb5
PW
49/* Powerdomain flags */
50#define PWRDM_HAS_HDWR_SAR (1 << 0) /* hardware save-and-restore support */
3863c74b
TG
51#define PWRDM_HAS_MPU_QUIRK (1 << 1) /* MPU pwr domain has MEM bank 0 bits
52 * in MEM bank 1 position. This is
53 * true for OMAP3430
54 */
90dbc7b0
RN
55#define PWRDM_HAS_LOWPOWERSTATECHANGE (1 << 2) /*
56 * support to transition from a
57 * sleep state to a lower sleep
58 * state without waking up the
59 * powerdomain
60 */
0b7cbfb5 61
ad67ef68 62/*
38900c27
AP
63 * Number of memory banks that are power-controllable. On OMAP4430, the
64 * maximum is 5.
ad67ef68 65 */
38900c27 66#define PWRDM_MAX_MEM_BANKS 5
ad67ef68 67
8420bb13
PW
68/*
69 * Maximum number of clockdomains that can be associated with a powerdomain.
3f0ea764 70 * PER powerdomain on AM33XX is the worst case
8420bb13 71 */
3f0ea764 72#define PWRDM_MAX_CLKDMS 11
8420bb13 73
ad67ef68
PW
74/* XXX A completely arbitrary number. What is reasonable here? */
75#define PWRDM_TRANSITION_BAILOUT 100000
76
8420bb13 77struct clockdomain;
ad67ef68
PW
78struct powerdomain;
79
f0271d65
PW
80/**
81 * struct powerdomain - OMAP powerdomain
82 * @name: Powerdomain name
8f1bec24 83 * @voltdm: voltagedomain containing this powerdomain
f0271d65 84 * @prcm_offs: the address offset from CM_BASE/PRM_BASE
a64bb9cd 85 * @prcm_partition: (OMAP4 only) the PRCM partition ID containing @prcm_offs
f0271d65
PW
86 * @pwrsts: Possible powerdomain power states
87 * @pwrsts_logic_ret: Possible logic power states when pwrdm in RETENTION
88 * @flags: Powerdomain flags
89 * @banks: Number of software-controllable memory banks in this powerdomain
90 * @pwrsts_mem_ret: Possible memory bank pwrstates when pwrdm in RETENTION
91 * @pwrsts_mem_on: Possible memory bank pwrstates when pwrdm in ON
92 * @pwrdm_clkdms: Clockdomains in this powerdomain
93 * @node: list_head linking all powerdomains
e69c22b1 94 * @voltdm_node: list_head linking all powerdomains in a voltagedomain
3f0ea764
VH
95 * @pwrstctrl_offs: (AM33XX only) XXX_PWRSTCTRL reg offset from prcm_offs
96 * @pwrstst_offs: (AM33XX only) XXX_PWRSTST reg offset from prcm_offs
97 * @logicretstate_mask: (AM33XX only) mask for logic retention bitfield
98 * in @pwrstctrl_offs
99 * @mem_on_mask: (AM33XX only) mask for mem on bitfield in @pwrstctrl_offs
100 * @mem_ret_mask: (AM33XX only) mask for mem ret bitfield in @pwrstctrl_offs
101 * @mem_pwrst_mask: (AM33XX only) mask for mem state bitfield in @pwrstst_offs
102 * @mem_retst_mask: (AM33XX only) mask for mem retention state bitfield
103 * in @pwrstctrl_offs
f0271d65
PW
104 * @state:
105 * @state_counter:
106 * @timer:
107 * @state_timer:
a64bb9cd
PW
108 *
109 * @prcm_partition possible values are defined in mach-omap2/prcm44xx.h.
f0271d65 110 */
ad67ef68 111struct powerdomain {
ad67ef68 112 const char *name;
8f1bec24
KH
113 union {
114 const char *name;
115 struct voltagedomain *ptr;
116 } voltdm;
e0594b44 117 const s16 prcm_offs;
ad67ef68 118 const u8 pwrsts;
ad67ef68 119 const u8 pwrsts_logic_ret;
0b7cbfb5 120 const u8 flags;
ad67ef68 121 const u8 banks;
ad67ef68 122 const u8 pwrsts_mem_ret[PWRDM_MAX_MEM_BANKS];
ad67ef68 123 const u8 pwrsts_mem_on[PWRDM_MAX_MEM_BANKS];
a64bb9cd 124 const u8 prcm_partition;
8420bb13 125 struct clockdomain *pwrdm_clkdms[PWRDM_MAX_CLKDMS];
ad67ef68 126 struct list_head node;
e69c22b1 127 struct list_head voltdm_node;
ba20bb12 128 int state;
2354eb5a 129 unsigned state_counter[PWRDM_MAX_PWRSTS];
cde08f81
TG
130 unsigned ret_logic_off_counter;
131 unsigned ret_mem_off_counter[PWRDM_MAX_MEM_BANKS];
331b93f4 132
3f0ea764
VH
133 const u8 pwrstctrl_offs;
134 const u8 pwrstst_offs;
135 const u32 logicretstate_mask;
136 const u32 mem_on_mask[PWRDM_MAX_MEM_BANKS];
137 const u32 mem_ret_mask[PWRDM_MAX_MEM_BANKS];
138 const u32 mem_pwrst_mask[PWRDM_MAX_MEM_BANKS];
139 const u32 mem_retst_mask[PWRDM_MAX_MEM_BANKS];
140
331b93f4
PDS
141#ifdef CONFIG_PM_DEBUG
142 s64 timer;
2354eb5a 143 s64 state_timer[PWRDM_MAX_PWRSTS];
331b93f4 144#endif
ad67ef68
PW
145};
146
3b1e8b21 147/**
25985edc 148 * struct pwrdm_ops - Arch specific function implementations
3b1e8b21
RN
149 * @pwrdm_set_next_pwrst: Set the target power state for a pd
150 * @pwrdm_read_next_pwrst: Read the target power state set for a pd
151 * @pwrdm_read_pwrst: Read the current power state of a pd
152 * @pwrdm_read_prev_pwrst: Read the prev power state entered by the pd
153 * @pwrdm_set_logic_retst: Set the logic state in RET for a pd
154 * @pwrdm_set_mem_onst: Set the Memory state in ON for a pd
155 * @pwrdm_set_mem_retst: Set the Memory state in RET for a pd
156 * @pwrdm_read_logic_pwrst: Read the current logic state of a pd
157 * @pwrdm_read_prev_logic_pwrst: Read the previous logic state entered by a pd
158 * @pwrdm_read_logic_retst: Read the logic state in RET for a pd
159 * @pwrdm_read_mem_pwrst: Read the current memory state of a pd
160 * @pwrdm_read_prev_mem_pwrst: Read the previous memory state entered by a pd
161 * @pwrdm_read_mem_retst: Read the memory state in RET for a pd
162 * @pwrdm_clear_all_prev_pwrst: Clear all previous power states logged for a pd
163 * @pwrdm_enable_hdwr_sar: Enable Hardware Save-Restore feature for the pd
164 * @pwrdm_disable_hdwr_sar: Disable Hardware Save-Restore feature for a pd
165 * @pwrdm_set_lowpwrstchange: Enable pd transitions from a shallow to deep sleep
166 * @pwrdm_wait_transition: Wait for a pd state transition to complete
167 */
168struct pwrdm_ops {
169 int (*pwrdm_set_next_pwrst)(struct powerdomain *pwrdm, u8 pwrst);
170 int (*pwrdm_read_next_pwrst)(struct powerdomain *pwrdm);
171 int (*pwrdm_read_pwrst)(struct powerdomain *pwrdm);
172 int (*pwrdm_read_prev_pwrst)(struct powerdomain *pwrdm);
173 int (*pwrdm_set_logic_retst)(struct powerdomain *pwrdm, u8 pwrst);
174 int (*pwrdm_set_mem_onst)(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
175 int (*pwrdm_set_mem_retst)(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
176 int (*pwrdm_read_logic_pwrst)(struct powerdomain *pwrdm);
177 int (*pwrdm_read_prev_logic_pwrst)(struct powerdomain *pwrdm);
178 int (*pwrdm_read_logic_retst)(struct powerdomain *pwrdm);
179 int (*pwrdm_read_mem_pwrst)(struct powerdomain *pwrdm, u8 bank);
180 int (*pwrdm_read_prev_mem_pwrst)(struct powerdomain *pwrdm, u8 bank);
181 int (*pwrdm_read_mem_retst)(struct powerdomain *pwrdm, u8 bank);
182 int (*pwrdm_clear_all_prev_pwrst)(struct powerdomain *pwrdm);
183 int (*pwrdm_enable_hdwr_sar)(struct powerdomain *pwrdm);
184 int (*pwrdm_disable_hdwr_sar)(struct powerdomain *pwrdm);
185 int (*pwrdm_set_lowpwrstchange)(struct powerdomain *pwrdm);
186 int (*pwrdm_wait_transition)(struct powerdomain *pwrdm);
187};
ad67ef68 188
129c65ee
PW
189int pwrdm_register_platform_funcs(struct pwrdm_ops *custom_funcs);
190int pwrdm_register_pwrdms(struct powerdomain **pwrdm_list);
191int pwrdm_complete_init(void);
ad67ef68 192
ad67ef68
PW
193struct powerdomain *pwrdm_lookup(const char *name);
194
a23456e9
PDS
195int pwrdm_for_each(int (*fn)(struct powerdomain *pwrdm, void *user),
196 void *user);
ee894b18
AB
197int pwrdm_for_each_nolock(int (*fn)(struct powerdomain *pwrdm, void *user),
198 void *user);
ad67ef68 199
8420bb13
PW
200int pwrdm_add_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm);
201int pwrdm_del_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm);
202int pwrdm_for_each_clkdm(struct powerdomain *pwrdm,
203 int (*fn)(struct powerdomain *pwrdm,
204 struct clockdomain *clkdm));
048a7034 205struct voltagedomain *pwrdm_get_voltdm(struct powerdomain *pwrdm);
8420bb13 206
ad67ef68
PW
207int pwrdm_get_mem_bank_count(struct powerdomain *pwrdm);
208
209int pwrdm_set_next_pwrst(struct powerdomain *pwrdm, u8 pwrst);
210int pwrdm_read_next_pwrst(struct powerdomain *pwrdm);
fecb494b 211int pwrdm_read_pwrst(struct powerdomain *pwrdm);
ad67ef68
PW
212int pwrdm_read_prev_pwrst(struct powerdomain *pwrdm);
213int pwrdm_clear_all_prev_pwrst(struct powerdomain *pwrdm);
214
215int pwrdm_set_logic_retst(struct powerdomain *pwrdm, u8 pwrst);
216int pwrdm_set_mem_onst(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
217int pwrdm_set_mem_retst(struct powerdomain *pwrdm, u8 bank, u8 pwrst);
218
219int pwrdm_read_logic_pwrst(struct powerdomain *pwrdm);
220int pwrdm_read_prev_logic_pwrst(struct powerdomain *pwrdm);
1e3d0d2b 221int pwrdm_read_logic_retst(struct powerdomain *pwrdm);
ad67ef68
PW
222int pwrdm_read_mem_pwrst(struct powerdomain *pwrdm, u8 bank);
223int pwrdm_read_prev_mem_pwrst(struct powerdomain *pwrdm, u8 bank);
1e3d0d2b 224int pwrdm_read_mem_retst(struct powerdomain *pwrdm, u8 bank);
ad67ef68 225
0b7cbfb5
PW
226int pwrdm_enable_hdwr_sar(struct powerdomain *pwrdm);
227int pwrdm_disable_hdwr_sar(struct powerdomain *pwrdm);
228bool pwrdm_has_hdwr_sar(struct powerdomain *pwrdm);
229
ad67ef68
PW
230int pwrdm_wait_transition(struct powerdomain *pwrdm);
231
ba20bb12 232int pwrdm_state_switch(struct powerdomain *pwrdm);
e0555489
KH
233int pwrdm_pre_transition(struct powerdomain *pwrdm);
234int pwrdm_post_transition(struct powerdomain *pwrdm);
04aeae77 235int pwrdm_set_lowpwrstchange(struct powerdomain *pwrdm);
fc013873 236int pwrdm_get_context_loss_count(struct powerdomain *pwrdm);
694606c4 237bool pwrdm_can_ever_lose_context(struct powerdomain *pwrdm);
ba20bb12 238
8179488a
PW
239extern void omap242x_powerdomains_init(void);
240extern void omap243x_powerdomains_init(void);
6e01478a 241extern void omap3xxx_powerdomains_init(void);
3f0ea764 242extern void am33xx_powerdomains_init(void);
6e01478a
PW
243extern void omap44xx_powerdomains_init(void);
244
72e06d08
PW
245extern struct pwrdm_ops omap2_pwrdm_operations;
246extern struct pwrdm_ops omap3_pwrdm_operations;
3f0ea764 247extern struct pwrdm_ops am33xx_pwrdm_operations;
72e06d08
PW
248extern struct pwrdm_ops omap4_pwrdm_operations;
249
250/* Common Internal functions used across OMAP rev's */
251extern u32 omap2_pwrdm_get_mem_bank_onstate_mask(u8 bank);
252extern u32 omap2_pwrdm_get_mem_bank_retst_mask(u8 bank);
253extern u32 omap2_pwrdm_get_mem_bank_stst_mask(u8 bank);
254
255extern struct powerdomain wkup_omap2_pwrdm;
256extern struct powerdomain gfx_omap2_pwrdm;
257
258
ad67ef68 259#endif
This page took 0.545754 seconds and 5 git commands to generate.