2023-06-22 08:18:11

by Benjamin Bara

[permalink] [raw]
Subject: [PATCH v5 0/3] usb: misc: onboard_usb_hub: add support for Cypress HX3 USB 3.0 family

Hi!

This series adds support for the Cypress HX3 USB 3.0 family (2/3). For
now, it just contains the USB-related aspects and ignores the option to
connect it via i2c (3/3).

As the HX3 family operates with two power supplies, multiple power
supply support is implemented (1/3).

Thanks & best regards,
Benjamin

---
Changes in v5:
- 1/3: use ARRAY_SIZE(supply_names) for MAX_SUPPLIES
- Link to v4: https://lore.kernel.org/r/[email protected]

Changes in v4:
- 1/3: set num_supplies=1 for the existing hubs
- 1/3: drop duplicate num_supplies in onboard_hub struct
- 1/3: clarify connection between supply_names and MAX_SUPPLIES
- Link to v3: https://lore.kernel.org/r/[email protected]

Changes in v3:
- 1/3: fix nits mentioned by Matthias
- Link to v2: https://lore.kernel.org/r/[email protected]

Changes in v2:
- don't re-order by VID/PID (thanks to Matthias)
- 1/3: replace (err != 0) with (err)
- Link to v1: https://lore.kernel.org/r/[email protected]

---
Benjamin Bara (3):
usb: misc: onboard-hub: support multiple power supplies
usb: misc: onboard-hub: add support for Cypress HX3 USB 3.0 family
dt-bindings: usb: Add binding for Cypress HX3 USB 3.0 family

.../devicetree/bindings/usb/cypress,hx3.yaml | 77 ++++++++++++++++++++++
drivers/usb/misc/onboard_usb_hub.c | 40 ++++++++---
drivers/usb/misc/onboard_usb_hub.h | 14 ++++
3 files changed, 123 insertions(+), 8 deletions(-)
---
base-commit: 45a3e24f65e90a047bef86f927ebdc4c710edaa1
change-id: 20230620-hx3-cb935b4fdd76

Best regards,
--
Benjamin Bara <[email protected]>



2023-06-22 08:22:37

by Benjamin Bara

[permalink] [raw]
Subject: [PATCH v5 3/3] dt-bindings: usb: Add binding for Cypress HX3 USB 3.0 family

From: Benjamin Bara <[email protected]>

The HX3 family comes in different variants (up to 4 USB 3.0 ports;
multi-TT), e.g. CYUSB330x/CYUSB331x/CYUSB332x/CYUSB230x.

This initial version of the binding only describes USB related aspects
of the HX3 family, it does not cover the option of connecting the
controller as an i2c slave.

Reviewed-by: Rob Herring <[email protected]>
Signed-off-by: Benjamin Bara <[email protected]>
---
.../devicetree/bindings/usb/cypress,hx3.yaml | 77 ++++++++++++++++++++++
1 file changed, 77 insertions(+)

diff --git a/Documentation/devicetree/bindings/usb/cypress,hx3.yaml b/Documentation/devicetree/bindings/usb/cypress,hx3.yaml
new file mode 100644
index 000000000000..47add0d85fb8
--- /dev/null
+++ b/Documentation/devicetree/bindings/usb/cypress,hx3.yaml
@@ -0,0 +1,77 @@
+# SPDX-License-Identifier: GPL-2.0-only or BSD-2-Clause
+%YAML 1.2
+---
+$id: http://devicetree.org/schemas/usb/cypress,hx3.yaml#
+$schema: http://devicetree.org/meta-schemas/core.yaml#
+
+title: Cypress HX3 USB 3.0 hub controller family
+
+maintainers:
+ - Benjamin Bara <[email protected]>
+
+allOf:
+ - $ref: usb-device.yaml#
+
+properties:
+ compatible:
+ enum:
+ - usb4b4,6504
+ - usb4b4,6506
+
+ reg: true
+
+ reset-gpios:
+ items:
+ - description: GPIO specifier for RESETN pin.
+
+ vdd-supply:
+ description:
+ 1V2 power supply (VDD_EFUSE, AVDD12, DVDD12).
+
+ vdd2-supply:
+ description:
+ 3V3 power supply (AVDD33, VDD_IO).
+
+ peer-hub:
+ $ref: /schemas/types.yaml#/definitions/phandle
+ description:
+ phandle to the peer hub on the controller.
+
+required:
+ - compatible
+ - reg
+ - peer-hub
+ - vdd-supply
+ - vdd2-supply
+
+additionalProperties: false
+
+examples:
+ - |
+ #include <dt-bindings/gpio/gpio.h>
+
+ usb {
+ dr_mode = "host";
+ #address-cells = <1>;
+ #size-cells = <0>;
+
+ /* 2.0 hub on port 1 */
+ hub_2_0: hub@1 {
+ compatible = "usb4b4,6504";
+ reg = <1>;
+ peer-hub = <&hub_3_0>;
+ reset-gpios = <&gpio1 11 GPIO_ACTIVE_LOW>;
+ vdd-supply = <&reg_1v2_usb>;
+ vdd2-supply = <&reg_3v3_usb>;
+ };
+
+ /* 3.0 hub on port 2 */
+ hub_3_0: hub@2 {
+ compatible = "usb4b4,6506";
+ reg = <2>;
+ peer-hub = <&hub_2_0>;
+ reset-gpios = <&gpio1 11 GPIO_ACTIVE_LOW>;
+ vdd-supply = <&reg_1v2_usb>;
+ vdd2-supply = <&reg_3v3_usb>;
+ };
+ };

--
2.34.1


2023-06-22 08:22:38

by Benjamin Bara

[permalink] [raw]
Subject: [PATCH v5 2/3] usb: misc: onboard-hub: add support for Cypress HX3 USB 3.0 family

From: Benjamin Bara <[email protected]>

The HX3 comes in different variants (up to 4 USB 3.0 ports; multi-TT),
e.g. CYUSB330x/CYUSB331x/CYUSB332x/CYUSB230x. It operates with two
different power supplies: 1V2 and 3V3.

Add the support for this hub, for controlling the reset pin and the
power supplies.

Reset time is extracted from data sheet, page 24:
"The RESETN pin can be tied to VDD_IO through an external resistor and
to ground (GND) through an external capacitor (minimum 5 ms time
constant)."
V_IH min is given at 0.7 * 3V3 (page 34), therefore use 10ms.

Also add USB PIDs for the USB 2.0 and USB 3.0 root hub.

Acked-by: Matthias Kaehlcke <[email protected]>
Signed-off-by: Benjamin Bara <[email protected]>
---
drivers/usb/misc/onboard_usb_hub.c | 3 +++
drivers/usb/misc/onboard_usb_hub.h | 7 +++++++
2 files changed, 10 insertions(+)

diff --git a/drivers/usb/misc/onboard_usb_hub.c b/drivers/usb/misc/onboard_usb_hub.c
index 1bbbc6948484..5a528de1189c 100644
--- a/drivers/usb/misc/onboard_usb_hub.c
+++ b/drivers/usb/misc/onboard_usb_hub.c
@@ -350,6 +350,7 @@ static struct platform_driver onboard_hub_driver = {

/************************** USB driver **************************/

+#define VENDOR_ID_CYPRESS 0x04b4
#define VENDOR_ID_GENESYS 0x05e3
#define VENDOR_ID_MICROCHIP 0x0424
#define VENDOR_ID_REALTEK 0x0bda
@@ -428,6 +429,8 @@ static void onboard_hub_usbdev_disconnect(struct usb_device *udev)
}

static const struct usb_device_id onboard_hub_id_table[] = {
+ { USB_DEVICE(VENDOR_ID_CYPRESS, 0x6504) }, /* CYUSB33{0,1,2}x/CYUSB230x 3.0 */
+ { USB_DEVICE(VENDOR_ID_CYPRESS, 0x6506) }, /* CYUSB33{0,1,2}x/CYUSB230x 2.0 */
{ USB_DEVICE(VENDOR_ID_GENESYS, 0x0608) }, /* Genesys Logic GL850G USB 2.0 */
{ USB_DEVICE(VENDOR_ID_GENESYS, 0x0610) }, /* Genesys Logic GL852G USB 2.0 */
{ USB_DEVICE(VENDOR_ID_MICROCHIP, 0x2514) }, /* USB2514B USB 2.0 */
diff --git a/drivers/usb/misc/onboard_usb_hub.h b/drivers/usb/misc/onboard_usb_hub.h
index 41a4127a92dc..6f446fe7d2f7 100644
--- a/drivers/usb/misc/onboard_usb_hub.h
+++ b/drivers/usb/misc/onboard_usb_hub.h
@@ -26,6 +26,11 @@ static const struct onboard_hub_pdata ti_tusb8041_data = {
.num_supplies = 1,
};

+static const struct onboard_hub_pdata cypress_hx3_data = {
+ .reset_us = 10000,
+ .num_supplies = 2,
+};
+
static const struct onboard_hub_pdata genesys_gl850g_data = {
.reset_us = 3,
.num_supplies = 1,
@@ -46,6 +51,8 @@ static const struct of_device_id onboard_hub_match[] = {
{ .compatible = "usb424,2517", .data = &microchip_usb424_data, },
{ .compatible = "usb451,8140", .data = &ti_tusb8041_data, },
{ .compatible = "usb451,8142", .data = &ti_tusb8041_data, },
+ { .compatible = "usb4b4,6504", .data = &cypress_hx3_data, },
+ { .compatible = "usb4b4,6506", .data = &cypress_hx3_data, },
{ .compatible = "usb5e3,608", .data = &genesys_gl850g_data, },
{ .compatible = "usb5e3,610", .data = &genesys_gl852g_data, },
{ .compatible = "usbbda,411", .data = &realtek_rts5411_data, },

--
2.34.1


2023-06-22 08:23:11

by Benjamin Bara

[permalink] [raw]
Subject: [PATCH v5 1/3] usb: misc: onboard-hub: support multiple power supplies

From: Benjamin Bara <[email protected]>

As some of the onboard hubs require multiple power supplies, provide the
environment to support them.

Signed-off-by: Benjamin Bara <[email protected]>
---
v5:
- use ARRAY_SIZE(supply_names) for MAX_SUPPLIES

v4:
- set num_supplies=1 for the existing hubs
- drop duplicate num_supplies in onboard_hub struct
- clarify connection between supply_names and MAX_SUPPLIES

v3:
- fix nits mentioned in v2

v2:
- replace (err != 0) with (err)
---
drivers/usb/misc/onboard_usb_hub.c | 37 +++++++++++++++++++++++++++++--------
drivers/usb/misc/onboard_usb_hub.h | 7 +++++++
2 files changed, 36 insertions(+), 8 deletions(-)

diff --git a/drivers/usb/misc/onboard_usb_hub.c b/drivers/usb/misc/onboard_usb_hub.c
index 12fc6eb67c3b..1bbbc6948484 100644
--- a/drivers/usb/misc/onboard_usb_hub.c
+++ b/drivers/usb/misc/onboard_usb_hub.c
@@ -27,6 +27,17 @@

#include "onboard_usb_hub.h"

+/*
+ * Use generic names, as the actual names might differ between hubs. If a new
+ * hub requires more than the currently supported supplies, add a new one here.
+ */
+static const char * const supply_names[] = {
+ "vdd",
+ "vdd2",
+};
+
+#define MAX_SUPPLIES ARRAY_SIZE(supply_names)
+
static void onboard_hub_attach_usb_driver(struct work_struct *work);

static struct usb_device_driver onboard_hub_usbdev_driver;
@@ -40,7 +51,7 @@ struct usbdev_node {
};

struct onboard_hub {
- struct regulator *vdd;
+ struct regulator_bulk_data supplies[MAX_SUPPLIES];
struct device *dev;
const struct onboard_hub_pdata *pdata;
struct gpio_desc *reset_gpio;
@@ -55,9 +66,9 @@ static int onboard_hub_power_on(struct onboard_hub *hub)
{
int err;

- err = regulator_enable(hub->vdd);
+ err = regulator_bulk_enable(hub->pdata->num_supplies, hub->supplies);
if (err) {
- dev_err(hub->dev, "failed to enable regulator: %d\n", err);
+ dev_err(hub->dev, "failed to enable supplies: %d\n", err);
return err;
}

@@ -75,9 +86,9 @@ static int onboard_hub_power_off(struct onboard_hub *hub)

gpiod_set_value_cansleep(hub->reset_gpio, 1);

- err = regulator_disable(hub->vdd);
+ err = regulator_bulk_disable(hub->pdata->num_supplies, hub->supplies);
if (err) {
- dev_err(hub->dev, "failed to disable regulator: %d\n", err);
+ dev_err(hub->dev, "failed to disable supplies: %d\n", err);
return err;
}

@@ -232,6 +243,7 @@ static int onboard_hub_probe(struct platform_device *pdev)
const struct of_device_id *of_id;
struct device *dev = &pdev->dev;
struct onboard_hub *hub;
+ unsigned int i;
int err;

hub = devm_kzalloc(dev, sizeof(*hub), GFP_KERNEL);
@@ -246,9 +258,18 @@ static int onboard_hub_probe(struct platform_device *pdev)
if (!hub->pdata)
return -EINVAL;

- hub->vdd = devm_regulator_get(dev, "vdd");
- if (IS_ERR(hub->vdd))
- return PTR_ERR(hub->vdd);
+ if (hub->pdata->num_supplies > MAX_SUPPLIES)
+ return dev_err_probe(dev, -EINVAL, "max %d supplies supported!\n",
+ MAX_SUPPLIES);
+
+ for (i = 0; i < hub->pdata->num_supplies; i++)
+ hub->supplies[i].supply = supply_names[i];
+
+ err = devm_regulator_bulk_get(dev, hub->pdata->num_supplies, hub->supplies);
+ if (err) {
+ dev_err(dev, "Failed to get regulator supplies: %d\n", err);
+ return err;
+ }

hub->reset_gpio = devm_gpiod_get_optional(dev, "reset",
GPIOD_OUT_HIGH);
diff --git a/drivers/usb/misc/onboard_usb_hub.h b/drivers/usb/misc/onboard_usb_hub.h
index aca5f50eb0da..41a4127a92dc 100644
--- a/drivers/usb/misc/onboard_usb_hub.h
+++ b/drivers/usb/misc/onboard_usb_hub.h
@@ -8,30 +8,37 @@

struct onboard_hub_pdata {
unsigned long reset_us; /* reset pulse width in us */
+ unsigned int num_supplies; /* number of supplies */
};

static const struct onboard_hub_pdata microchip_usb424_data = {
.reset_us = 1,
+ .num_supplies = 1,
};

static const struct onboard_hub_pdata realtek_rts5411_data = {
.reset_us = 0,
+ .num_supplies = 1,
};

static const struct onboard_hub_pdata ti_tusb8041_data = {
.reset_us = 3000,
+ .num_supplies = 1,
};

static const struct onboard_hub_pdata genesys_gl850g_data = {
.reset_us = 3,
+ .num_supplies = 1,
};

static const struct onboard_hub_pdata genesys_gl852g_data = {
.reset_us = 50,
+ .num_supplies = 1,
};

static const struct onboard_hub_pdata vialab_vl817_data = {
.reset_us = 10,
+ .num_supplies = 1,
};

static const struct of_device_id onboard_hub_match[] = {

--
2.34.1


2023-06-22 09:56:56

by kernel test robot

[permalink] [raw]
Subject: Re: [PATCH v5 1/3] usb: misc: onboard-hub: support multiple power supplies

Hi Benjamin,

kernel test robot noticed the following build warnings:

[auto build test WARNING on 45a3e24f65e90a047bef86f927ebdc4c710edaa1]

url: https://github.com/intel-lab-lkp/linux/commits/Benjamin-Bara/usb-misc-onboard-hub-support-multiple-power-supplies/20230622-161859
base: 45a3e24f65e90a047bef86f927ebdc4c710edaa1
patch link: https://lore.kernel.org/r/20230620-hx3-v5-1-319c9c4c846f%40skidata.com
patch subject: [PATCH v5 1/3] usb: misc: onboard-hub: support multiple power supplies
config: alpha-allyesconfig (https://download.01.org/0day-ci/archive/20230622/[email protected]/config)
compiler: alpha-linux-gcc (GCC) 12.3.0
reproduce: (https://download.01.org/0day-ci/archive/20230622/[email protected]/reproduce)

If you fix the issue in a separate patch/commit (i.e. not just a new version of
the same patch/commit), kindly add following tags
| Reported-by: kernel test robot <[email protected]>
| Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/

All warnings (new ones prefixed by >>):

drivers/usb/misc/onboard_usb_hub.c: In function 'onboard_hub_probe':
>> drivers/usb/misc/onboard_usb_hub.c:262:58: warning: format '%d' expects argument of type 'int', but argument 4 has type 'long unsigned int' [-Wformat=]
262 | return dev_err_probe(dev, -EINVAL, "max %d supplies supported!\n",
| ~^
| |
| int
| %ld


vim +262 drivers/usb/misc/onboard_usb_hub.c

240
241 static int onboard_hub_probe(struct platform_device *pdev)
242 {
243 const struct of_device_id *of_id;
244 struct device *dev = &pdev->dev;
245 struct onboard_hub *hub;
246 unsigned int i;
247 int err;
248
249 hub = devm_kzalloc(dev, sizeof(*hub), GFP_KERNEL);
250 if (!hub)
251 return -ENOMEM;
252
253 of_id = of_match_device(onboard_hub_match, &pdev->dev);
254 if (!of_id)
255 return -ENODEV;
256
257 hub->pdata = of_id->data;
258 if (!hub->pdata)
259 return -EINVAL;
260
261 if (hub->pdata->num_supplies > MAX_SUPPLIES)
> 262 return dev_err_probe(dev, -EINVAL, "max %d supplies supported!\n",
263 MAX_SUPPLIES);
264
265 for (i = 0; i < hub->pdata->num_supplies; i++)
266 hub->supplies[i].supply = supply_names[i];
267
268 err = devm_regulator_bulk_get(dev, hub->pdata->num_supplies, hub->supplies);
269 if (err) {
270 dev_err(dev, "Failed to get regulator supplies: %d\n", err);
271 return err;
272 }
273
274 hub->reset_gpio = devm_gpiod_get_optional(dev, "reset",
275 GPIOD_OUT_HIGH);
276 if (IS_ERR(hub->reset_gpio))
277 return dev_err_probe(dev, PTR_ERR(hub->reset_gpio), "failed to get reset GPIO\n");
278
279 hub->dev = dev;
280 mutex_init(&hub->lock);
281 INIT_LIST_HEAD(&hub->udev_list);
282
283 dev_set_drvdata(dev, hub);
284
285 err = onboard_hub_power_on(hub);
286 if (err)
287 return err;
288
289 /*
290 * The USB driver might have been detached from the USB devices by
291 * onboard_hub_remove() (e.g. through an 'unbind' by userspace),
292 * make sure to re-attach it if needed.
293 *
294 * This needs to be done deferred to avoid self-deadlocks on systems
295 * with nested onboard hubs.
296 */
297 schedule_work(&attach_usb_driver_work);
298
299 return 0;
300 }
301

--
0-DAY CI Kernel Test Service
https://github.com/intel/lkp-tests/wiki

2023-06-22 11:21:37

by Benjamin Bara

[permalink] [raw]
Subject: Re: [PATCH v5 1/3] usb: misc: onboard-hub: support multiple power supplies

On Thu, 22 Jun 2023 at 11:29, kernel test robot <[email protected]> wrote:
>
> Hi Benjamin,
>
> kernel test robot noticed the following build warnings:
>
> [auto build test WARNING on 45a3e24f65e90a047bef86f927ebdc4c710edaa1]
>
> url: https://github.com/intel-lab-lkp/linux/commits/Benjamin-Bara/usb-misc-onboard-hub-support-multiple-power-supplies/20230622-161859
> base: 45a3e24f65e90a047bef86f927ebdc4c710edaa1
> patch link: https://lore.kernel.org/r/20230620-hx3-v5-1-319c9c4c846f%40skidata.com
> patch subject: [PATCH v5 1/3] usb: misc: onboard-hub: support multiple power supplies
> config: alpha-allyesconfig (https://download.01.org/0day-ci/archive/20230622/[email protected]/config)
> compiler: alpha-linux-gcc (GCC) 12.3.0
> reproduce: (https://download.01.org/0day-ci/archive/20230622/[email protected]/reproduce)
>
> If you fix the issue in a separate patch/commit (i.e. not just a new version of
> the same patch/commit), kindly add following tags
> | Reported-by: kernel test robot <[email protected]>
> | Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
>
> All warnings (new ones prefixed by >>):
>
> drivers/usb/misc/onboard_usb_hub.c: In function 'onboard_hub_probe':
> >> drivers/usb/misc/onboard_usb_hub.c:262:58: warning: format '%d' expects argument of type 'int', but argument 4 has type 'long unsigned int' [-Wformat=]
> 262 | return dev_err_probe(dev, -EINVAL, "max %d supplies supported!\n",
> | ~^
> | |
> | int
> | %ld

Thanks Mr. Robot, seems like I forgot to compile with Werr :/
I will wait for other feedback and fix this in the next round.

Sorry for that...

best regards,
Benjamin

2023-06-22 16:54:47

by Matthias Kaehlcke

[permalink] [raw]
Subject: Re: [PATCH v5 1/3] usb: misc: onboard-hub: support multiple power supplies

On Thu, Jun 22, 2023 at 12:26:01PM +0200, Benjamin Bara wrote:
> On Thu, 22 Jun 2023 at 11:29, kernel test robot <[email protected]> wrote:
> >
> > Hi Benjamin,
> >
> > kernel test robot noticed the following build warnings:
> >
> > [auto build test WARNING on 45a3e24f65e90a047bef86f927ebdc4c710edaa1]
> >
> > url: https://github.com/intel-lab-lkp/linux/commits/Benjamin-Bara/usb-misc-onboard-hub-support-multiple-power-supplies/20230622-161859
> > base: 45a3e24f65e90a047bef86f927ebdc4c710edaa1
> > patch link: https://lore.kernel.org/r/20230620-hx3-v5-1-319c9c4c846f%40skidata.com
> > patch subject: [PATCH v5 1/3] usb: misc: onboard-hub: support multiple power supplies
> > config: alpha-allyesconfig (https://download.01.org/0day-ci/archive/20230622/[email protected]/config)
> > compiler: alpha-linux-gcc (GCC) 12.3.0
> > reproduce: (https://download.01.org/0day-ci/archive/20230622/[email protected]/reproduce)
> >
> > If you fix the issue in a separate patch/commit (i.e. not just a new version of
> > the same patch/commit), kindly add following tags
> > | Reported-by: kernel test robot <[email protected]>
> > | Closes: https://lore.kernel.org/oe-kbuild-all/[email protected]/
> >
> > All warnings (new ones prefixed by >>):
> >
> > drivers/usb/misc/onboard_usb_hub.c: In function 'onboard_hub_probe':
> > >> drivers/usb/misc/onboard_usb_hub.c:262:58: warning: format '%d' expects argument of type 'int', but argument 4 has type 'long unsigned int' [-Wformat=]
> > 262 | return dev_err_probe(dev, -EINVAL, "max %d supplies supported!\n",
> > | ~^
> > | |
> > | int
> > | %ld
>
> Thanks Mr. Robot, seems like I forgot to compile with Werr :/
> I will wait for other feedback and fix this in the next round.

The patch looks good to me with the above fixed.