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