/* SPDX-License-Identifier: GPL-2.0-only */ /* * pm_domain.h - Definitions and headers related to device power domains. * * Copyright (C) 2011 Rafael J. Wysocki <[email protected]>, Renesas Electronics Corp. */ #ifndef _LINUX_PM_DOMAIN_H #define _LINUX_PM_DOMAIN_H #include <linux/device.h> #include <linux/ktime.h> #include <linux/mutex.h> #include <linux/pm.h> #include <linux/err.h> #include <linux/of.h> #include <linux/notifier.h> #include <linux/spinlock.h> #include <linux/cpumask_types.h> #include <linux/time64.h> /* * Flags to control the behaviour when attaching a device to its PM domains. * * PD_FLAG_NO_DEV_LINK: As the default behaviour creates a device-link * for every PM domain that gets attached, this * flag can be used to skip that. * * PD_FLAG_DEV_LINK_ON: Add the DL_FLAG_RPM_ACTIVE to power-on the * supplier and its PM domain when creating the * device-links. * */ #define PD_FLAG_NO_DEV_LINK … #define PD_FLAG_DEV_LINK_ON … struct dev_pm_domain_attach_data { … }; struct dev_pm_domain_list { … }; /* * Flags to control the behaviour of a genpd. * * These flags may be set in the struct generic_pm_domain's flags field by a * genpd backend driver. The flags must be set before it calls pm_genpd_init(), * which initializes a genpd. * * GENPD_FLAG_PM_CLK: Instructs genpd to use the PM clk framework, * while powering on/off attached devices. * * GENPD_FLAG_IRQ_SAFE: This informs genpd that its backend callbacks, * ->power_on|off(), doesn't sleep. Hence, these * can be invoked from within atomic context, which * enables genpd to power on/off the PM domain, * even when pm_runtime_is_irq_safe() returns true, * for any of its attached devices. Note that, a * genpd having this flag set, requires its * masterdomains to also have it set. * * GENPD_FLAG_ALWAYS_ON: Instructs genpd to always keep the PM domain * powered on. * * GENPD_FLAG_ACTIVE_WAKEUP: Instructs genpd to keep the PM domain powered * on, in case any of its attached devices is used * in the wakeup path to serve system wakeups. * * GENPD_FLAG_CPU_DOMAIN: Instructs genpd that it should expect to get * devices attached, which may belong to CPUs or * possibly have subdomains with CPUs attached. * This flag enables the genpd backend driver to * deploy idle power management support for CPUs * and groups of CPUs. Note that, the backend * driver must then comply with the so called, * last-man-standing algorithm, for the CPUs in the * PM domain. * * GENPD_FLAG_RPM_ALWAYS_ON: Instructs genpd to always keep the PM domain * powered on except for system suspend. * * GENPD_FLAG_MIN_RESIDENCY: Enable the genpd governor to consider its * components' next wakeup when determining the * optimal idle state. * * GENPD_FLAG_OPP_TABLE_FW: The genpd provider supports performance states, * but its corresponding OPP tables are not * described in DT, but are given directly by FW. */ #define GENPD_FLAG_PM_CLK … #define GENPD_FLAG_IRQ_SAFE … #define GENPD_FLAG_ALWAYS_ON … #define GENPD_FLAG_ACTIVE_WAKEUP … #define GENPD_FLAG_CPU_DOMAIN … #define GENPD_FLAG_RPM_ALWAYS_ON … #define GENPD_FLAG_MIN_RESIDENCY … #define GENPD_FLAG_OPP_TABLE_FW … enum gpd_status { … }; enum genpd_notication { … }; struct dev_power_governor { … }; struct gpd_dev_ops { … }; struct genpd_governor_data { … }; struct genpd_power_state { … }; struct genpd_lock_ops; struct opp_table; struct generic_pm_domain { … }; static inline struct generic_pm_domain *pd_to_genpd(struct dev_pm_domain *pd) { … } struct gpd_link { … }; struct gpd_timing_data { … }; struct pm_domain_data { … }; struct generic_pm_domain_data { … }; #ifdef CONFIG_PM_GENERIC_DOMAINS static inline struct generic_pm_domain_data *to_gpd_data(struct pm_domain_data *pdd) { … } static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) { … } int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev); int pm_genpd_remove_device(struct device *dev); int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, struct generic_pm_domain *subdomain); int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, struct generic_pm_domain *subdomain); int pm_genpd_init(struct generic_pm_domain *genpd, struct dev_power_governor *gov, bool is_off); int pm_genpd_remove(struct generic_pm_domain *genpd); struct device *dev_to_genpd_dev(struct device *dev); int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state); int dev_pm_genpd_add_notifier(struct device *dev, struct notifier_block *nb); int dev_pm_genpd_remove_notifier(struct device *dev); void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next); ktime_t dev_pm_genpd_get_next_hrtimer(struct device *dev); void dev_pm_genpd_synced_poweroff(struct device *dev); int dev_pm_genpd_set_hwmode(struct device *dev, bool enable); bool dev_pm_genpd_get_hwmode(struct device *dev); extern struct dev_power_governor simple_qos_governor; extern struct dev_power_governor pm_domain_always_on_gov; #ifdef CONFIG_CPU_IDLE extern struct dev_power_governor pm_domain_cpu_gov; #endif #else static inline struct generic_pm_domain_data *dev_gpd_data(struct device *dev) { return ERR_PTR(-ENOSYS); } static inline int pm_genpd_add_device(struct generic_pm_domain *genpd, struct device *dev) { return -ENOSYS; } static inline int pm_genpd_remove_device(struct device *dev) { return -ENOSYS; } static inline int pm_genpd_add_subdomain(struct generic_pm_domain *genpd, struct generic_pm_domain *subdomain) { return -ENOSYS; } static inline int pm_genpd_remove_subdomain(struct generic_pm_domain *genpd, struct generic_pm_domain *subdomain) { return -ENOSYS; } static inline int pm_genpd_init(struct generic_pm_domain *genpd, struct dev_power_governor *gov, bool is_off) { return -ENOSYS; } static inline int pm_genpd_remove(struct generic_pm_domain *genpd) { return -EOPNOTSUPP; } static inline struct device *dev_to_genpd_dev(struct device *dev) { return ERR_PTR(-EOPNOTSUPP); } static inline int dev_pm_genpd_set_performance_state(struct device *dev, unsigned int state) { return -EOPNOTSUPP; } static inline int dev_pm_genpd_add_notifier(struct device *dev, struct notifier_block *nb) { return -EOPNOTSUPP; } static inline int dev_pm_genpd_remove_notifier(struct device *dev) { return -EOPNOTSUPP; } static inline void dev_pm_genpd_set_next_wakeup(struct device *dev, ktime_t next) { } static inline ktime_t dev_pm_genpd_get_next_hrtimer(struct device *dev) { return KTIME_MAX; } static inline void dev_pm_genpd_synced_poweroff(struct device *dev) { } static inline int dev_pm_genpd_set_hwmode(struct device *dev, bool enable) { return -EOPNOTSUPP; } static inline bool dev_pm_genpd_get_hwmode(struct device *dev) { return false; } #define simple_qos_governor … #define pm_domain_always_on_gov … #endif #ifdef CONFIG_PM_GENERIC_DOMAINS_SLEEP void dev_pm_genpd_suspend(struct device *dev); void dev_pm_genpd_resume(struct device *dev); #else static inline void dev_pm_genpd_suspend(struct device *dev) {} static inline void dev_pm_genpd_resume(struct device *dev) {} #endif /* OF PM domain providers */ struct of_device_id; genpd_xlate_t; struct genpd_onecell_data { … }; #ifdef CONFIG_PM_GENERIC_DOMAINS_OF int of_genpd_add_provider_simple(struct device_node *np, struct generic_pm_domain *genpd); int of_genpd_add_provider_onecell(struct device_node *np, struct genpd_onecell_data *data); void of_genpd_del_provider(struct device_node *np); int of_genpd_add_device(const struct of_phandle_args *args, struct device *dev); int of_genpd_add_subdomain(const struct of_phandle_args *parent_spec, const struct of_phandle_args *subdomain_spec); int of_genpd_remove_subdomain(const struct of_phandle_args *parent_spec, const struct of_phandle_args *subdomain_spec); struct generic_pm_domain *of_genpd_remove_last(struct device_node *np); int of_genpd_parse_idle_states(struct device_node *dn, struct genpd_power_state **states, int *n); int genpd_dev_pm_attach(struct device *dev); struct device *genpd_dev_pm_attach_by_id(struct device *dev, unsigned int index); struct device *genpd_dev_pm_attach_by_name(struct device *dev, const char *name); #else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ static inline int of_genpd_add_provider_simple(struct device_node *np, struct generic_pm_domain *genpd) { return -EOPNOTSUPP; } static inline int of_genpd_add_provider_onecell(struct device_node *np, struct genpd_onecell_data *data) { return -EOPNOTSUPP; } static inline void of_genpd_del_provider(struct device_node *np) {} static inline int of_genpd_add_device(const struct of_phandle_args *args, struct device *dev) { return -ENODEV; } static inline int of_genpd_add_subdomain(const struct of_phandle_args *parent_spec, const struct of_phandle_args *subdomain_spec) { return -ENODEV; } static inline int of_genpd_remove_subdomain(const struct of_phandle_args *parent_spec, const struct of_phandle_args *subdomain_spec) { return -ENODEV; } static inline int of_genpd_parse_idle_states(struct device_node *dn, struct genpd_power_state **states, int *n) { return -ENODEV; } static inline int genpd_dev_pm_attach(struct device *dev) { return 0; } static inline struct device *genpd_dev_pm_attach_by_id(struct device *dev, unsigned int index) { return NULL; } static inline struct device *genpd_dev_pm_attach_by_name(struct device *dev, const char *name) { return NULL; } static inline struct generic_pm_domain *of_genpd_remove_last(struct device_node *np) { return ERR_PTR(-EOPNOTSUPP); } #endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ #ifdef CONFIG_PM int dev_pm_domain_attach(struct device *dev, bool power_on); struct device *dev_pm_domain_attach_by_id(struct device *dev, unsigned int index); struct device *dev_pm_domain_attach_by_name(struct device *dev, const char *name); int dev_pm_domain_attach_list(struct device *dev, const struct dev_pm_domain_attach_data *data, struct dev_pm_domain_list **list); void dev_pm_domain_detach(struct device *dev, bool power_off); void dev_pm_domain_detach_list(struct dev_pm_domain_list *list); int dev_pm_domain_start(struct device *dev); void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd); int dev_pm_domain_set_performance_state(struct device *dev, unsigned int state); #else static inline int dev_pm_domain_attach(struct device *dev, bool power_on) { return 0; } static inline struct device *dev_pm_domain_attach_by_id(struct device *dev, unsigned int index) { return NULL; } static inline struct device *dev_pm_domain_attach_by_name(struct device *dev, const char *name) { return NULL; } static inline int dev_pm_domain_attach_list(struct device *dev, const struct dev_pm_domain_attach_data *data, struct dev_pm_domain_list **list) { return 0; } static inline void dev_pm_domain_detach(struct device *dev, bool power_off) {} static inline void dev_pm_domain_detach_list(struct dev_pm_domain_list *list) {} static inline int dev_pm_domain_start(struct device *dev) { return 0; } static inline void dev_pm_domain_set(struct device *dev, struct dev_pm_domain *pd) {} static inline int dev_pm_domain_set_performance_state(struct device *dev, unsigned int state) { return 0; } #endif #endif /* _LINUX_PM_DOMAIN_H */
Codebase Browser
linux