<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<title>Barry: controller.cc Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.6.2-20100208 -->
<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="annotated.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="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
</ul>
</div>
<div class="navpath"><a class="el" href="dir_65781e9408669bb8d7d9c025fdb5fe86.html">src</a>
</div>
</div>
<div class="contents">
<h1>controller.cc</h1><a href="controller_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 controller.cc</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// High level Barry API class</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-2010, 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="controller_8h.html" title="High level BlackBerry API class.">controller.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="common_8h.html" title="General header for the Barry library.">common.h</a>"</span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "<a class="code" href="protocol_8h.html" title="USB Blackberry bulk protocol API constants.">protocol.h</a>"</span>
<a name="l00026"></a>00026 <span class="preprocessor">#include "<a class="code" href="protostructs_8h.html" title="USB Blackberry bulk protocol API.">protostructs.h</a>"</span>
<a name="l00027"></a>00027 <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="l00028"></a>00028 <span class="preprocessor">#include "<a class="code" href="endian_8h.html" title="Endian conversion macros.">endian.h</a>"</span>
<a name="l00029"></a>00029 <span class="preprocessor">#include <string.h></span>
<a name="l00030"></a>00030
<a name="l00031"></a>00031 <span class="preprocessor">#define __DEBUG_MODE__</span>
<a name="l00032"></a>00032 <span class="preprocessor"></span><span class="preprocessor">#include "debug.h"</span>
<a name="l00033"></a>00033
<a name="l00034"></a>00034 <span class="keyword">namespace </span>Barry {
<a name="l00035"></a>00035
<a name="l00036"></a>00036 <span class="comment">//</span>
<a name="l00037"></a>00037 <span class="comment">// Controller constructor</span>
<a name="l00038"></a>00038 <span class="comment">//</span><span class="comment"></span>
<a name="l00039"></a>00039 <span class="comment">/// Constructor for the Controller class. Requires a valid ProbeResult</span>
<a name="l00040"></a>00040 <span class="comment">/// object to find the USB device to talk to.</span>
<a name="l00041"></a>00041 <span class="comment">///</span>
<a name="l00042"></a>00042 <span class="comment">/// \param[in] device One of the ProbeResult objects from the</span>
<a name="l00043"></a>00043 <span class="comment">/// Probe class.</span>
<a name="l00044"></a>00044 <span class="comment">/// \param[in] default_timeout Override Usb::Device's default timeout</span>
<a name="l00045"></a>00045 <span class="comment">///</span>
<a name="l00046"></a><a class="code" href="classBarry_1_1Controller.html#affac40e1eb00e5cedc3f575a64828e6c">00046</a> <span class="comment"></span><a class="code" href="classBarry_1_1Controller.html#affac40e1eb00e5cedc3f575a64828e6c" title="Constructor for the Controller class.">Controller::Controller</a>(<span class="keyword">const</span> <a class="code" href="structBarry_1_1ProbeResult.html">ProbeResult</a> &device,
<a name="l00047"></a>00047 <span class="keywordtype">int</span> default_timeout)
<a name="l00048"></a>00048 : m_result(device)
<a name="l00049"></a>00049 , m_dev(device.m_dev, default_timeout)
<a name="l00050"></a>00050 , m_iface(0)
<a name="l00051"></a>00051 , m_pin(device.m_pin)
<a name="l00052"></a>00052 , m_zero(m_dev, device.m_ep.write, device.m_ep.read, device.m_zeroSocketSequence)
<a name="l00053"></a>00053 , m_queue(0)
<a name="l00054"></a>00054 {
<a name="l00055"></a>00055 dout(<span class="stringliteral">"Controller: Using non-threaded sockets"</span>);
<a name="l00056"></a>00056 SetupUsb(device);
<a name="l00057"></a>00057 }
<a name="l00058"></a>00058
<a name="l00059"></a>00059 <span class="comment">//</span>
<a name="l00060"></a>00060 <span class="comment">// Controller constructor</span>
<a name="l00061"></a>00061 <span class="comment">//</span><span class="comment"></span>
<a name="l00062"></a>00062 <span class="comment">/// Constructor for the Controller class. Requires a valid ProbeResult</span>
<a name="l00063"></a>00063 <span class="comment">/// object to find the USB device to talk to.</span>
<a name="l00064"></a>00064 <span class="comment">///</span>
<a name="l00065"></a>00065 <span class="comment">/// \param[in] device One of the ProbeResult objects from the</span>
<a name="l00066"></a>00066 <span class="comment">/// Probe class.</span>
<a name="l00067"></a>00067 <span class="comment">/// \param[in] queue Plugin router object for reading data</span>
<a name="l00068"></a>00068 <span class="comment">/// from sockets.</span>
<a name="l00069"></a>00069 <span class="comment">/// \param[in] default_timeout Override Usb::Device's default timeout</span>
<a name="l00070"></a>00070 <span class="comment">///</span>
<a name="l00071"></a><a class="code" href="classBarry_1_1Controller.html#a32fbca6195f9e4bf45419ea8d244ebdd">00071</a> <span class="comment"></span><a class="code" href="classBarry_1_1Controller.html#affac40e1eb00e5cedc3f575a64828e6c" title="Constructor for the Controller class.">Controller::Controller</a>(<span class="keyword">const</span> <a class="code" href="structBarry_1_1ProbeResult.html">ProbeResult</a> &device,
<a name="l00072"></a>00072 <a class="code" href="classBarry_1_1SocketRoutingQueue.html">SocketRoutingQueue</a> &queue,
<a name="l00073"></a>00073 <span class="keywordtype">int</span> default_timeout)
<a name="l00074"></a>00074 : m_result(device)
<a name="l00075"></a>00075 , m_dev(device.m_dev, default_timeout)
<a name="l00076"></a>00076 , m_iface(0)
<a name="l00077"></a>00077 , m_pin(device.m_pin)
<a name="l00078"></a>00078 , m_zero(queue, device.m_ep.write, device.m_zeroSocketSequence)
<a name="l00079"></a>00079 , m_queue(&queue)
<a name="l00080"></a>00080 {
<a name="l00081"></a>00081 dout(<span class="stringliteral">"Controller: Using threaded socket router"</span>);
<a name="l00082"></a>00082
<a name="l00083"></a>00083 SetupUsb(device);
<a name="l00084"></a>00084
<a name="l00085"></a>00085 <span class="comment">// set the queue to use our device</span>
<a name="l00086"></a>00086 queue.SetUsbDevice(&m_dev, device.m_ep.write, device.m_ep.read);
<a name="l00087"></a>00087 }
<a name="l00088"></a>00088
<a name="l00089"></a>00089 <span class="keywordtype">void</span> Controller::SetupUsb(<span class="keyword">const</span> <a class="code" href="structBarry_1_1ProbeResult.html">ProbeResult</a> &device)
<a name="l00090"></a>00090 {
<a name="l00091"></a>00091 <span class="keywordtype">unsigned</span> <span class="keywordtype">char</span> cfg;
<a name="l00092"></a>00092 <span class="keywordflow">if</span>( !m_dev.<a class="code" href="classUsb_1_1Device.html#ac026a4fba6d561fc2d2dc18963164092" title="Uses the GET_CONFIGURATION control message to determine the currently selected USB...">GetConfiguration</a>(cfg) )
<a name="l00093"></a>00093 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Usb::Error</a>(m_dev.GetLastError(),
<a name="l00094"></a>00094 <span class="stringliteral">"Controller: GetConfiguration failed"</span>);
<a name="l00095"></a>00095
<a name="l00096"></a>00096 <span class="keywordflow">if</span>( cfg != BLACKBERRY_CONFIGURATION ) {
<a name="l00097"></a>00097 <span class="keywordflow">if</span>( !m_dev.SetConfiguration(BLACKBERRY_CONFIGURATION) )
<a name="l00098"></a>00098 <span class="keywordflow">throw</span> <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Usb::Error</a>(m_dev.GetLastError(),
<a name="l00099"></a>00099 <span class="stringliteral">"Controller: SetConfiguration failed"</span>);
<a name="l00100"></a>00100 }
<a name="l00101"></a>00101
<a name="l00102"></a>00102 m_iface = <span class="keyword">new</span> <a class="code" href="classUsb_1_1Interface.html">Usb::Interface</a>(m_dev, device.m_interface);
<a name="l00103"></a>00103
<a name="l00104"></a>00104 m_dev.ClearHalt(device.m_ep.read);
<a name="l00105"></a>00105 m_dev.ClearHalt(device.m_ep.write);
<a name="l00106"></a>00106 }
<a name="l00107"></a>00107
<a name="l00108"></a>00108 Controller::~Controller()
<a name="l00109"></a>00109 {
<a name="l00110"></a>00110 <span class="comment">// // trap exceptions in the destructor</span>
<a name="l00111"></a>00111 <span class="comment">// try {</span>
<a name="l00112"></a>00112 <span class="comment">// // a non-default socket has been opened, close it</span>
<a name="l00113"></a>00113 <span class="comment">// m_socket.Close();</span>
<a name="l00114"></a>00114 <span class="comment">// }</span>
<a name="l00115"></a>00115 <span class="comment">// catch( std::runtime_error &re ) {</span>
<a name="l00116"></a>00116 <span class="comment">// // do nothing... log it?</span>
<a name="l00117"></a>00117 <span class="comment">// dout("Exception caught in ~Socket: " << re.what());</span>
<a name="l00118"></a>00118 <span class="comment">// }</span>
<a name="l00119"></a>00119
<a name="l00120"></a>00120 <span class="comment">// detach the router from our device</span>
<a name="l00121"></a>00121 <span class="keywordflow">if</span>( m_queue ) {
<a name="l00122"></a>00122 m_queue->ClearUsbDevice();
<a name="l00123"></a>00123 m_queue = 0;
<a name="l00124"></a>00124 }
<a name="l00125"></a>00125
<a name="l00126"></a>00126 <span class="comment">// cleanup the interface</span>
<a name="l00127"></a>00127 <span class="keyword">delete</span> m_iface;
<a name="l00128"></a>00128
<a name="l00129"></a>00129 <span class="comment">// this happens when for some reason the Desktop mode</span>
<a name="l00130"></a>00130 <span class="comment">// is not fully opened, but the device has already recommended</span>
<a name="l00131"></a>00131 <span class="comment">// a socket to open... in this case, reset the device</span>
<a name="l00132"></a>00132 <span class="comment">// in the hopes that on next open, it will be in a</span>
<a name="l00133"></a>00133 <span class="comment">// recognizable state.</span>
<a name="l00134"></a>00134 <span class="comment">//</span>
<a name="l00135"></a>00135 <span class="comment">// FIXME - this should not be necessary, and someday we</span>
<a name="l00136"></a>00136 <span class="comment">// we should figure out how to handle the "already open"</span>
<a name="l00137"></a>00137 <span class="comment">// response we get for the Desktop</span>
<a name="l00138"></a>00138 <span class="comment">//</span>
<a name="l00139"></a>00139 <span class="comment">// FIXME - halfOpen now seems to be handled in the Socket class...</span>
<a name="l00140"></a>00140 <span class="comment">// perhaps move this there if needed</span>
<a name="l00141"></a>00141 <span class="comment">//</span>
<a name="l00142"></a>00142 <span class="comment">/*</span>
<a name="l00143"></a>00143 <span class="comment"> if( m_halfOpen ) {</span>
<a name="l00144"></a>00144 <span class="comment"> dout("Controller object destroyed in halfopen state, resetting device");</span>
<a name="l00145"></a>00145 <span class="comment"> m_dev.Reset();</span>
<a name="l00146"></a>00146 <span class="comment"> }</span>
<a name="l00147"></a>00147 <span class="comment">*/</span>
<a name="l00148"></a>00148 }
<a name="l00149"></a>00149 <span class="comment"></span>
<a name="l00150"></a>00150 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00151"></a>00151 <span class="comment"></span><span class="comment">// protected members</span>
<a name="l00152"></a>00152
<a name="l00153"></a>00153 <span class="comment">//</span>
<a name="l00154"></a>00154 <span class="comment">// Tells device which mode is desired, and returns the suggested</span>
<a name="l00155"></a>00155 <span class="comment">// socket ID to use for that mode.</span>
<a name="l00156"></a>00156 <span class="comment">//</span>
<a name="l00157"></a>00157 uint16_t Controller::SelectMode(ModeType mode)
<a name="l00158"></a>00158 {
<a name="l00159"></a>00159 <span class="comment">// select mode</span>
<a name="l00160"></a>00160 Protocol::Packet packet;
<a name="l00161"></a>00161 packet.socket = 0;
<a name="l00162"></a>00162 packet.size = htobs(SB_MODE_PACKET_COMMAND_SIZE);
<a name="l00163"></a>00163 packet.command = SB_COMMAND_SELECT_MODE;
<a name="l00164"></a>00164 packet.u.socket.socket = htobs(SB_MODE_REQUEST_SOCKET);
<a name="l00165"></a>00165 packet.u.socket.sequence = 0; <span class="comment">// updated by Socket::Send()</span>
<a name="l00166"></a>00166 memset(packet.u.socket.u.mode.name, 0, <span class="keyword">sizeof</span>(packet.u.socket.u.mode.name));
<a name="l00167"></a>00167
<a name="l00168"></a>00168 <span class="keywordtype">char</span> *modeName = (<span class="keywordtype">char</span> *) packet.u.socket.u.mode.name;
<a name="l00169"></a>00169 <span class="keywordflow">switch</span>( mode )
<a name="l00170"></a>00170 {
<a name="l00171"></a>00171 <span class="keywordflow">case</span> Bypass:
<a name="l00172"></a>00172 strcpy(modeName, <span class="stringliteral">"RIM Bypass"</span>);
<a name="l00173"></a>00173 <span class="keywordflow">break</span>;
<a name="l00174"></a>00174
<a name="l00175"></a>00175 <span class="keywordflow">case</span> Desktop:
<a name="l00176"></a>00176 strcpy(modeName, <span class="stringliteral">"RIM Desktop"</span>);
<a name="l00177"></a>00177 <span class="keywordflow">break</span>;
<a name="l00178"></a>00178
<a name="l00179"></a>00179 <span class="keywordflow">case</span> JavaLoader:
<a name="l00180"></a>00180 strcpy(modeName, <span class="stringliteral">"RIM_JavaLoader"</span>);
<a name="l00181"></a>00181 <span class="keywordflow">break</span>;
<a name="l00182"></a>00182
<a name="l00183"></a>00183 <span class="keywordflow">case</span> JVMDebug:
<a name="l00184"></a>00184 strcpy(modeName, <span class="stringliteral">"RIM_JVMDebug"</span>);
<a name="l00185"></a>00185 <span class="keywordflow">break</span>;
<a name="l00186"></a>00186
<a name="l00187"></a>00187 <span class="keywordflow">case</span> UsbSerData:
<a name="l00188"></a>00188 strcpy(modeName, <span class="stringliteral">"RIM_UsbSerData"</span>);
<a name="l00189"></a>00189 <span class="keywordflow">break</span>;
<a name="l00190"></a>00190
<a name="l00191"></a>00191 <span class="keywordflow">case</span> UsbSerCtrl:
<a name="l00192"></a>00192 strcpy(modeName, <span class="stringliteral">"RIM_UsbSerCtrl"</span>);
<a name="l00193"></a>00193 <span class="keywordflow">break</span>;
<a name="l00194"></a>00194
<a name="l00195"></a>00195 <span class="keywordflow">default</span>:
<a name="l00196"></a>00196 <span class="keywordflow">throw</span> std::logic_error(<span class="stringliteral">"Controller: Invalid mode in SelectMode"</span>);
<a name="l00197"></a>00197 <span class="keywordflow">break</span>;
<a name="l00198"></a>00198 }
<a name="l00199"></a>00199
<a name="l00200"></a>00200 <span class="comment">// send mode command before we open, as a default socket is socket 0</span>
<a name="l00201"></a>00201 Data command(&packet, btohs(packet.size));
<a name="l00202"></a>00202 Data response;
<a name="l00203"></a>00203
<a name="l00204"></a>00204 <span class="keywordflow">try</span> {
<a name="l00205"></a>00205 m_zero.Send(command, response);
<a name="l00206"></a>00206
<a name="l00207"></a>00207 <span class="comment">// get the data socket number</span>
<a name="l00208"></a>00208 <span class="comment">// indicates the socket number that</span>
<a name="l00209"></a>00209 <span class="comment">// should be used below in the Open() call</span>
<a name="l00210"></a>00210 Protocol::CheckSize(response, SB_MODE_PACKET_RESPONSE_SIZE);
<a name="l00211"></a>00211 MAKE_PACKET(modepack, response);
<a name="l00212"></a>00212 <span class="keywordflow">if</span>( modepack->command != SB_COMMAND_MODE_SELECTED ) {
<a name="l00213"></a>00213 eeout(command, response);
<a name="l00214"></a>00214 <span class="keywordflow">throw</span> Error(<span class="stringliteral">"Controller: mode not selected"</span>);
<a name="l00215"></a>00215 }
<a name="l00216"></a>00216
<a name="l00217"></a>00217 <span class="keywordflow">if</span> (mode == Desktop) {
<a name="l00218"></a>00218 <span class="comment">// On the BlackBerry Storm, I have to read a packet</span>
<a name="l00219"></a>00219 <span class="comment">// after opening a socket. (only for Desktop mode)</span>
<a name="l00220"></a>00220 <span class="comment">// Otherwise, barrybackup and opensync-plugin can crash (timeout)</span>
<a name="l00221"></a>00221 <span class="comment">// I don't know why ! Maybe a bug on the handheld.</span>
<a name="l00222"></a>00222 m_zero.HideSequencePacket(<span class="keyword">false</span>);
<a name="l00223"></a>00223 m_zero.Receive(response);
<a name="l00224"></a>00224 m_zero.HideSequencePacket(<span class="keyword">true</span>);
<a name="l00225"></a>00225 }
<a name="l00226"></a>00226
<a name="l00227"></a>00227 <span class="comment">// return the socket that the device is expecting us to use</span>
<a name="l00228"></a>00228 <span class="keywordflow">return</span> btohs(modepack->u.socket.socket);
<a name="l00229"></a>00229 }
<a name="l00230"></a>00230 <span class="keywordflow">catch</span>( <a class="code" href="classUsb_1_1Error.html" title="Thrown on low level USB errors.">Usb::Error</a> & ) {
<a name="l00231"></a>00231 eout(<span class="stringliteral">"Controller: error setting desktop mode"</span>);
<a name="l00232"></a>00232 eeout(command, response);
<a name="l00233"></a>00233 <span class="keywordflow">throw</span>;
<a name="l00234"></a>00234 }
<a name="l00235"></a>00235 }
<a name="l00236"></a>00236
<a name="l00237"></a>00237 <span class="comment"></span>
<a name="l00238"></a>00238 <span class="comment">///////////////////////////////////////////////////////////////////////////////</span>
<a name="l00239"></a>00239 <span class="comment"></span><span class="comment">// public API</span>
<a name="l00240"></a>00240
<a name="l00241"></a>00241
<a name="l00242"></a>00242 } <span class="comment">// namespace Barry</span>
<a name="l00243"></a>00243
</pre></div></div>
<hr class="footer"/><address style="text-align: right;"><small>Generated by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.6.2-20100208 </small></address>
</body>
</html>
