| Message ID | 1393862536-9842-2-git-send-email-tomasz.figa@gmail.com (mailing list archive) |
|---|---|
| State | New, archived |
| Headers | show |
On 03/03, Tomasz Figa wrote: > diff --git a/drivers/base/power/domain.c b/drivers/base/power/domain.c > index dc127e5..006b455 100644 > --- a/drivers/base/power/domain.c > +++ b/drivers/base/power/domain.c > @@ -3,12 +3,16 @@ > * > * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp. > * > + * Support for Device Tree based power domain providers: > + * Copyright (C) 2014 Tomasz Figa <tomasz.figa@gmail.com> > + * > * This file is released under the GPLv2. > */ > > #include <linux/init.h> > #include <linux/kernel.h> > #include <linux/io.h> > +#include <linux/platform_device.h> Is this still needed? > #include <linux/pm_runtime.h> > #include <linux/pm_domain.h> > #include <linux/pm_qos.h> [...] > + > +/* > + * DEVICE<->DOMAIN BINDING USING DEVICE TREE LOOK-UP > + * > + * The code below registers a notifier for platform bus devices' > + * BUS_NOTIFY_BIND_DRIVER events and tries to attach devices to their power > + * domains by looking them up using Device Tree. > + * > + * Similarly in BUS_NOTIFY_UNBOUND_DRIVER the device is detached from its > + * domain, since it no longer supports runtime PM without any driver bound > + * to it. This looks outdated. > + * > + * Both generic and legacy Samsung-specific DT bindings are supported to > + * keep backwards compatibility with existing DTBs. > + */
On Mon, Mar 03, 2014 at 05:02:06PM +0100, Tomasz Figa wrote: > This patch introduces generic code to perform power domain look-up using > device tree and automatically bind devices to their power domains. > Generic device tree binding is introduced to specify power domains of > devices in their device tree nodes. > > Backwards compatibility with legacy Samsung-specific power domain > bindings is provided, but for now the new code is not compiled when > CONFIG_ARCH_EXYNOS is selected to avoid collision with legacy code. This > will change as soon as Exynos power domain code gets converted to use > the generic framework in further patch. Reviwed-by: Mark Brown <broonie@linaro.org> (mainly the binding)
On Mon, Mar 3, 2014 at 10:02 AM, Tomasz Figa <tomasz.figa@gmail.com> wrote: > This patch introduces generic code to perform power domain look-up using > device tree and automatically bind devices to their power domains. > Generic device tree binding is introduced to specify power domains of > devices in their device tree nodes. > > Backwards compatibility with legacy Samsung-specific power domain > bindings is provided, but for now the new code is not compiled when > CONFIG_ARCH_EXYNOS is selected to avoid collision with legacy code. This > will change as soon as Exynos power domain code gets converted to use > the generic framework in further patch. > > Signed-off-by: Tomasz Figa <tomasz.figa@gmail.com> Acked-by: Rob Herring <robh@kernel.org> > --- > .../devicetree/bindings/power/power_domain.txt | 51 ++++ > drivers/base/power/domain.c | 298 +++++++++++++++++++++ > include/linux/pm_domain.h | 46 ++++ > kernel/power/Kconfig | 4 + > 4 files changed, 399 insertions(+) > create mode 100644 Documentation/devicetree/bindings/power/power_domain.txt > > diff --git a/Documentation/devicetree/bindings/power/power_domain.txt b/Documentation/devicetree/bindings/power/power_domain.txt > new file mode 100644 > index 0000000..93be5d9 > --- /dev/null > +++ b/Documentation/devicetree/bindings/power/power_domain.txt > @@ -0,0 +1,51 @@ > +* Generic power domains > + > +System on chip designs are often divided into multiple power domains that > +can be used for power gating of selected IP blocks for power saving by > +reduced leakage current. > + > +This device tree binding can be used to bind power domain consumer devices > +with their power domains provided by power domain providers. A power domain > +provider can be represented by any node in the device tree and can provide > +one or more power domains. A consumer node can refer to the provider by > +a phandle and a set of phandle arguments (so called power domain specifier) > +of length specified by #power-domain-cells property in the power domain > +provider node. > + > +==Power domain providers== > + > +Required properties: > + - #power-domain-cells : Number of cells in a power domain specifier; > + Typically 0 for nodes representing a single power domain and 1 for nodes > + providing multiple power domains (e.g. power controllers), but can be > + any value as specified by device tree binding documentation of particular > + provider. > + > +Example: > + > + power: power-controller@12340000 { > + compatible = "foo,power-controller"; > + reg = <0x12340000 0x1000>; > + #power-domain-cells = <1>; > + }; > + > +The node above defines a power controller that is a power domain provider > +and expects one cell as its phandle argument. > + > +==Power domain consumers== > + > +Required properties: > + - power-domain : A phandle and power domain specifier as defined by bindings > + of power controller specified by phandle. > + > +Example: > + > + leaky-device@12350000 { > + compatible = "foo,i-leak-current"; > + reg = <0x12350000 0x1000>; > + power-domain = <&power 0>; > + }; > + > +The node above defines a typical power domain consumer device, which is located > +inside power domain with index 0 of power controller represented by node with > +label "power". > diff --git a/drivers/base/power/domain.c b/drivers/base/power/domain.c > index dc127e5..006b455 100644 > --- a/drivers/base/power/domain.c > +++ b/drivers/base/power/domain.c > @@ -3,12 +3,16 @@ > * > * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp. > * > + * Support for Device Tree based power domain providers: > + * Copyright (C) 2014 Tomasz Figa <tomasz.figa@gmail.com> > + * > * This file is released under the GPLv2. > */ > > #include <linux/init.h> > #include <linux/kernel.h> > #include <linux/io.h> > +#include <linux/platform_device.h> > #include <linux/pm_runtime.h> > #include <linux/pm_domain.h> > #include <linux/pm_qos.h> > @@ -2177,3 +2181,297 @@ void pm_genpd_init(struct generic_pm_domain *genpd, > list_add(&genpd->gpd_list_node, &gpd_list); > mutex_unlock(&gpd_list_lock); > } > + > +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF > +/* > + * DEVICE TREE BASED POWER DOMAIN PROVIDERS > + * > + * The code below implements generic device tree based power domain providers > + * that bind device tree nodes with generic power domains registered in the > + * system. > + * > + * Any driver that registers generic power domains and need to support binding > + * of devices to these domains is supposed to register a power domain provider, > + * which maps a power domain specifier retrieved from device tree to a power > + * domain. > + * > + * Two simple mapping functions have been provided for convenience: > + * - of_genpd_xlate_simple() for 1:1 device tree node to domain mapping, > + * - of_genpd_xlate_onecell() for mapping of multiple domains per node > + * by index. > + */ > + > +/** > + * struct of_genpd_provider - Power domain provider registration structure > + * @link: Entry in global list of domain providers > + * @node: Pointer to device tree node of domain provider > + * @xlate: Provider-specific xlate callback mapping a set of specifier cells > + * into a power domain. > + * @data: context pointer to be passed into @xlate callback > + */ > +struct of_genpd_provider { > + struct list_head link; > + > + struct device_node *node; > + genpd_xlate_t xlate; > + void *data; > +}; > + > +/* List of registered power domain providers. */ > +static LIST_HEAD(of_genpd_providers); > +/* Mutex to protect the list above. */ > +static DEFINE_MUTEX(of_genpd_mutex); > + > +/** > + * of_genpd_xlate_simple() - Xlate function for direct node-domain mapping > + * @genpdspec: OF phandle args to map into a power domain > + * @data: xlate function private data - pointer to struct generic_pm_domain > + * > + * This is a generic xlate function that can be used to model power domains > + * that have their own device tree nodes. The private data of xlate function > + * needs to be a valid pointer to struct generic_pm_domain. > + */ > +struct generic_pm_domain *of_genpd_xlate_simple( > + struct of_phandle_args *genpdspec, > + void *data) > +{ > + if (genpdspec->args_count != 0) > + return ERR_PTR(-EINVAL); > + return data; > +} > +EXPORT_SYMBOL_GPL(of_genpd_xlate_simple); > + > +/** > + * of_genpd_xlate_onecell() - Xlate function for providers using single index. > + * @genpdspec: OF phandle args to map into a power domain > + * @data: xlate function private data - pointer to struct genpd_onecell_data > + * > + * This is a generic xlate function that can be used to model simple power > + * domain controllers that have one device tree node and provide multiple > + * power domains. A single cell is used as an index to an array of power > + * domains specified in genpd_onecell_data struct when registering the > + * provider. > + */ > +struct generic_pm_domain *of_genpd_xlate_onecell( > + struct of_phandle_args *genpdspec, > + void *data) > +{ > + struct genpd_onecell_data *genpd_data = data; > + unsigned int idx = genpdspec->args[0]; > + > + if (genpdspec->args_count != 1) > + return ERR_PTR(-EINVAL); > + > + if (idx >= genpd_data->domain_num) { > + pr_err("%s: invalid domain index %d\n", __func__, idx); > + return ERR_PTR(-EINVAL); > + } > + > + return genpd_data->domains[idx]; > +} > +EXPORT_SYMBOL_GPL(of_genpd_xlate_onecell); > + > +/** > + * of_genpd_add_provider() - Register a domain provider for a node > + * @np: Device node pointer associated with domain provider. > + * @xlate: Callback for decoding domain from phandle arguments. > + * @data: Context pointer for @genpd_src_get callback. > + */ > +int of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, > + void *data) > +{ > + struct of_genpd_provider *cp; > + > + cp = kzalloc(sizeof(*cp), GFP_KERNEL); > + if (!cp) > + return -ENOMEM; > + > + cp->node = of_node_get(np); > + cp->data = data; > + cp->xlate = xlate; > + > + mutex_lock(&of_genpd_mutex); > + list_add(&cp->link, &of_genpd_providers); > + mutex_unlock(&of_genpd_mutex); > + pr_debug("Added domain provider from %s\n", np->full_name); > + > + return 0; > +} > +EXPORT_SYMBOL_GPL(of_genpd_add_provider); > + > +/** > + * of_genpd_del_provider() - Remove a previously registered domain provider > + * @np: Device node pointer associated with domain provider > + */ > +void of_genpd_del_provider(struct device_node *np) > +{ > + struct of_genpd_provider *cp; > + > + mutex_lock(&of_genpd_mutex); > + list_for_each_entry(cp, &of_genpd_providers, link) { > + if (cp->node == np) { > + list_del(&cp->link); > + of_node_put(cp->node); > + kfree(cp); > + break; > + } > + } > + mutex_unlock(&of_genpd_mutex); > +} > +EXPORT_SYMBOL_GPL(of_genpd_del_provider); > + > +/* See of_genpd_get_from_provider(). */ > +static struct generic_pm_domain *__of_genpd_get_from_provider( > + struct of_phandle_args *genpdspec) > +{ > + struct of_genpd_provider *provider; > + struct generic_pm_domain *genpd = ERR_PTR(-EPROBE_DEFER); > + > + /* Check if we have such a provider in our array */ > + list_for_each_entry(provider, &of_genpd_providers, link) { > + if (provider->node == genpdspec->np) > + genpd = provider->xlate(genpdspec, provider->data); > + if (!IS_ERR(genpd)) > + break; > + } > + > + return genpd; > +} > + > +/** > + * of_genpd_get_from_provider() - Look-up power domain > + * @genpdspec: OF phandle args to use for look-up > + * > + * Looks for domain provider under node specified by @genpdspec and if found > + * uses xlate function of the provider to map phandle args to a power domain. > + * > + * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR() > + * on failure. > + */ > +static struct generic_pm_domain *of_genpd_get_from_provider( > + struct of_phandle_args *genpdspec) > +{ > + struct generic_pm_domain *genpd; > + > + mutex_lock(&of_genpd_mutex); > + genpd = __of_genpd_get_from_provider(genpdspec); > + mutex_unlock(&of_genpd_mutex); > + > + return genpd; > +} > + > +/* > + * DEVICE<->DOMAIN BINDING USING DEVICE TREE LOOK-UP > + * > + * The code below registers a notifier for platform bus devices' > + * BUS_NOTIFY_BIND_DRIVER events and tries to attach devices to their power > + * domains by looking them up using Device Tree. > + * > + * Similarly in BUS_NOTIFY_UNBOUND_DRIVER the device is detached from its > + * domain, since it no longer supports runtime PM without any driver bound > + * to it. > + * > + * Both generic and legacy Samsung-specific DT bindings are supported to > + * keep backwards compatibility with existing DTBs. > + */ > + > +/** > + * genpd_bind_domain - Bind device to its power domain using Device Tree. > + * @dev: Device to bind to its power domain. > + * > + * Tries to parse power domain specifier from device's OF node and if succeeds > + * attaches the device to retrieved power domain. > + * > + * Returns 0 on success or negative error code otherwise. > + */ > +int genpd_bind_domain(struct device *dev) > +{ > + struct of_phandle_args pd_args; > + struct generic_pm_domain *pd; > + int ret; > + > + if (!dev->of_node) > + return 0; > + > + ret = of_parse_phandle_with_args(dev->of_node, "power-domain", > + "#power-domain-cells", 0, &pd_args); > + if (ret < 0) { > + if (ret != -ENOENT) > + return ret; > + > + /* > + * Try legacy Samsung-specific bindings > + * (for backwards compatibility of DT ABI) > + */ > + pd_args.args_count = 0; > + pd_args.np = of_parse_phandle(dev->of_node, > + "samsung,power-domain", 0); > + if (!pd_args.np) > + return 0; > + } > + > + pd = of_genpd_get_from_provider(&pd_args); > + if (IS_ERR(pd)) { > + if (PTR_ERR(pd) != -EPROBE_DEFER) > + dev_err(dev, "failed to find power domain: %ld\n", > + PTR_ERR(pd)); > + return PTR_ERR(pd); > + } > + > + dev_dbg(dev, "adding to power domain %s\n", pd->name); > + > + while (1) { > + ret = pm_genpd_add_device(pd, dev); > + if (ret != -EAGAIN) > + break; > + cond_resched(); > + } > + > + if (ret < 0) { > + dev_err(dev, "failed to add to power domain %s: %d", > + pd->name, ret); > + return ret; > + } > + > + pm_genpd_dev_need_restore(dev, true); > + > + return 0; > +} > + > +/** > + * genpd_unbind_domain - Unbind device from its power domain. > + * @dev: Device to unbind from its power domain. > + * > + * Unbinds device from power domain previously bound to it. > + * > + * Returns 0 on success or negative error code otherwise. > + */ > +int genpd_unbind_domain(struct device *dev) > +{ > + struct generic_pm_domain *pd = dev_to_genpd(dev); > + int ret; > + > + if (!dev->of_node || IS_ERR(pd)) > + return 0; > + > + dev_dbg(dev, "removing from power domain %s\n", pd->name); > + > + while (1) { > + ret = pm_genpd_remove_device(pd, dev); > + if (ret != -EAGAIN) > + break; > + cond_resched(); > + } > + > + if (ret < 0) { > + dev_err(dev, "failed to remove from power domain %s: %d", > + pd->name, ret); > + return ret; > + } > + > + /* Check if domain can be powered off after removing this device. */ > + genpd_queue_power_off_work(pd); > + > + return 0; > +} > +#endif > diff --git a/include/linux/pm_domain.h b/include/linux/pm_domain.h > index 7c1d252..04473d4 100644 > --- a/include/linux/pm_domain.h > +++ b/include/linux/pm_domain.h > @@ -310,4 +310,50 @@ static inline void pm_genpd_syscore_poweron(struct device *dev) > pm_genpd_syscore_switch(dev, false); > } > > +/* OF power domain providers */ > +struct of_device_id; > + > +struct genpd_onecell_data { > + struct generic_pm_domain **domains; > + unsigned int domain_num; > +}; > + > +typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args, > + void *data); > + > +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF > +int of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, > + void *data); > +void of_genpd_del_provider(struct device_node *np); > + > +struct generic_pm_domain *of_genpd_xlate_simple( > + struct of_phandle_args *genpdspec, > + void *data); > +struct generic_pm_domain *of_genpd_xlate_onecell( > + struct of_phandle_args *genpdspec, > + void *data); > + > +int genpd_bind_domain(struct device *dev); > +int genpd_unbind_domain(struct device *dev); > +#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ > +static inline int of_genpd_add_provider(struct device_node *np, > + genpd_xlate_t xlate, void *data) > +{ > + return 0; > +} > +static inline void of_genpd_del_provider(struct device_node *np) {} > + > +#define of_genpd_xlate_simple NULL > +#define of_genpd_xlate_onecell NULL > + > +static inline int genpd_bind_domain(struct device *dev) > +{ > + return 0; > +} > +static inline int genpd_unbind_domain(struct device *dev) > +{ > + return 0; > +} > +#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ > + > #endif /* _LINUX_PM_DOMAIN_H */ > diff --git a/kernel/power/Kconfig b/kernel/power/Kconfig > index 2fac9cc..45aa98e 100644 > --- a/kernel/power/Kconfig > +++ b/kernel/power/Kconfig > @@ -306,6 +306,10 @@ config PM_GENERIC_DOMAINS_RUNTIME > def_bool y > depends on PM_RUNTIME && PM_GENERIC_DOMAINS > > +config PM_GENERIC_DOMAINS_OF > + def_bool y > + depends on PM_GENERIC_DOMAINS && OF && !ARCH_EXYNOS > + > config CPU_PM > bool > depends on SUSPEND || CPU_IDLE > -- > 1.9.0 >
On 3 March 2014 17:02, Tomasz Figa <tomasz.figa@gmail.com> wrote: > This patch introduces generic code to perform power domain look-up using > device tree and automatically bind devices to their power domains. > Generic device tree binding is introduced to specify power domains of > devices in their device tree nodes. > > Backwards compatibility with legacy Samsung-specific power domain > bindings is provided, but for now the new code is not compiled when > CONFIG_ARCH_EXYNOS is selected to avoid collision with legacy code. This > will change as soon as Exynos power domain code gets converted to use > the generic framework in further patch. > > Signed-off-by: Tomasz Figa <tomasz.figa@gmail.com> > --- > .../devicetree/bindings/power/power_domain.txt | 51 ++++ > drivers/base/power/domain.c | 298 +++++++++++++++++++++ > include/linux/pm_domain.h | 46 ++++ > kernel/power/Kconfig | 4 + > 4 files changed, 399 insertions(+) > create mode 100644 Documentation/devicetree/bindings/power/power_domain.txt > > diff --git a/Documentation/devicetree/bindings/power/power_domain.txt b/Documentation/devicetree/bindings/power/power_domain.txt > new file mode 100644 > index 0000000..93be5d9 > --- /dev/null > +++ b/Documentation/devicetree/bindings/power/power_domain.txt > @@ -0,0 +1,51 @@ > +* Generic power domains > + > +System on chip designs are often divided into multiple power domains that > +can be used for power gating of selected IP blocks for power saving by > +reduced leakage current. > + > +This device tree binding can be used to bind power domain consumer devices > +with their power domains provided by power domain providers. A power domain > +provider can be represented by any node in the device tree and can provide > +one or more power domains. A consumer node can refer to the provider by > +a phandle and a set of phandle arguments (so called power domain specifier) > +of length specified by #power-domain-cells property in the power domain > +provider node. > + > +==Power domain providers== > + > +Required properties: > + - #power-domain-cells : Number of cells in a power domain specifier; > + Typically 0 for nodes representing a single power domain and 1 for nodes > + providing multiple power domains (e.g. power controllers), but can be > + any value as specified by device tree binding documentation of particular > + provider. > + > +Example: > + > + power: power-controller@12340000 { > + compatible = "foo,power-controller"; > + reg = <0x12340000 0x1000>; > + #power-domain-cells = <1>; > + }; > + > +The node above defines a power controller that is a power domain provider > +and expects one cell as its phandle argument. > + > +==Power domain consumers== > + > +Required properties: > + - power-domain : A phandle and power domain specifier as defined by bindings > + of power controller specified by phandle. > + > +Example: > + > + leaky-device@12350000 { > + compatible = "foo,i-leak-current"; > + reg = <0x12350000 0x1000>; > + power-domain = <&power 0>; > + }; > + > +The node above defines a typical power domain consumer device, which is located > +inside power domain with index 0 of power controller represented by node with > +label "power". > diff --git a/drivers/base/power/domain.c b/drivers/base/power/domain.c > index dc127e5..006b455 100644 > --- a/drivers/base/power/domain.c > +++ b/drivers/base/power/domain.c > @@ -3,12 +3,16 @@ > * > * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp. > * > + * Support for Device Tree based power domain providers: > + * Copyright (C) 2014 Tomasz Figa <tomasz.figa@gmail.com> > + * > * This file is released under the GPLv2. > */ > > #include <linux/init.h> > #include <linux/kernel.h> > #include <linux/io.h> > +#include <linux/platform_device.h> > #include <linux/pm_runtime.h> > #include <linux/pm_domain.h> > #include <linux/pm_qos.h> > @@ -2177,3 +2181,297 @@ void pm_genpd_init(struct generic_pm_domain *genpd, > list_add(&genpd->gpd_list_node, &gpd_list); > mutex_unlock(&gpd_list_lock); > } > + > +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF Do we need a new config for this? Can't we just use CONFIG_OF? > +/* > + * DEVICE TREE BASED POWER DOMAIN PROVIDERS > + * > + * The code below implements generic device tree based power domain providers > + * that bind device tree nodes with generic power domains registered in the > + * system. > + * > + * Any driver that registers generic power domains and need to support binding > + * of devices to these domains is supposed to register a power domain provider, > + * which maps a power domain specifier retrieved from device tree to a power > + * domain. > + * > + * Two simple mapping functions have been provided for convenience: > + * - of_genpd_xlate_simple() for 1:1 device tree node to domain mapping, > + * - of_genpd_xlate_onecell() for mapping of multiple domains per node > + * by index. > + */ > + > +/** > + * struct of_genpd_provider - Power domain provider registration structure > + * @link: Entry in global list of domain providers > + * @node: Pointer to device tree node of domain provider > + * @xlate: Provider-specific xlate callback mapping a set of specifier cells > + * into a power domain. > + * @data: context pointer to be passed into @xlate callback > + */ > +struct of_genpd_provider { > + struct list_head link; > + > + struct device_node *node; > + genpd_xlate_t xlate; > + void *data; > +}; > + > +/* List of registered power domain providers. */ > +static LIST_HEAD(of_genpd_providers); > +/* Mutex to protect the list above. */ > +static DEFINE_MUTEX(of_genpd_mutex); > + > +/** > + * of_genpd_xlate_simple() - Xlate function for direct node-domain mapping > + * @genpdspec: OF phandle args to map into a power domain > + * @data: xlate function private data - pointer to struct generic_pm_domain > + * > + * This is a generic xlate function that can be used to model power domains > + * that have their own device tree nodes. The private data of xlate function > + * needs to be a valid pointer to struct generic_pm_domain. > + */ > +struct generic_pm_domain *of_genpd_xlate_simple( > + struct of_phandle_args *genpdspec, > + void *data) > +{ > + if (genpdspec->args_count != 0) > + return ERR_PTR(-EINVAL); > + return data; > +} > +EXPORT_SYMBOL_GPL(of_genpd_xlate_simple); > + > +/** > + * of_genpd_xlate_onecell() - Xlate function for providers using single index. > + * @genpdspec: OF phandle args to map into a power domain > + * @data: xlate function private data - pointer to struct genpd_onecell_data > + * > + * This is a generic xlate function that can be used to model simple power > + * domain controllers that have one device tree node and provide multiple > + * power domains. A single cell is used as an index to an array of power > + * domains specified in genpd_onecell_data struct when registering the > + * provider. > + */ > +struct generic_pm_domain *of_genpd_xlate_onecell( > + struct of_phandle_args *genpdspec, > + void *data) > +{ > + struct genpd_onecell_data *genpd_data = data; > + unsigned int idx = genpdspec->args[0]; > + > + if (genpdspec->args_count != 1) > + return ERR_PTR(-EINVAL); > + > + if (idx >= genpd_data->domain_num) { > + pr_err("%s: invalid domain index %d\n", __func__, idx); > + return ERR_PTR(-EINVAL); > + } > + > + return genpd_data->domains[idx]; > +} > +EXPORT_SYMBOL_GPL(of_genpd_xlate_onecell); > + > +/** > + * of_genpd_add_provider() - Register a domain provider for a node > + * @np: Device node pointer associated with domain provider. > + * @xlate: Callback for decoding domain from phandle arguments. > + * @data: Context pointer for @genpd_src_get callback. > + */ > +int of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, > + void *data) > +{ > + struct of_genpd_provider *cp; > + > + cp = kzalloc(sizeof(*cp), GFP_KERNEL); > + if (!cp) > + return -ENOMEM; > + > + cp->node = of_node_get(np); > + cp->data = data; > + cp->xlate = xlate; > + > + mutex_lock(&of_genpd_mutex); > + list_add(&cp->link, &of_genpd_providers); > + mutex_unlock(&of_genpd_mutex); > + pr_debug("Added domain provider from %s\n", np->full_name); > + > + return 0; > +} > +EXPORT_SYMBOL_GPL(of_genpd_add_provider); > + > +/** > + * of_genpd_del_provider() - Remove a previously registered domain provider > + * @np: Device node pointer associated with domain provider > + */ > +void of_genpd_del_provider(struct device_node *np) > +{ > + struct of_genpd_provider *cp; > + > + mutex_lock(&of_genpd_mutex); > + list_for_each_entry(cp, &of_genpd_providers, link) { > + if (cp->node == np) { > + list_del(&cp->link); > + of_node_put(cp->node); > + kfree(cp); > + break; > + } > + } > + mutex_unlock(&of_genpd_mutex); > +} > +EXPORT_SYMBOL_GPL(of_genpd_del_provider); > + > +/* See of_genpd_get_from_provider(). */ > +static struct generic_pm_domain *__of_genpd_get_from_provider( > + struct of_phandle_args *genpdspec) > +{ > + struct of_genpd_provider *provider; > + struct generic_pm_domain *genpd = ERR_PTR(-EPROBE_DEFER); > + > + /* Check if we have such a provider in our array */ > + list_for_each_entry(provider, &of_genpd_providers, link) { > + if (provider->node == genpdspec->np) > + genpd = provider->xlate(genpdspec, provider->data); > + if (!IS_ERR(genpd)) > + break; > + } > + > + return genpd; > +} > + > +/** > + * of_genpd_get_from_provider() - Look-up power domain > + * @genpdspec: OF phandle args to use for look-up > + * > + * Looks for domain provider under node specified by @genpdspec and if found > + * uses xlate function of the provider to map phandle args to a power domain. > + * > + * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR() > + * on failure. > + */ > +static struct generic_pm_domain *of_genpd_get_from_provider( > + struct of_phandle_args *genpdspec) > +{ > + struct generic_pm_domain *genpd; > + > + mutex_lock(&of_genpd_mutex); > + genpd = __of_genpd_get_from_provider(genpdspec); > + mutex_unlock(&of_genpd_mutex); > + > + return genpd; > +} > + > +/* > + * DEVICE<->DOMAIN BINDING USING DEVICE TREE LOOK-UP > + * > + * The code below registers a notifier for platform bus devices' > + * BUS_NOTIFY_BIND_DRIVER events and tries to attach devices to their power > + * domains by looking them up using Device Tree. > + * > + * Similarly in BUS_NOTIFY_UNBOUND_DRIVER the device is detached from its > + * domain, since it no longer supports runtime PM without any driver bound > + * to it. > + * > + * Both generic and legacy Samsung-specific DT bindings are supported to > + * keep backwards compatibility with existing DTBs. > + */ > + > +/** > + * genpd_bind_domain - Bind device to its power domain using Device Tree. > + * @dev: Device to bind to its power domain. > + * > + * Tries to parse power domain specifier from device's OF node and if succeeds > + * attaches the device to retrieved power domain. > + * > + * Returns 0 on success or negative error code otherwise. > + */ > +int genpd_bind_domain(struct device *dev) > +{ > + struct of_phandle_args pd_args; > + struct generic_pm_domain *pd; > + int ret; > + > + if (!dev->of_node) > + return 0; > + > + ret = of_parse_phandle_with_args(dev->of_node, "power-domain", > + "#power-domain-cells", 0, &pd_args); > + if (ret < 0) { > + if (ret != -ENOENT) > + return ret; > + > + /* > + * Try legacy Samsung-specific bindings > + * (for backwards compatibility of DT ABI) > + */ > + pd_args.args_count = 0; > + pd_args.np = of_parse_phandle(dev->of_node, > + "samsung,power-domain", 0); > + if (!pd_args.np) > + return 0; > + } > + > + pd = of_genpd_get_from_provider(&pd_args); > + if (IS_ERR(pd)) { > + if (PTR_ERR(pd) != -EPROBE_DEFER) > + dev_err(dev, "failed to find power domain: %ld\n", > + PTR_ERR(pd)); > + return PTR_ERR(pd); > + } > + > + dev_dbg(dev, "adding to power domain %s\n", pd->name); > + > + while (1) { > + ret = pm_genpd_add_device(pd, dev); > + if (ret != -EAGAIN) > + break; > + cond_resched(); > + } > + > + if (ret < 0) { > + dev_err(dev, "failed to add to power domain %s: %d", > + pd->name, ret); > + return ret; > + } > + > + pm_genpd_dev_need_restore(dev, true); So this will reflect the device as being inactive, which I think is the wrong approach. Usually we should expect drivers that's being probed successfully to leave their devices in active state, right? Kind regards Ulf Hansson > + > + return 0; > +} > + > +/** > + * genpd_unbind_domain - Unbind device from its power domain. > + * @dev: Device to unbind from its power domain. > + * > + * Unbinds device from power domain previously bound to it. > + * > + * Returns 0 on success or negative error code otherwise. > + */ > +int genpd_unbind_domain(struct device *dev) > +{ > + struct generic_pm_domain *pd = dev_to_genpd(dev); > + int ret; > + > + if (!dev->of_node || IS_ERR(pd)) > + return 0; > + > + dev_dbg(dev, "removing from power domain %s\n", pd->name); > + > + while (1) { > + ret = pm_genpd_remove_device(pd, dev); > + if (ret != -EAGAIN) > + break; > + cond_resched(); > + } > + > + if (ret < 0) { > + dev_err(dev, "failed to remove from power domain %s: %d", > + pd->name, ret); > + return ret; > + } > + > + /* Check if domain can be powered off after removing this device. */ > + genpd_queue_power_off_work(pd); > + > + return 0; > +} > +#endif > diff --git a/include/linux/pm_domain.h b/include/linux/pm_domain.h > index 7c1d252..04473d4 100644 > --- a/include/linux/pm_domain.h > +++ b/include/linux/pm_domain.h > @@ -310,4 +310,50 @@ static inline void pm_genpd_syscore_poweron(struct device *dev) > pm_genpd_syscore_switch(dev, false); > } > > +/* OF power domain providers */ > +struct of_device_id; > + > +struct genpd_onecell_data { > + struct generic_pm_domain **domains; > + unsigned int domain_num; > +}; > + > +typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args, > + void *data); > + > +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF > +int of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, > + void *data); > +void of_genpd_del_provider(struct device_node *np); > + > +struct generic_pm_domain *of_genpd_xlate_simple( > + struct of_phandle_args *genpdspec, > + void *data); > +struct generic_pm_domain *of_genpd_xlate_onecell( > + struct of_phandle_args *genpdspec, > + void *data); > + > +int genpd_bind_domain(struct device *dev); > +int genpd_unbind_domain(struct device *dev); > +#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ > +static inline int of_genpd_add_provider(struct device_node *np, > + genpd_xlate_t xlate, void *data) > +{ > + return 0; > +} > +static inline void of_genpd_del_provider(struct device_node *np) {} > + > +#define of_genpd_xlate_simple NULL > +#define of_genpd_xlate_onecell NULL > + > +static inline int genpd_bind_domain(struct device *dev) > +{ > + return 0; > +} > +static inline int genpd_unbind_domain(struct device *dev) > +{ > + return 0; > +} > +#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ > + > #endif /* _LINUX_PM_DOMAIN_H */ > diff --git a/kernel/power/Kconfig b/kernel/power/Kconfig > index 2fac9cc..45aa98e 100644 > --- a/kernel/power/Kconfig > +++ b/kernel/power/Kconfig > @@ -306,6 +306,10 @@ config PM_GENERIC_DOMAINS_RUNTIME > def_bool y > depends on PM_RUNTIME && PM_GENERIC_DOMAINS > > +config PM_GENERIC_DOMAINS_OF > + def_bool y > + depends on PM_GENERIC_DOMAINS && OF && !ARCH_EXYNOS > + > config CPU_PM > bool > depends on SUSPEND || CPU_IDLE > -- > 1.9.0 >
Hi Ulf, On 05.03.2014 08:19, Ulf Hansson wrote: >> @@ -2177,3 +2181,297 @@ void pm_genpd_init(struct generic_pm_domain *genpd, >> list_add(&genpd->gpd_list_node, &gpd_list); >> mutex_unlock(&gpd_list_lock); >> } >> + >> +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF > > Do we need a new config for this? Can't we just use CONFIG_OF? > I guess we could, but initially it would have to be CONFIG_OF && !CONFIG_ARCH_EXYNOS until patch 03/11 converts Exynos to use the common code. >> + if (ret < 0) { >> + dev_err(dev, "failed to add to power domain %s: %d", >> + pd->name, ret); >> + return ret; >> + } >> + >> + pm_genpd_dev_need_restore(dev, true); > > So this will reflect the device as being inactive, which I think is > the wrong approach. > > Usually we should expect drivers that's being probed successfully to > leave their devices in active state, right? It depends on domain power state, but actually it seems to be already handled in __pm_genpd_add_device(), so this line might be not needed indeed. Strangely enough, it seemed to be needed on Exynos for correct operation, but maybe in the meantime some fixes in genpd code showed up. This will need some extra testing. Best regards, Tomasz
On 04.03.2014 19:23, Stephen Boyd wrote: > On 03/03, Tomasz Figa wrote: >> diff --git a/drivers/base/power/domain.c b/drivers/base/power/domain.c >> index dc127e5..006b455 100644 >> --- a/drivers/base/power/domain.c >> +++ b/drivers/base/power/domain.c >> @@ -3,12 +3,16 @@ >> * >> * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp. >> * >> + * Support for Device Tree based power domain providers: >> + * Copyright (C) 2014 Tomasz Figa <tomasz.figa@gmail.com> >> + * >> * This file is released under the GPLv2. >> */ >> >> #include <linux/init.h> >> #include <linux/kernel.h> >> #include <linux/io.h> >> +#include <linux/platform_device.h> > > Is this still needed? > Probably not. >> #include <linux/pm_runtime.h> >> #include <linux/pm_domain.h> >> #include <linux/pm_qos.h> > [...] >> + >> +/* >> + * DEVICE<->DOMAIN BINDING USING DEVICE TREE LOOK-UP >> + * >> + * The code below registers a notifier for platform bus devices' >> + * BUS_NOTIFY_BIND_DRIVER events and tries to attach devices to their power >> + * domains by looking them up using Device Tree. >> + * >> + * Similarly in BUS_NOTIFY_UNBOUND_DRIVER the device is detached from its >> + * domain, since it no longer supports runtime PM without any driver bound >> + * to it. > > This looks outdated. > Oops, missed this one. Thanks for pointing out. Best regards, Tomasz
On 05.03.2014 12:47, Tomasz Figa wrote: > Hi Ulf, > > On 05.03.2014 08:19, Ulf Hansson wrote: >>> @@ -2177,3 +2181,297 @@ void pm_genpd_init(struct generic_pm_domain >>> *genpd, >>> list_add(&genpd->gpd_list_node, &gpd_list); >>> mutex_unlock(&gpd_list_lock); >>> } >>> + >>> +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF >> >> Do we need a new config for this? Can't we just use CONFIG_OF? >> > > I guess we could, but initially it would have to be CONFIG_OF && > !CONFIG_ARCH_EXYNOS until patch 03/11 converts Exynos to use the common > code. > >>> + if (ret < 0) { >>> + dev_err(dev, "failed to add to power domain %s: %d", >>> + pd->name, ret); >>> + return ret; >>> + } >>> + >>> + pm_genpd_dev_need_restore(dev, true); >> >> So this will reflect the device as being inactive, which I think is >> the wrong approach. >> >> Usually we should expect drivers that's being probed successfully to >> leave their devices in active state, right? > > It depends on domain power state, but actually it seems to be already > handled in __pm_genpd_add_device(), so this line might be not needed > indeed. > > Strangely enough, it seemed to be needed on Exynos for correct > operation, but maybe in the meantime some fixes in genpd code showed up. > This will need some extra testing. Hmm, after removing this line, power domains no longer work correctly on Exynos (thanks Marek for testing). Unfortunately I'm on a sick leave right now and I won't be able to debug this issue on Exynos for some time, but I'll see if I can reproduce it on s3c64xx board I have here at home. Best regards, Tomasz
On Mon, Mar 03, 2014 at 04:02:06PM +0000, Tomasz Figa wrote: [...] > +/** > + * genpd_bind_domain - Bind device to its power domain using Device Tree. > + * @dev: Device to bind to its power domain. > + * > + * Tries to parse power domain specifier from device's OF node and if succeeds > + * attaches the device to retrieved power domain. > + * > + * Returns 0 on success or negative error code otherwise. > + */ > +int genpd_bind_domain(struct device *dev) > +{ > + struct of_phandle_args pd_args; > + struct generic_pm_domain *pd; > + int ret; > + > + if (!dev->of_node) > + return 0; Returning 0 (ie success) is deliberate here right ? It is a bit misleading but I can see why (if a device has no backing DT node, it is up to platform code to bind it). Probably deserves a comment. > + > + ret = of_parse_phandle_with_args(dev->of_node, "power-domain", > + "#power-domain-cells", 0, &pd_args); > + if (ret < 0) { > + if (ret != -ENOENT) > + return ret; > + > + /* > + * Try legacy Samsung-specific bindings > + * (for backwards compatibility of DT ABI) > + */ > + pd_args.args_count = 0; > + pd_args.np = of_parse_phandle(dev->of_node, > + "samsung,power-domain", 0); > + if (!pd_args.np) > + return 0; Same here. > + } > + > + pd = of_genpd_get_from_provider(&pd_args); > + if (IS_ERR(pd)) { > + if (PTR_ERR(pd) != -EPROBE_DEFER) > + dev_err(dev, "failed to find power domain: %ld\n", > + PTR_ERR(pd)); > + return PTR_ERR(pd); > + } > + > + dev_dbg(dev, "adding to power domain %s\n", pd->name); > + > + while (1) { > + ret = pm_genpd_add_device(pd, dev); > + if (ret != -EAGAIN) > + break; > + cond_resched(); > + } > + > + if (ret < 0) { > + dev_err(dev, "failed to add to power domain %s: %d", > + pd->name, ret); > + return ret; > + } > + > + pm_genpd_dev_need_restore(dev, true); > + > + return 0; > +} > + > +/** > + * genpd_unbind_domain - Unbind device from its power domain. > + * @dev: Device to unbind from its power domain. > + * > + * Unbinds device from power domain previously bound to it. > + * > + * Returns 0 on success or negative error code otherwise. > + */ > +int genpd_unbind_domain(struct device *dev) > +{ > + struct generic_pm_domain *pd = dev_to_genpd(dev); > + int ret; > + > + if (!dev->of_node || IS_ERR(pd)) > + return 0; And here. Thanks for posting it, Lorenzo
Tomasz Figa <tomasz.figa@gmail.com> writes: > This patch introduces generic code to perform power domain look-up using > device tree and automatically bind devices to their power domains. > Generic device tree binding is introduced to specify power domains of > devices in their device tree nodes. > > Backwards compatibility with legacy Samsung-specific power domain > bindings is provided, but for now the new code is not compiled when > CONFIG_ARCH_EXYNOS is selected to avoid collision with legacy code. This > will change as soon as Exynos power domain code gets converted to use > the generic framework in further patch. > > Signed-off-by: Tomasz Figa <tomasz.figa@gmail.com> Reviewed-by: Kevin Hilman <khilman@linaro.org> The approach and binding both look good to me, other than a few minor nits on comments and question on the locking below... [...] > @@ -2177,3 +2181,297 @@ void pm_genpd_init(struct generic_pm_domain *genpd, > list_add(&genpd->gpd_list_node, &gpd_list); > mutex_unlock(&gpd_list_lock); > } > + > +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF > +/* > + * DEVICE TREE BASED POWER DOMAIN PROVIDERS why all caps? [...] > +/* See of_genpd_get_from_provider(). */ > +static struct generic_pm_domain *__of_genpd_get_from_provider( > + struct of_phandle_args *genpdspec) > +{ > + struct of_genpd_provider *provider; > + struct generic_pm_domain *genpd = ERR_PTR(-EPROBE_DEFER); > + > + /* Check if we have such a provider in our array */ I think you want to take the mutex here... > + list_for_each_entry(provider, &of_genpd_providers, link) { > + if (provider->node == genpdspec->np) > + genpd = provider->xlate(genpdspec, provider->data); > + if (!IS_ERR(genpd)) > + break; > + } ...and release it here, right? [...] > +/* > + * DEVICE<->DOMAIN BINDING USING DEVICE TREE LOOK-UP hmm, more yelling? Otherwise, looks good to me. Kevin
On Mon, 2014-03-03 at 05:02PM +0100, Tomasz Figa wrote: > This patch introduces generic code to perform power domain look-up using > device tree and automatically bind devices to their power domains. > Generic device tree binding is introduced to specify power domains of > devices in their device tree nodes. > > Backwards compatibility with legacy Samsung-specific power domain > bindings is provided, but for now the new code is not compiled when > CONFIG_ARCH_EXYNOS is selected to avoid collision with legacy code. This > will change as soon as Exynos power domain code gets converted to use > the generic framework in further patch. > > Signed-off-by: Tomasz Figa <tomasz.figa@gmail.com> > --- > .../devicetree/bindings/power/power_domain.txt | 51 ++++ > drivers/base/power/domain.c | 298 +++++++++++++++++++++ > include/linux/pm_domain.h | 46 ++++ > kernel/power/Kconfig | 4 + > 4 files changed, 399 insertions(+) > create mode 100644 Documentation/devicetree/bindings/power/power_domain.txt > > diff --git a/Documentation/devicetree/bindings/power/power_domain.txt b/Documentation/devicetree/bindings/power/power_domain.txt > new file mode 100644 > index 0000000..93be5d9 > --- /dev/null > +++ b/Documentation/devicetree/bindings/power/power_domain.txt > @@ -0,0 +1,51 @@ > +* Generic power domains > + > +System on chip designs are often divided into multiple power domains that > +can be used for power gating of selected IP blocks for power saving by > +reduced leakage current. > + > +This device tree binding can be used to bind power domain consumer devices > +with their power domains provided by power domain providers. A power domain > +provider can be represented by any node in the device tree and can provide > +one or more power domains. A consumer node can refer to the provider by > +a phandle and a set of phandle arguments (so called power domain specifier) > +of length specified by #power-domain-cells property in the power domain > +provider node. > + > +==Power domain providers== > + > +Required properties: > + - #power-domain-cells : Number of cells in a power domain specifier; > + Typically 0 for nodes representing a single power domain and 1 for nodes > + providing multiple power domains (e.g. power controllers), but can be > + any value as specified by device tree binding documentation of particular > + provider. > + > +Example: > + > + power: power-controller@12340000 { > + compatible = "foo,power-controller"; > + reg = <0x12340000 0x1000>; > + #power-domain-cells = <1>; > + }; > + > +The node above defines a power controller that is a power domain provider > +and expects one cell as its phandle argument. > + > +==Power domain consumers== > + > +Required properties: > + - power-domain : A phandle and power domain specifier as defined by bindings > + of power controller specified by phandle. > + > +Example: > + > + leaky-device@12350000 { > + compatible = "foo,i-leak-current"; > + reg = <0x12350000 0x1000>; > + power-domain = <&power 0>; > + }; > + > +The node above defines a typical power domain consumer device, which is located > +inside power domain with index 0 of power controller represented by node with > +label "power". Does this allow nesting of power domains? E.g. you have a PD which is represented by some programmable power supply, and within this domain smaller islands/domains that can be gated independently. Thanks, Sören
Hi Sören, On 20.03.2014 00:13, Sören Brinkmann wrote: > On Mon, 2014-03-03 at 05:02PM +0100, Tomasz Figa wrote: >> This patch introduces generic code to perform power domain look-up using >> device tree and automatically bind devices to their power domains. >> Generic device tree binding is introduced to specify power domains of >> devices in their device tree nodes. >> >> Backwards compatibility with legacy Samsung-specific power domain >> bindings is provided, but for now the new code is not compiled when >> CONFIG_ARCH_EXYNOS is selected to avoid collision with legacy code. This >> will change as soon as Exynos power domain code gets converted to use >> the generic framework in further patch. >> >> Signed-off-by: Tomasz Figa <tomasz.figa@gmail.com> >> --- >> .../devicetree/bindings/power/power_domain.txt | 51 ++++ >> drivers/base/power/domain.c | 298 +++++++++++++++++++++ >> include/linux/pm_domain.h | 46 ++++ >> kernel/power/Kconfig | 4 + >> 4 files changed, 399 insertions(+) >> create mode 100644 Documentation/devicetree/bindings/power/power_domain.txt >> >> diff --git a/Documentation/devicetree/bindings/power/power_domain.txt b/Documentation/devicetree/bindings/power/power_domain.txt >> new file mode 100644 >> index 0000000..93be5d9 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/power/power_domain.txt >> @@ -0,0 +1,51 @@ >> +* Generic power domains >> + >> +System on chip designs are often divided into multiple power domains that >> +can be used for power gating of selected IP blocks for power saving by >> +reduced leakage current. >> + >> +This device tree binding can be used to bind power domain consumer devices >> +with their power domains provided by power domain providers. A power domain >> +provider can be represented by any node in the device tree and can provide >> +one or more power domains. A consumer node can refer to the provider by >> +a phandle and a set of phandle arguments (so called power domain specifier) >> +of length specified by #power-domain-cells property in the power domain >> +provider node. >> + >> +==Power domain providers== >> + >> +Required properties: >> + - #power-domain-cells : Number of cells in a power domain specifier; >> + Typically 0 for nodes representing a single power domain and 1 for nodes >> + providing multiple power domains (e.g. power controllers), but can be >> + any value as specified by device tree binding documentation of particular >> + provider. >> + >> +Example: >> + >> + power: power-controller@12340000 { >> + compatible = "foo,power-controller"; >> + reg = <0x12340000 0x1000>; >> + #power-domain-cells = <1>; >> + }; >> + >> +The node above defines a power controller that is a power domain provider >> +and expects one cell as its phandle argument. >> + >> +==Power domain consumers== >> + >> +Required properties: >> + - power-domain : A phandle and power domain specifier as defined by bindings >> + of power controller specified by phandle. >> + >> +Example: >> + >> + leaky-device@12350000 { >> + compatible = "foo,i-leak-current"; >> + reg = <0x12350000 0x1000>; >> + power-domain = <&power 0>; >> + }; >> + >> +The node above defines a typical power domain consumer device, which is located >> +inside power domain with index 0 of power controller represented by node with >> +label "power". > > Does this allow nesting of power domains? E.g. you have a PD which is > represented by some programmable power supply, and within this domain > smaller islands/domains that can be gated independently. These are client-side bindings only, i.e. power domain providers and consumers. Registering power domains and relations between them are up to platform-specific code, e.g. power controller driver. Best regards, Tomasz
On 3 March 2014 17:02, Tomasz Figa <tomasz.figa@gmail.com> wrote: > This patch introduces generic code to perform power domain look-up using > device tree and automatically bind devices to their power domains. > Generic device tree binding is introduced to specify power domains of > devices in their device tree nodes. > > Backwards compatibility with legacy Samsung-specific power domain > bindings is provided, but for now the new code is not compiled when > CONFIG_ARCH_EXYNOS is selected to avoid collision with legacy code. This > will change as soon as Exynos power domain code gets converted to use > the generic framework in further patch. > > Signed-off-by: Tomasz Figa <tomasz.figa@gmail.com> > --- > .../devicetree/bindings/power/power_domain.txt | 51 ++++ > drivers/base/power/domain.c | 298 +++++++++++++++++++++ > include/linux/pm_domain.h | 46 ++++ > kernel/power/Kconfig | 4 + > 4 files changed, 399 insertions(+) > create mode 100644 Documentation/devicetree/bindings/power/power_domain.txt > > diff --git a/Documentation/devicetree/bindings/power/power_domain.txt b/Documentation/devicetree/bindings/power/power_domain.txt > new file mode 100644 > index 0000000..93be5d9 > --- /dev/null > +++ b/Documentation/devicetree/bindings/power/power_domain.txt > @@ -0,0 +1,51 @@ > +* Generic power domains > + > +System on chip designs are often divided into multiple power domains that > +can be used for power gating of selected IP blocks for power saving by > +reduced leakage current. > + > +This device tree binding can be used to bind power domain consumer devices > +with their power domains provided by power domain providers. A power domain > +provider can be represented by any node in the device tree and can provide > +one or more power domains. A consumer node can refer to the provider by > +a phandle and a set of phandle arguments (so called power domain specifier) > +of length specified by #power-domain-cells property in the power domain > +provider node. > + > +==Power domain providers== > + > +Required properties: > + - #power-domain-cells : Number of cells in a power domain specifier; > + Typically 0 for nodes representing a single power domain and 1 for nodes > + providing multiple power domains (e.g. power controllers), but can be > + any value as specified by device tree binding documentation of particular > + provider. I am trying to understand if using a value > 1, ever would make sense. Wouldn't that mean each consumer (device) would actually be a part of more than one power domain? That won't work, right!? Additionally, there are no corresponding parsing method (like of_genpd_xlate_onecell() ) that support more than one cell. Kind regards Ulf Hansson > + > +Example: > + > + power: power-controller@12340000 { > + compatible = "foo,power-controller"; > + reg = <0x12340000 0x1000>; > + #power-domain-cells = <1>; > + }; > + > +The node above defines a power controller that is a power domain provider > +and expects one cell as its phandle argument. > + > +==Power domain consumers== > + > +Required properties: > + - power-domain : A phandle and power domain specifier as defined by bindings > + of power controller specified by phandle. > + > +Example: > + > + leaky-device@12350000 { > + compatible = "foo,i-leak-current"; > + reg = <0x12350000 0x1000>; > + power-domain = <&power 0>; > + }; > + > +The node above defines a typical power domain consumer device, which is located > +inside power domain with index 0 of power controller represented by node with > +label "power". > diff --git a/drivers/base/power/domain.c b/drivers/base/power/domain.c > index dc127e5..006b455 100644 > --- a/drivers/base/power/domain.c > +++ b/drivers/base/power/domain.c > @@ -3,12 +3,16 @@ > * > * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp. > * > + * Support for Device Tree based power domain providers: > + * Copyright (C) 2014 Tomasz Figa <tomasz.figa@gmail.com> > + * > * This file is released under the GPLv2. > */ > > #include <linux/init.h> > #include <linux/kernel.h> > #include <linux/io.h> > +#include <linux/platform_device.h> > #include <linux/pm_runtime.h> > #include <linux/pm_domain.h> > #include <linux/pm_qos.h> > @@ -2177,3 +2181,297 @@ void pm_genpd_init(struct generic_pm_domain *genpd, > list_add(&genpd->gpd_list_node, &gpd_list); > mutex_unlock(&gpd_list_lock); > } > + > +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF > +/* > + * DEVICE TREE BASED POWER DOMAIN PROVIDERS > + * > + * The code below implements generic device tree based power domain providers > + * that bind device tree nodes with generic power domains registered in the > + * system. > + * > + * Any driver that registers generic power domains and need to support binding > + * of devices to these domains is supposed to register a power domain provider, > + * which maps a power domain specifier retrieved from device tree to a power > + * domain. > + * > + * Two simple mapping functions have been provided for convenience: > + * - of_genpd_xlate_simple() for 1:1 device tree node to domain mapping, > + * - of_genpd_xlate_onecell() for mapping of multiple domains per node > + * by index. > + */ > + > +/** > + * struct of_genpd_provider - Power domain provider registration structure > + * @link: Entry in global list of domain providers > + * @node: Pointer to device tree node of domain provider > + * @xlate: Provider-specific xlate callback mapping a set of specifier cells > + * into a power domain. > + * @data: context pointer to be passed into @xlate callback > + */ > +struct of_genpd_provider { > + struct list_head link; > + > + struct device_node *node; > + genpd_xlate_t xlate; > + void *data; > +}; > + > +/* List of registered power domain providers. */ > +static LIST_HEAD(of_genpd_providers); > +/* Mutex to protect the list above. */ > +static DEFINE_MUTEX(of_genpd_mutex); > + > +/** > + * of_genpd_xlate_simple() - Xlate function for direct node-domain mapping > + * @genpdspec: OF phandle args to map into a power domain > + * @data: xlate function private data - pointer to struct generic_pm_domain > + * > + * This is a generic xlate function that can be used to model power domains > + * that have their own device tree nodes. The private data of xlate function > + * needs to be a valid pointer to struct generic_pm_domain. > + */ > +struct generic_pm_domain *of_genpd_xlate_simple( > + struct of_phandle_args *genpdspec, > + void *data) > +{ > + if (genpdspec->args_count != 0) > + return ERR_PTR(-EINVAL); > + return data; > +} > +EXPORT_SYMBOL_GPL(of_genpd_xlate_simple); > + > +/** > + * of_genpd_xlate_onecell() - Xlate function for providers using single index. > + * @genpdspec: OF phandle args to map into a power domain > + * @data: xlate function private data - pointer to struct genpd_onecell_data > + * > + * This is a generic xlate function that can be used to model simple power > + * domain controllers that have one device tree node and provide multiple > + * power domains. A single cell is used as an index to an array of power > + * domains specified in genpd_onecell_data struct when registering the > + * provider. > + */ > +struct generic_pm_domain *of_genpd_xlate_onecell( > + struct of_phandle_args *genpdspec, > + void *data) > +{ > + struct genpd_onecell_data *genpd_data = data; > + unsigned int idx = genpdspec->args[0]; > + > + if (genpdspec->args_count != 1) > + return ERR_PTR(-EINVAL); > + > + if (idx >= genpd_data->domain_num) { > + pr_err("%s: invalid domain index %d\n", __func__, idx); > + return ERR_PTR(-EINVAL); > + } > + > + return genpd_data->domains[idx]; > +} > +EXPORT_SYMBOL_GPL(of_genpd_xlate_onecell); > + > +/** > + * of_genpd_add_provider() - Register a domain provider for a node > + * @np: Device node pointer associated with domain provider. > + * @xlate: Callback for decoding domain from phandle arguments. > + * @data: Context pointer for @genpd_src_get callback. > + */ > +int of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, > + void *data) > +{ > + struct of_genpd_provider *cp; > + > + cp = kzalloc(sizeof(*cp), GFP_KERNEL); > + if (!cp) > + return -ENOMEM; > + > + cp->node = of_node_get(np); > + cp->data = data; > + cp->xlate = xlate; > + > + mutex_lock(&of_genpd_mutex); > + list_add(&cp->link, &of_genpd_providers); > + mutex_unlock(&of_genpd_mutex); > + pr_debug("Added domain provider from %s\n", np->full_name); > + > + return 0; > +} > +EXPORT_SYMBOL_GPL(of_genpd_add_provider); > + > +/** > + * of_genpd_del_provider() - Remove a previously registered domain provider > + * @np: Device node pointer associated with domain provider > + */ > +void of_genpd_del_provider(struct device_node *np) > +{ > + struct of_genpd_provider *cp; > + > + mutex_lock(&of_genpd_mutex); > + list_for_each_entry(cp, &of_genpd_providers, link) { > + if (cp->node == np) { > + list_del(&cp->link); > + of_node_put(cp->node); > + kfree(cp); > + break; > + } > + } > + mutex_unlock(&of_genpd_mutex); > +} > +EXPORT_SYMBOL_GPL(of_genpd_del_provider); > + > +/* See of_genpd_get_from_provider(). */ > +static struct generic_pm_domain *__of_genpd_get_from_provider( > + struct of_phandle_args *genpdspec) > +{ > + struct of_genpd_provider *provider; > + struct generic_pm_domain *genpd = ERR_PTR(-EPROBE_DEFER); > + > + /* Check if we have such a provider in our array */ > + list_for_each_entry(provider, &of_genpd_providers, link) { > + if (provider->node == genpdspec->np) > + genpd = provider->xlate(genpdspec, provider->data); > + if (!IS_ERR(genpd)) > + break; > + } > + > + return genpd; > +} > + > +/** > + * of_genpd_get_from_provider() - Look-up power domain > + * @genpdspec: OF phandle args to use for look-up > + * > + * Looks for domain provider under node specified by @genpdspec and if found > + * uses xlate function of the provider to map phandle args to a power domain. > + * > + * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR() > + * on failure. > + */ > +static struct generic_pm_domain *of_genpd_get_from_provider( > + struct of_phandle_args *genpdspec) > +{ > + struct generic_pm_domain *genpd; > + > + mutex_lock(&of_genpd_mutex); > + genpd = __of_genpd_get_from_provider(genpdspec); > + mutex_unlock(&of_genpd_mutex); > + > + return genpd; > +} > + > +/* > + * DEVICE<->DOMAIN BINDING USING DEVICE TREE LOOK-UP > + * > + * The code below registers a notifier for platform bus devices' > + * BUS_NOTIFY_BIND_DRIVER events and tries to attach devices to their power > + * domains by looking them up using Device Tree. > + * > + * Similarly in BUS_NOTIFY_UNBOUND_DRIVER the device is detached from its > + * domain, since it no longer supports runtime PM without any driver bound > + * to it. > + * > + * Both generic and legacy Samsung-specific DT bindings are supported to > + * keep backwards compatibility with existing DTBs. > + */ > + > +/** > + * genpd_bind_domain - Bind device to its power domain using Device Tree. > + * @dev: Device to bind to its power domain. > + * > + * Tries to parse power domain specifier from device's OF node and if succeeds > + * attaches the device to retrieved power domain. > + * > + * Returns 0 on success or negative error code otherwise. > + */ > +int genpd_bind_domain(struct device *dev) > +{ > + struct of_phandle_args pd_args; > + struct generic_pm_domain *pd; > + int ret; > + > + if (!dev->of_node) > + return 0; > + > + ret = of_parse_phandle_with_args(dev->of_node, "power-domain", > + "#power-domain-cells", 0, &pd_args); > + if (ret < 0) { > + if (ret != -ENOENT) > + return ret; > + > + /* > + * Try legacy Samsung-specific bindings > + * (for backwards compatibility of DT ABI) > + */ > + pd_args.args_count = 0; > + pd_args.np = of_parse_phandle(dev->of_node, > + "samsung,power-domain", 0); > + if (!pd_args.np) > + return 0; > + } > + > + pd = of_genpd_get_from_provider(&pd_args); > + if (IS_ERR(pd)) { > + if (PTR_ERR(pd) != -EPROBE_DEFER) > + dev_err(dev, "failed to find power domain: %ld\n", > + PTR_ERR(pd)); > + return PTR_ERR(pd); > + } > + > + dev_dbg(dev, "adding to power domain %s\n", pd->name); > + > + while (1) { > + ret = pm_genpd_add_device(pd, dev); > + if (ret != -EAGAIN) > + break; > + cond_resched(); > + } > + > + if (ret < 0) { > + dev_err(dev, "failed to add to power domain %s: %d", > + pd->name, ret); > + return ret; > + } > + > + pm_genpd_dev_need_restore(dev, true); > + > + return 0; > +} > + > +/** > + * genpd_unbind_domain - Unbind device from its power domain. > + * @dev: Device to unbind from its power domain. > + * > + * Unbinds device from power domain previously bound to it. > + * > + * Returns 0 on success or negative error code otherwise. > + */ > +int genpd_unbind_domain(struct device *dev) > +{ > + struct generic_pm_domain *pd = dev_to_genpd(dev); > + int ret; > + > + if (!dev->of_node || IS_ERR(pd)) > + return 0; > + > + dev_dbg(dev, "removing from power domain %s\n", pd->name); > + > + while (1) { > + ret = pm_genpd_remove_device(pd, dev); > + if (ret != -EAGAIN) > + break; > + cond_resched(); > + } > + > + if (ret < 0) { > + dev_err(dev, "failed to remove from power domain %s: %d", > + pd->name, ret); > + return ret; > + } > + > + /* Check if domain can be powered off after removing this device. */ > + genpd_queue_power_off_work(pd); > + > + return 0; > +} > +#endif > diff --git a/include/linux/pm_domain.h b/include/linux/pm_domain.h > index 7c1d252..04473d4 100644 > --- a/include/linux/pm_domain.h > +++ b/include/linux/pm_domain.h > @@ -310,4 +310,50 @@ static inline void pm_genpd_syscore_poweron(struct device *dev) > pm_genpd_syscore_switch(dev, false); > } > > +/* OF power domain providers */ > +struct of_device_id; > + > +struct genpd_onecell_data { > + struct generic_pm_domain **domains; > + unsigned int domain_num; > +}; > + > +typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args, > + void *data); > + > +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF > +int of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, > + void *data); > +void of_genpd_del_provider(struct device_node *np); > + > +struct generic_pm_domain *of_genpd_xlate_simple( > + struct of_phandle_args *genpdspec, > + void *data); > +struct generic_pm_domain *of_genpd_xlate_onecell( > + struct of_phandle_args *genpdspec, > + void *data); > + > +int genpd_bind_domain(struct device *dev); > +int genpd_unbind_domain(struct device *dev); > +#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ > +static inline int of_genpd_add_provider(struct device_node *np, > + genpd_xlate_t xlate, void *data) > +{ > + return 0; > +} > +static inline void of_genpd_del_provider(struct device_node *np) {} > + > +#define of_genpd_xlate_simple NULL > +#define of_genpd_xlate_onecell NULL > + > +static inline int genpd_bind_domain(struct device *dev) > +{ > + return 0; > +} > +static inline int genpd_unbind_domain(struct device *dev) > +{ > + return 0; > +} > +#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ > + > #endif /* _LINUX_PM_DOMAIN_H */ > diff --git a/kernel/power/Kconfig b/kernel/power/Kconfig > index 2fac9cc..45aa98e 100644 > --- a/kernel/power/Kconfig > +++ b/kernel/power/Kconfig > @@ -306,6 +306,10 @@ config PM_GENERIC_DOMAINS_RUNTIME > def_bool y > depends on PM_RUNTIME && PM_GENERIC_DOMAINS > > +config PM_GENERIC_DOMAINS_OF > + def_bool y > + depends on PM_GENERIC_DOMAINS && OF && !ARCH_EXYNOS > + > config CPU_PM > bool > depends on SUSPEND || CPU_IDLE > -- > 1.9.0 >
Hi Ulf, On 03.04.2014 14:16, Ulf Hansson wrote: > On 3 March 2014 17:02, Tomasz Figa <tomasz.figa@gmail.com> wrote: >> This patch introduces generic code to perform power domain look-up using >> device tree and automatically bind devices to their power domains. >> Generic device tree binding is introduced to specify power domains of >> devices in their device tree nodes. >> >> Backwards compatibility with legacy Samsung-specific power domain >> bindings is provided, but for now the new code is not compiled when >> CONFIG_ARCH_EXYNOS is selected to avoid collision with legacy code. This >> will change as soon as Exynos power domain code gets converted to use >> the generic framework in further patch. >> >> Signed-off-by: Tomasz Figa <tomasz.figa@gmail.com> >> --- >> .../devicetree/bindings/power/power_domain.txt | 51 ++++ >> drivers/base/power/domain.c | 298 +++++++++++++++++++++ >> include/linux/pm_domain.h | 46 ++++ >> kernel/power/Kconfig | 4 + >> 4 files changed, 399 insertions(+) >> create mode 100644 Documentation/devicetree/bindings/power/power_domain.txt >> >> diff --git a/Documentation/devicetree/bindings/power/power_domain.txt b/Documentation/devicetree/bindings/power/power_domain.txt >> new file mode 100644 >> index 0000000..93be5d9 >> --- /dev/null >> +++ b/Documentation/devicetree/bindings/power/power_domain.txt >> @@ -0,0 +1,51 @@ >> +* Generic power domains >> + >> +System on chip designs are often divided into multiple power domains that >> +can be used for power gating of selected IP blocks for power saving by >> +reduced leakage current. >> + >> +This device tree binding can be used to bind power domain consumer devices >> +with their power domains provided by power domain providers. A power domain >> +provider can be represented by any node in the device tree and can provide >> +one or more power domains. A consumer node can refer to the provider by >> +a phandle and a set of phandle arguments (so called power domain specifier) >> +of length specified by #power-domain-cells property in the power domain >> +provider node. >> + >> +==Power domain providers== >> + >> +Required properties: >> + - #power-domain-cells : Number of cells in a power domain specifier; >> + Typically 0 for nodes representing a single power domain and 1 for nodes >> + providing multiple power domains (e.g. power controllers), but can be >> + any value as specified by device tree binding documentation of particular >> + provider. > > I am trying to understand if using a value > 1, ever would make sense. > Wouldn't that mean each consumer (device) would actually be a part of > more than one power domain? That won't work, right!? Not exactly. Each phandle + #power-domain-cells cells are used just for single power domain. The cells here are used merely as the identifier used by power domain driver to translate a power domain specifier from DT to a kernel pointer. It's up to driver bindings to select the number of cells to properly identify a power domain. As an example (from different world, but showing the same mechanism), let's see a common pattern of GPIO banks on some SoC: GPA0 GPA1 GPB0 GPB1 GPC0 GPC1 One might assign a single-cell ID to each bank ending with a namespace of integers from 0 to 5 that would be used as follows: #define GPA0 0 #define GPA1 1 #define GPB0 2 #define GPB1 3 #define GPC0 4 #define GPC1 5 reset-gpios = <&gpio GPA0 4>; However one might also consider assigning one cell to bank set (e.g. GPA) and one cell to identify the bank inside of a set, like on the following example: #define GPA 0 #define GPB 1 #define GPC 2 reset-gpios = <&gpio GPA 0 4>; Good bindings should allow arbitrary identification schemes to let a driver developer use the one that suits the hardware he's working on. > > Additionally, there are no corresponding parsing method (like > of_genpd_xlate_onecell() ) that support more than one cell. There are two generic xlate helpers provided for the most common cases that are likely to be reused by most drivers. For more complex cases it's up to the driver to implement its own mapping function. It can be promoted to a generic one later if such need shows up. Best regards, Tomasz
On 3 April 2014 14:30, Tomasz Figa <tomasz.figa@gmail.com> wrote: > Hi Ulf, > > > On 03.04.2014 14:16, Ulf Hansson wrote: >> >> On 3 March 2014 17:02, Tomasz Figa <tomasz.figa@gmail.com> wrote: >>> >>> This patch introduces generic code to perform power domain look-up using >>> device tree and automatically bind devices to their power domains. >>> Generic device tree binding is introduced to specify power domains of >>> devices in their device tree nodes. >>> >>> Backwards compatibility with legacy Samsung-specific power domain >>> bindings is provided, but for now the new code is not compiled when >>> CONFIG_ARCH_EXYNOS is selected to avoid collision with legacy code. This >>> will change as soon as Exynos power domain code gets converted to use >>> the generic framework in further patch. >>> >>> Signed-off-by: Tomasz Figa <tomasz.figa@gmail.com> >>> --- >>> .../devicetree/bindings/power/power_domain.txt | 51 ++++ >>> drivers/base/power/domain.c | 298 >>> +++++++++++++++++++++ >>> include/linux/pm_domain.h | 46 ++++ >>> kernel/power/Kconfig | 4 + >>> 4 files changed, 399 insertions(+) >>> create mode 100644 >>> Documentation/devicetree/bindings/power/power_domain.txt >>> >>> diff --git a/Documentation/devicetree/bindings/power/power_domain.txt >>> b/Documentation/devicetree/bindings/power/power_domain.txt >>> new file mode 100644 >>> index 0000000..93be5d9 >>> --- /dev/null >>> +++ b/Documentation/devicetree/bindings/power/power_domain.txt >>> @@ -0,0 +1,51 @@ >>> +* Generic power domains >>> + >>> +System on chip designs are often divided into multiple power domains >>> that >>> +can be used for power gating of selected IP blocks for power saving by >>> +reduced leakage current. >>> + >>> +This device tree binding can be used to bind power domain consumer >>> devices >>> +with their power domains provided by power domain providers. A power >>> domain >>> +provider can be represented by any node in the device tree and can >>> provide >>> +one or more power domains. A consumer node can refer to the provider by >>> +a phandle and a set of phandle arguments (so called power domain >>> specifier) >>> +of length specified by #power-domain-cells property in the power domain >>> +provider node. >>> + >>> +==Power domain providers== >>> + >>> +Required properties: >>> + - #power-domain-cells : Number of cells in a power domain specifier; >>> + Typically 0 for nodes representing a single power domain and 1 for >>> nodes >>> + providing multiple power domains (e.g. power controllers), but can be >>> + any value as specified by device tree binding documentation of >>> particular >>> + provider. >> >> >> I am trying to understand if using a value > 1, ever would make sense. >> Wouldn't that mean each consumer (device) would actually be a part of >> more than one power domain? That won't work, right!? > > > Not exactly. Each phandle + #power-domain-cells cells are used just for > single power domain. > > The cells here are used merely as the identifier used by power domain driver > to translate a power domain specifier from DT to a kernel pointer. It's up > to driver bindings to select the number of cells to properly identify a > power domain. > > As an example (from different world, but showing the same mechanism), let's > see a common pattern of GPIO banks on some SoC: > > GPA0 > GPA1 > GPB0 > GPB1 > GPC0 > GPC1 > > One might assign a single-cell ID to each bank ending with a namespace of > integers from 0 to 5 that would be used as follows: > > #define GPA0 0 > #define GPA1 1 > #define GPB0 2 > #define GPB1 3 > #define GPC0 4 > #define GPC1 5 > > reset-gpios = <&gpio GPA0 4>; > > However one might also consider assigning one cell to bank set (e.g. GPA) > and one cell to identify the bank inside of a set, like on the following > example: > > #define GPA 0 > #define GPB 1 > #define GPC 2 > > reset-gpios = <&gpio GPA 0 4>; > > Good bindings should allow arbitrary identification schemes to let a driver > developer use the one that suits the hardware he's working on. > > >> >> Additionally, there are no corresponding parsing method (like >> of_genpd_xlate_onecell() ) that support more than one cell. > > > There are two generic xlate helpers provided for the most common cases that > are likely to be reused by most drivers. For more complex cases it's up to > the driver to implement its own mapping function. It can be promoted to a > generic one later if such need shows up. > > Best regards, > Tomasz Tomasz, thanks for the clarification! I still have more to learn about DT. :-) Not sure if some additional comments would make this more clear though - or if it's juts my untrained eye that had a few problems understanding. Kind regards Ulf Hansson
diff --git a/Documentation/devicetree/bindings/power/power_domain.txt b/Documentation/devicetree/bindings/power/power_domain.txt new file mode 100644 index 0000000..93be5d9 --- /dev/null +++ b/Documentation/devicetree/bindings/power/power_domain.txt @@ -0,0 +1,51 @@ +* Generic power domains + +System on chip designs are often divided into multiple power domains that +can be used for power gating of selected IP blocks for power saving by +reduced leakage current. + +This device tree binding can be used to bind power domain consumer devices +with their power domains provided by power domain providers. A power domain +provider can be represented by any node in the device tree and can provide +one or more power domains. A consumer node can refer to the provider by +a phandle and a set of phandle arguments (so called power domain specifier) +of length specified by #power-domain-cells property in the power domain +provider node. + +==Power domain providers== + +Required properties: + - #power-domain-cells : Number of cells in a power domain specifier; + Typically 0 for nodes representing a single power domain and 1 for nodes + providing multiple power domains (e.g. power controllers), but can be + any value as specified by device tree binding documentation of particular + provider. + +Example: + + power: power-controller@12340000 { + compatible = "foo,power-controller"; + reg = <0x12340000 0x1000>; + #power-domain-cells = <1>; + }; + +The node above defines a power controller that is a power domain provider +and expects one cell as its phandle argument. + +==Power domain consumers== + +Required properties: + - power-domain : A phandle and power domain specifier as defined by bindings + of power controller specified by phandle. + +Example: + + leaky-device@12350000 { + compatible = "foo,i-leak-current"; + reg = <0x12350000 0x1000>; + power-domain = <&power 0>; + }; + +The node above defines a typical power domain consumer device, which is located +inside power domain with index 0 of power controller represented by node with +label "power". diff --git a/drivers/base/power/domain.c b/drivers/base/power/domain.c index dc127e5..006b455 100644 --- a/drivers/base/power/domain.c +++ b/drivers/base/power/domain.c @@ -3,12 +3,16 @@ * * Copyright (C) 2011 Rafael J. Wysocki <rjw@sisk.pl>, Renesas Electronics Corp. * + * Support for Device Tree based power domain providers: + * Copyright (C) 2014 Tomasz Figa <tomasz.figa@gmail.com> + * * This file is released under the GPLv2. */ #include <linux/init.h> #include <linux/kernel.h> #include <linux/io.h> +#include <linux/platform_device.h> #include <linux/pm_runtime.h> #include <linux/pm_domain.h> #include <linux/pm_qos.h> @@ -2177,3 +2181,297 @@ void pm_genpd_init(struct generic_pm_domain *genpd, list_add(&genpd->gpd_list_node, &gpd_list); mutex_unlock(&gpd_list_lock); } + +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF +/* + * DEVICE TREE BASED POWER DOMAIN PROVIDERS + * + * The code below implements generic device tree based power domain providers + * that bind device tree nodes with generic power domains registered in the + * system. + * + * Any driver that registers generic power domains and need to support binding + * of devices to these domains is supposed to register a power domain provider, + * which maps a power domain specifier retrieved from device tree to a power + * domain. + * + * Two simple mapping functions have been provided for convenience: + * - of_genpd_xlate_simple() for 1:1 device tree node to domain mapping, + * - of_genpd_xlate_onecell() for mapping of multiple domains per node + * by index. + */ + +/** + * struct of_genpd_provider - Power domain provider registration structure + * @link: Entry in global list of domain providers + * @node: Pointer to device tree node of domain provider + * @xlate: Provider-specific xlate callback mapping a set of specifier cells + * into a power domain. + * @data: context pointer to be passed into @xlate callback + */ +struct of_genpd_provider { + struct list_head link; + + struct device_node *node; + genpd_xlate_t xlate; + void *data; +}; + +/* List of registered power domain providers. */ +static LIST_HEAD(of_genpd_providers); +/* Mutex to protect the list above. */ +static DEFINE_MUTEX(of_genpd_mutex); + +/** + * of_genpd_xlate_simple() - Xlate function for direct node-domain mapping + * @genpdspec: OF phandle args to map into a power domain + * @data: xlate function private data - pointer to struct generic_pm_domain + * + * This is a generic xlate function that can be used to model power domains + * that have their own device tree nodes. The private data of xlate function + * needs to be a valid pointer to struct generic_pm_domain. + */ +struct generic_pm_domain *of_genpd_xlate_simple( + struct of_phandle_args *genpdspec, + void *data) +{ + if (genpdspec->args_count != 0) + return ERR_PTR(-EINVAL); + return data; +} +EXPORT_SYMBOL_GPL(of_genpd_xlate_simple); + +/** + * of_genpd_xlate_onecell() - Xlate function for providers using single index. + * @genpdspec: OF phandle args to map into a power domain + * @data: xlate function private data - pointer to struct genpd_onecell_data + * + * This is a generic xlate function that can be used to model simple power + * domain controllers that have one device tree node and provide multiple + * power domains. A single cell is used as an index to an array of power + * domains specified in genpd_onecell_data struct when registering the + * provider. + */ +struct generic_pm_domain *of_genpd_xlate_onecell( + struct of_phandle_args *genpdspec, + void *data) +{ + struct genpd_onecell_data *genpd_data = data; + unsigned int idx = genpdspec->args[0]; + + if (genpdspec->args_count != 1) + return ERR_PTR(-EINVAL); + + if (idx >= genpd_data->domain_num) { + pr_err("%s: invalid domain index %d\n", __func__, idx); + return ERR_PTR(-EINVAL); + } + + return genpd_data->domains[idx]; +} +EXPORT_SYMBOL_GPL(of_genpd_xlate_onecell); + +/** + * of_genpd_add_provider() - Register a domain provider for a node + * @np: Device node pointer associated with domain provider. + * @xlate: Callback for decoding domain from phandle arguments. + * @data: Context pointer for @genpd_src_get callback. + */ +int of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, + void *data) +{ + struct of_genpd_provider *cp; + + cp = kzalloc(sizeof(*cp), GFP_KERNEL); + if (!cp) + return -ENOMEM; + + cp->node = of_node_get(np); + cp->data = data; + cp->xlate = xlate; + + mutex_lock(&of_genpd_mutex); + list_add(&cp->link, &of_genpd_providers); + mutex_unlock(&of_genpd_mutex); + pr_debug("Added domain provider from %s\n", np->full_name); + + return 0; +} +EXPORT_SYMBOL_GPL(of_genpd_add_provider); + +/** + * of_genpd_del_provider() - Remove a previously registered domain provider + * @np: Device node pointer associated with domain provider + */ +void of_genpd_del_provider(struct device_node *np) +{ + struct of_genpd_provider *cp; + + mutex_lock(&of_genpd_mutex); + list_for_each_entry(cp, &of_genpd_providers, link) { + if (cp->node == np) { + list_del(&cp->link); + of_node_put(cp->node); + kfree(cp); + break; + } + } + mutex_unlock(&of_genpd_mutex); +} +EXPORT_SYMBOL_GPL(of_genpd_del_provider); + +/* See of_genpd_get_from_provider(). */ +static struct generic_pm_domain *__of_genpd_get_from_provider( + struct of_phandle_args *genpdspec) +{ + struct of_genpd_provider *provider; + struct generic_pm_domain *genpd = ERR_PTR(-EPROBE_DEFER); + + /* Check if we have such a provider in our array */ + list_for_each_entry(provider, &of_genpd_providers, link) { + if (provider->node == genpdspec->np) + genpd = provider->xlate(genpdspec, provider->data); + if (!IS_ERR(genpd)) + break; + } + + return genpd; +} + +/** + * of_genpd_get_from_provider() - Look-up power domain + * @genpdspec: OF phandle args to use for look-up + * + * Looks for domain provider under node specified by @genpdspec and if found + * uses xlate function of the provider to map phandle args to a power domain. + * + * Returns a valid pointer to struct generic_pm_domain on success or ERR_PTR() + * on failure. + */ +static struct generic_pm_domain *of_genpd_get_from_provider( + struct of_phandle_args *genpdspec) +{ + struct generic_pm_domain *genpd; + + mutex_lock(&of_genpd_mutex); + genpd = __of_genpd_get_from_provider(genpdspec); + mutex_unlock(&of_genpd_mutex); + + return genpd; +} + +/* + * DEVICE<->DOMAIN BINDING USING DEVICE TREE LOOK-UP + * + * The code below registers a notifier for platform bus devices' + * BUS_NOTIFY_BIND_DRIVER events and tries to attach devices to their power + * domains by looking them up using Device Tree. + * + * Similarly in BUS_NOTIFY_UNBOUND_DRIVER the device is detached from its + * domain, since it no longer supports runtime PM without any driver bound + * to it. + * + * Both generic and legacy Samsung-specific DT bindings are supported to + * keep backwards compatibility with existing DTBs. + */ + +/** + * genpd_bind_domain - Bind device to its power domain using Device Tree. + * @dev: Device to bind to its power domain. + * + * Tries to parse power domain specifier from device's OF node and if succeeds + * attaches the device to retrieved power domain. + * + * Returns 0 on success or negative error code otherwise. + */ +int genpd_bind_domain(struct device *dev) +{ + struct of_phandle_args pd_args; + struct generic_pm_domain *pd; + int ret; + + if (!dev->of_node) + return 0; + + ret = of_parse_phandle_with_args(dev->of_node, "power-domain", + "#power-domain-cells", 0, &pd_args); + if (ret < 0) { + if (ret != -ENOENT) + return ret; + + /* + * Try legacy Samsung-specific bindings + * (for backwards compatibility of DT ABI) + */ + pd_args.args_count = 0; + pd_args.np = of_parse_phandle(dev->of_node, + "samsung,power-domain", 0); + if (!pd_args.np) + return 0; + } + + pd = of_genpd_get_from_provider(&pd_args); + if (IS_ERR(pd)) { + if (PTR_ERR(pd) != -EPROBE_DEFER) + dev_err(dev, "failed to find power domain: %ld\n", + PTR_ERR(pd)); + return PTR_ERR(pd); + } + + dev_dbg(dev, "adding to power domain %s\n", pd->name); + + while (1) { + ret = pm_genpd_add_device(pd, dev); + if (ret != -EAGAIN) + break; + cond_resched(); + } + + if (ret < 0) { + dev_err(dev, "failed to add to power domain %s: %d", + pd->name, ret); + return ret; + } + + pm_genpd_dev_need_restore(dev, true); + + return 0; +} + +/** + * genpd_unbind_domain - Unbind device from its power domain. + * @dev: Device to unbind from its power domain. + * + * Unbinds device from power domain previously bound to it. + * + * Returns 0 on success or negative error code otherwise. + */ +int genpd_unbind_domain(struct device *dev) +{ + struct generic_pm_domain *pd = dev_to_genpd(dev); + int ret; + + if (!dev->of_node || IS_ERR(pd)) + return 0; + + dev_dbg(dev, "removing from power domain %s\n", pd->name); + + while (1) { + ret = pm_genpd_remove_device(pd, dev); + if (ret != -EAGAIN) + break; + cond_resched(); + } + + if (ret < 0) { + dev_err(dev, "failed to remove from power domain %s: %d", + pd->name, ret); + return ret; + } + + /* Check if domain can be powered off after removing this device. */ + genpd_queue_power_off_work(pd); + + return 0; +} +#endif diff --git a/include/linux/pm_domain.h b/include/linux/pm_domain.h index 7c1d252..04473d4 100644 --- a/include/linux/pm_domain.h +++ b/include/linux/pm_domain.h @@ -310,4 +310,50 @@ static inline void pm_genpd_syscore_poweron(struct device *dev) pm_genpd_syscore_switch(dev, false); } +/* OF power domain providers */ +struct of_device_id; + +struct genpd_onecell_data { + struct generic_pm_domain **domains; + unsigned int domain_num; +}; + +typedef struct generic_pm_domain *(*genpd_xlate_t)(struct of_phandle_args *args, + void *data); + +#ifdef CONFIG_PM_GENERIC_DOMAINS_OF +int of_genpd_add_provider(struct device_node *np, genpd_xlate_t xlate, + void *data); +void of_genpd_del_provider(struct device_node *np); + +struct generic_pm_domain *of_genpd_xlate_simple( + struct of_phandle_args *genpdspec, + void *data); +struct generic_pm_domain *of_genpd_xlate_onecell( + struct of_phandle_args *genpdspec, + void *data); + +int genpd_bind_domain(struct device *dev); +int genpd_unbind_domain(struct device *dev); +#else /* !CONFIG_PM_GENERIC_DOMAINS_OF */ +static inline int of_genpd_add_provider(struct device_node *np, + genpd_xlate_t xlate, void *data) +{ + return 0; +} +static inline void of_genpd_del_provider(struct device_node *np) {} + +#define of_genpd_xlate_simple NULL +#define of_genpd_xlate_onecell NULL + +static inline int genpd_bind_domain(struct device *dev) +{ + return 0; +} +static inline int genpd_unbind_domain(struct device *dev) +{ + return 0; +} +#endif /* CONFIG_PM_GENERIC_DOMAINS_OF */ + #endif /* _LINUX_PM_DOMAIN_H */ diff --git a/kernel/power/Kconfig b/kernel/power/Kconfig index 2fac9cc..45aa98e 100644 --- a/kernel/power/Kconfig +++ b/kernel/power/Kconfig @@ -306,6 +306,10 @@ config PM_GENERIC_DOMAINS_RUNTIME def_bool y depends on PM_RUNTIME && PM_GENERIC_DOMAINS +config PM_GENERIC_DOMAINS_OF + def_bool y + depends on PM_GENERIC_DOMAINS && OF && !ARCH_EXYNOS + config CPU_PM bool depends on SUSPEND || CPU_IDLE
This patch introduces generic code to perform power domain look-up using device tree and automatically bind devices to their power domains. Generic device tree binding is introduced to specify power domains of devices in their device tree nodes. Backwards compatibility with legacy Samsung-specific power domain bindings is provided, but for now the new code is not compiled when CONFIG_ARCH_EXYNOS is selected to avoid collision with legacy code. This will change as soon as Exynos power domain code gets converted to use the generic framework in further patch. Signed-off-by: Tomasz Figa <tomasz.figa@gmail.com> --- .../devicetree/bindings/power/power_domain.txt | 51 ++++ drivers/base/power/domain.c | 298 +++++++++++++++++++++ include/linux/pm_domain.h | 46 ++++ kernel/power/Kconfig | 4 + 4 files changed, 399 insertions(+) create mode 100644 Documentation/devicetree/bindings/power/power_domain.txt