1.\" 2.\" Copyright (c) 2008 AnyWi Technologies 3.\" All rights reserved. 4.\" 5.\" This code is derived from uark.c 6.\" 7.\" Permission to use, copy, modify, and distribute this software for any 8.\" purpose with or without fee is hereby granted, provided that the above 9.\" copyright notice and this permission notice appear in all copies. 10.\" 11.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES 12.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF 13.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR 14.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES 15.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN 16.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF 17.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. 18.\" 19.Dd February 4, 2023 20.Dt U3G 4 21.Os 22.Sh NAME 23.Nm u3g 24.Nd USB support for 3G and 4G datacards 25.Sh SYNOPSIS 26To compile this driver into the kernel, 27place the following lines in your 28kernel configuration file: 29.Bd -ragged -offset indent 30.Cd "device usb" 31.Cd "device ucom" 32.Cd "device u3g" 33.Ed 34.Pp 35Alternatively, to load the driver as a 36module at boot time, place the following line in 37.Xr loader.conf 5 : 38.Bd -literal -offset indent 39u3g_load="YES" 40.Ed 41.Pp 42If neither of the above is done, the driver will automatically be loaded 43by devd(8) when the device is connected. 44.Sh DESCRIPTION 45The 46.Nm 47driver provides support for the multiple USB-to-serial interfaces exposed by 48many 3G USB/PCCard modems. 49.Pp 50The device is accessed through the 51.Xr ucom 4 52driver which makes it behave like a 53.Xr tty 4 . 54.Sh HARDWARE 55The 56.Nm 57driver supports the following adapters: 58.Pp 59.Bl -bullet -compact 60.It 61Option GT 3G Fusion, GT Fusion Quad, etc. (only 3G part, not WLAN) 62.It 63Option GT 3G, GT 3G Quad, etc. 64.It 65Vodafone Mobile Connect Card 3G 66.It 67Vodafone Mobile Broadband K3772-Z 68.It 69Qualcomm Inc. CDMA MSM 70.It 71Qualcomm Inc. GOBI 1000, 2000 and 3000 devices with MDM1000 or MDM2000 chipsets 72.It 73QUECTEL BGX, ECX, EGX, EMX, EPX, RGX series. 74.It 75Quectel EM160R (see CAVEATS) 76.It 77Huawei B190, E180v, E220, E3372, E3372v153, E5573Cs322, ('<Huawei Mobile>') 78.It 79Novatel U740, MC950D, X950D, etc. 80.It 81Sierra MC875U, MC8775U, etc. 82.It 83Panasonic CF-F9 GOBI 84.El 85.Pp 86(See 87.Pa /sys/dev/usb/serial/u3g.c 88for the complete list of supported cards for each vendor 89mentioned above.) 90.Pp 91The supported 3G cards provide the necessary modem port for ppp, or mpd 92connections as well as extra ports (depending on the specific device) to 93provide other functions (additional command port, diagnostic port, SIM toolkit 94port). 95.Pp 96In some of these devices a mass storage device supported by the 97.Xr umass 4 98driver is present which contains Windows and Mac OS X drivers. 99The device starts up in disk mode (TruInstall, ZeroCD, etc.) and requires 100additional commands to switch it to modem mode. 101If your device is not switching automatically, please try to add quirks. 102See 103.Xr usbconfig 8 104and 105.Xr usb_quirk 4 . 106.Sh FILES 107.Bl -tag -width "/dev/ttyU*.*.init" -compact 108.It Pa /dev/ttyU*.* 109for callin ports 110.It Pa /dev/ttyU*.*.init 111.It Pa /dev/ttyU*.*.lock 112corresponding callin initial-state and lock-state devices 113.Pp 114.It Pa /dev/cuaU*.* 115for callout ports 116.It Pa /dev/cuaU*.*.init 117.It Pa /dev/cuaU*.*.lock 118corresponding callout initial-state and lock-state devices 119.El 120.Sh EXAMPLES 121Connect to the Internet using the default configuration: 122.Bd -literal -offset indent 123ppp -background u3g 124.Ed 125.Sh SEE ALSO 126.Xr tty 4 , 127.Xr ucom 4 , 128.Xr usb 4 , 129.Xr usb_quirk 4 , 130.Xr devd 8 , 131.Xr ppp 8 , 132.Xr usbconfig 8 133.Sh HISTORY 134The 135.Nm 136driver appeared in 137.Fx 7.2 , 138is based on the 139.Xr uark 4 140driver, and written by 141.An Andrea Guzzo Aq Mt aguzzo@anywi.com 142in September 2008. 143.Sh AUTHORS 144.An -nosplit 145The 146.Nm 147driver was written by 148.An Andrea Guzzo Aq Mt aguzzo@anywi.com 149and 150.An Nick Hibma Aq Mt n_hibma@FreeBSD.org . 151Hardware for testing was provided by AnyWi Technologies, Leiden, NL. 152.Sh CAVEATS 153The Quectel EM160R is not officially supported in PPP mode. 154In order to use it in PPP mode, the ctsrts option needs to be turned off, 155for example, by adding: 156.Dl set ctsrts off 157to 158.Pa /etc/ppp/ppp.conf 159in the correct section. 160.Sh BUGS 161The automatic mode switch from disk mode to modem mode does not work unless 162the driver is either built into the kernel or loaded before the device is 163connected. 164.Pp 165The GOBI-based devices require the gobi loader available from the 166.Pa sysutils/gobi_loader 167port. 168