usbip: move usbip userspace code out of staging
At this point, USB/IP userspace code is fully functional and can be moved out of staging. Signed-off-by: Valentina Manea <valentina.manea.m@gmail.com> Signed-off-by: Greg Kroah-Hartman <gregkh@linuxfoundation.org>
This commit is contained in:

committed by
Greg Kroah-Hartman

parent
1ddb55275d
commit
588b48caf6
95
tools/usb/usbip/doc/usbip.8
Normal file
95
tools/usb/usbip/doc/usbip.8
Normal file
@@ -0,0 +1,95 @@
|
||||
.TH USBIP "8" "February 2009" "usbip" "System Administration Utilities"
|
||||
.SH NAME
|
||||
usbip \- manage USB/IP devices
|
||||
.SH SYNOPSIS
|
||||
.B usbip
|
||||
[\fIoptions\fR] <\fIcommand\fR> <\fIargs\fR>
|
||||
|
||||
.SH DESCRIPTION
|
||||
On a USB/IP server, devices can be listed, bound, and unbound using
|
||||
this program. On a USB/IP client, devices exported by USB/IP servers
|
||||
can be listed, attached and detached.
|
||||
|
||||
.SH OPTIONS
|
||||
.HP
|
||||
\fB\-\-debug\fR
|
||||
.IP
|
||||
Print debugging information.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fB\-\-log\fR
|
||||
.IP
|
||||
Log to syslog.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fB\-\-tcp-port PORT\fR
|
||||
.IP
|
||||
Connect to PORT on remote host (used for attach and list --remote).
|
||||
.PP
|
||||
|
||||
.SH COMMANDS
|
||||
.HP
|
||||
\fBversion\fR
|
||||
.IP
|
||||
Show version and exit.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fBhelp\fR [\fIcommand\fR]
|
||||
.IP
|
||||
Print the program help message, or help on a specific command, and
|
||||
then exit.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fBattach\fR \-\-remote=<\fIhost\fR> \-\-busid=<\fIbus_id\fR>
|
||||
.IP
|
||||
Attach a remote USB device.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fBdetach\fR \-\-port=<\fIport\fR>
|
||||
.IP
|
||||
Detach an imported USB device.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fBbind\fR \-\-busid=<\fIbusid\fR>
|
||||
.IP
|
||||
Make a device exportable.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fBunbind\fR \-\-busid=<\fIbusid\fR>
|
||||
.IP
|
||||
Stop exporting a device so it can be used by a local driver.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fBlist\fR \-\-remote=<\fIhost\fR>
|
||||
.IP
|
||||
List USB devices exported by a remote host.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fBlist\fR \-\-local
|
||||
.IP
|
||||
List local USB devices.
|
||||
.PP
|
||||
|
||||
|
||||
.SH EXAMPLES
|
||||
|
||||
client:# usbip list --remote=server
|
||||
- List exportable usb devices on the server.
|
||||
|
||||
client:# usbip attach --remote=server --busid=1-2
|
||||
- Connect the remote USB device.
|
||||
|
||||
client:# usbip detach --port=0
|
||||
- Detach the usb device.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
\fBusbipd\fP\fB(8)\fB\fP
|
91
tools/usb/usbip/doc/usbipd.8
Normal file
91
tools/usb/usbip/doc/usbipd.8
Normal file
@@ -0,0 +1,91 @@
|
||||
.TH USBIP "8" "February 2009" "usbip" "System Administration Utilities"
|
||||
.SH NAME
|
||||
usbipd \- USB/IP server daemon
|
||||
.SH SYNOPSIS
|
||||
.B usbipd
|
||||
[\fIoptions\fR]
|
||||
|
||||
.SH DESCRIPTION
|
||||
.B usbipd
|
||||
provides USB/IP clients access to exported USB devices.
|
||||
|
||||
Devices have to explicitly be exported using
|
||||
.B usbip bind
|
||||
before usbipd makes them available to other hosts.
|
||||
|
||||
The daemon accepts connections from USB/IP clients
|
||||
on TCP port 3240 by default.
|
||||
|
||||
.SH OPTIONS
|
||||
.HP
|
||||
\fB\-4\fR, \fB\-\-ipv4\fR
|
||||
.IP
|
||||
Bind to IPv4. Default is both.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fB\-6\fR, \fB\-\-ipv6\fR
|
||||
.IP
|
||||
Bind to IPv6. Default is both.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fB\-D\fR, \fB\-\-daemon\fR
|
||||
.IP
|
||||
Run as a daemon process.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fB\-d\fR, \fB\-\-debug\fR
|
||||
.IP
|
||||
Print debugging information.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fB\-PFILE\fR, \fB\-\-pid FILE\fR
|
||||
.IP
|
||||
Write process id to FILE.
|
||||
.br
|
||||
If no FILE specified, use /var/run/usbipd.pid
|
||||
.PP
|
||||
|
||||
\fB\-tPORT\fR, \fB\-\-tcp\-port PORT\fR
|
||||
.IP
|
||||
Listen on TCP/IP port PORT.
|
||||
.PP
|
||||
|
||||
\fB\-h\fR, \fB\-\-help\fR
|
||||
.IP
|
||||
Print the program help message and exit.
|
||||
.PP
|
||||
|
||||
.HP
|
||||
\fB\-v\fR, \fB\-\-version\fR
|
||||
.IP
|
||||
Show version.
|
||||
.PP
|
||||
|
||||
.SH LIMITATIONS
|
||||
|
||||
.B usbipd
|
||||
offers no authentication or authorization for USB/IP. Any
|
||||
USB/IP client can connect and use exported devices.
|
||||
|
||||
.SH EXAMPLES
|
||||
|
||||
server:# modprobe usbip
|
||||
|
||||
server:# usbipd -D
|
||||
- Start usbip daemon.
|
||||
|
||||
server:# usbip list --local
|
||||
- List driver assignments for usb devices.
|
||||
|
||||
server:# usbip bind --busid=1-2
|
||||
- Bind usbip-host.ko to the device of busid 1-2.
|
||||
- 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.
|
||||
|
||||
.SH "SEE ALSO"
|
||||
\fBusbip\fP\fB(8)\fB\fP
|
||||
|
Reference in New Issue
Block a user