share/man/man4/umsm.4

   1 .\"     $DragonFly: src/share/man/man4/Attic/umsm.4,v 1.2 2007/09/13 10:34:04 swildner 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 $Mdocdate: May 31 2007 $
  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 "Kyocera KPC650" Ta Ta CardBus
  55 .It Li "Novatel Wireless ES620" Ta Ta USB
  56 .It Li "ONDA Communication H600" Ta Ta CardBus
  57 .It Li "Sierra Wireless MC8755" Ta Ta PCI Express Mini Card
  58 .It Li "Sierra Wireless AirCard 580" Ta Ta CardBus
  59 .It Li "Sierra Wireless AirCard 875" Ta Ta CardBus
  60 .El
  61 .Pp
  62 Devices suspected of being compatible are:
  63 .Pp
  64 .Bl -column "Device                " "Bus" -compact -offset 6n
  65 .It Em "Device          Bus"
  66 .It Li "Dell W5500" Ta Ta PCI Express Mini Card
  67 .It Li "Novatel Wireless Merlin V620" Ta CardBus
  68 .It Li "Novatel Wireless S720" Ta Ta CardBus
  69 .It Li "Novatel Wireless U720" Ta Ta USB
  70 .It Li "Novatel Wireless XU870 HSDPA" Ta ExpressCard
  71 .It Li "Sierra Wireless AirCard 595" Ta CardBus
  72 .It Li "Sierra Wireless EM5625" Ta Ta USB module
  73 .It Li "Sierra Wireless MC5720" Ta Ta PCI Express Mini Card
  74 .It Li "Sierra Wireless MC5725" Ta Ta PCI Express Mini Card
  75 .It Li "Sierra Wireless MC8765" Ta Ta PCI Express Mini Card
  76 .It Li "Sierra Wireless MC8775" Ta Ta PCI Express Mini Card
  77 .El
  78 .Sh EXAMPLES
  79 An example
  80 .Pa /etc/ppp/ppp.conf
  81 configuration for Verizon Wireless might look something like below;
  82 see
  83 .Xr ppp 8
  84 for more information.
  85 .Bd -literal -offset indent
  86 default:
  87    set device /dev/cuaU0
  88    set speed 230400
  89    set dial "ABORT BUSY ABORT NO\e\esCARRIER TIMEOUT 5 \e
  90              \e"\e" AT OK-AT-OK ATE1Q0s7=60 OK \e\edATDT\e\eT TIMEOUT 40 CONNECT"
  91    set phone "#777"
  92    set login
  93    set authname 4517654321@vzw3g.com
  94    set authkey vzw
  95    set timeout 120
  96    set ifaddr 10.0.0.1/0 10.0.0.2/0 255.255.255.0 0.0.0.0
  97    add default HISADDR
  98    enable dns
  99 .Ed
 100 .Pp
 101 In this example the phone number is (451) 765-4321: replace this with
 102 the number issued for the card or your phone's number if a handset is being
 103 used.
 104 .Pp
 105 An example demand dial configuration for Cingular Wireless using
 106 .Xr pppd 8
 107 appears below.
 108 .Pp
 109 .Pa /etc/ppp/cingular-chat :
 110 .Bd -literal -offset indent
 111 TIMEOUT 10
 112 REPORT CONNECT
 113 ABORT BUSY
 114 ABORT 'NO CARRIER'
 115 ABORT ERROR
 116 \'\' ATZ OK AT&F OK
 117 AT+CGDCONT=1,"IP","isp.cingular" OK
 118 ATD*99***1# CONNECT
 119 .Ed
 120 .Pp
 121 .Pa /etc/ppp/peers/ac875 :
 122 .Bd -literal -offset indent
 123 cuaU0
 124 115200
 125 debug
 126 noauth
 127 nocrtscts
 128 :10.254.254.1
 129 ipcp-accept-remote
 130 defaultroute
 131 user isp@cingulargprs.com
 132 demand
 133 active-filter 'not udp port 123'
 134 persist
 135 idle 600
 136 connect "/usr/sbin/chat -v -f /etc/ppp/cingular-chat"
 137 .Ed
 138 .Pp
 139 .Pa /etc/ppp/chap-secrets :
 140 .Bd -literal -offset indent
 141 # Secrets for authentication using CHAP
 142 # client                server  secret          IP addresses
 143 isp@cingulargprs.com    *       CINGULAR1
 144 .Ed
 145 .Pp
 146 .Xr pppd 8
 147 is then started using:
 148 .Pp
 149 .Dl # pppd call ac875
 150 .Sh SEE ALSO
 151 .Xr ucom 4 ,
 152 .Xr usb 4 ,
 153 .Xr pppd 8
 154 .Sh HISTORY
 155 The
 156 .Nm
 157 device driver first appeared in
 158 .Ox 4.0
 159 and was imported into
 160 .Dx 1.11 .
 161 .Sh AUTHORS
 162 .An -nosplit
 163 The
 164 .Nm
 165 driver was written by
 166 .An Jonathan Gray
 167 .Aq jsg@openbsd.org .
 168 .Sh CAVEATS
 169 For Verizon Wireless (and possibly other services),
 170 cards require a one-time activation before they will work;
 171 .Nm
 172 does not currently support this.