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