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