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