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