xref: /freebsd/share/man/man4/udbp.4 (revision 2be1a816b9ff69588e55be0a84cbe2a31efc0f2f)
1.\" Copyright (c) 1999
2.\"	Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\" 3. Neither the name of the author nor the names of any co-contributors
13.\"    may be used to endorse or promote products derived from this software
14.\"   without specific prior written permission.
15.\"
16.\" THIS SOFTWARE IS PROVIDED BY NICK HIBMA AND CONTRIBUTORS ``AS IS'' AND
17.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
18.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
19.\" ARE DISCLAIMED.  IN NO EVENT SHALL NICK HIBMA OR THE VOICES IN HIS HEAD
20.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
21.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
22.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
23.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
24.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
25.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
26.\" THE POSSIBILITY OF SUCH DAMAGE.
27.\"
28.\" $FreeBSD$
29.\"
30.Dd November 22, 2006
31.Dt UDBP 4
32.Os
33.Sh NAME
34.Nm udbp
35.Nd USB Double Bulk Pipe driver
36.Sh SYNOPSIS
37To compile this driver into the kernel,
38place the following line in your
39kernel configuration file:
40.Bd -ragged -offset indent
41.Cd "device udbp"
42.Ed
43.Pp
44Alternatively, to load the driver as a
45module at boot time, place the following line in
46.Xr loader.conf 5 :
47.Bd -literal -offset indent
48udbp_load="YES"
49.Ed
50.Sh DESCRIPTION
51The
52.Nm
53driver provides support for host-to-host cables
54that contain at least two bulk pipes (one for each direction),
55for example
56the EzLink cable and the NetChip 1080 chip.
57.Pp
58.\" XXX	The description of how to add netgraph to the kernel
59.\"	is out of place here.  It should be limited to the
60.\"	netgraph(4) manpage only.  However, that page does
61.\"	not yet give instructions for kldload(8) for the
62.\"	clueless.  Working on it -- sheldonh
63It requires
64.Xr netgraph 4
65to be available.
66This can be done either by adding
67.Cd "options NETGRAPH"
68to your kernel configuration file, or alternatively loading
69.Xr netgraph 4
70as a module, either from
71.Pa /boot/loader.conf
72or from the command line, before the
73.Nm
74module.
75.Sh EXAMPLES
76.Dl options NETGRAPH
77.Dl device udbp
78.Pp
79Add the
80.Nm
81driver to the kernel.
82.Pp
83.Dl kldload netgraph
84.Dl kldload udbp
85.Pp
86Load the
87.Xr netgraph 4
88module and then the
89.Nm
90driver.
91.Pp
92.Dl ngctl mkpeer udbp0: iface data inet
93.Dl ifconfig ng0 10.0.0.1 10.0.0.2
94.Pp
95Create a new network interface node
96and connect its inet hook to the data hook of the
97.Nm
98node.
99.Xr ifconfig 8
100configures the resulting network interface ng0 with a local
101IP address of 10.0.0.1 and a remote IP address of 10.0.0.2.
102On the remote host, the two
103IP addresses should of course be reversed.
104.Sh SEE ALSO
105.Xr netgraph 4 ,
106.Xr ng_iface 4 ,
107.Xr ohci 4 ,
108.Xr uhci 4 ,
109.Xr usb 4 ,
110.Xr ngctl 8
111.Sh HISTORY
112The
113.Nm
114driver first appeared in
115.Fx 5.0 .
116.Sh AUTHORS
117.An -nosplit
118The
119.Nm
120driver was written by
121.An Doug Ambrisko Aq ambrisko@whistle.com ,
122.An Julian Elischer Aq julian@FreeBSD.org
123and
124.An Nick Hibma Aq n_hibma@FreeBSD.org .
125.Pp
126This manual page was written by
127.An Nick Hibma Aq n_hibma@FreeBSD.org .
128