2 * OMAP4 CM instance functions
4 * Copyright (C) 2009 Nokia Corporation
5 * Copyright (C) 2008-2011 Texas Instruments, Inc.
7 * Rajendra Nayak <rnayak@ti.com>
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.
13 * This is needed since CM instances can be in the PRM, PRCM_MPU, CM1,
14 * or CM2 hardware modules. For example, the EMU_CM CM instance is in
15 * the PRM hardware module. What a mess...
18 #include <linux/kernel.h>
19 #include <linux/types.h>
20 #include <linux/errno.h>
21 #include <linux/err.h>
24 #include "clockdomain.h"
29 #include "cminst44xx.h"
30 #include "cm-regbits-34xx.h"
33 #include "prcm_mpu44xx.h"
34 #include "prcm-common.h"
36 #define OMAP4430_IDLEST_SHIFT 16
37 #define OMAP4430_IDLEST_MASK (0x3 << 16)
38 #define OMAP4430_CLKTRCTRL_SHIFT 0
39 #define OMAP4430_CLKTRCTRL_MASK (0x3 << 0)
40 #define OMAP4430_MODULEMODE_SHIFT 0
41 #define OMAP4430_MODULEMODE_MASK (0x3 << 0)
44 * CLKCTRL_IDLEST_*: possible values for the CM_*_CLKCTRL.IDLEST bitfield:
46 * 0x0 func: Module is fully functional, including OCP
47 * 0x1 trans: Module is performing transition: wakeup, or sleep, or sleep
49 * 0x2 idle: Module is in Idle mode (only OCP part). It is functional if
50 * using separate functional clock
51 * 0x3 disabled: Module is disabled and cannot be accessed
54 #define CLKCTRL_IDLEST_FUNCTIONAL 0x0
55 #define CLKCTRL_IDLEST_INTRANSITION 0x1
56 #define CLKCTRL_IDLEST_INTERFACE_IDLE 0x2
57 #define CLKCTRL_IDLEST_DISABLED 0x3
59 static void __iomem
*_cm_bases
[OMAP4_MAX_PRCM_PARTITIONS
];
62 * omap_cm_base_init - Populates the cm partitions
64 * Populates the base addresses of the _cm_bases
65 * array used for read/write of cm module registers.
67 void omap_cm_base_init(void)
69 _cm_bases
[OMAP4430_PRM_PARTITION
] = prm_base
;
70 _cm_bases
[OMAP4430_CM1_PARTITION
] = cm_base
;
71 _cm_bases
[OMAP4430_CM2_PARTITION
] = cm2_base
;
72 _cm_bases
[OMAP4430_PRCM_MPU_PARTITION
] = prcm_mpu_base
;
75 /* Private functions */
78 * _clkctrl_idlest - read a CM_*_CLKCTRL register; mask & shift IDLEST bitfield
79 * @part: PRCM partition ID that the CM_CLKCTRL register exists in
80 * @inst: CM instance register offset (*_INST macro)
81 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
82 * @clkctrl_offs: Module clock control register offset (*_CLKCTRL macro)
84 * Return the IDLEST bitfield of a CM_*_CLKCTRL register, shifted down to
87 static u32
_clkctrl_idlest(u8 part
, u16 inst
, s16 cdoffs
, u16 clkctrl_offs
)
89 u32 v
= omap4_cminst_read_inst_reg(part
, inst
, clkctrl_offs
);
90 v
&= OMAP4430_IDLEST_MASK
;
91 v
>>= OMAP4430_IDLEST_SHIFT
;
96 * _is_module_ready - can module registers be accessed without causing an abort?
97 * @part: PRCM partition ID that the CM_CLKCTRL register exists in
98 * @inst: CM instance register offset (*_INST macro)
99 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
100 * @clkctrl_offs: Module clock control register offset (*_CLKCTRL macro)
102 * Returns true if the module's CM_*_CLKCTRL.IDLEST bitfield is either
103 * *FUNCTIONAL or *INTERFACE_IDLE; false otherwise.
105 static bool _is_module_ready(u8 part
, u16 inst
, s16 cdoffs
, u16 clkctrl_offs
)
109 v
= _clkctrl_idlest(part
, inst
, cdoffs
, clkctrl_offs
);
111 return (v
== CLKCTRL_IDLEST_FUNCTIONAL
||
112 v
== CLKCTRL_IDLEST_INTERFACE_IDLE
) ? true : false;
115 /* Public functions */
117 /* Read a register in a CM instance */
118 u32
omap4_cminst_read_inst_reg(u8 part
, u16 inst
, u16 idx
)
120 BUG_ON(part
>= OMAP4_MAX_PRCM_PARTITIONS
||
121 part
== OMAP4430_INVALID_PRCM_PARTITION
||
123 return readl_relaxed(_cm_bases
[part
] + inst
+ idx
);
126 /* Write into a register in a CM instance */
127 void omap4_cminst_write_inst_reg(u32 val
, u8 part
, u16 inst
, u16 idx
)
129 BUG_ON(part
>= OMAP4_MAX_PRCM_PARTITIONS
||
130 part
== OMAP4430_INVALID_PRCM_PARTITION
||
132 writel_relaxed(val
, _cm_bases
[part
] + inst
+ idx
);
135 /* Read-modify-write a register in CM1. Caller must lock */
136 u32
omap4_cminst_rmw_inst_reg_bits(u32 mask
, u32 bits
, u8 part
, u16 inst
,
141 v
= omap4_cminst_read_inst_reg(part
, inst
, idx
);
144 omap4_cminst_write_inst_reg(v
, part
, inst
, idx
);
149 u32
omap4_cminst_set_inst_reg_bits(u32 bits
, u8 part
, u16 inst
, s16 idx
)
151 return omap4_cminst_rmw_inst_reg_bits(bits
, bits
, part
, inst
, idx
);
154 u32
omap4_cminst_clear_inst_reg_bits(u32 bits
, u8 part
, u16 inst
, s16 idx
)
156 return omap4_cminst_rmw_inst_reg_bits(bits
, 0x0, part
, inst
, idx
);
159 u32
omap4_cminst_read_inst_reg_bits(u8 part
, u16 inst
, s16 idx
, u32 mask
)
163 v
= omap4_cminst_read_inst_reg(part
, inst
, idx
);
175 * _clktrctrl_write - write @c to a CM_CLKSTCTRL.CLKTRCTRL register bitfield
176 * @c: CLKTRCTRL register bitfield (LSB = bit 0, i.e., unshifted)
177 * @part: PRCM partition ID that the CM_CLKSTCTRL register exists in
178 * @inst: CM instance register offset (*_INST macro)
179 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
181 * @c must be the unshifted value for CLKTRCTRL - i.e., this function
182 * will handle the shift itself.
184 static void _clktrctrl_write(u8 c
, u8 part
, u16 inst
, u16 cdoffs
)
188 v
= omap4_cminst_read_inst_reg(part
, inst
, cdoffs
+ OMAP4_CM_CLKSTCTRL
);
189 v
&= ~OMAP4430_CLKTRCTRL_MASK
;
190 v
|= c
<< OMAP4430_CLKTRCTRL_SHIFT
;
191 omap4_cminst_write_inst_reg(v
, part
, inst
, cdoffs
+ OMAP4_CM_CLKSTCTRL
);
195 * omap4_cminst_is_clkdm_in_hwsup - is a clockdomain in hwsup idle mode?
196 * @part: PRCM partition ID that the CM_CLKSTCTRL register exists in
197 * @inst: CM instance register offset (*_INST macro)
198 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
200 * Returns true if the clockdomain referred to by (@part, @inst, @cdoffs)
201 * is in hardware-supervised idle mode, or 0 otherwise.
203 bool omap4_cminst_is_clkdm_in_hwsup(u8 part
, u16 inst
, u16 cdoffs
)
207 v
= omap4_cminst_read_inst_reg(part
, inst
, cdoffs
+ OMAP4_CM_CLKSTCTRL
);
208 v
&= OMAP4430_CLKTRCTRL_MASK
;
209 v
>>= OMAP4430_CLKTRCTRL_SHIFT
;
211 return (v
== OMAP34XX_CLKSTCTRL_ENABLE_AUTO
) ? true : false;
215 * omap4_cminst_clkdm_enable_hwsup - put a clockdomain in hwsup-idle mode
216 * @part: PRCM partition ID that the clockdomain registers exist in
217 * @inst: CM instance register offset (*_INST macro)
218 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
220 * Put a clockdomain referred to by (@part, @inst, @cdoffs) into
221 * hardware-supervised idle mode. No return value.
223 void omap4_cminst_clkdm_enable_hwsup(u8 part
, u16 inst
, u16 cdoffs
)
225 _clktrctrl_write(OMAP34XX_CLKSTCTRL_ENABLE_AUTO
, part
, inst
, cdoffs
);
229 * omap4_cminst_clkdm_disable_hwsup - put a clockdomain in swsup-idle mode
230 * @part: PRCM partition ID that the clockdomain registers exist in
231 * @inst: CM instance register offset (*_INST macro)
232 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
234 * Put a clockdomain referred to by (@part, @inst, @cdoffs) into
235 * software-supervised idle mode, i.e., controlled manually by the
236 * Linux OMAP clockdomain code. No return value.
238 void omap4_cminst_clkdm_disable_hwsup(u8 part
, u16 inst
, u16 cdoffs
)
240 _clktrctrl_write(OMAP34XX_CLKSTCTRL_DISABLE_AUTO
, part
, inst
, cdoffs
);
244 * omap4_cminst_clkdm_force_sleep - try to take a clockdomain out of idle
245 * @part: PRCM partition ID that the clockdomain registers exist in
246 * @inst: CM instance register offset (*_INST macro)
247 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
249 * Take a clockdomain referred to by (@part, @inst, @cdoffs) out of idle,
250 * waking it up. No return value.
252 void omap4_cminst_clkdm_force_wakeup(u8 part
, u16 inst
, u16 cdoffs
)
254 _clktrctrl_write(OMAP34XX_CLKSTCTRL_FORCE_WAKEUP
, part
, inst
, cdoffs
);
261 void omap4_cminst_clkdm_force_sleep(u8 part
, u16 inst
, u16 cdoffs
)
263 _clktrctrl_write(OMAP34XX_CLKSTCTRL_FORCE_SLEEP
, part
, inst
, cdoffs
);
267 * omap4_cminst_wait_module_ready - wait for a module to be in 'func' state
268 * @part: PRCM partition ID that the CM_CLKCTRL register exists in
269 * @inst: CM instance register offset (*_INST macro)
270 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
271 * @clkctrl_offs: Module clock control register offset (*_CLKCTRL macro)
273 * Wait for the module IDLEST to be functional. If the idle state is in any
274 * the non functional state (trans, idle or disabled), module and thus the
275 * sysconfig cannot be accessed and will probably lead to an "imprecise
278 int omap4_cminst_wait_module_ready(u8 part
, u16 inst
, s16 cdoffs
,
286 omap_test_timeout(_is_module_ready(part
, inst
, cdoffs
, clkctrl_offs
),
287 MAX_MODULE_READY_TIME
, i
);
289 return (i
< MAX_MODULE_READY_TIME
) ? 0 : -EBUSY
;
293 * omap4_cminst_wait_module_idle - wait for a module to be in 'disabled'
295 * @part: PRCM partition ID that the CM_CLKCTRL register exists in
296 * @inst: CM instance register offset (*_INST macro)
297 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
298 * @clkctrl_offs: Module clock control register offset (*_CLKCTRL macro)
300 * Wait for the module IDLEST to be disabled. Some PRCM transition,
301 * like reset assertion or parent clock de-activation must wait the
302 * module to be fully disabled.
304 int omap4_cminst_wait_module_idle(u8 part
, u16 inst
, s16 cdoffs
, u16 clkctrl_offs
)
311 omap_test_timeout((_clkctrl_idlest(part
, inst
, cdoffs
, clkctrl_offs
) ==
312 CLKCTRL_IDLEST_DISABLED
),
313 MAX_MODULE_DISABLE_TIME
, i
);
315 return (i
< MAX_MODULE_DISABLE_TIME
) ? 0 : -EBUSY
;
319 * omap4_cminst_module_enable - Enable the modulemode inside CLKCTRL
320 * @mode: Module mode (SW or HW)
321 * @part: PRCM partition ID that the CM_CLKCTRL register exists in
322 * @inst: CM instance register offset (*_INST macro)
323 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
324 * @clkctrl_offs: Module clock control register offset (*_CLKCTRL macro)
328 void omap4_cminst_module_enable(u8 mode
, u8 part
, u16 inst
, s16 cdoffs
,
333 v
= omap4_cminst_read_inst_reg(part
, inst
, clkctrl_offs
);
334 v
&= ~OMAP4430_MODULEMODE_MASK
;
335 v
|= mode
<< OMAP4430_MODULEMODE_SHIFT
;
336 omap4_cminst_write_inst_reg(v
, part
, inst
, clkctrl_offs
);
340 * omap4_cminst_module_disable - Disable the module inside CLKCTRL
341 * @part: PRCM partition ID that the CM_CLKCTRL register exists in
342 * @inst: CM instance register offset (*_INST macro)
343 * @cdoffs: Clockdomain register offset (*_CDOFFS macro)
344 * @clkctrl_offs: Module clock control register offset (*_CLKCTRL macro)
348 void omap4_cminst_module_disable(u8 part
, u16 inst
, s16 cdoffs
,
353 v
= omap4_cminst_read_inst_reg(part
, inst
, clkctrl_offs
);
354 v
&= ~OMAP4430_MODULEMODE_MASK
;
355 omap4_cminst_write_inst_reg(v
, part
, inst
, clkctrl_offs
);
359 * Clockdomain low-level functions
362 static int omap4_clkdm_add_wkup_sleep_dep(struct clockdomain
*clkdm1
,
363 struct clockdomain
*clkdm2
)
365 omap4_cminst_set_inst_reg_bits((1 << clkdm2
->dep_bit
),
366 clkdm1
->prcm_partition
,
367 clkdm1
->cm_inst
, clkdm1
->clkdm_offs
+
372 static int omap4_clkdm_del_wkup_sleep_dep(struct clockdomain
*clkdm1
,
373 struct clockdomain
*clkdm2
)
375 omap4_cminst_clear_inst_reg_bits((1 << clkdm2
->dep_bit
),
376 clkdm1
->prcm_partition
,
377 clkdm1
->cm_inst
, clkdm1
->clkdm_offs
+
382 static int omap4_clkdm_read_wkup_sleep_dep(struct clockdomain
*clkdm1
,
383 struct clockdomain
*clkdm2
)
385 return omap4_cminst_read_inst_reg_bits(clkdm1
->prcm_partition
,
389 (1 << clkdm2
->dep_bit
));
392 static int omap4_clkdm_clear_all_wkup_sleep_deps(struct clockdomain
*clkdm
)
394 struct clkdm_dep
*cd
;
397 if (!clkdm
->prcm_partition
)
400 for (cd
= clkdm
->wkdep_srcs
; cd
&& cd
->clkdm_name
; cd
++) {
402 continue; /* only happens if data is erroneous */
404 mask
|= 1 << cd
->clkdm
->dep_bit
;
405 cd
->wkdep_usecount
= 0;
408 omap4_cminst_clear_inst_reg_bits(mask
, clkdm
->prcm_partition
,
409 clkdm
->cm_inst
, clkdm
->clkdm_offs
+
414 static int omap4_clkdm_sleep(struct clockdomain
*clkdm
)
416 if (clkdm
->flags
& CLKDM_CAN_HWSUP
)
417 omap4_cminst_clkdm_enable_hwsup(clkdm
->prcm_partition
,
420 else if (clkdm
->flags
& CLKDM_CAN_FORCE_SLEEP
)
421 omap4_cminst_clkdm_force_sleep(clkdm
->prcm_partition
,
430 static int omap4_clkdm_wakeup(struct clockdomain
*clkdm
)
432 omap4_cminst_clkdm_force_wakeup(clkdm
->prcm_partition
,
433 clkdm
->cm_inst
, clkdm
->clkdm_offs
);
437 static void omap4_clkdm_allow_idle(struct clockdomain
*clkdm
)
439 omap4_cminst_clkdm_enable_hwsup(clkdm
->prcm_partition
,
440 clkdm
->cm_inst
, clkdm
->clkdm_offs
);
443 static void omap4_clkdm_deny_idle(struct clockdomain
*clkdm
)
445 if (clkdm
->flags
& CLKDM_CAN_FORCE_WAKEUP
)
446 omap4_clkdm_wakeup(clkdm
);
448 omap4_cminst_clkdm_disable_hwsup(clkdm
->prcm_partition
,
453 static int omap4_clkdm_clk_enable(struct clockdomain
*clkdm
)
455 if (clkdm
->flags
& CLKDM_CAN_FORCE_WAKEUP
)
456 return omap4_clkdm_wakeup(clkdm
);
461 static int omap4_clkdm_clk_disable(struct clockdomain
*clkdm
)
465 if (!clkdm
->prcm_partition
)
469 * The CLKDM_MISSING_IDLE_REPORTING flag documentation has
470 * more details on the unpleasant problem this is working
473 if (clkdm
->flags
& CLKDM_MISSING_IDLE_REPORTING
&&
474 !(clkdm
->flags
& CLKDM_CAN_FORCE_SLEEP
)) {
475 omap4_clkdm_allow_idle(clkdm
);
479 hwsup
= omap4_cminst_is_clkdm_in_hwsup(clkdm
->prcm_partition
,
480 clkdm
->cm_inst
, clkdm
->clkdm_offs
);
482 if (!hwsup
&& (clkdm
->flags
& CLKDM_CAN_FORCE_SLEEP
))
483 omap4_clkdm_sleep(clkdm
);
488 struct clkdm_ops omap4_clkdm_operations
= {
489 .clkdm_add_wkdep
= omap4_clkdm_add_wkup_sleep_dep
,
490 .clkdm_del_wkdep
= omap4_clkdm_del_wkup_sleep_dep
,
491 .clkdm_read_wkdep
= omap4_clkdm_read_wkup_sleep_dep
,
492 .clkdm_clear_all_wkdeps
= omap4_clkdm_clear_all_wkup_sleep_deps
,
493 .clkdm_add_sleepdep
= omap4_clkdm_add_wkup_sleep_dep
,
494 .clkdm_del_sleepdep
= omap4_clkdm_del_wkup_sleep_dep
,
495 .clkdm_read_sleepdep
= omap4_clkdm_read_wkup_sleep_dep
,
496 .clkdm_clear_all_sleepdeps
= omap4_clkdm_clear_all_wkup_sleep_deps
,
497 .clkdm_sleep
= omap4_clkdm_sleep
,
498 .clkdm_wakeup
= omap4_clkdm_wakeup
,
499 .clkdm_allow_idle
= omap4_clkdm_allow_idle
,
500 .clkdm_deny_idle
= omap4_clkdm_deny_idle
,
501 .clkdm_clk_enable
= omap4_clkdm_clk_enable
,
502 .clkdm_clk_disable
= omap4_clkdm_clk_disable
,
505 struct clkdm_ops am43xx_clkdm_operations
= {
506 .clkdm_sleep
= omap4_clkdm_sleep
,
507 .clkdm_wakeup
= omap4_clkdm_wakeup
,
508 .clkdm_allow_idle
= omap4_clkdm_allow_idle
,
509 .clkdm_deny_idle
= omap4_clkdm_deny_idle
,
510 .clkdm_clk_enable
= omap4_clkdm_clk_enable
,
511 .clkdm_clk_disable
= omap4_clkdm_clk_disable
,