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 February 8, 2012
  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 u3g"
  33 .Ed
  34 .Pp
  35 Alternatively, to load the driver as a
  36 module at boot time, place the following line in
  37 .Xr loader.conf 5 :
  38 .Bd -literal -offset indent
  39 u3g_load="YES"
  40 .Ed
  41 .Sh DESCRIPTION
  42 The
  43 .Nm
  44 driver provides support for the multiple USB-to-serial interfaces exposed by
  45 many 3G USB/PCCard modems.
  46 .Pp
  47 The device is accessed through the
  48 .Xr ucom 4
  49 driver which makes it behave like a
  50 .Xr tty 4 .
  51 .Sh HARDWARE
  52 The
  53 .Nm
  54 driver supports the following adapters:
  55 .Pp
  56 .Bl -bullet -compact
  57 .It
  58 Option GT 3G Fusion, GT Fusion Quad, etc. (only 3G part, not WLAN)
  59 .It
  60 Option GT 3G, GT 3G Quad, etc.
  61 .It
  62 Vodafone Mobile Connect Card 3G
  63 .It
  64 Qualcomm Inc. CDMA MSM
  65 .It
  66 Huawei B190, E180v, E220 ('<Huawei Mobile>')
  67 .It
  68 Novatel U740, MC950D, X950D, etc.
  69 .It
  70 Sierra MC875U, MC8775U, etc.
  71 .El
  72 .Pp
  73 (See
  74 .Pa /sys/dev/usb/serial/u3g.c
  75 for the complete list of supported cards for each vendor
  76 mentioned above.)
  77 .Pp
  78 The supported 3G cards provide the necessary modem port for ppp, or mpd
  79 connections as well as extra ports (depending on the specific device) to
  80 provide other functions (additional command port, diagnostic port, SIM toolkit
  81 port).
  82 .Pp
  83 In some of these devices a mass storage device supported by the
  84 .Xr umass 4
  85 driver is present which contains Windows and Mac OS X drivers.
  86 The device starts up in disk mode (TruInstall, ZeroCD, etc.) and requires
  87 additional commands to switch it to modem mode. If your device is not
  88 switching automatically, please try to add quirks. See
  89 .Xr usbconfig 8
  90 and
  91 .Xr usb_quirk 4 .
  92 .Pp
  93 .Sh SEE ALSO
  94 .Xr tty 4 ,
  95 .Xr ucom 4 ,
  96 .Xr usb 4 ,
  97 .Xr usb_quirk 4 ,
  98 .Xr usbconfig 8
  99 .Sh HISTORY
 100 The
 101 .Nm
 102 driver appeared in
 103 .Fx 7.2 ,
 104 is based on the
 105 .Xr uark 4
 106 driver, and written by
 107 .An Andrea Guzzo Aq aguzzo@anywi.com
 108 in September 2008.
 109 .Sh AUTHORS
 110 The
 111 .Nm
 112 driver was written by
 113 .An Andrea Guzzo Aq aguzzo@anywi.com
 114 and
 115 .An Nick Hibma Aq n_hibma@FreeBSD.org .
 116 Hardware for testing was provided by AnyWi Technologies, Leiden, NL.