<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=UTF-8">
<title>Barry: probe.cc Source File</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.5.6 -->
<div class="navigation" id="top">
<div class="tabs">
<ul>
<li><a href="index.html"><span>Main Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="namespaces.html"><span>Namespaces</span></a></li>
<li><a href="classes.html"><span>Classes</span></a></li>
<li class="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_3e14c0bb4416cf979afc3165665fc916.html">src</a>
</div>
</div>
<div class="contents">
<h1>probe.cc</h1><a href="probe_8cc.html">Go to the documentation of this file.</a><div class="fragment"><pre class="fragment"><a name="l00001"></a>00001 <span class="comment">///</span>
<a name="l00002"></a>00002 <span class="comment"></span><span class="comment">/// \file probe.cc</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// USB Blackberry detection routines</span>
<a name="l00004"></a>00004 <span class="comment"></span><span class="comment">///</span>
<a name="l00005"></a>00005 <span class="comment"></span>
<a name="l00006"></a>00006 <span class="comment">/*</span>
<a name="l00007"></a>00007 <span class="comment"> Copyright (C) 2005-2011, Net Direct Inc. (http://www.netdirect.ca/)</span>
<a name="l00008"></a>00008 <span class="comment"></span>
<a name="l00009"></a>00009 <span class="comment"> This program is free software; you can redistribute it and/or modify</span>
<a name="l00010"></a>00010 <span class="comment"> it under the terms of the GNU General Public License as published by</span>
<a name="l00011"></a>00011 <span class="comment"> the Free Software Foundation; either version 2 of the License, or</span>
<a name="l00012"></a>00012 <span class="comment"> (at your option) any later version.</span>
<a name="l00013"></a>00013 <span class="comment"></span>
<a name="l00014"></a>00014 <span class="comment"> This program is distributed in the hope that it will be useful,</span>
<a name="l00015"></a>00015 <span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span>
<a name="l00016"></a>00016 <span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.</span>
<a name="l00017"></a>00017 <span class="comment"></span>
<a name="l00018"></a>00018 <span class="comment"> See the GNU General Public License in the COPYING file at the</span>
<a name="l00019"></a>00019 <span class="comment"> root directory of this project for more details.</span>
<a name="l00020"></a>00020 <span class="comment">*/</span>
<a name="l00021"></a>00021
<a name="l00022"></a>00022 <span class="preprocessor">#include "<a class="code" href="common_8h.html" title="General header for the Barry library.">common.h</a>"</span>
<a name="l00023"></a>00023 <span class="preprocessor">#include "<a class="code" href="probe_8h.html" title="USB Blackberry detection routines.">probe.h</a>"</span>
<a name="l00024"></a>00024 <span class="preprocessor">#include "<a class="code" href="usbwrap_8h.html" title="USB API wrapper.">usbwrap.h</a>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="data_8h.html" title="Class to deal with pre-saved data files.">data.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="endian_8h.html" title="Endian conversion macros.">endian.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="error_8h.html" title="Common exception classes for the Barry library.">error.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include "debug.h"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include "<a class="code" href="packet_8h.html" title="Low level protocol packet builder class.">packet.h</a>"</span>
<a name="l00030"></a>00030 <span class="preprocessor">#include "<a class="code" href="socket_8h.html" title="Class wrapper to encapsulate the Blackberry USB logical socket.">socket.h</a>"</span>
<a name="l00031"></a>00031 <span class="preprocessor">#include "<a class="code" href="protocol_8h.html" title="USB Blackberry bulk protocol API constants.">protocol.h</a>"</span>
<a name="l00032"></a>00032 <span class="preprocessor">#include "<a class="code" href="record-internal_8h.html" title="Support functions, types, and templates for the general record parsing classes in...">record-internal.h</a>"</span>
<a name="l00033"></a>00033 <span class="preprocessor">#include "<a class="code" href="strnlen_8h.html" title="Header for strnlen() call, for systems that don&#39;t have GNU.">strnlen.h</a>"</span>
<a name="l00034"></a>00034 <span class="preprocessor">#include "<a class="code" href="configfile_8h.html" title="Barry configuraion class, for one device PIN.">configfile.h</a>"</span>
<a name="l00035"></a>00035 <span class="preprocessor">#include "platform.h"</span>
<a name="l00036"></a>00036 <span class="preprocessor">#include <iomanip></span>
<a name="l00037"></a>00037 <span class="preprocessor">#include <errno.h></span>
<a name="l00038"></a>00038 <span class="preprocessor">#include <string.h></span>
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <span class="keyword">using namespace </span>Usb;
<a name="l00041"></a>00041
<a name="l00042"></a>00042 <span class="keyword">namespace </span>Barry {
<a name="l00043"></a>00043
<a name="l00044"></a>00044 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Intro_Sends[][32] = {
<a name="l00045"></a>00045 <span class="comment">// packet #1</span>
<a name="l00046"></a>00046 { 0x00, 0x00, 0x10, 0x00, 0x01, 0xff, 0x00, 0x00,
<a name="l00047"></a>00047 0xa8, 0x18, 0xda, 0x8d, 0x6c, 0x02, 0x00, 0x00 }
<a name="l00048"></a>00048 };
<a name="l00049"></a>00049
<a name="l00050"></a>00050
<a name="l00051"></a>00051 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> Intro_Receives[][32] = {
<a name="l00052"></a>00052 <span class="comment">// response to packet #1</span>
<a name="l00053"></a>00053 { 0x00, 0x00, 0x10, 0x00, 0x02, 0xff, 0x00, 0x00,
<a name="l00054"></a>00054 0xa8, 0x18, 0xda, 0x8d, 0x6c, 0x02, 0x00, 0x00 }
<a name="l00055"></a>00055 };
<a name="l00056"></a>00056
<a name="l00057"></a>00057 <span class="keyword">namespace </span>{
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> GetSize(<span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *packet)
<a name="l00060"></a>00060 {
<a name="l00061"></a>00061 uint16_t size = *((uint16_t *)&packet[2]);
<a name="l00062"></a>00062 <span class="keywordflow">return</span> btohs(size);
<a name="l00063"></a>00063 }
<a name="l00064"></a>00064
<a name="l00065"></a>00065 <span class="keywordtype">bool</span> Intro(<span class="keywordtype">int</span> IntroIndex, <span class="keyword">const</span> EndpointPair &ep, Device &dev, Data &response)
<a name="l00066"></a>00066 {
<a name="l00067"></a>00067 dev.BulkWrite(ep.write, Intro_Sends[IntroIndex],
<a name="l00068"></a>00068 GetSize(Intro_Sends[IntroIndex]));
<a name="l00069"></a>00069 <span class="keywordflow">try</span> {
<a name="l00070"></a>00070 dev.BulkRead(ep.read, response, 500);
<a name="l00071"></a>00071 }
<a name="l00072"></a>00072 <span class="keywordflow">catch</span>( Usb::Timeout &to ) {
<a name="l00073"></a>00073 ddout(<span class="stringliteral">"BulkRead: "</span> << to.what());
<a name="l00074"></a>00074 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00075"></a>00075 }
<a name="l00076"></a>00076 ddout(<span class="stringliteral">"BulkRead ("</span> << (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>)ep.read << <span class="stringliteral">"):\n"</span> << response);
<a name="l00077"></a>00077 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079
<a name="l00080"></a>00080 } <span class="comment">// anonymous namespace</span>
<a name="l00081"></a>00081
<a name="l00082"></a>00082
<a name="l00083"></a>00083 <span class="keywordtype">bool</span> Probe::CheckSize(<span class="keyword">const</span> Data &data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> required)
<a name="l00084"></a>00084 {
<a name="l00085"></a>00085 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *pd = data.GetData();
<a name="l00086"></a>00086
<a name="l00087"></a>00087 <span class="keywordflow">if</span>( GetSize(pd) != (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) data.GetSize() ||
<a name="l00088"></a>00088 data.GetSize() < required ||
<a name="l00089"></a>00089 pd[4] != SB_COMMAND_FETCHED_ATTRIBUTE )
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 dout(<span class="stringliteral">"Probe: Parse data failure: GetSize(pd): "</span> << GetSize(pd)
<a name="l00092"></a>00092 << <span class="stringliteral">", data.GetSize(): "</span> << data.GetSize()
<a name="l00093"></a>00093 << <span class="stringliteral">", pd[4]: "</span> << (<span class="keywordtype">unsigned</span> int) pd[4]);
<a name="l00094"></a>00094 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00095"></a>00095 }
<a name="l00096"></a>00096
<a name="l00097"></a>00097 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="keywordtype">bool</span> Probe::ParsePIN(<span class="keyword">const</span> Data &data, uint32_t &pin)
<a name="l00101"></a>00101 {
<a name="l00102"></a>00102 <span class="comment">// validate response data</span>
<a name="l00103"></a>00103 <span class="keyword">const</span> <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> *pd = data.GetData();
<a name="l00104"></a>00104
<a name="l00105"></a>00105 <span class="keywordflow">if</span>( !CheckSize(data, 0x14) )
<a name="l00106"></a>00106 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00107"></a>00107
<a name="l00108"></a>00108 <span class="comment">// capture the PIN</span>
<a name="l00109"></a>00109 pin = btohl(*((uint32_t *) &pd[16]));
<a name="l00110"></a>00110
<a name="l00111"></a>00111 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00112"></a>00112 }
<a name="l00113"></a>00113
<a name="l00114"></a>00114 <span class="keywordtype">bool</span> Probe::ParseDesc(<span class="keyword">const</span> Data &data, std::string &desc)
<a name="l00115"></a>00115 {
<a name="l00116"></a>00116 <span class="keywordflow">if</span>( !CheckSize(data, 29) )
<a name="l00117"></a>00117 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00118"></a>00118
<a name="l00119"></a>00119 <span class="comment">// capture the description</span>
<a name="l00120"></a>00120 <span class="keyword">const</span> <span class="keywordtype">char</span> *d = (<span class="keyword">const</span> <span class="keywordtype">char</span>*) &data.GetData()[28];
<a name="l00121"></a>00121 <span class="keywordtype">int</span> maxlen = data.GetSize() - 28;
<a name="l00122"></a>00122 desc.assign(d, strnlen(d, maxlen));
<a name="l00123"></a>00123
<a name="l00124"></a>00124 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00125"></a>00125 }
<a name="l00126"></a>00126
<a name="l00127"></a>00127 Probe::Probe(<span class="keyword">const</span> <span class="keywordtype">char</span> *busname, <span class="keyword">const</span> <span class="keywordtype">char</span> *devname,
<a name="l00128"></a>00128 <span class="keyword">const</span> Usb::EndpointPair *epp)
<a name="l00129"></a>00129 : m_fail_count(0)
<a name="l00130"></a>00130 , m_epp_override(epp)
<a name="l00131"></a>00131 {
<a name="l00132"></a>00132 <span class="keywordflow">if</span>( m_epp_override ) {
<a name="l00133"></a>00133 m_epp = *epp;
<a name="l00134"></a>00134 }
<a name="l00135"></a>00135
<a name="l00136"></a>00136 <span class="comment">// let the programmer pass in "" as well as 0</span>
<a name="l00137"></a>00137 <span class="keywordflow">if</span>( busname && !strlen(busname) )
<a name="l00138"></a>00138 busname = 0;
<a name="l00139"></a>00139 <span class="keywordflow">if</span>( devname && !strlen(devname) )
<a name="l00140"></a>00140 devname = 0;
<a name="l00141"></a>00141
<a name="l00142"></a>00142 <span class="comment">// Search for standard product ID first</span>
<a name="l00143"></a>00143 ProbeMatching(VENDOR_RIM, PRODUCT_RIM_BLACKBERRY, busname, devname);
<a name="l00144"></a>00144
<a name="l00145"></a>00145 <span class="comment">// Search for Pearl devices second</span>
<a name="l00146"></a>00146 <span class="comment">//</span>
<a name="l00147"></a>00147 <span class="comment">// productID 6 devices (PRODUCT_RIM_PEARL) do not expose</span>
<a name="l00148"></a>00148 <span class="comment">// the USB class 255 interface we need, but only the</span>
<a name="l00149"></a>00149 <span class="comment">// Mass Storage one. Here we search for PRODUCT_RIM_PEARL_DUAL,</span>
<a name="l00150"></a>00150 <span class="comment">// (ID 4) which has both enabled.</span>
<a name="l00151"></a>00151 ProbeMatching(VENDOR_RIM, PRODUCT_RIM_PEARL_DUAL, busname, devname);
<a name="l00152"></a>00152 <span class="comment">// And a special case, which behaves similar to the PEARL_DUAL,</span>
<a name="l00153"></a>00153 <span class="comment">// but with a unique Product ID.</span>
<a name="l00154"></a>00154 ProbeMatching(VENDOR_RIM, PRODUCT_RIM_PEARL_8120, busname, devname);
<a name="l00155"></a>00155 <span class="comment">// And one more! The Pearl Flip</span>
<a name="l00156"></a>00156 ProbeMatching(VENDOR_RIM, PRODUCT_RIM_PEARL_FLIP, busname, devname);
<a name="l00157"></a>00157
<a name="l00158"></a>00158 <span class="comment">// And one more time, for the Blackberry Storm</span>
<a name="l00159"></a>00159 ProbeMatching(VENDOR_RIM, PRODUCT_RIM_STORM, busname, devname);
<a name="l00160"></a>00160 }
<a name="l00161"></a>00161
<a name="l00162"></a>00162 <span class="keywordtype">void</span> Probe::ProbeMatching(<span class="keywordtype">int</span> vendor, <span class="keywordtype">int</span> product,
<a name="l00163"></a>00163 <span class="keyword">const</span> <span class="keywordtype">char</span> *busname, <span class="keyword">const</span> <span class="keywordtype">char</span> *devname)
<a name="l00164"></a>00164 {
<a name="l00165"></a>00165 <a class="code" href="namespaceUsb.html#6d445b3f5ddb92da82207f62e7d9494f" title="Typedefs used by the wrapper class, in the hope to make it easier to switch from...">Usb::DeviceIDType</a> devid;
<a name="l00166"></a>00166
<a name="l00167"></a>00167 Match match(vendor, product, busname, devname);
<a name="l00168"></a>00168 <span class="keywordflow">while</span>( match.next_device(&devid) ) <span class="keywordflow">try</span> {
<a name="l00169"></a>00169 ProbeDevice(devid);
<a name="l00170"></a>00170 }
<a name="l00171"></a>00171 <span class="keywordflow">catch</span>( <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Usb::Error</a> &e ) {
<a name="l00172"></a>00172 dout(<span class="stringliteral">"Usb::Error exception caught: "</span> << e.what());
<a name="l00173"></a>00173 <span class="keywordflow">if</span>( e.<a class="code" href="classUsb_1_1Error.html#ba0421cca3a83c2e53c9a4a1887cc1cc">libusb_errcode</a>() == -EBUSY ) {
<a name="l00174"></a>00174 m_fail_count++;
<a name="l00175"></a>00175 m_fail_msgs.push_back(e.what());
<a name="l00176"></a>00176 }
<a name="l00177"></a>00177 <span class="keywordflow">else</span> {
<a name="l00178"></a>00178 <span class="keywordflow">throw</span>;
<a name="l00179"></a>00179 }
<a name="l00180"></a>00180 }
<a name="l00181"></a>00181 }
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="keywordtype">void</span> Probe::ProbeDevice(<a class="code" href="namespaceUsb.html#6d445b3f5ddb92da82207f62e7d9494f" title="Typedefs used by the wrapper class, in the hope to make it easier to switch from...">Usb::DeviceIDType</a> devid)
<a name="l00184"></a>00184 {
<a name="l00185"></a>00185 <span class="comment">// skip if we can't properly discover device config</span>
<a name="l00186"></a>00186 DeviceDiscovery discover(devid);
<a name="l00187"></a>00187 ConfigDesc &config = discover.configs[BLACKBERRY_CONFIGURATION];
<a name="l00188"></a>00188
<a name="l00189"></a>00189 <span class="comment">// search for interface class</span>
<a name="l00190"></a>00190 InterfaceDiscovery::base_type::iterator idi = config.interfaces.begin();
<a name="l00191"></a>00191 <span class="keywordflow">for</span>( ; idi != config.interfaces.end(); idi++ ) {
<a name="l00192"></a>00192 <span class="keywordflow">if</span>( idi->second.desc.bInterfaceClass == BLACKBERRY_DB_CLASS )
<a name="l00193"></a>00193 <span class="keywordflow">break</span>;
<a name="l00194"></a>00194 }
<a name="l00195"></a>00195 <span class="keywordflow">if</span>( idi == config.interfaces.end() ) {
<a name="l00196"></a>00196 dout(<span class="stringliteral">"Probe: Interface with BLACKBERRY_DB_CLASS ("</span>
<a name="l00197"></a>00197 << BLACKBERRY_DB_CLASS << <span class="stringliteral">") not found."</span>);
<a name="l00198"></a>00198 <span class="keywordflow">return</span>; <span class="comment">// not found</span>
<a name="l00199"></a>00199 }
<a name="l00200"></a>00200
<a name="l00201"></a>00201 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> InterfaceNumber = idi->second.desc.bInterfaceNumber;
<a name="l00202"></a>00202 dout(<span class="stringliteral">"Probe: using InterfaceNumber: "</span> << (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) InterfaceNumber);
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <span class="comment">// check endpoint validity</span>
<a name="l00205"></a>00205 EndpointDiscovery &ed = config.interfaces[InterfaceNumber].endpoints;
<a name="l00206"></a>00206 <span class="keywordflow">if</span>( !ed.IsValid() || ed.GetEndpointPairs().size() == 0 ) {
<a name="l00207"></a>00207 dout(<span class="stringliteral">"Probe: endpoint invalid. ed.IsValud() == "</span>
<a name="l00208"></a>00208 << (ed.IsValid() ? <span class="stringliteral">"true"</span> : <span class="stringliteral">"false"</span>)
<a name="l00209"></a>00209 << <span class="stringliteral">", ed.GetEndpointPairs().size() == "</span>
<a name="l00210"></a>00210 << ed.GetEndpointPairs().size());
<a name="l00211"></a>00211 <span class="keywordflow">return</span>;
<a name="l00212"></a>00212 }
<a name="l00213"></a>00213
<a name="l00214"></a>00214 ProbeResult result;
<a name="l00215"></a>00215 result.m_dev = devid;
<a name="l00216"></a>00216 result.m_interface = InterfaceNumber;
<a name="l00217"></a>00217 result.m_zeroSocketSequence = 0;
<a name="l00218"></a>00218
<a name="l00219"></a>00219 <span class="comment">// open device</span>
<a name="l00220"></a>00220 Device dev(devid);
<a name="l00221"></a>00221 <span class="comment">// dev.Reset();</span>
<a name="l00222"></a>00222 <span class="comment">// sleep(5);</span>
<a name="l00223"></a>00223
<a name="l00224"></a>00224 <span class="comment">// make sure we're talking to the right config</span>
<a name="l00225"></a>00225 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> cfg;
<a name="l00226"></a>00226 <span class="keywordflow">if</span>( !dev.GetConfiguration(cfg) )
<a name="l00227"></a>00227 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Usb::Error</a>(dev.GetLastError(),
<a name="l00228"></a>00228 <span class="stringliteral">"Probe: GetConfiguration failed"</span>);
<a name="l00229"></a>00229 <span class="keywordflow">if</span>( cfg != BLACKBERRY_CONFIGURATION || MUST_SET_CONFIGURATION ) {
<a name="l00230"></a>00230 <span class="keywordflow">if</span>( !dev.SetConfiguration(BLACKBERRY_CONFIGURATION) )
<a name="l00231"></a>00231 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Usb::Error</a>(dev.GetLastError(),
<a name="l00232"></a>00232 <span class="stringliteral">"Probe: SetConfiguration failed"</span>);
<a name="l00233"></a>00233 }
<a name="l00234"></a>00234
<a name="l00235"></a>00235 <span class="comment">// open interface</span>
<a name="l00236"></a>00236 Interface iface(dev, InterfaceNumber);
<a name="l00237"></a>00237
<a name="l00238"></a>00238 <span class="comment">// Try the initial probing of endpoints</span>
<a name="l00239"></a>00239 ProbeDeviceEndpoints(dev, ed, result);
<a name="l00240"></a>00240
<a name="l00241"></a>00241 <span class="keywordflow">if</span>( !result.m_ep.IsComplete() ) {
<a name="l00242"></a>00242 <span class="comment">// Probing of end-points failed, so try reprobing</span>
<a name="l00243"></a>00243 <span class="comment">// after calling usb_set_altinterface().</span>
<a name="l00244"></a>00244 <span class="comment">//</span>
<a name="l00245"></a>00245 <span class="comment">// Calling usb_set_altinterface() should be harmless</span>
<a name="l00246"></a>00246 <span class="comment">// and can help the host and device to synchronize the</span>
<a name="l00247"></a>00247 <span class="comment">// USB state, especially on FreeBSD and Mac OS X.</span>
<a name="l00248"></a>00248 <span class="comment">// However it can cause usb-storage URBs to be lost</span>
<a name="l00249"></a>00249 <span class="comment">// on some devices, so is only used if necessary.</span>
<a name="l00250"></a>00250 dout(<span class="stringliteral">"Probe: probing endpoints failed, retrying after setting alternate interface"</span>);
<a name="l00251"></a>00251 dev.SetAltInterface(InterfaceNumber);
<a name="l00252"></a>00252 result.m_needSetAltInterface = <span class="keyword">true</span>;
<a name="l00253"></a>00253 ProbeDeviceEndpoints(dev, ed, result);
<a name="l00254"></a>00254 }
<a name="l00255"></a>00255
<a name="l00256"></a>00256 <span class="comment">// add to list</span>
<a name="l00257"></a>00257 <span class="keywordflow">if</span>( result.m_ep.IsComplete() ) {
<a name="l00258"></a>00258 <span class="comment">// before adding to list, try to load the device's</span>
<a name="l00259"></a>00259 <span class="comment">// friendly name from the configfile... but don't</span>
<a name="l00260"></a>00260 <span class="comment">// fail if we can't do it</span>
<a name="l00261"></a>00261 <span class="keywordflow">try</span> {
<a name="l00262"></a>00262 ConfigFile cfg(result.m_pin);
<a name="l00263"></a>00263 result.m_cfgDeviceName = cfg.GetDeviceName();
<a name="l00264"></a>00264 }
<a name="l00265"></a>00265 <span class="keywordflow">catch</span>( <a class="code" href="classBarry_1_1ConfigFileError.html" title="Thrown by the ConfigFile class when encountering a serious system error while loading...">Barry::ConfigFileError</a> & ) {
<a name="l00266"></a>00266 <span class="comment">// ignore...</span>
<a name="l00267"></a>00267 }
<a name="l00268"></a>00268
<a name="l00269"></a>00269 m_results.push_back(result);
<a name="l00270"></a>00270 ddout(<span class="stringliteral">"Using ReadEndpoint: "</span> << (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>)result.m_ep.read);
<a name="l00271"></a>00271 ddout(<span class="stringliteral">" WriteEndpoint: "</span> << (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>)result.m_ep.write);
<a name="l00272"></a>00272 }
<a name="l00273"></a>00273 <span class="keywordflow">else</span> {
<a name="l00274"></a>00274 ddout(<span class="stringliteral">"Unable to discover endpoint pair for one device."</span>);
<a name="l00275"></a>00275 }
<a name="l00276"></a>00276 }
<a name="l00277"></a>00277
<a name="l00278"></a>00278 <span class="keywordtype">void</span> Probe::ProbeDeviceEndpoints(Device &dev, EndpointDiscovery &ed, ProbeResult &result)
<a name="l00279"></a>00279 {
<a name="l00280"></a>00280 <span class="keywordflow">if</span>( m_epp_override ) {
<a name="l00281"></a>00281 <span class="comment">// user has given us endpoints to try... so try them</span>
<a name="l00282"></a>00282 uint32_t pin;
<a name="l00283"></a>00283 uint8_t zeroSocketSequence;
<a name="l00284"></a>00284 std::string desc;
<a name="l00285"></a>00285 <span class="keywordtype">bool</span> needClearHalt;
<a name="l00286"></a>00286 <span class="keywordflow">if</span>( ProbePair(dev, m_epp, pin, desc, zeroSocketSequence, needClearHalt) ) {
<a name="l00287"></a>00287 <span class="comment">// looks good, finish filling out the result</span>
<a name="l00288"></a>00288 result.m_ep = m_epp;
<a name="l00289"></a>00289 result.m_pin = pin;
<a name="l00290"></a>00290 result.m_description = desc;
<a name="l00291"></a>00291 result.m_zeroSocketSequence = zeroSocketSequence;
<a name="l00292"></a>00292 result.m_needClearHalt = needClearHalt;
<a name="l00293"></a>00293 }
<a name="l00294"></a>00294 }
<a name="l00295"></a>00295 <span class="keywordflow">else</span> {
<a name="l00296"></a>00296 <span class="comment">// find the first bulk read/write endpoint pair that answers</span>
<a name="l00297"></a>00297 <span class="comment">// to our probe commands</span>
<a name="l00298"></a>00298 <span class="comment">// Start with second pair, since evidence indicates the later pairs</span>
<a name="l00299"></a>00299 <span class="comment">// are the ones we need.</span>
<a name="l00300"></a>00300 <span class="keywordtype">size_t</span> i;
<a name="l00301"></a>00301 <span class="keywordflow">for</span>(i = ed.GetEndpointPairs().size() > 1 ? 1 : 0;
<a name="l00302"></a>00302 i < ed.GetEndpointPairs().size();
<a name="l00303"></a>00303 i++ )
<a name="l00304"></a>00304 {
<a name="l00305"></a>00305 <span class="keyword">const</span> EndpointPair &ep = ed.GetEndpointPairs()[i];
<a name="l00306"></a>00306 <span class="keywordflow">if</span>( ep.type == USB_ENDPOINT_TYPE_BULK ) {
<a name="l00307"></a>00307
<a name="l00308"></a>00308 uint32_t pin;
<a name="l00309"></a>00309 uint8_t zeroSocketSequence;
<a name="l00310"></a>00310 std::string desc;
<a name="l00311"></a>00311 <span class="keywordtype">bool</span> needClearHalt;
<a name="l00312"></a>00312 <span class="keywordflow">if</span>( ProbePair(dev, ep, pin, desc, zeroSocketSequence, needClearHalt) ) {
<a name="l00313"></a>00313 result.m_ep = ep;
<a name="l00314"></a>00314 result.m_pin = pin;
<a name="l00315"></a>00315 result.m_description = desc;
<a name="l00316"></a>00316 result.m_zeroSocketSequence = zeroSocketSequence;
<a name="l00317"></a>00317 result.m_needClearHalt = needClearHalt;
<a name="l00318"></a>00318 <span class="keywordflow">break</span>;
<a name="l00319"></a>00319 }
<a name="l00320"></a>00320 }
<a name="l00321"></a>00321 <span class="keywordflow">else</span> {
<a name="l00322"></a>00322 dout(<span class="stringliteral">"Probe: Skipping non-bulk endpoint pair (offset: "</span>
<a name="l00323"></a>00323 << i-1 << <span class="stringliteral">") "</span>);
<a name="l00324"></a>00324 }
<a name="l00325"></a>00325 }
<a name="l00326"></a>00326
<a name="l00327"></a>00327 <span class="comment">// check for ip modem endpoints</span>
<a name="l00328"></a>00328 i++;
<a name="l00329"></a>00329 <span class="keywordflow">if</span>( i < ed.GetEndpointPairs().size() ) {
<a name="l00330"></a>00330 <span class="keyword">const</span> EndpointPair &ep = ed.GetEndpointPairs()[i];
<a name="l00331"></a>00331 <span class="keywordflow">if</span>( ProbeModem(dev, ep) ) {
<a name="l00332"></a>00332 result.m_epModem = ep;
<a name="l00333"></a>00333 }
<a name="l00334"></a>00334 }
<a name="l00335"></a>00335 }
<a name="l00336"></a>00336 }
<a name="l00337"></a>00337
<a name="l00338"></a>00338 <span class="keywordtype">bool</span> Probe::ProbePair(Usb::Device &dev,
<a name="l00339"></a>00339 <span class="keyword">const</span> Usb::EndpointPair &ep,
<a name="l00340"></a>00340 uint32_t &pin,
<a name="l00341"></a>00341 std::string &desc,
<a name="l00342"></a>00342 uint8_t &zeroSocketSequence,
<a name="l00343"></a>00343 <span class="keywordtype">bool</span> &needClearHalt)
<a name="l00344"></a>00344 {
<a name="l00345"></a>00345 <span class="comment">// Initially assume that clear halt isn't needed as it causes some</span>
<a name="l00346"></a>00346 <span class="comment">// devices to drop packets. The suspicion is that the toggle bits</span>
<a name="l00347"></a>00347 <span class="comment">// get out of sync, but this hasn't been confirmed with hardware</span>
<a name="l00348"></a>00348 <span class="comment">// tracing.</span>
<a name="l00349"></a>00349 <span class="comment">//</span>
<a name="l00350"></a>00350 <span class="comment">// It is possible to always use clear halt, as long as SET</span>
<a name="l00351"></a>00351 <span class="comment">// INTERFACE has been sent before, via usb_set_altinterface().</span>
<a name="l00352"></a>00352 <span class="comment">// However this has the side affect that any outstanding URBs</span>
<a name="l00353"></a>00353 <span class="comment">// on other interfaces (i.e. usb-storage) timeout and lose</span>
<a name="l00354"></a>00354 <span class="comment">// their data. This is not a good thing as it can corrupt the</span>
<a name="l00355"></a>00355 <span class="comment">// file system exposed over usb-storage. This also has the</span>
<a name="l00356"></a>00356 <span class="comment">// side-affect that usb-storage issues a port reset after the</span>
<a name="l00357"></a>00357 <span class="comment">// 30 second timeout, which kills any current Barry</span>
<a name="l00358"></a>00358 <span class="comment">// connection.</span>
<a name="l00359"></a>00359 <span class="comment">//</span>
<a name="l00360"></a>00360 <span class="comment">// To further complicate matters some devices, such as the</span>
<a name="l00361"></a>00361 <span class="comment">// 8830, always need clear halt before they will respond to</span>
<a name="l00362"></a>00362 <span class="comment">// probes.</span>
<a name="l00363"></a>00363 <span class="comment">//</span>
<a name="l00364"></a>00364 <span class="comment">// So to work with all these device quirks the probe is first</span>
<a name="l00365"></a>00365 <span class="comment">// attempted without calling clear halt. If that probe fails</span>
<a name="l00366"></a>00366 <span class="comment">// then a clear halt is issued followed by a retry on the</span>
<a name="l00367"></a>00367 <span class="comment">// probing.</span>
<a name="l00368"></a>00368 needClearHalt = <span class="keyword">false</span>;
<a name="l00369"></a>00369
<a name="l00370"></a>00370 Data data;
<a name="l00371"></a>00371 dev.BulkDrain(ep.read);
<a name="l00372"></a>00372 <span class="keywordflow">if</span>( !Intro(0, ep, dev, data) ) {
<a name="l00373"></a>00373 <span class="comment">// Try clearing halt and then reprobing</span>
<a name="l00374"></a>00374 dout(<span class="stringliteral">"Probe: Intro(0) failed, retrying after clearing halt"</span>);
<a name="l00375"></a>00375 dev.ClearHalt(ep.read);
<a name="l00376"></a>00376 dev.ClearHalt(ep.write);
<a name="l00377"></a>00377 needClearHalt = <span class="keyword">true</span>;
<a name="l00378"></a>00378 <span class="comment">// Retry</span>
<a name="l00379"></a>00379 dev.BulkDrain(ep.read);
<a name="l00380"></a>00380 <span class="keywordflow">if</span>( !Intro(0, ep, dev, data) ) {
<a name="l00381"></a>00381 <span class="comment">// Still no response so fail the probe</span>
<a name="l00382"></a>00382 dout(<span class="stringliteral">"Probe: Intro(0) still failed after clearing halt"</span>);
<a name="l00383"></a>00383 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00384"></a>00384 }
<a name="l00385"></a>00385 }
<a name="l00386"></a>00386
<a name="l00387"></a>00387 SocketZero socket(dev, ep.write, ep.read);
<a name="l00388"></a>00388
<a name="l00389"></a>00389 Data send, receive;
<a name="l00390"></a>00390 ZeroPacket packet(send, receive);
<a name="l00391"></a>00391
<a name="l00392"></a>00392 <span class="comment">// unknown attribute: 0x14 / 0x01</span>
<a name="l00393"></a>00393 packet.GetAttribute(SB_OBJECT_INITIAL_UNKNOWN,
<a name="l00394"></a>00394 SB_ATTR_INITIAL_UNKNOWN);
<a name="l00395"></a>00395 socket.Send(packet);
<a name="l00396"></a>00396
<a name="l00397"></a>00397 <span class="comment">// fetch PIN</span>
<a name="l00398"></a>00398 packet.GetAttribute(SB_OBJECT_PROFILE, SB_ATTR_PROFILE_PIN);
<a name="l00399"></a>00399 socket.Send(packet);
<a name="l00400"></a>00400 <span class="keywordflow">if</span>( packet.ObjectID() != SB_OBJECT_PROFILE ||
<a name="l00401"></a>00401 packet.AttributeID() != SB_ATTR_PROFILE_PIN ||
<a name="l00402"></a>00402 !ParsePIN(receive, pin) )
<a name="l00403"></a>00403 {
<a name="l00404"></a>00404 dout(<span class="stringliteral">"Probe: unable to fetch PIN"</span>);
<a name="l00405"></a>00405 <span class="keywordflow">return</span> <span class="keyword">false</span>;
<a name="l00406"></a>00406 }
<a name="l00407"></a>00407
<a name="l00408"></a>00408 <span class="comment">// fetch Description</span>
<a name="l00409"></a>00409 packet.GetAttribute(SB_OBJECT_PROFILE, SB_ATTR_PROFILE_DESC);
<a name="l00410"></a>00410 socket.Send(packet);
<a name="l00411"></a>00411 <span class="comment">// response ObjectID does not match request... :-/</span>
<a name="l00412"></a>00412 <span class="keywordflow">if</span>( <span class="comment">// packet.ObjectID() != SB_OBJECT_PROFILE ||</span>
<a name="l00413"></a>00413 packet.AttributeID() != SB_ATTR_PROFILE_DESC ||
<a name="l00414"></a>00414 !ParseDesc(receive, desc) )
<a name="l00415"></a>00415 {
<a name="l00416"></a>00416 dout(<span class="stringliteral">"Probe: unable to fetch description"</span>);
<a name="l00417"></a>00417 }
<a name="l00418"></a>00418
<a name="l00419"></a>00419 <span class="comment">// more unknowns:</span>
<a name="l00420"></a>00420 <span class="keywordflow">for</span>( uint16_t attr = 5; attr < 9; attr++ ) {
<a name="l00421"></a>00421 packet.GetAttribute(SB_OBJECT_SOCKET_UNKNOWN, attr);
<a name="l00422"></a>00422 socket.Send(packet);
<a name="l00423"></a>00423 <span class="comment">// FIXME parse these responses, if they turn</span>
<a name="l00424"></a>00424 <span class="comment">// out to be important</span>
<a name="l00425"></a>00425 }
<a name="l00426"></a>00426
<a name="l00427"></a>00427 <span class="comment">// all info obtained!</span>
<a name="l00428"></a>00428 zeroSocketSequence = socket.GetZeroSocketSequence();
<a name="l00429"></a>00429 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00430"></a>00430 }
<a name="l00431"></a>00431
<a name="l00432"></a>00432 <span class="keywordtype">bool</span> Probe::ProbeModem(Usb::Device &dev, <span class="keyword">const</span> Usb::EndpointPair &ep)
<a name="l00433"></a>00433 {
<a name="l00434"></a>00434 <span class="comment">//</span>
<a name="l00435"></a>00435 <span class="comment">// This check is not needed for all devices. Some devices,</span>
<a name="l00436"></a>00436 <span class="comment">// like the 8700 have both the RIM_UsbSerData mode and IpModem mode.</span>
<a name="l00437"></a>00437 <span class="comment">//</span>
<a name="l00438"></a>00438 <span class="comment">// If this function is called, then we have extra endpoints,</span>
<a name="l00439"></a>00439 <span class="comment">// so might as well try them.</span>
<a name="l00440"></a>00440 <span class="comment">//</span>
<a name="l00441"></a>00441 <span class="comment">// FIXME - someday, we might wish to confirm that the endpoints</span>
<a name="l00442"></a>00442 <span class="comment">// work as a modem, and return true/false based on that test.</span>
<a name="l00443"></a>00443 <span class="comment">//</span>
<a name="l00444"></a>00444 <span class="keywordflow">return</span> <span class="keyword">true</span>;
<a name="l00445"></a>00445
<a name="l00446"></a>00446
<a name="l00447"></a>00447 <span class="comment">// Thanks to Rick Scott (XmBlackBerry:bb_usb.c) for reverse engineering this</span>
<a name="l00448"></a>00448 <span class="comment">// int num_read;</span>
<a name="l00449"></a>00449 <span class="comment">// char data[255];</span>
<a name="l00450"></a>00450 <span class="comment">// int local_errno;</span>
<a name="l00451"></a>00451 <span class="comment">//</span>
<a name="l00452"></a>00452 <span class="comment">// num_read = usb_control_msg(dev.GetHandle(),</span>
<a name="l00453"></a>00453 <span class="comment">// /* bmRequestType */ USB_ENDPOINT_IN | USB_TYPE_VENDOR | USB_RECIP_DEVICE,</span>
<a name="l00454"></a>00454 <span class="comment">// /* bRequest */ 0xa5,</span>
<a name="l00455"></a>00455 <span class="comment">// /* wValue */ 0,</span>
<a name="l00456"></a>00456 <span class="comment">// /* wIndex */ 1,</span>
<a name="l00457"></a>00457 <span class="comment">// /* data */ data,</span>
<a name="l00458"></a>00458 <span class="comment">// /* wLength */ sizeof(data),</span>
<a name="l00459"></a>00459 <span class="comment">// /* timeout */ 2000);</span>
<a name="l00460"></a>00460 <span class="comment">// local_errno = errno;</span>
<a name="l00461"></a>00461 <span class="comment">// if( num_read > 1 ) {</span>
<a name="l00462"></a>00462 <span class="comment">// if( data[0] == 0x02 ) {</span>
<a name="l00463"></a>00463 <span class="comment">// return true;</span>
<a name="l00464"></a>00464 <span class="comment">// }</span>
<a name="l00465"></a>00465 <span class="comment">// }</span>
<a name="l00466"></a>00466 <span class="comment">// return false;</span>
<a name="l00467"></a>00467 }
<a name="l00468"></a>00468
<a name="l00469"></a>00469 <span class="keywordtype">int</span> Probe::FindActive(Barry::Pin pin)<span class="keyword"> const</span>
<a name="l00470"></a>00470 <span class="keyword"></span>{
<a name="l00471"></a>00471 <span class="keywordflow">return</span> FindActive(m_results, pin);
<a name="l00472"></a>00472 }
<a name="l00473"></a>00473
<a name="l00474"></a>00474 <span class="keywordtype">int</span> Probe::FindActive(<span class="keyword">const</span> Barry::Probe::Results &results, Barry::Pin pin)
<a name="l00475"></a>00475 {
<a name="l00476"></a>00476 <span class="keywordtype">int</span> i = Find(results, pin);
<a name="l00477"></a>00477
<a name="l00478"></a>00478 <span class="keywordflow">if</span>( i == -1 && pin == 0 ) {
<a name="l00479"></a>00479 <span class="comment">// can we default to a single device?</span>
<a name="l00480"></a>00480 <span class="keywordflow">if</span>( results.size() == 1 )
<a name="l00481"></a>00481 <span class="keywordflow">return</span> 0; <span class="comment">// yes!</span>
<a name="l00482"></a>00482 }
<a name="l00483"></a>00483
<a name="l00484"></a>00484 <span class="keywordflow">return</span> i;
<a name="l00485"></a>00485 }
<a name="l00486"></a>00486
<a name="l00487"></a>00487 <span class="keywordtype">int</span> Probe::Find(<span class="keyword">const</span> Results &results, Barry::Pin pin)
<a name="l00488"></a>00488 {
<a name="l00489"></a>00489 Barry::Probe::Results::const_iterator ci = results.begin();
<a name="l00490"></a>00490 <span class="keywordflow">for</span>( <span class="keywordtype">int</span> i = 0; ci != results.end(); i++, ++ci ) {
<a name="l00491"></a>00491 <span class="keywordflow">if</span>( ci->m_pin == pin )
<a name="l00492"></a>00492 <span class="keywordflow">return</span> i;
<a name="l00493"></a>00493 }
<a name="l00494"></a>00494 <span class="comment">// PIN not found</span>
<a name="l00495"></a>00495 <span class="keywordflow">return</span> -1;
<a name="l00496"></a>00496 }
<a name="l00497"></a>00497
<a name="l00498"></a>00498 <span class="keywordtype">void</span> ProbeResult::DumpAll(std::ostream &os)<span class="keyword"> const</span>
<a name="l00499"></a>00499 <span class="keyword"></span>{
<a name="l00500"></a>00500 os << *<span class="keyword">this</span>
<a name="l00501"></a>00501 << <span class="stringliteral">", Interface: 0x"</span> << std::hex << (<span class="keywordtype">unsigned</span> int) m_interface
<a name="l00502"></a>00502 << <span class="stringliteral">", Endpoints: (read: 0x"</span> << std::hex << (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) m_ep.read
<a name="l00503"></a>00503 << <span class="stringliteral">", write: 0x"</span> << std::hex << (<span class="keywordtype">unsigned</span> int) m_ep.write
<a name="l00504"></a>00504 << <span class="stringliteral">", type: 0x"</span> << std::hex << (<span class="keywordtype">unsigned</span> <span class="keywordtype">int</span>) m_ep.type
<a name="l00505"></a>00505 << <span class="stringliteral">", ZeroSocketSequence: 0x"</span> << std::hex << (<span class="keywordtype">unsigned</span> int) m_zeroSocketSequence;
<a name="l00506"></a>00506 }
<a name="l00507"></a>00507
<a name="l00508"></a>00508 std::ostream& operator<< (std::ostream &os, <span class="keyword">const</span> ProbeResult &pr)
<a name="l00509"></a>00509 {
<a name="l00510"></a>00510 os << <span class="stringliteral">"Device ID: "</span> << pr.m_dev
<a name="l00511"></a>00511 << <span class="stringliteral">". PIN: "</span> << pr.m_pin.Str()
<a name="l00512"></a>00512 << <span class="stringliteral">", Description: "</span> << pr.m_description;
<a name="l00513"></a>00513 <span class="keywordflow">if</span>( pr.m_cfgDeviceName.size() )
<a name="l00514"></a>00514 os << <span class="stringliteral">", Name: "</span> << pr.m_cfgDeviceName;
<a name="l00515"></a>00515 <span class="keywordflow">return</span> os;
<a name="l00516"></a>00516 }
<a name="l00517"></a>00517
<a name="l00518"></a>00518 } <span class="comment">// namespace Barry</span>
<a name="l00519"></a>00519
</pre></div></div>
<hr size="1"><address style="text-align: right;"><small>Generated on Tue Mar 1 17:50:15 2011 for Barry by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.5.6 </small></address>
</body>
</html>
