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.Dd October 20, 2017 26.Dt UDBP 4 27.Os 28.Sh NAME 29.Nm udbp 30.Nd USB Double Bulk Pipe driver 31.Sh SYNOPSIS 32To compile this driver into the kernel, 33place the following line in your 34kernel configuration file: 35.Bd -ragged -offset indent 36.Cd "device udbp" 37.Ed 38.Pp 39Alternatively, to load the driver as a 40module at boot time, place the following line in 41.Xr loader.conf 5 : 42.Bd -literal -offset indent 43udbp_load="YES" 44.Ed 45.Sh DESCRIPTION 46The 47.Nm 48driver provides support for host-to-host cables 49that contain at least two bulk pipes (one for each direction). 50This typically includes cables branded for use with 51.Sy Windows USB Easy Transfer , 52and many cables based on the Prolific PL2xx1 series of USB bridge chips. 53A useful (but non-comprehensive) list of compatible USB host cables 54is listed in the 55.Sx SEE ALSO 56section below. 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: eiface data ether 93.Dl ifconfig ngeth0 ether aa:dd:xx:xx:xx 94.Dl ifconfig ngeth0 inet 169.254.x.x/16 95.Pp 96Create a new Ethernet network interface node 97and connect its ether hook to the data hook of the 98.Nm 99driver. 100.Pp 101This enables FreeBSD to communicate with a Linux peer (e.g. using the 102.Sy plusb 103driver). 104The Linux node should be configured to prefer link-local IPv4 addresses 105(e.g. using Network Manager in Debian and Red Hat derived distributions). 106.Pp 107Whilst both FreeBSD and Linux are able to interoperate by 108loosely following CDC EEM 1.0 in their behaviour, neither implementation 109has been expressly designed to follow its specification. 110.Sh SEE ALSO 111.Xr netgraph 4 , 112.Xr ng_eiface 4 , 113.Xr ohci 4 , 114.Xr uhci 4 , 115.Xr usb 4 , 116.Xr ngctl 8 117.\" 118.Rs 119.%B Universal Serial Bus: Communications Class Subclass Specification for Ethernet Emulation Model Devices 120.%N Revision 1.0 121.%D February 2, 2005 122.%I USB Implementers Forum, Inc. 123.%U http://www.usb.org/developers/docs/devclass_docs/CDC_EEM10.pdf 124.Re 125.\" 126.Rs 127.%B Total Commander: Supported cables for USB cable connection 128.%I Ghisler Software GmbH. 129.%U https://www.ghisler.com/cables/index.htm 130.Re 131.Sh CAVEATS 132The point-to-point nature and additional latency of USB host-host links 133makes them unsuitable as a "drop-in" replacement for an Ethernet LAN; 134for a USB 3.0 SuperSpeed cable, latency is comparable to 100BaseTX Ethernet 135(but often worse), with throughput comparable to 2.5GBASE-T. 136.Pp 137However, their energy efficiency makes them attractive for embedded applications. 138A Plugable PL27A1 cable claims 24mA of USB3 bus power, 139as compared to 150mA for a typical USB 3.0 to Gigabit Ethernet interface. 140.Sh HISTORY 141The 142.Nm 143driver first appeared in 144.Fx 5.0 . 145.Sh BUGS 146The 147.Nm 148driver does not support the special packets described in section 5.1 149of the CDC EEM specification. 150.Sh AUTHORS 151.An -nosplit 152The 153.Nm 154driver was written by 155.An Doug Ambrisko Aq Mt ambrisko@whistle.com , 156.An Julian Elischer Aq Mt julian@FreeBSD.org 157and 158.An Nick Hibma Aq Mt n_hibma@FreeBSD.org . 159.Pp 160This manual page was written by 161.An Nick Hibma Aq Mt n_hibma@FreeBSD.org 162and updated by 163.An Bruce Simpson Aq Mt bms@FreeBSD.org . 164