Skip to contentSkip to conversation

usb:gadget: Add SuperSpeed support to the Gadget Framework

PATCH Superseded tlinder 6 participants 18 messages Oct 3, 2010 – Nov 11, 2010

Subsystems (2)

v1 of 15 Superseded Latest is v15 →

lore
Share & tools
lore

tlinder

author
#0 lore raw

PATCH 2/2 usb:gadget: Add SuperSpeed support to the Gadget Framework

From: Tatyana Linder <[email protected]>

This patch adds the SuperSpeed functionality to the gadget framework. In order not to force all the FDs to supply SuperSpeed descriptors when operating in SuperSpeed mode the following approach was taken:
If we're operating in SuperSpeed mode and the FD didn't supply SuperSpeed descriptors, the composite layer will automatically create SuperSpeed descriptors with default values.
Support for new SuperSpeed BOS descriptor was added.
Support for SET_FEATURE and GET_STATUS requests in SuperSpeed mode was added.

---
This patch was verified by USBCV 3.0 and 2.0.

 drivers/usb/gadget/Kconfig     |   20 ++-
 drivers/usb/gadget/composite.c |  319 +++++++++++++++++++++++++++++++++++++---
 include/linux/usb/ch9.h        |   54 +++++++-
 include/linux/usb/composite.h  |   24 +++
 include/linux/usb/gadget.h     |   19 +++
 5 files changed, 407 insertions(+), 29 deletions(-)
drivers/usb/gadget/Kconfig +16 -4
index cd27f9b..9afdd08 100644
@@ -520,11 +520,11 @@ config USB_GADGET_DUMMY_HCD
 	  side is the master; the gadget side is the slave.  Gadget drivers
 	  can be high, full, or low speed; and they have access to endpoints
 	  like those from NET2280, PXA2xx, or SA1100 hardware.
-	  
+
 	  This may help in some stages of creating a driver to embed in a
 	  Linux device, since it lets you debug several parts of the gadget
 	  driver without its hardware or drivers being involved.
-	  
+
 	  Since such a gadget side driver needs to interoperate with a host
 	  side Linux-USB device driver, this may help to debug both sides
 	  of a USB protocol stack.
@@ -552,6 +552,18 @@ config USB_GADGET_DUALSPEED
 	  Means that gadget drivers should include extra descriptors
 	  and code to handle dual-speed controllers.
 
+config USB_GADGET_SUPERSPEED
+	boolean "Gadget opperating in Super Speed"
+	depends on USB_GADGET
+	depends on USB_GADGET_DUALSPEED
+	default n
+	help
+	  Enabling this feature enables Super Speed support in the Gadget
+	  driver. It means that gadget drivers should include extra (SuperSpeed)
+	  descriptors.
+	  For composite devices: if SupeSpeed descriptors weren't supplied by
+	  the FD, they will be automatically generated with default values.
+
 #
 # USB Gadget Drivers
 #
@@ -633,7 +645,7 @@ config USB_ETH
 	help
 	  This driver implements Ethernet style communication, in one of
 	  several ways:
-	  
+
 	   - The "Communication Device Class" (CDC) Ethernet Control Model.
 	     That protocol is often avoided with pure Ethernet adapters, in
 	     favor of simpler vendor-specific hardware, but is widely
@@ -673,7 +685,7 @@ config USB_ETH_RNDIS
 	   If you say "y" here, the Ethernet gadget driver will try to provide
 	   a second device configuration, supporting RNDIS to talk to such
 	   Microsoft USB hosts.
-	   
+
 	   To make MS-Windows work with this, use Documentation/usb/linux.inf
 	   as the "driver info file".  For versions of MS-Windows older than
 	   XP, you'll need to download drivers from Microsoft's website; a URL
drivers/usb/gadget/composite.c +296 -23

490 lines not on this page · raw message

include/linux/usb/ch9.h +52 -2

80 lines not on this page · raw message

include/linux/usb/composite.h +24 -0
index c623bed..36ab1d0 100644
@@ -52,6 +52,18 @@ struct usb_configuration;
  * @hs_descriptors: Table of high speed descriptors, using interface and
  *	string identifiers assigned during @bind().  If this pointer is null,
  *	the function will not be available at high speed.
+ * @ss_descriptors: Table of super speed descriptors. If
+ *	wasnt supplied by the FD during @bind() and
+ *	!ss_not_capble, will be generated automaticly with
+ *	default values while working in superspeed mode. If this
+ *	pointer is null after initiation, the function will not
+ *	be available at super speed.
+ * @ss_not_capable: This flag is used by the FD to indicate if
+ *	this function is SS capble. Meaning: if SS descriptors
+ *	weren't supplied by the FD, and the flag is set ss
+ *	descriptors will NOT be automatically generated
+ * @ss_desc_allocated: This flag indicates whether the ss descriptors were
+ *	dynamically allocated (and needs to be released).
  * @config: assigned when @usb_add_function() is called; this is the
  *	configuration with which this function is associated.
  * @bind: Before the gadget can register, all of its functions bind() to the
@@ -70,6 +82,10 @@ struct usb_configuration;
  * @setup: Used for interface-specific control requests.
  * @suspend: Notifies functions when the host stops sending USB traffic.
  * @resume: Notifies functions when the host restarts USB traffic.
+ * @get_status: Returns function status as a reply to
+ *	GetStatus() request when the recepient is Interface.
+ * @func_suspend: callback to be called when
+ *	SetFeature(FUNCTION_SUSPEND) is reseived
  *
  * A single USB function uses one or more interfaces, and should in most
  * cases support operation at both full and high speeds.  Each function is
@@ -99,6 +115,10 @@ struct usb_function {
 	struct usb_gadget_strings	**strings;
 	struct usb_descriptor_header	**descriptors;
 	struct usb_descriptor_header	**hs_descriptors;
+	struct usb_descriptor_header	**ss_descriptors;
+
+	unsigned			ss_desc_allocated:1;
+	unsigned			ss_not_capable:1;
 
 	struct usb_configuration	*config;
 
@@ -125,6 +145,9 @@ struct usb_function {
 	void			(*suspend)(struct usb_function *);
 	void			(*resume)(struct usb_function *);
 
+	/* USB 3.0 additions */
+	int			(*get_status)(struct usb_function *);
+	int			(*func_suspend)(struct usb_function *);
 	/* private: */
 	/* internals */
 	struct list_head		list;
@@ -229,6 +252,7 @@ struct usb_configuration {
 	struct list_head	list;
 	struct list_head	functions;
 	u8			next_interface_id;
+	unsigned		superspeed:1;
 	unsigned		highspeed:1;
 	unsigned		fullspeed:1;
 	struct usb_function	*interface[MAX_CONFIG_INTERFACES];
include/linux/usb/gadget.h +19 -0
index bf7dc0b..40329b0 100644
@@ -139,6 +139,8 @@ struct usb_ep_ops {
  * @desc:endpoint descriptor.  this pointer set before endpoint is enabled and
  *	remains valid until the endpoint is disabled; the data byte order
  *	is little-endian (usb-standard).
+ * @comp_desc: In case of SuperSpeed support, this is the
+ *	endpoint companion descriptor that is used to configure the endpoint
  *
  * the bus controller driver lists all the general purpose endpoints in
  * gadget->ep_list.  the control endpoint (gadget->ep0) is not in that list,
@@ -153,6 +155,7 @@ struct usb_ep {
 	unsigned			maxpacket:16;
 	u8				bEndpointAddress;
 	struct usb_endpoint_descriptor	*desc;
+	struct usb_ss_ep_comp_descriptor	*comp_desc;
 };
 
 /*-------------------------------------------------------------------------*/
@@ -525,6 +528,22 @@ static inline int gadget_is_dualspeed(struct usb_gadget *g)
 }
 
 /**
+ * gadget_is_superspeed - return true if the hardware handles
+ * supperspeed
+ */
+static inline int gadget_is_superspeed(struct usb_gadget *g)
+{
+#ifdef CONFIG_USB_GADGET_SUPERSPEED
+	/* runtime test would check "g->is_superspeed" ... that might be
+	 * useful to work around hardware bugs, but is mostly pointless
+	 */
+	return 1;
+#else
+	return 0;
+#endif
+}
+
+/**
  * gadget_is_otg - return true iff the hardware is OTG-ready
  * @g: controller that might have a Mini-AB connector
  *
Signature · 5 lines
1.6.3.3

--
Sent by an  consultant of the Qualcomm Innovation Center, Inc.
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum.
#1 lore raw
Quoted 11 lines · tlinder

From: Tatyana Linder <[email protected]>

This patch adds the SuperSpeed functionality to the gadget framework. In order not to force all the FDs to supply SuperSpeed descriptors when operating in SuperSpeed mode the following approach was taken:
If we're operating in SuperSpeed mode and the FD didn't supply SuperSpeed descriptors, the composite layer will automatically create SuperSpeed descriptors with default values.
Support for new SuperSpeed BOS descriptor was added.
Support for SET_FEATURE and GET_STATUS requests in SuperSpeed mode was added.

...

Quoted 12 lines
include/linux/usb/ch9.h +4 -0
index da2ed77..69e528a 100644
@@ -125,6 +125,20 @@
 
 #define USB_ENDPOINT_HALT		0	/* IN/OUT will STALL */
 
+/**
+ * New Feature Selectors as added by USB 3.0
+ * See USB 3.0 spec Table 9-6
+ */

include/linux/usb/ch9.h line 141

Quoted 10 lines
include/linux/usb/ch9.h +10 -0
+#define USB_DEVICE_U1_ENABLE		48	/*enables the upstream port to
+						initiate requests for transition
+						into U1 state*/
+#define USB_DEVICE_U2_ENABLE		49	/*enables the upstream port to
+						initiate requests for transition
+						into U2 state*/
+#define USB_DEVICE_LTM_ENABLE		50	/*enables the devise to send
+						Latency tolerance messages.*/
+#define USB_INTRF_FUNC_SUSPEND		0	/*function suspend*/
+

Since these are device and interface features, they belong before the endpoint feature above, not after it.

include/linux/usb/ch9.h struct usb_wireless_cap_descriptor { /* Ultra Wide Band */ · line 744

Quoted 3 lines
include/linux/usb/ch9.h +3 -0
+/*SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
+  specific device level capabilities*/
+#define	SS_USB_CAP_TYPE		3

This should be USB_SS_CAP_TYPE.

Quoted 5 lines
include/linux/usb/ch9.h +5 -0
+struct ss_usb_cap_descriptor {		/* Link Power Management */
+	__u8  bLength;
+	__u8  bDescriptorType;
+	__u8  bDevCapabilityType;
+	__u8  bmAttributes;

include/linux/usb/ch9.h struct usb_wireless_cap_descriptor { /* Ultra Wide Band */ · line 759

Quoted 10 lines
include/linux/usb/ch9.h +10 -0
+#define USB_LTM_SUPPORT			(1 << 1) /* supports LTM */
+	__u16 wSpeedSupported;
+#define USB_LOW_SPEED_OPERATION		(1)	 /* Low speed operation */
+#define USB_FULL_SPEED_OPERATION	(1 << 1) /* Full speed operation */
+#define USB_HIGH_SPEED_OPERATION	(1 << 2) /* High speed operation */
+#define USB_5GBPS_OPERATION		(1 << 3) /* Operation at 5Gbps */
+	__u8  bFunctionalitySupport;
+	__u8  bU1devExitLat;
+	__u16 bU2DevExitLat;
+} __attribute__((packed));

Similarly, this should usb_ss_cap_descriptor (by analogy with usb_otg_descriptor or usb_wireless_cap_descriptor).

Quoted 4 lines
include/linux/usb/ch9.h +4 -0
+#define USB_DT_SS_USB_CAP_SIZE	10
+
+/*Container ID Capability descriptor: Defines the instance unique ID used to
+  identify the instance across all operating modes*/

include/linux/usb/ch9.h struct usb_wireless_cap_descriptor { /* Ultra Wide Band */ · line 774

Quoted 10 lines
include/linux/usb/ch9.h +10 -0
+#define	CONTAINER_ID_TYPE	4
+struct ss_usb_container_id_descriptor {
+	__u8  bLength;
+	__u8  bDescriptorType;
+	__u8  bDevCapabilityType;
+	__u8  bReserved;
+	__u8  ContainerID[16]; /*128-bit number*/
+} __attribute__((packed));
+
+#define USB_DT_SS_CONTN_ID_SIZE	20

And this should be usb_ss_container_id_descriptor.

Alan Stern

#2 lore raw
In reply to tlinder

I seem to have missed any posting of a SuperSpeed capable USB Device Controller driver, even as RFC.

So these patches can't actually achieve what their subjects say.

I'd rather hold off such interface changes until there's a orking vertical slice through the stack, complete enough to test and evaluate the changes.

That said: yes, propose the interface changes first before diving into the rest.

- Dave

#3 lore raw

Hi Dave

We're currently working on USB Device Controller implementation. We already have a working setup in our lab which these changes were verified on. We passed USBCV 3.0 and 2.0 tests with this setup.
In parallel we added SuperSpeed support to the dummy_hcd module and tested the patch using it as well. Changes to dummy_hcd will be release in a few days.

Regards,
Tanya

I seem to have missed any posting of a SuperSpeed

Quoted 18 lines

capable USB Device Controller driver, even as RFC.

So these patches can't actually achieve what their subjects say.

I'd rather hold off such interface changes until there's a orking vertical slice through the stack, complete enough to test and evaluate the changes.

That said: yes, propose the interface changes first before diving into the rest.

- Dave

#4 lore raw

Resending since not everyone received my reply.

-----Original Message-----
From: [email protected] [mailto:[email protected]]
Sent: Tuesday, October 05, 2010 9:15 AM
To: David Brownell
Cc: [email protected]; tlinder; David Brownell; Greg Kroah-Hartman; Michal Nazarewicz; Randy Dunlap; Laurent Pinchart; Kyungmin Park; Robert Lukassen; Sarah Sharp; Matthew Wilcox; Fabien Chouteau; Tejun Heo; [email protected]
Subject: Re: [RFC/PATCH 2/2] usb:gadget: Add SuperSpeed support to the Gadget Framework

Hi Dave

We're currently working on USB Device Controller implementation. We already have a working setup in our lab which these changes were verified on. We passed USBCV 3.0 and 2.0 tests with this setup.
In parallel we added SuperSpeed support to the dummy_hcd module and tested the patch using it as well. Changes to dummy_hcd will be release in a few days.

Regards,
Tanya

I seem to have missed any posting of a SuperSpeed

Quoted 18 lines

capable USB Device Controller driver, even as RFC.

So these patches can't actually achieve what their subjects say.

I'd rather hold off such interface changes until there's a orking vertical slice through the stack, complete enough to test and evaluate the changes.

That said: yes, propose the interface changes first before diving into the rest.

- Dave

#5 lore raw
In reply to tlinder
Quoted 1 line · tlinder

In order not to force all the FDs to supply

What do File Descriptors have to do with this?

If you don't mean FD == File Descriptor, then please spell out what you do mean, instead of trying to repurpose a widely used abbreviation.

SuperSpeed

Quoted 8 lines

descriptors when
operating in SuperSpeed mode the following approach was taken:
If we're operating in SuperSpeed mode and the FD didn't supply SuperSpeed
descriptors, the composite layer will automatically create SuperSpeed
descriptors with default values.

That bothers me in two ways. First, I want to see a solution that maintains today's policy where the composite framework is optional for all gadget drivers.

Second, that kind of automagic bothers me.

What could be wrong with expecting gadget drivers to provide all the descriptors they need, instead of introducing automagic?

Quoted 1 line

Support for new SuperSpeed BOS descriptor was

Wireless USB BOS descriptors exist too, yes? Does this approach cover them, or just SuperSpeed? (We may someday want to support Wireless USB on the peripheral/gadget side too...

Quoted 2 lines

+++++++++++++++++++++++++++++++++++++---
include/linux/usb/ch9.h

I like to see patches related to USB-IF formats and protocols be separate from functional changes in the USB stack or its drivers. which may rely on those formats/protocols; less entanglement.

Quoted 6 lines
drivers/usb/gadget/Kconfig +3 -0
+
 
+config USB_GADGET_SUPERSPEED
+    boolean "Gadget opperating in Super

Speed"
+    depends on USB_GADGET

Quoted 8 lines

+    depends on USB_GADGET_DUALSPEED
+    default n
+    help
+      Enabling this feature enables
Super Speed support in the Gadget
+      driver. It means that gadget
drivers should include extra (SuperSpeed)
+      descriptors.

That is: the automagic isn't needed. The concepts in this patch seem to be a bit on the self-contradictory side...

ep_comp_desc = {

Quoted 5 lines

+        .bDescriptorType =
USB_DT_SS_ENDPOINT_COMP,
+        .bLength = 0x06,
+        .bMaxBurst = 0,
/*the default is we don't support bursting*/

I've not followed the SuperSpeed stuff as closely as I might, but ... doesn't bursting require some hardware support? So that not all UDC + driver
stacks can support it? (That'd be a case, if so,
for more sanity checks ... and the gadget driver to explicitly say if it handles bursting.

#6 lore raw
Quoted 11 lines
Quoted 1 line · tlinder

In order not to force all the FDs to supply

What do File Descriptors have to do with this?

If you don't mean FD == File Descriptor, then please spell out what you do mean, instead of trying to repurpose a widely used abbreviation.

By FD we meant Function Drivers. We'll update the patch description.

Quoted 12 lines

SuperSpeed

Quoted 8 lines

descriptors when
operating in SuperSpeed mode the following approach was taken:
If we're operating in SuperSpeed mode and the FD didn't supply SuperSpeed
descriptors, the composite layer will automatically create SuperSpeed
descriptors with default values.

Quoted 4 lines

That bothers me in two ways. First, I want to see a solution that maintains today's policy where the composite framework is optional for all gadget drivers.

This policy is maintained. Gadget drivers are not required to use the composite framework in order to work in SuperSpeed mode. If a certain driver wishes to do so, without using the composite framework, it should add definitions of SuperSpeed descriptors and support of new SuperSpeed features. If a driver wishes to work in High/Low speeds then no changes are needed.
Please note that this change is backward compatible.
In order to test a non composite gadget driver we used the File storage. We managed to load the file_storage gadget driver (while the SuperSpeed gadget flag is enabled) and the File Storage successfully registered as a high speed driver and enumerated with a super speed host.
We also tested a composite gadget driver (mass storage) that defines the descriptors and doesn't use the automatic and it worked successfully. All the other gadget drivers were also tested using the automatic composite framework and managed to enumerate.

Quoted 6 lines

Second, that kind of automagic bothers me.

What could be wrong with expecting gadget drivers to provide all the descriptors they need, instead of introducing automagic?

In the current implementation a gadget driver can still provide his own SuperSpeed descriptors as it provides HighSpeed descriptors and not use the automation.
Implementing the automatic creation of the SuperSpeed descriptors approach has several benefits:
1. All existing gadget drivers (that use the composite framework) are operational in SuperSpeed mode without any modifications to their code
2. Code duplication, of the additional SuperSpeed descriptors in each existing gadget driver, is spared: A gadget driver that doesn't wish to exploit the SuperSpeed capabilities (such as streaming for example) but wishes to operate in a SuperSpeed mode is not required to provide additional SuperSpeed descriptors with default values (meaning, that none of the SuperSpeed capabilities are supported by it). Such will be created for it automatically.
2. Single snippet of code tested for all existing gadget drivers

Quoted 8 lines
Quoted 3 lines

Support for new SuperSpeed BOS descriptor was

Wireless USB BOS descriptors exist too, yes? Does this approach cover them, or just SuperSpeed? (We may someday want to support Wireless USB on the peripheral/gadget side too...

In the current implementation the composite framework supports GetDescriptor(BOS) request only if the gadget driver supports SuperSpeed. In order to extend this functionality for wireless USB one should add another condition (is_wireless_USB()) to the existing if().

Quoted 10 lines
Quoted 5 lines

+++++++++++++++++++++++++++++++++++++---
include/linux/usb/ch9.h

I like to see patches related to USB-IF formats and protocols be separate from functional changes in the USB stack or its drivers. which may rely on those formats/protocols; less entanglement.

We will divide this patch into two patches.

Quoted 16 lines

Quoted 6 lines
drivers/usb/gadget/Kconfig +3 -0
+
 
+config USB_GADGET_SUPERSPEED
+    boolean "Gadget opperating in Super

Speed"
+    depends on USB_GADGET

Quoted 8 lines

+    depends on USB_GADGET_DUALSPEED
+    default n
+    help
+      Enabling this feature enables
Super Speed support in the Gadget
+      driver. It means that gadget
drivers should include extra (SuperSpeed)
+      descriptors.

Quoted 3 lines

That is: the automagic isn't needed. The concepts in this patch seem to be a bit on the self-contradictory side...

You are correct. We should change the comment as follows; "...It means that gadget drivers should provide extra (SuperSpeed) descriptors to the host."

Quoted 8 lines

ep_comp_desc = {

Quoted 5 lines

+        .bDescriptorType =
USB_DT_SS_ENDPOINT_COMP,
+        .bLength = 0x06,
+        .bMaxBurst = 0,
/*the default is we don't support bursting*/

Quoted 6 lines

I've not followed the SuperSpeed stuff as closely as I might, but ... doesn't bursting require some hardware support? So that not all UDC + driver
stacks can support it? (That'd be a case, if so,
for more sanity checks ... and the gadget driver to explicitly say if it handles bursting.

You're right. Bursting and streaming functionality support is defined by the UDC and not the gadget framework.
Due to the above, the create_ss_descriptors() is used for providing default SuperSpeed descriptors, meaning that streaming and bursting is not supported.

Quoted 4 lines
#7 lore raw

It seems that not everyone received this email.

Quoted 151 lines
Quoted 11 lines
Quoted 1 line · tlinder

In order not to force all the FDs to supply

What do File Descriptors have to do with this?

If you don't mean FD == File Descriptor, then please spell out what you do mean, instead of trying to repurpose a widely used abbreviation.

By FD we meant Function Drivers. We'll update the patch description.

Quoted 12 lines

SuperSpeed

Quoted 8 lines

descriptors when
operating in SuperSpeed mode the following approach was taken:
If we're operating in SuperSpeed mode and the FD didn't supply SuperSpeed
descriptors, the composite layer will automatically create SuperSpeed
descriptors with default values.

Quoted 4 lines

That bothers me in two ways. First, I want to see a solution that maintains today's policy where the composite framework is optional for all gadget drivers.

This policy is maintained. Gadget drivers are not required to use the composite framework in order to work in SuperSpeed mode. If a certain driver wishes to do so, without using the composite framework, it should add definitions of SuperSpeed descriptors and support of new SuperSpeed features. If a driver wishes to work in High/Low speeds then no changes are needed.
Please note that this change is backward compatible.
In order to test a non composite gadget driver we used the File storage. We managed to load the file_storage gadget driver (while the SuperSpeed gadget flag is enabled) and the File Storage successfully registered as a high speed driver and enumerated with a super speed host.
We also tested a composite gadget driver (mass storage) that defines the descriptors and doesn't use the automatic and it worked successfully. All the other gadget drivers were also tested using the automatic composite framework and managed to enumerate.

Quoted 6 lines

Second, that kind of automagic bothers me.

What could be wrong with expecting gadget drivers to provide all the descriptors they need, instead of introducing automagic?

In the current implementation a gadget driver can still provide his own SuperSpeed descriptors as it provides HighSpeed descriptors and not use the automation.
Implementing the automatic creation of the SuperSpeed descriptors approach has several benefits:
1. All existing gadget drivers (that use the composite framework) are operational in SuperSpeed mode without any modifications to their code
2. Code duplication, of the additional SuperSpeed descriptors in each existing gadget driver, is spared: A gadget driver that doesn't wish to exploit the SuperSpeed capabilities (such as streaming for example) but wishes to operate in a SuperSpeed mode is not required to provide additional SuperSpeed descriptors with default values (meaning, that none of the SuperSpeed capabilities are supported by it). Such will be created for it automatically.
2. Single snippet of code tested for all existing gadget drivers

Quoted 8 lines
Quoted 3 lines

Support for new SuperSpeed BOS descriptor was

Wireless USB BOS descriptors exist too, yes? Does this approach cover them, or just SuperSpeed? (We may someday want to support Wireless USB on the peripheral/gadget side too...

In the current implementation the composite framework supports GetDescriptor(BOS) request only if the gadget driver supports SuperSpeed. In order to extend this functionality for wireless USB one should add another condition (is_wireless_USB()) to the existing if().

Quoted 10 lines
Quoted 5 lines

+++++++++++++++++++++++++++++++++++++---
include/linux/usb/ch9.h

I like to see patches related to USB-IF formats and protocols be separate from functional changes in the USB stack or its drivers. which may rely on those formats/protocols; less entanglement.

We will divide this patch into two patches.

Quoted 16 lines

Quoted 6 lines
drivers/usb/gadget/Kconfig +3 -0
+
 
+config USB_GADGET_SUPERSPEED
+    boolean "Gadget opperating in Super

Speed"
+    depends on USB_GADGET

Quoted 8 lines

+    depends on USB_GADGET_DUALSPEED
+    default n
+    help
+      Enabling this feature enables
Super Speed support in the Gadget
+      driver. It means that gadget
drivers should include extra (SuperSpeed)
+      descriptors.

Quoted 3 lines

That is: the automagic isn't needed. The concepts in this patch seem to be a bit on the self-contradictory side...

You are correct. We should change the comment as follows; "...It means that gadget drivers should provide extra (SuperSpeed) descriptors to the host."

Quoted 8 lines

ep_comp_desc = {

Quoted 5 lines

+        .bDescriptorType =
USB_DT_SS_ENDPOINT_COMP,
+        .bLength = 0x06,
+        .bMaxBurst = 0,
/*the default is we don't support bursting*/

Quoted 6 lines

I've not followed the SuperSpeed stuff as closely as I might, but ... doesn't bursting require some hardware support? So that not all UDC + driver
stacks can support it? (That'd be a case, if so,
for more sanity checks ... and the gadget driver to explicitly say if it handles bursting.

You're right. Bursting and streaming functionality support is defined by the UDC and not the gadget framework.
Due to the above, the create_ss_descriptors() is used for providing default SuperSpeed descriptors, meaning that streaming and bursting is not supported.

Quoted 4 lines
#8 lore raw
In reply to David Brownell
Quoted 7 lines · David Brownell
Quoted 2 lines

Support for new SuperSpeed BOS descriptor was

Wireless USB BOS descriptors exist too, yes? Does this approach cover them, or just SuperSpeed? (We may someday want to support Wireless USB on the peripheral/gadget side too...

Wireless USB also has endpoint companion descriptors similar to SuperSpeed.

I haven't received the patch email for some reason. If someone forwards it to me I can review it from a WUSB point of view.

David

Signature · 6 lines
David Vrabel, Senior Software Engineer, Drivers
CSR, Churchill House, Cambridge Business Park,  Tel: +44 (0)1223 692562
Cowley Road, Cambridge, CB4 0WZ                 http://www.csr.com/


Member of the CSR plc group of companies. CSR plc registered in England and Wales, registered number 4187346, registered office Churchill House, Cambridge Business Park, Cowley Road, Cambridge, CB4 0WZ, United Kingdom
#9 lore raw
In reply to tlinder

Hi Tatyana,

Comments inline. I'm not familiar with the gadget framework; I'm just curious about some descriptor choices.

Quoted 6 lines · tlinder
drivers/usb/gadget/composite.c +0 -0
index c619c80..a5dcfe1 100644
@@ -70,6 +70,102 @@ static char *iSerialNumber;
 module_param(iSerialNumber, charp, 0);

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 80

Quoted 10 lines
drivers/usb/gadget/composite.c +8 -0
 MODULE_PARM_DESC(iSerialNumber, "SerialNumber string");
 
+/** Default endpoint companion descriptor */
+static struct usb_ss_ep_comp_descriptor ep_comp_desc = {
+		.bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
+		.bLength = 0x06,
+		.bMaxBurst = 0, /*the default is we don't support bursting*/
+		.bmAttributes = 0, /*2^0 streams supported*/
+		.wBytesPerInterval = 0,
+};

Can you please set wBytesPerInterval to something sane for periodic endpoints? Perhaps have it set to the maximum packet size times the max burst size times Mult plus one, or less if the device *knows* it's going to send less data. It's used for xHC host controller scheduling, so it's important to get right for maximum bandwidth usage.

Quoted 53 lines
drivers/usb/gadget/composite.c +53 -0
+/**This function receives a pointer to usb_function and adds
+ * missing super speed descriptors in the ss_descriptor field
+ * according to its hs_descriptors field.
+ *
+ * In more details: this function copies f->hs_descriptors while
+ * updating the endpoint descriptor and adding endpoint
+ * companion descriptor
+ */
+static void create_ss_descriptors(struct usb_function *f)
+{
+	unsigned bytes; /*number of bytes to allocate*/
+	unsigned n_desc;    /* number of descriptors*/
+	void *mem; /*allocated memory to copy to*/
+	struct usb_descriptor_header **tmp;
+	struct usb_endpoint_descriptor	*ep_desc ;
+	struct usb_descriptor_header **src = f->hs_descriptors;
+
+	if (!f->hs_descriptors)
+		return;
+
+	/* Count number of EPs (in order to know how many SS_EP_COMPANION
+	   descriptors to add), the total number of descriptors and the sum of
+	   each descriptor bLength field in order to know how much memory to
+	   allocate*/
+	for (bytes = 0, n_desc = 0, tmp = src; *tmp; tmp++, n_desc++) {
+		if ((*tmp)->bDescriptorType == USB_DT_ENDPOINT) {
+			bytes += ep_comp_desc.bLength;
+			n_desc++;
+		}
+		bytes += (*tmp)->bLength;
+	}
+
+	bytes += (n_desc + 1) * sizeof(*tmp);
+	mem = kmalloc(bytes, GFP_KERNEL);
+	if (!mem)
+		return;
+
+	/* fill in pointers starting at "tmp",
+	 * to descriptors copied starting at "mem";
+	 * and return "ret"
+	 */
+	tmp = mem;
+	f->ss_descriptors  = mem;
+	mem += (n_desc + 1) * sizeof(*tmp);
+	while (*src) {
+		/*Copy the original descriptor*/
+		memcpy(mem, *src, (*src)->bLength);
+		switch ((*src)->bDescriptorType) {
+		case USB_DT_ENDPOINT:
+			/*update ep descriptor*/
+			ep_desc = (struct usb_endpoint_descriptor *)mem;
+			switch (ep_desc->bmAttributes &
+				USB_ENDPOINT_XFERTYPE_MASK) {

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 144

Quoted 10 lines
drivers/usb/gadget/composite.c +10 -0
+			case USB_ENDPOINT_XFER_CONTROL:
+				ep_desc->wMaxPacketSize = 512;
+				ep_desc->bInterval = 0;
+				break;
+			case USB_ENDPOINT_XFER_BULK:
+				ep_desc->wMaxPacketSize = 1024;
+				ep_desc->bInterval = 0;
+				break;
+			case USB_ENDPOINT_XFER_INT:
+			case USB_ENDPOINT_XFER_ISOC:

Why are you not setting wMaxPacketSize for periodic endpoints? Does it get set later? (I can't tell from this snippet.)

Quoted 24 lines
drivers/usb/gadget/composite.c +24 -0
+				break;
+			}
+			*tmp = mem;
+			tmp++;
+			mem += (*src)->bLength;
+			/*add ep companion descriptor*/
+			memcpy(mem, &ep_comp_desc, ep_comp_desc.bLength);
+			*tmp = mem;
+			tmp++;
+			mem += ep_comp_desc.bLength;
+			break;
+		default:
+			*tmp = mem;
+			tmp++;
+			mem += (*src)->bLength;
+			break;
+		}
+		src++;
+	}
+	*tmp = NULL; /*The last (struct usb_descriptor_header *) in the
+			descriptors vector is NULL*/
+	f->ss_desc_allocated = true;
+}
+

...

Quoted 32 lines
drivers/usb/gadget/composite.c +32 -0
+/**
+ * bos() - prepares the BOS (Binary Device Object) descriptor
+ * and its device capabilities descriptors. The bos descriptor
+ * should be supported by a Superspeed device.
+ */
+static int bos(struct usb_composite_dev *cdev)
+{
+	struct usb_bos_descriptor	*bos = cdev->req->buf;
+	struct usb_ext_cap_descriptor	*usb_ext = NULL;
+	struct ss_usb_cap_descriptor	*ss_cap = NULL;
+
+	bos->bLength = USB_DT_BOS_SIZE;
+	bos->bDescriptorType = USB_DT_BOS;
+
+	bos->wTotalLength = USB_DT_BOS_SIZE;
+	bos->bNumDeviceCaps = 0;
+
+	/* A SuperSpeed device shall include the USB2.0 extension descriptor and
+	   shall support LPM when operating in USB2.0 HS mode.*/
+	usb_ext = (struct usb_ext_cap_descriptor *)
+			(cdev->req->buf+bos->wTotalLength);
+	bos->bNumDeviceCaps++;
+	bos->wTotalLength += USB_DT_USB_EXT_CAP_SIZE;
+	usb_ext->bLength = USB_DT_USB_EXT_CAP_SIZE;
+	usb_ext->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
+	usb_ext->bDevCapabilityType = USB_CAP_TYPE_EXT;
+	usb_ext->bmAttributes = USB_LPM_SUPPORT;
+
+	/* The Superspeed USB Capability descriptor shall be implemented by all
+	   Superspeed devices. */
+	ss_cap = (struct ss_usb_cap_descriptor *)
+		(cdev->req->buf+bos->wTotalLength);

drivers/usb/gadget/composite.c static int count_configs(struct usb_composite_dev *cdev, unsigned type) · line 603

Quoted 10 lines
drivers/usb/gadget/composite.c +10 -0
+	bos->bNumDeviceCaps++;
+	bos->wTotalLength += USB_DT_SS_USB_CAP_SIZE;
+	ss_cap->bLength = USB_DT_SS_USB_CAP_SIZE;
+	ss_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
+	ss_cap->bDevCapabilityType = SS_USB_CAP_TYPE;
+	ss_cap->bmAttributes = 0; /*LTM is not supported yet*/
+	ss_cap->wSpeedSupported = USB_LOW_SPEED_OPERATION |
+				USB_FULL_SPEED_OPERATION |
+				USB_HIGH_SPEED_OPERATION |
+				USB_5GBPS_OPERATION;

So this gadget will be able to support all speeds?

drivers/usb/gadget/composite.c static int count_configs(struct usb_composite_dev *cdev, unsigned type) · line 606

Quoted 3 lines
drivers/usb/gadget/composite.c +3 -0
+	ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
+	ss_cap->bU1devExitLat = 0;
+	ss_cap->bU2DevExitLat = 0;

Are you really sure you want to set the exit latency for low power states to less than 1 microsecond? Without real hardware it would be difficult to test, but this seems overly optimistic.

Quoted 4 lines
include/linux/usb/ch9.h +0 -0
index da2ed77..69e528a 100644

...

include/linux/usb/ch9.h struct usb_wireless_cap_descriptor { /* Ultra Wide Band */ · line 774

Quoted 12 lines
include/linux/usb/ch9.h +12 -0
+/*Container ID Capability descriptor: Defines the instance unique ID used to
+  identify the instance across all operating modes*/
+#define	CONTAINER_ID_TYPE	4
+struct ss_usb_container_id_descriptor {
+	__u8  bLength;
+	__u8  bDescriptorType;
+	__u8  bDevCapabilityType;
+	__u8  bReserved;
+	__u8  ContainerID[16]; /*128-bit number*/
+} __attribute__((packed));
+
+#define USB_DT_SS_CONTN_ID_SIZE	20

I don't see generation of a container ID in the code. Are you going to implement it? It's only required for USB 3.0 hubs, and I'm not sure if the gadget framework supports hubs. Nothing else in your code seems to use this definition.

Sarah

#10 lore raw
Quoted 15 lines

Hi Tatyana,

Comments inline. I'm not familiar with the gadget framework; I'm just curious about some descriptor choices.

Quoted 9 lines · tlinder
drivers/usb/gadget/composite.c +0 -0
index c619c80..a5dcfe1 100644
@@ -70,6 +70,102 @@ static char *iSerialNumber;
 module_param(iSerialNumber, charp, 0);
 MODULE_PARM_DESC(iSerialNumber, "SerialNumber string");
 
Quoted 14 lines

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 80

Quoted 8 lines
drivers/usb/gadget/composite.c +8 -0
+/** Default endpoint companion descriptor */
+static struct usb_ss_ep_comp_descriptor ep_comp_desc = {
+		.bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
+		.bLength = 0x06,
+		.bMaxBurst = 0, /*the default is we don't support bursting*/
+		.bmAttributes = 0, /*2^0 streams supported*/
+		.wBytesPerInterval = 0,
+};

Can you please set wBytesPerInterval to something sane for periodic endpoints? Perhaps have it set to the maximum packet size times the max burst size times Mult plus one, or less if the device *knows* it's going to send less data. It's used for xHC host controller scheduling, so it's important to get right for maximum bandwidth usage.

This descriptor holds default values so both bMaxBurst and bmAttributes are set to 0, meaning bursting and streaming are not not supported. So Mult will be set to 0 as well. Mult defined only for iso endpoints and not for interrupt.
Due to the above I propose setting wBytesPerInterval to maxpacketsize for periodic endpoints.

Quoted 58 lines
Quoted 58 lines
drivers/usb/gadget/composite.c +58 -0
+/**This function receives a pointer to usb_function and adds
+ * missing super speed descriptors in the ss_descriptor field
+ * according to its hs_descriptors field.
+ *
+ * In more details: this function copies f->hs_descriptors while
+ * updating the endpoint descriptor and adding endpoint
+ * companion descriptor
+ */
+static void create_ss_descriptors(struct usb_function *f)
+{
+	unsigned bytes; /*number of bytes to allocate*/
+	unsigned n_desc;    /* number of descriptors*/
+	void *mem; /*allocated memory to copy to*/
+	struct usb_descriptor_header **tmp;
+	struct usb_endpoint_descriptor	*ep_desc ;
+	struct usb_descriptor_header **src = f->hs_descriptors;
+
+	if (!f->hs_descriptors)
+		return;
+
+	/* Count number of EPs (in order to know how many SS_EP_COMPANION
+	   descriptors to add), the total number of descriptors and the sum of
+	   each descriptor bLength field in order to know how much memory to
+	   allocate*/
+	for (bytes = 0, n_desc = 0, tmp = src; *tmp; tmp++, n_desc++) {
+		if ((*tmp)->bDescriptorType == USB_DT_ENDPOINT) {
+			bytes += ep_comp_desc.bLength;
+			n_desc++;
+		}
+		bytes += (*tmp)->bLength;
+	}
+
+	bytes += (n_desc + 1) * sizeof(*tmp);
+	mem = kmalloc(bytes, GFP_KERNEL);
+	if (!mem)
+		return;
+
+	/* fill in pointers starting at "tmp",
+	 * to descriptors copied starting at "mem";
+	 * and return "ret"
+	 */
+	tmp = mem;
+	f->ss_descriptors  = mem;
+	mem += (n_desc + 1) * sizeof(*tmp);
+	while (*src) {
+		/*Copy the original descriptor*/
+		memcpy(mem, *src, (*src)->bLength);
+		switch ((*src)->bDescriptorType) {
+		case USB_DT_ENDPOINT:
+			/*update ep descriptor*/
+			ep_desc = (struct usb_endpoint_descriptor *)mem;
+			switch (ep_desc->bmAttributes &
+				USB_ENDPOINT_XFERTYPE_MASK) {
+			case USB_ENDPOINT_XFER_CONTROL:
+				ep_desc->wMaxPacketSize = 512;
+				ep_desc->bInterval = 0;
+				break;
+			case USB_ENDPOINT_XFER_BULK:
Quoted 8 lines

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 144

Quoted 5 lines
drivers/usb/gadget/composite.c +5 -0
+				ep_desc->wMaxPacketSize = 1024;
+				ep_desc->bInterval = 0;
+				break;
+			case USB_ENDPOINT_XFER_INT:
+			case USB_ENDPOINT_XFER_ISOC:

Why are you not setting wMaxPacketSize for periodic endpoints? Does it get set later? (I can't tell from this snippet.)

It's not set later. According to the USB30 Spec Table 9-18, the description of wMaxPacketSize for interrupt and iso endpoints:
"..if bMuxBurst field is set to zero then this field can have any value from 0..1024 for isochronous endpoints and 1..1042 for an interrupt endpoint." Since bMuxBurst default is 0 we decided to leave this fields value as it was in the HighSpeed descriptor.

Quoted 65 lines
Quoted 24 lines
drivers/usb/gadget/composite.c +24 -0
+				break;
+			}
+			*tmp = mem;
+			tmp++;
+			mem += (*src)->bLength;
+			/*add ep companion descriptor*/
+			memcpy(mem, &ep_comp_desc, ep_comp_desc.bLength);
+			*tmp = mem;
+			tmp++;
+			mem += ep_comp_desc.bLength;
+			break;
+		default:
+			*tmp = mem;
+			tmp++;
+			mem += (*src)->bLength;
+			break;
+		}
+		src++;
+	}
+	*tmp = NULL; /*The last (struct usb_descriptor_header *) in the
+			descriptors vector is NULL*/
+	f->ss_desc_allocated = true;
+}
+

...

Quoted 38 lines
drivers/usb/gadget/composite.c +18 -0
+/**
+ * bos() - prepares the BOS (Binary Device Object) descriptor
+ * and its device capabilities descriptors. The bos descriptor
+ * should be supported by a Superspeed device.
+ */
+static int bos(struct usb_composite_dev *cdev)
+{
+	struct usb_bos_descriptor	*bos = cdev->req->buf;
+	struct usb_ext_cap_descriptor	*usb_ext = NULL;
+	struct ss_usb_cap_descriptor	*ss_cap = NULL;
+
+	bos->bLength = USB_DT_BOS_SIZE;
+	bos->bDescriptorType = USB_DT_BOS;
+
+	bos->wTotalLength = USB_DT_BOS_SIZE;
+	bos->bNumDeviceCaps = 0;
+
+	/* A SuperSpeed device shall include the USB2.0 extension descriptor

and

drivers/usb/gadget/composite.c +11 -0
+	   shall support LPM when operating in USB2.0 HS mode.*/
+	usb_ext = (struct usb_ext_cap_descriptor *)
+			(cdev->req->buf+bos->wTotalLength);
+	bos->bNumDeviceCaps++;
+	bos->wTotalLength += USB_DT_USB_EXT_CAP_SIZE;
+	usb_ext->bLength = USB_DT_USB_EXT_CAP_SIZE;
+	usb_ext->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
+	usb_ext->bDevCapabilityType = USB_CAP_TYPE_EXT;
+	usb_ext->bmAttributes = USB_LPM_SUPPORT;
+
+	/* The Superspeed USB Capability descriptor shall be implemented by

all

drivers/usb/gadget/composite.c +7 -0
+	   Superspeed devices. */
+	ss_cap = (struct ss_usb_cap_descriptor *)
+		(cdev->req->buf+bos->wTotalLength);
+	bos->bNumDeviceCaps++;
+	bos->wTotalLength += USB_DT_SS_USB_CAP_SIZE;
+	ss_cap->bLength = USB_DT_SS_USB_CAP_SIZE;
+	ss_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
Quoted 8 lines

drivers/usb/gadget/composite.c static int count_configs(struct usb_composite_dev *cdev, unsigned type) · line 603

Quoted 6 lines
drivers/usb/gadget/composite.c +6 -0
+	ss_cap->bDevCapabilityType = SS_USB_CAP_TYPE;
+	ss_cap->bmAttributes = 0; /*LTM is not supported yet*/
+	ss_cap->wSpeedSupported = USB_LOW_SPEED_OPERATION |
+				USB_FULL_SPEED_OPERATION |
+				USB_HIGH_SPEED_OPERATION |
+				USB_5GBPS_OPERATION;

So this gadget will be able to support all speeds?

Yes, that's correct.

Quoted 8 lines

drivers/usb/gadget/composite.c static int count_configs(struct usb_composite_dev *cdev, unsigned type) · line 606

Quoted 4 lines
drivers/usb/gadget/composite.c +3 -0
+	ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
+	ss_cap->bU1devExitLat = 0;
+	ss_cap->bU2DevExitLat = 0;

Are you really sure you want to set the exit latency for low power states to less than 1 microsecond? Without real hardware it would be difficult to test, but this seems overly optimistic.

We will set it to the maximum value according to the USB30 spec:
ss_cap->bU1devExitLat = 0x0A (less then 10 microsec) ss_cap->bU2DevExitLat = 0x07FF (less then 2047 microsec)

Quoted 19 lines
Quoted 6 lines
include/linux/usb/ch9.h +0 -0
index da2ed77..69e528a 100644

...

Quoted 10 lines

+/*Container ID Capability descriptor: Defines the instance unique ID used to

include/linux/usb/ch9.h +8 -0
+  identify the instance across all operating modes*/
+#define	CONTAINER_ID_TYPE	4
+struct ss_usb_container_id_descriptor {
+	__u8  bLength;
+	__u8  bDescriptorType;
+	__u8  bDevCapabilityType;
+	__u8  bReserved;
+	__u8  ContainerID[16]; /*128-bit number*/
Quoted 8 lines

include/linux/usb/ch9.h struct usb_wireless_cap_descriptor { /* Ultra Wide Band */ · line 774

Quoted 3 lines
include/linux/usb/ch9.h +3 -0
+} __attribute__((packed));
+
+#define USB_DT_SS_CONTN_ID_SIZE	20

I don't see generation of a container ID in the code. Are you going to implement it? It's only required for USB 3.0 hubs, and I'm not sure if the gadget framework supports hubs. Nothing else in your code seems to use this definition.

This definition was moved to another patch that includes only USB30 ch9 definitions.

Quoted 2 lines

Sarah

#11 lore raw
Quoted 21 lines · On Tue, Oct 05, 2010 at 04:53:40AM -0700, [email protected] wrote:
Quoted 6 lines

Hi Tatyana,

Comments inline. I'm not familiar with the gadget framework; I'm just curious about some descriptor choices.

On Sun, Oct 03, 2010 at 10:02:15AM +0200, tlinder wrote:

Quoted 14 lines

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 80

Quoted 8 lines
drivers/usb/gadget/composite.c +8 -0
+/** Default endpoint companion descriptor */
+static struct usb_ss_ep_comp_descriptor ep_comp_desc = {
+		.bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
+		.bLength = 0x06,
+		.bMaxBurst = 0, /*the default is we don't support bursting*/
+		.bmAttributes = 0, /*2^0 streams supported*/
+		.wBytesPerInterval = 0,
+};

Can you please set wBytesPerInterval to something sane for periodic endpoints? Perhaps have it set to the maximum packet size times the max burst size times Mult plus one, or less if the device *knows* it's going to send less data. It's used for xHC host controller scheduling, so it's important to get right for maximum bandwidth usage.

Quoted 6 lines

This descriptor holds default values so both bMaxBurst and bmAttributes are set to 0, meaning bursting and streaming are not not supported. So Mult will be set to 0 as well. Mult defined only for iso endpoints and not for interrupt.
Due to the above I propose setting wBytesPerInterval to maxpacketsize for periodic endpoints.

Sounds good.

Quoted 23 lines
Quoted 14 lines
Quoted 14 lines
drivers/usb/gadget/composite.c +14 -0
+	while (*src) {
+		/*Copy the original descriptor*/
+		memcpy(mem, *src, (*src)->bLength);
+		switch ((*src)->bDescriptorType) {
+		case USB_DT_ENDPOINT:
+			/*update ep descriptor*/
+			ep_desc = (struct usb_endpoint_descriptor *)mem;
+			switch (ep_desc->bmAttributes &
+				USB_ENDPOINT_XFERTYPE_MASK) {
+			case USB_ENDPOINT_XFER_CONTROL:
+				ep_desc->wMaxPacketSize = 512;
+				ep_desc->bInterval = 0;
+				break;
+			case USB_ENDPOINT_XFER_BULK:
Quoted 8 lines

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 144

Quoted 5 lines
drivers/usb/gadget/composite.c +5 -0
+				ep_desc->wMaxPacketSize = 1024;
+				ep_desc->bInterval = 0;
+				break;
+			case USB_ENDPOINT_XFER_INT:
+			case USB_ENDPOINT_XFER_ISOC:

Why are you not setting wMaxPacketSize for periodic endpoints? Does it get set later? (I can't tell from this snippet.)

Quoted 6 lines

It's not set later. According to the USB30 Spec Table 9-18, the description of wMaxPacketSize for interrupt and iso endpoints:
"..if bMuxBurst field is set to zero then this field can have any value from 0..1024 for isochronous endpoints and 1..1042 for an interrupt endpoint." Since bMuxBurst default is 0 we decided to leave this fields value as it was in the HighSpeed descriptor.

Ok. I suppose whatever gadget application is being used can reset these values later? So that if you had a gadget webcam, it could set the wMaxPacketSize to the frame size or whatever it needed?

Quoted 11 lines
Quoted 7 lines

drivers/usb/gadget/composite.c static int count_configs(struct usb_composite_dev *cdev, unsigned type) · line 606

Quoted 3 lines
drivers/usb/gadget/composite.c +3 -0
+	ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
+	ss_cap->bU1devExitLat = 0;
+	ss_cap->bU2DevExitLat = 0;

Are you really sure you want to set the exit latency for low power states to less than 1 microsecond? Without real hardware it would be difficult to test, but this seems overly optimistic.

We will set it to the maximum value according to the USB30 spec:
ss_cap->bU1devExitLat = 0x0A (less then 10 microsec) ss_cap->bU2DevExitLat = 0x07FF (less then 2047 microsec)

That will give you *horrible* power management. The whole point of the link power management is to allow the device to go to sleep between packets. Pick some non-zero, lower default.

How are you going to implement link power management on the gadget side, btw? I know that the Linux USB host side doesn't support link PM yet, but if it did, how would the gadget power down pieces of itself when it receives a link PM request? Do you need some hooks that specific hardware implementations can register with the gadget interface?

Sarah Sharp

#12 lore raw
Quoted 66 lines · On Tue, Oct 05, 2010 at 04:53:40AM -0700, [email protected] wrote:
Quoted 23 lines
Quoted 6 lines

Hi Tatyana,

Comments inline. I'm not familiar with the gadget framework; I'm just curious about some descriptor choices.

On Sun, Oct 03, 2010 at 10:02:15AM +0200, tlinder wrote:

Quoted 11 lines

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 80

Quoted 8 lines
drivers/usb/gadget/composite.c +8 -0
+/** Default endpoint companion descriptor */
+static struct usb_ss_ep_comp_descriptor ep_comp_desc = {
+		.bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
+		.bLength = 0x06,
+		.bMaxBurst = 0, /*the default is we don't support bursting*/
+		.bmAttributes = 0, /*2^0 streams supported*/
+		.wBytesPerInterval = 0,
+};

Can you please set wBytesPerInterval to something sane for periodic endpoints? Perhaps have it set to the maximum packet size times the

max

Quoted 1 line

burst size times Mult plus one, or less if the device *knows* it's

going

Quoted 2 lines

to send less data. It's used for xHC host controller scheduling, so it's important to get right for maximum bandwidth usage.

Quoted 8 lines

This descriptor holds default values so both bMaxBurst and bmAttributes are set to 0, meaning bursting and streaming are not not supported. So Mult will be set to 0 as well. Mult defined only for iso endpoints and not
for interrupt.
Due to the above I propose setting wBytesPerInterval to maxpacketsize for
periodic endpoints.

Sounds good.

Quoted 22 lines
Quoted 13 lines
Quoted 13 lines
drivers/usb/gadget/composite.c +13 -0
+	while (*src) {
+		/*Copy the original descriptor*/
+		memcpy(mem, *src, (*src)->bLength);
+		switch ((*src)->bDescriptorType) {
+		case USB_DT_ENDPOINT:
+			/*update ep descriptor*/
+			ep_desc = (struct usb_endpoint_descriptor *)mem;
+			switch (ep_desc->bmAttributes &
+				USB_ENDPOINT_XFERTYPE_MASK) {
+			case USB_ENDPOINT_XFER_CONTROL:
+				ep_desc->wMaxPacketSize = 512;
+				ep_desc->bInterval = 0;
+				break;
Quoted 8 lines

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 144

Quoted 6 lines
drivers/usb/gadget/composite.c +6 -0
+			case USB_ENDPOINT_XFER_BULK:
+				ep_desc->wMaxPacketSize = 1024;
+				ep_desc->bInterval = 0;
+				break;
+			case USB_ENDPOINT_XFER_INT:
+			case USB_ENDPOINT_XFER_ISOC:

Why are you not setting wMaxPacketSize for periodic endpoints? Does

it

Quoted 8 lines
Quoted 1 line

get set later? (I can't tell from this snippet.)

It's not set later. According to the USB30 Spec Table 9-18, the description of wMaxPacketSize for interrupt and iso endpoints:
"..if bMuxBurst field is set to zero then this field can have any value from 0..1024 for isochronous endpoints and 1..1042 for an interrupt endpoint." Since bMuxBurst default is 0 we decided to leave this fields value as it was in the HighSpeed descriptor.

Quoted 3 lines

Ok. I suppose whatever gadget application is being used can reset these values later? So that if you had a gadget webcam, it could set the wMaxPacketSize to the frame size or whatever it needed?

Yes but resetting it later in the SuperSpeed descriptor will be a bit complicated. A better approach will be setting the desired values in the HighSpeed descriptors. This way they will be copied to the SuperSpeed descriptors automatically.

Quoted 9 lines
Quoted 9 lines
Quoted 8 lines

drivers/usb/gadget/composite.c static int count_configs(struct usb_composite_dev *cdev, unsigned type) · line 606

Quoted 4 lines
drivers/usb/gadget/composite.c +3 -0
+	ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
+	ss_cap->bU1devExitLat = 0;
+	ss_cap->bU2DevExitLat = 0;

Are you really sure you want to set the exit latency for low power states to less than 1 microsecond? Without real hardware it would be difficult to test, but this seems overly optimistic.

Quoted 7 lines
Quoted 3 lines

We will set it to the maximum value according to the USB30 spec:
ss_cap->bU1devExitLat = 0x0A (less then 10 microsec) ss_cap->bU2DevExitLat = 0x07FF (less then 2047 microsec)

That will give you *horrible* power management. The whole point of the link power management is to allow the device to go to sleep between packets. Pick some non-zero, lower default.

I've consulted out HW team and we came up with the flowing solution:
These values are determined by the controller and the PHY. The gadget SW has no impact on them what so ever. Therefore, we will add another callback to gadget_ops that will retrieve these values from the DCD. If this callback is not supplied we will report the flowing default values:
ss_cap->bU1devExitLat = 0x01 (less then 1 microsec) ss_cap->bU2DevExitLat = 0x1F4 (less then 500 microsec)

Quoted 6 lines

How are you going to implement link power management on the gadget side, btw? I know that the Linux USB host side doesn't support link PM yet, but if it did, how would the gadget power down pieces of itself when it receives a link PM request? Do you need some hooks that specific hardware implementations can register with the gadget interface?

Link power management is mostly implemented by the DCD and not the gadget. Once it will be implemented necessary changes will be applied to the gadget framework as well.

Quoted 2 lines

Sarah Sharp

#13 lore raw
Quoted 4 lines
Quoted 4 lines

Ok. I suppose whatever gadget application is being used can reset these values later? So that if you had a gadget webcam, it could set the wMaxPacketSize to the frame size or whatever it needed?

Yes ... in fact, every altsetting or configuration may need to set up each endpoint differently ... that's why ep_enable() passes full endpoint configs (as descriptors), so they can more easily be changed.

If the notion is that there are values that may need to get passed from silicon to driver, I'd like to see that done explicitly, with drivers updating descriptors, instead of doing anything by back-door routes that make UDC drivers making hidden updates.

- Dave

#14 lore raw
Quoted 11 lines
Quoted 6 lines
Quoted 3 lines

Ok. I suppose whatever gadget application is being used can reset

these

Quoted 2 lines

values later? So that if you had a gadget webcam, it could set the wMaxPacketSize to the frame size or whatever it needed?

Yes ... in fact, every altsetting or configuration may need to set up each endpoint differently ... that's why ep_enable() passes full endpoint configs (as descriptors), so they can more easily be changed.

Quoted 6 lines

If the notion is that there are values that may need to get passed from silicon to driver, I'd like to see that done explicitly, with drivers updating descriptors, instead of doing anything by back-door routes that make UDC drivers making hidden updates.

- Dave

This implementation creates default SuperSpeed descriptors with default values. It is used to spare drivers that don't want to fully exploit SuperSpeed functionality from handling SupperSpeed descriptors and still be able to operate in a SupperSpeed mode.
Please note that the gadget driver can still provide SuperSpeed descriptors with correct (and not default values) if it wishes to. I hope I understood your comment correctly. Please let me know if this is not the case.

Quoted 6 lines

--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

Signature · 2 lines
Sent by an consultant of the Qualcomm Innovation Center, Inc.
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum.
#15 lore raw

Resending since not everyone received my reply

-----Original Message-----
From: Brokhman Tatyana [mailto:[email protected]]
Sent: Tuesday, October 12, 2010 11:18 AM
To: David Brownell
Cc: [email protected]; Sarah Sharp; [email protected]; Greg Kroah-Hartman; Michal Nazarewicz; Randy Dunlap; Laurent Pinchart; Kyungmin Park; Robert Lukassen; Matthew Wilcox; Fabien Chouteau; Tejun Heo; [email protected]
Subject: Re: [RFC/PATCH 2/2] usb:gadget: Add SuperSpeed support to the Gadget Framework

Quoted 10 lines
Quoted 5 lines
Quoted 2 lines

Ok. I suppose whatever gadget application is being used can reset

these

Quoted 2 lines

values later? So that if you had a gadget webcam, it could set the wMaxPacketSize to the frame size or whatever it needed?

Yes ... in fact, every altsetting or configuration may need to set up each endpoint differently ... that's why ep_enable() passes full endpoint configs (as descriptors), so they can more easily be changed.

Quoted 6 lines

If the notion is that there are values that may need to get passed from silicon to driver, I'd like to see that done explicitly, with drivers updating descriptors, instead of doing anything by back-door routes that make UDC drivers making hidden updates.

- Dave

This implementation creates default SuperSpeed descriptors with default values. It is used to spare drivers that don't want to fully exploit SuperSpeed functionality from handling SupperSpeed descriptors and still be able to operate in a SupperSpeed mode.
Please note that the gadget driver can still provide SuperSpeed descriptors with correct (and not default values) if it wishes to. I hope I understood your comment correctly. Please let me know if this is not the case.

Quoted 6 lines

--
To unsubscribe from this list: send the line "unsubscribe linux-usb" in the body of a message to [email protected]
More majordomo info at http://vger.kernel.org/majordomo-info.html

Signature · 2 lines
Sent by an consultant of the Qualcomm Innovation Center, Inc.
The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum.
#16 lore raw
In reply to tlinder

Hi,

Quoted 13 lines · tlinder

From: Tatyana Linder <[email protected]>

This patch adds the SuperSpeed functionality to the gadget framework. In order not to force all the FDs to supply SuperSpeed descriptors when operating in SuperSpeed mode the following approach was taken:
If we're operating in SuperSpeed mode and the FD didn't supply SuperSpeed descriptors, the composite layer will automatically create SuperSpeed descriptors with default values.
Support for new SuperSpeed BOS descriptor was added.
Support for SET_FEATURE and GET_STATUS requests in SuperSpeed mode was added.

Quoted 1 line

Some comments on coding guidelines below.

Quoted 32 lines

---
This patch was verified by USBCV 3.0 and 2.0.

 drivers/usb/gadget/Kconfig     |   20 ++- drivers/usb/gadget/composite.c |  319 +++++++++++++++++++++++++++++++++++++--- include/linux/usb/ch9.h        |   54 +++++++- include/linux/usb/composite.h  |   24 +++ include/linux/usb/gadget.h     |   19 +++

 5 files changed, 407 insertions(+), 29 deletions(-)
drivers/usb/gadget/Kconfig +0 -0
index cd27f9b..9afdd08 100644
@@ -520,11 +520,11 @@ config USB_GADGET_DUMMY_HCD

         side is the master; the gadget side is the slave.  Gadget drivers can be high, full, or low speed; and they have access to endpoints like those from NET2280, PXA2xx, or SA1100 hardware.

drivers/usb/gadget/Kconfig +1 -1
-
+

         This may help in some stages of creating a driver to embed in a Linux device, since it lets you debug several parts of the gadget driver without its hardware or drivers being involved.

drivers/usb/gadget/Kconfig +1 -1
-
+

         Since such a gadget side driver needs to interoperate with a host side Linux-USB device driver, this may help to debug both sides of a USB protocol stack.

drivers/usb/gadget/Kconfig +0 -0
@@ -552,6 +552,18 @@ config USB_GADGET_DUALSPEED

         Means that gadget drivers should include extra descriptors and code to handle dual-speed controllers.

Quoted 2 lines

+config USB_GADGET_SUPERSPEED
+       boolean "Gadget opperating in Super Speed"

spelling "operating"

Quoted 8 lines

+       depends on USB_GADGET
+       depends on USB_GADGET_DUALSPEED
+       default n
+       help
+         Enabling this feature enables Super Speed support in the Gadget
+         driver. It means that gadget drivers should include extra (SuperSpeed)
+         descriptors.
+         For composite devices: if SupeSpeed descriptors weren't supplied by

spelling "Superspeed"

Quoted 28 lines

+         the FD, they will be automatically generated with default values. +
 #
 # USB Gadget Drivers
 #

drivers/usb/gadget/Kconfig +0 -0
@@ -633,7 +645,7 @@ config USB_ETH

       help
         This driver implements Ethernet style communication, in one of several ways:

drivers/usb/gadget/Kconfig +1 -1
-
+

          - The "Communication Device Class" (CDC) Ethernet Control Model. That protocol is often avoided with pure Ethernet adapters, in favor of simpler vendor-specific hardware, but is widely

drivers/usb/gadget/Kconfig +0 -0
@@ -673,7 +685,7 @@ config USB_ETH_RNDIS

          If you say "y" here, the Ethernet gadget driver will try to provide a second device configuration, supporting RNDIS to talk to such Microsoft USB hosts.

drivers/usb/gadget/Kconfig +1 -1
-
+

          To make MS-Windows work with this, use Documentation/usb/linux.inf as the "driver info file".  For versions of MS-Windows older than XP, you'll need to download drivers from Microsoft's website; a URL

drivers/usb/gadget/composite.c +0 -0
index c619c80..a5dcfe1 100644

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 77

Quoted 8 lines
drivers/usb/gadget/composite.c +5 -0
@@ -70,6 +70,102 @@ static char *iSerialNumber;
  module_param(iSerialNumber, charp, 0);
  MODULE_PARM_DESC(iSerialNumber, "SerialNumber string");
 
+/** Default endpoint companion descriptor */
+static struct usb_ss_ep_comp_descriptor ep_comp_desc = {
+               .bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
+               .bLength = 0x06,
+               .bMaxBurst = 0, /*the default is we don't support bursting*/

Commenting style not proper. It should be like "/* Leave a space as shown */"

Quoted 18 lines
drivers/usb/gadget/composite.c +18 -0
+               .bmAttributes = 0, /*2^0 streams supported*/
+               .wBytesPerInterval = 0,
+};
+
+/**This function receives a pointer to usb_function and adds
+ * missing super speed descriptors in the ss_descriptor field
+ * according to its hs_descriptors field.
+ *
+ * In more details: this function copies f->hs_descriptors while
+ * updating the endpoint descriptor and adding endpoint
+ * companion descriptor
+ */
+static void create_ss_descriptors(struct usb_function *f)
+{
+       unsigned bytes; /*number of bytes to allocate*/
+       unsigned n_desc;    /* number of descriptors*/
+       void *mem; /*allocated memory to copy to*/
+       struct usb_descriptor_header **tmp;

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 105

Quoted 10 lines
drivers/usb/gadget/composite.c +10 -0
+       struct usb_endpoint_descriptor  *ep_desc ;
+       struct usb_descriptor_header **src = f->hs_descriptors;
+
+       if (!f->hs_descriptors)
+               return;
+
+       /* Count number of EPs (in order to know how many SS_EP_COMPANION
+          descriptors to add), the total number of descriptors and the sum of
+          each descriptor bLength field in order to know how much memory to
+          allocate*/

Multi line comment style as per coding guidelines is as below.

/*
* First line
* Second line
* Third line
*/

Quoted 7 lines
drivers/usb/gadget/composite.c +7 -0
+       for (bytes = 0, n_desc = 0, tmp = src; *tmp; tmp++, n_desc++) {
+               if ((*tmp)->bDescriptorType == USB_DT_ENDPOINT) {
+                       bytes += ep_comp_desc.bLength;
+                       n_desc++;
+               }
+               bytes += (*tmp)->bLength;
+       }

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 122

Quoted 10 lines
drivers/usb/gadget/composite.c +10 -0
+
+       bytes += (n_desc + 1) * sizeof(*tmp);
+       mem = kmalloc(bytes, GFP_KERNEL);
+       if (!mem)
+               return;
+
+       /* fill in pointers starting at "tmp",
+        * to descriptors copied starting at "mem";
+        * and return "ret"
+        */

Same here.

Quoted 33 lines
drivers/usb/gadget/composite.c +33 -0
+       tmp = mem;
+       f->ss_descriptors  = mem;
+       mem += (n_desc + 1) * sizeof(*tmp);
+       while (*src) {
+               /*Copy the original descriptor*/
+               memcpy(mem, *src, (*src)->bLength);
+               switch ((*src)->bDescriptorType) {
+               case USB_DT_ENDPOINT:
+                       /*update ep descriptor*/
+                       ep_desc = (struct usb_endpoint_descriptor *)mem;
+                       switch (ep_desc->bmAttributes &
+                               USB_ENDPOINT_XFERTYPE_MASK) {
+                       case USB_ENDPOINT_XFER_CONTROL:
+                               ep_desc->wMaxPacketSize = 512;
+                               ep_desc->bInterval = 0;
+                               break;
+                       case USB_ENDPOINT_XFER_BULK:
+                               ep_desc->wMaxPacketSize = 1024;
+                               ep_desc->bInterval = 0;
+                               break;
+                       case USB_ENDPOINT_XFER_INT:
+                       case USB_ENDPOINT_XFER_ISOC:
+                               break;
+                       }
+                       *tmp = mem;
+                       tmp++;
+                       mem += (*src)->bLength;
+                       /*add ep companion descriptor*/
+                       memcpy(mem, &ep_comp_desc, ep_comp_desc.bLength);
+                       *tmp = mem;
+                       tmp++;
+                       mem += ep_comp_desc.bLength;
+                       break;

drivers/usb/gadget/composite.c static char *iSerialNumber; · line 165

Quoted 10 lines
drivers/usb/gadget/composite.c +10 -0
+               default:
+                       *tmp = mem;
+                       tmp++;
+                       mem += (*src)->bLength;
+                       break;
+               }
+               src++;
+       }
+       *tmp = NULL; /*The last (struct usb_descriptor_header *) in the
+                       descriptors vector is NULL*/

Fix commenting style.

Quoted 31 lines
drivers/usb/gadget/composite.c +6 -0
+       f->ss_desc_allocated = true;
+}
+
  /*-------------------------------------------------------------------------*/
  /**
  * next_ep_desc - advance to the next EP descriptor
@@ -110,6 +206,9 @@ int ep_choose(struct usb_gadget *g, struct usb_function *f, struct usb_ep *_ep)
        struct usb_endpoint_descriptor *chosen_desc = NULL;
        struct usb_descriptor_header **speed_desc = NULL;
 
+       struct usb_ss_ep_comp_descriptor *comp_desc = NULL;
+       int want_comp_desc = 0;
+

       struct usb_descriptor_header **d_spd; /* cursor for speed desc */

       if (!g || !f || !_ep)

drivers/usb/gadget/composite.c +7 -0
@@ -117,6 +216,13 @@ int ep_choose(struct usb_gadget *g, struct usb_function *f, struct usb_ep *_ep)
 
        /* select desired speed */
        switch (g->speed) {
+       case USB_SPEED_SUPER:
+               if (gadget_is_superspeed(g)) {
+                       speed_desc = f->ss_descriptors;
+                       want_comp_desc = 1;
+                       break;
+               }
+               /*else: Fall trough*/

       case USB_SPEED_HIGH:
               if (gadget_is_dualspeed(g)) { speed_desc = f->hs_descriptors;

drivers/usb/gadget/composite.c ep_found: · line 257

Quoted 10 lines
drivers/usb/gadget/composite.c +6 -1
@@ -143,7 +249,18 @@ ep_found:
        /* commit results */
        _ep->maxpacket = chosen_desc->wMaxPacketSize;
        _ep->desc = chosen_desc;
-
+       _ep->comp_desc = NULL;
+       if (want_comp_desc) {
+               /**
+                * Companion descriptor should follow EP descriptor
+                * USB 3.0 spec, #9.6.7
+                */

Same here. No two **.

Quoted 10 lines
drivers/usb/gadget/composite.c +6 -0
+               comp_desc = (struct usb_ss_ep_comp_descriptor *)*(++d_spd);
+               if (!comp_desc ||
+                   (comp_desc->bDescriptorType != USB_DT_SS_ENDPOINT_COMP))
+                       return -EIO;
+               _ep->comp_desc = comp_desc;
+       }
        return 0;
  }
 

drivers/usb/gadget/composite.c int usb_add_function(struct usb_configuration *config, · line 307

Quoted 6 lines
drivers/usb/gadget/composite.c +3 -0
@@ -185,6 +302,12 @@ int usb_add_function(struct usb_configuration *config,
                        list_del(&function->list);
                        function->config = NULL;
                }
+               /*Add SS descriptors if there are any. This has to be done
+                 after the bind since we need the hs_descriptors to be set in
+                 usb_function and some of the FDs does it in the bind. */

And here.

Please run scripts/checkpatch.pl to fix up the coding style issues at several places in this patch.

Regards,
Maulik

#17 lore raw
In reply to tlinder

Adding David Vrabel to review from a WUSB point of view.

Quoted 817 lines

From: Tatyana Linder <[email protected]>

This patch adds the SuperSpeed functionality to the gadget framework. In order not to force all the FDs to supply SuperSpeed descriptors when operating in SuperSpeed mode the following approach was taken:
If we're operating in SuperSpeed mode and the FD didn't supply SuperSpeed descriptors, the composite layer will automatically create SuperSpeed descriptors with default values.
Support for new SuperSpeed BOS descriptor was added.
Support for SET_FEATURE and GET_STATUS requests in SuperSpeed mode was added.

---
This patch was verified by USBCV 3.0 and 2.0.

 drivers/usb/gadget/Kconfig     |   20 ++-
 drivers/usb/gadget/composite.c |  319
+++++++++++++++++++++++++++++++++++++---
 include/linux/usb/ch9.h        |   54 +++++++-
 include/linux/usb/composite.h  |   24 +++
 include/linux/usb/gadget.h     |   19 +++
 5 files changed, 407 insertions(+), 29 deletions(-)
drivers/usb/gadget/Kconfig +16 -4
index cd27f9b..9afdd08 100644
@@ -520,11 +520,11 @@ config USB_GADGET_DUMMY_HCD
 	  side is the master; the gadget side is the slave.  Gadget drivers
 	  can be high, full, or low speed; and they have access to endpoints
 	  like those from NET2280, PXA2xx, or SA1100 hardware.
-
+
 	  This may help in some stages of creating a driver to embed in a
 	  Linux device, since it lets you debug several parts of the gadget
 	  driver without its hardware or drivers being involved.
-
+
 	  Since such a gadget side driver needs to interoperate with a host
 	  side Linux-USB device driver, this may help to debug both sides
 	  of a USB protocol stack.
@@ -552,6 +552,18 @@ config USB_GADGET_DUALSPEED
 	  Means that gadget drivers should include extra descriptors
 	  and code to handle dual-speed controllers.
 
+config USB_GADGET_SUPERSPEED
+	boolean "Gadget opperating in Super Speed"
+	depends on USB_GADGET
+	depends on USB_GADGET_DUALSPEED
+	default n
+	help
+	  Enabling this feature enables Super Speed support in the Gadget
+	  driver. It means that gadget drivers should include extra (SuperSpeed)
+	  descriptors.
+	  For composite devices: if SupeSpeed descriptors weren't supplied by
+	  the FD, they will be automatically generated with default values.
+
 #
 # USB Gadget Drivers
 #
@@ -633,7 +645,7 @@ config USB_ETH
 	help
 	  This driver implements Ethernet style communication, in one of
 	  several ways:
-
+
 	   - The "Communication Device Class" (CDC) Ethernet Control Model.
 	     That protocol is often avoided with pure Ethernet adapters, in
 	     favor of simpler vendor-specific hardware, but is widely
@@ -673,7 +685,7 @@ config USB_ETH_RNDIS
 	   If you say "y" here, the Ethernet gadget driver will try to provide
 	   a second device configuration, supporting RNDIS to talk to such
 	   Microsoft USB hosts.
-
+
 	   To make MS-Windows work with this, use Documentation/usb/linux.inf
 	   as the "driver info file".  For versions of MS-Windows older than
 	   XP, you'll need to download drivers from Microsoft's website; a URL
drivers/usb/gadget/composite.c +99 -0
index c619c80..a5dcfe1 100644
@@ -70,6 +70,102 @@ static char *iSerialNumber;
 module_param(iSerialNumber, charp, 0);
 MODULE_PARM_DESC(iSerialNumber, "SerialNumber string");
 
+/** Default endpoint companion descriptor */
+static struct usb_ss_ep_comp_descriptor ep_comp_desc = {
+		.bDescriptorType = USB_DT_SS_ENDPOINT_COMP,
+		.bLength = 0x06,
+		.bMaxBurst = 0, /*the default is we don't support bursting*/
+		.bmAttributes = 0, /*2^0 streams supported*/
+		.wBytesPerInterval = 0,
+};
+
+/**This function receives a pointer to usb_function and adds
+ * missing super speed descriptors in the ss_descriptor field
+ * according to its hs_descriptors field.
+ *
+ * In more details: this function copies f->hs_descriptors while
+ * updating the endpoint descriptor and adding endpoint
+ * companion descriptor
+ */
+static void create_ss_descriptors(struct usb_function *f)
+{
+	unsigned bytes; /*number of bytes to allocate*/
+	unsigned n_desc;    /* number of descriptors*/
+	void *mem; /*allocated memory to copy to*/
+	struct usb_descriptor_header **tmp;
+	struct usb_endpoint_descriptor	*ep_desc ;
+	struct usb_descriptor_header **src = f->hs_descriptors;
+
+	if (!f->hs_descriptors)
+		return;
+
+	/* Count number of EPs (in order to know how many SS_EP_COMPANION
+	   descriptors to add), the total number of descriptors and the sum of
+	   each descriptor bLength field in order to know how much memory to
+	   allocate*/
+	for (bytes = 0, n_desc = 0, tmp = src; *tmp; tmp++, n_desc++) {
+		if ((*tmp)->bDescriptorType == USB_DT_ENDPOINT) {
+			bytes += ep_comp_desc.bLength;
+			n_desc++;
+		}
+		bytes += (*tmp)->bLength;
+	}
+
+	bytes += (n_desc + 1) * sizeof(*tmp);
+	mem = kmalloc(bytes, GFP_KERNEL);
+	if (!mem)
+		return;
+
+	/* fill in pointers starting at "tmp",
+	 * to descriptors copied starting at "mem";
+	 * and return "ret"
+	 */
+	tmp = mem;
+	f->ss_descriptors  = mem;
+	mem += (n_desc + 1) * sizeof(*tmp);
+	while (*src) {
+		/*Copy the original descriptor*/
+		memcpy(mem, *src, (*src)->bLength);
+		switch ((*src)->bDescriptorType) {
+		case USB_DT_ENDPOINT:
+			/*update ep descriptor*/
+			ep_desc = (struct usb_endpoint_descriptor *)mem;
+			switch (ep_desc->bmAttributes &
+				USB_ENDPOINT_XFERTYPE_MASK) {
+			case USB_ENDPOINT_XFER_CONTROL:
+				ep_desc->wMaxPacketSize = 512;
+				ep_desc->bInterval = 0;
+				break;
+			case USB_ENDPOINT_XFER_BULK:
+				ep_desc->wMaxPacketSize = 1024;
+				ep_desc->bInterval = 0;
+				break;
+			case USB_ENDPOINT_XFER_INT:
+			case USB_ENDPOINT_XFER_ISOC:
+				break;
+			}
+			*tmp = mem;
+			tmp++;
+			mem += (*src)->bLength;
+			/*add ep companion descriptor*/
+			memcpy(mem, &ep_comp_desc, ep_comp_desc.bLength);
+			*tmp = mem;
+			tmp++;
+			mem += ep_comp_desc.bLength;
+			break;
+		default:
+			*tmp = mem;
+			tmp++;
+			mem += (*src)->bLength;
+			break;
+		}
+		src++;
+	}
+	*tmp = NULL; /*The last (struct usb_descriptor_header *) in the
+			descriptors vector is NULL*/
+	f->ss_desc_allocated = true;
+}
+
 /*-------------------------------------------------------------------------*/
 /**
  * next_ep_desc - advance to the next EP descriptor
@@ -110,6 +206,9 @@ int ep_choose(struct usb_gadget *g, struct
 usb_function *f, struct usb_ep *_ep)
 	struct usb_endpoint_descriptor *chosen_desc = NULL;
 	struct usb_descriptor_header **speed_desc = NULL;
 
+	struct usb_ss_ep_comp_descriptor *comp_desc = NULL;
+	int want_comp_desc = 0;
+
 	struct usb_descriptor_header **d_spd; /* cursor for speed desc */
 
drivers/usb/gadget/composite.c +7 -0
 	if (!g || !f || !_ep)
@@ -117,6 +216,13 @@ int ep_choose(struct usb_gadget *g, struct
 usb_function *f, struct usb_ep *_ep)
 
 	/* select desired speed */
 	switch (g->speed) {
+	case USB_SPEED_SUPER:
+		if (gadget_is_superspeed(g)) {
+			speed_desc = f->ss_descriptors;
+			want_comp_desc = 1;
+			break;
+		}
+		/*else: Fall trough*/
 	case USB_SPEED_HIGH:
 		if (gadget_is_dualspeed(g)) {
drivers/usb/gadget/composite.c +23 -2
 			speed_desc = f->hs_descriptors;
@@ -143,7 +249,18 @@ ep_found:
 	/* commit results */
 	_ep->maxpacket = chosen_desc->wMaxPacketSize;
 	_ep->desc = chosen_desc;
-
+	_ep->comp_desc = NULL;
+	if (want_comp_desc) {
+		/**
+		 * Companion descriptor should follow EP descriptor
+		 * USB 3.0 spec, #9.6.7
+		 */
+		comp_desc = (struct usb_ss_ep_comp_descriptor *)*(++d_spd);
+		if (!comp_desc ||
+		    (comp_desc->bDescriptorType != USB_DT_SS_ENDPOINT_COMP))
+			return -EIO;
+		_ep->comp_desc = comp_desc;
+	}
 	return 0;
 }
 
@@ -185,6 +302,12 @@ int usb_add_function(struct usb_configuration
 *config,
 			list_del(&function->list);
 			function->config = NULL;
 		}
+		/*Add SS descriptors if there are any. This has to be done
+		  after the bind since we need the hs_descriptors to be set in
+		  usb_function and some of the FDs does it in the bind. */
+		if ((gadget_is_superspeed(config->cdev->gadget)) &&
+		    (!function->ss_not_capable) && (!function->ss_descriptors))
+			create_ss_descriptors(function);
 	} else
 		value = 0;
@@ -197,6 +320,8 @@ int usb_add_function(struct usb_configuration *config,
 		config->fullspeed = true;
 	if (!config->highspeed && function->hs_descriptors)
 		config->highspeed = true;
+	if (!config->superspeed && function->ss_descriptors)
+		config->superspeed = true;
 
 done:
 	if (value)
@@ -340,7 +465,9 @@ static int config_buf(struct usb_configuration
 *config,
 	list_for_each_entry(f, &config->functions, list) {
 		struct usb_descriptor_header **descriptors;
 
-		if (speed == USB_SPEED_HIGH)
+		if (speed == USB_SPEED_SUPER)
+			descriptors = f->ss_descriptors;
+		else if (speed == USB_SPEED_HIGH)
 			descriptors = f->hs_descriptors;
 		else
drivers/usb/gadget/composite.c +8 -5
 			descriptors = f->descriptors;
@@ -366,23 +493,26 @@ static int config_desc(struct usb_composite_dev
 *cdev, unsigned w_value)
 	u8				type = w_value >> 8;
 	enum usb_device_speed		speed = USB_SPEED_UNKNOWN;
 
-	if (gadget_is_dualspeed(gadget)) {
-		int			hs = 0;
-
+	if (gadget->speed == USB_SPEED_SUPER)
+		speed = gadget->speed;
+	else if (gadget_is_dualspeed(gadget)) {
+		int	hs = 0;
 		if (gadget->speed == USB_SPEED_HIGH)
 			hs = 1;
 		if (type == USB_DT_OTHER_SPEED_CONFIG)
 			hs = !hs;
 		if (hs)
 			speed = USB_SPEED_HIGH;
-
 	}
 
 	/* This is a lookup by config *INDEX* */
 	w_value &= 0xff;
 	list_for_each_entry(c, &cdev->configs, list) {
 		/* ignore configs that won't work at this speed */
-		if (speed == USB_SPEED_HIGH) {
+		if (speed == USB_SPEED_SUPER) {
+			if (!c->superspeed)
+				continue;
+		} else if (speed == USB_SPEED_HIGH) {
 			if (!c->highspeed)
 				continue;
drivers/usb/gadget/composite.c +7 -1
 		} else {
@@ -402,16 +532,22 @@ static int count_configs(struct usb_composite_dev
 *cdev, unsigned type)
 	struct usb_configuration	*c;
 	unsigned			count = 0;
 	int				hs = 0;
+	int				ss = 0;
 
 	if (gadget_is_dualspeed(gadget)) {
 		if (gadget->speed == USB_SPEED_HIGH)
 			hs = 1;
+		if (gadget->speed == USB_SPEED_SUPER)
+			ss = 1;
 		if (type == USB_DT_DEVICE_QUALIFIER)
 			hs = !hs;
 	}
 	list_for_each_entry(c, &cdev->configs, list) {
 		/* ignore configs that won't work at this speed */
-		if (hs) {
+		if (ss) {
+			if (!c->superspeed)
+				continue;
+		} else if (hs) {
 			if (!c->highspeed)
 				continue;
drivers/usb/gadget/composite.c +49 -0
 		} else {
@@ -423,6 +559,55 @@ static int count_configs(struct usb_composite_dev
 *cdev, unsigned type)
 	return count;
 }
 
+/**
+ * bos() - prepares the BOS (Binary Device Object) descriptor
+ * and its device capabilities descriptors. The bos descriptor
+ * should be supported by a Superspeed device.
+ */
+static int bos(struct usb_composite_dev *cdev)
+{
+	struct usb_bos_descriptor	*bos = cdev->req->buf;
+	struct usb_ext_cap_descriptor	*usb_ext = NULL;
+	struct ss_usb_cap_descriptor	*ss_cap = NULL;
+
+	bos->bLength = USB_DT_BOS_SIZE;
+	bos->bDescriptorType = USB_DT_BOS;
+
+	bos->wTotalLength = USB_DT_BOS_SIZE;
+	bos->bNumDeviceCaps = 0;
+
+	/* A SuperSpeed device shall include the USB2.0 extension descriptor and
+	   shall support LPM when operating in USB2.0 HS mode.*/
+	usb_ext = (struct usb_ext_cap_descriptor *)
+			(cdev->req->buf+bos->wTotalLength);
+	bos->bNumDeviceCaps++;
+	bos->wTotalLength += USB_DT_USB_EXT_CAP_SIZE;
+	usb_ext->bLength = USB_DT_USB_EXT_CAP_SIZE;
+	usb_ext->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
+	usb_ext->bDevCapabilityType = USB_CAP_TYPE_EXT;
+	usb_ext->bmAttributes = USB_LPM_SUPPORT;
+
+	/* The Superspeed USB Capability descriptor shall be implemented by all
+	   Superspeed devices. */
+	ss_cap = (struct ss_usb_cap_descriptor *)
+		(cdev->req->buf+bos->wTotalLength);
+	bos->bNumDeviceCaps++;
+	bos->wTotalLength += USB_DT_SS_USB_CAP_SIZE;
+	ss_cap->bLength = USB_DT_SS_USB_CAP_SIZE;
+	ss_cap->bDescriptorType = USB_DT_DEVICE_CAPABILITY;
+	ss_cap->bDevCapabilityType = SS_USB_CAP_TYPE;
+	ss_cap->bmAttributes = 0; /*LTM is not supported yet*/
+	ss_cap->wSpeedSupported = USB_LOW_SPEED_OPERATION |
+				USB_FULL_SPEED_OPERATION |
+				USB_HIGH_SPEED_OPERATION |
+				USB_5GBPS_OPERATION;
+	ss_cap->bFunctionalitySupport = USB_LOW_SPEED_OPERATION;
+	ss_cap->bU1devExitLat = 0;
+	ss_cap->bU2DevExitLat = 0;
+
+	return bos->wTotalLength;
+}
+
 static void device_qual(struct usb_composite_dev *cdev)
 {
drivers/usb/gadget/composite.c +27 -11
 	struct usb_qualifier_descriptor	*qual = cdev->req->buf;
@@ -466,27 +651,40 @@ static int set_config(struct usb_composite_dev
 *cdev,
 	unsigned		power = gadget_is_otg(gadget) ? 8 : 100;
 	int			tmp;
 
-	if (cdev->config)
-		reset_config(cdev);
-
 	if (number) {
 		list_for_each_entry(c, &cdev->configs, list) {
 			if (c->bConfigurationValue == number) {
+				/* Need to disable the FDs of the previous
+				   configuration */
+				if (cdev->config)
+					reset_config(cdev);
 				result = 0;
 				break;
 			}
 		}
 		if (result < 0)
 			goto done;
-	} else
+	} else { /* Zero configuration value - need to reset the config */
+		if (cdev->config)
+			reset_config(cdev);
 		result = 0;
+	}
 
 	INFO(cdev, "%s speed config #%d: %s\n",
 		({ char *speed;
 		switch (gadget->speed) {
-		case USB_SPEED_LOW:	speed = "low"; break;
-		case USB_SPEED_FULL:	speed = "full"; break;
-		case USB_SPEED_HIGH:	speed = "high"; break;
+		case USB_SPEED_LOW:
+			speed = "low";
+			break;
+		case USB_SPEED_FULL:
+			speed = "full";
+			break;
+		case USB_SPEED_HIGH:
+			speed = "high";
+			break;
+		case USB_SPEED_SUPER:
+			speed = "super";
+			break;
 		default:		speed = "?"; break;
 		} ; speed; }), number, c ? c->label : "unconfigured");
@@ -509,7 +707,9 @@ static int set_config(struct usb_composite_dev *cdev,
 		 * function's setup callback instead of the current
 		 * configuration's setup callback.
 		 */
-		if (gadget->speed == USB_SPEED_HIGH)
+		if (gadget->speed == USB_SPEED_SUPER)
+			descriptors = f->ss_descriptors;
+		else if (gadget->speed == USB_SPEED_HIGH)
 			descriptors = f->hs_descriptors;
 		else
 			descriptors = f->descriptors;
@@ -592,14 +792,14 @@ int usb_add_config(struct usb_composite_dev *cdev,
 	} else {
 		unsigned	i;
 
-		DBG(cdev, "cfg %d/%p speeds:%s%s\n",
+		DBG(cdev, "cfg %d/%p speeds:%s%s%s\n",
 			config->bConfigurationValue, config,
+			config->superspeed ? " super" : "",
 			config->highspeed ? " high" : "",
 			config->fullspeed
 				? (gadget_is_dualspeed(cdev->gadget)
 					? " full"
-					: " full/low")
-				: "");
+					: " full/low") : "");
 
 		for (i = 0; i < MAX_CONFIG_INTERFACES; i++) {
 			struct usb_function	*f = config->interface[i];
@@ -851,6 +1051,7 @@ composite_setup(struct usb_gadget *gadget, const
 struct usb_ctrlrequest *ctrl)
 	struct usb_composite_dev	*cdev = get_gadget_data(gadget);
 	struct usb_request		*req = cdev->req;
 	int				value = -EOPNOTSUPP;
+	int				status = 0;
 	u16				w_index = le16_to_cpu(ctrl->wIndex);
 	u8				intf = w_index & 0xFF;
drivers/usb/gadget/composite.c +14 -2
 	u16				w_value = le16_to_cpu(ctrl->wValue);
@@ -878,18 +1079,30 @@ composite_setup(struct usb_gadget *gadget, const
 struct usb_ctrlrequest *ctrl)
 		case USB_DT_DEVICE:
 			cdev->desc.bNumConfigurations =
 				count_configs(cdev, USB_DT_DEVICE);
+			cdev->desc.bMaxPacketSize0 =
+				cdev->gadget->ep0->maxpacket;
+			if (gadget->speed >= USB_SPEED_SUPER)
+				cdev->desc.bcdUSB = cpu_to_le16(0x0300);
+			else if ((gadget_is_superspeed(gadget)) &&
+				 (gadget->speed <= USB_SPEED_HIGH))
+				cdev->desc.bcdUSB = cpu_to_le16(0x0210);
+
 			value = min(w_length, (u16) sizeof cdev->desc);
 			memcpy(req->buf, &cdev->desc, value);
 			break;
+
 		case USB_DT_DEVICE_QUALIFIER:
-			if (!gadget_is_dualspeed(gadget))
+			if (!gadget_is_dualspeed(gadget) ||
+			    gadget->speed >= USB_SPEED_SUPER)
 				break;
+
 			device_qual(cdev);
 			value = min_t(int, w_length,
 				sizeof(struct usb_qualifier_descriptor));
 			break;
 		case USB_DT_OTHER_SPEED_CONFIG:
-			if (!gadget_is_dualspeed(gadget))
+			if (!gadget_is_dualspeed(gadget) ||
+			    gadget->speed >= USB_SPEED_SUPER)
 				break;
 			/* FALLTHROUGH */
drivers/usb/gadget/composite.c +55 -0
 		case USB_DT_CONFIG:
@@ -903,6 +1116,12 @@ composite_setup(struct usb_gadget *gadget, const
 struct usb_ctrlrequest *ctrl)
 			if (value >= 0)
 				value = min(w_length, (u16) value);
 			break;
+		case USB_DT_BOS:
+			if (gadget_is_superspeed(gadget)) {
+				value = bos(cdev);
+				value = min(w_length, (u16) value);
+			}
+			break;
 		}
 		break;
@@ -962,6 +1181,55 @@ composite_setup(struct usb_gadget *gadget, const
 struct usb_ctrlrequest *ctrl)
 		*((u8 *)req->buf) = value;
 		value = min(w_length, (u16) 1);
 		break;
+
+		/*USB 3.0 additions*/
+	/* Function driver should handle get_status request. If such cb
+	  wasn't supplied we respond with default value = 0
+	  Note: FD should supply such cb only for the first interface
+	  of the function*/
+	case USB_REQ_GET_STATUS:
+		if (!gadget_is_superspeed(gadget))
+			goto unknown;
+		if (ctrl->bRequestType != (USB_DIR_IN | USB_RECIP_INTERFACE))
+			goto unknown;
+		value = 2;	/*This is the length of the get_status reply*/
+		*((u16 *)req->buf) = 0;
+		if (!cdev->config || w_index >= MAX_CONFIG_INTERFACES)
+			break;
+		f = cdev->config->interface[intf];
+		if (!f)
+			break;
+		status = f->get_status ? f->get_status(f) : 0;
+		if (status < 0)
+			break;
+		*((u16 *)req->buf) = status & 0x0000ffff;
+		break;
+	/*Function drivers should handle SetFeature(FUNCTION_SUSPEND) request.
+	  function_suspend cb should be supplied only for the first interface
+	  of the function*/
+	case USB_REQ_SET_FEATURE:
+		if (!gadget_is_superspeed(gadget))
+			goto unknown;
+		if (ctrl->bRequestType != (USB_DIR_IN | USB_RECIP_INTERFACE))
+			goto unknown;
+		switch (w_value) {
+		case USB_INTRF_FUNC_SUSPEND:
+			if (!cdev->config || w_index >= MAX_CONFIG_INTERFACES)
+				break;
+			f = cdev->config->interface[intf];
+			if (!f)
+				break;
+			value = f->func_suspend ? f->func_suspend(f) : 0;
+			if (value < 0) {
+				ERROR(cdev, "func_suspend() returned "
+					    "error %d\n", value);
+				value = 0;
+			}
+			break;
+		default:
+			break;
+		}
+		break;
 	default:
 unknown:
drivers/usb/gadget/composite.c +7 -2
 		VDBG(cdev,
@@ -1080,8 +1348,11 @@ composite_unbind(struct usb_gadget *gadget)
 				DBG(cdev, "unbind function '%s'/%p\n",
 						f->name, f);
 				f->unbind(c, f);
-				/* may free memory for "f" */
 			}
+			/*Free memory allocated for ss descriptors*/
+			if (f->ss_desc_allocated && f->ss_descriptors)
+				usb_free_descriptors(f->ss_descriptors);
+			/* may free memory for "f" */
 		}
 		list_del(&c->list);
 		if (c->unbind) {
@@ -1254,7 +1525,6 @@ composite_resume(struct usb_gadget *gadget)
 
 static struct usb_gadget_driver composite_driver = {
 	.speed		= USB_SPEED_HIGH,
-
 	.bind		= composite_bind,
 	.unbind		= composite_unbind,
 
@@ -1293,6 +1563,9 @@ int usb_composite_register(struct
 usb_composite_driver *driver)
 		driver->name = "composite";
 	composite_driver.function =  (char *) driver->name;
 	composite_driver.driver.name = driver->name;
+#ifdef CONFIG_USB_GADGET_SUPERSPEED
+	composite_driver.speed = USB_SPEED_SUPER;
+#endif /*CONFIG_USB_GADGET_SUPERSPEED*/
 	composite = driver;
 
drivers/usb/gadget/composite.c +0 -0
 	return usb_gadget_register_driver(&composite_driver);
include/linux/usb/ch9.h +15 -0
index da2ed77..69e528a 100644
@@ -125,6 +125,20 @@
 
 #define USB_ENDPOINT_HALT		0	/* IN/OUT will STALL */
 
+/**
+ * New Feature Selectors as added by USB 3.0
+ * See USB 3.0 spec Table 9-6
+ */
+#define USB_DEVICE_U1_ENABLE		48	/*enables the upstream port to
+						initiate requests for transition
+						into U1 state*/
+#define USB_DEVICE_U2_ENABLE		49	/*enables the upstream port to
+						initiate requests for transition
+						into U2 state*/
+#define USB_DEVICE_LTM_ENABLE		50	/*enables the devise to send
+						Latency tolerance messages.*/
+#define USB_INTRF_FUNC_SUSPEND		0	/*function suspend*/
+
 
 /**
  * struct usb_ctrlrequest - SETUP data for a USB device control request
@@ -675,6 +689,7 @@ struct usb_bos_descriptor {
 	__u8  bNumDeviceCaps;
 } __attribute__((packed));
 
+#define USB_DT_BOS_SIZE		5
 /*-------------------------------------------------------------------------*/
 
 /* USB_DT_DEVICE_CAPABILITY:  grouped with BOS */
@@ -712,16 +727,51 @@ struct usb_wireless_cap_descriptor {	/* Ultra Wide

Band */

include/linux/usb/ch9.h +26 -2
 	__u8  bReserved;
 } __attribute__((packed));
 
+/*USB 2.0 Extension descriptor*/
 #define	USB_CAP_TYPE_EXT		2
-
 struct usb_ext_cap_descriptor {		/* Link Power Management */
 	__u8  bLength;
 	__u8  bDescriptorType;
 	__u8  bDevCapabilityType;
-	__u8  bmAttributes;
+	__u32 bmAttributes;
 #define USB_LPM_SUPPORT			(1 << 1)	/* supports LPM */
 } __attribute__((packed));
 
+#define USB_DT_USB_EXT_CAP_SIZE	7
+
+/*SuperSpeed USB Capability descriptor: Defines the set of SuperSpeed USB
+  specific device level capabilities*/
+#define	SS_USB_CAP_TYPE		3
+struct ss_usb_cap_descriptor {		/* Link Power Management */
+	__u8  bLength;
+	__u8  bDescriptorType;
+	__u8  bDevCapabilityType;
+	__u8  bmAttributes;
+#define USB_LTM_SUPPORT			(1 << 1) /* supports LTM */
+	__u16 wSpeedSupported;
+#define USB_LOW_SPEED_OPERATION		(1)	 /* Low speed operation */
+#define USB_FULL_SPEED_OPERATION	(1 << 1) /* Full speed operation */
+#define USB_HIGH_SPEED_OPERATION	(1 << 2) /* High speed operation */
+#define USB_5GBPS_OPERATION		(1 << 3) /* Operation at 5Gbps */
+	__u8  bFunctionalitySupport;
+	__u8  bU1devExitLat;
+	__u16 bU2DevExitLat;
+} __attribute__((packed));
+
+#define USB_DT_SS_USB_CAP_SIZE	10
+
+/*Container ID Capability descriptor: Defines the instance unique ID used

to

include/linux/usb/ch9.h +11 -0
+  identify the instance across all operating modes*/
+#define	CONTAINER_ID_TYPE	4
+struct ss_usb_container_id_descriptor {
+	__u8  bLength;
+	__u8  bDescriptorType;
+	__u8  bDevCapabilityType;
+	__u8  bReserved;
+	__u8  ContainerID[16]; /*128-bit number*/
+} __attribute__((packed));
+
+#define USB_DT_SS_CONTN_ID_SIZE	20
 /*-------------------------------------------------------------------------*/
 
 /* USB_DT_WIRELESS_ENDPOINT_COMP:  companion descriptor associated with
include/linux/usb/composite.h +11 -0
index c623bed..36ab1d0 100644
@@ -52,6 +52,18 @@ struct usb_configuration;
  * @hs_descriptors: Table of high speed descriptors, using interface and
  *	string identifiers assigned during @bind().  If this pointer is null,
  *	the function will not be available at high speed.
+ * @ss_descriptors: Table of super speed descriptors. If
+ *	wasnt supplied by the FD during @bind() and
+ *	!ss_not_capble, will be generated automaticly with
+ *	default values while working in superspeed mode. If this
+ *	pointer is null after initiation, the function will not
+ *	be available at super speed.
+ * @ss_not_capable: This flag is used by the FD to indicate if
+ *	this function is SS capble. Meaning: if SS descriptors
+ *	weren't supplied by the FD, and the flag is set ss
+ *	descriptors will NOT be automatically generated
+ * @ss_desc_allocated: This flag indicates whether the ss descriptors

were
+ * dynamically allocated (and needs to be released).
* @config: assigned when @usb_add_function() is called; this is the
* configuration with which this function is associated.
* @bind: Before the gadget can register, all of its functions bind() to
the

include/linux/usb/composite.h +4 -0
@@ -70,6 +82,10 @@ struct usb_configuration;
  * @setup: Used for interface-specific control requests.
  * @suspend: Notifies functions when the host stops sending USB traffic.
  * @resume: Notifies functions when the host restarts USB traffic.
+ * @get_status: Returns function status as a reply to
+ *	GetStatus() request when the recepient is Interface.
+ * @func_suspend: callback to be called when
+ *	SetFeature(FUNCTION_SUSPEND) is reseived
  *
  * A single USB function uses one or more interfaces, and should in most
  * cases support operation at both full and high speeds.  Each function

is

include/linux/usb/composite.h +8 -0
@@ -99,6 +115,10 @@ struct usb_function {
 	struct usb_gadget_strings	**strings;
 	struct usb_descriptor_header	**descriptors;
 	struct usb_descriptor_header	**hs_descriptors;
+	struct usb_descriptor_header	**ss_descriptors;
+
+	unsigned			ss_desc_allocated:1;
+	unsigned			ss_not_capable:1;
 
 	struct usb_configuration	*config;
 
@@ -125,6 +145,9 @@ struct usb_function {
 	void			(*suspend)(struct usb_function *);
 	void			(*resume)(struct usb_function *);
 
+	/* USB 3.0 additions */
+	int			(*get_status)(struct usb_function *);
+	int			(*func_suspend)(struct usb_function *);
 	/* private: */
 	/* internals */
 	struct list_head		list;
@@ -229,6 +252,7 @@ struct usb_configuration {
 	struct list_head	list;
 	struct list_head	functions;
 	u8			next_interface_id;
+	unsigned		superspeed:1;
 	unsigned		highspeed:1;
 	unsigned		fullspeed:1;
 	struct usb_function	*interface[MAX_CONFIG_INTERFACES];
include/linux/usb/gadget.h +0 -0
index bf7dc0b..40329b0 100644
@@ -139,6 +139,8 @@ struct usb_ep_ops {
  * @desc:endpoint descriptor.  this pointer set before endpoint is

enabled and
* remains valid until the endpoint is disabled; the data byte order
* is little-endian (usb-standard).
+ * @comp_desc: In case of SuperSpeed support, this is the
+ * endpoint companion descriptor that is used to configure the endpoint
*
* the bus controller driver lists all the general purpose endpoints in
* gadget->ep_list. the control endpoint (gadget->ep0) is not in that
list,

include/linux/usb/gadget.h +17 -0
@@ -153,6 +155,7 @@ struct usb_ep {
 	unsigned			maxpacket:16;
 	u8				bEndpointAddress;
 	struct usb_endpoint_descriptor	*desc;
+	struct usb_ss_ep_comp_descriptor	*comp_desc;
 };
 
 /*-------------------------------------------------------------------------*/
@@ -525,6 +528,22 @@ static inline int gadget_is_dualspeed(struct
 usb_gadget *g)
 }
 
 /**
+ * gadget_is_superspeed - return true if the hardware handles
+ * supperspeed
+ */
+static inline int gadget_is_superspeed(struct usb_gadget *g)
+{
+#ifdef CONFIG_USB_GADGET_SUPERSPEED
+	/* runtime test would check "g->is_superspeed" ... that might be
+	 * useful to work around hardware bugs, but is mostly pointless
+	 */
+	return 1;
+#else
+	return 0;
+#endif
+}
+
+/**
  * gadget_is_otg - return true iff the hardware is OTG-ready
  * @g: controller that might have a Mini-AB connector

*
--
1.6.3.3

--
Sent by an consultant of the Qualcomm Innovation Center, Inc. The Qualcomm Innovation Center, Inc. is a member of the Code Aurora Forum.