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