Change in coreboot[master]: device: Add find_dev_nested_path helper function

[Rob Barnes (Code Review)]

Rob Barnes has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/43776 )

Change subject: device: Add find_dev_nested_path helper function
......................................................................

device: Add find_dev_nested_path helper function

Add find_dev_nested_path helper function to simplify finding deeply
nested devices.

BUG=b:157580724
TEST=Find bluetooth device on dalboz

Change-Id: I48fa5fcad0030fb6dcea97b9fc76e1d3d3f9b28f
---
M src/device/device_const.c
M src/include/device/device.h
2 files changed, 32 insertions(+), 0 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/76/43776/1

diff --git a/src/device/device_const.c b/src/device/device_const.c
index 12d5386..765fcdc 100644
--- a/src/device/device_const.c
+++ b/src/device/device_const.c
@@ -196,6 +196,34 @@
    return child;
 }

+/**
+ * Find the device structure given an array of nested device paths,
+ *
+ * @param parent The parent bus to start the search on.
+ * @param nested_path An array of relative paths from the parent bus to
+ 	  the target device.
+ * @param nested_path_length Number of path elements in nested_path array.
+ * @return Pointer to a device structure for the device at nested path
+ *         or 0/NULL if no device is found.
+ */
+DEVTREE_CONST struct device *find_dev_nested_path(
+	const struct bus *parent, const struct device_path nested_path[],
+	unsigned int nested_path_length)
+{
+	DEVTREE_CONST struct device *child;
+
+	if (!parent || !nested_path_length)
+		return NULL;
+
+	child = find_dev_path(parent, nested_path);
+
+	/* Terminate recursion at end of nested path or child not found */
+	if(nested_path_length == 1 || !child)
+		return child;
+
+	return find_dev_nested_path(child->link_list, nested_path+1, nested_path_length-1);
+}
+
 DEVTREE_CONST struct device *pcidev_path_behind(
    const struct bus *parent, pci_devfn_t devfn)
 {
diff --git a/src/include/device/device.h b/src/include/device/device.h
index 082dcbb..202d3ae 100644
--- a/src/include/device/device.h
+++ b/src/include/device/device.h
@@ -202,6 +202,10 @@
 DEVTREE_CONST struct device *find_dev_path(
    	const struct bus *parent,
    	const struct device_path *path);
+DEVTREE_CONST struct device *find_dev_nested_path(
+		const struct bus *parent,
+		const struct device_path nested_path[],
+		unsigned int nested_path_length);
 struct device *alloc_find_dev(struct bus *parent, struct device_path *path);
 struct device *dev_find_device(u16 vendor, u16 device, struct device *from);
 struct device *dev_find_class(unsigned int class, struct device *from);

[build bot (Jenkins) (Code Review)]

build bot (Jenkins) has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/43776 )

Change subject: device: Add find_dev_nested_path helper function
......................................................................

Patch Set 1:

(3 comments)

https://review.coreboot.org/c/coreboot/+/43776/1/src/device/device_const.c 
File src/device/device_const.c:

https://review.coreboot.org/c/coreboot/+/43776/1/src/device/device_const.c@2... 
PS1, Line 204:  	  the target device.
code indent should use tabs where possible

https://review.coreboot.org/c/coreboot/+/43776/1/src/device/device_const.c@2... 
PS1, Line 204:  	  the target device.
please, no space before tabs

https://review.coreboot.org/c/coreboot/+/43776/1/src/device/device_const.c@2... 
PS1, Line 221: 	if(nested_path_length == 1 || !child)
space required before the open parenthesis '('

[Rob Barnes (Code Review)]

Hello build bot (Jenkins),

I'd like you to reexamine a change. Please visit

https://review.coreboot.org/c/coreboot/+/43776

to look at the new patch set (#2).

Change subject: device: Add find_dev_nested_path helper function
......................................................................

device: Add find_dev_nested_path helper function

Add find_dev_nested_path helper function to simplify finding deeply
nested devices.

BUG=b:157580724
TEST=Find bluetooth device on dalboz

Change-Id: I48fa5fcad0030fb6dcea97b9fc76e1d3d3f9b28f
Signed-off-by: Rob Barnes 
---
M src/device/device_const.c
M src/include/device/device.h
2 files changed, 32 insertions(+), 0 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/76/43776/2

[Furquan Shaikh (Code Review)]

Furquan Shaikh has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/43776 )

Change subject: device: Add find_dev_nested_path helper function
......................................................................

Patch Set 2:

(5 comments)

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c 
File src/device/device_const.c:

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c@2... 
PS2, Line 211: unsigned int
size_t?

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c@2... 
PS2, Line 215: 	if (!parent || !nested_path_length)
Check for nested_path as well?

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c@2... 
PS2, Line 221: (
space before (

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c@2... 
PS2, Line 224: -
space around -

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c@2... 
PS2, Line 224: +
space around +

[Rob Barnes (Code Review)]

Hello build bot (Jenkins), Raul Rangel, Furquan Shaikh, Martin Roth,

I'd like you to reexamine a change. Please visit

https://review.coreboot.org/c/coreboot/+/43776

to look at the new patch set (#3).

Change subject: device: Add find_dev_nested_path helper function
......................................................................

device: Add find_dev_nested_path helper function

Add find_dev_nested_path helper function to simplify finding deeply
nested devices.

BUG=b:157580724
TEST=Find bluetooth device on dalboz

Change-Id: I48fa5fcad0030fb6dcea97b9fc76e1d3d3f9b28f
Signed-off-by: Rob Barnes 
---
M src/device/device_const.c
M src/include/device/device.h
2 files changed, 32 insertions(+), 0 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/76/43776/3

[Rob Barnes (Code Review)]

Rob Barnes has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/43776 )

Change subject: device: Add find_dev_nested_path helper function
......................................................................

Patch Set 3:

(5 comments)

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c 
File src/device/device_const.c:

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c@2... 
PS2, Line 211: unsigned int
> size_t?

Done

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c@2... 
PS2, Line 215: 	if (!parent || !nested_path_length)
> Check for nested_path as well?

Done

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c@2... 
PS2, Line 221: (
> space before (

Where's build bot when you need them?

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c@2... 
PS2, Line 224: +
> space around +

Done

https://review.coreboot.org/c/coreboot/+/43776/2/src/device/device_const.c@2... 
PS2, Line 224: -
> space around -

Done

[build bot (Jenkins) (Code Review)]

build bot (Jenkins) has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/43776 )

Change subject: device: Add find_dev_nested_path helper function
......................................................................

Patch Set 3:

(2 comments)

https://review.coreboot.org/c/coreboot/+/43776/3/src/device/device_const.c 
File src/device/device_const.c:

https://review.coreboot.org/c/coreboot/+/43776/3/src/device/device_const.c@2... 
PS3, Line 204:  	  the target device.
code indent should use tabs where possible

https://review.coreboot.org/c/coreboot/+/43776/3/src/device/device_const.c@2... 
PS3, Line 204:  	  the target device.
please, no space before tabs

[Rob Barnes (Code Review)]

Hello build bot (Jenkins), Raul Rangel, Furquan Shaikh, Martin Roth,

I'd like you to reexamine a change. Please visit

https://review.coreboot.org/c/coreboot/+/43776

to look at the new patch set (#4).

Change subject: device: Add find_dev_nested_path helper function
......................................................................

device: Add find_dev_nested_path helper function

Add find_dev_nested_path helper function to simplify finding deeply
nested devices.

BUG=b:157580724
TEST=Find bluetooth device on dalboz

Change-Id: I48fa5fcad0030fb6dcea97b9fc76e1d3d3f9b28f
Signed-off-by: Rob Barnes 
---
M src/device/device_const.c
M src/include/device/device.h
2 files changed, 31 insertions(+), 0 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/76/43776/4

[Furquan Shaikh (Code Review)]

Furquan Shaikh has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/43776 )

Change subject: device: Add find_dev_nested_path helper function
......................................................................

Patch Set 4: Code-Review+2

[Raul Rangel (Code Review)]

Raul Rangel has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/43776 )

Change subject: device: Add find_dev_nested_path helper function
......................................................................

Patch Set 4: Code-Review+2

[Patrick Georgi (Code Review)]

Patrick Georgi has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/43776 )

Change subject: device: Add find_dev_nested_path helper function
......................................................................

Patch Set 4:

(1 comment)

https://review.coreboot.org/c/coreboot/+/43776/4/src/device/device_const.c 
File src/device/device_const.c:

https://review.coreboot.org/c/coreboot/+/43776/4/src/device/device_const.c@2... 
PS4, Line 219: recursion
I hope nobody goes overboard with long nested paths here since our stacks aren't very flexible ;-)

[Patrick Georgi (Code Review)]

Patrick Georgi has submitted this change. ( https://review.coreboot.org/c/coreboot/+/43776 )

Change subject: device: Add find_dev_nested_path helper function
......................................................................

device: Add find_dev_nested_path helper function

Add find_dev_nested_path helper function to simplify finding deeply
nested devices.

BUG=b:157580724
TEST=Find bluetooth device on dalboz

Change-Id: I48fa5fcad0030fb6dcea97b9fc76e1d3d3f9b28f
Signed-off-by: Rob Barnes 
Reviewed-on: https://review.coreboot.org/c/coreboot/+/43776
Tested-by: build bot (Jenkins) 
Reviewed-by: Furquan Shaikh 
Reviewed-by: Raul Rangel 
---
M src/device/device_const.c
M src/include/device/device.h
2 files changed, 31 insertions(+), 0 deletions(-)

Approvals:
  build bot (Jenkins): Verified
  Furquan Shaikh: Looks good to me, approved
  Raul Rangel: Looks good to me, approved

diff --git a/src/device/device_const.c b/src/device/device_const.c
index 12d5386..79f025d 100644
--- a/src/device/device_const.c
+++ b/src/device/device_const.c
@@ -196,6 +196,33 @@
    return child;
 }

+/**
+ * Find the device structure given an array of nested device paths,
+ *
+ * @param parent The parent bus to start the search on.
+ * @param nested_path An array of relative paths from the parent bus to the target device.
+ * @param nested_path_length Number of path elements in nested_path array.
+ * @return Pointer to a device structure for the device at nested path
+ *         or 0/NULL if no device is found.
+ */
+DEVTREE_CONST struct device *find_dev_nested_path(
+	const struct bus *parent, const struct device_path nested_path[],
+	size_t nested_path_length)
+{
+	DEVTREE_CONST struct device *child;
+
+	if (!parent || !nested_path || !nested_path_length)
+		return NULL;
+
+	child = find_dev_path(parent, nested_path);
+
+	/* Terminate recursion at end of nested path or child not found */
+	if (nested_path_length == 1 || !child)
+		return child;
+
+	return find_dev_nested_path(child->link_list, nested_path + 1, nested_path_length - 1);
+}
+
 DEVTREE_CONST struct device *pcidev_path_behind(
    const struct bus *parent, pci_devfn_t devfn)
 {
diff --git a/src/include/device/device.h b/src/include/device/device.h
index 3177854..b53b64a 100644
--- a/src/include/device/device.h
+++ b/src/include/device/device.h
@@ -207,6 +207,10 @@
 DEVTREE_CONST struct device *find_dev_path(
    	const struct bus *parent,
    	const struct device_path *path);
+DEVTREE_CONST struct device *find_dev_nested_path(
+		const struct bus *parent,
+		const struct device_path nested_path[],
+		size_t nested_path_length);
 struct device *alloc_find_dev(struct bus *parent, struct device_path *path);
 struct device *dev_find_device(u16 vendor, u16 device, struct device *from);
 struct device *dev_find_class(unsigned int class, struct device *from);