include/linux/pm_domain.h

   1 /* SPDX-License-Identifier: GPL-2.0-only */
   2 /*
   3  * pm_domain.h - Definitions and headers related to device power domains.
   4  *
   5  * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp.
   6  */
   7
   8 #ifndef _LINUX_PM_DOMAIN_H
   9 #define _LINUX_PM_DOMAIN_H
  10
  11 #include <linux/device.h>
  12 #include <linux/ktime.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/spinlock.h>
  19 #include <linux/cpumask.h>
  20
  21 /*
  22  * Flags to control the behaviour of a genpd.
  23  *
  24  * These flags may be set in the struct generic_pm_domain's flags field by a
  25  * genpd backend driver. The flags must be set before it calls pm_genpd_init(),
  26  * which initializes a genpd.
  27  *
  28  * GENPD_FLAG_PM_CLK:           Instructs genpd to use the PM clk framework,
  29  *                              while powering on/off attached devices.
  30  *
  31  * GENPD_FLAG_IRQ_SAFE:         This informs genpd that its backend callbacks,
  32  *                              ->power_on|off(), doesn't sleep. Hence, these
  33  *                              can be invoked from within atomic context, which
  34  *                              enables genpd to power on/off the PM domain,
  35  *                              even when pm_runtime_is_irq_safe() returns true,
  36  *                              for any of its attached devices. Note that, a
  37  *                              genpd having this flag set, requires its
  38  *                              masterdomains to also have it set.
  39  *
  40  * GENPD_FLAG_ALWAYS_ON:        Instructs genpd to always keep the PM domain
  41  *                              powered on.
  42  *
  43  * GENPD_FLAG_ACTIVE_WAKEUP:    Instructs genpd to keep the PM domain powered
  44  *                              on, in case any of its attached devices is used
  45  *                              in the wakeup path to serve system wakeups.
  46  *
  47  * GENPD_FLAG_CPU_DOMAIN:       Instructs genpd that it should expect to get
  48  *                              devices attached, which may belong to CPUs or
  49  *                              possibly have subdomains with CPUs attached.
  50  *                              This flag enables the genpd backend driver to
  51  *                              deploy idle power management support for CPUs
  52  *                              and groups of CPUs. Note that, the backend
  53  *                              driver must then comply with the so called,
  54  *                              last-man-standing algorithm, for the CPUs in the
  55  *                              PM domain.
  56  *
  57  * GENPD_FLAG_RPM_ALWAYS_ON:    Instructs genpd to always keep the PM domain
  58  *                              powered on except for system suspend.
  59  *
  60  * GENPD_FLAG_MIN_RESIDENCY:    Enable the genpd governor to consider its
  61  *                              components' next wakeup when determining the
  62  *                              optimal idle state.
  63  */
  64 #define GENPD_FLAG_PM_CLK        (1U << 0)
  65 #define GENPD_FLAG_IRQ_SAFE      (1U << 1)
  66 #define GENPD_FLAG_ALWAYS_ON     (1U << 2)
  67 #define GENPD_FLAG_ACTIVE_WAKEUP (1U << 3)
  68 #define GENPD_FLAG_CPU_DOMAIN    (1U << 4)
  69 #define GENPD_FLAG_RPM_ALWAYS_ON (1U << 5)
  70 #define GENPD_FLAG_MIN_RESIDENCY (1U << 6)
  71
  72 enum gpd_status {
  73         GENPD_STATE_ON = 0,     /* PM domain is on */
  74         GENPD_STATE_OFF,        /* PM domain is off */
  75 };
  76
  77 enum genpd_notication {
  78         GENPD_NOTIFY_PRE_OFF = 0,
  79         GENPD_NOTIFY_OFF,
  80         GENPD_NOTIFY_PRE_ON,
  81         GENPD_NOTIFY_ON,
  82 };
  83
  84 struct dev_power_governor {
  85         bool (*power_down_ok)(struct dev_pm_domain *domain);
  86         bool (*suspend_ok)(struct device *dev);
  87 };
  88
  89 struct gpd_dev_ops {
  90         int (*start)(struct device *dev);
  91         int (*stop)(struct device *dev);
  92 };
  93
  94 struct genpd_power_state {
  95         s64 power_off_latency_ns;
  96         s64 power_on_latency_ns;
  97         s64 residency_ns;
  98         u64 usage;
  99         u64 rejected;
 100         struct fwnode_handle *fwnode;
 101         ktime_t idle_time;
 102         void *data;
 103 };
 104
 105 struct genpd_lock_ops;
 106 struct dev_pm_opp;
 107 struct opp_table;
 108
 109 struct generic_pm_domain {
 110         struct device dev;
 111         struct dev_pm_domain domain;    /* PM domain operations */
 112         struct list_head gpd_list_node; /* Node in the global PM domains list */
 113         struct list_head parent_links;  /* Links with PM domain as a parent */
 114         struct list_head child_links;   /* Links with PM domain as a child */
 115         struct list_head dev_list;      /* List of devices */
 116         struct dev_power_governor *gov;
 117         struct work_struct power_off_work;
 118         struct fwnode_handle *provider; /* Identity of the domain provider */
 119         bool has_provider;
 120         const char *name;
 121         atomic_t sd_count;      /* Number of subdomains with power "on" */
 122         enum gpd_status status; /* Current state of the domain */
 123         unsigned int device_count;      /* Number of devices */
 124         unsigned int suspended_count;   /* System suspend device counter */
 125         unsigned int prepared_count;    /* Suspend counter of prepared devices */
 126         unsigned int performance_state; /* Aggregated max performance state */
 127         cpumask_var_t cpus;             /* A cpumask of the attached CPUs */
 128         int (*power_off)(struct generic_pm_domain *domain);
 129         int (*power_on)(struct generic_pm_domain *domain);
 130         struct raw_notifier_head power_notifiers; /* Power on/off notifiers */
 131         struct opp_table *opp_table;    /* OPP table of the genpd */
 132         unsigned int (*opp_to_performance_state)(struct generic_pm_domain *genpd,
 133                                                  struct dev_pm_opp *opp);
 134         int (*set_performance_state)(struct generic_pm_domain *genpd,
 135                                      unsigned int state);
 136         struct gpd_dev_ops dev_ops;
 137         s64 max_off_time_ns;    /* Maximum allowed "suspended" time. */
 138         ktime_t next_wakeup;    /* Maintained by the domain governor */
 139         bool max_off_time_changed;
 140         bool cached_power_down_ok;
 141         bool cached_power_down_state_idx;
 142         int (*attach_dev)(struct generic_pm_domain *domain,
 143                           struct device *dev);
 144         void (*detach_dev)(struct generic_pm_domain *domain,
 145                            struct device *dev);
 146         unsigned int flags;             /* Bit field of configs for genpd */
 147         struct genpd_power_state *states;
 148         void (*free_states)(struct genpd_power_state *states,
 149                             unsigned int state_count);
 150         unsigned int state_count; /* number of states */
 151         unsigned int state_idx; /* state that genpd will go to when off */
 152         ktime_t on_time;
 153         ktime_t accounting_time;
 154         const struct genpd_lock_ops *lock_ops;
 155         union {
 156                 struct mutex mlock;
 157                 struct {
 158                         spinlock_t slock;
 159                         unsigned long lock_flags;
 160                 };
 161         };
 162
 163 };
 164
 165 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
 166 {
 167         return container_of(pd, struct generic_pm_domain, domain);
 168 }
 169
 170 struct gpd_link {
 171         struct generic_pm_domain *parent;
 172         struct list_head parent_node;
 173         struct generic_pm_domain *child;
 174         struct list_head child_node;
 175
 176         /* Sub-domain's per-master domain performance state */
 177         unsigned int performance_state;
 178         unsigned int prev_performance_state;
 179 };
 180
 181 struct gpd_timing_data {
 182         s64 suspend_latency_ns;
 183         s64 resume_latency_ns;
 184         s64 effective_constraint_ns;
 185         bool constraint_changed;
 186         bool cached_suspend_ok;
 187 };
 188
 189 struct pm_domain_data {
 190         struct list_head list_node;
 191         struct device *dev;
 192 };
 193
 194 struct generic_pm_domain_data {
 195         struct pm_domain_data base;
 196         struct gpd_timing_data td;
 197         struct notifier_block nb;
 198         struct notifier_block *power_nb;
 199         int cpu;
 200         unsigned int performance_state;
 201         unsigned int rpm_pstate;
 202         ktime_t next_wakeup;
 203         void *data;
 204 };
 205
 206 #ifdef CONFIG_PM_GENERIC_DOMAINS
 207 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 208 {
 209         return container_of(pdd, struct generic_pm_domain_data, base);
 210 }
 211
 212 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 213 {
 214         return to_gpd_data(dev->power.subsys_data->domain_data);
 215 }
 216
 217 int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev);
 218 int pm_genpd_remove_device(struct device *dev);
 219 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 220                            struct generic_pm_domain *subdomain);
 221 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 222                               struct generic_pm_domain *subdomain);
 223 int pm_genpd_init(struct generic_pm_domain *genpd,
 224                   struct dev_power_governor *gov, bool is_off);
 225 int pm_genpd_remove(struct generic_pm_domain *genpd);
 226 int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state);
 227 int dev_pm_genpd_add_notifier(struct device *dev, struct notifier_block *nb);
 228 int dev_pm_genpd_remove_notifier(struct device *dev);
 229 void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next);
 230
 231 extern struct dev_power_governor simple_qos_governor;
 232 extern struct dev_power_governor pm_domain_always_on_gov;
 233 #ifdef CONFIG_CPU_IDLE
 234 extern struct dev_power_governor pm_domain_cpu_gov;
 235 #endif
 236 #else
 237
 238 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 239 {
 240         return ERR_PTR(-ENOSYS);
 241 }
 242 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 243                                       struct device *dev)
 244 {
 245         return -ENOSYS;
 246 }
 247 static inline int pm_genpd_remove_device(struct device *dev)
 248 {
 249         return -ENOSYS;
 250 }
 251 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 252                                          struct generic_pm_domain *subdomain)
 253 {
 254         return -ENOSYS;
 255 }
 256 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 257                                             struct generic_pm_domain *subdomain)
 258 {
 259         return -ENOSYS;
 260 }
 261 static inline int pm_genpd_init(struct generic_pm_domain *genpd,
 262                                 struct dev_power_governor *gov, bool is_off)
 263 {
 264         return -ENOSYS;
 265 }
 266 static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
 267 {
 268         return -EOPNOTSUPP;
 269 }
 270
 271 static inline int dev_pm_genpd_set_performance_state(struct device *dev,
 272                                                      unsigned int state)
 273 {
 274         return -EOPNOTSUPP;
 275 }
 276
 277 static inline int dev_pm_genpd_add_notifier(struct device *dev,
 278                                             struct notifier_block *nb)
 279 {
 280         return -EOPNOTSUPP;
 281 }
 282
 283 static inline int dev_pm_genpd_remove_notifier(struct device *dev)
 284 {
 285         return -EOPNOTSUPP;
 286 }
 287
 288 static inline void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next)
 289 { }
 290
 291 #define simple_qos_governor             (*(struct dev_power_governor *)(NULL))
 292 #define pm_domain_always_on_gov         (*(struct dev_power_governor *)(NULL))
 293 #endif
 294
 295 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
 296 void dev_pm_genpd_suspend(struct device *dev);
 297 void dev_pm_genpd_resume(struct device *dev);
 298 #else
 299 static inline void dev_pm_genpd_suspend(struct device *dev) {}
 300 static inline void dev_pm_genpd_resume(struct device *dev) {}
 301 #endif
 302
 303 /* OF PM domain providers */
 304 struct of_device_id;
 305
 306 typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
 307                                                    void *data);
 308
 309 struct genpd_onecell_data {
 310         struct generic_pm_domain **domains;
 311         unsigned int num_domains;
 312         genpd_xlate_t xlate;
 313 };
 314
 315 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
 316 int of_genpd_add_provider_simple(struct device_node *np,
 317                                  struct generic_pm_domain *genpd);
 318 int of_genpd_add_provider_onecell(struct device_node *np,
 319                                   struct genpd_onecell_data *data);
 320 void of_genpd_del_provider(struct device_node *np);
 321 int of_genpd_add_device(struct of_phandle_args *args, struct device *dev);
 322 int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
 323                            struct of_phandle_args *subdomain_spec);
 324 int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
 325                               struct of_phandle_args *subdomain_spec);
 326 struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
 327 int of_genpd_parse_idle_states(struct device_node *dn,
 328                                struct genpd_power_state **states, int *n);
 329 unsigned int pm_genpd_opp_to_performance_state(struct device *genpd_dev,
 330                                                struct dev_pm_opp *opp);
 331
 332 int genpd_dev_pm_attach(struct device *dev);
 333 struct device *genpd_dev_pm_attach_by_id(struct device *dev,
 334                                          unsigned int index);
 335 struct device *genpd_dev_pm_attach_by_name(struct device *dev,
 336                                            const char *name);
 337 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
 338 static inline int of_genpd_add_provider_simple(struct device_node *np,
 339                                         struct generic_pm_domain *genpd)
 340 {
 341         return -EOPNOTSUPP;
 342 }
 343
 344 static inline int of_genpd_add_provider_onecell(struct device_node *np,
 345                                         struct genpd_onecell_data *data)
 346 {
 347         return -EOPNOTSUPP;
 348 }
 349
 350 static inline void of_genpd_del_provider(struct device_node *np) {}
 351
 352 static inline int of_genpd_add_device(struct of_phandle_args *args,
 353                                       struct device *dev)
 354 {
 355         return -ENODEV;
 356 }
 357
 358 static inline int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
 359                                          struct of_phandle_args *subdomain_spec)
 360 {
 361         return -ENODEV;
 362 }
 363
 364 static inline int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
 365                                         struct of_phandle_args *subdomain_spec)
 366 {
 367         return -ENODEV;
 368 }
 369
 370 static inline int of_genpd_parse_idle_states(struct device_node *dn,
 371                         struct genpd_power_state **states, int *n)
 372 {
 373         return -ENODEV;
 374 }
 375
 376 static inline unsigned int
 377 pm_genpd_opp_to_performance_state(struct device *genpd_dev,
 378                                   struct dev_pm_opp *opp)
 379 {
 380         return 0;
 381 }
 382
 383 static inline int genpd_dev_pm_attach(struct device *dev)
 384 {
 385         return 0;
 386 }
 387
 388 static inline struct device *genpd_dev_pm_attach_by_id(struct device *dev,
 389                                                        unsigned int index)
 390 {
 391         return NULL;
 392 }
 393
 394 static inline struct device *genpd_dev_pm_attach_by_name(struct device *dev,
 395                                                          const char *name)
 396 {
 397         return NULL;
 398 }
 399
 400 static inline
 401 struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
 402 {
 403         return ERR_PTR(-EOPNOTSUPP);
 404 }
 405 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
 406
 407 #ifdef CONFIG_PM
 408 int dev_pm_domain_attach(struct device *dev, bool power_on);
 409 struct device *dev_pm_domain_attach_by_id(struct device *dev,
 410                                           unsigned int index);
 411 struct device *dev_pm_domain_attach_by_name(struct device *dev,
 412                                             const char *name);
 413 void dev_pm_domain_detach(struct device *dev, bool power_off);
 414 int dev_pm_domain_start(struct device *dev);
 415 void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
 416 #else
 417 static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
 418 {
 419         return 0;
 420 }
 421 static inline struct device *dev_pm_domain_attach_by_id(struct device *dev,
 422                                                         unsigned int index)
 423 {
 424         return NULL;
 425 }
 426 static inline struct device *dev_pm_domain_attach_by_name(struct device *dev,
 427                                                           const char *name)
 428 {
 429         return NULL;
 430 }
 431 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
 432 static inline int dev_pm_domain_start(struct device *dev)
 433 {
 434         return 0;
 435 }
 436 static inline void dev_pm_domain_set(struct device *dev,
 437                                      struct dev_pm_domain *pd) {}
 438 #endif
 439
 440 #endif /* _LINUX_PM_DOMAIN_H */