xref: /freebsd/share/man/man4/u3g.4 (revision 4c1a82cea504df7a79f5bd8f7d0a41cacccff16e)
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 September 11, 2018
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.
95If your device is not switching automatically, please try to add quirks.
96See
97.Xr usbconfig 8
98and
99.Xr usb_quirk 4 .
100.Sh FILES
101.Bl -tag -width "/dev/ttyU*.*.init" -compact
102.It Pa /dev/ttyU*.*
103for callin ports
104.It Pa /dev/ttyU*.*.init
105.It Pa /dev/ttyU*.*.lock
106corresponding callin initial-state and lock-state devices
107.Pp
108.It Pa /dev/cuaU*.*
109for callout ports
110.It Pa /dev/cuaU*.*.init
111.It Pa /dev/cuaU*.*.lock
112corresponding callout initial-state and lock-state devices
113.El
114.Sh EXAMPLES
115Connect to the Internet using the default configuration:
116.Bd -literal -offset indent
117ppp -background u3g
118.Ed
119.Sh SEE ALSO
120.Xr tty 4 ,
121.Xr ucom 4 ,
122.Xr usb 4 ,
123.Xr usb_quirk 4 ,
124.Xr devd 8 ,
125.Xr ppp 8 ,
126.Xr usbconfig 8
127.Sh HISTORY
128The
129.Nm
130driver appeared in
131.Fx 7.2 ,
132is based on the
133.Xr uark 4
134driver, and written by
135.An Andrea Guzzo Aq Mt aguzzo@anywi.com
136in September 2008.
137.Sh AUTHORS
138.An -nosplit
139The
140.Nm
141driver was written by
142.An Andrea Guzzo Aq Mt aguzzo@anywi.com
143and
144.An Nick Hibma Aq Mt n_hibma@FreeBSD.org .
145Hardware for testing was provided by AnyWi Technologies, Leiden, NL.
146.Sh BUGS
147The automatic mode switch from disk mode to modem mode does not work unless
148the driver is either built into the kernel or loaded before the device is
149connected.
150