xref: /freebsd/share/man/man4/umodem.4 (revision 8aac90f18aef7c9eea906c3ff9a001ca7b94f375)
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.Dd April 26, 2017
31.Dt UMODEM 4
32.Os
33.Sh NAME
34.Nm umodem
35.Nd USB Communication Device Class serial (CDC ACM) driver
36.Sh SYNOPSIS
37To compile this driver into the kernel,
38place the following lines in your
39kernel configuration file:
40.Bd -ragged -offset indent
41.Cd "device usb"
42.Cd "device ucom"
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 and serial devices that
56implement the Communication Device Class Abstract Control Model (CDC ACM).
57It also provides device-side CDC ACM support.
58Supported 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.It
95Sonim XP5300 Force
96.El
97.Sh FILES
98.Bl -tag -width "/dev/ttyU*.init" -compact
99.It Pa /dev/ttyU*
100for callin ports
101.It Pa /dev/ttyU*.init
102.It Pa /dev/ttyU*.lock
103corresponding callin initial-state and lock-state devices
104.Pp
105.It Pa /dev/cuaU*
106for callout ports
107.It Pa /dev/cuaU*.init
108.It Pa /dev/cuaU*.lock
109corresponding callout initial-state and lock-state devices
110.El
111.Sh SEE ALSO
112.Xr tty 4 ,
113.Xr ucom 4 ,
114.Xr usb 4
115.Sh HISTORY
116The
117.Nm
118driver
119appeared in
120.Nx 1.5 .
121This manual page was adopted from
122.Nx
123by
124.An Tom Rhodes Aq Mt trhodes@FreeBSD.org
125in April 2002.
126.Sh BUGS
127Only modems with multiplexed commands and data are supported
128at the moment.
129