<!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.h 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.h</h1><a href="probe_8h.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.h</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">#ifndef __BARRY_PROBE_H__</span>
<a name="l00023"></a>00023 <span class="preprocessor"></span><span class="preprocessor">#define __BARRY_PROBE_H__</span>
<a name="l00024"></a>00024 <span class="preprocessor"></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="dll_8h.html" title="Macros for handling DLL/library API visibility.">dll.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="usbwrap_8h.html" title="USB API wrapper.">usbwrap.h</a>"</span>
<a name="l00027"></a>00027 <span class="preprocessor">#include "<a class="code" href="pin_8h.html" title="class for device PIN notation">pin.h</a>"</span>
<a name="l00028"></a>00028 <span class="preprocessor">#include <vector></span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <iosfwd></span>
<a name="l00030"></a>00030 <span class="preprocessor">#include <stdint.h></span>
<a name="l00031"></a>00031
<a name="l00032"></a>00032 <span class="keyword">namespace </span>Barry {
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">class </span>Probe;
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="keyword">struct </span>BXEXPORT ProbeResult
<a name="l00037"></a>00037 {
<a name="l00038"></a>00038 <span class="keyword">friend</span> <span class="keyword">class </span>Probe;
<a name="l00039"></a>00039
<a name="l00040"></a>00040 <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> m_dev;
<a name="l00041"></a>00041 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> m_interface;
<a name="l00042"></a>00042 Barry::Pin m_pin;
<a name="l00043"></a>00043 Usb::EndpointPair m_ep;
<a name="l00044"></a>00044 Usb::EndpointPair m_epModem;
<a name="l00045"></a>00045 <span class="comment">// Specifies if it's necessary to clear halt on the</span>
<a name="l00046"></a>00046 <span class="comment">// endpoints before using them. On some devices such</span>
<a name="l00047"></a>00047 <span class="comment">// as the 8830 it's essential to clear halt. On other</span>
<a name="l00048"></a>00048 <span class="comment">// devices such as the Curve 8520 calling clear halt</span>
<a name="l00049"></a>00049 <span class="comment">// can cause them to get into a state where they drop</span>
<a name="l00050"></a>00050 <span class="comment">// packets.</span>
<a name="l00051"></a>00051 <span class="keywordtype">bool</span> m_needClearHalt;
<a name="l00052"></a>00052 <span class="comment">// Specifies if it's necessary to call usb_set_altinterface()</span>
<a name="l00053"></a>00053 <span class="comment">// before attempting to use the end points for this device.</span>
<a name="l00054"></a>00054 <span class="comment">//</span>
<a name="l00055"></a>00055 <span class="comment">// This can help to re-synchronize the state between the USB</span>
<a name="l00056"></a>00056 <span class="comment">// host and the device. However it can also cause usb-storage</span>
<a name="l00057"></a>00057 <span class="comment">// URBs to be lost on some device, so it's only used as a</span>
<a name="l00058"></a>00058 <span class="comment">// last resort.</span>
<a name="l00059"></a>00059 <span class="keywordtype">bool</span> m_needSetAltInterface;
<a name="l00060"></a>00060 uint8_t m_zeroSocketSequence;
<a name="l00061"></a>00061 std::string m_description;
<a name="l00062"></a>00062
<a name="l00063"></a>00063 <span class="comment">// data from a possible ConfigFile (filled in automatically by</span>
<a name="l00064"></a>00064 <span class="comment">// the probe code if available)</span>
<a name="l00065"></a>00065 std::string m_cfgDeviceName;
<a name="l00066"></a>00066
<a name="l00067"></a>00067 <span class="keyword">private</span>:
<a name="l00068"></a>00068 <span class="comment">// All ProbeResult objects should come from Probe, therefore</span>
<a name="l00069"></a>00069 <span class="comment">// this constructor is private to force the issue.</span>
<a name="l00070"></a>00070 ProbeResult()
<a name="l00071"></a>00071 : m_dev(0), m_interface(0), m_pin(0)
<a name="l00072"></a>00072 , m_needClearHalt(false), m_needSetAltInterface(false)
<a name="l00073"></a>00073 , m_zeroSocketSequence(0)
<a name="l00074"></a>00074 {}
<a name="l00075"></a>00075
<a name="l00076"></a>00076 <span class="keyword">public</span>:
<a name="l00077"></a>00077 <span class="keywordtype">void</span> DumpAll(std::ostream &os) <span class="keyword">const</span>;
<a name="l00078"></a>00078 <span class="keywordtype">bool</span> HasIpModem()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_epModem.IsComplete(); }
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="keywordtype">bool</span> operator==(<span class="keyword">const</span> Barry::Pin &pin)<span class="keyword"> const</span>
<a name="l00081"></a>00081 <span class="keyword"> </span>{
<a name="l00082"></a>00082 <span class="keywordflow">return</span> m_pin == pin;
<a name="l00083"></a>00083 }
<a name="l00084"></a>00084 };
<a name="l00085"></a>00085
<a name="l00086"></a>00086 BXEXPORT std::ostream& operator<< (std::ostream &os, <span class="keyword">const</span> ProbeResult &pr);
<a name="l00087"></a>00087
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keyword">class </span>BXEXPORT Probe
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 <span class="keyword">public</span>:
<a name="l00092"></a>00092 <span class="keyword">typedef</span> std::vector<ProbeResult> Results;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keyword">private</span>:
<a name="l00095"></a>00095 Results m_results;
<a name="l00096"></a>00096
<a name="l00097"></a>00097 std::vector<std::string> m_fail_msgs;
<a name="l00098"></a>00098 <span class="keywordtype">int</span> m_fail_count;
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="keywordtype">bool</span> m_epp_override;
<a name="l00101"></a>00101 Usb::EndpointPair m_epp;
<a name="l00102"></a>00102
<a name="l00103"></a>00103 BXLOCAL <span class="keywordtype">bool</span> CheckSize(<span class="keyword">const</span> Data &data, <span class="keywordtype">unsigned</span> <span class="keywordtype">int</span> required);
<a name="l00104"></a>00104 BXLOCAL <span class="keywordtype">bool</span> ParsePIN(<span class="keyword">const</span> Data &data, uint32_t &pin);
<a name="l00105"></a>00105 BXLOCAL <span class="keywordtype">bool</span> ParseDesc(<span class="keyword">const</span> Data &data, std::string &desc);
<a name="l00106"></a>00106
<a name="l00107"></a>00107 <span class="keyword">protected</span>:
<a name="l00108"></a>00108 <span class="keywordtype">void</span> ProbeMatching(<span class="keywordtype">int</span> vendor, <span class="keywordtype">int</span> product,
<a name="l00109"></a>00109 <span class="keyword">const</span> <span class="keywordtype">char</span> *busname, <span class="keyword">const</span> <span class="keywordtype">char</span> *devname);
<a name="l00110"></a>00110 <span class="keywordtype">void</span> 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="l00111"></a>00111 <span class="keywordtype">void</span> ProbeDeviceEndpoints(Usb::Device &dev, Usb::EndpointDiscovery &ed, ProbeResult &result);
<a name="l00112"></a>00112 <span class="keywordtype">bool</span> ProbePair(Usb::Device &dev, <span class="keyword">const</span> Usb::EndpointPair &ep,
<a name="l00113"></a>00113 uint32_t &pin, std::string &desc, uint8_t &zeroSocketSequence,
<a name="l00114"></a>00114 <span class="keywordtype">bool</span> &needClearHalt);
<a name="l00115"></a>00115 <span class="keywordtype">bool</span> ProbeModem(Usb::Device &dev, <span class="keyword">const</span> Usb::EndpointPair &ep);
<a name="l00116"></a>00116
<a name="l00117"></a>00117 <span class="keyword">public</span>:
<a name="l00118"></a>00118 Probe(<span class="keyword">const</span> <span class="keywordtype">char</span> *busname = 0, <span class="keyword">const</span> <span class="keywordtype">char</span> *devname = 0,
<a name="l00119"></a>00119 <span class="keyword">const</span> Usb::EndpointPair *epp = 0);
<a name="l00120"></a>00120
<a name="l00121"></a>00121 <span class="keyword">const</span> Results& GetResults()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_results; }
<a name="l00122"></a>00122
<a name="l00123"></a>00123 <span class="keywordtype">int</span> GetCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_results.size(); }
<a name="l00124"></a>00124 <span class="keywordtype">int</span> GetFailCount()<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_fail_count; }
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="keyword">const</span> std::string& GetFailMsg(<span class="keywordtype">int</span> index)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_fail_msgs.at(index); }
<a name="l00127"></a>00127 <span class="keyword">const</span> ProbeResult& Get(<span class="keywordtype">int</span> index)<span class="keyword"> const </span>{ <span class="keywordflow">return</span> m_results.at(index); }
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="keywordtype">int</span> FindActive(Barry::Pin pin = 0) <span class="keyword">const</span>; <span class="comment">// returns -1 if pin not found</span>
<a name="l00130"></a>00130 <span class="comment">// or if no devices</span>
<a name="l00131"></a>00131 <span class="keyword">static</span> <span class="keywordtype">int</span> FindActive(<span class="keyword">const</span> Results &results, Barry::Pin pin = 0);
<a name="l00132"></a>00132 <span class="keyword">static</span> <span class="keywordtype">int</span> Find(<span class="keyword">const</span> Results &results, Barry::Pin pin = 0);
<a name="l00133"></a>00133 };
<a name="l00134"></a>00134
<a name="l00135"></a>00135
<a name="l00136"></a>00136 } <span class="comment">// namespace Barry</span>
<a name="l00137"></a>00137
<a name="l00138"></a>00138 <span class="preprocessor">#endif</span>
<a name="l00139"></a>00139 <span class="preprocessor"></span>
</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>
