share/man/man4/udbp.4

   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 April 30, 2000
  31 .Dt UDBP 4
  32 .Os
  33 .Sh NAME
  34 .Nm udbp
  35 .Nd USB Double Bulk Pipe driver
  36 .Sh SYNOPSIS
  37 .Cd "device udbp"
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver provides support for host-to-host cables
  42 that contain at least two bulk pipes (one for each direction),
  43 for example
  44 the EzLink cable and the NetChip 1080 chip.
  45 .Pp
  46 .\" XXX The description of how to add netgraph to the kernel
  47 .\"     is out of place here.  It should be limited to the
  48 .\"     netgraph(4) manpage only.  However, that page does
  49 .\"     not yet give instructions for kldload(8) for the
  50 .\"     clueless.  Working on it -- sheldonh
  51 It requires
  52 .Xr netgraph 4
  53 to be available.
  54 This can be done either by adding
  55 .Cd "options NETGRAPH"
  56 to your kernel configuration file, or alternatively loading
  57 .Xr netgraph 4
  58 as a module, either from
  59 .Pa /boot/loader.conf
  60 or from the command line, before the
  61 .Nm
  62 module.
  63 .Sh EXAMPLES
  64 .Dl options NETGRAPH
  65 .Dl device udbp
  66 .Pp
  67 Add the
  68 .Nm
  69 driver to the kernel.
  70 .Pp
  71 .Dl kldload netgraph
  72 .Dl kldload udbp
  73 .Pp
  74 Load the
  75 .Xr netgraph 4
  76 module and then the
  77 .Nm
  78 driver.
  79 .Pp
  80 .Dl ngctl mkpeer udbp0: iface data inet
  81 .Dl ifconfig ng0 10.0.0.1 10.0.0.2
  82 .Pp
  83 Create a new network interface node
  84 and connect its inet hook to the data hook of the
  85 .Nm
  86 node.
  87 .Xr ifconfig 8
  88 configures the resulting network interface ng0 with a local
  89 IP address of 10.0.0.1 and a remote IP address of 10.0.0.2.
  90 On the remote host, the two
  91 IP addresses should of course be reversed.
  92 .Sh SEE ALSO
  93 .Xr netgraph 4 ,
  94 .Xr ng_iface 4 ,
  95 .Xr ohci 4 ,
  96 .Xr uhci 4 ,
  97 .Xr usb 4 ,
  98 .Xr ngctl 8
  99 .Sh HISTORY
 100 The
 101 .Nm
 102 driver first appeared in
 103 .Fx 5.0 .
 104 .Sh AUTHORS
 105 .An -nosplit
 106 The
 107 .Nm
 108 driver was written by
 109 .An Doug Ambrisko Aq ambrisko@whistle.com ,
 110 .An Julian Elischer Aq julian@FreeBSD.org
 111 and
 112 .An Nick Hibma Aq n_hibma@FreeBSD.org .
 113 .Pp
 114 This manual page was written by
 115 .An Nick Hibma Aq n_hibma@FreeBSD.org .