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         bool always_on;
 101 };
 102
 103 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 104 {
 105         return container_of(pdd, struct generic_pm_domain_data, base);
 106 }
 107
 108 #ifdef CONFIG_PM_GENERIC_DOMAINS
 109 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 110 {
 111         return to_gpd_data(dev->power.subsys_data->domain_data);
 112 }
 113
 114 extern struct dev_power_governor simple_qos_governor;
 115
 116 extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
 117 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 118                                  struct device *dev,
 119                                  struct gpd_timing_data *td);
 120
 121 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 122                                       struct device *dev)
 123 {
 124         return __pm_genpd_add_device(genpd, dev, NULL);
 125 }
 126
 127 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 128                                   struct device *dev);
 129 extern void pm_genpd_dev_always_on(struct device *dev, bool val);
 130 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 131                                   struct generic_pm_domain *new_subdomain);
 132 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 133                                      struct generic_pm_domain *target);
 134 extern int pm_genpd_add_callbacks(struct device *dev,
 135                                   struct gpd_dev_ops *ops,
 136                                   struct gpd_timing_data *td);
 137 extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
 138 extern void pm_genpd_init(struct generic_pm_domain *genpd,
 139                           struct dev_power_governor *gov, bool is_off);
 140
 141 extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
 142
 143 extern bool default_stop_ok(struct device *dev);
 144
 145 extern struct dev_power_governor pm_domain_always_on_gov;
 146 #else
 147
 148 static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
 149 {
 150         return ERR_PTR(-ENOSYS);
 151 }
 152 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 153                                         struct device *dev,
 154                                         struct gpd_timing_data *td)
 155 {
 156         return -ENOSYS;
 157 }
 158 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 159                                       struct device *dev)
 160 {
 161         return -ENOSYS;
 162 }
 163 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 164                                          struct device *dev)
 165 {
 166         return -ENOSYS;
 167 }
 168 static inline void pm_genpd_dev_always_on(struct device *dev, bool val) {}
 169 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 170                                          struct generic_pm_domain *new_sd)
 171 {
 172         return -ENOSYS;
 173 }
 174 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 175                                             struct generic_pm_domain *target)
 176 {
 177         return -ENOSYS;
 178 }
 179 static inline int pm_genpd_add_callbacks(struct device *dev,
 180                                          struct gpd_dev_ops *ops,
 181                                          struct gpd_timing_data *td)
 182 {
 183         return -ENOSYS;
 184 }
 185 static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
 186 {
 187         return -ENOSYS;
 188 }
 189 static inline void pm_genpd_init(struct generic_pm_domain *genpd, bool is_off)
 190 {
 191 }
 192 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
 193 {
 194         return -ENOSYS;
 195 }
 196 static inline bool default_stop_ok(struct device *dev)
 197 {
 198         return false;
 199 }
 200 #define pm_domain_always_on_gov NULL
 201 #endif
 202
 203 static inline int pm_genpd_remove_callbacks(struct device *dev)
 204 {
 205         return __pm_genpd_remove_callbacks(dev, true);
 206 }
 207
 208 #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
 209 extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
 210 extern void pm_genpd_poweroff_unused(void);
 211 #else
 212 static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
 213 static inline void pm_genpd_poweroff_unused(void) {}
 214 #endif
 215
 216 #endif /* _LINUX_PM_DOMAIN_H */