<!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: common.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>common.cc</h1><a href="common_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 common.cc</span>
<a name="l00003"></a>00003 <span class="comment"></span><span class="comment">/// General Barry interface 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 <usb.h></span>
<a name="l00024"></a>00024 <span class="preprocessor">#include <pthread.h></span>
<a name="l00025"></a>00025 <span class="preprocessor">#include "debug.h"</span>
<a name="l00026"></a>00026
<a name="l00027"></a>00027 <span class="keyword">namespace </span>Barry {
<a name="l00028"></a>00028
<a name="l00029"></a>00029 <span class="keywordtype">bool</span> __data_dump_mode__;
<a name="l00030"></a>00030
<a name="l00031"></a>00031 std::ostream *LogStream = &std::cout;
<a name="l00032"></a>00032 pthread_mutex_t LogStreamMutex;
<a name="l00033"></a>00033
<a name="l00034"></a>00034
<a name="l00035"></a>00035 <span class="comment">//</span>
<a name="l00036"></a>00036 <span class="comment">// Init</span>
<a name="l00037"></a>00037 <span class="comment">//</span><span class="comment"></span>
<a name="l00038"></a>00038 <span class="comment">/// Barry library initializer. Call this before anything else.</span>
<a name="l00039"></a>00039 <span class="comment">/// This takes care of initializing the lower level libusb.</span>
<a name="l00040"></a>00040 <span class="comment">///</span>
<a name="l00041"></a>00041 <span class="comment">/// This function is safe to be called multiple times. The</span>
<a name="l00042"></a>00042 <span class="comment">/// data_dump_mode and the log stream will be updated each time</span>
<a name="l00043"></a>00043 <span class="comment">/// it is called, but the USB library will not be re-initialized.</span>
<a name="l00044"></a>00044 <span class="comment">///</span>
<a name="l00045"></a>00045 <span class="comment">/// \param[in] data_dump_mode If set to true, the protocol conversation</span>
<a name="l00046"></a>00046 <span class="comment">/// will be sent to the logStream specified</span>
<a name="l00047"></a>00047 <span class="comment">/// in the second argument.</span>
<a name="l00048"></a>00048 <span class="comment">/// \param[in] LogStream Pointer to std::ostream object to use for</span>
<a name="l00049"></a>00049 <span class="comment">/// debug output and logging. Defaults to</span>
<a name="l00050"></a>00050 <span class="comment">/// std::cout.</span>
<a name="l00051"></a>00051 <span class="comment">///</span>
<a name="l00052"></a><a class="code" href="namespaceBarry.html#2e28bd59aebe0bece5a46f02ef7dbd3d">00052</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="namespaceBarry.html#2e28bd59aebe0bece5a46f02ef7dbd3d" title="Barry library initializer.">Init</a>(<span class="keywordtype">bool</span> data_dump_mode, std::ostream *logStream)
<a name="l00053"></a>00053 {
<a name="l00054"></a>00054 <span class="keyword">static</span> <span class="keywordtype">bool</span> initialized = <span class="keyword">false</span>;
<a name="l00055"></a>00055
<a name="l00056"></a>00056 <span class="comment">// set usb debug mode first, so that USB's initialization</span>
<a name="l00057"></a>00057 <span class="comment">// is captured too</span>
<a name="l00058"></a>00058 <span class="keywordflow">if</span>( data_dump_mode )
<a name="l00059"></a>00059 usb_set_debug(9);
<a name="l00060"></a>00060
<a name="l00061"></a>00061 <span class="comment">// perform one-time initalization</span>
<a name="l00062"></a>00062 <span class="keywordflow">if</span>( !initialized ) {
<a name="l00063"></a>00063 <span class="comment">// if the environment variable USB_DEBUG is set, that</span>
<a name="l00064"></a>00064 <span class="comment">// level value will be used instead of our 9 above...</span>
<a name="l00065"></a>00065 <span class="comment">// if you need to *force* this to 9, call Verbose(true)</span>
<a name="l00066"></a>00066 <span class="comment">// after Init()</span>
<a name="l00067"></a>00067 usb_init();
<a name="l00068"></a>00068
<a name="l00069"></a>00069 <span class="comment">// only need to initialize this once</span>
<a name="l00070"></a>00070 pthread_mutex_init(&LogStreamMutex, NULL);
<a name="l00071"></a>00071
<a name="l00072"></a>00072 <span class="comment">// done</span>
<a name="l00073"></a>00073 initialized = <span class="keyword">true</span>;
<a name="l00074"></a>00074 }
<a name="l00075"></a>00075
<a name="l00076"></a>00076 __data_dump_mode__ = data_dump_mode;
<a name="l00077"></a>00077 LogStream = logStream;
<a name="l00078"></a>00078 }
<a name="l00079"></a>00079
<a name="l00080"></a>00080 <span class="comment">//</span>
<a name="l00081"></a>00081 <span class="comment">// Verbose</span>
<a name="l00082"></a>00082 <span class="comment">//</span><span class="comment"></span>
<a name="l00083"></a>00083 <span class="comment">/// This API call lets the application enable / disable verbose debug</span>
<a name="l00084"></a>00084 <span class="comment">/// output on the fly.</span>
<a name="l00085"></a>00085 <span class="comment">///</span>
<a name="l00086"></a>00086 <span class="comment">/// \param[in] data_dump_mode If set to true, the protocol conversation</span>
<a name="l00087"></a>00087 <span class="comment">/// will be sent to the logStream specified</span>
<a name="l00088"></a>00088 <span class="comment">/// in the Barry::Init() call.</span>
<a name="l00089"></a>00089 <span class="comment">///</span>
<a name="l00090"></a><a class="code" href="namespaceBarry.html#59da38213acb8827d30bddfc54bbfe2a">00090</a> <span class="comment"></span><span class="keywordtype">void</span> <a class="code" href="namespaceBarry.html#59da38213acb8827d30bddfc54bbfe2a" title="This API call lets the application enable / disable verbose debug output on the fly...">Verbose</a>(<span class="keywordtype">bool</span> data_dump_mode)
<a name="l00091"></a>00091 {
<a name="l00092"></a>00092 __data_dump_mode__ = data_dump_mode;
<a name="l00093"></a>00093
<a name="l00094"></a>00094 <span class="keywordflow">if</span>( data_dump_mode )
<a name="l00095"></a>00095 usb_set_debug(9);
<a name="l00096"></a>00096 <span class="keywordflow">else</span>
<a name="l00097"></a>00097 usb_set_debug(0);
<a name="l00098"></a>00098 }
<a name="l00099"></a>00099
<a name="l00100"></a>00100 <span class="comment">//</span>
<a name="l00101"></a>00101 <span class="comment">// IsVerbose</span>
<a name="l00102"></a>00102 <span class="comment">//</span><span class="comment"></span>
<a name="l00103"></a>00103 <span class="comment">/// Returns true if data dump mode is enabled.</span>
<a name="l00104"></a>00104 <span class="comment">///</span>
<a name="l00105"></a><a class="code" href="namespaceBarry.html#ec655def4d700239e60ed3ccb417e0c5">00105</a> <span class="comment"></span><span class="keywordtype">bool</span> <a class="code" href="namespaceBarry.html#ec655def4d700239e60ed3ccb417e0c5" title="Returns true if data dump mode is enabled.">IsVerbose</a>()
<a name="l00106"></a>00106 {
<a name="l00107"></a>00107 <span class="keywordflow">return</span> __data_dump_mode__;
<a name="l00108"></a>00108 }
<a name="l00109"></a>00109
<a name="l00110"></a>00110 } <span class="comment">// namespace Barry</span>
<a name="l00111"></a>00111
</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>
