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/mutex.h>
  14 #include <linux/pm.h>
  15 #include <linux/err.h>
  16 #include <linux/of.h>
  17 #include <linux/notifier.h>
  18 #include <linux/cpuidle.h>
  19
  20 /* Defines used for the flags field in the struct generic_pm_domain */
  21 #define GENPD_FLAG_PM_CLK       (1U << 0) /* PM domain uses PM clk */
  22
  23 enum gpd_status {
  24         GPD_STATE_ACTIVE = 0,   /* PM domain is active */
  25         GPD_STATE_POWER_OFF,    /* PM domain is off */
  26 };
  27
  28 struct dev_power_governor {
  29         bool (*power_down_ok)(struct dev_pm_domain *domain);
  30         bool (*stop_ok)(struct device *dev);
  31 };
  32
  33 struct gpd_dev_ops {
  34         int (*start)(struct device *dev);
  35         int (*stop)(struct device *dev);
  36         int (*save_state)(struct device *dev);
  37         int (*restore_state)(struct device *dev);
  38         bool (*active_wakeup)(struct device *dev);
  39 };
  40
  41 struct gpd_cpuidle_data {
  42         unsigned int saved_exit_latency;
  43         struct cpuidle_state *idle_state;
  44 };
  45
  46 struct generic_pm_domain {
  47         struct dev_pm_domain domain;    /* PM domain operations */
  48         struct list_head gpd_list_node; /* Node in the global PM domains list */
  49         struct list_head master_links;  /* Links with PM domain as a master */
  50         struct list_head slave_links;   /* Links with PM domain as a slave */
  51         struct list_head dev_list;      /* List of devices */
  52         struct mutex lock;
  53         struct dev_power_governor *gov;
  54         struct work_struct power_off_work;
  55         const char *name;
  56         unsigned int in_progress;       /* Number of devices being suspended now */
  57         atomic_t sd_count;      /* Number of subdomains with power "on" */
  58         enum gpd_status status; /* Current state of the domain */
  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         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 max_off_time_ns;    /* Maximum allowed "suspended" time. */
  69         bool max_off_time_changed;
  70         bool cached_power_down_ok;
  71         struct gpd_cpuidle_data *cpuidle_data;
  72         int (*attach_dev)(struct generic_pm_domain *domain,
  73                           struct device *dev);
  74         void (*detach_dev)(struct generic_pm_domain *domain,
  75                            struct device *dev);
  76         unsigned int flags;             /* Bit field of configs for genpd */
  77 };
  78
  79 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
  80 {
  81         return container_of(pd, struct generic_pm_domain, domain);
  82 }
  83
  84 struct gpd_link {
  85         struct generic_pm_domain *master;
  86         struct list_head master_node;
  87         struct generic_pm_domain *slave;
  88         struct list_head slave_node;
  89 };
  90
  91 struct gpd_timing_data {
  92         s64 stop_latency_ns;
  93         s64 start_latency_ns;
  94         s64 save_state_latency_ns;
  95         s64 restore_state_latency_ns;
  96         s64 effective_constraint_ns;
  97         bool constraint_changed;
  98         bool cached_stop_ok;
  99 };
 100
 101 struct pm_domain_data {
 102         struct list_head list_node;
 103         struct device *dev;
 104 };
 105
 106 struct generic_pm_domain_data {
 107         struct pm_domain_data base;
 108         struct gpd_timing_data td;
 109         struct notifier_block nb;
 110 };
 111
 112 #ifdef CONFIG_PM_GENERIC_DOMAINS
 113 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 114 {
 115         return container_of(pdd, struct generic_pm_domain_data, base);
 116 }
 117
 118 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 119 {
 120         return to_gpd_data(dev->power.subsys_data->domain_data);
 121 }
 122
 123 extern struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev);
 124 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 125                                  struct device *dev,
 126                                  struct gpd_timing_data *td);
 127
 128 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 129                                   struct device *dev);
 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_attach_cpuidle(struct generic_pm_domain *genpd, int state);
 135 extern int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd);
 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 extern void pm_genpd_poweroff_unused(void);
 141
 142 extern struct dev_power_governor simple_qos_governor;
 143 extern struct dev_power_governor pm_domain_always_on_gov;
 144 #else
 145
 146 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 147 {
 148         return ERR_PTR(-ENOSYS);
 149 }
 150 static inline struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
 151 {
 152         return NULL;
 153 }
 154 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 155                                         struct device *dev,
 156                                         struct gpd_timing_data *td)
 157 {
 158         return -ENOSYS;
 159 }
 160 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 161                                          struct device *dev)
 162 {
 163         return -ENOSYS;
 164 }
 165 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 166                                          struct generic_pm_domain *new_sd)
 167 {
 168         return -ENOSYS;
 169 }
 170 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 171                                             struct generic_pm_domain *target)
 172 {
 173         return -ENOSYS;
 174 }
 175 static inline int pm_genpd_attach_cpuidle(struct generic_pm_domain *genpd, int st)
 176 {
 177         return -ENOSYS;
 178 }
 179 static inline int pm_genpd_detach_cpuidle(struct generic_pm_domain *genpd)
 180 {
 181         return -ENOSYS;
 182 }
 183 static inline void pm_genpd_init(struct generic_pm_domain *genpd,
 184                                  struct dev_power_governor *gov, 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 void pm_genpd_poweroff_unused(void) {}
 192 #endif
 193
 194 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 195                                       struct device *dev)
 196 {
 197         return __pm_genpd_add_device(genpd, dev, NULL);
 198 }
 199
 200 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
 201 extern void pm_genpd_syscore_poweroff(struct device *dev);
 202 extern void pm_genpd_syscore_poweron(struct device *dev);
 203 #else
 204 static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
 205 static inline void pm_genpd_syscore_poweron(struct device *dev) {}
 206 #endif
 207
 208 /* OF PM domain providers */
 209 struct of_device_id;
 210
 211 struct genpd_onecell_data {
 212         struct generic_pm_domain **domains;
 213         unsigned int num_domains;
 214 };
 215
 216 typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
 217                                                 void *data);
 218
 219 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
 220 int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
 221                         void *data);
 222 void of_genpd_del_provider(struct device_node *np);
 223 struct generic_pm_domain *of_genpd_get_from_provider(
 224                         struct of_phandle_args *genpdspec);
 225
 226 struct generic_pm_domain *__of_genpd_xlate_simple(
 227                                         struct of_phandle_args *genpdspec,
 228                                         void *data);
 229 struct generic_pm_domain *__of_genpd_xlate_onecell(
 230                                         struct of_phandle_args *genpdspec,
 231                                         void *data);
 232
 233 int genpd_dev_pm_attach(struct device *dev);
 234 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
 235 static inline int __of_genpd_add_provider(struct device_node *np,
 236                                         genpd_xlate_t xlate, void *data)
 237 {
 238         return 0;
 239 }
 240 static inline void of_genpd_del_provider(struct device_node *np) {}
 241
 242 static inline struct generic_pm_domain *of_genpd_get_from_provider(
 243                         struct of_phandle_args *genpdspec)
 244 {
 245         return NULL;
 246 }
 247
 248 #define __of_genpd_xlate_simple         NULL
 249 #define __of_genpd_xlate_onecell        NULL
 250
 251 static inline int genpd_dev_pm_attach(struct device *dev)
 252 {
 253         return -ENODEV;
 254 }
 255 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
 256
 257 static inline int of_genpd_add_provider_simple(struct device_node *np,
 258                                         struct generic_pm_domain *genpd)
 259 {
 260         return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
 261 }
 262 static inline int of_genpd_add_provider_onecell(struct device_node *np,
 263                                         struct genpd_onecell_data *data)
 264 {
 265         return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
 266 }
 267
 268 #ifdef CONFIG_PM
 269 extern int dev_pm_domain_attach(struct device *dev, bool power_on);
 270 extern void dev_pm_domain_detach(struct device *dev, bool power_off);
 271 #else
 272 static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
 273 {
 274         return -ENODEV;
 275 }
 276 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
 277 #endif
 278
 279 #endif /* _LINUX_PM_DOMAIN_H */