blob: 5339ed5bd6f9d04af80cd7da068a776517d9c4ff [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>
Lina Iyerd716f472016-10-14 10:47:55 -070018#include <linux/spinlock.h>
Rafael J. Wysockif7218892011-07-01 22:12:45 +020019
Ulf Hanssonc11f6f52014-12-01 12:50:21 +010020/* Defines used for the flags field in the struct generic_pm_domain */
21#define GENPD_FLAG_PM_CLK (1U << 0) /* PM domain uses PM clk */
Lina Iyerd716f472016-10-14 10:47:55 -070022#define GENPD_FLAG_IRQ_SAFE (1U << 1) /* PM domain operates in atomic */
Ulf Hanssonc11f6f52014-12-01 12:50:21 +010023
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020024enum gpd_status {
25 GPD_STATE_ACTIVE = 0, /* PM domain is active */
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020026 GPD_STATE_POWER_OFF, /* PM domain is off */
27};
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020028
Rafael J. Wysockif7218892011-07-01 22:12:45 +020029struct dev_power_governor {
30 bool (*power_down_ok)(struct dev_pm_domain *domain);
Ulf Hansson9df39212016-03-31 11:21:25 +020031 bool (*suspend_ok)(struct device *dev);
Rafael J. Wysockif7218892011-07-01 22:12:45 +020032};
33
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +010034struct gpd_dev_ops {
35 int (*start)(struct device *dev);
36 int (*stop)(struct device *dev);
37 bool (*active_wakeup)(struct device *dev);
38};
39
Axel Haslamfc5cbf02016-02-15 11:10:51 +010040struct genpd_power_state {
41 s64 power_off_latency_ns;
42 s64 power_on_latency_ns;
Lina Iyer405f7222016-10-14 10:47:50 -070043 s64 residency_ns;
Lina Iyer0c9b6942016-10-14 10:47:52 -070044 struct fwnode_handle *fwnode;
Axel Haslamfc5cbf02016-02-15 11:10:51 +010045};
46
Lina Iyer35241d12016-10-14 10:47:54 -070047struct genpd_lock_ops;
48
Rafael J. Wysockif7218892011-07-01 22:12:45 +020049struct generic_pm_domain {
50 struct dev_pm_domain domain; /* PM domain operations */
Rafael J. Wysocki5125bbf2011-07-13 12:31:52 +020051 struct list_head gpd_list_node; /* Node in the global PM domains list */
Rafael J. Wysocki5063ce12011-08-08 23:43:40 +020052 struct list_head master_links; /* Links with PM domain as a master */
53 struct list_head slave_links; /* Links with PM domain as a slave */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020054 struct list_head dev_list; /* List of devices */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020055 struct dev_power_governor *gov;
56 struct work_struct power_off_work;
Jon Hunterde0aa06d2016-09-12 12:01:12 +010057 struct fwnode_handle *provider; /* Identity of the domain provider */
58 bool has_provider;
Geert Uytterhoevend07e9c12014-08-29 15:13:21 +020059 const char *name;
Rafael J. Wysockic4bb3162011-08-08 23:43:04 +020060 atomic_t sd_count; /* Number of subdomains with power "on" */
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020061 enum gpd_status status; /* Current state of the domain */
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020062 unsigned int device_count; /* Number of devices */
63 unsigned int suspended_count; /* System suspend device counter */
64 unsigned int prepared_count; /* Suspend counter of prepared devices */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020065 int (*power_off)(struct generic_pm_domain *domain);
66 int (*power_on)(struct generic_pm_domain *domain);
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +010067 struct gpd_dev_ops dev_ops;
Rafael J. Wysocki221e9b52011-12-01 00:02:10 +010068 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +020069 bool max_off_time_changed;
70 bool cached_power_down_ok;
Ulf Hanssonc16561e2014-11-06 00:37:08 +010071 int (*attach_dev)(struct generic_pm_domain *domain,
72 struct device *dev);
73 void (*detach_dev)(struct generic_pm_domain *domain,
74 struct device *dev);
Ulf Hanssonc11f6f52014-12-01 12:50:21 +010075 unsigned int flags; /* Bit field of configs for genpd */
Lina Iyer59d65b72016-10-14 10:47:49 -070076 struct genpd_power_state *states;
Axel Haslamfc5cbf02016-02-15 11:10:51 +010077 unsigned int state_count; /* number of states */
78 unsigned int state_idx; /* state that genpd will go to when off */
Lina Iyer59d65b72016-10-14 10:47:49 -070079 void *free; /* Free the state that was allocated for default */
Lina Iyer35241d12016-10-14 10:47:54 -070080 const struct genpd_lock_ops *lock_ops;
Lina Iyerd716f472016-10-14 10:47:55 -070081 union {
82 struct mutex mlock;
83 struct {
84 spinlock_t slock;
85 unsigned long lock_flags;
86 };
87 };
Axel Haslamfc5cbf02016-02-15 11:10:51 +010088
Rafael J. Wysockif7218892011-07-01 22:12:45 +020089};
90
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020091static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
92{
93 return container_of(pd, struct generic_pm_domain, domain);
94}
95
Rafael J. Wysocki5063ce12011-08-08 23:43:40 +020096struct gpd_link {
97 struct generic_pm_domain *master;
98 struct list_head master_node;
99 struct generic_pm_domain *slave;
100 struct list_head slave_node;
101};
102
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100103struct gpd_timing_data {
Ulf Hansson2b1d88c2015-10-15 17:02:19 +0200104 s64 suspend_latency_ns;
105 s64 resume_latency_ns;
Rafael J. Wysockia5bef8102012-04-29 22:54:17 +0200106 s64 effective_constraint_ns;
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +0200107 bool constraint_changed;
Ulf Hansson9df39212016-03-31 11:21:25 +0200108 bool cached_suspend_ok;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100109};
110
Ulf Hansson00e7c292014-11-14 08:41:32 +0100111struct pm_domain_data {
112 struct list_head list_node;
113 struct device *dev;
114};
115
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200116struct generic_pm_domain_data {
117 struct pm_domain_data base;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100118 struct gpd_timing_data td;
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +0200119 struct notifier_block nb;
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200120};
121
Guennadi Liakhovetski9b4f6172012-02-04 22:26:49 +0100122#ifdef CONFIG_PM_GENERIC_DOMAINS
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200123static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
124{
125 return container_of(pdd, struct generic_pm_domain_data, base);
126}
127
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +0100128static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
129{
130 return to_gpd_data(dev->power.subsys_data->domain_data);
131}
132
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100133extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
134 struct device *dev,
135 struct gpd_timing_data *td);
136
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200137extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
138 struct device *dev);
139extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
140 struct generic_pm_domain *new_subdomain);
141extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
142 struct generic_pm_domain *target);
Ulf Hansson7eb231c2016-06-17 12:27:52 +0200143extern int pm_genpd_init(struct generic_pm_domain *genpd,
144 struct dev_power_governor *gov, bool is_off);
Jon Hunter3fe57712016-09-12 12:01:13 +0100145extern int pm_genpd_remove(struct generic_pm_domain *genpd);
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100146
Ulf Hanssonae3c5112014-09-03 12:52:31 +0200147extern struct dev_power_governor simple_qos_governor;
Mark Brown925b44a2011-12-08 23:27:28 +0100148extern struct dev_power_governor pm_domain_always_on_gov;
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200149#else
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100150
Magnus Dammb6426312012-02-25 22:14:18 +0100151static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
152{
153 return ERR_PTR(-ENOSYS);
154}
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100155static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
156 struct device *dev,
157 struct gpd_timing_data *td)
158{
159 return -ENOSYS;
160}
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200161static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
162 struct device *dev)
163{
164 return -ENOSYS;
165}
166static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
167 struct generic_pm_domain *new_sd)
168{
169 return -ENOSYS;
170}
171static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
172 struct generic_pm_domain *target)
173{
174 return -ENOSYS;
175}
Ulf Hansson7eb231c2016-06-17 12:27:52 +0200176static inline int pm_genpd_init(struct generic_pm_domain *genpd,
177 struct dev_power_governor *gov, bool is_off)
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100178{
Ulf Hansson7eb231c2016-06-17 12:27:52 +0200179 return -ENOSYS;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100180}
Jon Hunter3fe57712016-09-12 12:01:13 +0100181static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
182{
183 return -ENOTSUPP;
184}
Geert Uytterhoeven16d0bf12017-02-08 19:37:55 +0100185
186#define simple_qos_governor (*(struct dev_power_governor *)(NULL))
187#define pm_domain_always_on_gov (*(struct dev_power_governor *)(NULL))
Rafael J. Wysocki17f2ae72011-08-14 13:34:31 +0200188#endif
189
Rafael J. Wysockib5abb082012-08-07 01:06:11 +0200190static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
191 struct device *dev)
192{
193 return __pm_genpd_add_device(genpd, dev, NULL);
194}
195
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200196#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
Ulf Hanssond47e6462014-09-03 12:52:24 +0200197extern void pm_genpd_syscore_poweroff(struct device *dev);
198extern void pm_genpd_syscore_poweron(struct device *dev);
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200199#else
Ulf Hanssond47e6462014-09-03 12:52:24 +0200200static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
201static inline void pm_genpd_syscore_poweron(struct device *dev) {}
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200202#endif
203
Tomasz Figaaa422402014-09-19 20:27:36 +0200204/* OF PM domain providers */
205struct of_device_id;
206
207struct genpd_onecell_data {
208 struct generic_pm_domain **domains;
209 unsigned int num_domains;
210};
211
Tomasz Figaaa422402014-09-19 20:27:36 +0200212#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
Jon Hunter892ebdcc2016-09-12 12:01:09 +0100213int of_genpd_add_provider_simple(struct device_node *np,
214 struct generic_pm_domain *genpd);
215int of_genpd_add_provider_onecell(struct device_node *np,
216 struct genpd_onecell_data *data);
Tomasz Figaaa422402014-09-19 20:27:36 +0200217void of_genpd_del_provider(struct device_node *np);
Jon Hunterec695722016-09-12 12:01:05 +0100218extern int of_genpd_add_device(struct of_phandle_args *args,
219 struct device *dev);
220extern int of_genpd_add_subdomain(struct of_phandle_args *parent,
221 struct of_phandle_args *new_subdomain);
Jon Hunter17926552016-09-12 12:01:14 +0100222extern struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
Lina Iyer30f60422016-10-14 10:47:51 -0700223extern int of_genpd_parse_idle_states(struct device_node *dn,
224 struct genpd_power_state **states, int *n);
Tomasz Figaaa422402014-09-19 20:27:36 +0200225
226int genpd_dev_pm_attach(struct device *dev);
227#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
Jon Hunter892ebdcc2016-09-12 12:01:09 +0100228static inline int of_genpd_add_provider_simple(struct device_node *np,
229 struct generic_pm_domain *genpd)
Tomasz Figaaa422402014-09-19 20:27:36 +0200230{
Jon Hunter892ebdcc2016-09-12 12:01:09 +0100231 return -ENOTSUPP;
Tomasz Figaaa422402014-09-19 20:27:36 +0200232}
Tomasz Figaaa422402014-09-19 20:27:36 +0200233
Jon Hunter892ebdcc2016-09-12 12:01:09 +0100234static inline int of_genpd_add_provider_onecell(struct device_node *np,
235 struct genpd_onecell_data *data)
236{
237 return -ENOTSUPP;
238}
239
240static inline void of_genpd_del_provider(struct device_node *np) {}
Tomasz Figaaa422402014-09-19 20:27:36 +0200241
Jon Hunterec695722016-09-12 12:01:05 +0100242static inline int of_genpd_add_device(struct of_phandle_args *args,
243 struct device *dev)
244{
245 return -ENODEV;
246}
247
248static inline int of_genpd_add_subdomain(struct of_phandle_args *parent,
249 struct of_phandle_args *new_subdomain)
250{
251 return -ENODEV;
252}
253
Lina Iyer30f60422016-10-14 10:47:51 -0700254static inline int of_genpd_parse_idle_states(struct device_node *dn,
255 struct genpd_power_state **states, int *n)
256{
257 return -ENODEV;
258}
259
Tomasz Figaaa422402014-09-19 20:27:36 +0200260static inline int genpd_dev_pm_attach(struct device *dev)
261{
262 return -ENODEV;
263}
Jon Hunter17926552016-09-12 12:01:14 +0100264
265static inline
266struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
267{
268 return ERR_PTR(-ENOTSUPP);
269}
Tomasz Figaaa422402014-09-19 20:27:36 +0200270#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
271
Ulf Hanssonf48c7672014-09-29 13:58:47 +0200272#ifdef CONFIG_PM
273extern int dev_pm_domain_attach(struct device *dev, bool power_on);
274extern void dev_pm_domain_detach(struct device *dev, bool power_off);
Tomeu Vizoso989561d2016-01-07 16:46:13 +0100275extern void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
Ulf Hanssonf48c7672014-09-29 13:58:47 +0200276#else
277static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
278{
279 return -ENODEV;
280}
281static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
Tomeu Vizoso989561d2016-01-07 16:46:13 +0100282static inline void dev_pm_domain_set(struct device *dev,
283 struct dev_pm_domain *pd) {}
Ulf Hanssonf48c7672014-09-29 13:58:47 +0200284#endif
285
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200286#endif /* _LINUX_PM_DOMAIN_H */