xref: /netbsd-src/share/man/man4/uhso.4 (revision ba65fde2d7fefa7d39838fa5fa855e62bd606b5e)
1.\" $NetBSD: uhso.4,v 1.3 2011/08/26 07:56:00 plunky Exp $
2.\"
3.\" Copyright (c) 2009 Iain Hibbert
4.\" All rights reserved.
5.\"
6.\" Redistribution and use in source and binary forms, with or without
7.\" modification, are permitted provided that the following conditions
8.\" are met:
9.\" 1. Redistributions of source code must retain the above copyright
10.\"    notice, this list of conditions and the following disclaimer.
11.\" 2. Redistributions in binary form must reproduce the above copyright
12.\"    notice, this list of conditions and the following disclaimer in the
13.\"    documentation and/or other materials provided with the distribution.
14.\"
15.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
16.\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
17.\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
18.\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
19.\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
20.\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
21.\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
22.\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
23.\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
24.\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
25.\"
26.Dd August 26, 2011
27.Dt UHSO 4
28.Os
29.Sh NAME
30.Nm uhso
31.Nd Option N.V. Wireless WAN modem driver
32.Sh SYNOPSIS
33.Cd "uhso*	at uhub? port ?"
34.Sh HARDWARE
35The
36.Nm
37driver supports at least the following adapters:
38.Lp
39.Bl -tag -compact -offset indent
40.It GlobeSurfer HSUPA
41.It GlobeSurfer iCON 7.2
42.It GlobeTrotter Express 40x
43.It GlobeTrotter Express HSUPA
44.It GlobeTrotter HSUPA
45.It GlobeTrotter Max HSDPA
46.It GlobeTrotter Module 382
47.It GlobeTrotter iCON 225
48.It GlobeTrotter iCON 321
49.It GlobeTrotter iCON 322
50.It GlobeTrotter iCON 401
51.It GlobeTrotter iCON 505
52.It GlobeTrotter iCON EDGE
53.El
54.Sh DESCRIPTION
55The
56.Tn Option N.V.
57modems appear at first as a
58.Xr umass 4
59device containing the
60.Tn Windows
61and
62.Tn MacOS
63drivers and, upon receipt of a SCSI
64.Qq REZERO UNIT
65command, will detach from the USB bus and reattach as a
66Wireless WAN modem.
67Unless disabled by clearing the
68.Xr sysctl 8
69variable
70.Dv hw.uhso.autoswitch ,
71the driver will handle that automatically.
72.Pp
73The modems provide a number of IO channels spread over several USB
74interfaces which are mapped by function to a standard port number
75in each driver instance.
76The defined channels are:
77.Lp
78.Bl -column -offset indent "Sy Channel Name" "Sy Port"
79.It Sy "Channel Name" Ta Sy "Port"
80.It Control Ta 0
81.It Diagnostic Ta 1
82.It Diagnostic 2 Ta 2
83.It Application Ta 3
84.It Application 2 Ta 4
85.It GPS Ta 5
86.It GPS Control Ta 6
87.It PC Smartcard Ta 7
88.It Modem Ta 8
89.It MSD Ta 9
90.It Voice Ta 10
91.It Network Ta 11
92.El
93.Pp
94Apart from the Network port, which is attached as a network
95interface, the ports are attached as
96.Xr tty 4
97devices using the port number as the minor device number.
98In order to connect using
99.Xr pppd 8 ,
100the Modem tty should be used
101.Pq eg /dev/ttyHS0.08 .
102.Pp
103The Network port provides a direct IPv4 interface,
104but before this can be used the modem needs to
105be placed in connected mode and network settings subsequently
106retrieved using the proprietary
107.Qq _OWANCALL
108and
109.Qq _OWANDATA
110AT commands on the Control port.
111.Pp
112Note that the Modem and Network ports should not be enabled at the
113same time for USB performance reasons.
114.Sh FILES
115.Bl -tag -compact
116.It Pa /dev/ttyHS?.??
117.It Pa /dev/dtyHS?.??
118.It Pa /dev/ctyHS?.??
119.El
120.Sh SEE ALSO
121.Xr intro 4 ,
122.Xr netintro 4 ,
123.Xr tty 4 ,
124.Xr uhub 4 ,
125.Xr usb 4 ,
126.Xr ifconfig 8
127.Sh HISTORY
128This driver originated as the
129.Nm hso
130module for
131.Fx
132written by
133.An Frederik Lindberg .
134It was rewritten for
135.Nx ,
136and to provide more complete device support with
137information extracted from the
138.Nm hso
139driver for
140.Tn Linux
141provided by
142.Tn Option N.V.
143.Pp
144The rewrite and this manual page by
145.An Iain Hibbert .
146