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 <[email protected]>, 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_types.h>
  20 #include <linux/time64.h>
  21
  22 /*
  23  * Flags to control the behaviour when attaching a device to its PM domains.
  24  *
  25  * PD_FLAG_NO_DEV_LINK:         As the default behaviour creates a device-link
  26  *                              for every PM domain that gets attached, this
  27  *                              flag can be used to skip that.
  28  *
  29  * PD_FLAG_DEV_LINK_ON:         Add the DL_FLAG_RPM_ACTIVE to power-on the
  30  *                              supplier and its PM domain when creating the
  31  *                              device-links.
  32  *
  33  * PD_FLAG_REQUIRED_OPP:        Assign required_devs for the required OPPs. The
  34  *                              index of the required OPP must correspond to the
  35  *                              index in the array of the pd_names. If pd_names
  36  *                              isn't specified, the index just follows the
  37  *                              index for the attached PM domain.
  38  *
  39  */
  40 #define PD_FLAG_NO_DEV_LINK             BIT(0)
  41 #define PD_FLAG_DEV_LINK_ON             BIT(1)
  42 #define PD_FLAG_REQUIRED_OPP            BIT(2)
  43
  44 struct dev_pm_domain_attach_data {
  45         const char * const *pd_names;
  46         const u32 num_pd_names;
  47         const u32 pd_flags;
  48 };
  49
  50 struct dev_pm_domain_list {
  51         struct device **pd_devs;
  52         struct device_link **pd_links;
  53         u32 *opp_tokens;
  54         u32 num_pds;
  55 };
  56
  57 /*
  58  * Flags to control the behaviour of a genpd.
  59  *
  60  * These flags may be set in the struct generic_pm_domain's flags field by a
  61  * genpd backend driver. The flags must be set before it calls pm_genpd_init(),
  62  * which initializes a genpd.
  63  *
  64  * GENPD_FLAG_PM_CLK:           Instructs genpd to use the PM clk framework,
  65  *                              while powering on/off attached devices.
  66  *
  67  * GENPD_FLAG_IRQ_SAFE:         This informs genpd that its backend callbacks,
  68  *                              ->power_on|off(), doesn't sleep. Hence, these
  69  *                              can be invoked from within atomic context, which
  70  *                              enables genpd to power on/off the PM domain,
  71  *                              even when pm_runtime_is_irq_safe() returns true,
  72  *                              for any of its attached devices. Note that, a
  73  *                              genpd having this flag set, requires its
  74  *                              masterdomains to also have it set.
  75  *
  76  * GENPD_FLAG_ALWAYS_ON:        Instructs genpd to always keep the PM domain
  77  *                              powered on.
  78  *
  79  * GENPD_FLAG_ACTIVE_WAKEUP:    Instructs genpd to keep the PM domain powered
  80  *                              on, in case any of its attached devices is used
  81  *                              in the wakeup path to serve system wakeups.
  82  *
  83  * GENPD_FLAG_CPU_DOMAIN:       Instructs genpd that it should expect to get
  84  *                              devices attached, which may belong to CPUs or
  85  *                              possibly have subdomains with CPUs attached.
  86  *                              This flag enables the genpd backend driver to
  87  *                              deploy idle power management support for CPUs
  88  *                              and groups of CPUs. Note that, the backend
  89  *                              driver must then comply with the so called,
  90  *                              last-man-standing algorithm, for the CPUs in the
  91  *                              PM domain.
  92  *
  93  * GENPD_FLAG_RPM_ALWAYS_ON:    Instructs genpd to always keep the PM domain
  94  *                              powered on except for system suspend.
  95  *
  96  * GENPD_FLAG_MIN_RESIDENCY:    Enable the genpd governor to consider its
  97  *                              components' next wakeup when determining the
  98  *                              optimal idle state.
  99  *
 100  * GENPD_FLAG_OPP_TABLE_FW:     The genpd provider supports performance states,
 101  *                              but its corresponding OPP tables are not
 102  *                              described in DT, but are given directly by FW.
 103  *
 104  * GENPD_FLAG_DEV_NAME_FW:      Instructs genpd to generate an unique device name
 105  *                              using ida. It is used by genpd providers which
 106  *                              get their genpd-names directly from FW.
 107  */
 108 #define GENPD_FLAG_PM_CLK        (1U << 0)
 109 #define GENPD_FLAG_IRQ_SAFE      (1U << 1)
 110 #define GENPD_FLAG_ALWAYS_ON     (1U << 2)
 111 #define GENPD_FLAG_ACTIVE_WAKEUP (1U << 3)
 112 #define GENPD_FLAG_CPU_DOMAIN    (1U << 4)
 113 #define GENPD_FLAG_RPM_ALWAYS_ON (1U << 5)
 114 #define GENPD_FLAG_MIN_RESIDENCY (1U << 6)
 115 #define GENPD_FLAG_OPP_TABLE_FW  (1U << 7)
 116 #define GENPD_FLAG_DEV_NAME_FW   (1U << 8)
 117
 118 enum gpd_status {
 119         GENPD_STATE_ON = 0,     /* PM domain is on */
 120         GENPD_STATE_OFF,        /* PM domain is off */
 121 };
 122
 123 enum genpd_notication {
 124         GENPD_NOTIFY_PRE_OFF = 0,
 125         GENPD_NOTIFY_OFF,
 126         GENPD_NOTIFY_PRE_ON,
 127         GENPD_NOTIFY_ON,
 128 };
 129
 130 struct dev_power_governor {
 131         bool (*power_down_ok)(struct dev_pm_domain *domain);
 132         bool (*suspend_ok)(struct device *dev);
 133 };
 134
 135 struct gpd_dev_ops {
 136         int (*start)(struct device *dev);
 137         int (*stop)(struct device *dev);
 138 };
 139
 140 struct genpd_governor_data {
 141         s64 max_off_time_ns;
 142         bool max_off_time_changed;
 143         ktime_t next_wakeup;
 144         ktime_t next_hrtimer;
 145         bool cached_power_down_ok;
 146         bool cached_power_down_state_idx;
 147 };
 148
 149 struct genpd_power_state {
 150         s64 power_off_latency_ns;
 151         s64 power_on_latency_ns;
 152         s64 residency_ns;
 153         u64 usage;
 154         u64 rejected;
 155         struct fwnode_handle *fwnode;
 156         u64 idle_time;
 157         void *data;
 158 };
 159
 160 struct genpd_lock_ops;
 161 struct opp_table;
 162
 163 struct generic_pm_domain {
 164         struct device dev;
 165         struct dev_pm_domain domain;    /* PM domain operations */
 166         struct list_head gpd_list_node; /* Node in the global PM domains list */
 167         struct list_head parent_links;  /* Links with PM domain as a parent */
 168         struct list_head child_links;   /* Links with PM domain as a child */
 169         struct list_head dev_list;      /* List of devices */
 170         struct dev_power_governor *gov;
 171         struct genpd_governor_data *gd; /* Data used by a genpd governor. */
 172         struct work_struct power_off_work;
 173         struct fwnode_handle *provider; /* Identity of the domain provider */
 174         bool has_provider;
 175         const char *name;
 176         atomic_t sd_count;      /* Number of subdomains with power "on" */
 177         enum gpd_status status; /* Current state of the domain */
 178         unsigned int device_count;      /* Number of devices */
 179         unsigned int device_id;         /* unique device id */
 180         unsigned int suspended_count;   /* System suspend device counter */
 181         unsigned int prepared_count;    /* Suspend counter of prepared devices */
 182         unsigned int performance_state; /* Aggregated max performance state */
 183         cpumask_var_t cpus;             /* A cpumask of the attached CPUs */
 184         bool synced_poweroff;           /* A consumer needs a synced poweroff */
 185         int (*power_off)(struct generic_pm_domain *domain);
 186         int (*power_on)(struct generic_pm_domain *domain);
 187         struct raw_notifier_head power_notifiers; /* Power on/off notifiers */
 188         struct opp_table *opp_table;    /* OPP table of the genpd */
 189         int (*set_performance_state)(struct generic_pm_domain *genpd,
 190                                      unsigned int state);
 191         struct gpd_dev_ops dev_ops;
 192         int (*set_hwmode_dev)(struct generic_pm_domain *domain,
 193                               struct device *dev, bool enable);
 194         bool (*get_hwmode_dev)(struct generic_pm_domain *domain,
 195                               struct device *dev);
 196         int (*attach_dev)(struct generic_pm_domain *domain,
 197                           struct device *dev);
 198         void (*detach_dev)(struct generic_pm_domain *domain,
 199                            struct device *dev);
 200         unsigned int flags;             /* Bit field of configs for genpd */
 201         struct genpd_power_state *states;
 202         void (*free_states)(struct genpd_power_state *states,
 203                             unsigned int state_count);
 204         unsigned int state_count; /* number of states */
 205         unsigned int state_idx; /* state that genpd will go to when off */
 206         u64 on_time;
 207         u64 accounting_time;
 208         const struct genpd_lock_ops *lock_ops;
 209         union {
 210                 struct mutex mlock;
 211                 struct {
 212                         spinlock_t slock;
 213                         unsigned long lock_flags;
 214                 };
 215                 struct {
 216                         raw_spinlock_t raw_slock;
 217                         unsigned long raw_lock_flags;
 218                 };
 219         };
 220 };
 221
 222 static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd)
 223 {
 224         return container_of(pd, struct generic_pm_domain, domain);
 225 }
 226
 227 struct gpd_link {
 228         struct generic_pm_domain *parent;
 229         struct list_head parent_node;
 230         struct generic_pm_domain *child;
 231         struct list_head child_node;
 232
 233         /* Sub-domain's per-master domain performance state */
 234         unsigned int performance_state;
 235         unsigned int prev_performance_state;
 236 };
 237
 238 struct gpd_timing_data {
 239         s64 suspend_latency_ns;
 240         s64 resume_latency_ns;
 241         s64 effective_constraint_ns;
 242         ktime_t next_wakeup;
 243         bool constraint_changed;
 244         bool cached_suspend_ok;
 245 };
 246
 247 struct pm_domain_data {
 248         struct list_head list_node;
 249         struct device *dev;
 250 };
 251
 252 struct generic_pm_domain_data {
 253         struct pm_domain_data base;
 254         struct gpd_timing_data *td;
 255         struct notifier_block nb;
 256         struct notifier_block *power_nb;
 257         int cpu;
 258         unsigned int performance_state;
 259         unsigned int default_pstate;
 260         unsigned int rpm_pstate;
 261         unsigned int opp_token;
 262         bool hw_mode;
 263         void *data;
 264 };
 265
 266 #ifdef CONFIG_PM_GENERIC_DOMAINS
 267 static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd)
 268 {
 269         return container_of(pdd, struct generic_pm_domain_data, base);
 270 }
 271
 272 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 273 {
 274         return to_gpd_data(dev->power.subsys_data->domain_data);
 275 }
 276
 277 int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev);
 278 int pm_genpd_remove_device(struct device *dev);
 279 int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 280                            struct generic_pm_domain *subdomain);
 281 int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 282                               struct generic_pm_domain *subdomain);
 283 int pm_genpd_init(struct generic_pm_domain *genpd,
 284                   struct dev_power_governor *gov, bool is_off);
 285 int pm_genpd_remove(struct generic_pm_domain *genpd);
 286 struct device *dev_to_genpd_dev(struct device *dev);
 287 int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state);
 288 int dev_pm_genpd_add_notifier(struct device *dev, struct notifier_block *nb);
 289 int dev_pm_genpd_remove_notifier(struct device *dev);
 290 void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next);
 291 ktime_t dev_pm_genpd_get_next_hrtimer(struct device *dev);
 292 void dev_pm_genpd_synced_poweroff(struct device *dev);
 293 int dev_pm_genpd_set_hwmode(struct device *dev, bool enable);
 294 bool dev_pm_genpd_get_hwmode(struct device *dev);
 295
 296 extern struct dev_power_governor simple_qos_governor;
 297 extern struct dev_power_governor pm_domain_always_on_gov;
 298 #ifdef CONFIG_CPU_IDLE
 299 extern struct dev_power_governor pm_domain_cpu_gov;
 300 #endif
 301 #else
 302
 303 static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev)
 304 {
 305         return ERR_PTR(-ENOSYS);
 306 }
 307 static inline int pm_genpd_add_device(struct generic_pm_domain *genpd,
 308                                       struct device *dev)
 309 {
 310         return -ENOSYS;
 311 }
 312 static inline int pm_genpd_remove_device(struct device *dev)
 313 {
 314         return -ENOSYS;
 315 }
 316 static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd,
 317                                          struct generic_pm_domain *subdomain)
 318 {
 319         return -ENOSYS;
 320 }
 321 static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd,
 322                                             struct generic_pm_domain *subdomain)
 323 {
 324         return -ENOSYS;
 325 }
 326 static inline int pm_genpd_init(struct generic_pm_domain *genpd,
 327                                 struct dev_power_governor *gov, bool is_off)
 328 {
 329         return -ENOSYS;
 330 }
 331 static inline int pm_genpd_remove(struct generic_pm_domain *genpd)
 332 {
 333         return -EOPNOTSUPP;
 334 }
 335
 336 static inline struct device *dev_to_genpd_dev(struct device *dev)
 337 {
 338         return ERR_PTR(-EOPNOTSUPP);
 339 }
 340
 341 static inline int dev_pm_genpd_set_performance_state(struct device *dev,
 342                                                      unsigned int state)
 343 {
 344         return -EOPNOTSUPP;
 345 }
 346
 347 static inline int dev_pm_genpd_add_notifier(struct device *dev,
 348                                             struct notifier_block *nb)
 349 {
 350         return -EOPNOTSUPP;
 351 }
 352
 353 static inline int dev_pm_genpd_remove_notifier(struct device *dev)
 354 {
 355         return -EOPNOTSUPP;
 356 }
 357
 358 static inline void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next)
 359 { }
 360
 361 static inline ktime_t dev_pm_genpd_get_next_hrtimer(struct device *dev)
 362 {
 363         return KTIME_MAX;
 364 }
 365 static inline void dev_pm_genpd_synced_poweroff(struct device *dev)
 366 { }
 367
 368 static inline int dev_pm_genpd_set_hwmode(struct device *dev, bool enable)
 369 {
 370         return -EOPNOTSUPP;
 371 }
 372
 373 static inline bool dev_pm_genpd_get_hwmode(struct device *dev)
 374 {
 375         return false;
 376 }
 377
 378 #define simple_qos_governor             (*(struct dev_power_governor *)(NULL))
 379 #define pm_domain_always_on_gov         (*(struct dev_power_governor *)(NULL))
 380 #endif
 381
 382 #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP
 383 void dev_pm_genpd_suspend(struct device *dev);
 384 void dev_pm_genpd_resume(struct device *dev);
 385 #else
 386 static inline void dev_pm_genpd_suspend(struct device *dev) {}
 387 static inline void dev_pm_genpd_resume(struct device *dev) {}
 388 #endif
 389
 390 /* OF PM domain providers */
 391 struct of_device_id;
 392
 393 typedef struct generic_pm_domain *(*genpd_xlate_t)(const struct of_phandle_args *args,
 394                                                    void *data);
 395
 396 struct genpd_onecell_data {
 397         struct generic_pm_domain **domains;
 398         unsigned int num_domains;
 399         genpd_xlate_t xlate;
 400 };
 401
 402 #ifdef CONFIG_PM_GENERIC_DOMAINS_OF
 403 int of_genpd_add_provider_simple(struct device_node *np,
 404                                  struct generic_pm_domain *genpd);
 405 int of_genpd_add_provider_onecell(struct device_node *np,
 406                                   struct genpd_onecell_data *data);
 407 void of_genpd_del_provider(struct device_node *np);
 408 int of_genpd_add_device(const struct of_phandle_args *args, struct device *dev);
 409 int of_genpd_add_subdomain(const struct of_phandle_args *parent_spec,
 410                            const struct of_phandle_args *subdomain_spec);
 411 int of_genpd_remove_subdomain(const struct of_phandle_args *parent_spec,
 412                               const struct of_phandle_args *subdomain_spec);
 413 struct generic_pm_domain *of_genpd_remove_last(struct device_node *np);
 414 int of_genpd_parse_idle_states(struct device_node *dn,
 415                                struct genpd_power_state **states, int *n);
 416
 417 int genpd_dev_pm_attach(struct device *dev);
 418 struct device *genpd_dev_pm_attach_by_id(struct device *dev,
 419                                          unsigned int index);
 420 struct device *genpd_dev_pm_attach_by_name(struct device *dev,
 421                                            const char *name);
 422 #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */
 423 static inline int of_genpd_add_provider_simple(struct device_node *np,
 424                                         struct generic_pm_domain *genpd)
 425 {
 426         return -EOPNOTSUPP;
 427 }
 428
 429 static inline int of_genpd_add_provider_onecell(struct device_node *np,
 430                                         struct genpd_onecell_data *data)
 431 {
 432         return -EOPNOTSUPP;
 433 }
 434
 435 static inline void of_genpd_del_provider(struct device_node *np) {}
 436
 437 static inline int of_genpd_add_device(const struct of_phandle_args *args,
 438                                       struct device *dev)
 439 {
 440         return -ENODEV;
 441 }
 442
 443 static inline int of_genpd_add_subdomain(const struct of_phandle_args *parent_spec,
 444                                          const struct of_phandle_args *subdomain_spec)
 445 {
 446         return -ENODEV;
 447 }
 448
 449 static inline int of_genpd_remove_subdomain(const struct of_phandle_args *parent_spec,
 450                                             const struct of_phandle_args *subdomain_spec)
 451 {
 452         return -ENODEV;
 453 }
 454
 455 static inline int of_genpd_parse_idle_states(struct device_node *dn,
 456                         struct genpd_power_state **states, int *n)
 457 {
 458         return -ENODEV;
 459 }
 460
 461 static inline int genpd_dev_pm_attach(struct device *dev)
 462 {
 463         return 0;
 464 }
 465
 466 static inline struct device *genpd_dev_pm_attach_by_id(struct device *dev,
 467                                                        unsigned int index)
 468 {
 469         return NULL;
 470 }
 471
 472 static inline struct device *genpd_dev_pm_attach_by_name(struct device *dev,
 473                                                          const char *name)
 474 {
 475         return NULL;
 476 }
 477
 478 static inline
 479 struct generic_pm_domain *of_genpd_remove_last(struct device_node *np)
 480 {
 481         return ERR_PTR(-EOPNOTSUPP);
 482 }
 483 #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */
 484
 485 #ifdef CONFIG_PM
 486 int dev_pm_domain_attach(struct device *dev, bool power_on);
 487 struct device *dev_pm_domain_attach_by_id(struct device *dev,
 488                                           unsigned int index);
 489 struct device *dev_pm_domain_attach_by_name(struct device *dev,
 490                                             const char *name);
 491 int dev_pm_domain_attach_list(struct device *dev,
 492                               const struct dev_pm_domain_attach_data *data,
 493                               struct dev_pm_domain_list **list);
 494 int devm_pm_domain_attach_list(struct device *dev,
 495                                const struct dev_pm_domain_attach_data *data,
 496                                struct dev_pm_domain_list **list);
 497 void dev_pm_domain_detach(struct device *dev, bool power_off);
 498 void dev_pm_domain_detach_list(struct dev_pm_domain_list *list);
 499 int dev_pm_domain_start(struct device *dev);
 500 void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd);
 501 int dev_pm_domain_set_performance_state(struct device *dev, unsigned int state);
 502 #else
 503 static inline int dev_pm_domain_attach(struct device *dev, bool power_on)
 504 {
 505         return 0;
 506 }
 507 static inline struct device *dev_pm_domain_attach_by_id(struct device *dev,
 508                                                         unsigned int index)
 509 {
 510         return NULL;
 511 }
 512 static inline struct device *dev_pm_domain_attach_by_name(struct device *dev,
 513                                                           const char *name)
 514 {
 515         return NULL;
 516 }
 517 static inline int dev_pm_domain_attach_list(struct device *dev,
 518                                 const struct dev_pm_domain_attach_data *data,
 519                                 struct dev_pm_domain_list **list)
 520 {
 521         return 0;
 522 }
 523
 524 static inline int devm_pm_domain_attach_list(struct device *dev,
 525                                              const struct dev_pm_domain_attach_data *data,
 526                                              struct dev_pm_domain_list **list)
 527 {
 528         return 0;
 529 }
 530
 531 static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {}
 532 static inline void dev_pm_domain_detach_list(struct dev_pm_domain_list *list) {}
 533 static inline int dev_pm_domain_start(struct device *dev)
 534 {
 535         return 0;
 536 }
 537 static inline void dev_pm_domain_set(struct device *dev,
 538                                      struct dev_pm_domain *pd) {}
 539 static inline int dev_pm_domain_set_performance_state(struct device *dev,
 540                                                       unsigned int state)
 541 {
 542         return 0;
 543 }
 544 #endif
 545
 546 #endif /* _LINUX_PM_DOMAIN_H */