summaryrefslogtreecommitdiff
path: root/static/freebsd/man4/ufoma.4 3.html
diff options
context:
space:
mode:
Diffstat (limited to 'static/freebsd/man4/ufoma.4 3.html')
-rw-r--r--static/freebsd/man4/ufoma.4 3.html117
1 files changed, 117 insertions, 0 deletions
diff --git a/static/freebsd/man4/ufoma.4 3.html b/static/freebsd/man4/ufoma.4 3.html
new file mode 100644
index 00000000..f9993978
--- /dev/null
+++ b/static/freebsd/man4/ufoma.4 3.html
@@ -0,0 +1,117 @@
+<table class="head">
+ <tr>
+ <td class="head-ltitle">UFOMA(4)</td>
+ <td class="head-vol">Device Drivers Manual</td>
+ <td class="head-rtitle">UFOMA(4)</td>
+ </tr>
+</table>
+<div class="manual-text">
+<section class="Sh">
+<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
+<p class="Pp"><code class="Nm">ufoma</code> &#x2014; <span class="Nd">USB mobile
+ phone support</span></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
+<p class="Pp">To compile this driver into the kernel, place the following lines
+ in your kernel configuration file:</p>
+<div class="Bd Pp Bd-indent"><code class="Cd">device usb</code>
+<br/>
+<code class="Cd">device ucom</code>
+<br/>
+<code class="Cd">device ufoma</code></div>
+<p class="Pp">Alternatively, to load the driver as a module at boot time, place
+ the following line in <a class="Xr">loader.conf(5)</a>:</p>
+<div class="Bd Pp Bd-indent Li">
+<pre>ufoma_load=&quot;YES&quot;</pre>
+</div>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
+<p class="Pp">The <code class="Nm">ufoma</code> driver provides support for USB
+ mobile phone terminals in the subset of the Mobile Computing Promotion
+ Consortium USB Implementation Guideline, which is adopted by FOMA, the NTT
+ DoCoMo 3G system, terminal. These are partly like CDC ACM model based
+ modems, which are supported by <a class="Xr">umodem(4)</a>, but the
+ <code class="Nm">ufoma</code> driver recognizes a specific USB descriptor
+ that describes its role and interface structure, and it will negotiate its
+ role when the device is open. They support a regular AT command set and the
+ commands can either be multiplexed with the data stream or handled through
+ separate pipes. In the latter case the AT commands have to be given on a
+ device separate from the data device.</p>
+<p class="Pp">The device is accessed through the <a class="Xr">ucom(4)</a>
+ driver which makes it behave like a <a class="Xr">tty(4)</a>.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SYSCTLS"><a class="permalink" href="#SYSCTLS">SYSCTLS</a></h1>
+<p class="Pp">These devices often have a few interface sets and these interfaces
+ have their role, sometimes multiplexed. These roles are identified with the
+ following sysctl MIBs:</p>
+<dl class="Bl-tag">
+ <dt id="dev.ucom._d.supportmode"><var class="Va">dev.ucom.%d.supportmode</var></dt>
+ <dd>The modes which are supported by the interface.</dd>
+ <dt id="dev.ucom._d.currentmode"><var class="Va">dev.ucom.%d.currentmode</var></dt>
+ <dd>Current mode of the interface.</dd>
+ <dt id="dev.ucom._d.openmode"><var class="Va">dev.ucom.%d.openmode</var></dt>
+ <dd>Mode to transit when the device is open next.</dd>
+</dl>
+The modes are as follows:
+<dl class="Bl-tag">
+ <dt id="modem"><a class="permalink" href="#modem"><code class="Li">modem</code></a></dt>
+ <dd>Accepts AT commands and go and pass packet communication data.</dd>
+ <dt id="handsfree"><a class="permalink" href="#handsfree"><code class="Li">handsfree</code></a></dt>
+ <dd>Accepts AT commands but it does not pass data.</dd>
+ <dt id="obex"><a class="permalink" href="#obex"><code class="Li">obex</code></a></dt>
+ <dd>Accepts OBEX frame which is used to exchange telephone book, etc.</dd>
+ <dt id="vendor1"><a class="permalink" href="#vendor1"><code class="Li">vendor1</code></a>,
+ <code class="Li">vendor2</code></dt>
+ <dd>Vendor specific data may be passed.</dd>
+ <dt id="deactivated"><a class="permalink" href="#deactivated"><code class="Li">deactivated</code></a></dt>
+ <dd>When an interface is recognized by the system but not used, the interface
+ will be set to this mode.</dd>
+ <dt id="unlinked"><a class="permalink" href="#unlinked"><code class="Li">unlinked</code></a></dt>
+ <dd>When an interface is not yet negotiated, the interface is in this
+ mode.</dd>
+</dl>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="HARDWARE"><a class="permalink" href="#HARDWARE">HARDWARE</a></h1>
+<p class="Pp">Devices supported by the <code class="Nm">ufoma</code> driver
+ include:</p>
+<p class="Pp"></p>
+<ul class="Bl-bullet Bl-compact">
+ <li>SHARP FOMA SH902i</li>
+ <li>KYOCERA PHS AH-K3001V (a.k.a Kyopon)</li>
+ <li>SANYO Vodafone3G V801SA</li>
+</ul>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE
+ ALSO</a></h1>
+<p class="Pp">Specification can be found at:</p>
+<p class="Pp"></p>
+<ul class="Bl-item Bl-compact">
+ <li><span class="Pa">http://www.nttdocomo.co.jp/corporate/technology/document/foma/index.html</span></li>
+ <li><span class="Pa">http://www.mcpc-jp.org/doclist.htm</span></li>
+</ul>
+<p class="Pp"><a class="Xr">tty(4)</a>, <a class="Xr">ucom(4)</a>,
+ <a class="Xr">umodem(4)</a>, <a class="Xr">usb(4)</a></p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1>
+<p class="Pp">The <code class="Nm">ufoma</code> driver appeared in
+ <span class="Ux">FreeBSD 7.0</span>, partly derived from the
+ <a class="Xr">umodem(4)</a> code.</p>
+</section>
+<section class="Sh">
+<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1>
+<p class="Pp">Interfaces with multiplexed commands and data and interfaces with
+ commands only are supported.</p>
+</section>
+</div>
+<table class="foot">
+ <tr>
+ <td class="foot-date">November 20, 2011</td>
+ <td class="foot-os">FreeBSD 15.0</td>
+ </tr>
+</table>