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