Skip to contentSkip to conversation

reset: Add a managed API

PATCH Superseded Pratyush Yadav 2 participants 6 messages Sep 9, 2020 – Oct 1, 2020 Reset controller framework

v3 of 5 Superseded Latest is v5 →

lore
Share & tools
lore
#0 lore raw

v3 cover reset: Add a managed API

Hi,

This is the 4th of a few series that are re-rolls of Jean-Jacques' earlier efforts. The goal is to facilitate porting drivers from the Linux kernel.

This particular series is about reset controllers. It adds a managed API, close to that of Linux. The main difference is that bulk and reset_ctl are handled with different functions.

Changes in v3:
- Rebase on latest master and fix merge conflicts.
- Other changes in individual patches.

Changes in v2:
- Fix test build failing because of missing function prototypes and includes.
- Drop NULL checks from the reset core. For now let drivers handle them. We can always add the checks back if we think they are a better idea.
- Rebase on latest master.

Jean-Jacques Hiblot (2):
drivers: reset: Add a managed API to get reset controllers from the DT
test: reset: Add tests for the managed API

 arch/sandbox/include/asm/reset.h   |   3 +
 drivers/reset/reset-uclass.c       | 118 ++++++++++++++++++++++++-
 drivers/reset/sandbox-reset-test.c |  51 +++++++++--
 drivers/reset/sandbox-reset.c      |  19 ++++
 include/reset.h                    | 135 ++++++++++++++++++++++++++++-
 test/dm/reset.c                    |  60 +++++++++++++
 6 files changed, 375 insertions(+), 11 deletions(-)

--
2.28.0

#1 lore raw

PATCH v3 1/2 drivers: reset: Add a managed API to get reset controllers from the DT

From: Jean-Jacques Hiblot <[email protected]>

Add managed functions to get a reset_ctl from the device-tree, based on a name or an index.
Also add a managed functions to get a reset_ctl_bulk (array of reset_ctl) from the device-tree.

When the device is unbound, the reset controllers are automatically released and the data structure is freed.

---

Notes:
Changes in v3:

- Include linux/err.h instead of linux/errno.h because it includes the definition of ERR_PTR(), which we use in the inline variants of the functions. Fixes build on various platforms.

- Drop the include of dm.h because it spits out a build warning.

- Fix some a small merge conflict.

 drivers/reset/reset-uclass.c | 118 ++++++++++++++++++++++++++++--
 include/reset.h              | 135 ++++++++++++++++++++++++++++++++++-
 2 files changed, 248 insertions(+), 5 deletions(-)
drivers/reset/reset-uclass.c +114 -4
index 5e38ce5c06..e7e407ca35 100644
@@ -11,6 +11,7 @@
 #include <reset.h>
 #include <reset-uclass.h>
 #include <dm/devres.h>
+#include <dm/lists.h>
 
 static inline struct reset_ops *reset_dev_ops(struct udevice *dev)
 {
@@ -100,13 +101,14 @@ int reset_get_by_index_nodev(ofnode node, int index,
 				       index > 0, reset_ctl);
 }
 
-int reset_get_bulk(struct udevice *dev, struct reset_ctl_bulk *bulk)
+static int __reset_get_bulk(struct udevice *dev, ofnode node,
+			    struct reset_ctl_bulk *bulk)
 {
 	int i, ret, err, count;
-	
+
 	bulk->count = 0;
 
-	count = dev_count_phandle_with_args(dev, "resets", "#reset-cells");
+	count = ofnode_count_phandle_with_args(node, "resets", "#reset-cells");
 	if (count < 1)
 		return count;
 
@@ -116,7 +118,7 @@ int reset_get_bulk(struct udevice *dev, struct reset_ctl_bulk *bulk)
 		return -ENOMEM;
 
 	for (i = 0; i < count; i++) {
-		ret = reset_get_by_index(dev, i, &bulk->resets[i]);
+		ret = reset_get_by_index_nodev(node, i, &bulk->resets[i]);
 		if (ret < 0)
 			goto bulk_get_err;
 
@@ -134,6 +136,11 @@ bulk_get_err:
 	return ret;
 }
 
+int reset_get_bulk(struct udevice *dev, struct reset_ctl_bulk *bulk)
+{
+	return __reset_get_bulk(dev, dev_ofnode(dev), bulk);
+}
+
 int reset_get_by_name(struct udevice *dev, const char *name,
 		     struct reset_ctl *reset_ctl)
 {
@@ -246,6 +253,109 @@ int reset_release_all(struct reset_ctl *reset_ctl, int count)
 	return 0;
 }
 
+static void devm_reset_release(struct udevice *dev, void *res)
+{
+	reset_free(res);
+}
+
+struct reset_ctl *devm_reset_control_get_by_index(struct udevice *dev,
+						  int index)
+{
+	int rc;
+	struct reset_ctl *reset_ctl;
+
+	reset_ctl = devres_alloc(devm_reset_release, sizeof(struct reset_ctl),
+				 __GFP_ZERO);
+	if (unlikely(!reset_ctl))
+		return ERR_PTR(-ENOMEM);
+
+	rc = reset_get_by_index(dev, index, reset_ctl);
+	if (rc)
+		return ERR_PTR(rc);
+
+	devres_add(dev, reset_ctl);
+	return reset_ctl;
+}
+
+struct reset_ctl *devm_reset_control_get(struct udevice *dev, const char *id)
+{
+	int rc;
+	struct reset_ctl *reset_ctl;
+
+	reset_ctl = devres_alloc(devm_reset_release, sizeof(struct reset_ctl),
+				 __GFP_ZERO);
+	if (unlikely(!reset_ctl))
+		return ERR_PTR(-ENOMEM);
+
+	rc = reset_get_by_name(dev, id, reset_ctl);
+	if (rc)
+		return ERR_PTR(rc);
+
+	devres_add(dev, reset_ctl);
+	return reset_ctl;
+}
+
+struct reset_ctl *devm_reset_control_get_optional(struct udevice *dev,
+						  const char *id)
+{
+	struct reset_ctl *r = devm_reset_control_get(dev, id);
+
+	if (IS_ERR(r))
+		return NULL;
+
+	return r;
+}
+
+static void devm_reset_bulk_release(struct udevice *dev, void *res)
+{
+	struct reset_ctl_bulk *bulk = res;
+
+	reset_release_all(bulk->resets, bulk->count);
+}
+
+struct reset_ctl_bulk *devm_reset_bulk_get_by_node(struct udevice *dev,
+						   ofnode node)
+{
+	int rc;
+	struct reset_ctl_bulk *bulk;
+
+	bulk = devres_alloc(devm_reset_bulk_release,
+			    sizeof(struct reset_ctl_bulk),
+			    __GFP_ZERO);
+	if (unlikely(!bulk))
+		return ERR_PTR(-ENOMEM);
+
+	rc = __reset_get_bulk(dev, node, bulk);
+	if (rc)
+		return ERR_PTR(rc);
+
+	devres_add(dev, bulk);
+	return bulk;
+}
+
+struct reset_ctl_bulk *devm_reset_bulk_get_optional_by_node(struct udevice *dev,
+							    ofnode node)
+{
+	struct reset_ctl_bulk *bulk;
+
+	bulk = devm_reset_bulk_get_by_node(dev, node);
+
+	if (IS_ERR(bulk))
+		return NULL;
+
+	return bulk;
+}
+
+struct reset_ctl_bulk *devm_reset_bulk_get(struct udevice *dev)
+{
+	return devm_reset_bulk_get_by_node(dev, dev_ofnode(dev));
+}
+
+struct reset_ctl_bulk *devm_reset_bulk_get_optional(struct udevice *dev)
+{
+	return devm_reset_bulk_get_optional_by_node(dev, dev_ofnode(dev));
+}
+
 UCLASS_DRIVER(reset) = {
 	.id		= UCLASS_RESET,
 	.name		= "reset",
include/reset.h +134 -1

154 lines not on this page · raw message

Signature · 1 line
2.28.0
#2 lore raw

PATCH v3 1/2 drivers: reset: Add a managed API to get reset controllers from the DT

Quoted 7 lines · Pratyush Yadav

From: Jean-Jacques Hiblot <[email protected]>

Add managed functions to get a reset_ctl from the device-tree, based on a name or an index.
Also add a managed functions to get a reset_ctl_bulk (array of reset_ctl) from the device-tree.

Quoted 6 lines

When the device is unbound, the reset controllers are automatically released and the data structure is freed.

Applied to u-boot/next, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20201001/1482fc6f/attachment.sig>
#3 lore raw

PATCH v3 2/2 test: reset: Add tests for the managed API

In reply to Pratyush Yadav

From: Jean-Jacques Hiblot <[email protected]>

The tests are basically the same as for the regular API. Except that the reset are initialized using the managed API, and no freed manually.

---

Notes:
Changes in v3:

- s/DM_TESTF/UT_TESTF/g

 arch/sandbox/include/asm/reset.h   |  3 ++
 drivers/reset/sandbox-reset-test.c | 51 ++++++++++++++++++++++---
 drivers/reset/sandbox-reset.c      | 19 ++++++++++
 test/dm/reset.c                    | 60 ++++++++++++++++++++++++++++++
 4 files changed, 127 insertions(+), 6 deletions(-)
arch/sandbox/include/asm/reset.h +3 -0
index c4205eabef..40d3e61c11 100644
@@ -11,9 +11,12 @@
 struct udevice;
 
 int sandbox_reset_query(struct udevice *dev, unsigned long id);
+int sandbox_reset_is_requested(struct udevice *dev, unsigned long id);
 
 int sandbox_reset_test_get(struct udevice *dev);
+int sandbox_reset_test_get_devm(struct udevice *dev);
 int sandbox_reset_test_get_bulk(struct udevice *dev);
+int sandbox_reset_test_get_bulk_devm(struct udevice *dev);
 int sandbox_reset_test_assert(struct udevice *dev);
 int sandbox_reset_test_assert_bulk(struct udevice *dev);
 int sandbox_reset_test_deassert(struct udevice *dev);
drivers/reset/sandbox-reset-test.c +45 -6

111 lines not on this page · raw message

drivers/reset/sandbox-reset.c +19 -0
index 7a6f7f676c..08008d875a 100644
@@ -15,6 +15,7 @@
 
 struct sandbox_reset_signal {
 	bool asserted;
+	bool requested;
 };
 
 struct sandbox_reset {
@@ -23,18 +24,24 @@ struct sandbox_reset {
 
 static int sandbox_reset_request(struct reset_ctl *reset_ctl)
 {
+	struct sandbox_reset *sbr = dev_get_priv(reset_ctl->dev);
+
 	debug("%s(reset_ctl=%p)\n", __func__, reset_ctl);
 
 	if (reset_ctl->id >= SANDBOX_RESET_SIGNALS)
 		return -EINVAL;
 
+	sbr->signals[reset_ctl->id].requested = true;
 	return 0;
 }
 
 static int sandbox_reset_free(struct reset_ctl *reset_ctl)
 {
+	struct sandbox_reset *sbr = dev_get_priv(reset_ctl->dev);
+
 	debug("%s(reset_ctl=%p)\n", __func__, reset_ctl);
 
+	sbr->signals[reset_ctl->id].requested = false;
 	return 0;
 }
 
@@ -107,3 +114,15 @@ int sandbox_reset_query(struct udevice *dev, unsigned long id)
 
 	return sbr->signals[id].asserted;
 }
+
+int sandbox_reset_is_requested(struct udevice *dev, unsigned long id)
+{
+	struct sandbox_reset *sbr = dev_get_priv(dev);
+
+	debug("%s(dev=%p, id=%ld)\n", __func__, dev, id);
+
+	if (id >= SANDBOX_RESET_SIGNALS)
+		return -EINVAL;
+
+	return sbr->signals[id].requested;
+}
test/dm/reset.c +60 -0

81 lines not on this page · raw message

Signature · 1 line
2.28.0
#4 lore raw

PATCH v3 2/2 test: reset: Add tests for the managed API

Quoted 8 lines · Pratyush Yadav

From: Jean-Jacques Hiblot <[email protected]>

The tests are basically the same as for the regular API. Except that the reset are initialized using the managed API, and no freed manually.

Applied to u-boot/next, thanks!

Signature · 8 lines
Tom
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: not available
URL: <https://lists.denx.de/pipermail/u-boot/attachments/20201001/4a3594b5/attachment.sig>
#5 lore raw

v3 cover reset: Add a managed API

In reply to Pratyush Yadav
Quoted 9 lines · Pratyush Yadav

Hi,

This is the 4th of a few series that are re-rolls of Jean-Jacques' earlier efforts. The goal is to facilitate porting drivers from the Linux kernel.

This particular series is about reset controllers. It adds a managed API, close to that of Linux. The main difference is that bulk and reset_ctl are handled with different functions.

Forgot to mention: Travis CI run can be found at
https://travis-ci.org/github/prati0100/uboot/builds/725197237

Signature · 3 lines
Regards,
Pratyush Yadav
Texas Instruments India