share/man/man4/u3g.4

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