2 .\" Nick Hibma <n_hibma@FreeBSD.org>. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
30 .Nd USB Double Bulk Pipe driver
32 To compile this driver into the kernel,
33 place the following line in your
34 kernel configuration file:
35 .Bd -ragged -offset indent
39 Alternatively, to load the driver as a
40 module at boot time, place the following line in
42 .Bd -literal -offset indent
48 driver provides support for host-to-host cables
49 that contain at least two bulk pipes (one for each direction).
50 This typically includes cables branded for use with
51 .Sy Windows USB Easy Transfer ,
52 and many cables based on the Prolific PL2xx1 series of USB bridge chips.
53 A useful (but non-comprehensive) list of compatible USB host cables
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
66 This can be done either by adding
67 .Cd "options NETGRAPH"
68 to your kernel configuration file, or alternatively loading
70 as a module, either from
72 or from the command line, before the
92 .Dl ngctl mkpeer udbp0: eiface data ether
93 .Dl ifconfig ngeth0 ether aa:dd:xx:xx:xx
94 .Dl ifconfig ngeth0 inet 169.254.x.x/16
96 Create a new Ethernet network interface node
97 and connect its ether hook to the data hook of the
101 This enables FreeBSD to communicate with a Linux peer (e.g. using the
104 The Linux node should be configured to prefer link-local IPv4 addresses
105 (e.g. using Network Manager in Debian and Red Hat derived distributions).
107 Whilst both FreeBSD and Linux are able to interoperate by
108 loosely following CDC EEM 1.0 in their behaviour, neither implementation
109 has been expressly designed to follow its specification.
119 .%B Universal Serial Bus: Communications Class Subclass Specification for Ethernet Emulation Model Devices
122 .%I USB Implementers Forum, Inc.
123 .%U http://www.usb.org/developers/docs/devclass_docs/CDC_EEM10.pdf
127 .%B Total Commander: Supported cables for USB cable connection
128 .%I Ghisler Software GmbH.
129 .%U https://www.ghisler.com/cables/index.htm
132 The point-to-point nature and additional latency of USB host-host links
133 makes them unsuitable as a "drop-in" replacement for an Ethernet LAN;
134 for a USB 3.0 SuperSpeed cable, latency is comparable to 100BaseTX Ethernet
135 (but often worse), with throughput comparable to 2.5GBASE-T.
137 However, their energy efficiency makes them attractive for embedded applications.
138 A Plugable PL27A1 cable claims 24mA of USB3 bus power,
139 as compared to 150mA for a typical USB 3.0 to Gigabit Ethernet interface.
143 driver first appeared in
148 driver does not support the special packets described in section 5.1
149 of the CDC EEM specification.
154 driver was written by
155 .An Doug Ambrisko Aq Mt ambrisko@whistle.com ,
156 .An Julian Elischer Aq Mt julian@FreeBSD.org
158 .An Nick Hibma Aq Mt n_hibma@FreeBSD.org .
160 This manual page was written by
161 .An Nick Hibma Aq Mt n_hibma@FreeBSD.org
163 .An Bruce Simpson Aq Mt bms@FreeBSD.org .