summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/u3g.4 3.html
blob: 04fc26ea0a2d691ed10489f294c209c0b85f0082 (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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
<table class="head">
  <tr>
    <td class="head-ltitle">U3G(4)</td>
    <td class="head-vol">Device Drivers Manual</td>
    <td class="head-rtitle">U3G(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">u3g</code> &#x2014; <span class="Nd">USB support
    for 3G and 4G cellular modems</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 usb</code>
<br/>
<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>u3g_load=&quot;YES&quot;</pre>
</div>
<p class="Pp">If neither of the above is done, the driver will be automatically
    loaded by devd(8) when the device is connected.</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">u3g</code> driver provides support for
    USB-to-serial interfaces exposed by many 3G and 4G modems. The supported
    adapters provide the necessary modem port for <a class="Xr">ppp(8)</a>, or
    <span class="Pa">net/mpd5</span> connections. Depending on the specific
    device, extra ports provide other functions such as an additional command
    port, diagnostic port, GPS receiver port, or SIM toolkit port.</p>
<p class="Pp">The device is accessed through the <a class="Xr">ucom(4)</a>
    driver which makes it behave like a <a class="Xr">tty(4)</a>.</p>
<p class="Pp">In some adapters a mass storage device supported by the
    <a class="Xr">umass(4)</a> driver is present which contains Windows and Mac
    OS X drivers. The device starts up in disk mode (TruInstall, ZeroCD, etc.)
    and requires additional commands to switch it to modem mode. If your device
    is not switching automatically, please try to add quirks. See
    <a class="Xr">usbconfig(8)</a> and <a class="Xr">usb_quirk(4)</a>.</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">u3g</code> driver supports the following
    cellular modems:</p>
<p class="Pp"></p>
<ul class="Bl-bullet Bl-compact">
  <li>Option GT 3G Fusion, GT Fusion Quad, etc. (3G only, not WLAN)</li>
  <li>Option GT 3G, GT 3G Quad, etc.</li>
  <li>Vodafone Mobile Connect Card 3G</li>
  <li>Vodafone Mobile Broadband K3772-Z</li>
  <li>Qualcomm Inc. CDMA MSM</li>
  <li>Qualcomm Inc. GOBI 1000, 2000 and 3000 devices with MDM1000 or MDM2000
      chipsets</li>
  <li>QUECTEL BGX, ECX, EGX, EMX, EPX, RGX series</li>
  <li>Quectel EM160R, EM060K (see
    <a class="Sx" href="#CAVEATS">CAVEATS</a>)</li>
  <li>Huawei B190, E180v, E220, E3372, E3372v153, E5573Cs322, ('&lt;Huawei
      Mobile&gt;')</li>
  <li>Novatel U740, MC950D, X950D, etc.</li>
  <li>Sierra MC875U, MC8775U, EM7590, etc.</li>
  <li>Panasonic CF-F9 GOBI</li>
</ul>
<p class="Pp">Many more are supported, see
    <span class="Pa">/sys/dev/usb/serial/u3g.c</span> for the complete list.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1>
<dl class="Bl-tag Bl-compact">
  <dt><span class="Pa">/dev/ttyU*.*</span></dt>
  <dd>for callin ports</dd>
  <dt><span class="Pa">/dev/ttyU*.*.init</span></dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt><span class="Pa">/dev/ttyU*.*.lock</span></dt>
  <dd>corresponding callin initial-state and lock-state devices
    <p class="Pp"></p>
  </dd>
  <dt><span class="Pa">/dev/cuaU*.*</span></dt>
  <dd>for callout ports</dd>
  <dt><span class="Pa">/dev/cuaU*.*.init</span></dt>
  <dd style="width: auto;">&#x00A0;</dd>
  <dt><span class="Pa">/dev/cuaU*.*.lock</span></dt>
  <dd>corresponding callout initial-state and lock-state devices</dd>
</dl>
</section>
<section class="Sh">
<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
<p class="Pp">Connect to the Internet using the default configuration:</p>
<div class="Bd Pp Bd-indent Li">
<pre>ppp -background u3g</pre>
</div>
</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">tty(4)</a>, <a class="Xr">ucom(4)</a>,
    <a class="Xr">usb(4)</a>, <a class="Xr">usb_quirk(4)</a>,
    <a class="Xr">devd(8)</a>, <a class="Xr">ppp(8)</a>,
    <a class="Xr">usbconfig(8)</a></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">u3g</code> driver appeared in
    <span class="Ux">FreeBSD 7.2</span>, is based on the
    <a class="Xr">uark(4)</a> driver, and written by <span class="An">Andrea
    Guzzo</span>
    &lt;<a class="Mt" href="mailto:aguzzo@anywi.com">aguzzo@anywi.com</a>&gt; in
    September 2008.</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">u3g</code> driver was written by
    <span class="An">Andrea Guzzo</span>
    &lt;<a class="Mt" href="mailto:aguzzo@anywi.com">aguzzo@anywi.com</a>&gt;
    and <span class="An">Nick Hibma</span>
    &lt;<a class="Mt" href="mailto:n_hibma@FreeBSD.org">n_hibma@FreeBSD.org</a>&gt;.
    Hardware for testing was provided by AnyWi Technologies, Leiden, NL.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1>
<p class="Pp">The Quectel EM160R is not officially supported in PPP mode. In
    order to use it in PPP mode, the ctsrts option needs to be turned off, for
    example, by adding:</p>
<p class="Pp"></p>
<div class="Bd Bd-indent"><code class="Li">set ctsrts off</code></div>
<p class="Pp">to <span class="Pa">/etc/ppp/ppp.conf</span> in the correct
    section.</p>
</section>
<section class="Sh">
<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
<p class="Pp">The automatic mode switch from disk mode to modem mode does not
    work unless the driver is either built into the kernel or loaded before the
    device is connected.</p>
<p class="Pp">The GOBI-based devices require the gobi loader available from the
    <span class="Pa">sysutils/gobi_loader</span> port.</p>
</section>
</div>
<table class="foot">
  <tr>
    <td class="foot-date">December 5, 2024</td>
    <td class="foot-os">FreeBSD 15.0</td>
  </tr>
</table>