usbip: tools: add options and examples in man page related to device mode

PATCH Superseded Hongren Zheng (Zenithal) 2 participants 6 messages Mar 15, 2021

Subsystems (2)

USB USB over IP driver

lore

Share & tools

lore

Hongren Zheng (Zenithal)

author reviewer

2021-03-15 12:41 UTC #0 lore raw

PATCH 1/2 usbip: tools: add options and examples in man page related to device mode

The commit e0546fd8b748b19d8edd1550530da8ebad6e4b31 implemented device mode for user space tools, however the corresponding options are not documented in man page.

This commit documents the options and provides examples on device mode.

---
 tools/usb/usbip/doc/usbip.8  | 25 +++++++++++++++++++++++++
 tools/usb/usbip/doc/usbipd.8 | 22 ++++++++++++++++++++++
 2 files changed, 47 insertions(+)

tools/usb/usbip/doc/usbip.8 +25 -0

index a15d20063b98..385b0eda8746 100644
@@ -49,6 +49,13 @@ then exit.
 Attach a remote USB device.
 .PP
 
+.HP
+\fBattach\fR \-\-remote=<\fIhost\fR> \-\-device=<\fdev_id\fR>
+.IP
+Attach a remote USB gadget.
+Only used when the remote usbipd is in device mode.
+.PP
+
 .HP
 \fBdetach\fR \-\-port=<\fIport\fR>
 .IP

@@ -73,6 +80,14 @@ Stop exporting a device so it can be used by a local driver.
 List USB devices exported by a remote host.
 .PP
 
+.HP
+\fBlist\fR \-\-device
+.IP
+List USB gadgets of local usbip-vudc.
+Only used when the local usbipd is in device mode.
+This can not list usbip-vudc USB gadgets of the remote device mode usbipd.
+.PP
+
 .HP
 \fBlist\fR \-\-local
 .IP

@@ -93,5 +108,15 @@ List local USB devices.
     client:# usbip detach --port=0
         - Detach the usb device.
 
+The following example shows the use of device mode
+
+    server:# usbip list --device
+        - Note this is the server side
+
+    client:# modprobe vhci-hcd
+
+    client:# usbip attach --remote=server --device=usbip-vudc.0
+        - Connect the remote USB gadget
+
 .SH "SEE ALSO"
 \fBusbipd\fP\fB(8)\fB\fP

tools/usb/usbip/doc/usbipd.8 +22 -0

index fb62a756893b..53c8d5792de6 100644
@@ -29,6 +29,12 @@ Bind to IPv4. Default is both.
 Bind to IPv6. Default is both.
 .PP
 
+.HP
+\fB\-e\fR, \fB\-\-device\fR
+.IP
+Run in device mode. Rather than drive an attached device, create a virtual UDC to bind gadgets to.
+.PP
+
 .HP
 \fB\-D\fR, \fB\-\-daemon\fR
 .IP

@@ -86,6 +92,22 @@ USB/IP client can connect and use exported devices.
         - A usb device 1-2 is now exportable to other hosts!
         - Use 'usbip unbind --busid=1-2' when you want to shutdown exporting and use the device locally.
 
+The following example shows the use of device mode
+
+    server:# modprobe usbip-vudc
+        - Use /sys/class/udc/ interface
+        - usbip-host is independent of this module.
+
+    server:# usbipd -e -D
+        - Start usbip daemon in device mode.
+
+    server:# modprobe g_mass_storage file=/tmp/tmp.img
+        - Bind a gadget to usbip-vudc
+        - in this example, a mass storage gadget is bound
+
+    server:# usbip list --device
+        - Note this is the server side
+
 .SH "SEE ALSO"
 \fBusbip\fP\fB(8)\fB\fP

Signature · 1 line

2.30.1

Hongren Zheng (Zenithal)

author reviewer

2021-03-15 12:45 UTC #1 lore raw

PATCH 2/2 usbip: tools: add usage of device mode in usbip_list.c

The option '-d/--device' was implemented in 'usbip list' but not shown in usage. Hence this commit adds this option to usage.

---
 tools/usb/usbip/src/usbip_list.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

tools/usb/usbip/src/usbip_list.c +2 -1

index 8625b0f514ee..3d810bcca02f 100644
@@ -33,7 +33,8 @@ static const char usbip_list_usage_string[] =
 	"usbip list [-p|--parsable] <args>\n"
 	"    -p, --parsable         Parsable list format\n"
 	"    -r, --remote=<host>    List the exportable USB devices on <host>\n"
-	"    -l, --local            List the local USB devices\n";
+	"    -l, --local            List the local USB devices\n"
+	"    -d, --device           List the local USB gadgets bound to usbip-vudc\n";
 
 void usbip_list_usage(void)
 {

Signature · 1 line

2.30.1

This is the friendly patch-bot of Greg Kroah-Hartman. You have sent him a patch that has triggered this response. He used to manually respond to these common problems, but in order to save his sanity (he kept writing the same thing over and over, yet to different people), I was created. Hopefully you will not take offence and will fix the problem in your patch and resubmit it so that it can be accepted into the Linux kernel tree.

You are receiving this message because of the following common error(s) as indicated below:

- Your patch does not have a Signed-off-by: line. Please read the kernel file, Documentation/SubmittingPatches and resend it after adding that line. Note, the line needs to be in the body of the email, before the patch, not at the bottom of the patch or in the email signature.

If you wish to discuss this problem further, or you have questions about how to resolve this issue, please feel free to respond to this email and Greg will reply once he has dug out from the pending patches received from other developers.

thanks,

greg k-h's patch email bot

Hongren Zheng (Zenithal)

author reviewer

2021-03-15 13:14 UTC #2 lore raw

PATCH v2 1/2 usbip: tools: add options and examples in man page related to device mode

In reply to Hongren Zheng (Zenithal)

The commit e0546fd8b748b19d8edd1550530da8ebad6e4b31 implemented device mode for user space tools, however the corresponding options are not documented in man page.

This commit documents the options and provides examples on device mode.

PATCH v2:
Add signed-off-by line

Signed-off-by "Hongren Zheng (Zenithal)" <[email protected]>

---
 tools/usb/usbip/doc/usbip.8  | 25 +++++++++++++++++++++++++
 tools/usb/usbip/doc/usbipd.8 | 22 ++++++++++++++++++++++
 2 files changed, 47 insertions(+)

tools/usb/usbip/doc/usbip.8 +25 -0

index a15d20063b98..385b0eda8746 100644
@@ -49,6 +49,13 @@ then exit.
 Attach a remote USB device.
 .PP
 
+.HP
+\fBattach\fR \-\-remote=<\fIhost\fR> \-\-device=<\fdev_id\fR>
+.IP
+Attach a remote USB gadget.
+Only used when the remote usbipd is in device mode.
+.PP
+
 .HP
 \fBdetach\fR \-\-port=<\fIport\fR>
 .IP

@@ -73,6 +80,14 @@ Stop exporting a device so it can be used by a local driver.
 List USB devices exported by a remote host.
 .PP
 
+.HP
+\fBlist\fR \-\-device
+.IP
+List USB gadgets of local usbip-vudc.
+Only used when the local usbipd is in device mode.
+This can not list usbip-vudc USB gadgets of the remote device mode usbipd.
+.PP
+
 .HP
 \fBlist\fR \-\-local
 .IP

@@ -93,5 +108,15 @@ List local USB devices.
     client:# usbip detach --port=0
         - Detach the usb device.
 
+The following example shows the use of device mode
+
+    server:# usbip list --device
+        - Note this is the server side
+
+    client:# modprobe vhci-hcd
+
+    client:# usbip attach --remote=server --device=usbip-vudc.0
+        - Connect the remote USB gadget
+
 .SH "SEE ALSO"
 \fBusbipd\fP\fB(8)\fB\fP

tools/usb/usbip/doc/usbipd.8 +22 -0

index fb62a756893b..53c8d5792de6 100644
@@ -29,6 +29,12 @@ Bind to IPv4. Default is both.
 Bind to IPv6. Default is both.
 .PP
 
+.HP
+\fB\-e\fR, \fB\-\-device\fR
+.IP
+Run in device mode. Rather than drive an attached device, create a virtual UDC to bind gadgets to.
+.PP
+
 .HP
 \fB\-D\fR, \fB\-\-daemon\fR
 .IP

@@ -86,6 +92,22 @@ USB/IP client can connect and use exported devices.
         - A usb device 1-2 is now exportable to other hosts!
         - Use 'usbip unbind --busid=1-2' when you want to shutdown exporting and use the device locally.
 
+The following example shows the use of device mode
+
+    server:# modprobe usbip-vudc
+        - Use /sys/class/udc/ interface
+        - usbip-host is independent of this module.
+
+    server:# usbipd -e -D
+        - Start usbip daemon in device mode.
+
+    server:# modprobe g_mass_storage file=/tmp/tmp.img
+        - Bind a gadget to usbip-vudc
+        - in this example, a mass storage gadget is bound
+
+    server:# usbip list --device
+        - Note this is the server side
+
 .SH "SEE ALSO"
 \fBusbip\fP\fB(8)\fB\fP

Signature · 1 line

2.30.1

Hongren Zheng (Zenithal)

author reviewer

2021-03-15 13:17 UTC #3 lore raw

PATCH v2 2/2 usbip: tools: add usage of device mode in usbip_list.c

The option '-d/--device' was implemented in 'usbip list' but not shown in usage. Hence this commit adds this option to usage.

PATCH v2:
Add signed-off-by line

Signed-off-by "Hongren Zheng (Zenithal)" <[email protected]>

---
 tools/usb/usbip/src/usbip_list.c | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

tools/usb/usbip/src/usbip_list.c +2 -1

index 8625b0f514ee..3d810bcca02f 100644
@@ -33,7 +33,8 @@ static const char usbip_list_usage_string[] =
 	"usbip list [-p|--parsable] <args>\n"
 	"    -p, --parsable         Parsable list format\n"
 	"    -r, --remote=<host>    List the exportable USB devices on <host>\n"
-	"    -l, --local            List the local USB devices\n";
+	"    -l, --local            List the local USB devices\n"
+	"    -d, --device           List the local USB gadgets bound to usbip-vudc\n";
 
 void usbip_list_usage(void)
 {

Signature · 1 line

2.30.1

Greg Kroah-Hartman

maintainer

2021-03-15 14:28 UTC #4 lore raw

In reply to Hongren Zheng (Zenithal)

Quoted 8 lines · Hongren Zheng (Zenithal)

The commit e0546fd8b748b19d8edd1550530da8ebad6e4b31 implemented device mode for user space tools, however the corresponding options are not documented in man page.
This commit documents the options and provides examples on device mode.
PATCH v2:
Add signed-off-by line

This needs to go below the --- line, as the Documentation asks for. Please fix it up and try it again.

Quoted 1 line

Signed-off-by "Hongren Zheng (Zenithal)" <[email protected]>

Do you sign legal documents with "(Zenithal)"?

thanks,

greg k-h