blob: ba4ced38efae0c9249a97ea57c0cccd1ac37e7f7 [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. Wysocki5125bbf2011-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 {
Ulf Hansson2b1d88c2015-10-15 17:02:19 +020084 s64 suspend_latency_ns;
85 s64 resume_latency_ns;
Rafael J. Wysockia5bef8102012-04-29 22:54:17 +020086 s64 effective_constraint_ns;
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +020087 bool constraint_changed;
88 bool cached_stop_ok;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +010089};
90
Ulf Hansson00e7c292014-11-14 08:41:32 +010091struct pm_domain_data {
92 struct list_head list_node;
93 struct device *dev;
94};
95
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +020096struct generic_pm_domain_data {
97 struct pm_domain_data base;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +010098 struct gpd_timing_data td;
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +020099 struct notifier_block nb;
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200100};
101
Guennadi Liakhovetski9b4f6172012-02-04 22:26:49 +0100102#ifdef CONFIG_PM_GENERIC_DOMAINS
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200103static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
104{
105 return container_of(pdd, struct generic_pm_domain_data, base);
106}
107
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +0100108static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
109{
110 return to_gpd_data(dev->power.subsys_data->domain_data);
111}
112
Russell King446d9992015-03-20 17:20:33 +0000113extern struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev);
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100114extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
115 struct device *dev,
116 struct gpd_timing_data *td);
117
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200118extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
119 struct device *dev);
120extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
121 struct generic_pm_domain *new_subdomain);
122extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
123 struct generic_pm_domain *target);
124extern void pm_genpd_init(struct generic_pm_domain *genpd,
125 struct dev_power_governor *gov, bool is_off);
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100126
Ulf Hanssonae3c5112014-09-03 12:52:31 +0200127extern struct dev_power_governor simple_qos_governor;
Mark Brown925b44a2011-12-08 23:27:28 +0100128extern struct dev_power_governor pm_domain_always_on_gov;
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200129#else
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100130
Magnus Dammb6426312012-02-25 22:14:18 +0100131static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
132{
133 return ERR_PTR(-ENOSYS);
134}
Russell King446d9992015-03-20 17:20:33 +0000135static inline struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100136{
Russell King446d9992015-03-20 17:20:33 +0000137 return NULL;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100138}
139static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
140 struct device *dev,
141 struct gpd_timing_data *td)
142{
143 return -ENOSYS;
144}
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200145static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
146 struct device *dev)
147{
148 return -ENOSYS;
149}
150static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
151 struct generic_pm_domain *new_sd)
152{
153 return -ENOSYS;
154}
155static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
156 struct generic_pm_domain *target)
157{
158 return -ENOSYS;
159}
Magnus Dammb6426312012-02-25 22:14:18 +0100160static inline void pm_genpd_init(struct generic_pm_domain *genpd,
161 struct dev_power_governor *gov, bool is_off)
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100162{
163}
Rafael J. Wysocki17f2ae72011-08-14 13:34:31 +0200164#endif
165
Rafael J. Wysockib5abb082012-08-07 01:06:11 +0200166static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
167 struct device *dev)
168{
169 return __pm_genpd_add_device(genpd, dev, NULL);
170}
171
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200172#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
Ulf Hanssond47e6462014-09-03 12:52:24 +0200173extern void pm_genpd_syscore_poweroff(struct device *dev);
174extern void pm_genpd_syscore_poweron(struct device *dev);
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200175#else
Ulf Hanssond47e6462014-09-03 12:52:24 +0200176static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
177static inline void pm_genpd_syscore_poweron(struct device *dev) {}
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200178#endif
179
Tomasz Figaaa422402014-09-19 20:27:36 +0200180/* OF PM domain providers */
181struct of_device_id;
182
183struct genpd_onecell_data {
184 struct generic_pm_domain **domains;
185 unsigned int num_domains;
186};
187
188typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
189 void *data);
190
191#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
192int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
193 void *data);
194void of_genpd_del_provider(struct device_node *np);
Amit Daniel Kachhap7496fcb2014-12-15 09:08:59 +0530195struct generic_pm_domain *of_genpd_get_from_provider(
196 struct of_phandle_args *genpdspec);
Tomasz Figaaa422402014-09-19 20:27:36 +0200197
198struct generic_pm_domain *__of_genpd_xlate_simple(
199 struct of_phandle_args *genpdspec,
200 void *data);
201struct generic_pm_domain *__of_genpd_xlate_onecell(
202 struct of_phandle_args *genpdspec,
203 void *data);
204
205int genpd_dev_pm_attach(struct device *dev);
206#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
207static inline int __of_genpd_add_provider(struct device_node *np,
208 genpd_xlate_t xlate, void *data)
209{
210 return 0;
211}
212static inline void of_genpd_del_provider(struct device_node *np) {}
213
Amit Daniel Kachhap7496fcb2014-12-15 09:08:59 +0530214static inline struct generic_pm_domain *of_genpd_get_from_provider(
215 struct of_phandle_args *genpdspec)
216{
217 return NULL;
218}
219
Tomasz Figaaa422402014-09-19 20:27:36 +0200220#define __of_genpd_xlate_simple NULL
221#define __of_genpd_xlate_onecell NULL
222
223static inline int genpd_dev_pm_attach(struct device *dev)
224{
225 return -ENODEV;
226}
227#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
228
229static inline int of_genpd_add_provider_simple(struct device_node *np,
230 struct generic_pm_domain *genpd)
231{
232 return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
233}
234static inline int of_genpd_add_provider_onecell(struct device_node *np,
235 struct genpd_onecell_data *data)
236{
237 return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
238}
239
Ulf Hanssonf48c7672014-09-29 13:58:47 +0200240#ifdef CONFIG_PM
241extern int dev_pm_domain_attach(struct device *dev, bool power_on);
242extern void dev_pm_domain_detach(struct device *dev, bool power_off);
243#else
244static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
245{
246 return -ENODEV;
247}
248static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
249#endif
250
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200251#endif /* _LINUX_PM_DOMAIN_H */