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_cpuidle_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         const 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 gpd_cpuidle_data *cpuidle_data;
  75         void (*attach_dev)(struct device *dev);
  76         void (*detach_dev)(struct device *dev);
  77 };
  78
  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
  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
  91 struct gpd_timing_data {
  92         s64 stop_latency_ns;
  93         s64 start_latency_ns;
  94         s64 save_state_latency_ns;
  95         s64 restore_state_latency_ns;
  96         s64 effective_constraint_ns;
  97         bool constraint_changed;
  98         bool cached_stop_ok;
  99 };
 100
 101 struct generic_pm_domain_data {
 102         struct pm_domain_data base;
 103         struct gpd_timing_data td;
 104         struct notifier_block nb;
 105         struct mutex lock;
 106         unsigned int refcount;
 107         bool need_restore;
 108 };
 109
 110 #ifdef CONFIG_PM_GENERIC_DOMAINS
 111 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 112 {
 113         return container_of(pdd, struct generic_pm_domain_data, base);
 114 }
 115
 116 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 117 {
 118         return to_gpd_data(dev->power.subsys_data->domain_data);
 119 }
 120
 121 extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
 122 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 123                                  struct device *dev,
 124                                  struct gpd_timing_data *td);
 125
 126 extern int __pm_genpd_name_add_device(const char *domain_name,
 127                                       struct device *dev,
 128                                       struct gpd_timing_data *td);
 129
 130 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 131                                   struct device *dev);
 132 extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
 133 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 134                                   struct generic_pm_domain *new_subdomain);
 135 extern int pm_genpd_add_subdomain_names(const char *master_name,
 136                                         const char *subdomain_name);
 137 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 138                                      struct generic_pm_domain *target);
 139 extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
 140 extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
 141 extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
 142 extern int pm_genpd_name_detach_cpuidle(const char *name);
 143 extern void pm_genpd_init(struct generic_pm_domain *genpd,
 144                           struct dev_power_governor *gov, bool is_off);
 145
 146 extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
 147 extern int pm_genpd_name_poweron(const char *domain_name);
 148
 149 extern struct dev_power_governor simple_qos_governor;
 150 extern struct dev_power_governor pm_domain_always_on_gov;
 151 #else
 152
 153 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 154 {
 155         return ERR_PTR(-ENOSYS);
 156 }
 157 static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
 158 {
 159         return ERR_PTR(-ENOSYS);
 160 }
 161 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 162                                         struct device *dev,
 163                                         struct gpd_timing_data *td)
 164 {
 165         return -ENOSYS;
 166 }
 167 static inline int __pm_genpd_name_add_device(const char *domain_name,
 168                                              struct device *dev,
 169                                              struct gpd_timing_data *td)
 170 {
 171         return -ENOSYS;
 172 }
 173 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 174                                          struct device *dev)
 175 {
 176         return -ENOSYS;
 177 }
 178 static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
 179 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 180                                          struct generic_pm_domain *new_sd)
 181 {
 182         return -ENOSYS;
 183 }
 184 static inline int pm_genpd_add_subdomain_names(const char *master_name,
 185                                                const char *subdomain_name)
 186 {
 187         return -ENOSYS;
 188 }
 189 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 190                                             struct generic_pm_domain *target)
 191 {
 192         return -ENOSYS;
 193 }
 194 static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
 195 {
 196         return -ENOSYS;
 197 }
 198 static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
 199 {
 200         return -ENOSYS;
 201 }
 202 static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
 203 {
 204         return -ENOSYS;
 205 }
 206 static inline int pm_genpd_name_detach_cpuidle(const char *name)
 207 {
 208         return -ENOSYS;
 209 }
 210 static inline void pm_genpd_init(struct generic_pm_domain *genpd,
 211                                  struct dev_power_governor *gov, bool is_off)
 212 {
 213 }
 214 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
 215 {
 216         return -ENOSYS;
 217 }
 218 static inline int pm_genpd_name_poweron(const char *domain_name)
 219 {
 220         return -ENOSYS;
 221 }
 222 #define simple_qos_governor NULL
 223 #define pm_domain_always_on_gov NULL
 224 #endif
 225
 226 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 227                                       struct device *dev)
 228 {
 229         return __pm_genpd_add_device(genpd, dev, NULL);
 230 }
 231
 232 static inline int pm_genpd_name_add_device(const char *domain_name,
 233                                            struct device *dev)
 234 {
 235         return __pm_genpd_name_add_device(domain_name, dev, NULL);
 236 }
 237
 238 #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
 239 extern void pm_genpd_poweroff_unused(void);
 240 #else
 241 static inline void pm_genpd_poweroff_unused(void) {}
 242 #endif
 243
 244 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
 245 extern void pm_genpd_syscore_poweroff(struct device *dev);
 246 extern void pm_genpd_syscore_poweron(struct device *dev);
 247 #else
 248 static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
 249 static inline void pm_genpd_syscore_poweron(struct device *dev) {}
 250 #endif
 251
 252 /* OF PM domain providers */
 253 struct of_device_id;
 254
 255 struct genpd_onecell_data {
 256         struct generic_pm_domain **domains;
 257         unsigned int num_domains;
 258 };
 259
 260 typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
 261                                                 void *data);
 262
 263 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
 264 int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
 265                         void *data);
 266 void of_genpd_del_provider(struct device_node *np);
 267
 268 struct generic_pm_domain *__of_genpd_xlate_simple(
 269                                         struct of_phandle_args *genpdspec,
 270                                         void *data);
 271 struct generic_pm_domain *__of_genpd_xlate_onecell(
 272                                         struct of_phandle_args *genpdspec,
 273                                         void *data);
 274
 275 int genpd_dev_pm_attach(struct device *dev);
 276 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
 277 static inline int __of_genpd_add_provider(struct device_node *np,
 278                                         genpd_xlate_t xlate, void *data)
 279 {
 280         return 0;
 281 }
 282 static inline void of_genpd_del_provider(struct device_node *np) {}
 283
 284 #define __of_genpd_xlate_simple         NULL
 285 #define __of_genpd_xlate_onecell        NULL
 286
 287 static inline int genpd_dev_pm_attach(struct device *dev)
 288 {
 289         return -ENODEV;
 290 }
 291 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
 292
 293 static inline int of_genpd_add_provider_simple(struct device_node *np,
 294                                         struct generic_pm_domain *genpd)
 295 {
 296         return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
 297 }
 298 static inline int of_genpd_add_provider_onecell(struct device_node *np,
 299                                         struct genpd_onecell_data *data)
 300 {
 301         return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
 302 }
 303
 304 #ifdef CONFIG_PM
 305 extern int dev_pm_domain_attach(struct device *dev, bool power_on);
 306 extern void dev_pm_domain_detach(struct device *dev, bool power_off);
 307 #else
 308 static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
 309 {
 310         return -ENODEV;
 311 }
 312 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
 313 #endif
 314
 315 #endif /* _LINUX_PM_DOMAIN_H */