2011-07-02 04:12:45 +08:00
|
|
|
/*
|
|
|
|
* pm_domain.h - Definitions and headers related to device power domains.
|
|
|
|
*
|
|
|
|
* Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
|
|
|
|
*
|
|
|
|
* This file is released under the GPLv2.
|
|
|
|
*/
|
|
|
|
|
|
|
|
#ifndef _LINUX_PM_DOMAIN_H
|
|
|
|
#define _LINUX_PM_DOMAIN_H
|
|
|
|
|
|
|
|
#include <linux/device.h>
|
|
|
|
|
2011-07-12 06:39:29 +08:00
|
|
|
enum gpd_status {
|
|
|
|
GPD_STATE_ACTIVE = 0, /* PM domain is active */
|
|
|
|
GPD_STATE_BUSY, /* Something is happening to the PM domain */
|
PM / Domains: Allow callbacks to execute all runtime PM helpers
A deadlock may occur if one of the PM domains' .start_device() or
.stop_device() callbacks or a device driver's .runtime_suspend() or
.runtime_resume() callback executed by the core generic PM domain
code uses a "wrong" runtime PM helper function. This happens, for
example, if .runtime_resume() from one device's driver calls
pm_runtime_resume() for another device in the same PM domain.
A similar situation may take place if a device's parent is in the
same PM domain, in which case the runtime PM framework may execute
pm_genpd_runtime_resume() automatically for the parent (if it is
suspended at the moment). This, of course, is undesirable, so
the generic PM domains code should be modified to prevent it from
happening.
The runtime PM framework guarantees that pm_genpd_runtime_suspend()
and pm_genpd_runtime_resume() won't be executed in parallel for
the same device, so the generic PM domains code need not worry
about those cases. Still, it needs to prevent the other possible
race conditions between pm_genpd_runtime_suspend(),
pm_genpd_runtime_resume(), pm_genpd_poweron() and pm_genpd_poweroff()
from happening and it needs to avoid deadlocks at the same time.
To this end, modify the generic PM domains code to relax
synchronization rules so that:
* pm_genpd_poweron() doesn't wait for the PM domain status to
change from GPD_STATE_BUSY. If it finds that the status is
not GPD_STATE_POWER_OFF, it returns without powering the domain on
(it may modify the status depending on the circumstances).
* pm_genpd_poweroff() returns as soon as it finds that the PM
domain's status changed from GPD_STATE_BUSY after it's released
the PM domain's lock.
* pm_genpd_runtime_suspend() doesn't wait for the PM domain status
to change from GPD_STATE_BUSY after executing the domain's
.stop_device() callback and executes pm_genpd_poweroff() only
if pm_genpd_runtime_resume() is not executed in parallel.
* pm_genpd_runtime_resume() doesn't wait for the PM domain status
to change from GPD_STATE_BUSY after executing pm_genpd_poweron()
and sets the domain's status to GPD_STATE_BUSY and increments its
counter of resuming devices (introduced by this change) immediately
after acquiring the lock. The counter of resuming devices is then
decremented after executing __pm_genpd_runtime_resume() for the
device and the domain's status is reset to GPD_STATE_ACTIVE (unless
there are more resuming devices in the domain, in which case the
status remains GPD_STATE_BUSY).
This way, for example, if a device driver's .runtime_resume()
callback executes pm_runtime_resume() for another device in the same
PM domain, pm_genpd_poweron() called by pm_genpd_runtime_resume()
invoked by the runtime PM framework will not block and it will see
that there's nothing to do for it. Next, the PM domain's lock will
be acquired without waiting for its status to change from
GPD_STATE_BUSY and the device driver's .runtime_resume() callback
will be executed. In turn, if pm_runtime_suspend() is executed by
one device driver's .runtime_resume() callback for another device in
the same PM domain, pm_genpd_poweroff() executed by
pm_genpd_runtime_suspend() invoked by the runtime PM framework as a
result will notice that one of the devices in the domain is being
resumed, so it will return immediately.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
2011-07-12 06:39:36 +08:00
|
|
|
GPD_STATE_REPEAT, /* Power off in progress, to be repeated */
|
2011-07-12 06:39:29 +08:00
|
|
|
GPD_STATE_POWER_OFF, /* PM domain is off */
|
|
|
|
};
|
2011-07-02 04:13:19 +08:00
|
|
|
|
2011-07-02 04:12:45 +08:00
|
|
|
struct dev_power_governor {
|
|
|
|
bool (*power_down_ok)(struct dev_pm_domain *domain);
|
|
|
|
};
|
|
|
|
|
|
|
|
struct generic_pm_domain {
|
|
|
|
struct dev_pm_domain domain; /* PM domain operations */
|
2011-07-13 18:31:52 +08:00
|
|
|
struct list_head gpd_list_node; /* Node in the global PM domains list */
|
2011-07-02 04:12:45 +08:00
|
|
|
struct list_head sd_node; /* Node in the parent's subdomain list */
|
|
|
|
struct generic_pm_domain *parent; /* Parent PM domain */
|
|
|
|
struct list_head sd_list; /* List of dubdomains */
|
|
|
|
struct list_head dev_list; /* List of devices */
|
|
|
|
struct mutex lock;
|
|
|
|
struct dev_power_governor *gov;
|
|
|
|
struct work_struct power_off_work;
|
|
|
|
unsigned int in_progress; /* Number of devices being suspended now */
|
|
|
|
unsigned int sd_count; /* Number of subdomains with power "on" */
|
2011-07-12 06:39:29 +08:00
|
|
|
enum gpd_status status; /* Current state of the domain */
|
|
|
|
wait_queue_head_t status_wait_queue;
|
PM / Domains: Allow callbacks to execute all runtime PM helpers
A deadlock may occur if one of the PM domains' .start_device() or
.stop_device() callbacks or a device driver's .runtime_suspend() or
.runtime_resume() callback executed by the core generic PM domain
code uses a "wrong" runtime PM helper function. This happens, for
example, if .runtime_resume() from one device's driver calls
pm_runtime_resume() for another device in the same PM domain.
A similar situation may take place if a device's parent is in the
same PM domain, in which case the runtime PM framework may execute
pm_genpd_runtime_resume() automatically for the parent (if it is
suspended at the moment). This, of course, is undesirable, so
the generic PM domains code should be modified to prevent it from
happening.
The runtime PM framework guarantees that pm_genpd_runtime_suspend()
and pm_genpd_runtime_resume() won't be executed in parallel for
the same device, so the generic PM domains code need not worry
about those cases. Still, it needs to prevent the other possible
race conditions between pm_genpd_runtime_suspend(),
pm_genpd_runtime_resume(), pm_genpd_poweron() and pm_genpd_poweroff()
from happening and it needs to avoid deadlocks at the same time.
To this end, modify the generic PM domains code to relax
synchronization rules so that:
* pm_genpd_poweron() doesn't wait for the PM domain status to
change from GPD_STATE_BUSY. If it finds that the status is
not GPD_STATE_POWER_OFF, it returns without powering the domain on
(it may modify the status depending on the circumstances).
* pm_genpd_poweroff() returns as soon as it finds that the PM
domain's status changed from GPD_STATE_BUSY after it's released
the PM domain's lock.
* pm_genpd_runtime_suspend() doesn't wait for the PM domain status
to change from GPD_STATE_BUSY after executing the domain's
.stop_device() callback and executes pm_genpd_poweroff() only
if pm_genpd_runtime_resume() is not executed in parallel.
* pm_genpd_runtime_resume() doesn't wait for the PM domain status
to change from GPD_STATE_BUSY after executing pm_genpd_poweron()
and sets the domain's status to GPD_STATE_BUSY and increments its
counter of resuming devices (introduced by this change) immediately
after acquiring the lock. The counter of resuming devices is then
decremented after executing __pm_genpd_runtime_resume() for the
device and the domain's status is reset to GPD_STATE_ACTIVE (unless
there are more resuming devices in the domain, in which case the
status remains GPD_STATE_BUSY).
This way, for example, if a device driver's .runtime_resume()
callback executes pm_runtime_resume() for another device in the same
PM domain, pm_genpd_poweron() called by pm_genpd_runtime_resume()
invoked by the runtime PM framework will not block and it will see
that there's nothing to do for it. Next, the PM domain's lock will
be acquired without waiting for its status to change from
GPD_STATE_BUSY and the device driver's .runtime_resume() callback
will be executed. In turn, if pm_runtime_suspend() is executed by
one device driver's .runtime_resume() callback for another device in
the same PM domain, pm_genpd_poweroff() executed by
pm_genpd_runtime_suspend() invoked by the runtime PM framework as a
result will notice that one of the devices in the domain is being
resumed, so it will return immediately.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
2011-07-12 06:39:36 +08:00
|
|
|
struct task_struct *poweroff_task; /* Powering off task */
|
|
|
|
unsigned int resume_count; /* Number of devices being resumed */
|
2011-07-02 04:13:19 +08:00
|
|
|
unsigned int device_count; /* Number of devices */
|
|
|
|
unsigned int suspended_count; /* System suspend device counter */
|
|
|
|
unsigned int prepared_count; /* Suspend counter of prepared devices */
|
|
|
|
bool suspend_power_off; /* Power status before system suspend */
|
2011-07-02 04:12:45 +08:00
|
|
|
int (*power_off)(struct generic_pm_domain *domain);
|
|
|
|
int (*power_on)(struct generic_pm_domain *domain);
|
|
|
|
int (*start_device)(struct device *dev);
|
|
|
|
int (*stop_device)(struct device *dev);
|
PM / Domains: Wakeup devices support for system sleep transitions
There is the problem how to handle devices set up to wake up the
system from sleep states during system-wide power transitions.
In some cases, those devices can be turned off entirely, because the
wakeup signals will be generated on their behalf anyway. In some
other cases, they will generate wakeup signals if their clocks are
stopped, but only if power is not removed from them. Finally, in
some cases, they can only generate wakeup signals if power is not
removed from them and their clocks are enabled.
To allow platform-specific code to decide whether or not to put
wakeup devices (and their PM domains) into low-power state during
system-wide transitions, such as system suspend, introduce a new
generic PM domain callback, .active_wakeup(), that will be used
during the "noirq" phase of system suspend and hibernation (after
image creation) to decide what to do with wakeup devices.
Specifically, if this callback is present and returns "true", the
generic PM domain code will not execute .stop_device() for the
given wakeup device and its PM domain won't be powered off.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
Acked-by: Kevin Hilman <khilman@ti.com>
2011-07-02 04:13:29 +08:00
|
|
|
bool (*active_wakeup)(struct device *dev);
|
2011-07-02 04:12:45 +08:00
|
|
|
};
|
|
|
|
|
2011-07-02 04:13:19 +08:00
|
|
|
static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
|
|
|
|
{
|
|
|
|
return container_of(pd, struct generic_pm_domain, domain);
|
|
|
|
}
|
|
|
|
|
2011-07-02 04:12:45 +08:00
|
|
|
struct dev_list_entry {
|
|
|
|
struct list_head node;
|
|
|
|
struct device *dev;
|
|
|
|
bool need_restore;
|
|
|
|
};
|
|
|
|
|
|
|
|
#ifdef CONFIG_PM_GENERIC_DOMAINS
|
|
|
|
extern int pm_genpd_add_device(struct generic_pm_domain *genpd,
|
|
|
|
struct device *dev);
|
|
|
|
extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
|
|
|
|
struct device *dev);
|
|
|
|
extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
|
|
|
|
struct generic_pm_domain *new_subdomain);
|
|
|
|
extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
|
|
|
|
struct generic_pm_domain *target);
|
|
|
|
extern void pm_genpd_init(struct generic_pm_domain *genpd,
|
|
|
|
struct dev_power_governor *gov, bool is_off);
|
2011-07-10 16:39:14 +08:00
|
|
|
extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
|
2011-07-13 18:31:52 +08:00
|
|
|
extern void pm_genpd_poweroff_unused(void);
|
2011-07-15 02:59:07 +08:00
|
|
|
extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
|
2011-07-02 04:12:45 +08:00
|
|
|
#else
|
|
|
|
static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
|
|
|
|
struct device *dev)
|
|
|
|
{
|
|
|
|
return -ENOSYS;
|
|
|
|
}
|
|
|
|
static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
|
|
|
|
struct device *dev)
|
|
|
|
{
|
|
|
|
return -ENOSYS;
|
|
|
|
}
|
|
|
|
static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
|
|
|
|
struct generic_pm_domain *new_sd)
|
|
|
|
{
|
|
|
|
return -ENOSYS;
|
|
|
|
}
|
|
|
|
static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
|
|
|
|
struct generic_pm_domain *target)
|
|
|
|
{
|
|
|
|
return -ENOSYS;
|
|
|
|
}
|
|
|
|
static inline void pm_genpd_init(struct generic_pm_domain *genpd,
|
|
|
|
struct dev_power_governor *gov, bool is_off) {}
|
2011-07-10 16:39:14 +08:00
|
|
|
static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
|
|
|
|
{
|
|
|
|
return -ENOSYS;
|
|
|
|
}
|
2011-07-13 18:31:52 +08:00
|
|
|
static inline void pm_genpd_poweroff_unused(void) {}
|
2011-07-15 02:59:07 +08:00
|
|
|
static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
|
2011-07-02 04:12:45 +08:00
|
|
|
#endif
|
|
|
|
|
|
|
|
#endif /* _LINUX_PM_DOMAIN_H */
|