share/man/man4/ugensa.4

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