xref: /openbsd-src/share/man/man4/umsm.4 (revision f6aab3d83b51b91c24247ad2c2573574de475a82)
1.\"	$OpenBSD: umsm.4,v 1.96 2021/05/18 14:23:03 kevlo 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 $Mdocdate: May 18 2021 $
18.Dt UMSM 4
19.Os
20.Sh NAME
21.Nm umsm
22.Nd Qualcomm MSM modem device
23.Sh SYNOPSIS
24.Cd "umsm* at uhub?"
25.Cd "ucom* at umsm?"
26.Sh DESCRIPTION
27The
28.Nm
29driver supports Qualcomm MSM modem adapters.
30The MSM chipset is found in EVDO, UMTS and LTE capable modems.
31Typically these are CardBus and PCI Express Mini Cards that incorporate a
32USB controller with the actual device attached to it.
33.Pp
34The following devices are known to work with the
35.Nm
36driver:
37.Bl -column "Medion Mobile S4012 (Huawei E1550 OEM)" "Bus" -offset 6n
38.It Em Device Ta Em Bus
39.It Li "AirPrime PC5220" Ta "CardBus"
40.It Li "Alcatel One Touch X060" Ta "USB"
41.It Li "Alcatel One Touch X200" Ta "USB"
42.It Li "Alcatel One Touch X210" Ta "USB"
43.It Li "Alcatel One Touch X220" Ta "USB"
44.It Li "AnyDATA ADU-500A" Ta "USB"
45.It Li "AnyDATA ADU-E100H" Ta "USB"
46.It Li "AnyDATA A2502" Ta "USB"
47.It Li "C-motech CNU 680" Ta "USB"
48.It Li "Emobile D01HW (Huawei OEM)" Ta "USB"
49.It Li "Emobile D02HW (Huawei OEM)" Ta "USB"
50.It Li "Emobile D12HW (Huawei OEM)" Ta "USB"
51.It Li "Emobile D22HW (Huawei OEM)" Ta "USB"
52.It Li "Emobile D31HW (Huawei OEM)" Ta "USB"
53.It Li "Emobile H12HW (Huawei OEM)" Ta "USB"
54.It Li "Emobile D21LC (longcheer OEM)" Ta "USB"
55.It Li "Huawei Mobile E156G" Ta "USB"
56.It Li "Huawei Mobile E160E" Ta "USB"
57.It Li "Huawei Mobile E161" Ta "USB"
58.It Li "Huawei Mobile E160g" Ta "USB"
59.It Li "Huawei Mobile E1692" Ta "USB"
60.It Li "Huawei Mobile E172" Ta "USB"
61.It Li "Huawei Mobile E173" Ta "USB"
62.It Li "Huawei Mobile E173s" Ta "USB"
63.It Li "Huawei Mobile E180" Ta "USB"
64.It Li "Huawei Mobile E181" Ta "USB"
65.It Li "Huawei Mobile E182" Ta "USB"
66.It Li "Huawei Mobile E220" Ta "USB"
67.It Li "Huawei Mobile E303" Ta "USB"
68.It Li "Huawei Mobile E352" Ta "USB"
69.It Li "Huawei Mobile E353" Ta "USB"
70.It Li "Huawei Mobile E392" Ta "USB"
71.It Li "Huawei Mobile E510" Ta "USB"
72.It Li "Huawei Mobile E1550" Ta "USB"
73.It Li "Huawei Mobile E1750" Ta "USB"
74.It Li "Huawei Mobile E1752" Ta "USB"
75.It Li "Huawei Mobile E1820" Ta "USB"
76.It Li "Huawei Mobile E3372" Ta "USB"
77.It Li "Huawei Mobile EM770W" Ta "PCI Express Mini Card"
78.It Li "Huawei Mobile K4510" Ta "USB"
79.It Li "Huawei Mobile K4511" Ta "USB"
80.It Li "Huawei Mobile Connect E169g" Ta "USB"
81.It Li "Huawei Mobile Connect E618" Ta "USB"
82.It Li "Huawei Mobile Connect E620" Ta "USB"
83.It Li "IIJMobile 120FU (ZTE OEM)" Ta "USB"
84.It Li "Kyocera KPC650" Ta "CardBus"
85.It Li "Medion Mobile S4012 (Huawei E1550 OEM)" Ta "USB"
86.It Li "Medion Mobile S4222 (MediaTek OEM)" Ta "USB"
87.It Li "Novatel Wireless ES620" Ta "USB"
88.It Li "Novatel Wireless Ovation U727" Ta "USB"
89.It Li "Novatel Wireless U760" Ta "USB"
90.It Li "NTT DoCoMo A2502" Ta "USB"
91.It Li "ONDA Communication H600" Ta "CardBus"
92.It Li "ONDA Communication MSA110UP" Ta "USB"
93.It Li "Option GlobeSurfer iCON 7.2" Ta "USB"
94.It Li "Option GlobeTrotter 3G+" Ta "CardBus"
95.It Li "Option GlobeTrotter 3G Quad" Ta "CardBus"
96.It Li "Option GlobeTrotter 3G Quad Plus" Ta "CardBus"
97.It Li "Option GlobeTrotter GT Fusion" Ta "CardBus"
98.It Li "Option GlobeTrotter GT Max" Ta "CardBus"
99.It Li "Option GlobeTrotter HSDPA" Ta "USB"
100.It Li "Option iCON 225" Ta "USB"
101.It Li "Option iCON 505" Ta "USB"
102.It Li "Option GlobeTrotter HSUPA 380E" Ta "PCI Express Mini Card"
103.It Li "Quectel EC25" Ta "PCI Express Mini Card"
104.It Li "Sierra Wireless MC8755" Ta "PCI Express Mini Card"
105.It Li "Sierra Wireless MC8775" Ta "PCI Express Mini Card"
106.It Li "Sierra Wireless MC8790" Ta "PCI Express Mini Card"
107.It Li "Sierra Wireless AirCard 580" Ta "CardBus"
108.It Li "Sierra Wireless AirCard 875" Ta "CardBus"
109.It Li "Sierra Wireless AirCard 881" Ta "CardBus"
110.It Li "Sierra Wireless AirCard 881U" Ta "USB"
111.It Li "Sierra Wireless Inc. USB 305" Ta "USB"
112.It Li "Simcom SIM7600E" Ta "PCI Express Mini Card"
113.It Li "Softbank C01SW (Sierra OEM)" Ta "USB"
114.It Li "Toshiba 3G HSDPA MiniCard" Ta "PCI Express Mini Card"
115.It Li "Vodafone Mobile Connect 3G" Ta "CardBus"
116.It Li "Vodafone Mobile Broadband K3765" Ta "USB"
117.It Li "Vodafone Mobile Broadband K3772" Ta "USB"
118.It Li "ZTE AC2746" Ta "USB"
119.It Li "ZTE MF112" Ta "USB"
120.It Li "ZTE MF190" Ta "USB"
121.It Li "ZTE MF633" Ta "USB"
122.It Li "ZTE MF637" Ta "USB"
123.El
124.Pp
125Devices suspected of being compatible are:
126.Bl -column "Option GlobeTrotter HSDPA ICON225" "Bus" -offset 6n
127.It Em Device Ta Em Bus
128.It Li "Dell W5500" Ta "PCI Express Mini Card"
129.It Li "Huawei E270+" Ta "USB"
130.It Li "Huawei E1690" Ta "USB"
131.It Li "Huawei E1762" Ta "USB"
132.It Li "Novatel Wireless ExpressCard" Ta "ExpressCard"
133.It Li "Novatel Wireless Merlin V620" Ta "CardBus"
134.It Li "Novatel Wireless Merlin V740" Ta "CardBus"
135.It Li "Novatel Wireless Merlin X950D" Ta "ExpressCard"
136.It Li "Novatel Wireless MC950D" Ta "USB"
137.It Li "Novatel Wireless S720" Ta "CardBus"
138.It Li "Novatel Wireless U720" Ta "USB"
139.It Li "Novatel Wireless U740" Ta "CardBus"
140.It Li "Novatel Wireless U870" Ta "CardBus"
141.It Li "Novatel Wireless V720" Ta "CardBus"
142.It Li "Novatel Wireless X950D" Ta "ExpressCard"
143.It Li "Novatel Wireless XU870 HSDPA" Ta "ExpressCard"
144.It Li "Sierra Wireless AirCard 595" Ta "CardBus"
145.It Li "Sierra Wireless AirCard 597E" Ta "CardBus"
146.It Li "Sierra Wireless AirCard 880" Ta "CardBus"
147.It Li "Sierra Wireless AirCard 880E" Ta "ExpressCard"
148.It Li "Sierra Wireless AirCard 880U" Ta "USB"
149.It Li "Sierra Wireless AirCard 881E" Ta "ExpressCard"
150.It Li "Sierra Wireless AirCard 885U" Ta "USB"
151.It Li "Sierra Wireless C597" Ta "USB"
152.It Li "Sierra Wireless EM5625" Ta "USB"
153.It Li "Sierra Wireless MC5720" Ta "PCI Express Mini Card"
154.It Li "Sierra Wireless MC5725" Ta "PCI Express Mini Card"
155.It Li "Sierra Wireless MC8765" Ta "PCI Express Mini Card"
156.It Li "Sierra Wireless MC8780" Ta "PCI Express Mini Card"
157.It Li "Sierra Wireless MC8781" Ta "PCI Express Mini Card"
158.El
159.Pp
160Some modems have multiple serial ports,
161however almost all modems have only one effective serial port
162for PPP connections.
163For example, the Huawei E220 has two serial ports,
164but only the first port can be used to make connections;
165the second one is for management.
166The Option GlobeTrotter HSDPA/HSUPA modems have three serial ports,
167but only the last port can be used to make PPP connections.
168The Medion Mobile S4222 has four serial ports, but only the first
169port can be used to make connections.
170.Pp
171Some modems require multi-link PPP operation.
172For example, the Huawei E1550 has four serial ports.
173When initiating a connection, the control commands have to be issued
174on the third port, and after that the actual PPP connection comes
175up on the first port.
176The function of the second and fourth ports is unknown.
177.Sh EXAMPLES
178An example demand dial configuration for Cingular Wireless using
179.Xr pppd 8 :
180.Pp
181.Pa /etc/ppp/cingular-chat :
182.Bd -literal -offset indent
183TIMEOUT 10
184REPORT CONNECT
185ABORT BUSY
186ABORT 'NO CARRIER'
187ABORT ERROR
188\&'' ATZ OK AT&F OK
189AT+CGDCONT=1,"IP","isp.cingular" OK
190ATD*99***1# CONNECT
191.Ed
192.Pp
193.Pa /etc/ppp/peers/ac875 :
194.Bd -literal -offset indent
195cuaU0
196115200
197debug
198noauth
199nocrtscts
200:10.254.254.1
201ipcp-accept-remote
202defaultroute
203user isp@cingulargprs.com
204demand
205active-filter 'not udp port 123'
206persist
207idle 600
208connect "/usr/sbin/chat -v -f /etc/ppp/cingular-chat"
209.Ed
210.Pp
211.Pa /etc/ppp/chap-secrets :
212.Bd -literal -offset indent
213# Secrets for authentication using CHAP
214# client		server	secret		IP addresses
215isp@cingulargprs.com	*	CINGULAR1
216.Ed
217.Pp
218.Xr pppd 8
219is then started using:
220.Pp
221.Dl # pppd call ac875
222.Sh SEE ALSO
223.Xr ucom 4 ,
224.Xr uhub 4 ,
225.Xr usb 4 ,
226.Xr pppd 8
227.Sh HISTORY
228The
229.Nm
230device driver first appeared in
231.Ox 4.0 .
232.Sh AUTHORS
233.An -nosplit
234The
235.Nm
236driver was written by
237.An Jonathan Gray Aq Mt jsg@openbsd.org
238and
239.An Yojiro UO Aq Mt yuo@nui.org .
240.Sh CAVEATS
241For Verizon Wireless (and possibly other services),
242cards require a one-time activation before they will work;
243.Nm
244does not currently support this.
245.Pp
246The additional IEEE 802.11 wireless chipset found in the Option
247GlobeTrotter GT FUSION is not yet supported.
248