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