2019-10-23 08:27:19

by Ran Wang

[permalink] [raw]
Subject: [PATCH v9 1/3] PM: wakeup: Add routine to help fetch wakeup source object.

Some user might want to go through all registered wakeup sources
and doing things accordingly. For example, SoC PM driver might need to
do HW programming to prevent powering down specific IP which wakeup
source depending on. So add this API to help walk through all registered
wakeup source objects on that list and return them one by one.

Signed-off-by: Ran Wang <[email protected]>
Tested-by: Leonard Crestez <[email protected]>
---
Change in v9:
- Supplement comments for wakeup_sources_read_lock(),
wakeup_sources_read_unlock, wakeup_sources_walk_start and
wakeup_sources_walk_next().

Change in v8:
- Rename wakeup_source_get_next() to wakeup_sources_walk_next().
- Add wakeup_sources_read_lock() to take over locking job of
wakeup_source_get_star().
- Rename wakeup_source_get_start() to wakeup_sources_walk_start().
- Replace wakeup_source_get_stop() with wakeup_sources_read_unlock().
- Define macro for_each_wakeup_source(ws).

Change in v7:
- Remove define of member *dev in wake_irq to fix conflict with commit
c8377adfa781 ("PM / wakeup: Show wakeup sources stats in sysfs"), user
will use ws->dev->parent instead.
- Remove '#include <linux/of_device.h>' because it is not used.

Change in v6:
- Add wakeup_source_get_star() and wakeup_source_get_stop() to aligned
with wakeup_sources_stats_seq_start/nex/stop.

Change in v5:
- Update commit message, add decription of walk through all wakeup
source objects.
- Add SCU protection in function wakeup_source_get_next().
- Rename wakeup_source member 'attached_dev' to 'dev' and move it up
(before wakeirq).

Change in v4:
- None.

Change in v3:
- Adjust indentation of *attached_dev;.

Change in v2:
- None.

drivers/base/power/wakeup.c | 54 +++++++++++++++++++++++++++++++++++++++++++++
include/linux/pm_wakeup.h | 9 ++++++++
2 files changed, 63 insertions(+)

diff --git a/drivers/base/power/wakeup.c b/drivers/base/power/wakeup.c
index 5817b51..70a9edb 100644
--- a/drivers/base/power/wakeup.c
+++ b/drivers/base/power/wakeup.c
@@ -248,6 +248,60 @@ void wakeup_source_unregister(struct wakeup_source *ws)
EXPORT_SYMBOL_GPL(wakeup_source_unregister);

/**
+ * wakeup_sources_read_lock - Lock wakeup source list for read.
+ *
+ * Returns an index of srcu lock for struct wakeup_srcu.
+ * This index must be passed to the matching wakeup_sources_read_unlock().
+ */
+int wakeup_sources_read_lock(void)
+{
+ return srcu_read_lock(&wakeup_srcu);
+}
+EXPORT_SYMBOL_GPL(wakeup_sources_read_lock);
+
+/**
+ * wakeup_sources_read_unlock - Unlock wakeup source list.
+ * @idx: return value from corresponding wakeup_sources_read_lock()
+ */
+void wakeup_sources_read_unlock(int idx)
+{
+ srcu_read_unlock(&wakeup_srcu, idx);
+}
+EXPORT_SYMBOL_GPL(wakeup_sources_read_unlock);
+
+/**
+ * wakeup_sources_walk_start - Begin a walk on wakeup source list
+ *
+ * Returns first object of the list of wakeup sources.
+ *
+ * Note that to be safe, wakeup sources list needs to be locked by calling
+ * wakeup_source_read_lock() for this.
+ */
+struct wakeup_source *wakeup_sources_walk_start(void)
+{
+ struct list_head *ws_head = &wakeup_sources;
+
+ return list_entry_rcu(ws_head->next, struct wakeup_source, entry);
+}
+EXPORT_SYMBOL_GPL(wakeup_sources_walk_start);
+
+/**
+ * wakeup_sources_walk_next - Get next wakeup source from the list
+ * @ws: Previous wakeup source object
+ *
+ * Note that to be safe, wakeup sources list needs to be locked by calling
+ * wakeup_source_read_lock() for this.
+ */
+struct wakeup_source *wakeup_sources_walk_next(struct wakeup_source *ws)
+{
+ struct list_head *ws_head = &wakeup_sources;
+
+ return list_next_or_null_rcu(ws_head, &ws->entry,
+ struct wakeup_source, entry);
+}
+EXPORT_SYMBOL_GPL(wakeup_sources_walk_next);
+
+/**
* device_wakeup_attach - Attach a wakeup source object to a device object.
* @dev: Device to handle.
* @ws: Wakeup source object to attach to @dev.
diff --git a/include/linux/pm_wakeup.h b/include/linux/pm_wakeup.h
index 661efa0..aa3da66 100644
--- a/include/linux/pm_wakeup.h
+++ b/include/linux/pm_wakeup.h
@@ -63,6 +63,11 @@ struct wakeup_source {
bool autosleep_enabled:1;
};

+#define for_each_wakeup_source(ws) \
+ for ((ws) = wakeup_sources_walk_start(); \
+ (ws); \
+ (ws) = wakeup_sources_walk_next((ws)))
+
#ifdef CONFIG_PM_SLEEP

/*
@@ -92,6 +97,10 @@ extern void wakeup_source_remove(struct wakeup_source *ws);
extern struct wakeup_source *wakeup_source_register(struct device *dev,
const char *name);
extern void wakeup_source_unregister(struct wakeup_source *ws);
+extern int wakeup_sources_read_lock(void);
+extern void wakeup_sources_read_unlock(int idx);
+extern struct wakeup_source *wakeup_sources_walk_start(void);
+extern struct wakeup_source *wakeup_sources_walk_next(struct wakeup_source *ws);
extern int device_wakeup_enable(struct device *dev);
extern int device_wakeup_disable(struct device *dev);
extern void device_set_wakeup_capable(struct device *dev, bool capable);
--
2.7.4


2019-10-23 08:27:34

by Ran Wang

[permalink] [raw]
Subject: [PATCH v9 2/3] Documentation: dt: binding: fsl: Add 'little-endian' and update Chassis define

By default, QorIQ SoC's RCPM register block is Big Endian. But
there are some exceptions, such as LS1088A and LS2088A, are
Little Endian. So add this optional property to help identify
them.

Actually LS2021A and other Layerscapes won't totally follow Chassis
2.1, so separate them from powerpc SoC.

Signed-off-by: Ran Wang <[email protected]>
Reviewed-by: Rob Herring <[email protected]>
---
Change in v9:
- None

Change in v8:
- None.

Change in v7:
- None.

Change in v6:
- None.

Change in v5:
- Add 'Reviewed-by: Rob Herring <[email protected]>' to commit message.
- Rename property 'fsl,#rcpm-wakeup-cells' to '#fsl,rcpm-wakeup-cells'.
please see https://lore.kernel.org/patchwork/patch/1101022/

Change in v4:
- Adjust indectation of 'ls1021a, ls1012a, ls1043a, ls1046a'.

Change in v3:
- None.

Change in v2:
- None.

Documentation/devicetree/bindings/soc/fsl/rcpm.txt | 14 ++++++++++----
1 file changed, 10 insertions(+), 4 deletions(-)

diff --git a/Documentation/devicetree/bindings/soc/fsl/rcpm.txt b/Documentation/devicetree/bindings/soc/fsl/rcpm.txt
index e284e4e..5a33619 100644
--- a/Documentation/devicetree/bindings/soc/fsl/rcpm.txt
+++ b/Documentation/devicetree/bindings/soc/fsl/rcpm.txt
@@ -5,7 +5,7 @@ and power management.

Required properites:
- reg : Offset and length of the register set of the RCPM block.
- - fsl,#rcpm-wakeup-cells : The number of IPPDEXPCR register cells in the
+ - #fsl,rcpm-wakeup-cells : The number of IPPDEXPCR register cells in the
fsl,rcpm-wakeup property.
- compatible : Must contain a chip-specific RCPM block compatible string
and (if applicable) may contain a chassis-version RCPM compatible
@@ -20,6 +20,7 @@ Required properites:
* "fsl,qoriq-rcpm-1.0": for chassis 1.0 rcpm
* "fsl,qoriq-rcpm-2.0": for chassis 2.0 rcpm
* "fsl,qoriq-rcpm-2.1": for chassis 2.1 rcpm
+ * "fsl,qoriq-rcpm-2.1+": for chassis 2.1+ rcpm

All references to "1.0" and "2.0" refer to the QorIQ chassis version to
which the chip complies.
@@ -27,14 +28,19 @@ Chassis Version Example Chips
--------------- -------------------------------
1.0 p4080, p5020, p5040, p2041, p3041
2.0 t4240, b4860, b4420
-2.1 t1040, ls1021
+2.1 t1040,
+2.1+ ls1021a, ls1012a, ls1043a, ls1046a
+
+Optional properties:
+ - little-endian : RCPM register block is Little Endian. Without it RCPM
+ will be Big Endian (default case).

Example:
The RCPM node for T4240:
rcpm: global-utilities@e2000 {
compatible = "fsl,t4240-rcpm", "fsl,qoriq-rcpm-2.0";
reg = <0xe2000 0x1000>;
- fsl,#rcpm-wakeup-cells = <2>;
+ #fsl,rcpm-wakeup-cells = <2>;
};

* Freescale RCPM Wakeup Source Device Tree Bindings
@@ -44,7 +50,7 @@ can be used as a wakeup source.

- fsl,rcpm-wakeup: Consists of a phandle to the rcpm node and the IPPDEXPCR
register cells. The number of IPPDEXPCR register cells is defined in
- "fsl,#rcpm-wakeup-cells" in the rcpm node. The first register cell is
+ "#fsl,rcpm-wakeup-cells" in the rcpm node. The first register cell is
the bit mask that should be set in IPPDEXPCR0, and the second register
cell is for IPPDEXPCR1, and so on.

--
2.7.4

2019-10-23 12:33:57

by Ran Wang

[permalink] [raw]
Subject: [PATCH v9 3/3] soc: fsl: add RCPM driver

The NXP's QorIQ Processors based on ARM Core have RCPM module
(Run Control and Power Management), which performs system level
tasks associated with power management such as wakeup source control.

This driver depends on PM wakeup source framework which help to
collect wake information.

Signed-off-by: Ran Wang <[email protected]>
---
Change in v9:
- Add kerneldoc for rcpm_pm_prepare().
- Use pr_debug() to replace dev_info(), to print message when decide
skip current wakeup object, this is mainly for debugging (in order
to detect potential improper implementation on device tree which
might cause this skip).
- Refactor looping implementation in rcpm_pm_prepare(), add more
comments to help clarify.

Change in v8:
- Adjust related API usage to meet wakeup.c's update in patch 1/3.
- Add sanity checking for the case of ws->dev or ws->dev->parent
is null.

Change in v7:
- Replace 'ws->dev' with 'ws->dev->parent' to get aligned with
c8377adfa781 ("PM / wakeup: Show wakeup sources stats in sysfs")
- Remove '+obj-y += ftm_alarm.o' since it is wrong.
- Cosmetic work.

Change in v6:
- Adjust related API usage to meet wakeup.c's update in patch 1/3.

Change in v5:
- Fix v4 regression of the return value of wakeup_source_get_next()
didn't pass to ws in while loop.
- Rename wakeup_source member 'attached_dev' to 'dev'.
- Rename property 'fsl,#rcpm-wakeup-cells' to '#fsl,rcpm-wakeup-cells'.
please see https://lore.kernel.org/patchwork/patch/1101022/

Change in v4:
- Remove extra ',' in author line of rcpm.c
- Update usage of wakeup_source_get_next() to be less confusing to the
reader, code logic remain the same.

Change in v3:
- Some whitespace ajdustment.

Change in v2:
- Rebase Kconfig and Makefile update to latest mainline.

drivers/soc/fsl/Kconfig | 8 +++
drivers/soc/fsl/Makefile | 1 +
drivers/soc/fsl/rcpm.c | 148 +++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 157 insertions(+)
create mode 100644 drivers/soc/fsl/rcpm.c

diff --git a/drivers/soc/fsl/Kconfig b/drivers/soc/fsl/Kconfig
index f9ad8ad..4918856 100644
--- a/drivers/soc/fsl/Kconfig
+++ b/drivers/soc/fsl/Kconfig
@@ -40,4 +40,12 @@ config DPAA2_CONSOLE
/dev/dpaa2_mc_console and /dev/dpaa2_aiop_console,
which can be used to dump the Management Complex and AIOP
firmware logs.
+
+config FSL_RCPM
+ bool "Freescale RCPM support"
+ depends on PM_SLEEP
+ help
+ The NXP QorIQ Processors based on ARM Core have RCPM module
+ (Run Control and Power Management), which performs all device-level
+ tasks associated with power management, such as wakeup source control.
endmenu
diff --git a/drivers/soc/fsl/Makefile b/drivers/soc/fsl/Makefile
index 71dee8d..906f1cd 100644
--- a/drivers/soc/fsl/Makefile
+++ b/drivers/soc/fsl/Makefile
@@ -6,6 +6,7 @@
obj-$(CONFIG_FSL_DPAA) += qbman/
obj-$(CONFIG_QUICC_ENGINE) += qe/
obj-$(CONFIG_CPM) += qe/
+obj-$(CONFIG_FSL_RCPM) += rcpm.o
obj-$(CONFIG_FSL_GUTS) += guts.o
obj-$(CONFIG_FSL_MC_DPIO) += dpio/
obj-$(CONFIG_DPAA2_CONSOLE) += dpaa2-console.o
diff --git a/drivers/soc/fsl/rcpm.c b/drivers/soc/fsl/rcpm.c
new file mode 100644
index 0000000..9378073
--- /dev/null
+++ b/drivers/soc/fsl/rcpm.c
@@ -0,0 +1,148 @@
+// SPDX-License-Identifier: GPL-2.0
+//
+// rcpm.c - Freescale QorIQ RCPM driver
+//
+// Copyright 2019 NXP
+//
+// Author: Ran Wang <[email protected]>
+
+#include <linux/init.h>
+#include <linux/module.h>
+#include <linux/platform_device.h>
+#include <linux/of_address.h>
+#include <linux/slab.h>
+#include <linux/suspend.h>
+#include <linux/kernel.h>
+
+#define RCPM_WAKEUP_CELL_MAX_SIZE 7
+
+struct rcpm {
+ unsigned int wakeup_cells;
+ void __iomem *ippdexpcr_base;
+ bool little_endian;
+};
+
+/**
+ * rcpm_pm_prepare - performs device-level tasks associated with power
+ * management, such as programming related to the wakeup source control.
+ * @dev: Device to handle.
+ *
+ */
+static int rcpm_pm_prepare(struct device *dev)
+{
+ int i, ret, idx;
+ void __iomem *base;
+ struct wakeup_source *ws;
+ struct rcpm *rcpm;
+ struct device_node *np = dev->of_node;
+ u32 value[RCPM_WAKEUP_CELL_MAX_SIZE + 1];
+
+ rcpm = dev_get_drvdata(dev);
+ if (!rcpm)
+ return -EINVAL;
+
+ base = rcpm->ippdexpcr_base;
+ idx = wakeup_sources_read_lock();
+
+ /* Begin with first registered wakeup source */
+ for_each_wakeup_source(ws) {
+
+ /* skip object which is not attached to device */
+ if (!ws->dev || !ws->dev->parent)
+ continue;
+
+ ret = device_property_read_u32_array(ws->dev->parent,
+ "fsl,rcpm-wakeup", value,
+ rcpm->wakeup_cells + 1);
+
+ /* Wakeup source should refer to current rcpm device */
+ if (ret || (np->phandle != value[0])) {
+ pr_debug("%s doesn't refer to this rcpm\n", ws->name);
+ continue;
+ }
+
+ /* Property "#fsl,rcpm-wakeup-cells" of rcpm node defines the
+ * number of IPPDEXPCR register cells, and "fsl,rcpm-wakeup"
+ * of wakeup source IP contains an integer array: <phandle to
+ * RCPM node, IPPDEXPCR0 setting, IPPDEXPCR1 setting,
+ * IPPDEXPCR2 setting, etc>.
+ *
+ * So we will go thought them and do programming accordngly.
+ */
+ for (i = 0; i < rcpm->wakeup_cells; i++) {
+ u32 tmp = value[i + 1];
+ void __iomem *address = base + i * 4;
+
+ if (!tmp)
+ continue;
+
+ /* We can only OR related bits */
+ if (rcpm->little_endian) {
+ tmp |= ioread32(address);
+ iowrite32(tmp, address);
+ } else {
+ tmp |= ioread32be(address);
+ iowrite32be(tmp, address);
+ }
+ }
+ }
+
+ wakeup_sources_read_unlock(idx);
+
+ return 0;
+}
+
+static const struct dev_pm_ops rcpm_pm_ops = {
+ .prepare = rcpm_pm_prepare,
+};
+
+static int rcpm_probe(struct platform_device *pdev)
+{
+ struct device *dev = &pdev->dev;
+ struct resource *r;
+ struct rcpm *rcpm;
+ int ret;
+
+ rcpm = devm_kzalloc(dev, sizeof(*rcpm), GFP_KERNEL);
+ if (!rcpm)
+ return -ENOMEM;
+
+ r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
+ if (!r)
+ return -ENODEV;
+
+ rcpm->ippdexpcr_base = devm_ioremap_resource(&pdev->dev, r);
+ if (IS_ERR(rcpm->ippdexpcr_base)) {
+ ret = PTR_ERR(rcpm->ippdexpcr_base);
+ return ret;
+ }
+
+ rcpm->little_endian = device_property_read_bool(
+ &pdev->dev, "little-endian");
+
+ ret = device_property_read_u32(&pdev->dev,
+ "#fsl,rcpm-wakeup-cells", &rcpm->wakeup_cells);
+ if (ret)
+ return ret;
+
+ dev_set_drvdata(&pdev->dev, rcpm);
+
+ return 0;
+}
+
+static const struct of_device_id rcpm_of_match[] = {
+ { .compatible = "fsl,qoriq-rcpm-2.1+", },
+ {}
+};
+MODULE_DEVICE_TABLE(of, rcpm_of_match);
+
+static struct platform_driver rcpm_driver = {
+ .driver = {
+ .name = "rcpm",
+ .of_match_table = rcpm_of_match,
+ .pm = &rcpm_pm_ops,
+ },
+ .probe = rcpm_probe,
+};
+
+module_platform_driver(rcpm_driver);
--
2.7.4

2019-10-23 12:35:58

by Rafael J. Wysocki

[permalink] [raw]
Subject: Re: [PATCH v9 1/3] PM: wakeup: Add routine to help fetch wakeup source object.

On Wed, Oct 23, 2019 at 10:24 AM Ran Wang <[email protected]> wrote:
>
> Some user might want to go through all registered wakeup sources
> and doing things accordingly. For example, SoC PM driver might need to
> do HW programming to prevent powering down specific IP which wakeup
> source depending on. So add this API to help walk through all registered
> wakeup source objects on that list and return them one by one.
>
> Signed-off-by: Ran Wang <[email protected]>
> Tested-by: Leonard Crestez <[email protected]>

OK, thanks for making all of the requested changes:

Reviewed-by: Rafael J. Wysocki <[email protected]>

and please feel free to push this through the appropriate
arch/platform tree. Alternatively, please let me know if you want me
to take this series, but then I need an ACK from the appropriate
maintainer(s) on patch 3.

> ---
> Change in v9:
> - Supplement comments for wakeup_sources_read_lock(),
> wakeup_sources_read_unlock, wakeup_sources_walk_start and
> wakeup_sources_walk_next().
>
> Change in v8:
> - Rename wakeup_source_get_next() to wakeup_sources_walk_next().
> - Add wakeup_sources_read_lock() to take over locking job of
> wakeup_source_get_star().
> - Rename wakeup_source_get_start() to wakeup_sources_walk_start().
> - Replace wakeup_source_get_stop() with wakeup_sources_read_unlock().
> - Define macro for_each_wakeup_source(ws).
>
> Change in v7:
> - Remove define of member *dev in wake_irq to fix conflict with commit
> c8377adfa781 ("PM / wakeup: Show wakeup sources stats in sysfs"), user
> will use ws->dev->parent instead.
> - Remove '#include <linux/of_device.h>' because it is not used.
>
> Change in v6:
> - Add wakeup_source_get_star() and wakeup_source_get_stop() to aligned
> with wakeup_sources_stats_seq_start/nex/stop.
>
> Change in v5:
> - Update commit message, add decription of walk through all wakeup
> source objects.
> - Add SCU protection in function wakeup_source_get_next().
> - Rename wakeup_source member 'attached_dev' to 'dev' and move it up
> (before wakeirq).
>
> Change in v4:
> - None.
>
> Change in v3:
> - Adjust indentation of *attached_dev;.
>
> Change in v2:
> - None.
>
> drivers/base/power/wakeup.c | 54 +++++++++++++++++++++++++++++++++++++++++++++
> include/linux/pm_wakeup.h | 9 ++++++++
> 2 files changed, 63 insertions(+)
>
> diff --git a/drivers/base/power/wakeup.c b/drivers/base/power/wakeup.c
> index 5817b51..70a9edb 100644
> --- a/drivers/base/power/wakeup.c
> +++ b/drivers/base/power/wakeup.c
> @@ -248,6 +248,60 @@ void wakeup_source_unregister(struct wakeup_source *ws)
> EXPORT_SYMBOL_GPL(wakeup_source_unregister);
>
> /**
> + * wakeup_sources_read_lock - Lock wakeup source list for read.
> + *
> + * Returns an index of srcu lock for struct wakeup_srcu.
> + * This index must be passed to the matching wakeup_sources_read_unlock().
> + */
> +int wakeup_sources_read_lock(void)
> +{
> + return srcu_read_lock(&wakeup_srcu);
> +}
> +EXPORT_SYMBOL_GPL(wakeup_sources_read_lock);
> +
> +/**
> + * wakeup_sources_read_unlock - Unlock wakeup source list.
> + * @idx: return value from corresponding wakeup_sources_read_lock()
> + */
> +void wakeup_sources_read_unlock(int idx)
> +{
> + srcu_read_unlock(&wakeup_srcu, idx);
> +}
> +EXPORT_SYMBOL_GPL(wakeup_sources_read_unlock);
> +
> +/**
> + * wakeup_sources_walk_start - Begin a walk on wakeup source list
> + *
> + * Returns first object of the list of wakeup sources.
> + *
> + * Note that to be safe, wakeup sources list needs to be locked by calling
> + * wakeup_source_read_lock() for this.
> + */
> +struct wakeup_source *wakeup_sources_walk_start(void)
> +{
> + struct list_head *ws_head = &wakeup_sources;
> +
> + return list_entry_rcu(ws_head->next, struct wakeup_source, entry);
> +}
> +EXPORT_SYMBOL_GPL(wakeup_sources_walk_start);
> +
> +/**
> + * wakeup_sources_walk_next - Get next wakeup source from the list
> + * @ws: Previous wakeup source object
> + *
> + * Note that to be safe, wakeup sources list needs to be locked by calling
> + * wakeup_source_read_lock() for this.
> + */
> +struct wakeup_source *wakeup_sources_walk_next(struct wakeup_source *ws)
> +{
> + struct list_head *ws_head = &wakeup_sources;
> +
> + return list_next_or_null_rcu(ws_head, &ws->entry,
> + struct wakeup_source, entry);
> +}
> +EXPORT_SYMBOL_GPL(wakeup_sources_walk_next);
> +
> +/**
> * device_wakeup_attach - Attach a wakeup source object to a device object.
> * @dev: Device to handle.
> * @ws: Wakeup source object to attach to @dev.
> diff --git a/include/linux/pm_wakeup.h b/include/linux/pm_wakeup.h
> index 661efa0..aa3da66 100644
> --- a/include/linux/pm_wakeup.h
> +++ b/include/linux/pm_wakeup.h
> @@ -63,6 +63,11 @@ struct wakeup_source {
> bool autosleep_enabled:1;
> };
>
> +#define for_each_wakeup_source(ws) \
> + for ((ws) = wakeup_sources_walk_start(); \
> + (ws); \
> + (ws) = wakeup_sources_walk_next((ws)))
> +
> #ifdef CONFIG_PM_SLEEP
>
> /*
> @@ -92,6 +97,10 @@ extern void wakeup_source_remove(struct wakeup_source *ws);
> extern struct wakeup_source *wakeup_source_register(struct device *dev,
> const char *name);
> extern void wakeup_source_unregister(struct wakeup_source *ws);
> +extern int wakeup_sources_read_lock(void);
> +extern void wakeup_sources_read_unlock(int idx);
> +extern struct wakeup_source *wakeup_sources_walk_start(void);
> +extern struct wakeup_source *wakeup_sources_walk_next(struct wakeup_source *ws);
> extern int device_wakeup_enable(struct device *dev);
> extern int device_wakeup_disable(struct device *dev);
> extern void device_set_wakeup_capable(struct device *dev, bool capable);
> --
> 2.7.4
>

2019-10-23 12:44:40

by Ran Wang

[permalink] [raw]
Subject: RE: [PATCH v9 1/3] PM: wakeup: Add routine to help fetch wakeup source object.

Hi Rafael,

On Wednesday, October 23, 2019 17:07, Rafael J. Wysocki wrote:
>
> On Wed, Oct 23, 2019 at 10:24 AM Ran Wang <[email protected]> wrote:
> >
> > Some user might want to go through all registered wakeup sources and
> > doing things accordingly. For example, SoC PM driver might need to do
> > HW programming to prevent powering down specific IP which wakeup
> > source depending on. So add this API to help walk through all
> > registered wakeup source objects on that list and return them one by one.
> >
> > Signed-off-by: Ran Wang <[email protected]>
> > Tested-by: Leonard Crestez <[email protected]>
>
> OK, thanks for making all of the requested changes:

Thanks for your patient direction :)
Actually Leo and me planed to have a f2f discussion with you about this patch on
LPC 2019 but unfortunately missed the opportunity finally (v6 review was
pending at time).

> Reviewed-by: Rafael J. Wysocki <[email protected]>
>
> and please feel free to push this through the appropriate arch/platform tree.

Yes, we will do this later.

> Alternatively, please let me know if you want me to take this series, but then I
> need an ACK from the appropriate
> maintainer(s) on patch 3.

Thanks again, I will wait Leo's comment on patch 3.

Regards,
Ran

2019-10-24 09:41:32

by Leo Li

[permalink] [raw]
Subject: RE: [PATCH v9 1/3] PM: wakeup: Add routine to help fetch wakeup source object.



> -----Original Message-----
> From: Ran Wang <[email protected]>
> Sent: Wednesday, October 23, 2019 4:53 AM
> To: Rafael J. Wysocki <[email protected]>
> Cc: Rafael J . Wysocki <[email protected]>; Rob Herring
> <[email protected]>; Leo Li <[email protected]>; Mark Rutland
> <[email protected]>; Pavel Machek <[email protected]>; Anson Huang
> <[email protected]>; Biwen Li <[email protected]>; Len Brown
> <[email protected]>; Greg Kroah-Hartman
> <[email protected]>; linuxppc-dev <linuxppc-
> [email protected]>; Linux ARM <[email protected]>;
> [email protected]; Linux Kernel Mailing List <linux-
> [email protected]>; Linux PM <[email protected]>
> Subject: RE: [PATCH v9 1/3] PM: wakeup: Add routine to help fetch wakeup
> source object.
>
> Hi Rafael,
>
> On Wednesday, October 23, 2019 17:07, Rafael J. Wysocki wrote:
> >
> > On Wed, Oct 23, 2019 at 10:24 AM Ran Wang <[email protected]>
> wrote:
> > >
> > > Some user might want to go through all registered wakeup sources and
> > > doing things accordingly. For example, SoC PM driver might need to
> > > do HW programming to prevent powering down specific IP which wakeup
> > > source depending on. So add this API to help walk through all
> > > registered wakeup source objects on that list and return them one by
> one.
> > >
> > > Signed-off-by: Ran Wang <[email protected]>
> > > Tested-by: Leonard Crestez <[email protected]>
> >
> > OK, thanks for making all of the requested changes:
>
> Thanks for your patient direction :)
> Actually Leo and me planed to have a f2f discussion with you about this patch
> on LPC 2019 but unfortunately missed the opportunity finally (v6 review was
> pending at time).
>
> > Reviewed-by: Rafael J. Wysocki <[email protected]>

Thanks for the review.

> >
> > and please feel free to push this through the appropriate arch/platform
> tree.
>
> Yes, we will do this later.
>
> > Alternatively, please let me know if you want me to take this series,
> > but then I need an ACK from the appropriate
> > maintainer(s) on patch 3.
>
> Thanks again, I will wait Leo's comment on patch 3.

I will do another review on patch 3 and apply the series through my soc/fsl tree.

Regards,
Leo

2019-10-24 10:37:56

by Leo Li

[permalink] [raw]
Subject: Re: [PATCH v9 3/3] soc: fsl: add RCPM driver

On Wed, Oct 23, 2019 at 3:24 AM Ran Wang <[email protected]> wrote:
>
> The NXP's QorIQ Processors based on ARM Core have RCPM module

Actually not just ARM based QorIQ processors are having RCPM, PowerPC
based QorIQ SoCs also have RCPM. Does this driver also work with the
PowerPC SoCs? Please clarify in the commit message and Kconfig
description.

> (Run Control and Power Management), which performs system level
> tasks associated with power management such as wakeup source control.
>
> This driver depends on PM wakeup source framework which help to
> collect wake information.
>
> Signed-off-by: Ran Wang <[email protected]>
> ---
> Change in v9:
> - Add kerneldoc for rcpm_pm_prepare().
> - Use pr_debug() to replace dev_info(), to print message when decide
> skip current wakeup object, this is mainly for debugging (in order
> to detect potential improper implementation on device tree which
> might cause this skip).
> - Refactor looping implementation in rcpm_pm_prepare(), add more
> comments to help clarify.
>
> Change in v8:
> - Adjust related API usage to meet wakeup.c's update in patch 1/3.
> - Add sanity checking for the case of ws->dev or ws->dev->parent
> is null.
>
> Change in v7:
> - Replace 'ws->dev' with 'ws->dev->parent' to get aligned with
> c8377adfa781 ("PM / wakeup: Show wakeup sources stats in sysfs")
> - Remove '+obj-y += ftm_alarm.o' since it is wrong.
> - Cosmetic work.
>
> Change in v6:
> - Adjust related API usage to meet wakeup.c's update in patch 1/3.
>
> Change in v5:
> - Fix v4 regression of the return value of wakeup_source_get_next()
> didn't pass to ws in while loop.
> - Rename wakeup_source member 'attached_dev' to 'dev'.
> - Rename property 'fsl,#rcpm-wakeup-cells' to '#fsl,rcpm-wakeup-cells'.
> please see https://lore.kernel.org/patchwork/patch/1101022/
>
> Change in v4:
> - Remove extra ',' in author line of rcpm.c
> - Update usage of wakeup_source_get_next() to be less confusing to the
> reader, code logic remain the same.
>
> Change in v3:
> - Some whitespace ajdustment.
>
> Change in v2:
> - Rebase Kconfig and Makefile update to latest mainline.
>
> drivers/soc/fsl/Kconfig | 8 +++
> drivers/soc/fsl/Makefile | 1 +
> drivers/soc/fsl/rcpm.c | 148 +++++++++++++++++++++++++++++++++++++++++++++++
> 3 files changed, 157 insertions(+)
> create mode 100644 drivers/soc/fsl/rcpm.c
>
> diff --git a/drivers/soc/fsl/Kconfig b/drivers/soc/fsl/Kconfig
> index f9ad8ad..4918856 100644
> --- a/drivers/soc/fsl/Kconfig
> +++ b/drivers/soc/fsl/Kconfig
> @@ -40,4 +40,12 @@ config DPAA2_CONSOLE
> /dev/dpaa2_mc_console and /dev/dpaa2_aiop_console,
> which can be used to dump the Management Complex and AIOP
> firmware logs.
> +
> +config FSL_RCPM
> + bool "Freescale RCPM support"
> + depends on PM_SLEEP

If this is only for ARM, probably add more dependency here?

> + help
> + The NXP QorIQ Processors based on ARM Core have RCPM module
> + (Run Control and Power Management), which performs all device-level
> + tasks associated with power management, such as wakeup source control.
> endmenu
> diff --git a/drivers/soc/fsl/Makefile b/drivers/soc/fsl/Makefile
> index 71dee8d..906f1cd 100644
> --- a/drivers/soc/fsl/Makefile
> +++ b/drivers/soc/fsl/Makefile
> @@ -6,6 +6,7 @@
> obj-$(CONFIG_FSL_DPAA) += qbman/
> obj-$(CONFIG_QUICC_ENGINE) += qe/
> obj-$(CONFIG_CPM) += qe/
> +obj-$(CONFIG_FSL_RCPM) += rcpm.o
> obj-$(CONFIG_FSL_GUTS) += guts.o
> obj-$(CONFIG_FSL_MC_DPIO) += dpio/
> obj-$(CONFIG_DPAA2_CONSOLE) += dpaa2-console.o
> diff --git a/drivers/soc/fsl/rcpm.c b/drivers/soc/fsl/rcpm.c
> new file mode 100644
> index 0000000..9378073
> --- /dev/null
> +++ b/drivers/soc/fsl/rcpm.c
> @@ -0,0 +1,148 @@
> +// SPDX-License-Identifier: GPL-2.0
> +//
> +// rcpm.c - Freescale QorIQ RCPM driver
> +//
> +// Copyright 2019 NXP
> +//
> +// Author: Ran Wang <[email protected]>
> +
> +#include <linux/init.h>
> +#include <linux/module.h>
> +#include <linux/platform_device.h>
> +#include <linux/of_address.h>
> +#include <linux/slab.h>
> +#include <linux/suspend.h>
> +#include <linux/kernel.h>
> +
> +#define RCPM_WAKEUP_CELL_MAX_SIZE 7
> +
> +struct rcpm {
> + unsigned int wakeup_cells;
> + void __iomem *ippdexpcr_base;
> + bool little_endian;
> +};
> +
> +/**
> + * rcpm_pm_prepare - performs device-level tasks associated with power
> + * management, such as programming related to the wakeup source control.
> + * @dev: Device to handle.
> + *
> + */
> +static int rcpm_pm_prepare(struct device *dev)
> +{
> + int i, ret, idx;
> + void __iomem *base;
> + struct wakeup_source *ws;
> + struct rcpm *rcpm;
> + struct device_node *np = dev->of_node;
> + u32 value[RCPM_WAKEUP_CELL_MAX_SIZE + 1];
> +
> + rcpm = dev_get_drvdata(dev);
> + if (!rcpm)
> + return -EINVAL;
> +
> + base = rcpm->ippdexpcr_base;
> + idx = wakeup_sources_read_lock();
> +
> + /* Begin with first registered wakeup source */
> + for_each_wakeup_source(ws) {
> +
> + /* skip object which is not attached to device */
> + if (!ws->dev || !ws->dev->parent)
> + continue;
> +
> + ret = device_property_read_u32_array(ws->dev->parent,
> + "fsl,rcpm-wakeup", value,
> + rcpm->wakeup_cells + 1);
> +
> + /* Wakeup source should refer to current rcpm device */
> + if (ret || (np->phandle != value[0])) {
> + pr_debug("%s doesn't refer to this rcpm\n", ws->name);

I agree with Rafael that this looks a little bit weird.

> + continue;
> + }
> +
> + /* Property "#fsl,rcpm-wakeup-cells" of rcpm node defines the
> + * number of IPPDEXPCR register cells, and "fsl,rcpm-wakeup"
> + * of wakeup source IP contains an integer array: <phandle to
> + * RCPM node, IPPDEXPCR0 setting, IPPDEXPCR1 setting,
> + * IPPDEXPCR2 setting, etc>.
> + *
> + * So we will go thought them and do programming accordngly.
> + */
> + for (i = 0; i < rcpm->wakeup_cells; i++) {
> + u32 tmp = value[i + 1];
> + void __iomem *address = base + i * 4;
> +
> + if (!tmp)
> + continue;
> +
> + /* We can only OR related bits */
> + if (rcpm->little_endian) {
> + tmp |= ioread32(address);
> + iowrite32(tmp, address);
> + } else {
> + tmp |= ioread32be(address);
> + iowrite32be(tmp, address);
> + }

Can we do read once at the beginning and write once at the end,
instead of doing IO read/write for every wakeup source?

> + }
> + }
> +
> + wakeup_sources_read_unlock(idx);
> +
> + return 0;
> +}
> +
> +static const struct dev_pm_ops rcpm_pm_ops = {
> + .prepare = rcpm_pm_prepare,
> +};
> +
> +static int rcpm_probe(struct platform_device *pdev)
> +{
> + struct device *dev = &pdev->dev;
> + struct resource *r;
> + struct rcpm *rcpm;
> + int ret;
> +
> + rcpm = devm_kzalloc(dev, sizeof(*rcpm), GFP_KERNEL);
> + if (!rcpm)
> + return -ENOMEM;
> +
> + r = platform_get_resource(pdev, IORESOURCE_MEM, 0);
> + if (!r)
> + return -ENODEV;
> +
> + rcpm->ippdexpcr_base = devm_ioremap_resource(&pdev->dev, r);
> + if (IS_ERR(rcpm->ippdexpcr_base)) {
> + ret = PTR_ERR(rcpm->ippdexpcr_base);
> + return ret;
> + }
> +
> + rcpm->little_endian = device_property_read_bool(
> + &pdev->dev, "little-endian");
> +
> + ret = device_property_read_u32(&pdev->dev,
> + "#fsl,rcpm-wakeup-cells", &rcpm->wakeup_cells);
> + if (ret)
> + return ret;
> +
> + dev_set_drvdata(&pdev->dev, rcpm);
> +
> + return 0;
> +}
> +
> +static const struct of_device_id rcpm_of_match[] = {
> + { .compatible = "fsl,qoriq-rcpm-2.1+", },
> + {}
> +};
> +MODULE_DEVICE_TABLE(of, rcpm_of_match);
> +
> +static struct platform_driver rcpm_driver = {
> + .driver = {
> + .name = "rcpm",
> + .of_match_table = rcpm_of_match,
> + .pm = &rcpm_pm_ops,
> + },
> + .probe = rcpm_probe,
> +};
> +
> +module_platform_driver(rcpm_driver);
> --
> 2.7.4
>

2019-10-24 19:40:03

by Ran Wang

[permalink] [raw]
Subject: RE: [PATCH v9 3/3] soc: fsl: add RCPM driver

Hi Leo,


On Thursday, October 24, 2019 06:48, Li Yang wrote:
>
> On Wed, Oct 23, 2019 at 3:24 AM Ran Wang <[email protected]> wrote:
> >
> > The NXP's QorIQ Processors based on ARM Core have RCPM module
>
> Actually not just ARM based QorIQ processors are having RCPM, PowerPC based
> QorIQ SoCs also have RCPM. Does this driver also work with the PowerPC SoCs?
> Please clarify in the commit message and Kconfig description.
>
> > (Run Control and Power Management), which performs system level tasks
> > associated with power management such as wakeup source control.
> >
> > This driver depends on PM wakeup source framework which help to
> > collect wake information.
> >
> > Signed-off-by: Ran Wang <[email protected]>

<snip>


> > diff --git a/drivers/soc/fsl/Kconfig b/drivers/soc/fsl/Kconfig index
> > f9ad8ad..4918856 100644
> > --- a/drivers/soc/fsl/Kconfig
> > +++ b/drivers/soc/fsl/Kconfig
> > @@ -40,4 +40,12 @@ config DPAA2_CONSOLE
> > /dev/dpaa2_mc_console and /dev/dpaa2_aiop_console,
> > which can be used to dump the Management Complex and AIOP
> > firmware logs.
> > +
> > +config FSL_RCPM
> > + bool "Freescale RCPM support"
> > + depends on PM_SLEEP
>
> If this is only for ARM, probably add more dependency here?

OK.

> > + help
> > + The NXP QorIQ Processors based on ARM Core have RCPM module
> > + (Run Control and Power Management), which performs all device-level
> > + tasks associated with power management, such as wakeup source
> control.
> > endmenu

<snip>

> > +
> > +/**
> > + * rcpm_pm_prepare - performs device-level tasks associated with
> > +power
> > + * management, such as programming related to the wakeup source control.
> > + * @dev: Device to handle.
> > + *
> > + */
> > +static int rcpm_pm_prepare(struct device *dev) {
> > + int i, ret, idx;
> > + void __iomem *base;
> > + struct wakeup_source *ws;
> > + struct rcpm *rcpm;
> > + struct device_node *np = dev->of_node;
> > + u32 value[RCPM_WAKEUP_CELL_MAX_SIZE + 1];
> > +
> > + rcpm = dev_get_drvdata(dev);
> > + if (!rcpm)
> > + return -EINVAL;
> > +
> > + base = rcpm->ippdexpcr_base;
> > + idx = wakeup_sources_read_lock();
> > +
> > + /* Begin with first registered wakeup source */
> > + for_each_wakeup_source(ws) {
> > +
> > + /* skip object which is not attached to device */
> > + if (!ws->dev || !ws->dev->parent)
> > + continue;
> > +
> > + ret = device_property_read_u32_array(ws->dev->parent,
> > + "fsl,rcpm-wakeup", value,
> > + rcpm->wakeup_cells + 1);
> > +
> > + /* Wakeup source should refer to current rcpm device */
> > + if (ret || (np->phandle != value[0])) {
> > + pr_debug("%s doesn't refer to this rcpm\n",
> > + ws->name);
>
> I agree with Rafael that this looks a little bit weird.

OK, let me remove this print in next version.

> > + continue;
> > + }
> > +
> > + /* Property "#fsl,rcpm-wakeup-cells" of rcpm node defines the
> > + * number of IPPDEXPCR register cells, and "fsl,rcpm-wakeup"
> > + * of wakeup source IP contains an integer array: <phandle to
> > + * RCPM node, IPPDEXPCR0 setting, IPPDEXPCR1 setting,
> > + * IPPDEXPCR2 setting, etc>.
> > + *
> > + * So we will go thought them and do programming accordngly.
> > + */
> > + for (i = 0; i < rcpm->wakeup_cells; i++) {
> > + u32 tmp = value[i + 1];
> > + void __iomem *address = base + i * 4;
> > +
> > + if (!tmp)
> > + continue;
> > +
> > + /* We can only OR related bits */
> > + if (rcpm->little_endian) {
> > + tmp |= ioread32(address);
> > + iowrite32(tmp, address);
> > + } else {
> > + tmp |= ioread32be(address);
> > + iowrite32be(tmp, address);
> > + }
>
> Can we do read once at the beginning and write once at the end, instead of
> doing IO read/write for every wakeup source?

Sure, but another loop might need to be added after the one of wakeup source walk
through, to program all IPPDEXPCR registers. Is that OK?

Regards,
Ran


> > + }
> > + }
> > +
> > + wakeup_sources_read_unlock(idx);
> > +
> > + return 0;
> > +}
> > +
> > +static const struct dev_pm_ops rcpm_pm_ops = {
> > + .prepare = rcpm_pm_prepare,
> > +};
> > +