blob: 9b6abe6325875ce91a353d64fa2f53a52a77f583 [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 Hanssonffaa42e2017-03-20 11:19:21 +010023#define GENPD_FLAG_ALWAYS_ON (1U << 2) /* PM domain is always powered on */
Ulf Hanssonc11f6f52014-12-01 12:50:21 +010024
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020025enum gpd_status {
26 GPD_STATE_ACTIVE = 0, /* PM domain is active */
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020027 GPD_STATE_POWER_OFF, /* PM domain is off */
28};
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020029
Rafael J. Wysockif7218892011-07-01 22:12:45 +020030struct dev_power_governor {
31 bool (*power_down_ok)(struct dev_pm_domain *domain);
Ulf Hansson9df39212016-03-31 11:21:25 +020032 bool (*suspend_ok)(struct device *dev);
Rafael J. Wysockif7218892011-07-01 22:12:45 +020033};
34
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +010035struct gpd_dev_ops {
36 int (*start)(struct device *dev);
37 int (*stop)(struct device *dev);
38 bool (*active_wakeup)(struct device *dev);
39};
40
Axel Haslamfc5cbf02016-02-15 11:10:51 +010041struct genpd_power_state {
42 s64 power_off_latency_ns;
43 s64 power_on_latency_ns;
Lina Iyer405f7222016-10-14 10:47:50 -070044 s64 residency_ns;
Lina Iyer0c9b6942016-10-14 10:47:52 -070045 struct fwnode_handle *fwnode;
Axel Haslamfc5cbf02016-02-15 11:10:51 +010046};
47
Lina Iyer35241d12016-10-14 10:47:54 -070048struct genpd_lock_ops;
49
Rafael J. Wysockif7218892011-07-01 22:12:45 +020050struct generic_pm_domain {
51 struct dev_pm_domain domain; /* PM domain operations */
Rafael J. Wysocki5125bbf2011-07-13 12:31:52 +020052 struct list_head gpd_list_node; /* Node in the global PM domains list */
Rafael J. Wysocki5063ce12011-08-08 23:43:40 +020053 struct list_head master_links; /* Links with PM domain as a master */
54 struct list_head slave_links; /* Links with PM domain as a slave */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020055 struct list_head dev_list; /* List of devices */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020056 struct dev_power_governor *gov;
57 struct work_struct power_off_work;
Jon Hunterde0aa06d2016-09-12 12:01:12 +010058 struct fwnode_handle *provider; /* Identity of the domain provider */
59 bool has_provider;
Geert Uytterhoevend07e9c12014-08-29 15:13:21 +020060 const char *name;
Rafael J. Wysockic4bb3162011-08-08 23:43:04 +020061 atomic_t sd_count; /* Number of subdomains with power "on" */
Rafael J. Wysocki17b75ec2011-07-12 00:39:29 +020062 enum gpd_status status; /* Current state of the domain */
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020063 unsigned int device_count; /* Number of devices */
64 unsigned int suspended_count; /* System suspend device counter */
65 unsigned int prepared_count; /* Suspend counter of prepared devices */
Rafael J. Wysockif7218892011-07-01 22:12:45 +020066 int (*power_off)(struct generic_pm_domain *domain);
67 int (*power_on)(struct generic_pm_domain *domain);
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +010068 struct gpd_dev_ops dev_ops;
Rafael J. Wysocki221e9b52011-12-01 00:02:10 +010069 s64 max_off_time_ns; /* Maximum allowed "suspended" time. */
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +020070 bool max_off_time_changed;
71 bool cached_power_down_ok;
Ulf Hanssonc16561e2014-11-06 00:37:08 +010072 int (*attach_dev)(struct generic_pm_domain *domain,
73 struct device *dev);
74 void (*detach_dev)(struct generic_pm_domain *domain,
75 struct device *dev);
Ulf Hanssonc11f6f52014-12-01 12:50:21 +010076 unsigned int flags; /* Bit field of configs for genpd */
Lina Iyer59d65b72016-10-14 10:47:49 -070077 struct genpd_power_state *states;
Axel Haslamfc5cbf02016-02-15 11:10:51 +010078 unsigned int state_count; /* number of states */
79 unsigned int state_idx; /* state that genpd will go to when off */
Lina Iyer59d65b72016-10-14 10:47:49 -070080 void *free; /* Free the state that was allocated for default */
Lina Iyer35241d12016-10-14 10:47:54 -070081 const struct genpd_lock_ops *lock_ops;
Lina Iyerd716f472016-10-14 10:47:55 -070082 union {
83 struct mutex mlock;
84 struct {
85 spinlock_t slock;
86 unsigned long lock_flags;
87 };
88 };
Axel Haslamfc5cbf02016-02-15 11:10:51 +010089
Rafael J. Wysockif7218892011-07-01 22:12:45 +020090};
91
Rafael J. Wysocki596ba342011-07-01 22:13:19 +020092static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
93{
94 return container_of(pd, struct generic_pm_domain, domain);
95}
96
Rafael J. Wysocki5063ce12011-08-08 23:43:40 +020097struct gpd_link {
98 struct generic_pm_domain *master;
99 struct list_head master_node;
100 struct generic_pm_domain *slave;
101 struct list_head slave_node;
102};
103
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100104struct gpd_timing_data {
Ulf Hansson2b1d88c2015-10-15 17:02:19 +0200105 s64 suspend_latency_ns;
106 s64 resume_latency_ns;
Rafael J. Wysockia5bef8102012-04-29 22:54:17 +0200107 s64 effective_constraint_ns;
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +0200108 bool constraint_changed;
Ulf Hansson9df39212016-03-31 11:21:25 +0200109 bool cached_suspend_ok;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100110};
111
Ulf Hansson00e7c292014-11-14 08:41:32 +0100112struct pm_domain_data {
113 struct list_head list_node;
114 struct device *dev;
115};
116
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200117struct generic_pm_domain_data {
118 struct pm_domain_data base;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100119 struct gpd_timing_data td;
Rafael J. Wysocki6ff7bb0d02012-05-01 21:34:07 +0200120 struct notifier_block nb;
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200121};
122
Guennadi Liakhovetski9b4f6172012-02-04 22:26:49 +0100123#ifdef CONFIG_PM_GENERIC_DOMAINS
Rafael J. Wysockicd0ea672011-09-26 20:22:02 +0200124static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
125{
126 return container_of(pdd, struct generic_pm_domain_data, base);
127}
128
Rafael J. Wysockid5e4cbf2011-11-27 13:11:36 +0100129static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
130{
131 return to_gpd_data(dev->power.subsys_data->domain_data);
132}
133
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100134extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
135 struct device *dev,
136 struct gpd_timing_data *td);
137
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200138extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
139 struct device *dev);
140extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
141 struct generic_pm_domain *new_subdomain);
142extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
143 struct generic_pm_domain *target);
Ulf Hansson7eb231c2016-06-17 12:27:52 +0200144extern int pm_genpd_init(struct generic_pm_domain *genpd,
145 struct dev_power_governor *gov, bool is_off);
Jon Hunter3fe57712016-09-12 12:01:13 +0100146extern int pm_genpd_remove(struct generic_pm_domain *genpd);
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100147
Ulf Hanssonae3c5112014-09-03 12:52:31 +0200148extern struct dev_power_governor simple_qos_governor;
Mark Brown925b44a2011-12-08 23:27:28 +0100149extern struct dev_power_governor pm_domain_always_on_gov;
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200150#else
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100151
Magnus Dammb6426312012-02-25 22:14:18 +0100152static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
153{
154 return ERR_PTR(-ENOSYS);
155}
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100156static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
157 struct device *dev,
158 struct gpd_timing_data *td)
159{
160 return -ENOSYS;
161}
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200162static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
163 struct device *dev)
164{
165 return -ENOSYS;
166}
167static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
168 struct generic_pm_domain *new_sd)
169{
170 return -ENOSYS;
171}
172static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
173 struct generic_pm_domain *target)
174{
175 return -ENOSYS;
176}
Ulf Hansson7eb231c2016-06-17 12:27:52 +0200177static inline int pm_genpd_init(struct generic_pm_domain *genpd,
178 struct dev_power_governor *gov, bool is_off)
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100179{
Ulf Hansson7eb231c2016-06-17 12:27:52 +0200180 return -ENOSYS;
Rafael J. Wysockib02c9992011-12-01 00:02:05 +0100181}
Jon Hunter3fe57712016-09-12 12:01:13 +0100182static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
183{
184 return -ENOTSUPP;
185}
Geert Uytterhoeven16d0bf12017-02-08 19:37:55 +0100186
187#define simple_qos_governor (*(struct dev_power_governor *)(NULL))
188#define pm_domain_always_on_gov (*(struct dev_power_governor *)(NULL))
Rafael J. Wysocki17f2ae72011-08-14 13:34:31 +0200189#endif
190
Rafael J. Wysockib5abb082012-08-07 01:06:11 +0200191static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
192 struct device *dev)
193{
194 return __pm_genpd_add_device(genpd, dev, NULL);
195}
196
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200197#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
Ulf Hanssond47e6462014-09-03 12:52:24 +0200198extern void pm_genpd_syscore_poweroff(struct device *dev);
199extern void pm_genpd_syscore_poweron(struct device *dev);
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200200#else
Ulf Hanssond47e6462014-09-03 12:52:24 +0200201static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
202static inline void pm_genpd_syscore_poweron(struct device *dev) {}
Rafael J. Wysocki77f827d2012-08-06 01:39:57 +0200203#endif
204
Tomasz Figaaa422402014-09-19 20:27:36 +0200205/* OF PM domain providers */
206struct of_device_id;
207
208struct genpd_onecell_data {
209 struct generic_pm_domain **domains;
210 unsigned int num_domains;
211};
212
Tomasz Figaaa422402014-09-19 20:27:36 +0200213#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
Jon Hunter892ebdcc2016-09-12 12:01:09 +0100214int of_genpd_add_provider_simple(struct device_node *np,
215 struct generic_pm_domain *genpd);
216int of_genpd_add_provider_onecell(struct device_node *np,
217 struct genpd_onecell_data *data);
Tomasz Figaaa422402014-09-19 20:27:36 +0200218void of_genpd_del_provider(struct device_node *np);
Jon Hunterec695722016-09-12 12:01:05 +0100219extern int of_genpd_add_device(struct of_phandle_args *args,
220 struct device *dev);
221extern int of_genpd_add_subdomain(struct of_phandle_args *parent,
222 struct of_phandle_args *new_subdomain);
Jon Hunter17926552016-09-12 12:01:14 +0100223extern struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
Lina Iyer30f60422016-10-14 10:47:51 -0700224extern int of_genpd_parse_idle_states(struct device_node *dn,
225 struct genpd_power_state **states, int *n);
Tomasz Figaaa422402014-09-19 20:27:36 +0200226
227int genpd_dev_pm_attach(struct device *dev);
228#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
Jon Hunter892ebdcc2016-09-12 12:01:09 +0100229static inline int of_genpd_add_provider_simple(struct device_node *np,
230 struct generic_pm_domain *genpd)
Tomasz Figaaa422402014-09-19 20:27:36 +0200231{
Jon Hunter892ebdcc2016-09-12 12:01:09 +0100232 return -ENOTSUPP;
Tomasz Figaaa422402014-09-19 20:27:36 +0200233}
Tomasz Figaaa422402014-09-19 20:27:36 +0200234
Jon Hunter892ebdcc2016-09-12 12:01:09 +0100235static inline int of_genpd_add_provider_onecell(struct device_node *np,
236 struct genpd_onecell_data *data)
237{
238 return -ENOTSUPP;
239}
240
241static inline void of_genpd_del_provider(struct device_node *np) {}
Tomasz Figaaa422402014-09-19 20:27:36 +0200242
Jon Hunterec695722016-09-12 12:01:05 +0100243static inline int of_genpd_add_device(struct of_phandle_args *args,
244 struct device *dev)
245{
246 return -ENODEV;
247}
248
249static inline int of_genpd_add_subdomain(struct of_phandle_args *parent,
250 struct of_phandle_args *new_subdomain)
251{
252 return -ENODEV;
253}
254
Lina Iyer30f60422016-10-14 10:47:51 -0700255static inline int of_genpd_parse_idle_states(struct device_node *dn,
256 struct genpd_power_state **states, int *n)
257{
258 return -ENODEV;
259}
260
Tomasz Figaaa422402014-09-19 20:27:36 +0200261static inline int genpd_dev_pm_attach(struct device *dev)
262{
263 return -ENODEV;
264}
Jon Hunter17926552016-09-12 12:01:14 +0100265
266static inline
267struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
268{
269 return ERR_PTR(-ENOTSUPP);
270}
Tomasz Figaaa422402014-09-19 20:27:36 +0200271#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
272
Ulf Hanssonf48c7672014-09-29 13:58:47 +0200273#ifdef CONFIG_PM
274extern int dev_pm_domain_attach(struct device *dev, bool power_on);
275extern void dev_pm_domain_detach(struct device *dev, bool power_off);
Tomeu Vizoso989561d2016-01-07 16:46:13 +0100276extern void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
Ulf Hanssonf48c7672014-09-29 13:58:47 +0200277#else
278static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
279{
280 return -ENODEV;
281}
282static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
Tomeu Vizoso989561d2016-01-07 16:46:13 +0100283static inline void dev_pm_domain_set(struct device *dev,
284 struct dev_pm_domain *pd) {}
Ulf Hanssonf48c7672014-09-29 13:58:47 +0200285#endif
286
Rafael J. Wysockif7218892011-07-01 22:12:45 +0200287#endif /* _LINUX_PM_DOMAIN_H */