blob: 30f794eb382654f9017b868b4245986b4e621a31 [file] [log] [blame]
Rafael J. Wysockif7218892011-07-01 22:12:45 +02001/*
2 * pm_domain.h - Definitions and headers related to device power domains.
3 *
4 * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
5 *
6 * This file is released under the GPLv2.
7 */
8
9#ifndef _LINUX_PM_DOMAIN_H
10#define _LINUX_PM_DOMAIN_H
11
12#include <linux/device.h>
Paul Gortmaker313162d2012-01-30 11:46:54 -050013#include <linux/mutex.h>
14#include <linux/pm.h>
Guennadi Liakhovetski4f042cd2011-12-01 00:05:31 +010015#include <linux/err.h>
Thomas Abrahamc8aa1302012-01-27 15:22:07 +090016#include <linux/of.h>
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +020017#include <linux/notifier.h>
Rafael J. Wysockif7218892011-07-01 22:12:45 +020018
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020019enum gpd_status {
20 GPD_STATE_ACTIVE = 0, /* PM domain is active */
Rafael J. Wysocki17877eb2011-08-08 23:43:50 +020021 GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020022 GPD_STATE_BUSY, /* Something is happening to the PM domain */
Rafael J. Wysockic6d22b32011-07-12 00:39:36 +020023 GPD_STATE_REPEAT, /* Power off in progress, to be repeated */
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020024 GPD_STATE_POWER_OFF, /* PM domain is off */
25};
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020026
Rafael J. Wysockif7218892011-07-01 22:12:45 +020027struct dev_power_governor {
28 bool (*power_down_ok)(struct dev_pm_domain *domain);
Rafael J. Wysockib02c9992011-12-01 00:02:05 +010029 bool (*stop_ok)(struct device *dev);
Rafael J. Wysockif7218892011-07-01 22:12:45 +020030};
31
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +010032struct gpd_dev_ops {
33 int (*start)(struct device *dev);
34 int (*stop)(struct device *dev);
Rafael J. Wysockiecf00472011-11-27 13:11:44 +010035 int (*save_state)(struct device *dev);
36 int (*restore_state)(struct device *dev);
Rafael J. Wysockid23b9b02011-11-27 13:11:51 +010037 int (*suspend)(struct device *dev);
38 int (*suspend_late)(struct device *dev);
39 int (*resume_early)(struct device *dev);
40 int (*resume)(struct device *dev);
41 int (*freeze)(struct device *dev);
42 int (*freeze_late)(struct device *dev);
43 int (*thaw_early)(struct device *dev);
44 int (*thaw)(struct device *dev);
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +010045 bool (*active_wakeup)(struct device *dev);
46};
47
Rafael J. Wysockif7218892011-07-01 22:12:45 +020048struct generic_pm_domain {
49 struct dev_pm_domain domain; /* PM domain operations */
Rafael J. Wysocki5125bbf2011-07-13 12:31:52 +020050 struct list_head gpd_list_node; /* Node in the global PM domains list */
Rafael J. Wysocki5063ce12011-08-08 23:43:40 +020051 struct list_head master_links; /* Links with PM domain as a master */
52 struct list_head slave_links; /* Links with PM domain as a slave */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020053 struct list_head dev_list; /* List of devices */
54 struct mutex lock;
55 struct dev_power_governor *gov;
56 struct work_struct power_off_work;
Rafael J. Wysockie84b2c22011-12-06 22:19:54 +010057 char *name;
Rafael J. Wysockif7218892011-07-01 22:12:45 +020058 unsigned int in_progress; /* Number of devices being suspended now */
Rafael J. Wysockic4bb3162011-08-08 23:43:04 +020059 atomic_t sd_count; /* Number of subdomains with power "on" */
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020060 enum gpd_status status; /* Current state of the domain */
61 wait_queue_head_t status_wait_queue;
Rafael J. Wysockic6d22b32011-07-12 00:39:36 +020062 struct task_struct *poweroff_task; /* Powering off task */
63 unsigned int resume_count; /* Number of devices being resumed */
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020064 unsigned int device_count; /* Number of devices */
65 unsigned int suspended_count; /* System suspend device counter */
66 unsigned int prepared_count; /* Suspend counter of prepared devices */
67 bool suspend_power_off; /* Power status before system suspend */
Rafael J. Wysocki0aa2a222011-08-25 15:37:04 +020068 bool dev_irq_safe; /* Device callbacks are IRQ-safe */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020069 int (*power_off)(struct generic_pm_domain *domain);
Rafael J. Wysocki221e9b52011-12-01 00:02:10 +010070 s64 power_off_latency_ns;
Rafael J. Wysockif7218892011-07-01 22:12:45 +020071 int (*power_on)(struct generic_pm_domain *domain);
Rafael J. Wysocki221e9b52011-12-01 00:02:10 +010072 s64 power_on_latency_ns;
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +010073 struct gpd_dev_ops dev_ops;
Rafael J. Wysocki221e9b52011-12-01 00:02:10 +010074 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +020075 bool max_off_time_changed;
76 bool cached_power_down_ok;
Thomas Abrahamc8aa1302012-01-27 15:22:07 +090077 struct device_node *of_node; /* Node in device tree */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020078};
79
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020080static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
81{
82 return container_of(pd, struct generic_pm_domain, domain);
83}
84
Rafael J. Wysocki5063ce12011-08-08 23:43:40 +020085struct gpd_link {
86 struct generic_pm_domain *master;
87 struct list_head master_node;
88 struct generic_pm_domain *slave;
89 struct list_head slave_node;
90};
91
Rafael J. Wysockib02c9992011-12-01 00:02:05 +010092struct gpd_timing_data {
93 s64 stop_latency_ns;
94 s64 start_latency_ns;
Rafael J. Wysocki221e9b52011-12-01 00:02:10 +010095 s64 save_state_latency_ns;
96 s64 restore_state_latency_ns;
Rafael J. Wysockia5bef8102012-04-29 22:54:17 +020097 s64 effective_constraint_ns;
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +020098 bool constraint_changed;
99 bool cached_stop_ok;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100100};
101
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200102struct generic_pm_domain_data {
103 struct pm_domain_data base;
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +0100104 struct gpd_dev_ops ops;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100105 struct gpd_timing_data td;
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +0200106 struct notifier_block nb;
107 struct mutex lock;
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200108 bool need_restore;
Rafael J. Wysocki1e78a0c2012-03-13 22:39:48 +0100109 bool always_on;
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200110};
111
Guennadi Liakhovetski9b4f6172012-02-04 22:26:49 +0100112#ifdef CONFIG_PM_GENERIC_DOMAINS
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200113static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
114{
115 return container_of(pdd, struct generic_pm_domain_data, base);
116}
117
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +0100118static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
119{
120 return to_gpd_data(dev->power.subsys_data->domain_data);
121}
122
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100123extern struct dev_power_governor simple_qos_governor;
124
125extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
126extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
127 struct device *dev,
128 struct gpd_timing_data *td);
129
Thomas Abrahamc8aa1302012-01-27 15:22:07 +0900130extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
131 struct device *dev,
132 struct gpd_timing_data *td);
133
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100134static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
135 struct device *dev)
136{
137 return __pm_genpd_add_device(genpd, dev, NULL);
138}
139
Thomas Abrahamc8aa1302012-01-27 15:22:07 +0900140static inline int pm_genpd_of_add_device(struct device_node *genpd_node,
141 struct device *dev)
142{
143 return __pm_genpd_of_add_device(genpd_node, dev, NULL);
144}
145
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200146extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
147 struct device *dev);
Rafael J. Wysocki1e78a0c2012-03-13 22:39:48 +0100148extern void pm_genpd_dev_always_on(struct device *dev, bool val);
Rafael J. Wysockica1d72f2012-05-14 21:45:52 +0200149extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200150extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
151 struct generic_pm_domain *new_subdomain);
152extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
153 struct generic_pm_domain *target);
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100154extern int pm_genpd_add_callbacks(struct device *dev,
155 struct gpd_dev_ops *ops,
156 struct gpd_timing_data *td);
157extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200158extern void pm_genpd_init(struct generic_pm_domain *genpd,
159 struct dev_power_governor *gov, bool is_off);
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100160
Magnus Damm18b4f3f2011-07-10 10:39:14 +0200161extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100162
163extern bool default_stop_ok(struct device *dev);
164
Mark Brown925b44a2011-12-08 23:27:28 +0100165extern struct dev_power_governor pm_domain_always_on_gov;
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200166#else
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100167
Magnus Dammb6426312012-02-25 22:14:18 +0100168static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
169{
170 return ERR_PTR(-ENOSYS);
171}
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100172static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
173{
174 return ERR_PTR(-ENOSYS);
175}
176static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
177 struct device *dev,
178 struct gpd_timing_data *td)
179{
180 return -ENOSYS;
181}
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200182static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
183 struct device *dev)
184{
185 return -ENOSYS;
186}
187static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
188 struct device *dev)
189{
190 return -ENOSYS;
191}
Rafael J. Wysocki1e78a0c2012-03-13 22:39:48 +0100192static inline void pm_genpd_dev_always_on(struct device *dev, bool val) {}
Rafael J. Wysockica1d72f2012-05-14 21:45:52 +0200193static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200194static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
195 struct generic_pm_domain *new_sd)
196{
197 return -ENOSYS;
198}
199static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
200 struct generic_pm_domain *target)
201{
202 return -ENOSYS;
203}
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +0100204static inline int pm_genpd_add_callbacks(struct device *dev,
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100205 struct gpd_dev_ops *ops,
206 struct gpd_timing_data *td)
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +0100207{
208 return -ENOSYS;
209}
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100210static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +0100211{
212 return -ENOSYS;
213}
Magnus Dammb6426312012-02-25 22:14:18 +0100214static inline void pm_genpd_init(struct generic_pm_domain *genpd,
215 struct dev_power_governor *gov, bool is_off)
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100216{
217}
Magnus Damm18b4f3f2011-07-10 10:39:14 +0200218static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
219{
220 return -ENOSYS;
221}
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100222static inline bool default_stop_ok(struct device *dev)
223{
224 return false;
225}
Magnus Dammb6426312012-02-25 22:14:18 +0100226#define simple_qos_governor NULL
Mark Brown925b44a2011-12-08 23:27:28 +0100227#define pm_domain_always_on_gov NULL
Rafael J. Wysocki17f2ae72011-08-14 13:34:31 +0200228#endif
229
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100230static inline int pm_genpd_remove_callbacks(struct device *dev)
231{
232 return __pm_genpd_remove_callbacks(dev, true);
233}
234
Rafael J. Wysocki17f2ae72011-08-14 13:34:31 +0200235#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
236extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
237extern void pm_genpd_poweroff_unused(void);
238#else
Rafael J. Wysocki0bc5b2d2011-07-14 20:59:07 +0200239static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
Rafael J. Wysocki17f2ae72011-08-14 13:34:31 +0200240static inline void pm_genpd_poweroff_unused(void) {}
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200241#endif
242
243#endif /* _LINUX_PM_DOMAIN_H */