share/man/man4/ugensa.4

   1 .\" $OpenBSD: umsm.4,v 1.20 2007/05/31 19:19:52 jmc Exp $
   2 .\"
   3 .\" Copyright (c) 2006 Jonathan Gray <jsg@openbsd.org>
   4 .\"
   5 .\" Permission to use, copy, modify, and distribute this software for any
   6 .\" purpose with or without fee is hereby granted, provided that the above
   7 .\" copyright notice and this permission notice appear in all copies.
   8 .\"
   9 .\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
  10 .\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
  11 .\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
  12 .\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
  13 .\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
  14 .\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
  15 .\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
  16 .\"
  17 .Dd February 21, 2008
  18 .Dt UGENSA 4
  19 .Os
  20 .Sh NAME
  21 .Nm ugensa
  22 .Nd Generic USB serial device
  23 .Sh SYNOPSIS
  24 To compile this driver into the kernel, place the following lines in your
  25 kernel configuration file:
  26 .Bd -ragged -offset indent
  27 .Cd "device ugensa"
  28 .Cd "device ucom"
  29 .Ed
  30 .Pp
  31 Alternatively, to load the driver as a module at boot time, place the
  32 following line in
  33 .Xr loader.conf 5 :
  34 .Bd -literal -offset indent
  35 ugensa_load="YES"
  36 .Ed
  37 .Sh DESCRIPTION
  38 The
  39 .Nm
  40 is the minimal USB serial driver written to support virtual serial ports in
  41 devices where hardware specific settings (baudrate, flow control etc) don't
  42 make sense or just don't apply.
  43 .Pp
  44 The virtual serial ports are accessed through the
  45 .Xr ucom 4
  46 driver which makes them behave like a
  47 .Xr tty 4 .
  48 .Pp
  49 The
  50 .Nm
  51 driver was originally written to support Qualcomm MSM chipset found in EVDO
  52 and UMTS capable modems, but there is nothing MSM chipset specific in it.
  53 Many devices supported by the driver aren't typical USB devices, but CardBus,
  54 ExpressCard or PCI Express Mini Cards that incorporate a USB controller
  55 with the actual devices attached to it.
  56 .Pp
  57 Communication devices supported by the
  58 .Nm
  59 driver typically have more than one virtual serial port, but only one of
  60 them (usually the first one) can be used with
  61 .Xr ppp 8
  62 or
  63 .Xr pppd 8 .
  64 At least one of additional ports can usually be used for device/network
  65 monitoring and other communication tasks (like SMS for example).
  66 Protocols and methods used to access these features are out of scope of this
  67 driver.
  68 .Pp
  69 The following devices should work with the
  70 .Nm
  71 driver:
  72 .Pp
  73 .Bl -column "Device                " "Bus" -compact -offset 6n
  74 .It Em "Device          Bus"
  75 .It Li "AirPrime PC5220" Ta Ta CardBus
  76 .It Li "AnyDATA ADU-E100A/D/H" Ta Ta USB
  77 .It Li "Dell Wireless 5500" Ta Ta PCI Express Mini Card
  78 .It Li "Dell Wireless 5505" Ta Ta PCI Express Mini Card
  79 .It Li "Dell Wireless 5510" Ta Ta PCI Express Mini Card
  80 .It Li "Dell Wireless 5520" Ta Ta PCI Express Mini Card
  81 .It Li "Dell Wireless 5700" Ta Ta PCI Express Mini Card
  82 .It Li "Dell Wireless 5700" Ta Ta ExpressCard
  83 .It Li "Huawei Mobile Connect" Ta Ta CardBus
  84 .It Li "Huawei E220" Ta Ta USB
  85 .It Li "Kyocera KPC650" Ta Ta CardBus
  86 .It Li "Novatel Wireless Expedite EU740" Ta Ta PCI Express Mini Card
  87 .It Li "Novatel Wireless Expedite EU870D" Ta Ta PCI Express Mini Card
  88 .It Li "Novatel Wireless Expedite EV620" Ta Ta PCI Express Mini Card
  89 .It Li "Novatel Wireless Merlin ES620" Ta Ta CardBus
  90 .It Li "Novatel Wireless Merlin ES720" Ta Ta CardBus
  91 .It Li "Novatel Wireless Merlin EX720" Ta Ta ExpressCard
  92 .It Li "Novatel Wireless Merlin S620" Ta Ta CardBus
  93 .It Li "Novatel Wireless Merlin S640" Ta Ta CardBus
  94 .It Li "Novatel Wireless Merlin S720" Ta Ta CardBus
  95 .It Li "Novatel Wireless Merlin U730" Ta Ta CardBus
  96 .It Li "Novatel Wireless Merlin U740" Ta Ta CardBus
  97 .It Li "Novatel Wireless Merlin V620" Ta Ta CardBus
  98 .It Li "Novatel Wireless Merlin XS620" Ta ExpressCard
  99 .It Li "Novatel Wireless Merlin XU870" Ta ExpressCard
 100 .It Li "Novatel Wireless Ovation U720" Ta Ta USB
 101 .It Li "Novatel Wireless Ovation MC727" Ta Ta USB
 102 .It Li "Novatel Wireless Ovation MC950D" Ta Ta USB
 103 .It Li "ONDA Communication H600" Ta Ta CardBus
 104 .It Li "Sierra Wireless MC5720" Ta Ta PCI Express Mini Card
 105 .It Li "Sierra Wireless MC5725" Ta Ta PCI Express Mini Card
 106 .It Li "Sierra Wireless MC8755" Ta Ta PCI Express Mini Card
 107 .It Li "Sierra Wireless MC8765" Ta Ta PCI Express Mini Card
 108 .It Li "Sierra Wireless MC8775" Ta Ta PCI Express Mini Card
 109 .It Li "Sierra Wireless MC8780" Ta Ta PCI Express Mini Card
 110 .It Li "Sierra Wireless MC8781" Ta Ta PCI Express Mini Card
 111 .It Li "Sierra Wireless AirCard 580" Ta Ta CardBus
 112 .It Li "Sierra Wireless AirCard 595" Ta Ta CardBus
 113 .It Li "Sierra Wireless AirCard 595U" Ta Ta USB
 114 .It Li "Sierra Wireless AirCard 597E" Ta Ta ExpressCard
 115 .It Li "Sierra Wireless AirCard 875" Ta Ta CardBus
 116 .It Li "Sierra Wireless AirCard 880" Ta Ta CardBus
 117 .It Li "Sierra Wireless AirCard 880E" Ta Ta ExpressCard
 118 .It Li "Sierra Wireless AirCard 880U" Ta Ta USB
 119 .It Li "Sierra Wireless AirCard 881" Ta Ta CardBus
 120 .It Li "Sierra Wireless AirCard 881E" Ta Ta ExpressCard
 121 .It Li "Sierra Wireless AirCard 881U" Ta Ta USB
 122 .El
 123 .Pp
 124 Due to rebranding (which is very common in mobile broadband business) this
 125 list is certainly incomplete.
 126 .Sh SEE ALSO
 127 .Xr tty 4 ,
 128 .Xr ucom 4 ,
 129 .Xr usb 4 ,
 130 .Xr ppp 8 ,
 131 .Xr pppd 8
 132 .Sh HISTORY
 133 The
 134 .Nm
 135 device driver first appeared in
 136 .Ox 4.0
 137 as
 138 .Nm umsm .
 139 It was imported into
 140 .Dx 1.11
 141 with its present name and extended to support multiple virtual serial ports
 142 per device.
 143 .Sh AUTHORS
 144 .An -nosplit
 145 The
 146 .Nm
 147 driver was written by
 148 .An Jonathan Gray Aq Mt jsg@openbsd.org .
 149 .Sh CAVEATS
 150 For Verizon Wireless (and possibly other services), cards require a one-time
 151 activation before they will work.