summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/umb.4 3.html
blob: d064c898d7745b915193378b5626165fccef669b (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
<table class="head">
  <tr>
    <td class="head-ltitle">UMB(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">UMB(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">umb</code> &#x2014; <span class="Nd">USB Mobile
    Broadband Interface Model (MBIM) cellular modem driver</span></p>
</section>
<section class="Sh">
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
<p class="Pp"><code class="Cd">device usb</code>
  <br/>
  <code class="Cd">device umb</code></p>
<p class="Pp">In <a class="Xr">loader.conf(5)</a>:
  <br/>
  <code class="Cd">umb_load=&quot;YES&quot;</code></p>
</section>
<section class="Sh">
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
<p class="Pp">The <code class="Nm">umb</code> driver provides support for USB
    MBIM devices. If the appropriate hardware is detected, the driver will be
    loaded automatically by <a class="Xr">devmatch(8)</a>. To load the driver
    manually, <code class="Cm">load</code> it in
    <a class="Xr">loader.conf(5)</a> or at the <a class="Xr">loader(8)</a>
    prompt.</p>
<p class="Pp">MBIM devices establish connections via cellular networks such as
    GPRS, UMTS, and LTE. They appear as a regular point-to-point network
    interface, transporting raw IP frames.</p>
<p class="Pp">Required configuration parameters like PIN and APN have to be set
    with <a class="Xr">umbctl(8)</a>. Once the SIM card has been unlocked with
    the correct PIN, it will remain in this state until the MBIM device is
    power-cycled. In case the device is connected to an &quot;always-on&quot;
    USB port, it may be possible to connect to a provider without entering the
    PIN again even if the system was rebooted.</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">umb</code> driver should support any USB
    device implementing MBIM, including the following cellular modems:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
  <li>Ericsson H5321gw and N5321gw</li>
  <li>Fibocom L831-EAU</li>
  <li>Medion Mobile S4222 (MediaTek OEM)</li>
  <li>Sierra Wireless EM7345</li>
  <li>Sierra Wireless EM7455</li>
  <li>Sierra Wireless EM8805</li>
  <li>Sierra Wireless MC8305</li>
</ul>
</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">intro(4)</a>, <a class="Xr">netintro(4)</a>,
    <a class="Xr">usb(4)</a>, <a class="Xr">ifconfig(8)</a>,
    <a class="Xr">umbctl(8)</a></p>
<p class="Pp"><cite class="Rs"><span class="RsT">Universal Serial Bus
    Communications Class Subclass Specification for Mobile Broadband Interface
    Model</span>,
    <a class="RsU" href="http://www.usb.org/developers/docs/devclass_docs/MBIM10Errata1_073013.zip">http://www.usb.org/developers/docs/devclass_docs/MBIM10Errata1_073013.zip</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">umb</code> device driver first appeared in
    <span class="Ux">OpenBSD 6.0</span>, <span class="Ux">NetBSD 9.0</span>, and
    <span class="Ux">FreeBSD 15.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">umb</code> driver was written by
    <span class="An">Gerhard Roth</span>
    &lt;<a class="Mt" href="mailto:gerhard@openbsd.org">gerhard@openbsd.org</a>&gt;
    and ported from <span class="Ux">OpenBSD</span> by <span class="An">Pierre
    Pronchery</span>
    &lt;<a class="Mt" href="mailto:khorben@defora.org">khorben@defora.org</a>&gt;.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1>
<p class="Pp">The <code class="Nm">umb</code> driver does not support IPv6.</p>
<p class="Pp">Devices which fail to provide a conforming MBIM implementation
    will probably be attached as some other driver, such as
    <a class="Xr">u3g(4)</a>.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">September 3, 2025</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>