From nobody Sat Dec 28 18:57:01 2024 X-Original-To: dev-commits-src-all@mlmmj.nyi.freebsd.org Received: from mx1.freebsd.org (mx1.freebsd.org [IPv6:2610:1c1:1:606c::19:1]) by mlmmj.nyi.freebsd.org (Postfix) with ESMTP id 4YLBRy0Fhnz5j3G0; Sat, 28 Dec 2024 18:57:02 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from mxrelay.nyi.freebsd.org (mxrelay.nyi.freebsd.org [IPv6:2610:1c1:1:606c::19:3]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256 client-signature RSA-PSS (4096 bits) client-digest SHA256) (Client CN "mxrelay.nyi.freebsd.org", Issuer "R11" (verified OK)) by mx1.freebsd.org (Postfix) with ESMTPS id 4YLBRx3zF5z53PR; Sat, 28 Dec 2024 18:57:01 +0000 (UTC) (envelope-from git@FreeBSD.org) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1735412221; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Pct0rA+Pbl/xROb6bZmnnR94hXytDm1xf0YTG+qz2mU=; b=b4sv/2vIT7rij+0mYHZmxc9lto2/MU91IK5/h1S+TEcgkaQ6dRr0Z5YABhvQ85U8HDuZGy nW7gTQgMWjbWyKwpwCxJrkU5p06lbrm8ksEgW1TASrMUv0VQFs4/emDsnsJGpufQNntdWQ t4QKXQlX7eO3dLrloHDYMQLCVGGBN9Ob71/QciQhJODuRSGn0QRV1CNIVYuOlOnms8Uzhn BBzpN/rwAC4lx427g2yXemm6Nk7TgtM2y3PkjqxStRzVPyhAReeVle+Ozy7UUTFOYKOIDz lx4AGisGL3QDi8dtPAhpvZqGO3AiNwNRvEElezPxHBnCqlnHKAHV/ey9/MpTFg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=freebsd.org; s=dkim; t=1735412221; h=from:from:reply-to:subject:subject:date:date:message-id:message-id: to:to:cc:mime-version:mime-version:content-type:content-type: content-transfer-encoding:content-transfer-encoding; bh=Pct0rA+Pbl/xROb6bZmnnR94hXytDm1xf0YTG+qz2mU=; b=NZ66FKkP+lEAroiaenaKmEehNckMdozLE8Ju4dRO+W0ckxebiqlBamqag0ibGCRAfc/rXM Om9ivRQ8XeSRWFTwjGry0Va6kMJmNptN0Mxb1tJ99gWtG/34igyk42EQPF0MO92ve2tocO J5Ffeb/XCCdn0tsZZ4Lvh57gdaCLNa37SAWwRU2iclz1IL2FzpkBHIm92Mp/MBHBjVs0v4 SUVMler16MAlr4SLEQVebjOa5eCqf2oQ/m0ZT8+vCkodETsRzcZYe9tJQGAxfXR8fULH4o Kbzelv8EOz93bDLZcU+ECiGwh14ibNNXd8sdSU4HU/ZBG0TQXXgmfn2lKJb2kw== ARC-Authentication-Results: i=1; mx1.freebsd.org; none ARC-Seal: i=1; s=dkim; d=freebsd.org; t=1735412221; a=rsa-sha256; cv=none; b=tW45eJcnlOt4IGFuFQze+iDg5M3xJAZX2rAEbECt4+6yWWX5P6zIvEQSHQneYUK1m0jXGM WkRHEe3qST3TOESZoWehE+OE1j9yN2svkbv9nSJHvFyNk79YY23JZy4Dl9OsJyVUkErBa6 pCOPMWKmvSx2GdYE6Aj2SO80lezrR+OtXU/li+A+rbphwA1Tt2EVLRYiqpSWHuikMaXHud DoP+NBt7DbAorwi6iphIX2vYCcmYmSdoOh+2MvakFCngg3RXMbCWM1eQcge9qS2EHQErrZ wWudFEaX5lzM+szJmcELmuVJGnwv4VuIOF7qTqNlowK1Zadhgfwl5cjXDg3V+Q== Received: from gitrepo.freebsd.org (gitrepo.freebsd.org [IPv6:2610:1c1:1:6068::e6a:5]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (4096 bits) server-digest SHA256) (Client did not present a certificate) by mxrelay.nyi.freebsd.org (Postfix) with ESMTPS id 4YLBRx2jtHzc13; Sat, 28 Dec 2024 18:57:01 +0000 (UTC) (envelope-from git@FreeBSD.org) Received: from gitrepo.freebsd.org ([127.0.1.44]) by gitrepo.freebsd.org (8.18.1/8.18.1) with ESMTP id 4BSIv1Ts039315; Sat, 28 Dec 2024 18:57:01 GMT (envelope-from git@gitrepo.freebsd.org) Received: (from git@localhost) by gitrepo.freebsd.org (8.18.1/8.18.1/Submit) id 4BSIv1KX039312; Sat, 28 Dec 2024 18:57:01 GMT (envelope-from git) Date: Sat, 28 Dec 2024 18:57:01 GMT Message-Id: <202412281857.4BSIv1KX039312@gitrepo.freebsd.org> To: src-committers@FreeBSD.org, dev-commits-src-all@FreeBSD.org, dev-commits-src-branches@FreeBSD.org From: Warner Losh Subject: git: a3ce16174787 - stable/14 - u3g.4: Fall cleaning List-Id: Commit messages for all branches of the src repository List-Archive: https://lists.freebsd.org/archives/dev-commits-src-all List-Help: List-Post: List-Subscribe: List-Unsubscribe: X-BeenThere: dev-commits-src-all@freebsd.org Sender: owner-dev-commits-src-all@FreeBSD.org MIME-Version: 1.0 Content-Type: text/plain; charset=utf-8 Content-Transfer-Encoding: 8bit X-Git-Committer: imp X-Git-Repository: src X-Git-Refname: refs/heads/stable/14 X-Git-Reftype: branch X-Git-Commit: a3ce16174787c0aad6d410c515487820b1ae8909 Auto-Submitted: auto-generated The branch stable/14 has been updated by imp: URL: https://cgit.FreeBSD.org/src/commit/?id=a3ce16174787c0aad6d410c515487820b1ae8909 commit a3ce16174787c0aad6d410c515487820b1ae8909 Author: Alexander Ziaee AuthorDate: 2024-11-07 18:01:50 +0000 Commit: Warner Losh CommitDate: 2024-12-28 18:19:06 +0000 u3g.4: Fall cleaning 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. + Document description: s/datacards/cellular modems/ for apropos search + HARDWARE: s/adapters/cellular modems/ 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 + xref supported connections MFC after: 3 days Reported by: allanjude (u3g can also provide GPS port) Reported by: Jared Trout (cellular in title) Reported by: emaste (specify mpd, editorial style instruction) Reported by: Metify (modem drivers exist) Reviewed by: imp, emaste, allanjude Pull Request: https://github.com/freebsd/freebsd-src/pull/1519 (cherry picked from commit 53484f516ac4ce3bf57a8c52c094ae67d79312d5) --- share/man/man4/u3g.4 | 66 +++++++++++++++++++++++++++++----------------------- 1 file changed, 37 insertions(+), 29 deletions(-) diff --git a/share/man/man4/u3g.4 b/share/man/man4/u3g.4 index 234b5a4b3277..51c883b8378e 100644 --- a/share/man/man4/u3g.4 +++ b/share/man/man4/u3g.4 @@ -1,3 +1,5 @@ +.\"- +.\" SPDX-License-Identifier: ISC .\" .\" Copyright (c) 2008 AnyWi Technologies .\" All rights reserved. @@ -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 December 5, 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 @@ -39,26 +41,46 @@ 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 +.Pa net/mpd5 +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. .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 @@ -70,9 +92,10 @@ 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, ('') .It @@ -83,26 +106,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*.* @@ -153,7 +159,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.