Pileus Git - ~andy/linux/blob - 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         unsigned int in_progress;       /* Number of devices being suspended now */
  54         atomic_t sd_count;      /* Number of subdomains with power "on" */
  55         enum gpd_status status; /* Current state of the domain */
  56         wait_queue_head_t status_wait_queue;
  57         struct task_struct *poweroff_task;      /* Powering off task */
  58         unsigned int resume_count;      /* Number of devices being resumed */
  59         unsigned int device_count;      /* Number of devices */
  60         unsigned int suspended_count;   /* System suspend device counter */
  61         unsigned int prepared_count;    /* Suspend counter of prepared devices */
  62         bool suspend_power_off; /* Power status before system suspend */
  63         bool dev_irq_safe;      /* Device callbacks are IRQ-safe */
  64         int (*power_off)(struct generic_pm_domain *domain);
  65         s64 power_off_latency_ns;
  66         int (*power_on)(struct generic_pm_domain *domain);
  67         s64 power_on_latency_ns;
  68         struct gpd_dev_ops dev_ops;
  69         s64 break_even_ns;      /* Power break even for the entire domain. */
  70         s64 max_off_time_ns;    /* Maximum allowed "suspended" time. */
  71         ktime_t power_off_time;
  72 };
  73
  74 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
  75 {
  76         return container_of(pd, struct generic_pm_domain, domain);
  77 }
  78
  79 struct gpd_link {
  80         struct generic_pm_domain *master;
  81         struct list_head master_node;
  82         struct generic_pm_domain *slave;
  83         struct list_head slave_node;
  84 };
  85
  86 struct gpd_timing_data {
  87         s64 stop_latency_ns;
  88         s64 start_latency_ns;
  89         s64 save_state_latency_ns;
  90         s64 restore_state_latency_ns;
  91         s64 break_even_ns;
  92 };
  93
  94 struct generic_pm_domain_data {
  95         struct pm_domain_data base;
  96         struct gpd_dev_ops ops;
  97         struct gpd_timing_data td;
  98         bool need_restore;
  99 };
 100
 101 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 102 {
 103         return container_of(pdd, struct generic_pm_domain_data, base);
 104 }
 105
 106 #ifdef CONFIG_PM_GENERIC_DOMAINS
 107 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 108 {
 109         return to_gpd_data(dev->power.subsys_data->domain_data);
 110 }
 111
 112 extern struct dev_power_governor simple_qos_governor;
 113
 114 extern struct generic_pm_domain *dev_to_genpd(struct device *dev);
 115 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 116                                  struct device *dev,
 117                                  struct gpd_timing_data *td);
 118
 119 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 120                                       struct device *dev)
 121 {
 122         return __pm_genpd_add_device(genpd, dev, NULL);
 123 }
 124
 125 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 126                                   struct device *dev);
 127 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 128                                   struct generic_pm_domain *new_subdomain);
 129 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 130                                      struct generic_pm_domain *target);
 131 extern int pm_genpd_add_callbacks(struct device *dev,
 132                                   struct gpd_dev_ops *ops,
 133                                   struct gpd_timing_data *td);
 134 extern int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td);
 135 extern void pm_genpd_init(struct generic_pm_domain *genpd,
 136                           struct dev_power_governor *gov, bool is_off);
 137
 138 extern int pm_genpd_poweron(struct generic_pm_domain *genpd);
 139
 140 extern bool default_stop_ok(struct device *dev);
 141
 142 #else
 143
 144 static inline struct generic_pm_domain *dev_to_genpd(struct device *dev)
 145 {
 146         return ERR_PTR(-ENOSYS);
 147 }
 148 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 149                                         struct device *dev,
 150                                         struct gpd_timing_data *td)
 151 {
 152         return -ENOSYS;
 153 }
 154 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 155                                       struct device *dev)
 156 {
 157         return -ENOSYS;
 158 }
 159 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 160                                          struct device *dev)
 161 {
 162         return -ENOSYS;
 163 }
 164 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 165                                          struct generic_pm_domain *new_sd)
 166 {
 167         return -ENOSYS;
 168 }
 169 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 170                                             struct generic_pm_domain *target)
 171 {
 172         return -ENOSYS;
 173 }
 174 static inline int pm_genpd_add_callbacks(struct device *dev,
 175                                          struct gpd_dev_ops *ops,
 176                                          struct gpd_timing_data *td)
 177 {
 178         return -ENOSYS;
 179 }
 180 static inline int __pm_genpd_remove_callbacks(struct device *dev, bool clear_td)
 181 {
 182         return -ENOSYS;
 183 }
 184 static inline void pm_genpd_init(struct generic_pm_domain *genpd, bool is_off)
 185 {
 186 }
 187 static inline int pm_genpd_poweron(struct generic_pm_domain *genpd)
 188 {
 189         return -ENOSYS;
 190 }
 191 static inline bool default_stop_ok(struct device *dev)
 192 {
 193         return false;
 194 }
 195 #endif
 196
 197 static inline int pm_genpd_remove_callbacks(struct device *dev)
 198 {
 199         return __pm_genpd_remove_callbacks(dev, true);
 200 }
 201
 202 #ifdef CONFIG_PM_GENERIC_DOMAINS_RUNTIME
 203 extern void genpd_queue_power_off_work(struct generic_pm_domain *genpd);
 204 extern void pm_genpd_poweroff_unused(void);
 205 #else
 206 static inline void genpd_queue_power_off_work(struct generic_pm_domain *gpd) {}
 207 static inline void pm_genpd_poweroff_unused(void) {}
 208 #endif
 209
 210 #endif /* _LINUX_PM_DOMAIN_H */