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>
|
2012-01-31 00:46:54 +08:00
|
|
|
#include <linux/mutex.h>
|
|
|
|
|
#include <linux/pm.h>
|
2011-12-01 07:05:31 +08:00
|
|
|
#include <linux/err.h>
|
2012-01-27 14:22:07 +08:00
|
|
|
#include <linux/of.h>
|
PM / Domains: Cache device stop and domain power off governor results, v3
The results of the default device stop and domain power off governor
functions for generic PM domains, default_stop_ok() and
default_power_down_ok(), depend only on the timing data of devices,
which are static, and on their PM QoS constraints. Thus, in theory,
these functions only need to carry out their computations, which may
be time consuming in general, when it is known that the PM QoS
constraint of at least one of the devices in question has changed.
Use the PM QoS notifiers of devices to implement that. First,
introduce new fields, constraint_changed and max_off_time_changed,
into struct gpd_timing_data and struct generic_pm_domain,
respectively, and register a PM QoS notifier function when adding
a device into a domain that will set those fields to 'true' whenever
the device's PM QoS constraint is modified. Second, make
default_stop_ok() and default_power_down_ok() use those fields to
decide whether or not to carry out their computations from scratch.
The device and PM domain hierarchies are taken into account in that
and the expense is that the changes of PM QoS constraints of
suspended devices will not be taken into account immediately, which
isn't guaranteed anyway in general.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
2012-05-02 03:34:07 +08:00
|
|
|
#include <linux/notifier.h>
|
2011-07-02 04:12:45 +08:00
|
|
|
|
2014-12-01 19:50:21 +08:00
|
|
|
/* Defines used for the flags field in the struct generic_pm_domain */
|
|
|
|
|
#define GENPD_FLAG_PM_CLK (1U << 0) /* PM domain uses PM clk */
|
|
|
|
|
|
2011-07-12 06:39:29 +08:00
|
|
|
enum gpd_status {
|
|
|
|
|
GPD_STATE_ACTIVE = 0, /* PM domain is active */
|
|
|
|
|
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);
|
2011-12-01 07:02:05 +08:00
|
|
|
bool (*stop_ok)(struct device *dev);
|
2011-07-02 04:12:45 +08:00
|
|
|
};
|
|
|
|
|
|
2011-11-27 20:11:36 +08:00
|
|
|
struct gpd_dev_ops {
|
|
|
|
|
int (*start)(struct device *dev);
|
|
|
|
|
int (*stop)(struct device *dev);
|
PM / Domains: Introduce "save/restore state" device callbacks
The current PM domains code uses device drivers' .runtime_suspend()
and .runtime_resume() callbacks as the "save device state" and
"restore device state" operations, which may not be appropriate in
general, because it forces drivers to assume that they always will
be used with generic PM domains. However, in theory, the same
hardware may be used in devices that don't belong to any PM
domain, in which case it would be necessary to add "fake" PM
domains to satisfy the above assumption. It also may be located in
a PM domain that's not handled with the help of the generic code.
To allow device drivers that may be used along with the generic PM
domains code of more flexibility, introduce new device callbacks,
.save_state() and .restore_state(), that can be supplied by the
drivers in addition to their "standard" runtime PM callbacks. This
will allow the drivers to be designed to work with generic PM domains
as well as without them.
For backwards compatibility, introduce default .save_state() and
.restore_state() callback routines for PM domains that will execute
a device driver's .runtime_suspend() and .runtime_resume() callbacks,
respectively, for the given device if the driver doesn't provide its
own implementations of .save_state() and .restore_state().
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
2011-11-27 20:11:44 +08:00
|
|
|
int (*save_state)(struct device *dev);
|
|
|
|
|
int (*restore_state)(struct device *dev);
|
2011-11-27 20:11:36 +08:00
|
|
|
bool (*active_wakeup)(struct device *dev);
|
|
|
|
|
};
|
|
|
|
|
|
2011-07-02 04:12:45 +08:00
|
|
|
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-08-09 05:43:40 +08:00
|
|
|
struct list_head master_links; /* Links with PM domain as a master */
|
|
|
|
|
struct list_head slave_links; /* Links with PM domain as a slave */
|
2011-07-02 04:12:45 +08:00
|
|
|
struct list_head dev_list; /* List of devices */
|
|
|
|
|
struct mutex lock;
|
|
|
|
|
struct dev_power_governor *gov;
|
|
|
|
|
struct work_struct power_off_work;
|
2014-08-29 21:13:21 +08:00
|
|
|
const char *name;
|
2011-08-09 05:43:04 +08:00
|
|
|
atomic_t 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 */
|
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);
|
2011-12-01 07:02:10 +08:00
|
|
|
s64 power_off_latency_ns;
|
2011-07-02 04:12:45 +08:00
|
|
|
int (*power_on)(struct generic_pm_domain *domain);
|
2011-12-01 07:02:10 +08:00
|
|
|
s64 power_on_latency_ns;
|
2011-11-27 20:11:36 +08:00
|
|
|
struct gpd_dev_ops dev_ops;
|
2011-12-01 07:02:10 +08:00
|
|
|
s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
|
PM / Domains: Cache device stop and domain power off governor results, v3
The results of the default device stop and domain power off governor
functions for generic PM domains, default_stop_ok() and
default_power_down_ok(), depend only on the timing data of devices,
which are static, and on their PM QoS constraints. Thus, in theory,
these functions only need to carry out their computations, which may
be time consuming in general, when it is known that the PM QoS
constraint of at least one of the devices in question has changed.
Use the PM QoS notifiers of devices to implement that. First,
introduce new fields, constraint_changed and max_off_time_changed,
into struct gpd_timing_data and struct generic_pm_domain,
respectively, and register a PM QoS notifier function when adding
a device into a domain that will set those fields to 'true' whenever
the device's PM QoS constraint is modified. Second, make
default_stop_ok() and default_power_down_ok() use those fields to
decide whether or not to carry out their computations from scratch.
The device and PM domain hierarchies are taken into account in that
and the expense is that the changes of PM QoS constraints of
suspended devices will not be taken into account immediately, which
isn't guaranteed anyway in general.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
2012-05-02 03:34:07 +08:00
|
|
|
bool max_off_time_changed;
|
|
|
|
|
bool cached_power_down_ok;
|
2014-11-06 07:37:08 +08:00
|
|
|
int (*attach_dev)(struct generic_pm_domain *domain,
|
|
|
|
|
struct device *dev);
|
|
|
|
|
void (*detach_dev)(struct generic_pm_domain *domain,
|
|
|
|
|
struct device *dev);
|
2014-12-01 19:50:21 +08:00
|
|
|
unsigned int flags; /* Bit field of configs for genpd */
|
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-08-09 05:43:40 +08:00
|
|
|
struct gpd_link {
|
|
|
|
|
struct generic_pm_domain *master;
|
|
|
|
|
struct list_head master_node;
|
|
|
|
|
struct generic_pm_domain *slave;
|
|
|
|
|
struct list_head slave_node;
|
|
|
|
|
};
|
|
|
|
|
|
2011-12-01 07:02:05 +08:00
|
|
|
struct gpd_timing_data {
|
2015-10-15 23:02:19 +08:00
|
|
|
s64 suspend_latency_ns;
|
|
|
|
|
s64 resume_latency_ns;
|
2012-04-30 04:54:17 +08:00
|
|
|
s64 effective_constraint_ns;
|
PM / Domains: Cache device stop and domain power off governor results, v3
The results of the default device stop and domain power off governor
functions for generic PM domains, default_stop_ok() and
default_power_down_ok(), depend only on the timing data of devices,
which are static, and on their PM QoS constraints. Thus, in theory,
these functions only need to carry out their computations, which may
be time consuming in general, when it is known that the PM QoS
constraint of at least one of the devices in question has changed.
Use the PM QoS notifiers of devices to implement that. First,
introduce new fields, constraint_changed and max_off_time_changed,
into struct gpd_timing_data and struct generic_pm_domain,
respectively, and register a PM QoS notifier function when adding
a device into a domain that will set those fields to 'true' whenever
the device's PM QoS constraint is modified. Second, make
default_stop_ok() and default_power_down_ok() use those fields to
decide whether or not to carry out their computations from scratch.
The device and PM domain hierarchies are taken into account in that
and the expense is that the changes of PM QoS constraints of
suspended devices will not be taken into account immediately, which
isn't guaranteed anyway in general.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
2012-05-02 03:34:07 +08:00
|
|
|
bool constraint_changed;
|
|
|
|
|
bool cached_stop_ok;
|
2011-12-01 07:02:05 +08:00
|
|
|
};
|
|
|
|
|
|
2014-11-14 15:41:32 +08:00
|
|
|
struct pm_domain_data {
|
|
|
|
|
struct list_head list_node;
|
|
|
|
|
struct device *dev;
|
|
|
|
|
};
|
|
|
|
|
|
2011-09-27 02:22:02 +08:00
|
|
|
struct generic_pm_domain_data {
|
|
|
|
|
struct pm_domain_data base;
|
2011-12-01 07:02:05 +08:00
|
|
|
struct gpd_timing_data td;
|
PM / Domains: Cache device stop and domain power off governor results, v3
The results of the default device stop and domain power off governor
functions for generic PM domains, default_stop_ok() and
default_power_down_ok(), depend only on the timing data of devices,
which are static, and on their PM QoS constraints. Thus, in theory,
these functions only need to carry out their computations, which may
be time consuming in general, when it is known that the PM QoS
constraint of at least one of the devices in question has changed.
Use the PM QoS notifiers of devices to implement that. First,
introduce new fields, constraint_changed and max_off_time_changed,
into struct gpd_timing_data and struct generic_pm_domain,
respectively, and register a PM QoS notifier function when adding
a device into a domain that will set those fields to 'true' whenever
the device's PM QoS constraint is modified. Second, make
default_stop_ok() and default_power_down_ok() use those fields to
decide whether or not to carry out their computations from scratch.
The device and PM domain hierarchies are taken into account in that
and the expense is that the changes of PM QoS constraints of
suspended devices will not be taken into account immediately, which
isn't guaranteed anyway in general.
Signed-off-by: Rafael J. Wysocki <rjw@sisk.pl>
2012-05-02 03:34:07 +08:00
|
|
|
struct notifier_block nb;
|
2011-09-27 02:22:02 +08:00
|
|
|
};
|
|
|
|
|
|
2012-02-05 05:26:49 +08:00
|
|
|
#ifdef CONFIG_PM_GENERIC_DOMAINS
|
2011-09-27 02:22:02 +08:00
|
|
|
static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
|
|
|
|
|
{
|
|
|
|
|
return container_of(pdd, struct generic_pm_domain_data, base);
|
|
|
|
|
}
|
|
|
|
|
|
2011-11-27 20:11:36 +08:00
|
|
|
static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
|
|
|
|
|
{
|
|
|
|
|
return to_gpd_data(dev->power.subsys_data->domain_data);
|
|
|
|
|
}
|
|
|
|
|
|
2015-03-21 01:20:33 +08:00
|
|
|
extern struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev);
|
2011-12-01 07:02:05 +08:00
|
|
|
extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
|
|
|
|
|
struct device *dev,
|
|
|
|
|
struct gpd_timing_data *td);
|
|
|
|
|
|
2011-07-02 04:12:45 +08:00
|
|
|
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-12-01 07:02:05 +08:00
|
|
|
|
2014-09-03 18:52:31 +08:00
|
|
|
extern struct dev_power_governor simple_qos_governor;
|
2011-12-09 06:27:28 +08:00
|
|
|
extern struct dev_power_governor pm_domain_always_on_gov;
|
2011-07-02 04:12:45 +08:00
|
|
|
#else
|
2011-12-01 07:02:05 +08:00
|
|
|
|
2012-02-26 05:14:18 +08:00
|
|
|
static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
|
|
|
|
|
{
|
|
|
|
|
return ERR_PTR(-ENOSYS);
|
|
|
|
|
}
|
2015-03-21 01:20:33 +08:00
|
|
|
static inline struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
|
2011-12-01 07:02:05 +08:00
|
|
|
{
|
2015-03-21 01:20:33 +08:00
|
|
|
return NULL;
|
2011-12-01 07:02:05 +08:00
|
|
|
}
|
|
|
|
|
static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
|
|
|
|
|
struct device *dev,
|
|
|
|
|
struct gpd_timing_data *td)
|
|
|
|
|
{
|
|
|
|
|
return -ENOSYS;
|
|
|
|
|
}
|
2011-07-02 04:12:45 +08:00
|
|
|
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;
|
|
|
|
|
}
|
2012-02-26 05:14:18 +08:00
|
|
|
static inline void pm_genpd_init(struct generic_pm_domain *genpd,
|
|
|
|
|
struct dev_power_governor *gov, bool is_off)
|
2011-12-01 07:02:05 +08:00
|
|
|
{
|
|
|
|
|
}
|
2011-08-14 19:34:31 +08:00
|
|
|
#endif
|
|
|
|
|
|
2012-08-07 07:06:11 +08:00
|
|
|
static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
|
|
|
|
|
struct device *dev)
|
|
|
|
|
{
|
|
|
|
|
return __pm_genpd_add_device(genpd, dev, NULL);
|
|
|
|
|
}
|
|
|
|
|
|
2012-08-06 07:39:57 +08:00
|
|
|
#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
|
2014-09-03 18:52:24 +08:00
|
|
|
extern void pm_genpd_syscore_poweroff(struct device *dev);
|
|
|
|
|
extern void pm_genpd_syscore_poweron(struct device *dev);
|
2012-08-06 07:39:57 +08:00
|
|
|
#else
|
2014-09-03 18:52:24 +08:00
|
|
|
static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
|
|
|
|
|
static inline void pm_genpd_syscore_poweron(struct device *dev) {}
|
2012-08-06 07:39:57 +08:00
|
|
|
#endif
|
|
|
|
|
|
2014-09-20 02:27:36 +08:00
|
|
|
/* OF PM domain providers */
|
|
|
|
|
struct of_device_id;
|
|
|
|
|
|
|
|
|
|
struct genpd_onecell_data {
|
|
|
|
|
struct generic_pm_domain **domains;
|
|
|
|
|
unsigned int num_domains;
|
|
|
|
|
};
|
|
|
|
|
|
|
|
|
|
typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
|
|
|
|
|
void *data);
|
|
|
|
|
|
|
|
|
|
#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
|
|
|
|
|
int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
|
|
|
|
|
void *data);
|
|
|
|
|
void of_genpd_del_provider(struct device_node *np);
|
2014-12-15 11:38:59 +08:00
|
|
|
struct generic_pm_domain *of_genpd_get_from_provider(
|
|
|
|
|
struct of_phandle_args *genpdspec);
|
2014-09-20 02:27:36 +08:00
|
|
|
|
|
|
|
|
struct generic_pm_domain *__of_genpd_xlate_simple(
|
|
|
|
|
struct of_phandle_args *genpdspec,
|
|
|
|
|
void *data);
|
|
|
|
|
struct generic_pm_domain *__of_genpd_xlate_onecell(
|
|
|
|
|
struct of_phandle_args *genpdspec,
|
|
|
|
|
void *data);
|
|
|
|
|
|
|
|
|
|
int genpd_dev_pm_attach(struct device *dev);
|
|
|
|
|
#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
|
|
|
|
|
static inline int __of_genpd_add_provider(struct device_node *np,
|
|
|
|
|
genpd_xlate_t xlate, void *data)
|
|
|
|
|
{
|
|
|
|
|
return 0;
|
|
|
|
|
}
|
|
|
|
|
static inline void of_genpd_del_provider(struct device_node *np) {}
|
|
|
|
|
|
2014-12-15 11:38:59 +08:00
|
|
|
static inline struct generic_pm_domain *of_genpd_get_from_provider(
|
|
|
|
|
struct of_phandle_args *genpdspec)
|
|
|
|
|
{
|
|
|
|
|
return NULL;
|
|
|
|
|
}
|
|
|
|
|
|
2014-09-20 02:27:36 +08:00
|
|
|
#define __of_genpd_xlate_simple NULL
|
|
|
|
|
#define __of_genpd_xlate_onecell NULL
|
|
|
|
|
|
|
|
|
|
static inline int genpd_dev_pm_attach(struct device *dev)
|
|
|
|
|
{
|
|
|
|
|
return -ENODEV;
|
|
|
|
|
}
|
|
|
|
|
#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
|
|
|
|
|
|
|
|
|
|
static inline int of_genpd_add_provider_simple(struct device_node *np,
|
|
|
|
|
struct generic_pm_domain *genpd)
|
|
|
|
|
{
|
|
|
|
|
return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
|
|
|
|
|
}
|
|
|
|
|
static inline int of_genpd_add_provider_onecell(struct device_node *np,
|
|
|
|
|
struct genpd_onecell_data *data)
|
|
|
|
|
{
|
|
|
|
|
return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
|
|
|
|
|
}
|
|
|
|
|
|
2014-09-29 19:58:47 +08:00
|
|
|
#ifdef CONFIG_PM
|
|
|
|
|
extern int dev_pm_domain_attach(struct device *dev, bool power_on);
|
|
|
|
|
extern void dev_pm_domain_detach(struct device *dev, bool power_off);
|
|
|
|
|
#else
|
|
|
|
|
static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
|
|
|
|
|
{
|
|
|
|
|
return -ENODEV;
|
|
|
|
|
}
|
|
|
|
|
static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
|
|
|
|
|
#endif
|
|
|
|
|
|
2011-07-02 04:12:45 +08:00
|
|
|
#endif /* _LINUX_PM_DOMAIN_H */
|