Skip to contentSkip to conversation

usb: gadget: composite: Fix bMaxPower for SuperSpeedPlus

PATCH Superseded Jack Pham 2 participants 9 messages Oct 23, 2019 – Oct 30, 2019

Subsystems (2)

v1 of 4 Superseded Latest is v4 →

lore
Share & tools
lore

Jack Pham

author
#0 lore raw

PATCH 1/2 usb: gadget: composite: Fix bMaxPower for SuperSpeedPlus

SuperSpeedPlus peripherals must report their bMaxPower of the configuration descriptor in units of 8mA as per the USB 3.2 specification. The current switch statement in encode_bMaxPower() only checks for USB_SPEED_SUPER but not USB_SPEED_SUPER_PLUS so the latter falls back to USB 2.0 encoding which uses 2mA units. Replace the switch with a simple if/else.

Fixes eae5820b852f ("usb: gadget: composite: Write SuperSpeedPlus config descriptors")
---
 drivers/usb/gadget/composite.c | 8 +++-----
 1 file changed, 3 insertions(+), 5 deletions(-)
drivers/usb/gadget/composite.c +3 -5
index d516e8d6cd7f..e1db94d1fe2e 100644
@@ -437,12 +437,10 @@ static u8 encode_bMaxPower(enum usb_device_speed speed,
 		val = CONFIG_USB_GADGET_VBUS_DRAW;
 	if (!val)
 		return 0;
-	switch (speed) {
-	case USB_SPEED_SUPER:
-		return DIV_ROUND_UP(val, 8);
-	default:
+	if (speed < USB_SPEED_SUPER)
 		return DIV_ROUND_UP(val, 2);
-	}
+	else
+		return DIV_ROUND_UP(val, 8);
 }
 
 static int config_buf(struct usb_configuration *config,
Signature · 1 line
2.21.0
author
#1 lore raw

PATCH 2/2 usb: gadget: composite: Support more than 500mA MaxPower

USB 3.x SuperSpeed peripherals can draw up to 900mA of VBUS power when in configured state. However, if a configuration wanting to take advantage of this is added with MaxPower greater than 500 (currently possible if using a ConfigFS gadget) the composite driver fails to accommodate this for a couple reasons:

- usb_gadget_vbus_draw() when called from set_config() and composite_resume() will be passed the MaxPower value without regard for the current connection speed, resulting in a violation for USB 2.0 since the max is 500mA.

- the bMaxPower of the configuration descriptor would be incorrectly encoded, again if the connection speed is only at USB 2.0 or below, likely wrapping around UINT8_MAX since the 2mA multiplier corresponds to a maximum of 610mA.

Fix these by adding checks against the current gadget->speed when the c->MaxPower value is used and appropriately limit based on whether it is currently at a low-/full-/high- or super- speed connection.

Incidentally, 900 is not divisble by 8, so even for super-speed the bMaxPower neds to be capped at 896mA, otherwise due to the round-up division a MaxPower of 900 will result in an encoded value of 904mA and many host stacks (including Linux and Windows) of a root port will reject the configuration.

N.B. USB 3.2 Gen N x 2 allows for up to 1500mA but there doesn't seem to be any any peripheral controller supported by Linux that does two lane operation, so for now keeping the clamp at 900 should be fine.

---
 drivers/usb/gadget/composite.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/usb/gadget/composite.c +11 -2
index e1db94d1fe2e..92ce3018f482 100644
@@ -438,9 +438,10 @@ static u8 encode_bMaxPower(enum usb_device_speed speed,
 	if (!val)
 		return 0;
 	if (speed < USB_SPEED_SUPER)
-		return DIV_ROUND_UP(val, 2);
+		return DIV_ROUND_UP(min(val, 500U), 2);
 	else
-		return DIV_ROUND_UP(val, 8);
+		/* USB 3.x supports 900mA, but that isn't divisible by 8... */
+		return DIV_ROUND_UP(min(val, 896U), 8);
 }
 
 static int config_buf(struct usb_configuration *config,
@@ -852,6 +853,10 @@ static int set_config(struct usb_composite_dev *cdev,
 
 	/* when we return, be sure our power usage is valid */
 	power = c->MaxPower ? c->MaxPower : CONFIG_USB_GADGET_VBUS_DRAW;
+	if (gadget->speed < USB_SPEED_SUPER)
+		power = min(power, 500U);
+	else
+		power = min(power, 900U);
 done:
 	usb_gadget_vbus_draw(gadget, power);
 	if (result >= 0 && cdev->delayed_status)
@@ -2289,6 +2294,10 @@ void composite_resume(struct usb_gadget *gadget)
 		}
 
 		maxpower = cdev->config->MaxPower;
+		if (gadget->speed < USB_SPEED_SUPER)
+			maxpower = min_t(u16, maxpower, 500U);
+		else
+			maxpower = min_t(u16, maxpower, 900U);
 
 		usb_gadget_vbus_draw(gadget, maxpower ?
 			maxpower : CONFIG_USB_GADGET_VBUS_DRAW);
Signature · 1 line
2.21.0
author
#2 lore raw

Re: [PATCH 2/2] usb: gadget: composite: Support more than 500mA MaxPower

Quoted 11 lines · Jack Pham

USB 3.x SuperSpeed peripherals can draw up to 900mA of VBUS power when in configured state. However, if a configuration wanting to take advantage of this is added with MaxPower greater than 500 (currently possible if using a ConfigFS gadget) the composite driver fails to accommodate this for a couple reasons:

- usb_gadget_vbus_draw() when called from set_config() and composite_resume() will be passed the MaxPower value without regard for the current connection speed, resulting in a violation for USB 2.0 since the max is 500mA.

Quoted 4 lines

- the bMaxPower of the configuration descriptor would be incorrectly encoded, again if the connection speed is only at USB 2.0 or below, likely wrapping around UINT8_MAX since the 2mA multiplier corresponds to a maximum of 610mA.

                                                    ^^^^^

Argh, my bad math/typo. Should be 510mA (UINT8_MAX = 255 * 2mA).

Jack

Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum,
a Linux Foundation Collaborative Project
#3 lore raw

Re: [PATCH 2/2] usb: gadget: composite: Support more than 500mA MaxPower

In reply to Jack Pham

Hi,

Quoted 16 lines · Jack Pham

USB 3.x SuperSpeed peripherals can draw up to 900mA of VBUS power when in configured state. However, if a configuration wanting to take advantage of this is added with MaxPower greater than 500 (currently possible if using a ConfigFS gadget) the composite driver fails to accommodate this for a couple reasons:

- usb_gadget_vbus_draw() when called from set_config() and composite_resume() will be passed the MaxPower value without regard for the current connection speed, resulting in a violation for USB 2.0 since the max is 500mA.

- the bMaxPower of the configuration descriptor would be incorrectly encoded, again if the connection speed is only at USB 2.0 or below, likely wrapping around UINT8_MAX since the 2mA multiplier corresponds to a maximum of 610mA.

Quoted 7 lines

Fix these by adding checks against the current gadget->speed when the c->MaxPower value is used and appropriately limit based on whether it is currently at a low-/full-/high- or super- speed connection.

Incidentally, 900 is not divisble by 8, so even for super-speed the bMaxPower neds to be capped at 896mA, otherwise due to the

                ^^^^
                needs

Why do you need to cap it? DIV_ROUND_UP() should still work.

Quoted 19 lines

round-up division a MaxPower of 900 will result in an encoded value of 904mA and many host stacks (including Linux and Windows) of a root port will reject the configuration.

N.B. USB 3.2 Gen N x 2 allows for up to 1500mA but there doesn't seem to be any any peripheral controller supported by Linux that does two lane operation, so for now keeping the clamp at 900 should be fine.

---
 drivers/usb/gadget/composite.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/usb/gadget/composite.c +0 -0
index e1db94d1fe2e..92ce3018f482 100644

drivers/usb/gadget/composite.c static u8 encode_bMaxPower(enum usb_device_speed speed, · line 444

Quoted 9 lines
drivers/usb/gadget/composite.c +3 -2
@@ -438,9 +438,10 @@ static u8 encode_bMaxPower(enum usb_device_speed speed,
 	if (!val)
 		return 0;
 	if (speed < USB_SPEED_SUPER)
-		return DIV_ROUND_UP(val, 2);
+		return DIV_ROUND_UP(min(val, 500U), 2);
 	else
-		return DIV_ROUND_UP(val, 8);
+		/* USB 3.x supports 900mA, but that isn't divisible by 8... */
+		return DIV_ROUND_UP(min(val, 896U), 8);

DIV_ROUND_UP(896, 8) = 112
DIV_ROUND_UP(900, 8) = 113

Why value do you want here?

Signature · 1 line
balbi
#4 lore raw

Re: [PATCH 2/2] usb: gadget: composite: Support more than 500mA MaxPower

Quoted 24 lines · Felipe Balbi

Hi,

Quoted 21 lines · Jack Pham

USB 3.x SuperSpeed peripherals can draw up to 900mA of VBUS power when in configured state. However, if a configuration wanting to take advantage of this is added with MaxPower greater than 500 (currently possible if using a ConfigFS gadget) the composite driver fails to accommodate this for a couple reasons:

- usb_gadget_vbus_draw() when called from set_config() and composite_resume() will be passed the MaxPower value without regard for the current connection speed, resulting in a violation for USB 2.0 since the max is 500mA.

- the bMaxPower of the configuration descriptor would be incorrectly encoded, again if the connection speed is only at USB 2.0 or below, likely wrapping around UINT8_MAX since the 2mA multiplier corresponds to a maximum of 610mA.

Fix these by adding checks against the current gadget->speed when the c->MaxPower value is used and appropriately limit based on whether it is currently at a low-/full-/high- or super- speed connection.

Quoted 6 lines
Quoted 2 lines

Incidentally, 900 is not divisble by 8, so even for super-speed the bMaxPower neds to be capped at 896mA, otherwise due to the

                ^^^^
                needs

Why do you need to cap it? DIV_ROUND_UP() should still work.

The round up causes 900 on the input side to be greater than 900 when doing the reverse, i.e. multiplication by 8.

Alternatively we could just do a normal integer division here (effectively round down).

Quoted 33 lines
Quoted 19 lines

round-up division a MaxPower of 900 will result in an encoded value of 904mA and many host stacks (including Linux and Windows) of a root port will reject the configuration.

N.B. USB 3.2 Gen N x 2 allows for up to 1500mA but there doesn't seem to be any any peripheral controller supported by Linux that does two lane operation, so for now keeping the clamp at 900 should be fine.

---
 drivers/usb/gadget/composite.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/usb/gadget/composite.c +0 -0
index e1db94d1fe2e..92ce3018f482 100644

drivers/usb/gadget/composite.c static u8 encode_bMaxPower(enum usb_device_speed · line 445

Quoted 10 lines
drivers/usb/gadget/composite.c +3 -2
@@ -438,9 +438,10 @@ static u8 encode_bMaxPower(enum usb_device_speed 
 speed,
 	if (!val)
 		return 0;
 	if (speed < USB_SPEED_SUPER)
-		return DIV_ROUND_UP(val, 2);
+		return DIV_ROUND_UP(min(val, 500U), 2);
 	else
-		return DIV_ROUND_UP(val, 8);
+		/* USB 3.x supports 900mA, but that isn't divisible by 8... */
+		return DIV_ROUND_UP(min(val, 896U), 8);

DIV_ROUND_UP(896, 8) = 112
DIV_ROUND_UP(900, 8) = 113

Quoted 1 line

Why value do you want here?

Right, but now on the host it will do the reverse calculation, i.e. 113*8 == 904mA. For a root port this would be greater than it's maximum power budget of 900mA and would result in not selecting the config.

author
#8 lore raw

PATCH v2 2/2 usb: gadget: composite: Support more than 500mA MaxPower

In reply to Jack Pham

USB 3.x SuperSpeed peripherals can draw up to 900mA of VBUS power when in configured state. However, if a configuration wanting to take advantage of this is added with MaxPower greater than 500 (currently possible if using a ConfigFS gadget) the composite driver fails to accommodate this for a couple reasons:

- usb_gadget_vbus_draw() when called from set_config() and composite_resume() will be passed the MaxPower value without regard for the current connection speed, resulting in a violation for USB 2.0 since the max is 500mA.

- the bMaxPower of the configuration descriptor would be incorrectly encoded, again if the connection speed is only at USB 2.0 or below, likely wrapping around UINT8_MAX since the 2mA multiplier corresponds to a maximum of 510mA.

Fix these by adding checks against the current gadget->speed when the c->MaxPower value is used and appropriately limit based on whether it is currently at a low-/full-/high- or super- speed connection.

Incidentally, 900 is not divisible by 8, so even for Superspeed the bMaxPower needs to be capped at 896mA, otherwise due to the round-up division a MaxPower of 900mA will result in an encoded value of 0x71. When a host stack (including Linux and Windows) enumerates this on a single port root hub, it reads this value back and decodes (multiplies by 8) to get 904mA which is strictly greater than 900mA that is typically budgeted for that port, causing it to reject the configuration.

N.B. USB 3.2 Gen N x 2 allows for up to 1500mA but there doesn't seem to be any any peripheral controller supported by Linux that does two lane operation, so for now keeping the clamp at 900 should be fine.

---
v2: Fix typos in commit text and reworded the blurb about rounding

 drivers/usb/gadget/composite.c | 13 +++++++++++--
 1 file changed, 11 insertions(+), 2 deletions(-)
drivers/usb/gadget/composite.c +11 -2
index e1db94d1fe2e..92ce3018f482 100644
@@ -438,9 +438,10 @@ static u8 encode_bMaxPower(enum usb_device_speed speed,
 	if (!val)
 		return 0;
 	if (speed < USB_SPEED_SUPER)
-		return DIV_ROUND_UP(val, 2);
+		return DIV_ROUND_UP(min(val, 500U), 2);
 	else
-		return DIV_ROUND_UP(val, 8);
+		/* USB 3.x supports 900mA, but that isn't divisible by 8... */
+		return DIV_ROUND_UP(min(val, 896U), 8);
 }
 
 static int config_buf(struct usb_configuration *config,
@@ -852,6 +853,10 @@ static int set_config(struct usb_composite_dev *cdev,
 
 	/* when we return, be sure our power usage is valid */
 	power = c->MaxPower ? c->MaxPower : CONFIG_USB_GADGET_VBUS_DRAW;
+	if (gadget->speed < USB_SPEED_SUPER)
+		power = min(power, 500U);
+	else
+		power = min(power, 900U);
 done:
 	usb_gadget_vbus_draw(gadget, power);
 	if (result >= 0 && cdev->delayed_status)
@@ -2289,6 +2294,10 @@ void composite_resume(struct usb_gadget *gadget)
 		}
 
 		maxpower = cdev->config->MaxPower;
+		if (gadget->speed < USB_SPEED_SUPER)
+			maxpower = min_t(u16, maxpower, 500U);
+		else
+			maxpower = min_t(u16, maxpower, 900U);
 
 		usb_gadget_vbus_draw(gadget, maxpower ?
 			maxpower : CONFIG_USB_GADGET_VBUS_DRAW);
Signature · 1 line
2.21.0
#5 lore raw

Re: [PATCH 2/2] usb: gadget: composite: Support more than 500mA MaxPower

In reply to [email protected]

Hi,

Quoted 39 lines · [email protected] writes:
Quoted 24 lines · Felipe Balbi

Hi,

Quoted 21 lines · Jack Pham

USB 3.x SuperSpeed peripherals can draw up to 900mA of VBUS power when in configured state. However, if a configuration wanting to take advantage of this is added with MaxPower greater than 500 (currently possible if using a ConfigFS gadget) the composite driver fails to accommodate this for a couple reasons:

- usb_gadget_vbus_draw() when called from set_config() and composite_resume() will be passed the MaxPower value without regard for the current connection speed, resulting in a violation for USB 2.0 since the max is 500mA.

- the bMaxPower of the configuration descriptor would be incorrectly encoded, again if the connection speed is only at USB 2.0 or below, likely wrapping around UINT8_MAX since the 2mA multiplier corresponds to a maximum of 610mA.

Fix these by adding checks against the current gadget->speed when the c->MaxPower value is used and appropriately limit based on whether it is currently at a low-/full-/high- or super- speed connection.

Quoted 6 lines
Quoted 2 lines

Incidentally, 900 is not divisble by 8, so even for super-speed the bMaxPower neds to be capped at 896mA, otherwise due to the

                ^^^^
                needs

Why do you need to cap it? DIV_ROUND_UP() should still work.

The round up causes 900 on the input side to be greater than 900 when doing the
reverse, i.e. multiplication by 8.

Alternatively we could just do a normal integer division here (effectively
round down).

(...)

Quoted 4 lines
Quoted 4 lines

DIV_ROUND_UP(896, 8) = 112
DIV_ROUND_UP(900, 8) = 113

Why value do you want here?

^^^
I mean which, sorry

Quoted 4 lines

Right, but now on the host it will do the reverse calculation, i.e. 113*8 == 904mA. For a root port this would be greater than it's maximum power budget of 900mA and would result in not selecting the config.

That's a very good explanation of the problem, thank you. It seems like a round down would be safer here in all cases.

Signature · 1 line
balbi
author
#6 lore raw

Re: [PATCH 2/2] usb: gadget: composite: Support more than 500mA MaxPower

Hi Felipe,

Quoted 53 lines · Felipe Balbi

Hi,

Quoted 39 lines · [email protected] writes:
Quoted 24 lines · Felipe Balbi

Hi,

Quoted 21 lines · Jack Pham

USB 3.x SuperSpeed peripherals can draw up to 900mA of VBUS power when in configured state. However, if a configuration wanting to take advantage of this is added with MaxPower greater than 500 (currently possible if using a ConfigFS gadget) the composite driver fails to accommodate this for a couple reasons:

- usb_gadget_vbus_draw() when called from set_config() and composite_resume() will be passed the MaxPower value without regard for the current connection speed, resulting in a violation for USB 2.0 since the max is 500mA.

- the bMaxPower of the configuration descriptor would be incorrectly encoded, again if the connection speed is only at USB 2.0 or below, likely wrapping around UINT8_MAX since the 2mA multiplier corresponds to a maximum of 610mA.

Fix these by adding checks against the current gadget->speed when the c->MaxPower value is used and appropriately limit based on whether it is currently at a low-/full-/high- or super- speed connection.

Quoted 6 lines
Quoted 2 lines

Incidentally, 900 is not divisble by 8, so even for super-speed the bMaxPower neds to be capped at 896mA, otherwise due to the

                ^^^^
                needs

Why do you need to cap it? DIV_ROUND_UP() should still work.

The round up causes 900 on the input side to be greater than 900 when doing the
reverse, i.e. multiplication by 8.

Alternatively we could just do a normal integer division here (effectively
round down).

(...)

Quoted 4 lines
Quoted 4 lines

DIV_ROUND_UP(896, 8) = 112
DIV_ROUND_UP(900, 8) = 113

Why value do you want here?

^^^
I mean which, sorry

Quoted 7 lines
Quoted 4 lines

Right, but now on the host it will do the reverse calculation, i.e. 113*8 == 904mA. For a root port this would be greater than it's maximum power budget of 900mA and would result in not selecting the config.

That's a very good explanation of the problem, thank you. It seems like a round down would be safer here in all cases.

Ok, so do you mean something like:

if (speed < USB_SPEED_SUPER)
- return DIV_ROUND_UP(val, 2);
+ return DIV_ROUND_UP(min(val, 500U), 2);
else
- return DIV_ROUND_UP(val, 8);
+ /*
+ * USB 3.x supports up to 900mA, but since 900 isn't
+ * divisible by 8, we need to round down.
+ */
+ return min(val, 900U) / 8;

Or by "all cases" did you also mean high/full/low speeds too where the divisor is 2mA (in the first part of the if/else)? Otherwise it looks a little inconsistent using two modes of division here. Technically the calculation would then be changed for any odd values less than 500mA but we're only talking about a difference of 2mA here...

Jack

Signature · 2 lines
The Qualcomm Innovation Center, Inc. is a member of Code Aurora Forum,
a Linux Foundation Collaborative Project
#7 lore raw

Re: [PATCH 2/2] usb: gadget: composite: Support more than 500mA MaxPower

Hi,

Quoted 71 lines · Jack Pham
Quoted 50 lines
Quoted 39 lines · [email protected] writes:
Quoted 24 lines · Felipe Balbi

Hi,

Quoted 21 lines · Jack Pham

USB 3.x SuperSpeed peripherals can draw up to 900mA of VBUS power when in configured state. However, if a configuration wanting to take advantage of this is added with MaxPower greater than 500 (currently possible if using a ConfigFS gadget) the composite driver fails to accommodate this for a couple reasons:

- usb_gadget_vbus_draw() when called from set_config() and composite_resume() will be passed the MaxPower value without regard for the current connection speed, resulting in a violation for USB 2.0 since the max is 500mA.

- the bMaxPower of the configuration descriptor would be incorrectly encoded, again if the connection speed is only at USB 2.0 or below, likely wrapping around UINT8_MAX since the 2mA multiplier corresponds to a maximum of 610mA.

Fix these by adding checks against the current gadget->speed when the c->MaxPower value is used and appropriately limit based on whether it is currently at a low-/full-/high- or super- speed connection.

Quoted 6 lines
Quoted 2 lines

Incidentally, 900 is not divisble by 8, so even for super-speed the bMaxPower neds to be capped at 896mA, otherwise due to the

                ^^^^
                needs

Why do you need to cap it? DIV_ROUND_UP() should still work.

The round up causes 900 on the input side to be greater than 900 when doing the
reverse, i.e. multiplication by 8.

Alternatively we could just do a normal integer division here (effectively
round down).

(...)

Quoted 4 lines
Quoted 4 lines

DIV_ROUND_UP(896, 8) = 112
DIV_ROUND_UP(900, 8) = 113

Why value do you want here?

^^^
I mean which, sorry

Quoted 7 lines
Quoted 4 lines

Right, but now on the host it will do the reverse calculation, i.e. 113*8 == 904mA. For a root port this would be greater than it's maximum power budget of 900mA and would result in not selecting the config.

That's a very good explanation of the problem, thank you. It seems like a round down would be safer here in all cases.

Ok, so do you mean something like:

if (speed < USB_SPEED_SUPER)

drivers/usb/gadget/composite.c +1 -1
-		return DIV_ROUND_UP(val, 2);
+		return DIV_ROUND_UP(min(val, 500U), 2);

else

(quoted diff) +5 -1
-		return DIV_ROUND_UP(val, 8);
+		/*
+		 * USB 3.x supports up to 900mA, but since 900 isn't
+		 * divisible by 8, we need to round down.
+		 */
+		return min(val, 900U) / 8;
Quoted 5 lines

Or by "all cases" did you also mean high/full/low speeds too where the divisor is 2mA (in the first part of the if/else)? Otherwise it looks a little inconsistent using two modes of division here. Technically the calculation would then be changed for any odd values less than 500mA but we're only talking about a difference of 2mA here...

yeah, It should be okay to use round down for fs, hs and ls as well. Thinking about it, this bMaxPower should be treated as a "at most this much"; but never more than maximum.

Signature · 1 line
balbi