Merge from vendor branch FILE:
[dragonfly.git] / share / man / man4 / umsm.4
1 .\"     $DragonFly: src/share/man/man4/Attic/umsm.4,v 1.4 2008/01/11 12:25:30 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 January 11, 2008
19 .Dt UMSM 4
20 .Os
21 .Sh NAME
22 .Nm umsm
23 .Nd Qualcomm MSM modem device
24 .Sh SYNOPSIS
25 To compile this driver into the kernel,
26 place the following lines in your
27 kernel configuration file:
28 .Bd -ragged -offset indent
29 .Cd "device umsm"
30 .Cd "device ucom"
31 .Ed
32 .Pp
33 Alternatively, to load the driver as a
34 module at boot time, place the following line in
35 .Xr loader.conf 5 :
36 .Bd -literal -offset indent
37 umsm_load="YES"
38 .Ed
39 .Sh DESCRIPTION
40 The
41 .Nm
42 driver supports Qualcomm MSM modem adapters.
43 The MSM chipset is found in EVDO and UMTS capable modems.
44 Typically these are CardBus and PCI Express Mini Cards that incorporate a
45 USB controller with the actual device attached to it.
46 .Pp
47 The following devices are known to work with the
48 .Nm
49 driver:
50 .Pp
51 .Bl -column "Device                " "Bus" -compact -offset 6n
52 .It Em "Device          Bus"
53 .It Li "AirPrime PC5220" Ta Ta CardBus
54 .It Li "Huawei Mobile Connect" Ta Ta CardBus
55 .It Li "Kyocera KPC650" Ta Ta CardBus
56 .It Li "Novatel Wireless ES620" Ta Ta USB
57 .It Li "ONDA Communication H600" Ta Ta CardBus
58 .It Li "Sierra Wireless MC8755" Ta Ta PCI Express Mini Card
59 .It Li "Sierra Wireless AirCard 580" Ta Ta CardBus
60 .It Li "Sierra Wireless AirCard 875" Ta Ta CardBus
61 .El
62 .Pp
63 Devices suspected of being compatible are:
64 .Pp
65 .Bl -column "Device                " "Bus" -compact -offset 6n
66 .It Em "Device          Bus"
67 .It Li "Dell W5500" Ta Ta PCI Express Mini Card
68 .It Li "Novatel Wireless Merlin V620" Ta CardBus
69 .It Li "Novatel Wireless S720" Ta Ta CardBus
70 .It Li "Novatel Wireless U720" Ta Ta USB
71 .It Li "Novatel Wireless XU870 HSDPA" Ta ExpressCard
72 .It Li "Sierra Wireless AirCard 595" Ta CardBus
73 .It Li "Sierra Wireless EM5625" Ta Ta USB module
74 .It Li "Sierra Wireless MC5720" Ta Ta PCI Express Mini Card
75 .It Li "Sierra Wireless MC5725" Ta Ta PCI Express Mini Card
76 .It Li "Sierra Wireless MC8765" Ta Ta PCI Express Mini Card
77 .It Li "Sierra Wireless MC8775" Ta Ta PCI Express Mini Card
78 .El
79 .Sh EXAMPLES
80 An example
81 .Pa /etc/ppp/ppp.conf
82 configuration for Verizon Wireless might look something like below;
83 see
84 .Xr ppp 8
85 for more information.
86 .Bd -literal -offset indent
87 default:
88    set device /dev/cuaU0
89    set speed 230400
90    set dial "ABORT BUSY ABORT NO\e\esCARRIER TIMEOUT 5 \e
91              \e"\e" AT OK-AT-OK ATE1Q0s7=60 OK \e\edATDT\e\eT TIMEOUT 40 CONNECT"
92    set phone "#777"
93    set login
94    set authname 4517654321@vzw3g.com
95    set authkey vzw
96    set timeout 120
97    set ifaddr 10.0.0.1/0 10.0.0.2/0 255.255.255.0 0.0.0.0
98    add default HISADDR
99    enable dns
100 .Ed
101 .Pp
102 In this example the phone number is (451) 765-4321: replace this with
103 the number issued for the card or your phone's number if a handset is being
104 used.
105 .Pp
106 An example demand dial configuration for Cingular Wireless using
107 .Xr pppd 8
108 appears below.
109 .Pp
110 .Pa /etc/ppp/cingular-chat :
111 .Bd -literal -offset indent
112 TIMEOUT 10
113 REPORT CONNECT
114 ABORT BUSY
115 ABORT 'NO CARRIER'
116 ABORT ERROR
117 \'\' ATZ OK AT&F OK
118 AT+CGDCONT=1,"IP","isp.cingular" OK
119 ATD*99***1# CONNECT
120 .Ed
121 .Pp
122 .Pa /etc/ppp/peers/ac875 :
123 .Bd -literal -offset indent
124 cuaU0
125 115200
126 debug
127 noauth
128 nocrtscts
129 :10.254.254.1
130 ipcp-accept-remote
131 defaultroute
132 user isp@cingulargprs.com
133 demand
134 active-filter 'not udp port 123'
135 persist
136 idle 600
137 connect "/usr/sbin/chat -v -f /etc/ppp/cingular-chat"
138 .Ed
139 .Pp
140 .Pa /etc/ppp/chap-secrets :
141 .Bd -literal -offset indent
142 # Secrets for authentication using CHAP
143 # client                server  secret          IP addresses
144 isp@cingulargprs.com    *       CINGULAR1
145 .Ed
146 .Pp
147 .Xr pppd 8
148 is then started using:
149 .Pp
150 .Dl # pppd call ac875
151 .Sh SEE ALSO
152 .Xr ucom 4 ,
153 .Xr usb 4 ,
154 .Xr pppd 8
155 .Sh HISTORY
156 The
157 .Nm
158 device driver first appeared in
159 .Ox 4.0
160 and was imported into
161 .Dx 1.11 .
162 .Sh AUTHORS
163 .An -nosplit
164 The
165 .Nm
166 driver was written by
167 .An Jonathan Gray
168 .Aq jsg@openbsd.org .
169 .Sh CAVEATS
170 For Verizon Wireless (and possibly other services),
171 cards require a one-time activation before they will work;
172 .Nm
173 does not currently support this.