xref: /netbsd-src/share/man/man4/uhso.4 (revision 5d7c2f3f3ff80ee3f35c0e02c42d22f04c14a606)
1.\" $NetBSD: uhso.4,v 1.5 2014/07/19 14:21:34 skrll 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 July 19, 2014
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 HSUPA Modem
46.It GlobeTrotter Max HSDPA
47.It GlobeTrotter Module 382
48.It GlobeTrotter iCON 225
49.It GlobeTrotter iCON 321
50.It GlobeTrotter iCON 322
51.It GlobeTrotter iCON 401
52.It GlobeTrotter iCON 505
53.It GlobeTrotter iCON EDGE
54.El
55.Sh DESCRIPTION
56The
57.Tn Option N.V.
58modems appear at first as a
59.Xr umass 4
60device containing the
61.Tn Windows
62and
63.Tn MacOS
64drivers and, upon receipt of a SCSI
65.Qq REZERO UNIT
66command, will detach from the USB bus and reattach as a
67Wireless WAN modem.
68Unless disabled by clearing the
69.Xr sysctl 8
70variable
71.Dv hw.uhso.autoswitch ,
72the driver will handle that automatically.
73.Pp
74The modems provide a number of IO channels spread over several USB
75interfaces which are mapped by function to a standard port number
76in each driver instance.
77The defined channels are:
78.Lp
79.Bl -column -offset indent "Sy Channel Name" "Sy Port"
80.It Sy "Channel Name" Ta Sy "Port"
81.It Control Ta 0
82.It Diagnostic Ta 1
83.It Diagnostic 2 Ta 2
84.It Application Ta 3
85.It Application 2 Ta 4
86.It GPS Ta 5
87.It GPS Control Ta 6
88.It PC Smartcard Ta 7
89.It Modem Ta 8
90.It MSD Ta 9
91.It Voice Ta 10
92.It Network Ta 11
93.El
94.Pp
95Apart from the Network port, which is attached as a network
96interface, the ports are attached as
97.Xr tty 4
98devices using the port number as the minor device number.
99In order to connect using
100.Xr pppd 8 ,
101the Modem tty should be used
102.Pq eg /dev/ttyHS0.08 .
103.Pp
104The Network port provides a direct IPv4 interface,
105but before this can be used the modem needs to
106be placed in connected mode and network settings subsequently
107retrieved using the proprietary
108.Qq _OWANCALL
109and
110.Qq _OWANDATA
111AT commands on the Control port.
112.Pp
113Note that the Modem and Network ports should not be enabled at the
114same time for USB performance reasons.
115.Sh FILES
116.Bl -tag -compact
117.It Pa /dev/ttyHS?.??
118.It Pa /dev/dtyHS?.??
119.It Pa /dev/ctyHS?.??
120.El
121.Sh SEE ALSO
122.Xr intro 4 ,
123.Xr netintro 4 ,
124.Xr tty 4 ,
125.Xr uhub 4 ,
126.Xr usb 4 ,
127.Xr ifconfig 8
128.Sh HISTORY
129This driver originated as the
130.Nm hso
131module for
132.Fx
133written by
134.An Frederik Lindberg .
135It was rewritten for
136.Nx ,
137and to provide more complete device support with
138information extracted from the
139.Nm hso
140driver for
141.Tn Linux
142provided by
143.Tn Option N.V.
144.Pp
145The rewrite and this manual page by
146.An Iain Hibbert .
147