Change in coreboot[master]: device/xhci: Add helper method to iterate over xhci_supported_protocl

[Raul Rangel (Code Review)]

Raul Rangel has uploaded this change for review. ( https://review.coreboot.org/c/coreboot/+/43352 )

Change subject: device/xhci: Add helper method to iterate over xhci_supported_protocl
......................................................................

device/xhci: Add helper method to iterate over xhci_supported_protocl

There is some boilerplate required to iterate over the USB supported
protocol structs. Encapsulate all the in a method to make the callers
simpler.

BUG=b:154756391
TEST=Built test trembyle.

Signed-off-by: Raul E Rangel 
Change-Id: I401f10d242638b0000ba697573856d765333dca0
---
M src/device/xhci.c
M src/include/device/xhci.h
2 files changed, 47 insertions(+), 2 deletions(-)

git pull ssh://review.coreboot.org:29418/coreboot refs/changes/52/43352/1

diff --git a/src/device/xhci.c b/src/device/xhci.c
index ce1c1b2..d4cacef 100644
--- a/src/device/xhci.c
+++ b/src/device/xhci.c
@@ -1,9 +1,10 @@
 /* SPDX-License-Identifier: GPL-2.0-or-later */

-#include <device/xhci.h>
+#include <arch/mmio.h>
 #include <console/console.h>
 #include <device/pci_def.h>
-#include <arch/mmio.h>
+#include <device/xhci.h>
+#include <string.h>

union xhci_ext_caps_header {
    uint32_t val;
@@ -75,6 +76,42 @@
    return CB_SUCCESS;
 }

+struct supported_usb_cap_context {
+	void *context;
+	void (*callback)(void *context, const struct xhci_supported_protocol *data);
+};
+
+static void xhci_supported_usb_cap_handler(void *context, const struct xhci_ext_cap *cap)
+{
+	const struct xhci_supported_protocol *data;
+	struct supported_usb_cap_context *internal_context = context;
+
+	if (cap->cap_id != XHCI_ECP_CAP_ID_SUPP)
+		return;
+
+	data = &cap->supported_protocol;
+
+	if (memcmp(data->name, "USB ", 4)) {
+		printk(BIOS_DEBUG, "%s: Unknown Protocol: %.*s\n", __func__,
+		       (int)sizeof(data->name), data->name);
+		return;
+	}
+
+	internal_context->callback(internal_context->context, data);
+}
+
+enum cb_err xhci_for_each_supported_usb_cap(
+	const struct device *device, void *context,
+	void (*callback)(void *context, const struct xhci_supported_protocol *data))
+{
+	struct supported_usb_cap_context internal_context = {
+		.context = context,
+		.callback = callback,
+	};
+
+	return xhci_for_each_ext_cap(device, &internal_context, xhci_supported_usb_cap_handler);
+}
+
 void xhci_print_supported_protocol(const struct xhci_supported_protocol *supported_protocol)
 {
    printk(BIOS_DEBUG, "xHCI Supported Protocol:\n");
diff --git a/src/include/device/xhci.h b/src/include/device/xhci.h
index 25f950b..17ce846 100644
--- a/src/include/device/xhci.h
+++ b/src/include/device/xhci.h
@@ -52,6 +52,14 @@
    			  void (*callback)(void *context,
    					   const struct xhci_ext_cap *cap));

+/**
+ * Helper method that iterates over only the USB supported capabilities structures in the
+ * xHCI Extended Capabilities List.
+ */
+enum cb_err xhci_for_each_supported_usb_cap(
+	const struct device *device, void *context,
+	void (*callback)(void *context, const struct xhci_supported_protocol *data));
+
 void xhci_print_supported_protocol(const struct xhci_supported_protocol *supported_protocol);

#endif /* __DEVICE_XHCI_H__ */

[build bot (Jenkins) (Code Review)]

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

Change subject: device/xhci: Add helper method to iterate over xhci_supported_protocl
......................................................................

Patch Set 1:

(1 comment)

https://review.coreboot.org/c/coreboot/+/43352/1/src/device/xhci.c 
File src/device/xhci.c:

https://review.coreboot.org/c/coreboot/+/43352/1/src/device/xhci.c@103 
PS1, Line 103: enum cb_err xhci_for_each_supported_usb_cap(
that open brace { should be on the previous line

[Aaron Durbin (Code Review)]

Aaron Durbin has posted comments on this change. ( https://review.coreboot.org/c/coreboot/+/43352 )

Change subject: device/xhci: Add helper method to iterate over xhci_supported_protocl
......................................................................

Patch Set 1: Code-Review+2

[build bot (Jenkins) (Code Review)]

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

Change subject: device/xhci: Add helper method to iterate over xhci_supported_protocl
......................................................................

Patch Set 2:

(1 comment)

https://review.coreboot.org/c/coreboot/+/43352/2/src/device/xhci.c 
File src/device/xhci.c:

https://review.coreboot.org/c/coreboot/+/43352/2/src/device/xhci.c@103 
PS2, Line 103: enum cb_err xhci_for_each_supported_usb_cap(
that open brace { should be on the previous line

[Furquan Shaikh (Code Review)]

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

Change subject: device/xhci: Add helper method to iterate over xhci_supported_protocl
......................................................................

Patch Set 2: Code-Review+2

[Felix Held (Code Review)]

Felix Held has submitted this change. ( https://review.coreboot.org/c/coreboot/+/43352 )

Change subject: device/xhci: Add helper method to iterate over xhci_supported_protocl
......................................................................

device/xhci: Add helper method to iterate over xhci_supported_protocl

There is some boilerplate required to iterate over the USB supported
protocol structs. Encapsulate all the in a method to make the callers
simpler.

BUG=b:154756391
TEST=Built test trembyle.

Signed-off-by: Raul E Rangel 
Change-Id: I401f10d242638b0000ba697573856d765333dca0
Reviewed-on: https://review.coreboot.org/c/coreboot/+/43352
Reviewed-by: Furquan Shaikh 
Reviewed-by: Aaron Durbin 
Tested-by: build bot (Jenkins) 
---
M src/device/xhci.c
M src/include/device/xhci.h
2 files changed, 47 insertions(+), 2 deletions(-)

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

diff --git a/src/device/xhci.c b/src/device/xhci.c
index ce1c1b2..d4cacef 100644
--- a/src/device/xhci.c
+++ b/src/device/xhci.c
@@ -1,9 +1,10 @@
 /* SPDX-License-Identifier: GPL-2.0-or-later */

-#include <device/xhci.h>
+#include <arch/mmio.h>
 #include <console/console.h>
 #include <device/pci_def.h>
-#include <arch/mmio.h>
+#include <device/xhci.h>
+#include <string.h>

union xhci_ext_caps_header {
    uint32_t val;
@@ -75,6 +76,42 @@
    return CB_SUCCESS;
 }

+struct supported_usb_cap_context {
+	void *context;
+	void (*callback)(void *context, const struct xhci_supported_protocol *data);
+};
+
+static void xhci_supported_usb_cap_handler(void *context, const struct xhci_ext_cap *cap)
+{
+	const struct xhci_supported_protocol *data;
+	struct supported_usb_cap_context *internal_context = context;
+
+	if (cap->cap_id != XHCI_ECP_CAP_ID_SUPP)
+		return;
+
+	data = &cap->supported_protocol;
+
+	if (memcmp(data->name, "USB ", 4)) {
+		printk(BIOS_DEBUG, "%s: Unknown Protocol: %.*s\n", __func__,
+		       (int)sizeof(data->name), data->name);
+		return;
+	}
+
+	internal_context->callback(internal_context->context, data);
+}
+
+enum cb_err xhci_for_each_supported_usb_cap(
+	const struct device *device, void *context,
+	void (*callback)(void *context, const struct xhci_supported_protocol *data))
+{
+	struct supported_usb_cap_context internal_context = {
+		.context = context,
+		.callback = callback,
+	};
+
+	return xhci_for_each_ext_cap(device, &internal_context, xhci_supported_usb_cap_handler);
+}
+
 void xhci_print_supported_protocol(const struct xhci_supported_protocol *supported_protocol)
 {
    printk(BIOS_DEBUG, "xHCI Supported Protocol:\n");
diff --git a/src/include/device/xhci.h b/src/include/device/xhci.h
index 25f950b..17ce846 100644
--- a/src/include/device/xhci.h
+++ b/src/include/device/xhci.h
@@ -52,6 +52,14 @@
    			  void (*callback)(void *context,
    					   const struct xhci_ext_cap *cap));

+/**
+ * Helper method that iterates over only the USB supported capabilities structures in the
+ * xHCI Extended Capabilities List.
+ */
+enum cb_err xhci_for_each_supported_usb_cap(
+	const struct device *device, void *context,
+	void (*callback)(void *context, const struct xhci_supported_protocol *data));
+
 void xhci_print_supported_protocol(const struct xhci_supported_protocol *supported_protocol);

#endif /* __DEVICE_XHCI_H__ */