cc64c7336eed24c2357aa148f0e8ca4ea7e147d5
[dragonfly.git] / share / man / man4 / ugensa.4
1 .\" $DragonFly: src/share/man/man4/ugensa.4,v 1.3 2008/02/21 09:00:19 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 21, 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 "AnyDATA ADU-E100A/D/H" Ta Ta USB
78 .It Li "Dell Wireless 5500" Ta Ta PCI Express Mini Card
79 .It Li "Dell Wireless 5505" Ta Ta PCI Express Mini Card
80 .It Li "Dell Wireless 5510" Ta Ta PCI Express Mini Card
81 .It Li "Dell Wireless 5520" Ta Ta PCI Express Mini Card
82 .It Li "Dell Wireless 5700" Ta Ta PCI Express Mini Card
83 .It Li "Dell Wireless 5700" Ta Ta ExpressCard
84 .It Li "Huawei Mobile Connect" Ta Ta CardBus
85 .It Li "Huawei E220" Ta Ta USB
86 .It Li "Kyocera KPC650" Ta Ta CardBus
87 .It Li "Novatel Wireless Expedite EU740" Ta Ta PCI Express Mini Card
88 .It Li "Novatel Wireless Expedite EU870D" Ta Ta PCI Express Mini Card
89 .It Li "Novatel Wireless Expedite EV620" Ta Ta PCI Express Mini Card
90 .It Li "Novatel Wireless Merlin ES620" Ta Ta CardBus
91 .It Li "Novatel Wireless Merlin ES720" Ta Ta CardBus
92 .It Li "Novatel Wireless Merlin EX720" Ta Ta ExpressCard
93 .It Li "Novatel Wireless Merlin S620" Ta Ta CardBus
94 .It Li "Novatel Wireless Merlin S640" Ta Ta CardBus
95 .It Li "Novatel Wireless Merlin S720" Ta Ta CardBus
96 .It Li "Novatel Wireless Merlin U730" Ta Ta CardBus
97 .It Li "Novatel Wireless Merlin U740" Ta Ta CardBus
98 .It Li "Novatel Wireless Merlin V620" Ta Ta CardBus
99 .It Li "Novatel Wireless Merlin XS620" Ta ExpressCard
100 .It Li "Novatel Wireless Merlin XU870" Ta ExpressCard
101 .It Li "Novatel Wireless Ovation U720" Ta Ta USB
102 .It Li "Novatel Wireless Ovation MC727" Ta Ta USB
103 .It Li "Novatel Wireless Ovation MC950D" Ta Ta USB
104 .It Li "ONDA Communication H600" Ta Ta CardBus
105 .It Li "Sierra Wireless MC5720" Ta Ta PCI Express Mini Card
106 .It Li "Sierra Wireless MC5725" Ta Ta PCI Express Mini Card
107 .It Li "Sierra Wireless MC8755" Ta Ta PCI Express Mini Card
108 .It Li "Sierra Wireless MC8765" Ta Ta PCI Express Mini Card
109 .It Li "Sierra Wireless MC8775" Ta Ta PCI Express Mini Card
110 .It Li "Sierra Wireless MC8780" Ta Ta PCI Express Mini Card
111 .It Li "Sierra Wireless MC8781" Ta Ta PCI Express Mini Card
112 .It Li "Sierra Wireless AirCard 580" Ta Ta CardBus
113 .It Li "Sierra Wireless AirCard 595" Ta Ta CardBus
114 .It Li "Sierra Wireless AirCard 595U" Ta Ta USB
115 .It Li "Sierra Wireless AirCard 597E" Ta Ta ExpressCard
116 .It Li "Sierra Wireless AirCard 875" Ta Ta CardBus
117 .It Li "Sierra Wireless AirCard 880" Ta Ta CardBus
118 .It Li "Sierra Wireless AirCard 880E" Ta Ta ExpressCard
119 .It Li "Sierra Wireless AirCard 880U" Ta Ta USB
120 .It Li "Sierra Wireless AirCard 881" Ta Ta CardBus
121 .It Li "Sierra Wireless AirCard 881E" Ta Ta ExpressCard
122 .It Li "Sierra Wireless AirCard 881U" Ta Ta USB
123 .El
124 .Pp
125 Due to rebranding (which is very common in mobile braodband business) this
126 list is certainly incomplete.
127 .Sh SEE ALSO
128 .Xr ppp 8 ,
129 .Xr pppd 8 ,
130 .Xr tty 4 ,
131 .Xr ucom 4 ,
132 .Xr usb 4
133 .Sh HISTORY
134 The
135 .Nm
136 device driver first appeared in
137 .Ox 4.0
138 as
139 .Nm umsm .
140 It was imported into
141 .Dx 1.11
142 with its present name and extended to support multiple virtual serial ports
143 per device.
144 .Sh AUTHORS
145 .An -nosplit
146 The
147 .Nm
148 driver was written by
149 .An Jonathan Gray
150 .Aq jsg@openbsd.org .
151 .Sh CAVEATS
152 For Verizon Wireless (and possibly other services), cards require a one-time
153 activation before they will work.