ARM: OMAP2+: PRM: add generic API for asserting hardware reset
[cascardo/linux.git] / arch / arm / mach-omap2 / prm2xxx_3xxx.c
1 /*
2  * OMAP2/3 PRM module functions
3  *
4  * Copyright (C) 2010-2011 Texas Instruments, Inc.
5  * Copyright (C) 2010 Nokia Corporation
6  * BenoĆ®t Cousson
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
14 #include <linux/kernel.h>
15 #include <linux/errno.h>
16 #include <linux/err.h>
17 #include <linux/io.h>
18
19 #include "powerdomain.h"
20 #include "prm2xxx_3xxx.h"
21 #include "prm-regbits-24xx.h"
22 #include "clockdomain.h"
23
24 /**
25  * omap2_prm_is_hardreset_asserted - read the HW reset line state of
26  * submodules contained in the hwmod module
27  * @prm_mod: PRM submodule base (e.g. CORE_MOD)
28  * @shift: register bit shift corresponding to the reset line to check
29  *
30  * Returns 1 if the (sub)module hardreset line is currently asserted,
31  * 0 if the (sub)module hardreset line is not currently asserted, or
32  * -EINVAL if called while running on a non-OMAP2/3 chip.
33  */
34 int omap2_prm_is_hardreset_asserted(s16 prm_mod, u8 shift)
35 {
36         return omap2_prm_read_mod_bits_shift(prm_mod, OMAP2_RM_RSTCTRL,
37                                        (1 << shift));
38 }
39
40 /**
41  * omap2_prm_assert_hardreset - assert the HW reset line of a submodule
42  * @shift: register bit shift corresponding to the reset line to assert
43  * @part: PRM partition, ignored for OMAP2
44  * @prm_mod: PRM submodule base (e.g. CORE_MOD)
45  * @offset: register offset, ignored for OMAP2
46  *
47  * Some IPs like dsp or iva contain processors that require an HW
48  * reset line to be asserted / deasserted in order to fully enable the
49  * IP.  These modules may have multiple hard-reset lines that reset
50  * different 'submodules' inside the IP block.  This function will
51  * place the submodule into reset.  Returns 0 upon success or -EINVAL
52  * upon an argument error.
53  */
54 int omap2_prm_assert_hardreset(u8 shift, u8 part, s16 prm_mod, u16 offset)
55 {
56         u32 mask;
57
58         mask = 1 << shift;
59         omap2_prm_rmw_mod_reg_bits(mask, mask, prm_mod, OMAP2_RM_RSTCTRL);
60
61         return 0;
62 }
63
64 /**
65  * omap2_prm_deassert_hardreset - deassert a submodule hardreset line and wait
66  * @prm_mod: PRM submodule base (e.g. CORE_MOD)
67  * @rst_shift: register bit shift corresponding to the reset line to deassert
68  * @st_shift: register bit shift for the status of the deasserted submodule
69  *
70  * Some IPs like dsp or iva contain processors that require an HW
71  * reset line to be asserted / deasserted in order to fully enable the
72  * IP.  These modules may have multiple hard-reset lines that reset
73  * different 'submodules' inside the IP block.  This function will
74  * take the submodule out of reset and wait until the PRCM indicates
75  * that the reset has completed before returning.  Returns 0 upon success or
76  * -EINVAL upon an argument error, -EEXIST if the submodule was already out
77  * of reset, or -EBUSY if the submodule did not exit reset promptly.
78  */
79 int omap2_prm_deassert_hardreset(s16 prm_mod, u8 rst_shift, u8 st_shift)
80 {
81         u32 rst, st;
82         int c;
83
84         rst = 1 << rst_shift;
85         st = 1 << st_shift;
86
87         /* Check the current status to avoid de-asserting the line twice */
88         if (omap2_prm_read_mod_bits_shift(prm_mod, OMAP2_RM_RSTCTRL, rst) == 0)
89                 return -EEXIST;
90
91         /* Clear the reset status by writing 1 to the status bit */
92         omap2_prm_rmw_mod_reg_bits(0xffffffff, st, prm_mod, OMAP2_RM_RSTST);
93         /* de-assert the reset control line */
94         omap2_prm_rmw_mod_reg_bits(rst, 0, prm_mod, OMAP2_RM_RSTCTRL);
95         /* wait the status to be set */
96         omap_test_timeout(omap2_prm_read_mod_bits_shift(prm_mod, OMAP2_RM_RSTST,
97                                                   st),
98                           MAX_MODULE_HARDRESET_WAIT, c);
99
100         return (c == MAX_MODULE_HARDRESET_WAIT) ? -EBUSY : 0;
101 }
102
103
104 /* Powerdomain low-level functions */
105
106 /* Common functions across OMAP2 and OMAP3 */
107 int omap2_pwrdm_set_mem_onst(struct powerdomain *pwrdm, u8 bank,
108                                                                 u8 pwrst)
109 {
110         u32 m;
111
112         m = omap2_pwrdm_get_mem_bank_onstate_mask(bank);
113
114         omap2_prm_rmw_mod_reg_bits(m, (pwrst << __ffs(m)), pwrdm->prcm_offs,
115                                    OMAP2_PM_PWSTCTRL);
116
117         return 0;
118 }
119
120 int omap2_pwrdm_set_mem_retst(struct powerdomain *pwrdm, u8 bank,
121                                                                 u8 pwrst)
122 {
123         u32 m;
124
125         m = omap2_pwrdm_get_mem_bank_retst_mask(bank);
126
127         omap2_prm_rmw_mod_reg_bits(m, (pwrst << __ffs(m)), pwrdm->prcm_offs,
128                                    OMAP2_PM_PWSTCTRL);
129
130         return 0;
131 }
132
133 int omap2_pwrdm_read_mem_pwrst(struct powerdomain *pwrdm, u8 bank)
134 {
135         u32 m;
136
137         m = omap2_pwrdm_get_mem_bank_stst_mask(bank);
138
139         return omap2_prm_read_mod_bits_shift(pwrdm->prcm_offs, OMAP2_PM_PWSTST,
140                                              m);
141 }
142
143 int omap2_pwrdm_read_mem_retst(struct powerdomain *pwrdm, u8 bank)
144 {
145         u32 m;
146
147         m = omap2_pwrdm_get_mem_bank_retst_mask(bank);
148
149         return omap2_prm_read_mod_bits_shift(pwrdm->prcm_offs,
150                                              OMAP2_PM_PWSTCTRL, m);
151 }
152
153 int omap2_pwrdm_set_logic_retst(struct powerdomain *pwrdm, u8 pwrst)
154 {
155         u32 v;
156
157         v = pwrst << __ffs(OMAP_LOGICRETSTATE_MASK);
158         omap2_prm_rmw_mod_reg_bits(OMAP_LOGICRETSTATE_MASK, v, pwrdm->prcm_offs,
159                                    OMAP2_PM_PWSTCTRL);
160
161         return 0;
162 }
163
164 int omap2_pwrdm_wait_transition(struct powerdomain *pwrdm)
165 {
166         u32 c = 0;
167
168         /*
169          * REVISIT: pwrdm_wait_transition() may be better implemented
170          * via a callback and a periodic timer check -- how long do we expect
171          * powerdomain transitions to take?
172          */
173
174         /* XXX Is this udelay() value meaningful? */
175         while ((omap2_prm_read_mod_reg(pwrdm->prcm_offs, OMAP2_PM_PWSTST) &
176                 OMAP_INTRANSITION_MASK) &&
177                 (c++ < PWRDM_TRANSITION_BAILOUT))
178                         udelay(1);
179
180         if (c > PWRDM_TRANSITION_BAILOUT) {
181                 pr_err("powerdomain: %s: waited too long to complete transition\n",
182                        pwrdm->name);
183                 return -EAGAIN;
184         }
185
186         pr_debug("powerdomain: completed transition in %d loops\n", c);
187
188         return 0;
189 }
190
191 int omap2_clkdm_add_wkdep(struct clockdomain *clkdm1,
192                           struct clockdomain *clkdm2)
193 {
194         omap2_prm_set_mod_reg_bits((1 << clkdm2->dep_bit),
195                                    clkdm1->pwrdm.ptr->prcm_offs, PM_WKDEP);
196         return 0;
197 }
198
199 int omap2_clkdm_del_wkdep(struct clockdomain *clkdm1,
200                           struct clockdomain *clkdm2)
201 {
202         omap2_prm_clear_mod_reg_bits((1 << clkdm2->dep_bit),
203                                      clkdm1->pwrdm.ptr->prcm_offs, PM_WKDEP);
204         return 0;
205 }
206
207 int omap2_clkdm_read_wkdep(struct clockdomain *clkdm1,
208                            struct clockdomain *clkdm2)
209 {
210         return omap2_prm_read_mod_bits_shift(clkdm1->pwrdm.ptr->prcm_offs,
211                                              PM_WKDEP, (1 << clkdm2->dep_bit));
212 }
213
214 /* XXX Caller must hold the clkdm's powerdomain lock */
215 int omap2_clkdm_clear_all_wkdeps(struct clockdomain *clkdm)
216 {
217         struct clkdm_dep *cd;
218         u32 mask = 0;
219
220         for (cd = clkdm->wkdep_srcs; cd && cd->clkdm_name; cd++) {
221                 if (!cd->clkdm)
222                         continue; /* only happens if data is erroneous */
223
224                 /* PRM accesses are slow, so minimize them */
225                 mask |= 1 << cd->clkdm->dep_bit;
226                 cd->wkdep_usecount = 0;
227         }
228
229         omap2_prm_clear_mod_reg_bits(mask, clkdm->pwrdm.ptr->prcm_offs,
230                                      PM_WKDEP);
231         return 0;
232 }
233