[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <1a2c79b7-1cc0-9ddd-f2ec-fa7b222113ec@linuxfoundation.org>
Date: Tue, 23 Mar 2021 17:12:00 -0600
From: Shuah Khan <skhan@...uxfoundation.org>
To: "Hongren Zheng (Zenithal)" <i@...ithal.me>,
Valentina Manea <valentina.manea.m@...il.com>,
Shuah Khan <shuah@...nel.org>,
Antonio Borneo <borneo.antonio@...il.com>,
Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
matt mooney <mfm@...eddisk.com>, linux-usb@...r.kernel.org,
Shuah Khan <skhan@...uxfoundation.org>
Cc: linux-kernel@...r.kernel.org
Subject: Re: [PATCH v4 1/2] usbip: tools: add options and examples in man page
related to device mode
On 3/23/21 6:55 AM, Hongren Zheng (Zenithal) wrote:
> The commit e0546fd8b748 ("usbip: tools: Start using VUDC backend in
> usbip tools") 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.
>
> Signed-off-by: Hongren Zheng <i@...ithal.me>
> ---
> tools/usb/usbip/doc/usbip.8 | 25 +++++++++++++++++++++++++
> tools/usb/usbip/doc/usbipd.8 | 22 ++++++++++++++++++++++
> 2 files changed, 47 insertions(+)
>
> PATCH v2:
> Add signed-off-by line
>
> PATCH v3:
> Move patch changelog after the marker line
> Remove nickname in signed-off-by line
>
> PATCH v4:
> Use commit short hash and message instead of long hash only when
> referring to commit in the kernel
>
Thank you for the patch. Please see comments below:
> diff --git a/tools/usb/usbip/doc/usbip.8 b/tools/usb/usbip/doc/usbip.8
> index a15d20063b98..385b0eda8746 100644
> --- a/tools/usb/usbip/doc/usbip.8
> +++ b/tools/usb/usbip/doc/usbip.8
> @@ -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
This is a bit confusing. Please add a separate section for
Attach a remote USB gadget complete with attach and detach
instructions.
> @@ -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
> diff --git a/tools/usb/usbip/doc/usbipd.8 b/tools/usb/usbip/doc/usbipd.8
> index fb62a756893b..53c8d5792de6 100644
> --- a/tools/usb/usbip/doc/usbipd.8
> +++ b/tools/usb/usbip/doc/usbipd.8
> @@ -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
>
>
thanks,
-- Shuah
Powered by blists - more mailing lists