share/man/man4/ufoma.4

   1 .\" Copyright (c) 2006 Takanori Watanabe.
   2 .\" All rights reserved.
   3 .\"
   4 .\" This code is derived from software contributed to The NetBSD Foundation
   5 .\" by Lennart Augustsson.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY THE NETBSD FOUNDATION, INC. AND CONTRIBUTORS
  17 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
  18 .\" TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
  19 .\" PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE FOUNDATION OR CONTRIBUTORS
  20 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  21 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  22 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  23 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  24 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  25 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
  26 .\" POSSIBILITY OF SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd January 10, 2006
  31 .Dt UFOMA 4
  32 .Os
  33 .Sh NAME
  34 .Nm ufoma
  35 .Nd USB mobile phone support
  36 .Sh SYNOPSIS
  37 .Cd "device ufoma"
  38 .Cd "device ucom"
  39 .Sh DESCRIPTION
  40 The
  41 .Nm
  42 driver provides support for USB mobile phone terminals in the subset of
  43 the Mobile Computing Promotion Consortium USB Implementation Guideline,
  44 which is adopted by FOMA, the NTT DoCoMo 3G system, terminal.
  45 These are partly like CDC ACM model based modems, which are supported
  46 by
  47 .Xr umodem 4 ,
  48 but the
  49 .Nm
  50 driver recognizes a specific USB descriptor that describes its role and
  51 interface structure, and it will negotiate its role when the device is open.
  52 They support a regular AT command set and
  53 the commands can either be multiplexed with the data stream
  54 or handled through separate pipes.
  55 In the latter case the AT
  56 commands have to be given on a device separate from the data device.
  57 .Pp
  58 The device is accessed through the
  59 .Xr ucom 4
  60 driver which makes it behave like a
  61 .Xr tty 4 .
  62 .Sh SYSCTLS
  63 These devices often have a few interface sets and these interfaces
  64 have their role, sometimes multiplexed.
  65 These roles are identified with the following sysctl MIBs:
  66 .Bl -tag -width indent
  67 .It Va dev.ucom.%d.supportmode
  68 The modes which are supported by the interface.
  69 .It Va dev.ucom.%d.currentmode
  70 Current mode of the interface.
  71 .It Va dev.ucom.%d.openmode
  72 Mode to transit when the device is open next.
  73 .El
  74 The modes are as follows:
  75 .Bl -tag -width indent
  76 .It Li modem
  77 Accepts AT commands and go and pass packet communication data.
  78 .It Li handsfree
  79 Accepts AT commands but it does not pass data.
  80 .It Li obex
  81 Accepts OBEX frame which is used to exchange telephone book, etc.
  82 .It Li vendor1 , vendor2
  83 Vendor specific data may be passed.
  84 .It Li deactivated
  85 When an interface is recognized by the system but not used, the interface
  86 will be set to this mode.
  87 .It Li unlinked
  88 When an interface is not yet negotiated, the interface is in this mode.
  89 .El
  90 .Sh HARDWARE
  91 Devices supported by the
  92 .Nm
  93 driver include:
  94 .Pp
  95 .Bl -bullet -compact
  96 .It
  97 SHARP FOMA SH902i
  98 .It
  99 KYOCERA PHS AH-K3001V (a.k.a Kyopon)
 100 .It
 101 SANYO Vodafone3G V801SA
 102 .El
 103 .Sh SEE ALSO
 104 Specification can be found at:
 105 .Pp
 106 .Bl -item -compact
 107 .It
 108 .Pa http://www.nttdocomo.co.jp/corporate/technology/document/foma/index.html
 109 .It
 110 .Pa http://www.mcpc-jp.org/doclist.htm
 111 .El
 112 .Pp
 113 .Xr tty 4 ,
 114 .Xr ucom 4 ,
 115 .Xr umodem 4 ,
 116 .Xr usb 4
 117 .Sh HISTORY
 118 The
 119 .Nm
 120 driver
 121 appeared in
 122 .Fx 7.0 ,
 123 partly derived from the
 124 .Xr umodem 4
 125 code.
 126 .Sh BUGS
 127 Interfaces with multiplexed commands and data and interfaces with
 128 commands only are supported.