LXR linux/include/linux/pm

   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
  72enum gpd_status {
  73        GENPD_STATE_ON = 0,     /* PM domain is on */
  74        GENPD_STATE_OFF,        /* PM domain is off */
  75};
  76
  77enum genpd_notication {
  78        GENPD_NOTIFY_PRE_OFF = 0,
  79        GENPD_NOTIFY_OFF,
  80        GENPD_NOTIFY_PRE_ON,
  81        GENPD_NOTIFY_ON,
  82};
  83
  84struct dev_power_governor {
  85        bool (*power_down_ok)(struct dev_pm_domain *domain);
  86        bool (*suspend_ok)(struct device *dev);
  87};
  88
  89struct gpd_dev_ops {
  90        int (*start)(struct device *dev);
  91        int (*stop)(struct device *dev);
  92};
  93
  94struct 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
 105struct genpd_lock_ops;
 106struct dev_pm_opp;
 107struct opp_table;
 108
 109struct 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
 165static 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
 170struct 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
 181struct 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
 189struct pm_domain_data {
 190        struct list_head list_node;
 191        struct device *dev;
 192};
 193
 194struct 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 default_pstate;
 202        unsigned int rpm_pstate;
 203        ktime_t next_wakeup;
 204        void *data;
 205};
 206
 207#ifdef CONFIG_PM_GENERIC_DOMAINS
 208static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 209{
 210        return container_of(pdd, struct generic_pm_domain_data, base);
 211}
 212
 213static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 214{
 215        return to_gpd_data(dev->power.subsys_data->domain_data);
 216}
 217
 218int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev);
 219int pm_genpd_remove_device(struct device *dev);
 220int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 221                           struct generic_pm_domain *subdomain);
 222int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 223                              struct generic_pm_domain *subdomain);
 224int pm_genpd_init(struct generic_pm_domain *genpd,
 225                  struct dev_power_governor *gov, bool is_off);
 226int pm_genpd_remove(struct generic_pm_domain *genpd);
 227int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state);
 228int dev_pm_genpd_add_notifier(struct device *dev, struct notifier_block *nb);
 229int dev_pm_genpd_remove_notifier(struct device *dev);
 230void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next);
 231
 232extern struct dev_power_governor simple_qos_governor;
 233extern struct dev_power_governor pm_domain_always_on_gov;
 234#ifdef CONFIG_CPU_IDLE
 235extern struct dev_power_governor pm_domain_cpu_gov;
 236#endif
 237#else
 238
 239static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 240{
 241        return ERR_PTR(-ENOSYS);
 242}
 243static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 244                                      struct device *dev)
 245{
 246        return -ENOSYS;
 247}
 248static inline int pm_genpd_remove_device(struct device *dev)
 249{
 250        return -ENOSYS;
 251}
 252static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 253                                         struct generic_pm_domain *subdomain)
 254{
 255        return -ENOSYS;
 256}
 257static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 258                                            struct generic_pm_domain *subdomain)
 259{
 260        return -ENOSYS;
 261}
 262static inline int pm_genpd_init(struct generic_pm_domain *genpd,
 263                                struct dev_power_governor *gov, bool is_off)
 264{
 265        return -ENOSYS;
 266}
 267static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
 268{
 269        return -EOPNOTSUPP;
 270}
 271
 272static inline int dev_pm_genpd_set_performance_state(struct device *dev,
 273                                                     unsigned int state)
 274{
 275        return -EOPNOTSUPP;
 276}
 277
 278static inline int dev_pm_genpd_add_notifier(struct device *dev,
 279                                            struct notifier_block *nb)
 280{
 281        return -EOPNOTSUPP;
 282}
 283
 284static inline int dev_pm_genpd_remove_notifier(struct device *dev)
 285{
 286        return -EOPNOTSUPP;
 287}
 288
 289static inline void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next)
 290{ }
 291
 292#define simple_qos_governor             (*(struct dev_power_governor *)(NULL))
 293#define pm_domain_always_on_gov         (*(struct dev_power_governor *)(NULL))
 294#endif
 295
 296#ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
 297void dev_pm_genpd_suspend(struct device *dev);
 298void dev_pm_genpd_resume(struct device *dev);
 299#else
 300static inline void dev_pm_genpd_suspend(struct device *dev) {}
 301static inline void dev_pm_genpd_resume(struct device *dev) {}
 302#endif
 303
 304/* OF PM domain providers */
 305struct of_device_id;
 306
 307typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args,
 308                                                   void *data);
 309
 310struct genpd_onecell_data {
 311        struct generic_pm_domain **domains;
 312        unsigned int num_domains;
 313        genpd_xlate_t xlate;
 314};
 315
 316#ifdef CONFIG_PM_GENERIC_DOMAINS_OF
 317int of_genpd_add_provider_simple(struct device_node *np,
 318                                 struct generic_pm_domain *genpd);
 319int of_genpd_add_provider_onecell(struct device_node *np,
 320                                  struct genpd_onecell_data *data);
 321void of_genpd_del_provider(struct device_node *np);
 322int of_genpd_add_device(struct of_phandle_args *args, struct device *dev);
 323int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
 324                           struct of_phandle_args *subdomain_spec);
 325int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
 326                              struct of_phandle_args *subdomain_spec);
 327struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
 328int of_genpd_parse_idle_states(struct device_node *dn,
 329                               struct genpd_power_state **states, int *n);
 330unsigned int pm_genpd_opp_to_performance_state(struct device *genpd_dev,
 331                                               struct dev_pm_opp *opp);
 332
 333int genpd_dev_pm_attach(struct device *dev);
 334struct device *genpd_dev_pm_attach_by_id(struct device *dev,
 335                                         unsigned int index);
 336struct device *genpd_dev_pm_attach_by_name(struct device *dev,
 337                                           const char *name);
 338#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
 339static inline int of_genpd_add_provider_simple(struct device_node *np,
 340                                        struct generic_pm_domain *genpd)
 341{
 342        return -EOPNOTSUPP;
 343}
 344
 345static inline int of_genpd_add_provider_onecell(struct device_node *np,
 346                                        struct genpd_onecell_data *data)
 347{
 348        return -EOPNOTSUPP;
 349}
 350
 351static inline void of_genpd_del_provider(struct device_node *np) {}
 352
 353static inline int of_genpd_add_device(struct of_phandle_args *args,
 354                                      struct device *dev)
 355{
 356        return -ENODEV;
 357}
 358
 359static inline int of_genpd_add_subdomain(struct of_phandle_args *parent_spec,
 360                                         struct of_phandle_args *subdomain_spec)
 361{
 362        return -ENODEV;
 363}
 364
 365static inline int of_genpd_remove_subdomain(struct of_phandle_args *parent_spec,
 366                                        struct of_phandle_args *subdomain_spec)
 367{
 368        return -ENODEV;
 369}
 370
 371static inline int of_genpd_parse_idle_states(struct device_node *dn,
 372                        struct genpd_power_state **states, int *n)
 373{
 374        return -ENODEV;
 375}
 376
 377static inline unsigned int
 378pm_genpd_opp_to_performance_state(struct device *genpd_dev,
 379                                  struct dev_pm_opp *opp)
 380{
 381        return 0;
 382}
 383
 384static inline int genpd_dev_pm_attach(struct device *dev)
 385{
 386        return 0;
 387}
 388
 389static inline struct device *genpd_dev_pm_attach_by_id(struct device *dev,
 390                                                       unsigned int index)
 391{
 392        return NULL;
 393}
 394
 395static inline struct device *genpd_dev_pm_attach_by_name(struct device *dev,
 396                                                         const char *name)
 397{
 398        return NULL;
 399}
 400
 401static inline
 402struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
 403{
 404        return ERR_PTR(-EOPNOTSUPP);
 405}
 406#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
 407
 408#ifdef CONFIG_PM
 409int dev_pm_domain_attach(struct device *dev, bool power_on);
 410struct device *dev_pm_domain_attach_by_id(struct device *dev,
 411                                          unsigned int index);
 412struct device *dev_pm_domain_attach_by_name(struct device *dev,
 413                                            const char *name);
 414void dev_pm_domain_detach(struct device *dev, bool power_off);
 415int dev_pm_domain_start(struct device *dev);
 416void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
 417#else
 418static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
 419{
 420        return 0;
 421}
 422static inline struct device *dev_pm_domain_attach_by_id(struct device *dev,
 423                                                        unsigned int index)
 424{
 425        return NULL;
 426}
 427static inline struct device *dev_pm_domain_attach_by_name(struct device *dev,
 428                                                          const char *name)
 429{
 430        return NULL;
 431}
 432static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
 433static inline int dev_pm_domain_start(struct device *dev)
 434{
 435        return 0;
 436}
 437static inline void dev_pm_domain_set(struct device *dev,
 438                                     struct dev_pm_domain *pd) {}
 439#endif
 440
 441#endif /* _LINUX_PM_DOMAIN_H */
 442