share/man/man4/uhso.4

   1 .\" Copyright (c) 2009 Fredrik Lindberg
   2 .\" All rights reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\"
  13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
  14 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  15 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
  16 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
  17 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
  18 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
  19 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
  20 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
  21 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
  22 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  23 .\"
  24 .\" $FreeBSD$
  25 .\"
  26 .Dd January 14, 2010
  27 .Dt UHSO 4
  28 .Os
  29 .Sh NAME
  30 .Nm uhso
  31 .Nd support for several HSxPA devices from Option N.V.
  32 .Sh SYNOPSIS
  33 The module can be loaded at boot time by placing the following line in
  34 .Xr loader.conf 5 :
  35 .Bd -literal -offset indent
  36 uhso_load="YES"
  37 .Ed
  38 .Sh DESCRIPTION
  39 The
  40 .Nm
  41 driver provides support for several HSxPA devices from Option N.V. that are
  42 based on their packet interface.
  43 Each device has a set of serial ports and a raw IP packet interface.
  44 The serial ports of the device are accessed through the
  45 .Xr ucom 4
  46 driver which makes them behave like
  47 .Xr tty 4
  48 devices.
  49 The packet interface is exposed as a network interface.
  50 .Pp
  51 Establishing a connection on the packet interface is achieved by using the
  52 proprietary AT commands
  53 .Dq Li AT_OWANCALL
  54 and
  55 .Dq Li AT_OWANDATA
  56 on any of the available serial ports.
  57 .Pp
  58 The network interface must be configured manually using the data obtain from
  59 these calls.
  60 .Pp
  61 Each device usually have at least two or more serial ports, their individual purpose
  62 can be identified through
  63 .Xr sysctl 8 .
  64 Ports identified as
  65 .Dq Modem
  66 features a normal modem interface that can be used with PPP.
  67 Ports identified as
  68 .Dq Diagnostic
  69 uses a proprietary binary interface used for firmware upgrades, this port does not
  70 have a AT command interface and can not be used to control the device.
  71 Other ports features an AT command interface that can be used for normal device control.
  72 .Sh HARDWARE
  73 The
  74 .Nm
  75 driver should work with most devices from Option.
  76 The following devices have been verified to work
  77 .Pp
  78 .Bl -bullet -compact
  79 .It
  80 Option GlobeSurfer iCON 7.2 (new firmware)
  81 .It
  82 Option iCON 225
  83 .It
  84 Option iCON 452
  85 .It
  86 Option iCON 505
  87 .El
  88 .Pp
  89 The device features a mass storage device referred to as
  90 .Dq Zero-CD
  91 which contains drivers for Microsoft Windows; this is the default
  92 mode for the device.
  93 The
  94 .Nm
  95 driver automatically switches the device from
  96 .Dq Zero-CD
  97 mode to modem mode.
  98 This behavior can be disabled by setting
  99 .Va hw.usb.uhso.auto_switch
 100 to 0 using
 101 .Xr sysctl 8
 102 .Sh EXAMPLES
 103 Establishing a packet interface connection using the AT command interface available
 104 at one of the serial ports
 105 .Bd -literal -offset indent
 106 AT+CGDCONT=1,,"apn.provider"
 107 AT_OWANCALL=1,1,1
 108 OK
 109 _OWANCALL=1,1
 110
 111 AT_OWANDATA=1
 112 _OWANDATA: 1, 10.11.12.13, 0.0.0.0, 10.2.3.4, 10.2.3.5, \e
 113         0.0.0.0, 0.0.0.0, 72000
 114 .Ed
 115 .Pp
 116 Configuring the interface
 117 .Bd -literal -offset indent
 118 ifconfig uhso0 10.11.12.13 up
 119 route add default -interface uhso0
 120 echo "nameserver 10.2.3.4" > /etc/resolv.conf
 121 echo "nameserver 10.2.3.5" >> /etc/resolv.conf
 122 .Ed
 123 .Pp
 124 The connection can be terminated with
 125 .Bd -literal -offset indent
 126 AT_OWANCALL=1,0,1
 127 .Ed
 128 .Sh FILES
 129 .Bl -tag -width "XXXXXX"
 130 .It Pa /dev/cuaU?.?
 131 .El
 132 .Sh SEE ALSO
 133 .Xr ucom 4 ,
 134 .Xr usb 4
 135 .Sh AUTHORS
 136 The
 137 .Nm
 138 driver was written by
 139 .An Fredrik Lindberg Aq fli@shapeshifter.se .