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> |
| 13 | |
Rafael J. Wysocki | 17b75ec | 2011-07-12 00:39:29 +0200 | [diff] [blame] | 14 | enum gpd_status { |
| 15 | GPD_STATE_ACTIVE = 0, /* PM domain is active */ |
Rafael J. Wysocki | 17877eb | 2011-08-08 23:43:50 +0200 | [diff] [blame] | 16 | 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] | 17 | GPD_STATE_BUSY, /* Something is happening to the PM domain */ |
Rafael J. Wysocki | c6d22b3 | 2011-07-12 00:39:36 +0200 | [diff] [blame] | 18 | GPD_STATE_REPEAT, /* Power off in progress, to be repeated */ |
Rafael J. Wysocki | 17b75ec | 2011-07-12 00:39:29 +0200 | [diff] [blame] | 19 | GPD_STATE_POWER_OFF, /* PM domain is off */ |
| 20 | }; |
Rafael J. Wysocki | 596ba34 | 2011-07-01 22:13:19 +0200 | [diff] [blame] | 21 | |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 22 | struct dev_power_governor { |
| 23 | bool (*power_down_ok)(struct dev_pm_domain *domain); |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 24 | bool (*stop_ok)(struct device *dev); |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 25 | }; |
| 26 | |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 27 | struct gpd_dev_ops { |
| 28 | int (*start)(struct device *dev); |
| 29 | int (*stop)(struct device *dev); |
Rafael J. Wysocki | ecf0047 | 2011-11-27 13:11:44 +0100 | [diff] [blame] | 30 | int (*save_state)(struct device *dev); |
| 31 | int (*restore_state)(struct device *dev); |
Rafael J. Wysocki | d23b9b0 | 2011-11-27 13:11:51 +0100 | [diff] [blame] | 32 | int (*suspend)(struct device *dev); |
| 33 | int (*suspend_late)(struct device *dev); |
| 34 | int (*resume_early)(struct device *dev); |
| 35 | int (*resume)(struct device *dev); |
| 36 | int (*freeze)(struct device *dev); |
| 37 | int (*freeze_late)(struct device *dev); |
| 38 | int (*thaw_early)(struct device *dev); |
| 39 | int (*thaw)(struct device *dev); |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 40 | bool (*active_wakeup)(struct device *dev); |
| 41 | }; |
| 42 | |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 43 | struct generic_pm_domain { |
| 44 | struct dev_pm_domain domain; /* PM domain operations */ |
Rafael J. Wysocki | 5125bbf | 2011-07-13 12:31:52 +0200 | [diff] [blame] | 45 | 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] | 46 | struct list_head master_links; /* Links with PM domain as a master */ |
| 47 | 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] | 48 | struct list_head dev_list; /* List of devices */ |
| 49 | struct mutex lock; |
| 50 | struct dev_power_governor *gov; |
| 51 | struct work_struct power_off_work; |
| 52 | unsigned int in_progress; /* Number of devices being suspended now */ |
Rafael J. Wysocki | c4bb316 | 2011-08-08 23:43:04 +0200 | [diff] [blame] | 53 | atomic_t sd_count; /* Number of subdomains with power "on" */ |
Rafael J. Wysocki | 17b75ec | 2011-07-12 00:39:29 +0200 | [diff] [blame] | 54 | enum gpd_status status; /* Current state of the domain */ |
| 55 | wait_queue_head_t status_wait_queue; |
Rafael J. Wysocki | c6d22b3 | 2011-07-12 00:39:36 +0200 | [diff] [blame] | 56 | struct task_struct *poweroff_task; /* Powering off task */ |
| 57 | unsigned int resume_count; /* Number of devices being resumed */ |
Rafael J. Wysocki | 596ba34 | 2011-07-01 22:13:19 +0200 | [diff] [blame] | 58 | unsigned int device_count; /* Number of devices */ |
| 59 | unsigned int suspended_count; /* System suspend device counter */ |
| 60 | unsigned int prepared_count; /* Suspend counter of prepared devices */ |
| 61 | bool suspend_power_off; /* Power status before system suspend */ |
Rafael J. Wysocki | 0aa2a22 | 2011-08-25 15:37:04 +0200 | [diff] [blame] | 62 | bool dev_irq_safe; /* Device callbacks are IRQ-safe */ |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 63 | int (*power_off)(struct generic_pm_domain *domain); |
| 64 | int (*power_on)(struct generic_pm_domain *domain); |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 65 | struct gpd_dev_ops dev_ops; |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 66 | }; |
| 67 | |
Rafael J. Wysocki | 596ba34 | 2011-07-01 22:13:19 +0200 | [diff] [blame] | 68 | static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd) |
| 69 | { |
| 70 | return container_of(pd, struct generic_pm_domain, domain); |
| 71 | } |
| 72 | |
Rafael J. Wysocki | 5063ce1 | 2011-08-08 23:43:40 +0200 | [diff] [blame] | 73 | struct gpd_link { |
| 74 | struct generic_pm_domain *master; |
| 75 | struct list_head master_node; |
| 76 | struct generic_pm_domain *slave; |
| 77 | struct list_head slave_node; |
| 78 | }; |
| 79 | |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 80 | struct gpd_timing_data { |
| 81 | s64 stop_latency_ns; |
| 82 | s64 start_latency_ns; |
| 83 | s64 break_even_ns; |
| 84 | }; |
| 85 | |
Rafael J. Wysocki | cd0ea67 | 2011-09-26 20:22:02 +0200 | [diff] [blame] | 86 | struct generic_pm_domain_data { |
| 87 | struct pm_domain_data base; |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 88 | struct gpd_dev_ops ops; |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 89 | struct gpd_timing_data td; |
Rafael J. Wysocki | cd0ea67 | 2011-09-26 20:22:02 +0200 | [diff] [blame] | 90 | bool need_restore; |
| 91 | }; |
| 92 | |
| 93 | static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) |
| 94 | { |
| 95 | return container_of(pdd, struct generic_pm_domain_data, base); |
| 96 | } |
| 97 | |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 98 | #ifdef CONFIG_PM_GENERIC_DOMAINS |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 99 | static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) |
| 100 | { |
| 101 | return to_gpd_data(dev->power.subsys_data->domain_data); |
| 102 | } |
| 103 | |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 104 | extern struct dev_power_governor simple_qos_governor; |
| 105 | |
| 106 | extern struct generic_pm_domain *dev_to_genpd(struct device *dev); |
| 107 | extern int __pm_genpd_add_device(struct generic_pm_domain *genpd, |
| 108 | struct device *dev, |
| 109 | struct gpd_timing_data *td); |
| 110 | |
| 111 | static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, |
| 112 | struct device *dev) |
| 113 | { |
| 114 | return __pm_genpd_add_device(genpd, dev, NULL); |
| 115 | } |
| 116 | |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 117 | extern int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
| 118 | struct device *dev); |
| 119 | extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, |
| 120 | struct generic_pm_domain *new_subdomain); |
| 121 | extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, |
| 122 | struct generic_pm_domain *target); |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 123 | extern int pm_genpd_add_callbacks(struct device *dev, |
| 124 | struct gpd_dev_ops *ops, |
| 125 | struct gpd_timing_data *td); |
| 126 | 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] | 127 | extern void pm_genpd_init(struct generic_pm_domain *genpd, |
| 128 | struct dev_power_governor *gov, bool is_off); |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 129 | |
Magnus Damm | 18b4f3f | 2011-07-10 10:39:14 +0200 | [diff] [blame] | 130 | extern int pm_genpd_poweron(struct generic_pm_domain *genpd); |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 131 | |
| 132 | extern bool default_stop_ok(struct device *dev); |
| 133 | |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 134 | #else |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 135 | |
| 136 | static inline struct generic_pm_domain *dev_to_genpd(struct device *dev) |
| 137 | { |
| 138 | return ERR_PTR(-ENOSYS); |
| 139 | } |
| 140 | static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd, |
| 141 | struct device *dev, |
| 142 | struct gpd_timing_data *td) |
| 143 | { |
| 144 | return -ENOSYS; |
| 145 | } |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 146 | static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, |
| 147 | struct device *dev) |
| 148 | { |
| 149 | return -ENOSYS; |
| 150 | } |
| 151 | static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd, |
| 152 | struct device *dev) |
| 153 | { |
| 154 | return -ENOSYS; |
| 155 | } |
| 156 | static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, |
| 157 | struct generic_pm_domain *new_sd) |
| 158 | { |
| 159 | return -ENOSYS; |
| 160 | } |
| 161 | static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, |
| 162 | struct generic_pm_domain *target) |
| 163 | { |
| 164 | return -ENOSYS; |
| 165 | } |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 166 | static inline int pm_genpd_add_callbacks(struct device *dev, |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 167 | struct gpd_dev_ops *ops, |
| 168 | struct gpd_timing_data *td) |
Rafael J. Wysocki | d5e4cbf | 2011-11-27 13:11:36 +0100 | [diff] [blame] | 169 | { |
| 170 | return -ENOSYS; |
| 171 | } |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 172 | 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] | 173 | { |
| 174 | return -ENOSYS; |
| 175 | } |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 176 | static inline void pm_genpd_init(struct generic_pm_domain *genpd, bool is_off) |
| 177 | { |
| 178 | } |
Magnus Damm | 18b4f3f | 2011-07-10 10:39:14 +0200 | [diff] [blame] | 179 | static inline int pm_genpd_poweron(struct generic_pm_domain *genpd) |
| 180 | { |
| 181 | return -ENOSYS; |
| 182 | } |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 183 | static inline bool default_stop_ok(struct device *dev) |
| 184 | { |
| 185 | return false; |
| 186 | } |
Rafael J. Wysocki | 17f2ae7 | 2011-08-14 13:34:31 +0200 | [diff] [blame] | 187 | #endif |
| 188 | |
Rafael J. Wysocki | b02c999 | 2011-12-01 00:02:05 +0100 | [diff] [blame^] | 189 | static inline int pm_genpd_remove_callbacks(struct device *dev) |
| 190 | { |
| 191 | return __pm_genpd_remove_callbacks(dev, true); |
| 192 | } |
| 193 | |
Rafael J. Wysocki | 17f2ae7 | 2011-08-14 13:34:31 +0200 | [diff] [blame] | 194 | #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME |
| 195 | extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd); |
| 196 | extern void pm_genpd_poweroff_unused(void); |
| 197 | #else |
Rafael J. Wysocki | 0bc5b2d | 2011-07-14 20:59:07 +0200 | [diff] [blame] | 198 | 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] | 199 | static inline void pm_genpd_poweroff_unused(void) {} |
Rafael J. Wysocki | f721889 | 2011-07-01 22:12:45 +0200 | [diff] [blame] | 200 | #endif |
| 201 | |
| 202 | #endif /* _LINUX_PM_DOMAIN_H */ |