2 * OMAP powerdomain control
4 * Copyright (C) 2007-2008, 2011 Texas Instruments, Inc.
5 * Copyright (C) 2007-2011 Nokia Corporation
7 * Written by Paul Walmsley
8 * Added OMAP4 specific support by Abhijit Pagare <abhijitpagare@ti.com>
9 * State counting code by Tero Kristo <tero.kristo@nokia.com>
11 * This program is free software; you can redistribute it and/or modify
12 * it under the terms of the GNU General Public License version 2 as
13 * published by the Free Software Foundation.
17 #include <linux/kernel.h>
18 #include <linux/types.h>
19 #include <linux/list.h>
20 #include <linux/errno.h>
21 #include <linux/string.h>
22 #include <linux/spinlock.h>
23 #include <trace/events/power.h>
25 #include "cm2xxx_3xxx.h"
28 #include "prm2xxx_3xxx.h"
33 #include "powerdomain.h"
34 #include "clockdomain.h"
40 #define PWRDM_TRACE_STATES_FLAG (1<<31)
48 * Types of sleep_switch used internally in omap_set_pwrdm_state()
49 * and its associated static functions
51 * XXX Better documentation is needed here
53 #define ALREADYACTIVE_SWITCH 0
54 #define FORCEWAKEUP_SWITCH 1
55 #define LOWPOWERSTATE_SWITCH 2
57 /* pwrdm_list contains all registered struct powerdomains */
58 static LIST_HEAD(pwrdm_list);
60 static struct pwrdm_ops *arch_pwrdm;
62 /* Private functions */
64 static struct powerdomain *_pwrdm_lookup(const char *name)
66 struct powerdomain *pwrdm, *temp_pwrdm;
70 list_for_each_entry(temp_pwrdm, &pwrdm_list, node) {
71 if (!strcmp(name, temp_pwrdm->name)) {
81 * _pwrdm_register - register a powerdomain
82 * @pwrdm: struct powerdomain * to register
84 * Adds a powerdomain to the internal powerdomain list. Returns
85 * -EINVAL if given a null pointer, -EEXIST if a powerdomain is
86 * already registered by the provided name, or 0 upon success.
88 static int _pwrdm_register(struct powerdomain *pwrdm)
91 struct voltagedomain *voltdm;
93 if (!pwrdm || !pwrdm->name)
96 if (cpu_is_omap44xx() &&
97 pwrdm->prcm_partition == OMAP4430_INVALID_PRCM_PARTITION) {
98 pr_err("powerdomain: %s: missing OMAP4 PRCM partition ID\n",
103 if (_pwrdm_lookup(pwrdm->name))
106 if (arch_pwrdm && arch_pwrdm->pwrdm_has_voltdm)
107 if (!arch_pwrdm->pwrdm_has_voltdm())
110 voltdm = voltdm_lookup(pwrdm->voltdm.name);
112 pr_err("powerdomain: %s: voltagedomain %s does not exist\n",
113 pwrdm->name, pwrdm->voltdm.name);
116 pwrdm->voltdm.ptr = voltdm;
117 INIT_LIST_HEAD(&pwrdm->voltdm_node);
119 spin_lock_init(&pwrdm->_lock);
121 list_add(&pwrdm->node, &pwrdm_list);
123 /* Initialize the powerdomain's state counter */
124 for (i = 0; i < PWRDM_MAX_PWRSTS; i++)
125 pwrdm->state_counter[i] = 0;
127 pwrdm->ret_logic_off_counter = 0;
128 for (i = 0; i < pwrdm->banks; i++)
129 pwrdm->ret_mem_off_counter[i] = 0;
131 if (arch_pwrdm && arch_pwrdm->pwrdm_wait_transition)
132 arch_pwrdm->pwrdm_wait_transition(pwrdm);
133 pwrdm->state = pwrdm_read_pwrst(pwrdm);
134 pwrdm->state_counter[pwrdm->state] = 1;
136 pr_debug("powerdomain: registered %s\n", pwrdm->name);
141 static void _update_logic_membank_counters(struct powerdomain *pwrdm)
144 u8 prev_logic_pwrst, prev_mem_pwrst;
146 prev_logic_pwrst = pwrdm_read_prev_logic_pwrst(pwrdm);
147 if ((pwrdm->pwrsts_logic_ret == PWRSTS_OFF_RET) &&
148 (prev_logic_pwrst == PWRDM_POWER_OFF))
149 pwrdm->ret_logic_off_counter++;
151 for (i = 0; i < pwrdm->banks; i++) {
152 prev_mem_pwrst = pwrdm_read_prev_mem_pwrst(pwrdm, i);
154 if ((pwrdm->pwrsts_mem_ret[i] == PWRSTS_OFF_RET) &&
155 (prev_mem_pwrst == PWRDM_POWER_OFF))
156 pwrdm->ret_mem_off_counter[i]++;
160 static int _pwrdm_state_switch(struct powerdomain *pwrdm, int flag)
163 int prev, next, state, trace_state = 0;
168 state = pwrdm_read_pwrst(pwrdm);
171 case PWRDM_STATE_NOW:
174 case PWRDM_STATE_PREV:
175 prev = pwrdm_read_prev_pwrst(pwrdm);
176 if (pwrdm->state != prev)
177 pwrdm->state_counter[prev]++;
178 if (prev == PWRDM_POWER_RET)
179 _update_logic_membank_counters(pwrdm);
181 * If the power domain did not hit the desired state,
182 * generate a trace event with both the desired and hit states
184 next = pwrdm_read_next_pwrst(pwrdm);
186 trace_state = (PWRDM_TRACE_STATES_FLAG |
187 ((next & OMAP_POWERSTATE_MASK) << 8) |
188 ((prev & OMAP_POWERSTATE_MASK) << 0));
189 trace_power_domain_target_rcuidle(pwrdm->name,
191 raw_smp_processor_id());
199 pwrdm->state_counter[state]++;
201 pm_dbg_update_time(pwrdm, prev);
203 pwrdm->state = state;
208 static int _pwrdm_pre_transition_cb(struct powerdomain *pwrdm, void *unused)
210 pwrdm_clear_all_prev_pwrst(pwrdm);
211 _pwrdm_state_switch(pwrdm, PWRDM_STATE_NOW);
215 static int _pwrdm_post_transition_cb(struct powerdomain *pwrdm, void *unused)
217 _pwrdm_state_switch(pwrdm, PWRDM_STATE_PREV);
222 * _pwrdm_save_clkdm_state_and_activate - prepare for power state change
223 * @pwrdm: struct powerdomain * to operate on
224 * @curr_pwrst: current power state of @pwrdm
225 * @pwrst: power state to switch to
227 * Determine whether the powerdomain needs to be turned on before
228 * attempting to switch power states. Called by
229 * omap_set_pwrdm_state(). NOTE that if the powerdomain contains
230 * multiple clockdomains, this code assumes that the first clockdomain
231 * supports software-supervised wakeup mode - potentially a problem.
232 * Returns the power state switch mode currently in use (see the
233 * "Types of sleep_switch" comment above).
235 static u8 _pwrdm_save_clkdm_state_and_activate(struct powerdomain *pwrdm,
236 u8 curr_pwrst, u8 pwrst)
240 if (curr_pwrst < PWRDM_POWER_ON) {
241 if (curr_pwrst > pwrst &&
242 pwrdm->flags & PWRDM_HAS_LOWPOWERSTATECHANGE &&
243 arch_pwrdm->pwrdm_set_lowpwrstchange) {
244 sleep_switch = LOWPOWERSTATE_SWITCH;
246 clkdm_deny_idle_nolock(pwrdm->pwrdm_clkdms[0]);
247 sleep_switch = FORCEWAKEUP_SWITCH;
250 sleep_switch = ALREADYACTIVE_SWITCH;
257 * _pwrdm_restore_clkdm_state - restore the clkdm hwsup state after pwrst change
258 * @pwrdm: struct powerdomain * to operate on
259 * @sleep_switch: return value from _pwrdm_save_clkdm_state_and_activate()
261 * Restore the clockdomain state perturbed by
262 * _pwrdm_save_clkdm_state_and_activate(), and call the power state
263 * bookkeeping code. Called by omap_set_pwrdm_state(). NOTE that if
264 * the powerdomain contains multiple clockdomains, this assumes that
265 * the first associated clockdomain supports either
266 * hardware-supervised idle control in the register, or
267 * software-supervised sleep. No return value.
269 static void _pwrdm_restore_clkdm_state(struct powerdomain *pwrdm,
272 switch (sleep_switch) {
273 case FORCEWAKEUP_SWITCH:
274 clkdm_allow_idle_nolock(pwrdm->pwrdm_clkdms[0]);
276 case LOWPOWERSTATE_SWITCH:
277 if (pwrdm->flags & PWRDM_HAS_LOWPOWERSTATECHANGE &&
278 arch_pwrdm->pwrdm_set_lowpwrstchange)
279 arch_pwrdm->pwrdm_set_lowpwrstchange(pwrdm);
280 pwrdm_state_switch_nolock(pwrdm);
285 /* Public functions */
288 * pwrdm_register_platform_funcs - register powerdomain implementation fns
289 * @po: func pointers for arch specific implementations
291 * Register the list of function pointers used to implement the
292 * powerdomain functions on different OMAP SoCs. Should be called
293 * before any other pwrdm_register*() function. Returns -EINVAL if
294 * @po is null, -EEXIST if platform functions have already been
295 * registered, or 0 upon success.
297 int pwrdm_register_platform_funcs(struct pwrdm_ops *po)
311 * pwrdm_register_pwrdms - register SoC powerdomains
312 * @ps: pointer to an array of struct powerdomain to register
314 * Register the powerdomains available on a particular OMAP SoC. Must
315 * be called after pwrdm_register_platform_funcs(). May be called
316 * multiple times. Returns -EACCES if called before
317 * pwrdm_register_platform_funcs(); -EINVAL if the argument @ps is
318 * null; or 0 upon success.
320 int pwrdm_register_pwrdms(struct powerdomain **ps)
322 struct powerdomain **p = NULL;
330 for (p = ps; *p; p++)
337 * pwrdm_complete_init - set up the powerdomain layer
339 * Do whatever is necessary to initialize registered powerdomains and
340 * powerdomain code. Currently, this programs the next power state
341 * for each powerdomain to ON. This prevents powerdomains from
342 * unexpectedly losing context or entering high wakeup latency modes
343 * with non-power-management-enabled kernels. Must be called after
344 * pwrdm_register_pwrdms(). Returns -EACCES if called before
345 * pwrdm_register_pwrdms(), or 0 upon success.
347 int pwrdm_complete_init(void)
349 struct powerdomain *temp_p;
351 if (list_empty(&pwrdm_list))
354 list_for_each_entry(temp_p, &pwrdm_list, node)
355 pwrdm_set_next_pwrst(temp_p, PWRDM_POWER_ON);
361 * pwrdm_lock - acquire a Linux spinlock on a powerdomain
362 * @pwrdm: struct powerdomain * to lock
364 * Acquire the powerdomain spinlock on @pwrdm. No return value.
366 void pwrdm_lock(struct powerdomain *pwrdm)
367 __acquires(&pwrdm->_lock)
369 spin_lock_irqsave(&pwrdm->_lock, pwrdm->_lock_flags);
373 * pwrdm_unlock - release a Linux spinlock on a powerdomain
374 * @pwrdm: struct powerdomain * to unlock
376 * Release the powerdomain spinlock on @pwrdm. No return value.
378 void pwrdm_unlock(struct powerdomain *pwrdm)
379 __releases(&pwrdm->_lock)
381 spin_unlock_irqrestore(&pwrdm->_lock, pwrdm->_lock_flags);
385 * pwrdm_lookup - look up a powerdomain by name, return a pointer
386 * @name: name of powerdomain
388 * Find a registered powerdomain by its name @name. Returns a pointer
389 * to the struct powerdomain if found, or NULL otherwise.
391 struct powerdomain *pwrdm_lookup(const char *name)
393 struct powerdomain *pwrdm;
398 pwrdm = _pwrdm_lookup(name);
404 * pwrdm_for_each - call function on each registered clockdomain
405 * @fn: callback function *
407 * Call the supplied function @fn for each registered powerdomain.
408 * The callback function @fn can return anything but 0 to bail out
409 * early from the iterator. Returns the last return value of the
410 * callback function, which should be 0 for success or anything else
411 * to indicate failure; or -EINVAL if the function pointer is null.
413 int pwrdm_for_each(int (*fn)(struct powerdomain *pwrdm, void *user),
416 struct powerdomain *temp_pwrdm;
422 list_for_each_entry(temp_pwrdm, &pwrdm_list, node) {
423 ret = (*fn)(temp_pwrdm, user);
432 * pwrdm_add_clkdm - add a clockdomain to a powerdomain
433 * @pwrdm: struct powerdomain * to add the clockdomain to
434 * @clkdm: struct clockdomain * to associate with a powerdomain
436 * Associate the clockdomain @clkdm with a powerdomain @pwrdm. This
437 * enables the use of pwrdm_for_each_clkdm(). Returns -EINVAL if
438 * presented with invalid pointers; -ENOMEM if memory could not be allocated;
441 int pwrdm_add_clkdm(struct powerdomain *pwrdm, struct clockdomain *clkdm)
446 if (!pwrdm || !clkdm)
449 pr_debug("powerdomain: %s: associating clockdomain %s\n",
450 pwrdm->name, clkdm->name);
452 for (i = 0; i < PWRDM_MAX_CLKDMS; i++) {
453 if (!pwrdm->pwrdm_clkdms[i])
456 if (pwrdm->pwrdm_clkdms[i] == clkdm) {
463 if (i == PWRDM_MAX_CLKDMS) {
464 pr_debug("powerdomain: %s: increase PWRDM_MAX_CLKDMS for clkdm %s\n",
465 pwrdm->name, clkdm->name);
471 pwrdm->pwrdm_clkdms[i] = clkdm;
480 * pwrdm_get_mem_bank_count - get number of memory banks in this powerdomain
481 * @pwrdm: struct powerdomain *
483 * Return the number of controllable memory banks in powerdomain @pwrdm,
484 * starting with 1. Returns -EINVAL if the powerdomain pointer is null.
486 int pwrdm_get_mem_bank_count(struct powerdomain *pwrdm)
495 * pwrdm_set_next_pwrst - set next powerdomain power state
496 * @pwrdm: struct powerdomain * to set
497 * @pwrst: one of the PWRDM_POWER_* macros
499 * Set the powerdomain @pwrdm's next power state to @pwrst. The powerdomain
500 * may not enter this state immediately if the preconditions for this state
501 * have not been satisfied. Returns -EINVAL if the powerdomain pointer is
502 * null or if the power state is invalid for the powerdomin, or returns 0
505 int pwrdm_set_next_pwrst(struct powerdomain *pwrdm, u8 pwrst)
512 if (!(pwrdm->pwrsts & (1 << pwrst)))
515 pr_debug("powerdomain: %s: setting next powerstate to %0x\n",
518 if (arch_pwrdm && arch_pwrdm->pwrdm_set_next_pwrst) {
519 /* Trace the pwrdm desired target state */
520 trace_power_domain_target_rcuidle(pwrdm->name, pwrst,
521 raw_smp_processor_id());
522 /* Program the pwrdm desired target state */
523 ret = arch_pwrdm->pwrdm_set_next_pwrst(pwrdm, pwrst);
530 * pwrdm_read_next_pwrst - get next powerdomain power state
531 * @pwrdm: struct powerdomain * to get power state
533 * Return the powerdomain @pwrdm's next power state. Returns -EINVAL
534 * if the powerdomain pointer is null or returns the next power state
537 int pwrdm_read_next_pwrst(struct powerdomain *pwrdm)
544 if (arch_pwrdm && arch_pwrdm->pwrdm_read_next_pwrst)
545 ret = arch_pwrdm->pwrdm_read_next_pwrst(pwrdm);
551 * pwrdm_read_pwrst - get current powerdomain power state
552 * @pwrdm: struct powerdomain * to get power state
554 * Return the powerdomain @pwrdm's current power state. Returns -EINVAL
555 * if the powerdomain pointer is null or returns the current power state
556 * upon success. Note that if the power domain only supports the ON state
557 * then just return ON as the current state.
559 int pwrdm_read_pwrst(struct powerdomain *pwrdm)
566 if (pwrdm->pwrsts == PWRSTS_ON)
567 return PWRDM_POWER_ON;
569 if (arch_pwrdm && arch_pwrdm->pwrdm_read_pwrst)
570 ret = arch_pwrdm->pwrdm_read_pwrst(pwrdm);
576 * pwrdm_read_prev_pwrst - get previous powerdomain power state
577 * @pwrdm: struct powerdomain * to get previous power state
579 * Return the powerdomain @pwrdm's previous power state. Returns -EINVAL
580 * if the powerdomain pointer is null or returns the previous power state
583 int pwrdm_read_prev_pwrst(struct powerdomain *pwrdm)
590 if (arch_pwrdm && arch_pwrdm->pwrdm_read_prev_pwrst)
591 ret = arch_pwrdm->pwrdm_read_prev_pwrst(pwrdm);
597 * pwrdm_set_logic_retst - set powerdomain logic power state upon retention
598 * @pwrdm: struct powerdomain * to set
599 * @pwrst: one of the PWRDM_POWER_* macros
601 * Set the next power state @pwrst that the logic portion of the
602 * powerdomain @pwrdm will enter when the powerdomain enters retention.
603 * This will be either RETENTION or OFF, if supported. Returns
604 * -EINVAL if the powerdomain pointer is null or the target power
605 * state is not not supported, or returns 0 upon success.
607 int pwrdm_set_logic_retst(struct powerdomain *pwrdm, u8 pwrst)
614 if (!(pwrdm->pwrsts_logic_ret & (1 << pwrst)))
617 pr_debug("powerdomain: %s: setting next logic powerstate to %0x\n",
620 if (arch_pwrdm && arch_pwrdm->pwrdm_set_logic_retst)
621 ret = arch_pwrdm->pwrdm_set_logic_retst(pwrdm, pwrst);
627 * pwrdm_set_mem_onst - set memory power state while powerdomain ON
628 * @pwrdm: struct powerdomain * to set
629 * @bank: memory bank number to set (0-3)
630 * @pwrst: one of the PWRDM_POWER_* macros
632 * Set the next power state @pwrst that memory bank @bank of the
633 * powerdomain @pwrdm will enter when the powerdomain enters the ON
634 * state. @bank will be a number from 0 to 3, and represents different
635 * types of memory, depending on the powerdomain. Returns -EINVAL if
636 * the powerdomain pointer is null or the target power state is not
637 * not supported for this memory bank, -EEXIST if the target memory
638 * bank does not exist or is not controllable, or returns 0 upon
641 int pwrdm_set_mem_onst(struct powerdomain *pwrdm, u8 bank, u8 pwrst)
648 if (pwrdm->banks < (bank + 1))
651 if (!(pwrdm->pwrsts_mem_on[bank] & (1 << pwrst)))
654 pr_debug("powerdomain: %s: setting next memory powerstate for bank %0x while pwrdm-ON to %0x\n",
655 pwrdm->name, bank, pwrst);
657 if (arch_pwrdm && arch_pwrdm->pwrdm_set_mem_onst)
658 ret = arch_pwrdm->pwrdm_set_mem_onst(pwrdm, bank, pwrst);
664 * pwrdm_set_mem_retst - set memory power state while powerdomain in RET
665 * @pwrdm: struct powerdomain * to set
666 * @bank: memory bank number to set (0-3)
667 * @pwrst: one of the PWRDM_POWER_* macros
669 * Set the next power state @pwrst that memory bank @bank of the
670 * powerdomain @pwrdm will enter when the powerdomain enters the
671 * RETENTION state. Bank will be a number from 0 to 3, and represents
672 * different types of memory, depending on the powerdomain. @pwrst
673 * will be either RETENTION or OFF, if supported. Returns -EINVAL if
674 * the powerdomain pointer is null or the target power state is not
675 * not supported for this memory bank, -EEXIST if the target memory
676 * bank does not exist or is not controllable, or returns 0 upon
679 int pwrdm_set_mem_retst(struct powerdomain *pwrdm, u8 bank, u8 pwrst)
686 if (pwrdm->banks < (bank + 1))
689 if (!(pwrdm->pwrsts_mem_ret[bank] & (1 << pwrst)))
692 pr_debug("powerdomain: %s: setting next memory powerstate for bank %0x while pwrdm-RET to %0x\n",
693 pwrdm->name, bank, pwrst);
695 if (arch_pwrdm && arch_pwrdm->pwrdm_set_mem_retst)
696 ret = arch_pwrdm->pwrdm_set_mem_retst(pwrdm, bank, pwrst);
702 * pwrdm_read_logic_pwrst - get current powerdomain logic retention power state
703 * @pwrdm: struct powerdomain * to get current logic retention power state
705 * Return the power state that the logic portion of powerdomain @pwrdm
706 * will enter when the powerdomain enters retention. Returns -EINVAL
707 * if the powerdomain pointer is null or returns the logic retention
708 * power state upon success.
710 int pwrdm_read_logic_pwrst(struct powerdomain *pwrdm)
717 if (arch_pwrdm && arch_pwrdm->pwrdm_read_logic_pwrst)
718 ret = arch_pwrdm->pwrdm_read_logic_pwrst(pwrdm);
724 * pwrdm_read_prev_logic_pwrst - get previous powerdomain logic power state
725 * @pwrdm: struct powerdomain * to get previous logic power state
727 * Return the powerdomain @pwrdm's previous logic power state. Returns
728 * -EINVAL if the powerdomain pointer is null or returns the previous
729 * logic power state upon success.
731 int pwrdm_read_prev_logic_pwrst(struct powerdomain *pwrdm)
738 if (arch_pwrdm && arch_pwrdm->pwrdm_read_prev_logic_pwrst)
739 ret = arch_pwrdm->pwrdm_read_prev_logic_pwrst(pwrdm);
745 * pwrdm_read_logic_retst - get next powerdomain logic power state
746 * @pwrdm: struct powerdomain * to get next logic power state
748 * Return the powerdomain pwrdm's logic power state. Returns -EINVAL
749 * if the powerdomain pointer is null or returns the next logic
750 * power state upon success.
752 int pwrdm_read_logic_retst(struct powerdomain *pwrdm)
759 if (arch_pwrdm && arch_pwrdm->pwrdm_read_logic_retst)
760 ret = arch_pwrdm->pwrdm_read_logic_retst(pwrdm);
766 * pwrdm_read_mem_pwrst - get current memory bank power state
767 * @pwrdm: struct powerdomain * to get current memory bank power state
768 * @bank: memory bank number (0-3)
770 * Return the powerdomain @pwrdm's current memory power state for bank
771 * @bank. Returns -EINVAL if the powerdomain pointer is null, -EEXIST if
772 * the target memory bank does not exist or is not controllable, or
773 * returns the current memory power state upon success.
775 int pwrdm_read_mem_pwrst(struct powerdomain *pwrdm, u8 bank)
782 if (pwrdm->banks < (bank + 1))
785 if (pwrdm->flags & PWRDM_HAS_MPU_QUIRK)
788 if (arch_pwrdm && arch_pwrdm->pwrdm_read_mem_pwrst)
789 ret = arch_pwrdm->pwrdm_read_mem_pwrst(pwrdm, bank);
795 * pwrdm_read_prev_mem_pwrst - get previous memory bank power state
796 * @pwrdm: struct powerdomain * to get previous memory bank power state
797 * @bank: memory bank number (0-3)
799 * Return the powerdomain @pwrdm's previous memory power state for
800 * bank @bank. Returns -EINVAL if the powerdomain pointer is null,
801 * -EEXIST if the target memory bank does not exist or is not
802 * controllable, or returns the previous memory power state upon
805 int pwrdm_read_prev_mem_pwrst(struct powerdomain *pwrdm, u8 bank)
812 if (pwrdm->banks < (bank + 1))
815 if (pwrdm->flags & PWRDM_HAS_MPU_QUIRK)
818 if (arch_pwrdm && arch_pwrdm->pwrdm_read_prev_mem_pwrst)
819 ret = arch_pwrdm->pwrdm_read_prev_mem_pwrst(pwrdm, bank);
825 * pwrdm_read_mem_retst - get next memory bank power state
826 * @pwrdm: struct powerdomain * to get mext memory bank power state
827 * @bank: memory bank number (0-3)
829 * Return the powerdomain pwrdm's next memory power state for bank
830 * x. Returns -EINVAL if the powerdomain pointer is null, -EEXIST if
831 * the target memory bank does not exist or is not controllable, or
832 * returns the next memory power state upon success.
834 int pwrdm_read_mem_retst(struct powerdomain *pwrdm, u8 bank)
841 if (pwrdm->banks < (bank + 1))
844 if (arch_pwrdm && arch_pwrdm->pwrdm_read_mem_retst)
845 ret = arch_pwrdm->pwrdm_read_mem_retst(pwrdm, bank);
851 * pwrdm_clear_all_prev_pwrst - clear previous powerstate register for a pwrdm
852 * @pwrdm: struct powerdomain * to clear
854 * Clear the powerdomain's previous power state register @pwrdm.
855 * Clears the entire register, including logic and memory bank
856 * previous power states. Returns -EINVAL if the powerdomain pointer
857 * is null, or returns 0 upon success.
859 int pwrdm_clear_all_prev_pwrst(struct powerdomain *pwrdm)
867 * XXX should get the powerdomain's current state here;
868 * warn & fail if it is not ON.
871 pr_debug("powerdomain: %s: clearing previous power state reg\n",
874 if (arch_pwrdm && arch_pwrdm->pwrdm_clear_all_prev_pwrst)
875 ret = arch_pwrdm->pwrdm_clear_all_prev_pwrst(pwrdm);
881 * pwrdm_enable_hdwr_sar - enable automatic hardware SAR for a pwrdm
882 * @pwrdm: struct powerdomain *
884 * Enable automatic context save-and-restore upon power state change
885 * for some devices in the powerdomain @pwrdm. Warning: this only
886 * affects a subset of devices in a powerdomain; check the TRM
887 * closely. Returns -EINVAL if the powerdomain pointer is null or if
888 * the powerdomain does not support automatic save-and-restore, or
889 * returns 0 upon success.
891 int pwrdm_enable_hdwr_sar(struct powerdomain *pwrdm)
898 if (!(pwrdm->flags & PWRDM_HAS_HDWR_SAR))
901 pr_debug("powerdomain: %s: setting SAVEANDRESTORE bit\n", pwrdm->name);
903 if (arch_pwrdm && arch_pwrdm->pwrdm_enable_hdwr_sar)
904 ret = arch_pwrdm->pwrdm_enable_hdwr_sar(pwrdm);
910 * pwrdm_disable_hdwr_sar - disable automatic hardware SAR for a pwrdm
911 * @pwrdm: struct powerdomain *
913 * Disable automatic context save-and-restore upon power state change
914 * for some devices in the powerdomain @pwrdm. Warning: this only
915 * affects a subset of devices in a powerdomain; check the TRM
916 * closely. Returns -EINVAL if the powerdomain pointer is null or if
917 * the powerdomain does not support automatic save-and-restore, or
918 * returns 0 upon success.
920 int pwrdm_disable_hdwr_sar(struct powerdomain *pwrdm)
927 if (!(pwrdm->flags & PWRDM_HAS_HDWR_SAR))
930 pr_debug("powerdomain: %s: clearing SAVEANDRESTORE bit\n", pwrdm->name);
932 if (arch_pwrdm && arch_pwrdm->pwrdm_disable_hdwr_sar)
933 ret = arch_pwrdm->pwrdm_disable_hdwr_sar(pwrdm);
939 * pwrdm_has_hdwr_sar - test whether powerdomain supports hardware SAR
940 * @pwrdm: struct powerdomain *
942 * Returns 1 if powerdomain @pwrdm supports hardware save-and-restore
943 * for some devices, or 0 if it does not.
945 bool pwrdm_has_hdwr_sar(struct powerdomain *pwrdm)
947 return (pwrdm && pwrdm->flags & PWRDM_HAS_HDWR_SAR) ? 1 : 0;
950 int pwrdm_state_switch_nolock(struct powerdomain *pwrdm)
954 if (!pwrdm || !arch_pwrdm)
957 ret = arch_pwrdm->pwrdm_wait_transition(pwrdm);
959 ret = _pwrdm_state_switch(pwrdm, PWRDM_STATE_NOW);
964 int __deprecated pwrdm_state_switch(struct powerdomain *pwrdm)
969 ret = pwrdm_state_switch_nolock(pwrdm);
975 int pwrdm_pre_transition(struct powerdomain *pwrdm)
978 _pwrdm_pre_transition_cb(pwrdm, NULL);
980 pwrdm_for_each(_pwrdm_pre_transition_cb, NULL);
985 int pwrdm_post_transition(struct powerdomain *pwrdm)
988 _pwrdm_post_transition_cb(pwrdm, NULL);
990 pwrdm_for_each(_pwrdm_post_transition_cb, NULL);
996 * pwrdm_get_valid_lp_state() - Find best match deep power state
997 * @pwrdm: power domain for which we want to find best match
998 * @is_logic_state: Are we looking for logic state match here? Should
999 * be one of PWRDM_xxx macro values
1000 * @req_state: requested power state
1002 * Returns: closest match for requested power state. default fallback
1003 * is RET for logic state and ON for power state.
1005 * This does a search from the power domain data looking for the
1006 * closest valid power domain state that the hardware can achieve.
1007 * PRCM definitions for PWRSTCTRL allows us to program whatever
1008 * configuration we'd like, and PRCM will actually attempt such
1009 * a transition, however if the powerdomain does not actually support it,
1010 * we endup with a hung system. The valid power domain states are already
1011 * available in our powerdomain data files. So this function tries to do
1013 * a) find if we have an exact match to the request - no issues.
1014 * b) else find if a deeper power state is possible.
1015 * c) failing which, it tries to find closest higher power state for the
1018 u8 pwrdm_get_valid_lp_state(struct powerdomain *pwrdm,
1019 bool is_logic_state, u8 req_state)
1021 u8 pwrdm_states = is_logic_state ? pwrdm->pwrsts_logic_ret :
1023 /* For logic, ret is highest and others, ON is highest */
1024 u8 default_pwrst = is_logic_state ? PWRDM_POWER_RET : PWRDM_POWER_ON;
1028 /* If it is already supported, nothing to search */
1029 if (pwrdm_states & BIT(req_state))
1036 * So, we dont have a exact match
1037 * Can we get a deeper power state match?
1039 new_pwrst = req_state - 1;
1041 while (!(pwrdm_states & BIT(new_pwrst))) {
1042 /* No match even at OFF? Not available */
1043 if (new_pwrst == PWRDM_POWER_OFF) {
1054 /* OK, no deeper ones, can we get a higher match? */
1055 new_pwrst = req_state + 1;
1056 while (!(pwrdm_states & BIT(new_pwrst))) {
1057 if (new_pwrst > PWRDM_POWER_ON) {
1058 WARN(1, "powerdomain: %s: Fix max powerstate to ON\n",
1060 return PWRDM_POWER_ON;
1063 if (new_pwrst == default_pwrst)
1072 * omap_set_pwrdm_state - change a powerdomain's current power state
1073 * @pwrdm: struct powerdomain * to change the power state of
1074 * @pwrst: power state to change to
1076 * Change the current hardware power state of the powerdomain
1077 * represented by @pwrdm to the power state represented by @pwrst.
1078 * Returns -EINVAL if @pwrdm is null or invalid or if the
1079 * powerdomain's current power state could not be read, or returns 0
1080 * upon success or if @pwrdm does not support @pwrst or any
1081 * lower-power state. XXX Should not return 0 if the @pwrdm does not
1082 * support @pwrst or any lower-power state: this should be an error.
1084 int omap_set_pwrdm_state(struct powerdomain *pwrdm, u8 pwrst)
1086 u8 next_pwrst, sleep_switch;
1090 if (!pwrdm || IS_ERR(pwrdm))
1093 while (!(pwrdm->pwrsts & (1 << pwrst))) {
1094 if (pwrst == PWRDM_POWER_OFF)
1101 curr_pwrst = pwrdm_read_pwrst(pwrdm);
1102 if (curr_pwrst < 0) {
1107 next_pwrst = pwrdm_read_next_pwrst(pwrdm);
1108 if (curr_pwrst == pwrst && next_pwrst == pwrst)
1111 sleep_switch = _pwrdm_save_clkdm_state_and_activate(pwrdm, curr_pwrst,
1114 ret = pwrdm_set_next_pwrst(pwrdm, pwrst);
1116 pr_err("%s: unable to set power state of powerdomain: %s\n",
1117 __func__, pwrdm->name);
1119 _pwrdm_restore_clkdm_state(pwrdm, sleep_switch);
1122 pwrdm_unlock(pwrdm);
1128 * pwrdm_get_context_loss_count - get powerdomain's context loss count
1129 * @pwrdm: struct powerdomain * to wait for
1131 * Context loss count is the sum of powerdomain off-mode counter, the
1132 * logic off counter and the per-bank memory off counter. Returns negative
1133 * (and WARNs) upon error, otherwise, returns the context loss count.
1135 int pwrdm_get_context_loss_count(struct powerdomain *pwrdm)
1140 WARN(1, "powerdomain: %s: pwrdm is null\n", __func__);
1144 count = pwrdm->state_counter[PWRDM_POWER_OFF];
1145 count += pwrdm->ret_logic_off_counter;
1147 for (i = 0; i < pwrdm->banks; i++)
1148 count += pwrdm->ret_mem_off_counter[i];
1151 * Context loss count has to be a non-negative value. Clear the sign
1152 * bit to get a value range from 0 to INT_MAX.
1156 pr_debug("powerdomain: %s: context loss count = %d\n",
1157 pwrdm->name, count);
1163 * pwrdm_can_ever_lose_context - can this powerdomain ever lose context?
1164 * @pwrdm: struct powerdomain *
1166 * Given a struct powerdomain * @pwrdm, returns 1 if the powerdomain
1167 * can lose either memory or logic context or if @pwrdm is invalid, or
1168 * returns 0 otherwise. This function is not concerned with how the
1169 * powerdomain registers are programmed (i.e., to go off or not); it's
1170 * concerned with whether it's ever possible for this powerdomain to
1171 * go off while some other part of the chip is active. This function
1172 * assumes that every powerdomain can go to either ON or INACTIVE.
1174 bool pwrdm_can_ever_lose_context(struct powerdomain *pwrdm)
1179 pr_debug("powerdomain: %s: invalid powerdomain pointer\n",
1184 if (pwrdm->pwrsts & PWRSTS_OFF)
1187 if (pwrdm->pwrsts & PWRSTS_RET) {
1188 if (pwrdm->pwrsts_logic_ret & PWRSTS_OFF)
1191 for (i = 0; i < pwrdm->banks; i++)
1192 if (pwrdm->pwrsts_mem_ret[i] & PWRSTS_OFF)
1196 for (i = 0; i < pwrdm->banks; i++)
1197 if (pwrdm->pwrsts_mem_on[i] & PWRSTS_OFF)