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