xref: /dflybsd-src/share/man/man4/umodem.4 (revision f4828a5d02b16c08d88e5534038a4a300b90ed60)
1e1fb9409SSascha Wildner.\" $NetBSD: umodem.4,v 1.6 2001/09/11 23:18:55 wiz Exp $
2e1fb9409SSascha Wildner.\"
3e1fb9409SSascha Wildner.\" Copyright (c) 1999 The NetBSD Foundation, Inc.
4e1fb9409SSascha Wildner.\" All rights reserved.
5e1fb9409SSascha Wildner.\"
6e1fb9409SSascha Wildner.\" This code is derived from software contributed to The NetBSD Foundation
7e1fb9409SSascha Wildner.\" by Lennart Augustsson.
8e1fb9409SSascha Wildner.\"
9e1fb9409SSascha Wildner.\" Redistribution and use in source and binary forms, with or without
10e1fb9409SSascha Wildner.\" modification, are permitted provided that the following conditions
11e1fb9409SSascha Wildner.\" are met:
12e1fb9409SSascha Wildner.\" 1. Redistributions of source code must retain the above copyright
13e1fb9409SSascha Wildner.\"    notice, this list of conditions and the following disclaimer.
14e1fb9409SSascha Wildner.\" 2. Redistributions in binary form must reproduce the above copyright
15e1fb9409SSascha Wildner.\"    notice, this list of conditions and the following disclaimer in the
16e1fb9409SSascha Wildner.\"    documentation and/or other materials provided with the distribution.
17e1fb9409SSascha Wildner.\"
18e1fb9409SSascha Wildner.\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
19e1fb9409SSascha Wildner.\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
20e1fb9409SSascha Wildner.\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
21e1fb9409SSascha Wildner.\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
22e1fb9409SSascha Wildner.\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
23e1fb9409SSascha Wildner.\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
24e1fb9409SSascha Wildner.\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
25e1fb9409SSascha Wildner.\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
26e1fb9409SSascha Wildner.\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
27e1fb9409SSascha Wildner.\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
28e1fb9409SSascha Wildner.\" POSSIBILITY OF SUCH DAMAGE.
29e1fb9409SSascha Wildner.\"
30*f4828a5dSSascha Wildner.\" $FreeBSD: head/share/man/man4/umodem.4 239090 2012-08-06 08:59:39Z glebius $
31e1fb9409SSascha Wildner.\"
32*f4828a5dSSascha Wildner.Dd August 6, 2012
33e1fb9409SSascha Wildner.Dt UMODEM 4
34e1fb9409SSascha Wildner.Os
35e1fb9409SSascha Wildner.Sh NAME
36e1fb9409SSascha Wildner.Nm umodem
37e1fb9409SSascha Wildner.Nd USB modem support
38e1fb9409SSascha Wildner.Sh SYNOPSIS
39*f4828a5dSSascha WildnerTo compile this driver into the kernel,
40*f4828a5dSSascha Wildnerplace the following lines in your
41*f4828a5dSSascha Wildnerkernel configuration file:
42*f4828a5dSSascha Wildner.Bd -ragged -offset indent
43*f4828a5dSSascha Wildner.Cd "device usb"
44e1fb9409SSascha Wildner.Cd "device ucom"
45*f4828a5dSSascha Wildner.Cd "device umodem"
46*f4828a5dSSascha Wildner.Ed
47*f4828a5dSSascha Wildner.Pp
48*f4828a5dSSascha WildnerAlternatively, to load the driver as a
49*f4828a5dSSascha Wildnermodule at boot time, place the following line in
50*f4828a5dSSascha Wildner.Xr loader.conf 5 :
51*f4828a5dSSascha Wildner.Bd -literal -offset indent
52*f4828a5dSSascha Wildnerumodem_load="YES"
53*f4828a5dSSascha Wildner.Ed
54e1fb9409SSascha Wildner.Sh DESCRIPTION
55e1fb9409SSascha WildnerThe
56e1fb9409SSascha Wildner.Nm
57e1fb9409SSascha Wildnerdriver provides support for USB modems in the Communication
58e1fb9409SSascha WildnerDevice Class using the Abstract Control Model.
59e1fb9409SSascha WildnerThese modems are basically standard serial line modems, but they are
60e1fb9409SSascha Wildneraccessed via USB instead.
61e1fb9409SSascha WildnerThey support a regular AT command set.
62e1fb9409SSascha WildnerThe commands can either be multiplexed with the data stream
63e1fb9409SSascha Wildneror handled through separate pipes.
64e1fb9409SSascha WildnerIn the latter case the AT
65e1fb9409SSascha Wildnercommands have to be given on a device separate from the data device.
66e1fb9409SSascha Wildner.Pp
67e1fb9409SSascha WildnerThe device is accessed through the
68e1fb9409SSascha Wildner.Xr ucom 4
69e1fb9409SSascha Wildnerdriver which makes it behave like a
70e1fb9409SSascha Wildner.Xr tty 4 .
71*f4828a5dSSascha Wildner.Sh HARDWARE
72*f4828a5dSSascha WildnerDevices supported by the
73*f4828a5dSSascha Wildner.Nm
74*f4828a5dSSascha Wildnerdriver include:
75*f4828a5dSSascha Wildner.Pp
76*f4828a5dSSascha Wildner.Bl -bullet -compact
77*f4828a5dSSascha Wildner.It
78*f4828a5dSSascha Wildner3Com 5605
79*f4828a5dSSascha Wildner.It
80*f4828a5dSSascha WildnerCuritel PC5740 Wireless Modem
81*f4828a5dSSascha Wildner.It
82*f4828a5dSSascha WildnerKyocera AH-K3001V Mobile Phone(WILLCOM)
83*f4828a5dSSascha Wildner.It
84*f4828a5dSSascha WildnerKyocera WX320K Mobile Phone(WILLCOM)
85*f4828a5dSSascha Wildner.It
86*f4828a5dSSascha WildnerMetricom Ricochet GS USB wireless modem
87*f4828a5dSSascha Wildner.It
88*f4828a5dSSascha WildnerSierra MC5720 Wireless Modem
89*f4828a5dSSascha Wildner.It
90*f4828a5dSSascha WildnerYamaha Broadband Wireless Router RTW65b
91*f4828a5dSSascha Wildner.It
92*f4828a5dSSascha WildnerELSA MicroLink 56k USB modem
93*f4828a5dSSascha Wildner.It
94*f4828a5dSSascha WildnerSony Ericsson W810i phone
95*f4828a5dSSascha Wildner.It
96*f4828a5dSSascha WildnerSonim XP5300 Force
97*f4828a5dSSascha Wildner.El
98e1fb9409SSascha Wildner.Sh SEE ALSO
99e1fb9409SSascha Wildner.Xr tty 4 ,
100e1fb9409SSascha Wildner.Xr ucom 4 ,
101e1fb9409SSascha Wildner.Xr usb 4
102e1fb9409SSascha Wildner.Sh HISTORY
103e1fb9409SSascha WildnerThe
104e1fb9409SSascha Wildner.Nm
105e1fb9409SSascha Wildnerdriver
106e1fb9409SSascha Wildnerappeared in
107e1fb9409SSascha Wildner.Nx 1.5 .
108e1fb9409SSascha WildnerThis manual page was adopted from
109e1fb9409SSascha Wildner.Nx
110e1fb9409SSascha Wildnerby
111e18a87e3SFranco Fichtner.An Tom Rhodes Aq Mt trhodes@FreeBSD.org
112e1fb9409SSascha Wildnerin April 2002.
113e1fb9409SSascha Wildner.Sh BUGS
114e1fb9409SSascha WildnerOnly modems with multiplexed commands and data are supported
115e1fb9409SSascha Wildnerat the moment.
116