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         atomic_t sd_count;      /* Number of subdomains with power "on" */
  51         enum gpd_status status; /* Current state of the domain */
  52         unsigned int device_count;      /* Number of devices */
  53         unsigned int suspended_count;   /* System suspend device counter */
  54         unsigned int prepared_count;    /* Suspend counter of prepared devices */
  55         bool suspend_power_off; /* Power status before system suspend */
  56         int (*power_off)(struct generic_pm_domain *domain);
  57         s64 power_off_latency_ns;
  58         int (*power_on)(struct generic_pm_domain *domain);
  59         s64 power_on_latency_ns;
  60         struct gpd_dev_ops dev_ops;
  61         s64 max_off_time_ns;    /* Maximum allowed "suspended" time. */
  62         bool max_off_time_changed;
  63         bool cached_power_down_ok;
  64         int (*attach_dev)(struct generic_pm_domain *domain,
  65                           struct device *dev);
  66         void (*detach_dev)(struct generic_pm_domain *domain,
  67                            struct device *dev);
  68         unsigned int flags;             /* Bit field of configs for genpd */
  69 };
  70
  71 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
  72 {
  73         return container_of(pd, struct generic_pm_domain, domain);
  74 }
  75
  76 struct gpd_link {
  77         struct generic_pm_domain *master;
  78         struct list_head master_node;
  79         struct generic_pm_domain *slave;
  80         struct list_head slave_node;
  81 };
  82
  83 struct gpd_timing_data {
  84         s64 stop_latency_ns;
  85         s64 start_latency_ns;
  86         s64 save_state_latency_ns;
  87         s64 restore_state_latency_ns;
  88         s64 effective_constraint_ns;
  89         bool constraint_changed;
  90         bool cached_stop_ok;
  91 };
  92
  93 struct pm_domain_data {
  94         struct list_head list_node;
  95         struct device *dev;
  96 };
  97
  98 struct generic_pm_domain_data {
  99         struct pm_domain_data base;
 100         struct gpd_timing_data td;
 101         struct notifier_block nb;
 102 };
 103
 104 #ifdef CONFIG_PM_GENERIC_DOMAINS
 105 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 106 {
 107         return container_of(pdd, struct generic_pm_domain_data, base);
 108 }
 109
 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 generic_pm_domain *pm_genpd_lookup_dev(struct device *dev);
 116 extern int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 117                                  struct device *dev,
 118                                  struct gpd_timing_data *td);
 119
 120 extern int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 121                                   struct device *dev);
 122 extern int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 123                                   struct generic_pm_domain *new_subdomain);
 124 extern int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 125                                      struct generic_pm_domain *target);
 126 extern void pm_genpd_init(struct generic_pm_domain *genpd,
 127                           struct dev_power_governor *gov, bool is_off);
 128
 129 extern struct dev_power_governor simple_qos_governor;
 130 extern struct dev_power_governor pm_domain_always_on_gov;
 131 #else
 132
 133 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 134 {
 135         return ERR_PTR(-ENOSYS);
 136 }
 137 static inline struct generic_pm_domain *pm_genpd_lookup_dev(struct device *dev)
 138 {
 139         return NULL;
 140 }
 141 static inline int __pm_genpd_add_device(struct generic_pm_domain *genpd,
 142                                         struct device *dev,
 143                                         struct gpd_timing_data *td)
 144 {
 145         return -ENOSYS;
 146 }
 147 static inline int pm_genpd_remove_device(struct generic_pm_domain *genpd,
 148                                          struct device *dev)
 149 {
 150         return -ENOSYS;
 151 }
 152 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 153                                          struct generic_pm_domain *new_sd)
 154 {
 155         return -ENOSYS;
 156 }
 157 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 158                                             struct generic_pm_domain *target)
 159 {
 160         return -ENOSYS;
 161 }
 162 static inline void pm_genpd_init(struct generic_pm_domain *genpd,
 163                                  struct dev_power_governor *gov, bool is_off)
 164 {
 165 }
 166 #endif
 167
 168 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 169                                       struct device *dev)
 170 {
 171         return __pm_genpd_add_device(genpd, dev, NULL);
 172 }
 173
 174 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
 175 extern void pm_genpd_syscore_poweroff(struct device *dev);
 176 extern void pm_genpd_syscore_poweron(struct device *dev);
 177 #else
 178 static inline void pm_genpd_syscore_poweroff(struct device *dev) {}
 179 static inline void pm_genpd_syscore_poweron(struct device *dev) {}
 180 #endif
 181
 182 /* OF PM domain providers */
 183 struct of_device_id;
 184
 185 struct genpd_onecell_data {
 186         struct generic_pm_domain **domains;
 187         unsigned int num_domains;
 188 };
 189
 190 typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
 191                                                 void *data);
 192
 193 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
 194 int __of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate,
 195                         void *data);
 196 void of_genpd_del_provider(struct device_node *np);
 197 struct generic_pm_domain *of_genpd_get_from_provider(
 198                         struct of_phandle_args *genpdspec);
 199
 200 struct generic_pm_domain *__of_genpd_xlate_simple(
 201                                         struct of_phandle_args *genpdspec,
 202                                         void *data);
 203 struct generic_pm_domain *__of_genpd_xlate_onecell(
 204                                         struct of_phandle_args *genpdspec,
 205                                         void *data);
 206
 207 int genpd_dev_pm_attach(struct device *dev);
 208 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
 209 static inline int __of_genpd_add_provider(struct device_node *np,
 210                                         genpd_xlate_t xlate, void *data)
 211 {
 212         return 0;
 213 }
 214 static inline void of_genpd_del_provider(struct device_node *np) {}
 215
 216 static inline struct generic_pm_domain *of_genpd_get_from_provider(
 217                         struct of_phandle_args *genpdspec)
 218 {
 219         return NULL;
 220 }
 221
 222 #define __of_genpd_xlate_simple         NULL
 223 #define __of_genpd_xlate_onecell        NULL
 224
 225 static inline int genpd_dev_pm_attach(struct device *dev)
 226 {
 227         return -ENODEV;
 228 }
 229 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
 230
 231 static inline int of_genpd_add_provider_simple(struct device_node *np,
 232                                         struct generic_pm_domain *genpd)
 233 {
 234         return __of_genpd_add_provider(np, __of_genpd_xlate_simple, genpd);
 235 }
 236 static inline int of_genpd_add_provider_onecell(struct device_node *np,
 237                                         struct genpd_onecell_data *data)
 238 {
 239         return __of_genpd_add_provider(np, __of_genpd_xlate_onecell, data);
 240 }
 241
 242 #ifdef CONFIG_PM
 243 extern int dev_pm_domain_attach(struct device *dev, bool power_on);
 244 extern void dev_pm_domain_detach(struct device *dev, bool power_off);
 245 #else
 246 static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
 247 {
 248         return -ENODEV;
 249 }
 250 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
 251 #endif
 252
 253 #endif /* _LINUX_PM_DOMAIN_H */