xref: /freebsd/share/man/man4/uhso.4 (revision e28a4053)
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 July 20, 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
33The module can be loaded at boot time by placing the following line in
34.Xr loader.conf 5 :
35.Bd -literal -offset indent
36uhso_load="YES"
37.Ed
38.Sh DESCRIPTION
39The
40.Nm
41driver provides support for several HSxPA devices from Option N.V. that are
42based on their packet interface.
43Each device has a set of serial ports and a raw IP packet interface.
44The serial ports of the device are accessed through the
45.Xr ucom 4
46driver which makes them behave like
47.Xr tty 4
48devices.
49The packet interface is exposed as a network interface.
50.Pp
51Establishing a connection on the packet interface is achieved by using the
52proprietary AT commands
53.Dq Li AT_OWANCALL
54and
55.Dq Li AT_OWANDATA
56on any of the available serial ports.
57.Pp
58The network interface must be configured manually using the data obtain from
59these calls.
60.Pp
61Each device usually have at least two or more serial ports, their individual purpose
62can be identified through
63.Xr sysctl 8 .
64Ports identified as
65.Dq Modem
66features a normal modem interface that can be used with PPP.
67Ports identified as
68.Dq Diagnostic
69uses a proprietary binary interface used for firmware upgrades, this port does not
70have a AT command interface and can not be used to control the device.
71Other ports features an AT command interface that can be used for normal device control.
72.Sh HARDWARE
73The
74.Nm
75driver should work with most devices from Option.
76The following devices have been verified to work
77.Pp
78.Bl -bullet -compact
79.It
80Option GlobeSurfer iCON 7.2 (new firmware)
81.It
82Option iCON 225
83.It
84Option iCON 452
85.It
86Option iCON 505
87.El
88.Pp
89The device features a mass storage device referred to as
90.Dq Zero-CD
91which contains drivers for Microsoft Windows; this is the default
92mode for the device.
93The
94.Nm
95driver automatically switches the device from
96.Dq Zero-CD
97mode to modem mode.
98This behavior can be disabled by setting
99.Va hw.usb.uhso.auto_switch
100to 0 using
101.Xr sysctl 8
102.Sh FILES
103.Bl -tag -width "XXXXXX"
104.It Pa /dev/cuaU?.?
105.El
106.Sh EXAMPLES
107Establishing a packet interface connection using the AT command interface available
108at one of the serial ports
109.Bd -literal -offset indent
110AT+CGDCONT=1,,"apn.provider"
111AT_OWANCALL=1,1,1
112OK
113_OWANCALL=1,1
114
115AT_OWANDATA=1
116_OWANDATA: 1, 10.11.12.13, 0.0.0.0, 10.2.3.4, 10.2.3.5, \e
117	0.0.0.0, 0.0.0.0, 72000
118.Ed
119.Pp
120Configuring the interface
121.Bd -literal -offset indent
122ifconfig uhso0 10.11.12.13 up
123route add default -interface uhso0
124echo "nameserver 10.2.3.4" > /etc/resolv.conf
125echo "nameserver 10.2.3.5" >> /etc/resolv.conf
126.Ed
127.Pp
128The connection can be terminated with
129.Bd -literal -offset indent
130AT_OWANCALL=1,0,1
131.Ed
132.Sh SEE ALSO
133.Xr uhsoctl 1 ,
134.Xr ucom 4 ,
135.Xr usb 4
136.Sh AUTHORS
137The
138.Nm
139driver was written by
140.An Fredrik Lindberg Aq fli@shapeshifter.se .
141