Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 1 | /* |
| 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 Gortmaker | 313162d | 2012-01-30 11:46:54 -0500 | [diff] [blame] | 13 | #include <linux/mutex.h> |
| 14 | #include <linux/pm.h> |
Guennadi Liakhovetski | 4f042cd | 2011-12-01 00:05:31 +0100 | [diff] [blame] | 15 | #include <linux/err.h> |
Thomas Abraham | c8aa130 | 2012-01-27 15:22:07 +0900 | [diff] [blame] | 16 | #include <linux/of.h> |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 17 | |
Rafael J. Wysocki | 17b75ec | 2011-07-12 00:39:29 +0200 | [diff] [blame] | 18 | enum gpd_status { |
| 19 | GPD_STATE_ACTIVE = 0, /* PM domain is active */ |
Rafael J. Wysocki | 17877eb | 2011-08-08 23:43:50 +0200 | [diff] [blame] | 20 | GPD_STATE_WAIT_MASTER, /* PM domain's master is being waited for */ |
Rafael J. Wysocki | 17b75ec | 2011-07-12 00:39:29 +0200 | [diff] [blame] | 21 | GPD_STATE_BUSY, /* Something is happening to the PM domain */ |
Rafael J. Wysocki | c6d22b3 | 2011-07-12 00:39:36 +0200 | [diff] [blame] | 22 | GPD_STATE_REPEAT, /* Power off in progress, to be repeated */ |
Rafael J. Wysocki | 17b75ec | 2011-07-12 00:39:29 +0200 | [diff] [blame] | 23 | GPD_STATE_POWER_OFF, /* PM domain is off */ |
| 24 | }; |
Rafael J. Wysocki | 596ba34 | 2011-07-01 22:13:19 +0200 | [diff] [blame] | 25 | |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 26 | struct dev_power_governor { |
| 27 | bool (*power_down_ok)(struct dev_pm_domain *domain); |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 28 | bool (*stop_ok)(struct device *dev); |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 29 | }; |
| 30 | |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 31 | struct gpd_dev_ops { |
| 32 | int (*start)(struct device *dev); |
| 33 | int (*stop)(struct device *dev); |
Rafael J. Wysocki | ecf0047 | 2011-11-27 13:11:44 +0100 | [diff] [blame] | 34 | int (*save_state)(struct device *dev); |
| 35 | int (*restore_state)(struct device *dev); |
Rafael J. Wysocki | d23b9b0 | 2011-11-27 13:11:51 +0100 | [diff] [blame] | 36 | int (*suspend)(struct device *dev); |
| 37 | int (*suspend_late)(struct device *dev); |
| 38 | int (*resume_early)(struct device *dev); |
| 39 | int (*resume)(struct device *dev); |
| 40 | int (*freeze)(struct device *dev); |
| 41 | int (*freeze_late)(struct device *dev); |
| 42 | int (*thaw_early)(struct device *dev); |
| 43 | int (*thaw)(struct device *dev); |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 44 | bool (*active_wakeup)(struct device *dev); |
| 45 | }; |
| 46 | |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 47 | struct generic_pm_domain { |
| 48 | struct dev_pm_domain domain; /* PM domain operations */ |
Rafael J. Wysocki | 5125bbf | 2011-07-13 12:31:52 +0200 | [diff] [blame] | 49 | struct list_head gpd_list_node; /* Node in the global PM domains list */ |
Rafael J. Wysocki | 5063ce1 | 2011-08-08 23:43:40 +0200 | [diff] [blame] | 50 | struct list_head master_links; /* Links with PM domain as a master */ |
| 51 | struct list_head slave_links; /* Links with PM domain as a slave */ |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 52 | struct list_head dev_list; /* List of devices */ |
| 53 | struct mutex lock; |
| 54 | struct dev_power_governor *gov; |
| 55 | struct work_struct power_off_work; |
Rafael J. Wysocki | e84b2c2 | 2011-12-06 22:19:54 +0100 | [diff] [blame] | 56 | char *name; |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 57 | unsigned int in_progress; /* Number of devices being suspended now */ |
Rafael J. Wysocki | c4bb316 | 2011-08-08 23:43:04 +0200 | [diff] [blame] | 58 | atomic_t sd_count; /* Number of subdomains with power "on" */ |
Rafael J. Wysocki | 17b75ec | 2011-07-12 00:39:29 +0200 | [diff] [blame] | 59 | enum gpd_status status; /* Current state of the domain */ |
| 60 | wait_queue_head_t status_wait_queue; |
Rafael J. Wysocki | c6d22b3 | 2011-07-12 00:39:36 +0200 | [diff] [blame] | 61 | struct task_struct *poweroff_task; /* Powering off task */ |
| 62 | unsigned int resume_count; /* Number of devices being resumed */ |
Rafael J. Wysocki | 596ba34 | 2011-07-01 22:13:19 +0200 | [diff] [blame] | 63 | 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 */ |
| 66 | bool suspend_power_off; /* Power status before system suspend */ |
Rafael J. Wysocki | 0aa2a22 | 2011-08-25 15:37:04 +0200 | [diff] [blame] | 67 | bool dev_irq_safe; /* Device callbacks are IRQ-safe */ |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 68 | int (*power_off)(struct generic_pm_domain *domain); |
Rafael J. Wysocki | 221e9b5 | 2011-12-01 00:02:10 +0100 | [diff] [blame] | 69 | s64 power_off_latency_ns; |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 70 | int (*power_on)(struct generic_pm_domain *domain); |
Rafael J. Wysocki | 221e9b5 | 2011-12-01 00:02:10 +0100 | [diff] [blame] | 71 | s64 power_on_latency_ns; |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 72 | struct gpd_dev_ops dev_ops; |
Rafael J. Wysocki | 221e9b5 | 2011-12-01 00:02:10 +0100 | [diff] [blame] | 73 | s64 break_even_ns; /* Power break even for the entire domain. */ |
| 74 | s64 max_off_time_ns; /* Maximum allowed "suspended" time. */ |
| 75 | ktime_t power_off_time; |
Thomas Abraham | c8aa130 | 2012-01-27 15:22:07 +0900 | [diff] [blame] | 76 | struct device_node *of_node; /* Node in device tree */ |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 77 | }; |
| 78 | |
Rafael J. Wysocki | 596ba34 | 2011-07-01 22:13:19 +0200 | [diff] [blame] | 79 | static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd) |
| 80 | { |
| 81 | return container_of(pd, struct generic_pm_domain, domain); |
| 82 | } |
| 83 | |
Rafael J. Wysocki | 5063ce1 | 2011-08-08 23:43:40 +0200 | [diff] [blame] | 84 | struct gpd_link { |
| 85 | struct generic_pm_domain *master; |
| 86 | struct list_head master_node; |
| 87 | struct generic_pm_domain *slave; |
| 88 | struct list_head slave_node; |
| 89 | }; |
| 90 | |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 91 | struct gpd_timing_data { |
| 92 | s64 stop_latency_ns; |
| 93 | s64 start_latency_ns; |
Rafael J. Wysocki | 221e9b5 | 2011-12-01 00:02:10 +0100 | [diff] [blame] | 94 | s64 save_state_latency_ns; |
| 95 | s64 restore_state_latency_ns; |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 96 | s64 break_even_ns; |
| 97 | }; |
| 98 | |
Rafael J. Wysocki | cd0ea67 | 2011-09-26 20:22:02 +0200 | [diff] [blame] | 99 | struct generic_pm_domain_data { |
| 100 | struct pm_domain_data base; |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 101 | struct gpd_dev_ops ops; |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 102 | struct gpd_timing_data td; |
Rafael J. Wysocki | cd0ea67 | 2011-09-26 20:22:02 +0200 | [diff] [blame] | 103 | bool need_restore; |
Rafael J. Wysocki | 1e78a0c | 2012-03-13 22:39:48 +0100 | [diff] [blame] | 104 | bool always_on; |
Rafael J. Wysocki | cd0ea67 | 2011-09-26 20:22:02 +0200 | [diff] [blame] | 105 | }; |
| 106 | |
Guennadi Liakhovetski | 9b4f617 | 2012-02-04 22:26:49 +0100 | [diff] [blame] | 107 | #ifdef CONFIG_PM_GENERIC_DOMAINS |
Rafael J. Wysocki | cd0ea67 | 2011-09-26 20:22:02 +0200 | [diff] [blame] | 108 | static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) |
| 109 | { |
| 110 | return container_of(pdd, struct generic_pm_domain_data, base); |
| 111 | } |
| 112 | |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 113 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
| 114 | { |
| 115 | return to_gpd_data(dev->power.subsys_data->domain_data); |
| 116 | } |
| 117 | |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 118 | extern struct dev_power_governor simple_qos_governor; |
| 119 | |
| 120 | extern struct generic_pm_domain *dev_to_genpd(struct device *dev); |
| 121 | extern int __pm_genpd_add_device(struct generic_pm_domain *genpd, |
| 122 | struct device *dev, |
| 123 | struct gpd_timing_data *td); |
| 124 | |
Thomas Abraham | c8aa130 | 2012-01-27 15:22:07 +0900 | [diff] [blame] | 125 | extern int __pm_genpd_of_add_device(struct device_node *genpd_node, |
| 126 | struct device *dev, |
| 127 | struct gpd_timing_data *td); |
| 128 | |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 129 | static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, |
| 130 | struct device *dev) |
| 131 | { |
| 132 | return __pm_genpd_add_device(genpd, dev, NULL); |
| 133 | } |
| 134 | |
Thomas Abraham | c8aa130 | 2012-01-27 15:22:07 +0900 | [diff] [blame] | 135 | static inline int pm_genpd_of_add_device(struct device_node *genpd_node, |
| 136 | struct device *dev) |
| 137 | { |
| 138 | return __pm_genpd_of_add_device(genpd_node, dev, NULL); |
| 139 | } |
| 140 | |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 141 | extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
| 142 | struct device *dev); |
Rafael J. Wysocki | 1e78a0c | 2012-03-13 22:39:48 +0100 | [diff] [blame] | 143 | extern void pm_genpd_dev_always_on(struct device *dev, bool val); |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 144 | extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, |
| 145 | struct generic_pm_domain *new_subdomain); |
| 146 | extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, |
| 147 | struct generic_pm_domain *target); |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 148 | extern int pm_genpd_add_callbacks(struct device *dev, |
| 149 | struct gpd_dev_ops *ops, |
| 150 | struct gpd_timing_data *td); |
| 151 | extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td); |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 152 | extern void pm_genpd_init(struct generic_pm_domain *genpd, |
| 153 | struct dev_power_governor *gov, bool is_off); |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 154 | |
Magnus Damm | 18b4f3f | 2011-07-10 10:39:14 +0200 | [diff] [blame] | 155 | extern int pm_genpd_poweron(struct generic_pm_domain *genpd); |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 156 | |
| 157 | extern bool default_stop_ok(struct device *dev); |
| 158 | |
Mark Brown | 925b44a | 2011-12-08 23:27:28 +0100 | [diff] [blame] | 159 | extern struct dev_power_governor pm_domain_always_on_gov; |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 160 | #else |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 161 | |
Magnus Damm | b642631 | 2012-02-25 22:14:18 +0100 | [diff] [blame] | 162 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
| 163 | { |
| 164 | return ERR_PTR(-ENOSYS); |
| 165 | } |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 166 | static inline struct generic_pm_domain *dev_to_genpd(struct device *dev) |
| 167 | { |
| 168 | return ERR_PTR(-ENOSYS); |
| 169 | } |
| 170 | static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd, |
| 171 | struct device *dev, |
| 172 | struct gpd_timing_data *td) |
| 173 | { |
| 174 | return -ENOSYS; |
| 175 | } |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 176 | static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, |
| 177 | struct device *dev) |
| 178 | { |
| 179 | return -ENOSYS; |
| 180 | } |
| 181 | static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
| 182 | struct device *dev) |
| 183 | { |
| 184 | return -ENOSYS; |
| 185 | } |
Rafael J. Wysocki | 1e78a0c | 2012-03-13 22:39:48 +0100 | [diff] [blame] | 186 | static inline void pm_genpd_dev_always_on(struct device *dev, bool val) {} |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 187 | static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, |
| 188 | struct generic_pm_domain *new_sd) |
| 189 | { |
| 190 | return -ENOSYS; |
| 191 | } |
| 192 | static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, |
| 193 | struct generic_pm_domain *target) |
| 194 | { |
| 195 | return -ENOSYS; |
| 196 | } |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 197 | static inline int pm_genpd_add_callbacks(struct device *dev, |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 198 | struct gpd_dev_ops *ops, |
| 199 | struct gpd_timing_data *td) |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 200 | { |
| 201 | return -ENOSYS; |
| 202 | } |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 203 | static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td) |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 204 | { |
| 205 | return -ENOSYS; |
| 206 | } |
Magnus Damm | b642631 | 2012-02-25 22:14:18 +0100 | [diff] [blame] | 207 | static inline void pm_genpd_init(struct generic_pm_domain *genpd, |
| 208 | struct dev_power_governor *gov, bool is_off) |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 209 | { |
| 210 | } |
Magnus Damm | 18b4f3f | 2011-07-10 10:39:14 +0200 | [diff] [blame] | 211 | static inline int pm_genpd_poweron(struct generic_pm_domain *genpd) |
| 212 | { |
| 213 | return -ENOSYS; |
| 214 | } |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 215 | static inline bool default_stop_ok(struct device *dev) |
| 216 | { |
| 217 | return false; |
| 218 | } |
Magnus Damm | b642631 | 2012-02-25 22:14:18 +0100 | [diff] [blame] | 219 | #define simple_qos_governor NULL |
Mark Brown | 925b44a | 2011-12-08 23:27:28 +0100 | [diff] [blame] | 220 | #define pm_domain_always_on_gov NULL |
Rafael J. Wysocki | 17f2ae7 | 2011-08-14 13:34:31 +0200 | [diff] [blame] | 221 | #endif |
| 222 | |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame] | 223 | static inline int pm_genpd_remove_callbacks(struct device *dev) |
| 224 | { |
| 225 | return __pm_genpd_remove_callbacks(dev, true); |
| 226 | } |
| 227 | |
Rafael J. Wysocki | 17f2ae7 | 2011-08-14 13:34:31 +0200 | [diff] [blame] | 228 | #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME |
| 229 | extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd); |
| 230 | extern void pm_genpd_poweroff_unused(void); |
| 231 | #else |
Rafael J. Wysocki | 0bc5b2d | 2011-07-14 20:59:07 +0200 | [diff] [blame] | 232 | static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {} |
Rafael J. Wysocki | 17f2ae7 | 2011-08-14 13:34:31 +0200 | [diff] [blame] | 233 | static inline void pm_genpd_poweroff_unused(void) {} |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 234 | #endif |
| 235 | |
| 236 | #endif /* _LINUX_PM_DOMAIN_H */ |