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 .Os
  28 .Dt UHSO 4
  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 a
  47 .Xr tty 4 .
  48 The packet interface is exposed as a network interface.
  49 .Pp
  50 Establishing a connection on the packet interface is achieved by using the
  51 proprietary AT commands
  52 .Dq Li AT_OWANCALL
  53 and
  54 .Dq Li AT_OWANDATA
  55 on any of the available serial ports.
  56 .Pp
  57 The network interface must be configured manually using the data obtain from
  58 these calls.
  59 .Pp
  60 Each device usually have at least two or more serial ports, their individual purpose
  61 can be identified through
  62 .Xr sysctl 8 .
  63 .Sh HARDWARE
  64 The
  65 .Nm
  66 driver supports at least the following cards
  67 .Pp
  68 .Bl -bullet -compact
  69 .It
  70 Option GlobeSurfer iCON 7.2 (new firmware)
  71 .It
  72 Option iCON 225
  73 .It
  74 Option iCON 505
  75 .El
  76 .Pp
  77 The device features a mass storage device referred to as
  78 .Dq Zero-CD
  79 which contains drivers for Microsoft Windows; this is the default
  80 mode for the device.
  81 The
  82 .Nm
  83 driver automatically switches the device from
  84 .Dq Zero-CD
  85 mode to modem mode.
  86 This behavior can be disabled by setting
  87 .Va hw.usb.uhso.auto_switch
  88 to 0 using
  89 .Xr sysctl 8
  90 .Sh EXAMPLES
  91 Establishing a packet interface connection
  92 .Bd -literal -offset indent
  93 AT+CGDCONT=1,,"apn.provider"
  94 AT_OWANCALL=1,1,1
  95 OK
  96 _OWANCALL=1,1
  97
  98 AT_OWANDATA=1
  99 _OWANDATA: 1, 10.11.12.13, 0.0.0.0, 10.2.3.4, 10.2.3.5, \e
 100         0.0.0.0, 0.0.0.0, 72000
 101 .Ed
 102 .Pp
 103 Configuring the interface
 104 .Bd -literal -offset indent
 105 ifconfig uhso0 10.11.12.13 up
 106 route add default -interface uhso0
 107 echo "nameserver 10.2.3.4" > /etc/resolv.conf
 108 echo "nameserver 10.2.3.5" >> /etc/resolv.conf
 109 .Ed
 110 .Pp
 111 The connection can be terminated with
 112 .Bd -literal -offset indent
 113 AT_OWANCALL=1,0,1
 114 .Ed
 115 .Sh FILES
 116 .Bl -tag -width "XXXXXX"
 117 .It Pa /dev/cuaU?.?
 118 .El
 119 .Sh SEE ALSO
 120 .Xr ucom 4 ,
 121 .Xr usb 4
 122 .Sh AUTHORS
 123 The
 124 .Nm
 125 driver was written by
 126 .An Fredrik Lindberg Aq fli@shapeshifter.se .