share/man/man4/umodem.4

   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 .\" 3. All advertising materials mentioning features or use of this software
  18 .\"    must display the following acknowledgment:
  19 .\"        This product includes software developed by the NetBSD
  20 .\"        Foundation, Inc. and its contributors.
  21 .\" 4. Neither the name of The NetBSD Foundation nor the names of its
  22 .\"    contributors may be used to endorse or promote products derived
  23 .\"    from this software without specific prior written permission.
  24 .\"
  25 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  26 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  27 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  28 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  29 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  30 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  31 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  32 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  33 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  34 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  35 .\" POSSIBILITY OF SUCH DAMAGE.
  36 .\"
  37 .\" $FreeBSD$
  38 .\"
  39 .Dd November 22, 2006
  40 .Dt UMODEM 4
  41 .Os
  42 .Sh NAME
  43 .Nm umodem
  44 .Nd USB modem support
  45 .Sh SYNOPSIS
  46 To compile this driver into the kernel,
  47 place the following lines in your
  48 kernel configuration file:
  49 .Bd -ragged -offset indent
  50 .Cd "device umodem"
  51 .Cd "device ucom"
  52 .Ed
  53 .Pp
  54 Alternatively, to load the driver as a
  55 module at boot time, place the following line in
  56 .Xr loader.conf 5 :
  57 .Bd -literal -offset indent
  58 umodem_load="YES"
  59 .Ed
  60 .Sh DESCRIPTION
  61 The
  62 .Nm
  63 driver provides support for USB modems in the Communication
  64 Device Class using the Abstract Control Model.
  65 These modems are basically standard serial line modems, but they are
  66 accessed via USB instead.
  67 They support a regular AT command set.
  68 The commands can either be multiplexed with the data stream
  69 or handled through separate pipes.
  70 In the latter case the AT
  71 commands have to be given on a device separate from the data device.
  72 .Pp
  73 The device is accessed through the
  74 .Xr ucom 4
  75 driver which makes it behave like a
  76 .Xr tty 4 .
  77 .Sh HARDWARE
  78 Devices supported by the
  79 .Nm
  80 driver include:
  81 .Pp
  82 .Bl -bullet -compact
  83 .It
  84 3Com 5605
  85 .It
  86 Curitel PC5740 Wireless Modem
  87 .It
  88 Kyocera AH-K3001V Mobile Phone(WILLCOM)
  89 .It
  90 Kyocera WX320K Mobile Phone(WILLCOM)
  91 .It
  92 Metricom Ricochet GS USB wireless modem
  93 .It
  94 Sierra MC5720 Wireless Modem
  95 .It
  96 Yamaha Broadband Wireless Router RTW65b
  97 .It
  98 ELSA MicroLink 56k USB modem
  99 .It
 100 Sony Ericsson W810i phone
 101 .El
 102 .Sh SEE ALSO
 103 .Xr tty 4 ,
 104 .Xr ucom 4 ,
 105 .Xr usb 4
 106 .Sh HISTORY
 107 The
 108 .Nm
 109 driver
 110 appeared in
 111 .Nx 1.5 .
 112 This manual page was adopted from
 113 .Nx
 114 by
 115 .An Tom Rhodes Aq trhodes@FreeBSD.org
 116 in April 2002.
 117 .Sh BUGS
 118 Only modems with multiplexed commands and data are supported
 119 at the moment.