xref: /freebsd/share/man/man4/u3g.4 (revision bc96366c864c07ef352edb92017357917c75b36c)
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 November 26, 2013
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
73Huawei B190, E180v, E220 ('<Huawei Mobile>')
74.It
75Novatel U740, MC950D, X950D, etc.
76.It
77Sierra MC875U, MC8775U, etc.
78.El
79.Pp
80(See
81.Pa /sys/dev/usb/serial/u3g.c
82for the complete list of supported cards for each vendor
83mentioned above.)
84.Pp
85The supported 3G cards provide the necessary modem port for ppp, or mpd
86connections as well as extra ports (depending on the specific device) to
87provide other functions (additional command port, diagnostic port, SIM toolkit
88port).
89.Pp
90In some of these devices a mass storage device supported by the
91.Xr umass 4
92driver is present which contains Windows and Mac OS X drivers.
93The device starts up in disk mode (TruInstall, ZeroCD, etc.) and requires
94additional commands to switch it to modem mode. If your device is not
95switching automatically, please try to add quirks. See
96.Xr usbconfig 8
97and
98.Xr usb_quirk 4 .
99.Sh SEE ALSO
100.Xr tty 4 ,
101.Xr ucom 4 ,
102.Xr usb 4 ,
103.Xr usb_quirk 4 ,
104.Xr devd 8 ,
105.Xr usbconfig 8
106.Sh HISTORY
107The
108.Nm
109driver appeared in
110.Fx 7.2 ,
111is based on the
112.Xr uark 4
113driver, and written by
114.An Andrea Guzzo Aq Mt aguzzo@anywi.com
115in September 2008.
116.Sh AUTHORS
117.An -nosplit
118The
119.Nm
120driver was written by
121.An Andrea Guzzo Aq Mt aguzzo@anywi.com
122and
123.An Nick Hibma Aq Mt n_hibma@FreeBSD.org .
124Hardware for testing was provided by AnyWi Technologies, Leiden, NL.
125.Sh BUGS
126The automatic mode switch from disk mode to modem mode does not work unless
127the driver is either built into the kernel or loaded before the device is
128connected.
129