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