163722e52SEdward Tomasz Napierala.\" Copyright (c) 2019 Edward Tomasz Napierala <trasz@FreeBSD.org> 263722e52SEdward Tomasz Napierala.\" 363722e52SEdward Tomasz Napierala.\" Redistribution and use in source and binary forms, with or without 463722e52SEdward Tomasz Napierala.\" modification, are permitted provided that the following conditions 563722e52SEdward Tomasz Napierala.\" are met: 663722e52SEdward Tomasz Napierala.\" 1. Redistributions of source code must retain the above copyright 763722e52SEdward Tomasz Napierala.\" notice, this list of conditions and the following disclaimer. 863722e52SEdward Tomasz Napierala.\" 2. Redistributions in binary form must reproduce the above copyright 963722e52SEdward Tomasz Napierala.\" notice, this list of conditions and the following disclaimer in the 1063722e52SEdward Tomasz Napierala.\" documentation and/or other materials provided with the distribution. 1163722e52SEdward Tomasz Napierala.\" 1263722e52SEdward Tomasz Napierala.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 1363722e52SEdward Tomasz Napierala.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 1463722e52SEdward Tomasz Napierala.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 1563722e52SEdward Tomasz Napierala.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 1663722e52SEdward Tomasz Napierala.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 1763722e52SEdward Tomasz Napierala.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 1863722e52SEdward Tomasz Napierala.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 1963722e52SEdward Tomasz Napierala.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 2063722e52SEdward Tomasz Napierala.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 2163722e52SEdward Tomasz Napierala.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 2263722e52SEdward Tomasz Napierala.\" SUCH DAMAGE. 23*09a05e60SEdward Tomasz Napierala.Dd November 7, 2019 2463722e52SEdward Tomasz Napierala.Dt CDCEEM 4 2563722e52SEdward Tomasz Napierala.Os 2663722e52SEdward Tomasz Napierala.Sh NAME 2763722e52SEdward Tomasz Napierala.Nm cdceem 2863722e52SEdward Tomasz Napierala.Nd "USB Communication Device Class Ethernet Emulation Model (CDC EEM) driver" 2963722e52SEdward Tomasz Napierala.Sh SYNOPSIS 3063722e52SEdward Tomasz NapieralaTo compile this driver into the kernel, 3163722e52SEdward Tomasz Napieralaplace the following lines in your 3263722e52SEdward Tomasz Napieralakernel configuration file: 3363722e52SEdward Tomasz Napierala.Bd -ragged -offset indent 3463722e52SEdward Tomasz Napierala.Cd "device uhci" 3563722e52SEdward Tomasz Napierala.Cd "device ohci" 3663722e52SEdward Tomasz Napierala.Cd "device usb" 3763722e52SEdward Tomasz Napierala.Cd "device miibus" 3863722e52SEdward Tomasz Napierala.Cd "device uether" 3963722e52SEdward Tomasz Napierala.Cd "device cdceem" 4063722e52SEdward Tomasz Napierala.Ed 4163722e52SEdward Tomasz Napierala.Pp 4263722e52SEdward Tomasz NapieralaAlternatively, to load the driver as a 4363722e52SEdward Tomasz Napieralamodule at boot time, place the following line in 4463722e52SEdward Tomasz Napierala.Xr loader.conf 5 : 4563722e52SEdward Tomasz Napierala.Bd -literal -offset indent 4663722e52SEdward Tomasz Napieralaif_cdceem_load="YES" 4763722e52SEdward Tomasz Napierala.Ed 4863722e52SEdward Tomasz Napierala.Sh DESCRIPTION 4963722e52SEdward Tomasz NapieralaThe 5063722e52SEdward Tomasz Napierala.Nm 5163722e52SEdward Tomasz Napieraladriver provides support for USB devices based on the USB Communication 5263722e52SEdward Tomasz NapieralaDevice Class Ethernet Emulation Model (CDC EEM) specification. 5363722e52SEdward Tomasz Napierala.Pp 5463722e52SEdward Tomasz NapieralaThe driver works on both host, and device-side; see 5563722e52SEdward Tomasz Napierala.Xr usb_template 4 5663722e52SEdward Tomasz Napieralafor details. 5763722e52SEdward Tomasz Napierala.Pp 5863722e52SEdward Tomasz NapieralaThe USB device appears as a regular network interface on both sides, 5963722e52SEdward Tomasz Napieralatransporting Ethernet frames. 6063722e52SEdward Tomasz Napierala.Pp 6163722e52SEdward Tomasz NapieralaFor more information on configuring this device, see 6263722e52SEdward Tomasz Napierala.Xr ifconfig 8 . 6363722e52SEdward Tomasz Napierala.Pp 6463722e52SEdward Tomasz NapieralaThe 6563722e52SEdward Tomasz Napierala.Nm 6663722e52SEdward Tomasz Napieraladriver does not support different media types or options. 6763722e52SEdward Tomasz Napierala.Sh SYSCTL VARIABLES 6863722e52SEdward Tomasz NapieralaThe following variables are available as both 6963722e52SEdward Tomasz Napierala.Xr sysctl 8 7063722e52SEdward Tomasz Napieralavariables and 7163722e52SEdward Tomasz Napierala.Xr loader 8 7263722e52SEdward Tomasz Napieralatunables: 7363722e52SEdward Tomasz Napierala.Bl -tag -width indent 7463722e52SEdward Tomasz Napierala.It Va hw.usb.cdceem.debug 7563722e52SEdward Tomasz NapieralaVerbosity level for log messages from the 7663722e52SEdward Tomasz Napierala.Nm 7763722e52SEdward Tomasz Napieraladriver. 7863722e52SEdward Tomasz NapieralaSet to 0 to disable logging or 1 to warn about potential problems. 7963722e52SEdward Tomasz NapieralaLarger values enable debugging output. 8063722e52SEdward Tomasz NapieralaDefaults to 1. 8163722e52SEdward Tomasz Napierala.It Va hw.usb.cdceem.send_echoes 8263722e52SEdward Tomasz NapieralaIf set to 1, the driver will send an Echo EEM packet when the 8363722e52SEdward Tomasz Napieralainterface is brought up. 8463722e52SEdward Tomasz NapieralaWhile responding to Echo is mandatory, some devices cannot handle it. 8563722e52SEdward Tomasz NapieralaOnly use for debugging. 8663722e52SEdward Tomasz NapieralaDefaults to 0. 8763722e52SEdward Tomasz Napierala.It Va hw.usb.cdceem.send_fake_crc 8863722e52SEdward Tomasz NapieralaIf set to 1, the driver will use 0xdeadbeef as the CRC value 8963722e52SEdward Tomasz Napieralafor outgoing Data EEM packets. 9063722e52SEdward Tomasz NapieralaOnly use for debugging. 9163722e52SEdward Tomasz NapieralaDefaults to 0. 9263722e52SEdward Tomasz Napierala.El 9363722e52SEdward Tomasz Napierala.Sh SEE ALSO 9463722e52SEdward Tomasz Napierala.Xr arp 4 , 9563722e52SEdward Tomasz Napierala.Xr cdce 4 , 9663722e52SEdward Tomasz Napierala.Xr intro 4 , 9763722e52SEdward Tomasz Napierala.Xr ipheth 4 , 9863722e52SEdward Tomasz Napierala.Xr netintro 4 , 9963722e52SEdward Tomasz Napierala.Xr urndis 4 , 10063722e52SEdward Tomasz Napierala.Xr usb 4 , 10163722e52SEdward Tomasz Napierala.Xr usb_template 4 , 10263722e52SEdward Tomasz Napierala.Xr ifconfig 8 10363722e52SEdward Tomasz Napierala.Rs 10463722e52SEdward Tomasz Napierala.%T "Universal Serial Bus Communications Class Subclass Specification for Ethernet Emulation Model Devices" 10563722e52SEdward Tomasz Napierala.%U https://usb.org/sites/default/files/CDC_EEM10.pdf 10663722e52SEdward Tomasz Napierala.Re 10763722e52SEdward Tomasz Napierala.Sh HISTORY 10863722e52SEdward Tomasz NapieralaThe 10963722e52SEdward Tomasz Napierala.Nm 11063722e52SEdward Tomasz Napieraladevice driver first appeared in 111*09a05e60SEdward Tomasz Napierala.Fx 12.1 . 11263722e52SEdward Tomasz Napierala.Sh AUTHORS 11363722e52SEdward Tomasz NapieralaThe 11463722e52SEdward Tomasz Napierala.Nm 11563722e52SEdward Tomasz Napieraladriver was written by 11663722e52SEdward Tomasz Napierala.An Edward Tomasz Napierala Aq Mt trasz@FreeBSD.org 11763722e52SEdward Tomasz Napieralaunder sponsorship from Hewlett Packard Enterprise. 118