Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

u3g.4: increase visibility in apropos and release HW notes #1519

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
67 changes: 37 additions & 30 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 @@ -16,12 +18,12 @@
.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.Dd February 4, 2023
.Dd November 12, 2024
.Dt U3G 4
.Os
.Sh NAME
.Nm u3g
.Nd USB support for 3G and 4G datacards
.Nd USB support for 3G and 4G cellular modems
.Sh SYNOPSIS
To compile this driver into the kernel,
place the following lines in your
Expand All @@ -39,26 +41,45 @@
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 ,
concussious marked this conversation as resolved.
Show resolved Hide resolved
or
.Pa net/mpd5
connections.
Depending on the specific device, extra ports 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 +91,12 @@
.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.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this change lose information? Is Huawei Mobile just a generic company, or some specific branding these are sold under?

Copy link
Contributor Author

@concussious concussious Nov 12, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

When I googled I only found Huawei for each of the model numbers here. They are all sold under the Huawei brand. I think someone will /huawei on the manual or release notes.

.It
Novatel U740, MC950D, X950D, etc.
.It
Expand All @@ -83,26 +105,9 @@
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,10 +158,12 @@
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 166 in share/man/man4/u3g.4

View workflow job for this annotation

GitHub Actions / Style Checker

Missing Signed-off-by: line
.Sh BUGS
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
Expand Down