summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/cdce.4 3.html
diff options
context:
space:
mode:
authorJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:59:05 -0400
committerJacob McDonnell <jacob@jacobmcdonnell.com>2026-04-25 19:59:05 -0400
commit1f19f33e45791ea59aed048796fc68672c6723a5 (patch)
tree54625fba89e91d1c2177801ec635e8528bba937f /static/freebsd/man4/cdce.4 3.html
parentac5e55f5f2af5b92794c2aded46c6bae85b5f5ed (diff)
docs: Removed Precompiled HTML
Diffstat (limited to 'static/freebsd/man4/cdce.4 3.html')
-rw-r--r--static/freebsd/man4/cdce.4 3.html163
1 files changed, 0 insertions, 163 deletions
diff --git a/static/freebsd/man4/cdce.4 3.html b/static/freebsd/man4/cdce.4 3.html
deleted file mode 100644
index b8ce5fb9..00000000
--- a/static/freebsd/man4/cdce.4 3.html
+++ /dev/null
@@ -1,163 +0,0 @@
-<table class="head">
- <tr>
- <td class="head-ltitle">CDCE(4)</td>
- <td class="head-vol">Device Drivers Manual</td>
- <td class="head-rtitle">CDCE(4)</td>
- </tr>
-</table>
-<div class="manual-text">
-<section class="Sh">
-<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
-<p class="Pp"><code class="Nm">cdce</code> &#x2014; <span class="Nd">USB
- Communication Device Class Ethernet (ECM/NCM) driver</span></p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
-<p class="Pp">To compile this driver into the kernel, place the following lines
- in your kernel configuration file:</p>
-<div class="Bd Pp Bd-indent"><code class="Cd">device uhci</code>
-<br/>
-<code class="Cd">device ohci</code>
-<br/>
-<code class="Cd">device usb</code>
-<br/>
-<code class="Cd">device miibus</code>
-<br/>
-<code class="Cd">device uether</code>
-<br/>
-<code class="Cd">device cdce</code></div>
-<p class="Pp">Mobile Devices (e.g., Huawei E3372, E5573 and others) may need
- additionally the u3g command port:</p>
-<div class="Bd Pp Bd-indent"><code class="Cd">device ucom</code>
-<br/>
-<code class="Cd">device u3g</code></div>
-<p class="Pp">Alternatively, to load the driver as a module at boot time, place
- the following line in <a class="Xr">loader.conf(5)</a>:</p>
-<div class="Bd Pp Bd-indent Li">
-<pre>if_cdce_load=&quot;YES&quot;</pre>
-</div>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
-<p class="Pp">The <code class="Nm">cdce</code> driver provides support for USB
- Host-to-Host (aka USB-to-USB) and USB-to-Ethernet bridges based on the USB
- Communication Device Class Ethernet Control Model (CDC ECM) and Network
- Control Model (CDC NCM) specifications. It also provides device-side CDC ECM
- support.</p>
-<p class="Pp">The USB bridge appears as a regular network interface on both
- sides, transporting Ethernet frames.</p>
-<p class="Pp">For more information on configuring this device, see
- <a class="Xr">ifconfig(8)</a>.</p>
-<p class="Pp">USB 1.x bridges support speeds of up to 12Mbps, and USB 2.0 speeds
- of up to 480Mbps.</p>
-<p class="Pp">Packets are received and transmitted over separate USB bulk
- transfer endpoints.</p>
-<p class="Pp">The <code class="Nm">cdce</code> driver does not support different
- media types or options.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
-<p class="Pp">The <code class="Nm">cdce</code> driver supports USB Ethernet
- interfaces implementing the USB Communication Device Class Ethernet Control
- Model (CDC ECM) or Network Control Model (CDC NCM) protocol, such as:</p>
-<p class="Pp"></p>
-<ul class="Bl-bullet Bl-compact">
- <li>Android USB tethering</li>
- <li>iPhone USB tethering</li>
- <li>Realtek RTL8153 USB 3.0 to Gigabit Ethernet controller</li>
- <li>Prolific PL-2501 Host-to-Host Bridge controller</li>
- <li>Sharp Zaurus PDA</li>
- <li>Terayon TJ-715 DOCSIS Cable Modem</li>
- <li>Huawei 3G/4G LTE (e.g., E3372, E5573) and other mobile network
- devices</li>
-</ul>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
-<p class="Pp">Mobile <code class="Nm">cdce</code> Network Devices may need a
- connect command sequence via the <a class="Xr">u3g(4)</a> serial command
- port before activating the NCM/ECM/ACM network interface. For example:</p>
-<p class="Pp"></p>
-<div class="Bd Bd-indent"><code class="Li">echo
- 'AT^NDISUP=1,1,&quot;internet&quot;' &gt; /dev/cuaU[0].0</code></div>
-<p class="Pp">Wwhere &#x201C;internet&#x201D; is your providers apn name.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="DIAGNOSTICS"><a class="permalink" href="#DIAGNOSTICS">DIAGNOSTICS</a></h1>
-<dl class="Bl-diag">
- <dt>cdce%d: no union descriptor</dt>
- <dd>The driver could not fetch an interface descriptor from the USB device.
- For a manually added USB vendor/product, the CDCE_NO_UNION flag can be
- tried to work around the missing descriptor.</dd>
- <dt>cdce%d: no data interface</dt>
- <dd></dd>
- <dt>cdce%d: could not read endpoint descriptor</dt>
- <dd></dd>
- <dt>cdce%d: unexpected endpoint</dt>
- <dd></dd>
- <dt>cdce%d: could not find data bulk in/out</dt>
- <dd>For a manually added USB vendor/product, these errors indicate that the
- bridge is not compatible with the driver.</dd>
- <dt>cdce%d: watchdog timeout</dt>
- <dd>A packet was queued for transmission and a transmit command was issued,
- however the device failed to acknowledge the transmission before a timeout
- expired.</dd>
- <dt>cdce%d: no memory for rx list -- packet dropped!</dt>
- <dd>Memory allocation through MGETHDR or MCLGET failed, the system is running
- low on mbufs.</dd>
- <dt>cdce%d: abort/close rx/tx pipe failed</dt>
- <dd></dd>
- <dt>cdce%d: rx/tx list init failed</dt>
- <dd></dd>
- <dt>cdce%d: open rx/tx pipe failed</dt>
- <dd></dd>
- <dt>cdce%d: usb error on rx/tx</dt>
- <dd></dd>
-</dl>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
- ALSO</a></h1>
-<p class="Pp"><a class="Xr">arp(4)</a>, <a class="Xr">cdceem(4)</a>,
- <a class="Xr">intro(4)</a>, <a class="Xr">ipheth(4)</a>,
- <a class="Xr">netintro(4)</a>, <a class="Xr">u3g(4)</a>,
- <a class="Xr">ucom(4)</a>, <a class="Xr">urndis(4)</a>,
- <a class="Xr">usb(4)</a>, <a class="Xr">ifconfig(8)</a></p>
-<p class="Pp"><cite class="Rs"><span class="RsT">Universal Serial Bus Class
- Definitions for Communication Devices</span>,
- <a class="RsU" href="http://www.usb.org/developers/devclass_docs/usbcdc11.pdf">http://www.usb.org/developers/devclass_docs/usbcdc11.pdf</a>.</cite></p>
-<p class="Pp"><cite class="Rs"><span class="RsT">Data sheet Prolific PL-2501
- Host-to-Host Bridge/Network Controller</span>,
- <a class="RsU" href="http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530">http://tech.prolific.com.tw/visitor/fcabdl.asp?fid=20679530</a>.</cite></p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
-<p class="Pp">The <code class="Nm">cdce</code> device driver first appeared in
- <span class="Ux">OpenBSD 3.6</span>, <span class="Ux">NetBSD 3.0</span> and
- <span class="Ux">FreeBSD 6.0</span>.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1>
-<p class="Pp">The <code class="Nm">cdce</code> driver was written by
- <span class="An">Craig Boston</span>
- &lt;<a class="Mt" href="mailto:craig@tobuj.gank.org">craig@tobuj.gank.org</a>&gt;
- based on the <a class="Xr">aue(4)</a> driver written by
- <span class="An">Bill Paul</span>
- &lt;<a class="Mt" href="mailto:wpaul@windriver.com">wpaul@windriver.com</a>&gt;
- and ported to <span class="Ux">OpenBSD</span> by <span class="An">Daniel
- Hartmeier</span>
- &lt;<a class="Mt" href="mailto:dhartmei@openbsd.org">dhartmei@openbsd.org</a>&gt;.</p>
-</section>
-<section class="Sh">
-<h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1>
-<p class="Pp">Many USB devices notoriously fail to report their class and
- interfaces correctly. Undetected products might work flawlessly when their
- vendor and product IDs are added to the driver manually.</p>
-</section>
-</div>
-<table class="foot">
- <tr>
- <td class="foot-date">December 23, 2025</td>
- <td class="foot-os">FreeBSD 15.0</td>
- </tr>
-</table>