blob: f4dd8105b0245cdfaa6371e39f3473c7988525e3 [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
Ulf Hanssonc11f6f52014-12-01 12:50:21 +010019/* Defines used for the flags field in the struct generic_pm_domain */
20#define GENPD_FLAG_PM_CLK (1U << 0) /* PM domain uses PM clk */
21
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020022enum gpd_status {
23 GPD_STATE_ACTIVE = 0, /* PM domain is active */
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. Wysockid5e4cbf2011-11-27 13:11:36 +010037 bool (*active_wakeup)(struct device *dev);
38};
39
Rafael J. Wysockif7218892011-07-01 22:12:45 +020040struct generic_pm_domain {
41 struct dev_pm_domain domain; /* PM domain operations */
Rafael J. Wysocki5125bbf382011-07-13 12:31:52 +020042 struct list_head gpd_list_node; /* Node in the global PM domains list */
Rafael J. Wysocki5063ce12011-08-08 23:43:40 +020043 struct list_head master_links; /* Links with PM domain as a master */
44 struct list_head slave_links; /* Links with PM domain as a slave */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020045 struct list_head dev_list; /* List of devices */
46 struct mutex lock;
47 struct dev_power_governor *gov;
48 struct work_struct power_off_work;
Geert Uytterhoevend07e9c12014-08-29 15:13:21 +020049 const char *name;
Rafael J. Wysockic4bb3162011-08-08 23:43:04 +020050 atomic_t sd_count; /* Number of subdomains with power "on" */
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020051 enum gpd_status status; /* Current state of the domain */
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020052 unsigned int device_count; /* Number of devices */
53 unsigned int suspended_count; /* System suspend device counter */
54 unsigned int prepared_count; /* Suspend counter of prepared devices */
55 bool suspend_power_off; /* Power status before system suspend */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020056 int (*power_off)(struct generic_pm_domain *domain);
Rafael J. Wysocki221e9b52011-12-01 00:02:10 +010057 s64 power_off_latency_ns;
Rafael J. Wysockif7218892011-07-01 22:12:45 +020058 int (*power_on)(struct generic_pm_domain *domain);
Rafael J. Wysocki221e9b52011-12-01 00:02:10 +010059 s64 power_on_latency_ns;
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +010060 struct gpd_dev_ops dev_ops;
Rafael J. Wysocki221e9b52011-12-01 00:02:10 +010061 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +020062 bool max_off_time_changed;
63 bool cached_power_down_ok;
Ulf Hanssonc16561e2014-11-06 00:37:08 +010064 int (*attach_dev)(struct generic_pm_domain *domain,
65 struct device *dev);
66 void (*detach_dev)(struct generic_pm_domain *domain,
67 struct device *dev);
Ulf Hanssonc11f6f52014-12-01 12:50:21 +010068 unsigned int flags; /* Bit field of configs for genpd */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020069};
70
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020071static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
72{
73 return container_of(pd, struct generic_pm_domain, domain);
74}
75
Rafael J. Wysocki5063ce12011-08-08 23:43:40 +020076struct gpd_link {
77 struct generic_pm_domain *master;
78 struct list_head master_node;
79 struct generic_pm_domain *slave;
80 struct list_head slave_node;
81};
82
Rafael J. Wysockib02c9992011-12-01 00:02:05 +010083struct gpd_timing_data {
84 s64 stop_latency_ns;
85 s64 start_latency_ns;
Rafael J. Wysocki221e9b52011-12-01 00:02:10 +010086 s64 save_state_latency_ns;
87 s64 restore_state_latency_ns;
Rafael J. Wysockia5bef8102012-04-29 22:54:17 +020088 s64 effective_constraint_ns;
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +020089 bool constraint_changed;
90 bool cached_stop_ok;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +010091};
92
Ulf Hansson00e7c292014-11-14 08:41:32 +010093struct pm_domain_data {
94 struct list_head list_node;
95 struct device *dev;
96};
97
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +020098struct generic_pm_domain_data {
99 struct pm_domain_data base;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100100 struct gpd_timing_data td;
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +0200101 struct notifier_block nb;
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200102};
103
Guennadi Liakhovetski9b4f617b2012-02-04 22:26:49 +0100104#ifdef CONFIG_PM_GENERIC_DOMAINS
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200105static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
106{
107 return container_of(pdd, struct generic_pm_domain_data, base);
108}
109
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +0100110static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
111{
112 return to_gpd_data(dev->power.subsys_data->domain_data);
113}
114
Russell King446d999c2015-03-20 17:20:33 +0000115extern struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev);
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100116extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
117 struct device *dev,
118 struct gpd_timing_data *td);
119
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200120extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
121 struct device *dev);
122extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
123 struct generic_pm_domain *new_subdomain);
124extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
125 struct generic_pm_domain *target);
126extern void pm_genpd_init(struct generic_pm_domain *genpd,
127 struct dev_power_governor *gov, bool is_off);
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100128
Ulf Hanssonae3c5112014-09-03 12:52:31 +0200129extern struct dev_power_governor simple_qos_governor;
Mark Brown925b44a2011-12-08 23:27:28 +0100130extern struct dev_power_governor pm_domain_always_on_gov;
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200131#else
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100132
Magnus Dammb6426312012-02-25 22:14:18 +0100133static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
134{
135 return ERR_PTR(-ENOSYS);
136}
Russell King446d999c2015-03-20 17:20:33 +0000137static inline struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100138{
Russell King446d999c2015-03-20 17:20:33 +0000139 return NULL;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100140}
141static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
142 struct device *dev,
143 struct gpd_timing_data *td)
144{
145 return -ENOSYS;
146}
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200147static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
148 struct device *dev)
149{
150 return -ENOSYS;
151}
152static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
153 struct generic_pm_domain *new_sd)
154{
155 return -ENOSYS;
156}
157static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
158 struct generic_pm_domain *target)
159{
160 return -ENOSYS;
161}
Magnus Dammb6426312012-02-25 22:14:18 +0100162static inline void pm_genpd_init(struct generic_pm_domain *genpd,
163 struct dev_power_governor *gov, bool is_off)
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100164{
165}
Rafael J. Wysocki17f2ae72011-08-14 13:34:31 +0200166#endif
167
Rafael J. Wysockib5abb082012-08-07 01:06:11 +0200168static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
169 struct device *dev)
170{
171 return __pm_genpd_add_device(genpd, dev, NULL);
172}
173
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200174#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
Ulf Hanssond47e6462014-09-03 12:52:24 +0200175extern void pm_genpd_syscore_poweroff(struct device *dev);
176extern void pm_genpd_syscore_poweron(struct device *dev);
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200177#else
Ulf Hanssond47e6462014-09-03 12:52:24 +0200178static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
179static inline void pm_genpd_syscore_poweron(struct device *dev) {}
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200180#endif
181
Tomasz Figaaa422402014-09-19 20:27:36 +0200182/* OF PM domain providers */
183struct of_device_id;
184
185struct genpd_onecell_data {
186 struct generic_pm_domain **domains;
187 unsigned int num_domains;
188};
189
190typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
191 void *data);
192
193#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
194int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
195 void *data);
196void of_genpd_del_provider(struct device_node *np);
Amit Daniel Kachhap7496fcb2014-12-15 09:08:59 +0530197struct generic_pm_domain *of_genpd_get_from_provider(
198 struct of_phandle_args *genpdspec);
Tomasz Figaaa422402014-09-19 20:27:36 +0200199
200struct generic_pm_domain *__of_genpd_xlate_simple(
201 struct of_phandle_args *genpdspec,
202 void *data);
203struct generic_pm_domain *__of_genpd_xlate_onecell(
204 struct of_phandle_args *genpdspec,
205 void *data);
206
207int genpd_dev_pm_attach(struct device *dev);
208#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
209static inline int __of_genpd_add_provider(struct device_node *np,
210 genpd_xlate_t xlate, void *data)
211{
212 return 0;
213}
214static inline void of_genpd_del_provider(struct device_node *np) {}
215
Amit Daniel Kachhap7496fcb2014-12-15 09:08:59 +0530216static inline struct generic_pm_domain *of_genpd_get_from_provider(
217 struct of_phandle_args *genpdspec)
218{
219 return NULL;
220}
221
Tomasz Figaaa422402014-09-19 20:27:36 +0200222#define __of_genpd_xlate_simple NULL
223#define __of_genpd_xlate_onecell NULL
224
225static inline int genpd_dev_pm_attach(struct device *dev)
226{
227 return -ENODEV;
228}
229#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
230
231static inline int of_genpd_add_provider_simple(struct device_node *np,
232 struct generic_pm_domain *genpd)
233{
234 return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
235}
236static inline int of_genpd_add_provider_onecell(struct device_node *np,
237 struct genpd_onecell_data *data)
238{
239 return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
240}
241
Ulf Hanssonf48c7672014-09-29 13:58:47 +0200242#ifdef CONFIG_PM
243extern int dev_pm_domain_attach(struct device *dev, bool power_on);
244extern void dev_pm_domain_detach(struct device *dev, bool power_off);
245#else
246static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
247{
248 return -ENODEV;
249}
250static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
251#endif
252
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200253#endif /* _LINUX_PM_DOMAIN_H */