2 * Copyright (c) 2015, 2017-2018, The Linux Foundation. All rights reserved.
4 * This program is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU General Public License version 2 and
6 * only version 2 as published by the Free Software Foundation.
8 * This program is distributed in the hope that it will be useful,
9 * but WITHOUT ANY WARRANTY; without even the implied warranty of
10 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
11 * GNU General Public License for more details.
14 #include <linux/bitops.h>
15 #include <linux/delay.h>
16 #include <linux/err.h>
17 #include <linux/jiffies.h>
18 #include <linux/kernel.h>
19 #include <linux/ktime.h>
20 #include <linux/pm_domain.h>
21 #include <linux/regmap.h>
22 #include <linux/reset-controller.h>
23 #include <linux/slab.h>
26 #define PWR_ON_MASK BIT(31)
27 #define EN_REST_WAIT_MASK GENMASK_ULL(23, 20)
28 #define EN_FEW_WAIT_MASK GENMASK_ULL(19, 16)
29 #define CLK_DIS_WAIT_MASK GENMASK_ULL(15, 12)
30 #define SW_OVERRIDE_MASK BIT(2)
31 #define HW_CONTROL_MASK BIT(1)
32 #define SW_COLLAPSE_MASK BIT(0)
33 #define GMEM_CLAMP_IO_MASK BIT(0)
34 #define GMEM_RESET_MASK BIT(4)
37 #define GDSC_POWER_UP_COMPLETE BIT(16)
38 #define GDSC_POWER_DOWN_COMPLETE BIT(15)
39 #define CFG_GDSCR_OFFSET 0x4
41 /* Wait 2^n CXO cycles between all states. Here, n=2 (4 cycles). */
42 #define EN_REST_WAIT_VAL (0x2 << 20)
43 #define EN_FEW_WAIT_VAL (0x8 << 16)
44 #define CLK_DIS_WAIT_VAL (0x2 << 12)
46 #define RETAIN_MEM BIT(14)
47 #define RETAIN_PERIPH BIT(13)
49 #define TIMEOUT_US 500
51 #define domain_to_gdsc(domain) container_of(domain, struct gdsc, pd)
58 /* Returns 1 if GDSC status is status, 0 if not, and < 0 on error */
59 static int gdsc_check_status(struct gdsc
*sc
, enum gdsc_status status
)
65 if (sc
->flags
& POLL_CFG_GDSCR
)
66 reg
= sc
->gdscr
+ CFG_GDSCR_OFFSET
;
67 else if (sc
->gds_hw_ctrl
)
68 reg
= sc
->gds_hw_ctrl
;
72 ret
= regmap_read(sc
->regmap
, reg
, &val
);
76 if (sc
->flags
& POLL_CFG_GDSCR
) {
79 return !!(val
& GDSC_POWER_UP_COMPLETE
);
81 return !!(val
& GDSC_POWER_DOWN_COMPLETE
);
87 return !!(val
& PWR_ON_MASK
);
89 return !(val
& PWR_ON_MASK
);
95 static int gdsc_hwctrl(struct gdsc
*sc
, bool en
)
97 u32 val
= en
? HW_CONTROL_MASK
: 0;
99 return regmap_update_bits(sc
->regmap
, sc
->gdscr
, HW_CONTROL_MASK
, val
);
102 static int gdsc_poll_status(struct gdsc
*sc
, enum gdsc_status status
)
108 if (gdsc_check_status(sc
, status
))
110 } while (ktime_us_delta(ktime_get(), start
) < TIMEOUT_US
);
112 if (gdsc_check_status(sc
, status
))
118 static int gdsc_toggle_logic(struct gdsc
*sc
, enum gdsc_status status
)
121 u32 val
= (status
== GDSC_ON
) ? 0 : SW_COLLAPSE_MASK
;
123 ret
= regmap_update_bits(sc
->regmap
, sc
->gdscr
, SW_COLLAPSE_MASK
, val
);
127 /* If disabling votable gdscs, don't poll on status */
128 if ((sc
->flags
& VOTABLE
) && status
== GDSC_OFF
) {
130 * Add a short delay here to ensure that an enable
131 * right after it was disabled does not put it in an
138 if (sc
->gds_hw_ctrl
) {
140 * The gds hw controller asserts/de-asserts the status bit soon
141 * after it receives a power on/off request from a master.
142 * The controller then takes around 8 xo cycles to start its
143 * internal state machine and update the status bit. During
144 * this time, the status bit does not reflect the true status
146 * Add a delay of 1 us between writing to the SW_COLLAPSE bit
147 * and polling the status bit.
152 return gdsc_poll_status(sc
, status
);
155 static inline int gdsc_deassert_reset(struct gdsc
*sc
)
159 for (i
= 0; i
< sc
->reset_count
; i
++)
160 sc
->rcdev
->ops
->deassert(sc
->rcdev
, sc
->resets
[i
]);
164 static inline int gdsc_assert_reset(struct gdsc
*sc
)
168 for (i
= 0; i
< sc
->reset_count
; i
++)
169 sc
->rcdev
->ops
->assert(sc
->rcdev
, sc
->resets
[i
]);
173 static inline void gdsc_force_mem_on(struct gdsc
*sc
)
176 u32 mask
= RETAIN_MEM
| RETAIN_PERIPH
;
178 for (i
= 0; i
< sc
->cxc_count
; i
++)
179 regmap_update_bits(sc
->regmap
, sc
->cxcs
[i
], mask
, mask
);
182 static inline void gdsc_clear_mem_on(struct gdsc
*sc
)
185 u32 mask
= RETAIN_MEM
| RETAIN_PERIPH
;
187 for (i
= 0; i
< sc
->cxc_count
; i
++)
188 regmap_update_bits(sc
->regmap
, sc
->cxcs
[i
], mask
, 0);
191 static inline void gdsc_deassert_clamp_io(struct gdsc
*sc
)
193 regmap_update_bits(sc
->regmap
, sc
->clamp_io_ctrl
,
194 GMEM_CLAMP_IO_MASK
, 0);
197 static inline void gdsc_assert_clamp_io(struct gdsc
*sc
)
199 regmap_update_bits(sc
->regmap
, sc
->clamp_io_ctrl
,
200 GMEM_CLAMP_IO_MASK
, 1);
203 static inline void gdsc_assert_reset_aon(struct gdsc
*sc
)
205 regmap_update_bits(sc
->regmap
, sc
->clamp_io_ctrl
,
208 regmap_update_bits(sc
->regmap
, sc
->clamp_io_ctrl
,
211 static int gdsc_enable(struct generic_pm_domain
*domain
)
213 struct gdsc
*sc
= domain_to_gdsc(domain
);
216 if (sc
->pwrsts
== PWRSTS_ON
)
217 return gdsc_deassert_reset(sc
);
219 if (sc
->flags
& SW_RESET
) {
220 gdsc_assert_reset(sc
);
222 gdsc_deassert_reset(sc
);
225 if (sc
->flags
& CLAMP_IO
) {
226 if (sc
->flags
& AON_RESET
)
227 gdsc_assert_reset_aon(sc
);
228 gdsc_deassert_clamp_io(sc
);
231 ret
= gdsc_toggle_logic(sc
, GDSC_ON
);
235 if (sc
->pwrsts
& PWRSTS_OFF
)
236 gdsc_force_mem_on(sc
);
239 * If clocks to this power domain were already on, they will take an
240 * additional 4 clock cycles to re-enable after the power domain is
241 * enabled. Delay to account for this. A delay is also needed to ensure
242 * clocks are not enabled within 400ns of enabling power to the
247 /* Turn on HW trigger mode if supported */
248 if (sc
->flags
& HW_CTRL
) {
249 ret
= gdsc_hwctrl(sc
, true);
253 * Wait for the GDSC to go through a power down and
254 * up cycle. In case a firmware ends up polling status
255 * bits for the gdsc, it might read an 'on' status before
256 * the GDSC can finish the power cycle.
257 * We wait 1us before returning to ensure the firmware
258 * can't immediately poll the status bits.
266 static int gdsc_disable(struct generic_pm_domain
*domain
)
268 struct gdsc
*sc
= domain_to_gdsc(domain
);
271 if (sc
->pwrsts
== PWRSTS_ON
)
272 return gdsc_assert_reset(sc
);
274 /* Turn off HW trigger mode if supported */
275 if (sc
->flags
& HW_CTRL
) {
276 ret
= gdsc_hwctrl(sc
, false);
280 * Wait for the GDSC to go through a power down and
281 * up cycle. In case we end up polling status
282 * bits for the gdsc before the power cycle is completed
283 * it might read an 'on' status wrongly.
287 ret
= gdsc_poll_status(sc
, GDSC_ON
);
292 if (sc
->pwrsts
& PWRSTS_OFF
)
293 gdsc_clear_mem_on(sc
);
295 ret
= gdsc_toggle_logic(sc
, GDSC_OFF
);
299 if (sc
->flags
& CLAMP_IO
)
300 gdsc_assert_clamp_io(sc
);
305 static int gdsc_init(struct gdsc
*sc
)
311 * Disable HW trigger: collapse/restore occur based on registers writes.
312 * Disable SW override: Use hardware state-machine for sequencing.
313 * Configure wait time between states.
315 mask
= HW_CONTROL_MASK
| SW_OVERRIDE_MASK
|
316 EN_REST_WAIT_MASK
| EN_FEW_WAIT_MASK
| CLK_DIS_WAIT_MASK
;
317 val
= EN_REST_WAIT_VAL
| EN_FEW_WAIT_VAL
| CLK_DIS_WAIT_VAL
;
318 ret
= regmap_update_bits(sc
->regmap
, sc
->gdscr
, mask
, val
);
322 /* Force gdsc ON if only ON state is supported */
323 if (sc
->pwrsts
== PWRSTS_ON
) {
324 ret
= gdsc_toggle_logic(sc
, GDSC_ON
);
329 on
= gdsc_check_status(sc
, GDSC_ON
);
334 * Votable GDSCs can be ON due to Vote from other masters.
335 * If a Votable GDSC is ON, make sure we have a Vote.
337 if ((sc
->flags
& VOTABLE
) && on
)
338 gdsc_enable(&sc
->pd
);
340 /* If ALWAYS_ON GDSCs are not ON, turn them ON */
341 if (sc
->flags
& ALWAYS_ON
) {
343 gdsc_enable(&sc
->pd
);
345 sc
->pd
.flags
|= GENPD_FLAG_ALWAYS_ON
;
348 if (on
|| (sc
->pwrsts
& PWRSTS_RET
))
349 gdsc_force_mem_on(sc
);
351 gdsc_clear_mem_on(sc
);
353 sc
->pd
.power_off
= gdsc_disable
;
354 sc
->pd
.power_on
= gdsc_enable
;
355 pm_genpd_init(&sc
->pd
, NULL
, !on
);
360 int gdsc_register(struct gdsc_desc
*desc
,
361 struct reset_controller_dev
*rcdev
, struct regmap
*regmap
)
364 struct genpd_onecell_data
*data
;
365 struct device
*dev
= desc
->dev
;
366 struct gdsc
**scs
= desc
->scs
;
367 size_t num
= desc
->num
;
369 data
= devm_kzalloc(dev
, sizeof(*data
), GFP_KERNEL
);
373 data
->domains
= devm_kcalloc(dev
, num
, sizeof(*data
->domains
),
378 data
->num_domains
= num
;
379 for (i
= 0; i
< num
; i
++) {
382 scs
[i
]->regmap
= regmap
;
383 scs
[i
]->rcdev
= rcdev
;
384 ret
= gdsc_init(scs
[i
]);
387 data
->domains
[i
] = &scs
[i
]->pd
;
391 for (i
= 0; i
< num
; i
++) {
395 pm_genpd_add_subdomain(scs
[i
]->parent
, &scs
[i
]->pd
);
398 return of_genpd_add_provider_onecell(dev
->of_node
, data
);
401 void gdsc_unregister(struct gdsc_desc
*desc
)
404 struct device
*dev
= desc
->dev
;
405 struct gdsc
**scs
= desc
->scs
;
406 size_t num
= desc
->num
;
408 /* Remove subdomains */
409 for (i
= 0; i
< num
; i
++) {
413 pm_genpd_remove_subdomain(scs
[i
]->parent
, &scs
[i
]->pd
);
415 of_genpd_del_provider(dev
->of_node
);