xref: /freebsd/share/man/man4/umodem.4 (revision 7aa383846770374466b1dcb2cefd71bde9acf463)
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.Cd "device ucom"
45.Ed
46.Pp
47Alternatively, to load the driver as a
48module at boot time, place the following line in
49.Xr loader.conf 5 :
50.Bd -literal -offset indent
51umodem_load="YES"
52.Ed
53.Sh DESCRIPTION
54The
55.Nm
56driver provides support for USB modems in the Communication
57Device Class using the Abstract Control Model.
58These modems are basically standard serial line modems, but they are
59accessed via USB instead.
60They support a regular AT command set.
61The commands can either be multiplexed with the data stream
62or handled through separate pipes.
63In the latter case the AT
64commands have to be given on a device separate from the data device.
65.Pp
66The device is accessed through the
67.Xr ucom 4
68driver which makes it behave like a
69.Xr tty 4 .
70.Sh HARDWARE
71Devices supported by the
72.Nm
73driver include:
74.Pp
75.Bl -bullet -compact
76.It
773Com 5605
78.It
79Curitel PC5740 Wireless Modem
80.It
81Kyocera AH-K3001V Mobile Phone(WILLCOM)
82.It
83Kyocera WX320K Mobile Phone(WILLCOM)
84.It
85Metricom Ricochet GS USB wireless modem
86.It
87Sierra MC5720 Wireless Modem
88.It
89Yamaha Broadband Wireless Router RTW65b
90.It
91ELSA MicroLink 56k USB modem
92.It
93Sony Ericsson W810i phone
94.El
95.Sh SEE ALSO
96.Xr tty 4 ,
97.Xr ucom 4 ,
98.Xr usb 4
99.Sh HISTORY
100The
101.Nm
102driver
103appeared in
104.Nx 1.5 .
105This manual page was adopted from
106.Nx
107by
108.An Tom Rhodes Aq trhodes@FreeBSD.org
109in April 2002.
110.Sh BUGS
111Only modems with multiplexed commands and data are supported
112at the moment.
113