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