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