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 November 22, 2006
  31 .Dt UFOMA 4
  32 .Os
  33 .Sh NAME
  34 .Nm ufoma
  35 .Nd USB mobile phone support
  36 .Sh SYNOPSIS
  37 To compile this driver into the kernel,
  38 place the following lines in your
  39 kernel configuration file:
  40 .Bd -ragged -offset indent
  41 .Cd "device ufoma"
  42 .Cd "device ucom"
  43 .Ed
  44 .Pp
  45 Alternatively, to load the driver as a
  46 module at boot time, place the following line in
  47 .Xr loader.conf 5 :
  48 .Bd -literal -offset indent
  49 ufoma_load="YES"
  50 .Ed
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 driver provides support for USB mobile phone terminals in the subset of
  55 the Mobile Computing Promotion Consortium USB Implementation Guideline,
  56 which is adopted by FOMA, the NTT DoCoMo 3G system, terminal.
  57 These are partly like CDC ACM model based modems, which are supported
  58 by
  59 .Xr umodem 4 ,
  60 but the
  61 .Nm
  62 driver recognizes a specific USB descriptor that describes its role and
  63 interface structure, and it will negotiate its role when the device is open.
  64 They support a regular AT command set and
  65 the commands can either be multiplexed with the data stream
  66 or handled through separate pipes.
  67 In the latter case the AT
  68 commands have to be given on a device separate from the data device.
  69 .Pp
  70 The device is accessed through the
  71 .Xr ucom 4
  72 driver which makes it behave like a
  73 .Xr tty 4 .
  74 .Sh SYSCTLS
  75 These devices often have a few interface sets and these interfaces
  76 have their role, sometimes multiplexed.
  77 These roles are identified with the following sysctl MIBs:
  78 .Bl -tag -width indent
  79 .It Va dev.ucom.%d.supportmode
  80 The modes which are supported by the interface.
  81 .It Va dev.ucom.%d.currentmode
  82 Current mode of the interface.
  83 .It Va dev.ucom.%d.openmode
  84 Mode to transit when the device is open next.
  85 .El
  86 The modes are as follows:
  87 .Bl -tag -width indent
  88 .It Li modem
  89 Accepts AT commands and go and pass packet communication data.
  90 .It Li handsfree
  91 Accepts AT commands but it does not pass data.
  92 .It Li obex
  93 Accepts OBEX frame which is used to exchange telephone book, etc.
  94 .It Li vendor1 , vendor2
  95 Vendor specific data may be passed.
  96 .It Li deactivated
  97 When an interface is recognized by the system but not used, the interface
  98 will be set to this mode.
  99 .It Li unlinked
 100 When an interface is not yet negotiated, the interface is in this mode.
 101 .El
 102 .Sh HARDWARE
 103 Devices supported by the
 104 .Nm
 105 driver include:
 106 .Pp
 107 .Bl -bullet -compact
 108 .It
 109 SHARP FOMA SH902i
 110 .It
 111 KYOCERA PHS AH-K3001V (a.k.a Kyopon)
 112 .It
 113 SANYO Vodafone3G V801SA
 114 .El
 115 .Sh SEE ALSO
 116 Specification can be found at:
 117 .Pp
 118 .Bl -item -compact
 119 .It
 120 .Pa http://www.nttdocomo.co.jp/corporate/technology/document/foma/index.html
 121 .It
 122 .Pa http://www.mcpc-jp.org/doclist.htm
 123 .El
 124 .Pp
 125 .Xr tty 4 ,
 126 .Xr ucom 4 ,
 127 .Xr umodem 4 ,
 128 .Xr usb 4
 129 .Sh HISTORY
 130 The
 131 .Nm
 132 driver
 133 appeared in
 134 .Fx 7.0 ,
 135 partly derived from the
 136 .Xr umodem 4
 137 code.
 138 .Sh BUGS
 139 Interfaces with multiplexed commands and data and interfaces with
 140 commands only are supported.