include/linux/pm_domain.h

   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 #include <linux/mutex.h>
  14 #include <linux/pm.h>
  15 #include <linux/err.h>
  16 #include <linux/of.h>
  17 #include <linux/notifier.h>
  18 #include <linux/cpuidle.h>
  19
  20 enum gpd_status {
  21         GPD_STATE_ACTIVE = 0,   /* PM domain is active */
  22         GPD_STATE_WAIT_MASTER,  /* PM domain's master is being waited for */
  23         GPD_STATE_BUSY,         /* Something is happening to the PM domain */
  24         GPD_STATE_REPEAT,       /* Power off in progress, to be repeated */
  25         GPD_STATE_POWER_OFF,    /* PM domain is off */
  26 };
  27
  28 struct dev_power_governor {
  29         bool (*power_down_ok)(struct dev_pm_domain *domain);
  30         bool (*stop_ok)(struct device *dev);
  31 };
  32
  33 struct gpd_dev_ops {
  34         int (*start)(struct device *dev);
  35         int (*stop)(struct device *dev);
  36         int (*save_state)(struct device *dev);
  37         int (*restore_state)(struct device *dev);
  38         int (*suspend)(struct device *dev);
  39         int (*suspend_late)(struct device *dev);
  40         int (*resume_early)(struct device *dev);
  41         int (*resume)(struct device *dev);
  42         int (*freeze)(struct device *dev);
  43         int (*freeze_late)(struct device *dev);
  44         int (*thaw_early)(struct device *dev);
  45         int (*thaw)(struct device *dev);
  46         bool (*active_wakeup)(struct device *dev);
  47 };
  48
  49 struct gpd_cpu_data {
  50         unsigned int saved_exit_latency;
  51         struct cpuidle_state *idle_state;
  52 };
  53
  54 struct generic_pm_domain {
  55         struct dev_pm_domain domain;    /* PM domain operations */
  56         struct list_head gpd_list_node; /* Node in the global PM domains list */
  57         struct list_head master_links;  /* Links with PM domain as a master */
  58         struct list_head slave_links;   /* Links with PM domain as a slave */
  59         struct list_head dev_list;      /* List of devices */
  60         struct mutex lock;
  61         struct dev_power_governor *gov;
  62         struct work_struct power_off_work;
  63         char *name;
  64         unsigned int in_progress;       /* Number of devices being suspended now */
  65         atomic_t sd_count;      /* Number of subdomains with power "on" */
  66         enum gpd_status status; /* Current state of the domain */
  67         wait_queue_head_t status_wait_queue;
  68         struct task_struct *poweroff_task;      /* Powering off task */
  69         unsigned int resume_count;      /* Number of devices being resumed */
  70         unsigned int device_count;      /* Number of devices */
  71         unsigned int suspended_count;   /* System suspend device counter */
  72         unsigned int prepared_count;    /* Suspend counter of prepared devices */
  73         bool suspend_power_off; /* Power status before system suspend */
  74         bool dev_irq_safe;      /* Device callbacks are IRQ-safe */
  75         int (*power_off)(struct generic_pm_domain *domain);
  76         s64 power_off_latency_ns;
  77         int (*power_on)(struct generic_pm_domain *domain);
  78         s64 power_on_latency_ns;
  79         struct gpd_dev_ops dev_ops;
  80         s64 max_off_time_ns;    /* Maximum allowed "suspended" time. */
  81         bool max_off_time_changed;
  82         bool cached_power_down_ok;
  83         struct device_node *of_node; /* Node in device tree */
  84         struct gpd_cpu_data *cpu_data;
  85 };
  86
  87 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
  88 {
  89         return container_of(pd, struct generic_pm_domain, domain);
  90 }
  91
  92 struct gpd_link {
  93         struct generic_pm_domain *master;
  94         struct list_head master_node;
  95         struct generic_pm_domain *slave;
  96         struct list_head slave_node;
  97 };
  98
  99 struct gpd_timing_data {
 100         s64 stop_latency_ns;
 101         s64 start_latency_ns;
 102         s64 save_state_latency_ns;
 103         s64 restore_state_latency_ns;
 104         s64 effective_constraint_ns;
 105         bool constraint_changed;
 106         bool cached_stop_ok;
 107 };
 108
 109 struct generic_pm_domain_data {
 110         struct pm_domain_data base;
 111         struct gpd_timing_data td;
 112         struct notifier_block nb;
 113         struct mutex lock;
 114         unsigned int refcount;
 115         bool need_restore;
 116 };
 117
 118 #ifdef CONFIG_PM_GENERIC_DOMAINS
 119 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 120 {
 121         return container_of(pdd, struct generic_pm_domain_data, base);
 122 }
 123
 124 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 125 {
 126         return to_gpd_data(dev->power.subsys_data->domain_data);
 127 }
 128
 129 extern struct dev_power_governor simple_qos_governor;
 130
 131 extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
 132 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 133                                  struct device *dev,
 134                                  struct gpd_timing_data *td);
 135
 136 extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
 137                                     struct device *dev,
 138                                     struct gpd_timing_data *td);
 139
 140 extern int __pm_genpd_name_add_device(const char *domain_name,
 141                                       struct device *dev,
 142                                       struct gpd_timing_data *td);
 143
 144 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 145                                   struct device *dev);
 146 extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
 147 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 148                                   struct generic_pm_domain *new_subdomain);
 149 extern int pm_genpd_add_subdomain_names(const char *master_name,
 150                                         const char *subdomain_name);
 151 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 152                                      struct generic_pm_domain *target);
 153 extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
 154 extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
 155 extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
 156 extern int pm_genpd_name_detach_cpuidle(const char *name);
 157 extern void pm_genpd_init(struct generic_pm_domain *genpd,
 158                           struct dev_power_governor *gov, bool is_off);
 159
 160 extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
 161 extern int pm_genpd_name_poweron(const char *domain_name);
 162
 163 extern bool default_stop_ok(struct device *dev);
 164
 165 extern struct dev_power_governor pm_domain_always_on_gov;
 166 #else
 167
 168 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 169 {
 170         return ERR_PTR(-ENOSYS);
 171 }
 172 static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
 173 {
 174         return ERR_PTR(-ENOSYS);
 175 }
 176 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 177                                         struct device *dev,
 178                                         struct gpd_timing_data *td)
 179 {
 180         return -ENOSYS;
 181 }
 182 static inline int __pm_genpd_of_add_device(struct device_node *genpd_node,
 183                                            struct device *dev,
 184                                            struct gpd_timing_data *td)
 185 {
 186         return -ENOSYS;
 187 }
 188 static inline int __pm_genpd_name_add_device(const char *domain_name,
 189                                              struct device *dev,
 190                                              struct gpd_timing_data *td)
 191 {
 192         return -ENOSYS;
 193 }
 194 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 195                                          struct device *dev)
 196 {
 197         return -ENOSYS;
 198 }
 199 static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
 200 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 201                                          struct generic_pm_domain *new_sd)
 202 {
 203         return -ENOSYS;
 204 }
 205 static inline int pm_genpd_add_subdomain_names(const char *master_name,
 206                                                const char *subdomain_name)
 207 {
 208         return -ENOSYS;
 209 }
 210 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 211                                             struct generic_pm_domain *target)
 212 {
 213         return -ENOSYS;
 214 }
 215 static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
 216 {
 217         return -ENOSYS;
 218 }
 219 static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
 220 {
 221         return -ENOSYS;
 222 }
 223 static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
 224 {
 225         return -ENOSYS;
 226 }
 227 static inline int pm_genpd_name_detach_cpuidle(const char *name)
 228 {
 229         return -ENOSYS;
 230 }
 231 static inline void pm_genpd_init(struct generic_pm_domain *genpd,
 232                                  struct dev_power_governor *gov, bool is_off)
 233 {
 234 }
 235 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
 236 {
 237         return -ENOSYS;
 238 }
 239 static inline int pm_genpd_name_poweron(const char *domain_name)
 240 {
 241         return -ENOSYS;
 242 }
 243 static inline bool default_stop_ok(struct device *dev)
 244 {
 245         return false;
 246 }
 247 #define simple_qos_governor NULL
 248 #define pm_domain_always_on_gov NULL
 249 #endif
 250
 251 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 252                                       struct device *dev)
 253 {
 254         return __pm_genpd_add_device(genpd, dev, NULL);
 255 }
 256
 257 static inline int pm_genpd_of_add_device(struct device_node *genpd_node,
 258                                          struct device *dev)
 259 {
 260         return __pm_genpd_of_add_device(genpd_node, dev, NULL);
 261 }
 262
 263 static inline int pm_genpd_name_add_device(const char *domain_name,
 264                                            struct device *dev)
 265 {
 266         return __pm_genpd_name_add_device(domain_name, dev, NULL);
 267 }
 268
 269 #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
 270 extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
 271 extern void pm_genpd_poweroff_unused(void);
 272 #else
 273 static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
 274 static inline void pm_genpd_poweroff_unused(void) {}
 275 #endif
 276
 277 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
 278 extern void pm_genpd_syscore_switch(struct device *dev, bool suspend);
 279 #else
 280 static inline void pm_genpd_syscore_switch(struct device *dev, bool suspend) {}
 281 #endif
 282
 283 static inline void pm_genpd_syscore_poweroff(struct device *dev)
 284 {
 285         pm_genpd_syscore_switch(dev, true);
 286 }
 287
 288 static inline void pm_genpd_syscore_poweron(struct device *dev)
 289 {
 290         pm_genpd_syscore_switch(dev, false);
 291 }
 292
 293 #endif /* _LINUX_PM_DOMAIN_H */