File: usbipd.8

package info (click to toggle)
linux 6.1.8-1
  • links: PTS, VCS
  • area: main
  • in suites: bookworm
  • size: 1,488,076 kB
  • sloc: ansic: 23,401,844; asm: 266,744; sh: 108,976; makefile: 49,705; python: 36,927; perl: 36,810; cpp: 6,044; yacc: 4,904; lex: 2,722; awk: 1,440; ruby: 25; sed: 5
file content (119 lines) | stat: -rw-r--r-- 2,580 bytes parent folder | download | duplicates (15)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
.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.  The clients authorised to connect may be
configured as documented in hosts_access(5).

.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\-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
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 running on an authorised host can connect and
use exported devices.

.SH EXAMPLES

    server:# modprobe usbip-host

    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.

The following example shows the usage 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
        - List gadgets exported by local usbipd server.

    server:# modprobe -r g_mass_storage
        - Unbind a gadget from usbip-vudc.
        - in this example, the previous mass storage gadget is unbound.

.SH "SEE ALSO"
\fBusbip\fP\fB(8)\fB\fP