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