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