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