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