Skip to content

Commit

Permalink
u3g.4: Fall cleaning
Browse files Browse the repository at this point in the history
Many people come on our social spaces asking about router projects,
can't find info about supported cellular modems, and say they're
sticking to $other_OS. Thanks to the fantastic talk by Ian from
Metify, I now know that is not true, we have them and they work great.

Therefore, tell everyone else by massaging this page for
discoverability in the manual and the release hardware notes.

+ add `cellular modem` to document description for apropos search
+ s/adapters/cellular modems/ in hardware for release hardware notes
+ move things which shouldn't be in Rel HW notes to description
+ massage things around for readability and flow + tag spdx

MFC after:	3 days
Reported by:	Jared Trout <[email protected]> (cellular in title)
  • Loading branch information
concussious committed Nov 8, 2024
1 parent 15853a5 commit f8be01c
Showing 1 changed file with 35 additions and 29 deletions.
64 changes: 35 additions & 29 deletions share/man/man4/u3g.4
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
.\"-
.\" SPDX-License-Identifier: ISC
.\"
.\" Copyright (c) 2008 AnyWi Technologies
.\" All rights reserved.
Expand All @@ -21,7 +23,7 @@
.Os
.Sh NAME
.Nm u3g
.Nd USB support for 3G and 4G datacards
.Nd USB support for 3G and 4G cellular modem datacards
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your
Expand All @@ -39,26 +41,44 @@ module at boot time, place the following line in
u3g_load="YES"
.Ed
.Pp
If neither of the above is done, the driver will automatically be loaded
by devd(8) when the device is connected.
If neither of the above is done, the driver will be
automatically loaded by devd(8) when the device is connected.
.Sh DESCRIPTION
The
.Nm
driver provides support for the multiple USB-to-serial interfaces exposed by
many 3G USB/PCCard modems.
driver provides support for USB-to-serial interfaces
exposed by many 3G and 4G modems.
The supported adapters provide the necessary modem port for
.Xr ppp 8 ,
or mpd connections,
as well as extra ports depending on the specific device,
to provide other functions
.Pq additional command port, diagnostic port, SIM toolkit port .
.Pp
The device is accessed through the
.Xr ucom 4
driver which makes it behave like a
.Xr tty 4 .
.Pp
In some adapters a mass storage device supported by the
.Xr umass 4
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
.Xr usbconfig 8
and
.Xr usb_quirk 4 .
.Sh HARDWARE
The
.Nm
driver supports the following adapters:
driver supports the following cellular modems:
.Pp
.Bl -bullet -compact
.It
Option GT 3G Fusion, GT Fusion Quad, etc. (only 3G part, not WLAN)
Option GT 3G Fusion, GT Fusion Quad, etc.
.Pq 3G only, not WLAN
.It
Option GT 3G, GT 3G Quad, etc.
.It
Expand All @@ -70,11 +90,12 @@ Qualcomm Inc. CDMA MSM
.It
Qualcomm Inc. GOBI 1000, 2000 and 3000 devices with MDM1000 or MDM2000 chipsets
.It
QUECTEL BGX, ECX, EGX, EMX, EPX, RGX series.
QUECTEL BGX, ECX, EGX, EMX, EPX, RGX series
.It
Quectel EM160R (see CAVEATS)
Quectel EM160R
.Pq see Sx CAVEATS
.It
Huawei B190, E180v, E220, E3372, E3372v153, E5573Cs322, ('<Huawei Mobile>')
Huawei B190, E180v, E220, E3372, E3372v153, E5573Cs322, etc.
.It
Novatel U740, MC950D, X950D, etc.
.It
Expand All @@ -83,26 +104,9 @@ Sierra MC875U, MC8775U, etc.
Panasonic CF-F9 GOBI
.El
.Pp
(See
Many more are supported, see
.Pa /sys/dev/usb/serial/u3g.c
for the complete list of supported cards for each vendor
mentioned above.)
.Pp
The supported 3G cards provide the necessary modem port for ppp, or mpd
connections as well as extra ports (depending on the specific device) to
provide other functions (additional command port, diagnostic port, SIM toolkit
port).
.Pp
In some of these devices a mass storage device supported by the
.Xr umass 4
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
.Xr usbconfig 8
and
.Xr usb_quirk 4 .
for the complete list.
.Sh FILES
.Bl -tag -width "/dev/ttyU*.*.init" -compact
.It Pa /dev/ttyU*.*
Expand Down Expand Up @@ -153,7 +157,9 @@ Hardware for testing was provided by AnyWi Technologies, Leiden, NL.
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:
.Pp
.Dl set ctsrts off
.Pp
to
.Pa /etc/ppp/ppp.conf
in the correct section.

Check warning on line 165 in share/man/man4/u3g.4

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line

Check warning on line 165 in share/man/man4/u3g.4

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line
Expand Down

0 comments on commit f8be01c

Please sign in to comment.