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