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 June 15, 2021 22.Dt U3G 4 23.Os 24.Sh NAME 25.Nm u3g 26.Nd USB support for 3G 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 75Huawei B190, E180v, E220 ('<Huawei Mobile>') 76.It 77Novatel U740, MC950D, X950D, etc. 78.It 79Sierra MC875U, MC8775U, etc. 80.It 81Panasonic CF-F9 GOBI 82.El 83.Pp 84(See 85.Pa /sys/dev/usb/serial/u3g.c 86for the complete list of supported cards for each vendor 87mentioned above.) 88.Pp 89The supported 3G cards provide the necessary modem port for ppp, or mpd 90connections as well as extra ports (depending on the specific device) to 91provide other functions (additional command port, diagnostic port, SIM toolkit 92port). 93.Pp 94In some of these devices a mass storage device supported by the 95.Xr umass 4 96driver is present which contains Windows and Mac OS X drivers. 97The device starts up in disk mode (TruInstall, ZeroCD, etc.) and requires 98additional commands to switch it to modem mode. 99If your device is not switching automatically, please try to add quirks. 100See 101.Xr usbconfig 8 102and 103.Xr usb_quirk 4 . 104.Sh FILES 105.Bl -tag -width "/dev/ttyU*.*.init" -compact 106.It Pa /dev/ttyU*.* 107for callin ports 108.It Pa /dev/ttyU*.*.init 109.It Pa /dev/ttyU*.*.lock 110corresponding callin initial-state and lock-state devices 111.Pp 112.It Pa /dev/cuaU*.* 113for callout ports 114.It Pa /dev/cuaU*.*.init 115.It Pa /dev/cuaU*.*.lock 116corresponding callout initial-state and lock-state devices 117.El 118.Sh EXAMPLES 119Connect to the Internet using the default configuration: 120.Bd -literal -offset indent 121ppp -background u3g 122.Ed 123.Sh SEE ALSO 124.Xr tty 4 , 125.Xr ucom 4 , 126.Xr usb 4 , 127.Xr usb_quirk 4 , 128.Xr devd 8 , 129.Xr ppp 8 , 130.Xr usbconfig 8 131.Sh HISTORY 132The 133.Nm 134driver appeared in 135.Fx 7.2 , 136is based on the 137.Xr uark 4 138driver, and written by 139.An Andrea Guzzo Aq Mt aguzzo@anywi.com 140in September 2008. 141.Sh AUTHORS 142.An -nosplit 143The 144.Nm 145driver was written by 146.An Andrea Guzzo Aq Mt aguzzo@anywi.com 147and 148.An Nick Hibma Aq Mt n_hibma@FreeBSD.org . 149Hardware for testing was provided by AnyWi Technologies, Leiden, NL. 150.Sh BUGS 151The automatic mode switch from disk mode to modem mode does not work unless 152the driver is either built into the kernel or loaded before the device is 153connected. 154.Pp 155The GOBI-based devices require the gobi loader available from the 156.Pa sysutils/gobi_loader 157port. 158