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