LXR linux/include/linux/pm

   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
  20enum 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
  28struct dev_power_governor {
  29        bool (*power_down_ok)(struct dev_pm_domain *domain);
  30        bool (*stop_ok)(struct device *dev);
  31};
  32
  33struct 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
  49struct gpd_cpu_data {
  50        unsigned int saved_exit_latency;
  51        struct cpuidle_state *idle_state;
  52};
  53
  54struct 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
  87static 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
  92struct 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
  99struct 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
 109struct generic_pm_domain_data {
 110        struct pm_domain_data base;
 111        struct gpd_dev_ops ops;
 112        struct gpd_timing_data td;
 113        struct notifier_block nb;
 114        struct mutex lock;
 115        unsigned int refcount;
 116        bool need_restore;
 117};
 118
 119#ifdef CONFIG_PM_GENERIC_DOMAINS
 120static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 121{
 122        return container_of(pdd, struct generic_pm_domain_data, base);
 123}
 124
 125static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 126{
 127        return to_gpd_data(dev->power.subsys_data->domain_data);
 128}
 129
 130extern struct dev_power_governor simple_qos_governor;
 131
 132extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
 133extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 134                                 struct device *dev,
 135                                 struct gpd_timing_data *td);
 136
 137extern int __pm_genpd_of_add_device(struct device_node *genpd_node,
 138                                    struct device *dev,
 139                                    struct gpd_timing_data *td);
 140
 141extern int __pm_genpd_name_add_device(const char *domain_name,
 142                                      struct device *dev,
 143                                      struct gpd_timing_data *td);
 144
 145extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 146                                  struct device *dev);
 147extern void pm_genpd_dev_need_restore(struct device *dev, bool val);
 148extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 149                                  struct generic_pm_domain *new_subdomain);
 150extern int pm_genpd_add_subdomain_names(const char *master_name,
 151                                        const char *subdomain_name);
 152extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 153                                     struct generic_pm_domain *target);
 154extern int pm_genpd_add_callbacks(struct device *dev,
 155                                  struct gpd_dev_ops *ops,
 156                                  struct gpd_timing_data *td);
 157extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
 158extern int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int state);
 159extern int pm_genpd_name_attach_cpuidle(const char *name, int state);
 160extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
 161extern int pm_genpd_name_detach_cpuidle(const char *name);
 162extern void pm_genpd_init(struct generic_pm_domain *genpd,
 163                          struct dev_power_governor *gov, bool is_off);
 164
 165extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
 166extern int pm_genpd_name_poweron(const char *domain_name);
 167
 168extern bool default_stop_ok(struct device *dev);
 169
 170extern struct dev_power_governor pm_domain_always_on_gov;
 171#else
 172
 173static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 174{
 175        return ERR_PTR(-ENOSYS);
 176}
 177static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
 178{
 179        return ERR_PTR(-ENOSYS);
 180}
 181static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 182                                        struct device *dev,
 183                                        struct gpd_timing_data *td)
 184{
 185        return -ENOSYS;
 186}
 187static inline int __pm_genpd_of_add_device(struct device_node *genpd_node,
 188                                           struct device *dev,
 189                                           struct gpd_timing_data *td)
 190{
 191        return -ENOSYS;
 192}
 193static inline int __pm_genpd_name_add_device(const char *domain_name,
 194                                             struct device *dev,
 195                                             struct gpd_timing_data *td)
 196{
 197        return -ENOSYS;
 198}
 199static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 200                                         struct device *dev)
 201{
 202        return -ENOSYS;
 203}
 204static inline void pm_genpd_dev_need_restore(struct device *dev, bool val) {}
 205static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 206                                         struct generic_pm_domain *new_sd)
 207{
 208        return -ENOSYS;
 209}
 210static inline int pm_genpd_add_subdomain_names(const char *master_name,
 211                                               const char *subdomain_name)
 212{
 213        return -ENOSYS;
 214}
 215static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 216                                            struct generic_pm_domain *target)
 217{
 218        return -ENOSYS;
 219}
 220static inline int pm_genpd_add_callbacks(struct device *dev,
 221                                         struct gpd_dev_ops *ops,
 222                                         struct gpd_timing_data *td)
 223{
 224        return -ENOSYS;
 225}
 226static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
 227{
 228        return -ENOSYS;
 229}
 230static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
 231{
 232        return -ENOSYS;
 233}
 234static inline int pm_genpd_name_attach_cpuidle(const char *name, int state)
 235{
 236        return -ENOSYS;
 237}
 238static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
 239{
 240        return -ENOSYS;
 241}
 242static inline int pm_genpd_name_detach_cpuidle(const char *name)
 243{
 244        return -ENOSYS;
 245}
 246static inline void pm_genpd_init(struct generic_pm_domain *genpd,
 247                                 struct dev_power_governor *gov, bool is_off)
 248{
 249}
 250static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
 251{
 252        return -ENOSYS;
 253}
 254static inline int pm_genpd_name_poweron(const char *domain_name)
 255{
 256        return -ENOSYS;
 257}
 258static inline bool default_stop_ok(struct device *dev)
 259{
 260        return false;
 261}
 262#define simple_qos_governor NULL
 263#define pm_domain_always_on_gov NULL
 264#endif
 265
 266static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 267                                      struct device *dev)
 268{
 269        return __pm_genpd_add_device(genpd, dev, NULL);
 270}
 271
 272static inline int pm_genpd_of_add_device(struct device_node *genpd_node,
 273                                         struct device *dev)
 274{
 275        return __pm_genpd_of_add_device(genpd_node, dev, NULL);
 276}
 277
 278static inline int pm_genpd_name_add_device(const char *domain_name,
 279                                           struct device *dev)
 280{
 281        return __pm_genpd_name_add_device(domain_name, dev, NULL);
 282}
 283
 284static inline int pm_genpd_remove_callbacks(struct device *dev)
 285{
 286        return __pm_genpd_remove_callbacks(dev, true);
 287}
 288
 289#ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
 290extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
 291extern void pm_genpd_poweroff_unused(void);
 292#else
 293static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
 294static inline void pm_genpd_poweroff_unused(void) {}
 295#endif
 296
 297#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
 298extern void pm_genpd_syscore_switch(struct device *dev, bool suspend);
 299#else
 300static inline void pm_genpd_syscore_switch(struct device *dev, bool suspend) {}
 301#endif
 302
 303static inline void pm_genpd_syscore_poweroff(struct device *dev)
 304{
 305        pm_genpd_syscore_switch(dev, true);
 306}
 307
 308static inline void pm_genpd_syscore_poweron(struct device *dev)
 309{
 310        pm_genpd_syscore_switch(dev, false);
 311}
 312
 313#endif /* _LINUX_PM_DOMAIN_H */
 314