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