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/err.h>
  14
  15 enum gpd_status {
  16         GPD_STATE_ACTIVE = 0,   /* PM domain is active */
  17         GPD_STATE_WAIT_MASTER,  /* PM domain's master is being waited for */
  18         GPD_STATE_BUSY,         /* Something is happening to the PM domain */
  19         GPD_STATE_REPEAT,       /* Power off in progress, to be repeated */
  20         GPD_STATE_POWER_OFF,    /* PM domain is off */
  21 };
  22
  23 struct dev_power_governor {
  24         bool (*power_down_ok)(struct dev_pm_domain *domain);
  25         bool (*stop_ok)(struct device *dev);
  26 };
  27
  28 struct gpd_dev_ops {
  29         int (*start)(struct device *dev);
  30         int (*stop)(struct device *dev);
  31         int (*save_state)(struct device *dev);
  32         int (*restore_state)(struct device *dev);
  33         int (*suspend)(struct device *dev);
  34         int (*suspend_late)(struct device *dev);
  35         int (*resume_early)(struct device *dev);
  36         int (*resume)(struct device *dev);
  37         int (*freeze)(struct device *dev);
  38         int (*freeze_late)(struct device *dev);
  39         int (*thaw_early)(struct device *dev);
  40         int (*thaw)(struct device *dev);
  41         bool (*active_wakeup)(struct device *dev);
  42 };
  43
  44 struct generic_pm_domain {
  45         struct dev_pm_domain domain;    /* PM domain operations */
  46         struct list_head gpd_list_node; /* Node in the global PM domains list */
  47         struct list_head master_links;  /* Links with PM domain as a master */
  48         struct list_head slave_links;   /* Links with PM domain as a slave */
  49         struct list_head dev_list;      /* List of devices */
  50         struct mutex lock;
  51         struct dev_power_governor *gov;
  52         struct work_struct power_off_work;
  53         char *name;
  54         unsigned int in_progress;       /* Number of devices being suspended now */
  55         atomic_t sd_count;      /* Number of subdomains with power "on" */
  56         enum gpd_status status; /* Current state of the domain */
  57         wait_queue_head_t status_wait_queue;
  58         struct task_struct *poweroff_task;      /* Powering off task */
  59         unsigned int resume_count;      /* Number of devices being resumed */
  60         unsigned int device_count;      /* Number of devices */
  61         unsigned int suspended_count;   /* System suspend device counter */
  62         unsigned int prepared_count;    /* Suspend counter of prepared devices */
  63         bool suspend_power_off; /* Power status before system suspend */
  64         bool dev_irq_safe;      /* Device callbacks are IRQ-safe */
  65         int (*power_off)(struct generic_pm_domain *domain);
  66         s64 power_off_latency_ns;
  67         int (*power_on)(struct generic_pm_domain *domain);
  68         s64 power_on_latency_ns;
  69         struct gpd_dev_ops dev_ops;
  70         s64 break_even_ns;      /* Power break even for the entire domain. */
  71         s64 max_off_time_ns;    /* Maximum allowed "suspended" time. */
  72         ktime_t power_off_time;
  73 };
  74
  75 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
  76 {
  77         return container_of(pd, struct generic_pm_domain, domain);
  78 }
  79
  80 struct gpd_link {
  81         struct generic_pm_domain *master;
  82         struct list_head master_node;
  83         struct generic_pm_domain *slave;
  84         struct list_head slave_node;
  85 };
  86
  87 struct gpd_timing_data {
  88         s64 stop_latency_ns;
  89         s64 start_latency_ns;
  90         s64 save_state_latency_ns;
  91         s64 restore_state_latency_ns;
  92         s64 break_even_ns;
  93 };
  94
  95 struct generic_pm_domain_data {
  96         struct pm_domain_data base;
  97         struct gpd_dev_ops ops;
  98         struct gpd_timing_data td;
  99         bool need_restore;
 100 };
 101
 102 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 103 {
 104         return container_of(pdd, struct generic_pm_domain_data, base);
 105 }
 106
 107 #ifdef CONFIG_PM_GENERIC_DOMAINS
 108 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 109 {
 110         return to_gpd_data(dev->power.subsys_data->domain_data);
 111 }
 112
 113 extern struct dev_power_governor simple_qos_governor;
 114
 115 extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
 116 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 117                                  struct device *dev,
 118                                  struct gpd_timing_data *td);
 119
 120 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 121                                       struct device *dev)
 122 {
 123         return __pm_genpd_add_device(genpd, dev, NULL);
 124 }
 125
 126 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 127                                   struct device *dev);
 128 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 129                                   struct generic_pm_domain *new_subdomain);
 130 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 131                                      struct generic_pm_domain *target);
 132 extern int pm_genpd_add_callbacks(struct device *dev,
 133                                   struct gpd_dev_ops *ops,
 134                                   struct gpd_timing_data *td);
 135 extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
 136 extern void pm_genpd_init(struct generic_pm_domain *genpd,
 137                           struct dev_power_governor *gov, bool is_off);
 138
 139 extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
 140
 141 extern bool default_stop_ok(struct device *dev);
 142
 143 extern struct dev_power_governor pm_domain_always_on_gov;
 144 #else
 145
 146 static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
 147 {
 148         return ERR_PTR(-ENOSYS);
 149 }
 150 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 151                                         struct device *dev,
 152                                         struct gpd_timing_data *td)
 153 {
 154         return -ENOSYS;
 155 }
 156 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 157                                       struct device *dev)
 158 {
 159         return -ENOSYS;
 160 }
 161 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 162                                          struct device *dev)
 163 {
 164         return -ENOSYS;
 165 }
 166 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 167                                          struct generic_pm_domain *new_sd)
 168 {
 169         return -ENOSYS;
 170 }
 171 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 172                                             struct generic_pm_domain *target)
 173 {
 174         return -ENOSYS;
 175 }
 176 static inline int pm_genpd_add_callbacks(struct device *dev,
 177                                          struct gpd_dev_ops *ops,
 178                                          struct gpd_timing_data *td)
 179 {
 180         return -ENOSYS;
 181 }
 182 static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
 183 {
 184         return -ENOSYS;
 185 }
 186 static inline void pm_genpd_init(struct generic_pm_domain *genpd, bool is_off)
 187 {
 188 }
 189 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
 190 {
 191         return -ENOSYS;
 192 }
 193 static inline bool default_stop_ok(struct device *dev)
 194 {
 195         return false;
 196 }
 197 #define pm_domain_always_on_gov NULL
 198 #endif
 199
 200 static inline int pm_genpd_remove_callbacks(struct device *dev)
 201 {
 202         return __pm_genpd_remove_callbacks(dev, true);
 203 }
 204
 205 #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
 206 extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
 207 extern void pm_genpd_poweroff_unused(void);
 208 #else
 209 static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
 210 static inline void pm_genpd_poweroff_unused(void) {}
 211 #endif
 212
 213 #endif /* _LINUX_PM_DOMAIN_H */