<!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"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.3"/>
<title>GNU Radio 3.6.4.1 C++ API: microtune_xxxx_eval_board.h Source File</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
$(document).ready(initResizable);
$(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">GNU Radio 3.6.4.1 C++ API
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.3 -->
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
<div id="nav-tree">
<div id="nav-tree-contents">
<div id="nav-sync" class="sync"></div>
</div>
</div>
<div id="splitbar" style="-moz-user-select:none;"
class="ui-resizable-handle">
</div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('microtune__xxxx__eval__board_8h_source.html','');});
</script>
<div id="doc-content">
<div class="header">
<div class="headertitle">
<div class="title">microtune_xxxx_eval_board.h</div> </div>
</div><!--header-->
<div class="contents">
<a href="microtune__xxxx__eval__board_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/* -*- C++ -*- */</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment">/*</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * Copyright 2001,2004 Free Software Foundation, Inc.</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * This file is part of GNU Radio</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> * GNU Radio is free software; you can redistribute it and/or modify</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="comment"> * it under the terms of the GNU General Public License as published by</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span> <span class="comment"> * the Free Software Foundation; either version 3, or (at your option)</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="comment"> * any later version.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span> <span class="comment"> * GNU Radio is distributed in the hope that it will be useful,</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span> <span class="comment"> * but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"> * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment"> * GNU General Public License for more details.</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span> <span class="comment"> * You should have received a copy of the GNU General Public License</span></div>
<div class="line"><a name="l00018"></a><span class="lineno"> 18</span> <span class="comment"> * along with GNU Radio; see the file COPYING. If not, write to</span></div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span> <span class="comment"> * the Free Software Foundation, Inc., 51 Franklin Street,</span></div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span> <span class="comment"> * Boston, MA 02110-1301, USA.</span></div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span> </div>
<div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="preprocessor">#ifndef INCLUDED_MICROTUNE_XXXX_EVAL_BOARD_H</span></div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="preprocessor"></span><span class="preprocessor">#define INCLUDED_MICROTUNE_XXXX_EVAL_BOARD_H</span></div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="preprocessor"></span></div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="preprocessor">#include <<a class="code" href="gr__core__api_8h.html">gr_core_api.h</a>></span></div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="preprocessor">#include <boost/shared_ptr.hpp></span></div>
<div class="line"><a name="l00028"></a><span class="lineno"> 28</span> </div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="keyword">class </span><a class="code" href="classmicrotune__xxxx.html" title="abstract class for controlling microtune {4937,4702} tuner modules">microtune_xxxx</a>;</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span> </div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="keyword">class </span><a class="code" href="classppio.html" title="abstract class that provides low level access to parallel port bits">ppio</a>;</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<ppio></a> <a class="code" href="classboost_1_1shared__ptr.html" title="shared_ptr documentation stub">ppio_sptr</a>;</div>
<div class="line"><a name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="keyword">class </span><a class="code" href="classi2c.html" title="abstract class for controlling i2c bus">i2c</a>;</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="keyword">typedef</span> <a class="code" href="classboost_1_1shared__ptr.html">boost::shared_ptr<i2c></a> <a class="code" href="classboost_1_1shared__ptr.html">i2c_sptr</a>;</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment"></span></div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment">/*!</span></div>
<div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"> * \brief abstract class for controlling microtune xxxx eval board</span></div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment"> * \ingroup hardware</span></div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00041"></a><span class="lineno"><a class="code" href="classmicrotune__xxxx__eval__board.html"> 41</a></span> <span class="keyword">class </span><a class="code" href="gr__core__api_8h.html#a8b8937b0c61edd85ab57ce8203543248">GR_CORE_API</a> <a class="code" href="classmicrotune__xxxx__eval__board.html" title="abstract class for controlling microtune xxxx eval board">microtune_xxxx_eval_board</a> {</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="keyword">public</span>:</div>
<div class="line"><a name="l00043"></a><span class="lineno"> 43</span>  <a class="code" href="classmicrotune__xxxx__eval__board.html" title="abstract class for controlling microtune xxxx eval board">microtune_xxxx_eval_board</a> (<span class="keywordtype">int</span> which_pp = 0);</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>  <span class="keyword">virtual</span> ~<a class="code" href="classmicrotune__xxxx__eval__board.html" title="abstract class for controlling microtune xxxx eval board">microtune_xxxx_eval_board</a> ();</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span> <span class="comment"></span></div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span> <span class="comment"> //! is the eval board present?</span></div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span> <span class="comment"></span> <span class="keywordtype">bool</span> board_present_p ();</div>
<div class="line"><a name="l00048"></a><span class="lineno"> 48</span> <span class="comment"></span></div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span> <span class="comment"> * \brief set RF and IF AGC control voltages ([0, 5] volts)</span></div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>  <span class="keywordtype">void</span> set_RF_AGC_voltage (<span class="keywordtype">float</span> volts);</div>
<div class="line"><a name="l00053"></a><span class="lineno"> 53</span>  <span class="keywordtype">void</span> set_IF_AGC_voltage (<span class="keywordtype">float</span> volts);</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span> <span class="comment"></span></div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span> <span class="comment"> * \brief set RF and IF AGC levels together (scale [0, 1000])</span></div>
<div class="line"><a name="l00057"></a><span class="lineno"> 57</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00058"></a><span class="lineno"> 58</span> <span class="comment"> * This provides a simple linear interface for adjusting both</span></div>
<div class="line"><a name="l00059"></a><span class="lineno"> 59</span> <span class="comment"> * the RF and IF gain in consort. This is the easy to use interface.</span></div>
<div class="line"><a name="l00060"></a><span class="lineno"> 60</span> <span class="comment"> * 0 corresponds to minimum gain. 1000 corresponds to maximum gain.</span></div>
<div class="line"><a name="l00061"></a><span class="lineno"> 61</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00062"></a><span class="lineno"> 62</span>  <span class="keyword">virtual</span> <span class="keywordtype">void</span> set_AGC (<span class="keywordtype">float</span> value_0_1000) = 0;</div>
<div class="line"><a name="l00063"></a><span class="lineno"> 63</span> <span class="comment"></span></div>
<div class="line"><a name="l00064"></a><span class="lineno"> 64</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00065"></a><span class="lineno"> 65</span> <span class="comment"> * \brief select RF frequency to be tuned to output frequency.</span></div>
<div class="line"><a name="l00066"></a><span class="lineno"> 66</span> <span class="comment"> * \p freq is the requested frequency in Hz, \p actual_freq</span></div>
<div class="line"><a name="l00067"></a><span class="lineno"> 67</span> <span class="comment"> * is set to the actual frequency tuned. It takes about 100 ms</span></div>
<div class="line"><a name="l00068"></a><span class="lineno"> 68</span> <span class="comment"> * for the PLL to settle.</span></div>
<div class="line"><a name="l00069"></a><span class="lineno"> 69</span> <span class="comment"> *</span></div>
<div class="line"><a name="l00070"></a><span class="lineno"> 70</span> <span class="comment"> * \returns true iff sucessful.</span></div>
<div class="line"><a name="l00071"></a><span class="lineno"> 71</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00072"></a><span class="lineno"> 72</span>  <span class="keywordtype">bool</span> set_RF_freq (<span class="keywordtype">double</span> freq, <span class="keywordtype">double</span> *actual_freq);</div>
<div class="line"><a name="l00073"></a><span class="lineno"> 73</span> </div>
<div class="line"><a name="l00074"></a><span class="lineno"> 74</span>  <span class="comment">// returns actual freq or 0 if error (easier interface for SWIG)</span></div>
<div class="line"><a name="l00075"></a><span class="lineno"> 75</span>  <span class="keywordtype">double</span> set_RF_freq (<span class="keywordtype">double</span> freq);</div>
<div class="line"><a name="l00076"></a><span class="lineno"> 76</span> <span class="comment"></span></div>
<div class="line"><a name="l00077"></a><span class="lineno"> 77</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00078"></a><span class="lineno"> 78</span> <span class="comment"> * \returns true iff PLL is locked</span></div>
<div class="line"><a name="l00079"></a><span class="lineno"> 79</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00080"></a><span class="lineno"> 80</span>  <span class="keywordtype">bool</span> pll_locked_p ();</div>
<div class="line"><a name="l00081"></a><span class="lineno"> 81</span> <span class="comment"></span></div>
<div class="line"><a name="l00082"></a><span class="lineno"> 82</span> <span class="comment"> /*!</span></div>
<div class="line"><a name="l00083"></a><span class="lineno"> 83</span> <span class="comment"> * \returns the output frequency (IF center freq) of the tuner in Hz.</span></div>
<div class="line"><a name="l00084"></a><span class="lineno"> 84</span> <span class="comment"> */</span></div>
<div class="line"><a name="l00085"></a><span class="lineno"> 85</span>  <span class="keywordtype">double</span> get_output_freq ();</div>
<div class="line"><a name="l00086"></a><span class="lineno"> 86</span> </div>
<div class="line"><a name="l00087"></a><span class="lineno"> 87</span> </div>
<div class="line"><a name="l00088"></a><span class="lineno"> 88</span> <span class="keyword">private</span>:</div>
<div class="line"><a name="l00089"></a><span class="lineno"> 89</span>  <span class="keywordtype">void</span> write_dac (<span class="keywordtype">int</span> which, <span class="keywordtype">int</span> value);</div>
<div class="line"><a name="l00090"></a><span class="lineno"> 90</span>  <span class="keywordtype">void</span> write_both_dacs (<span class="keywordtype">int</span> val0, <span class="keywordtype">int</span> val1);</div>
<div class="line"><a name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a name="l00092"></a><span class="lineno"> 92</span> <span class="keyword">protected</span>:</div>
<div class="line"><a name="l00093"></a><span class="lineno"><a class="code" href="classmicrotune__xxxx__eval__board.html#a61be9a0910599fbbdd4b0164b5453843"> 93</a></span>  <a class="code" href="classboost_1_1shared__ptr.html">ppio_sptr</a> <a class="code" href="classmicrotune__xxxx__eval__board.html#a61be9a0910599fbbdd4b0164b5453843">d_ppio</a>;</div>
<div class="line"><a name="l00094"></a><span class="lineno"><a class="code" href="classmicrotune__xxxx__eval__board.html#a6fc807ce2050b39fa5bf887a657837ae"> 94</a></span>  <a class="code" href="classboost_1_1shared__ptr.html">i2c_sptr</a> <a class="code" href="classmicrotune__xxxx__eval__board.html#a6fc807ce2050b39fa5bf887a657837ae">d_i2c</a>;</div>
<div class="line"><a name="l00095"></a><span class="lineno"><a class="code" href="classmicrotune__xxxx__eval__board.html#a7734fb4f9c1e4843b149628c2c38d3a5"> 95</a></span>  <a class="code" href="classmicrotune__xxxx.html" title="abstract class for controlling microtune {4937,4702} tuner modules">microtune_xxxx</a> *<a class="code" href="classmicrotune__xxxx__eval__board.html#a7734fb4f9c1e4843b149628c2c38d3a5">d_tuner</a>;</div>
<div class="line"><a name="l00096"></a><span class="lineno"> 96</span> };</div>
<div class="line"><a name="l00097"></a><span class="lineno"> 97</span> </div>
<div class="line"><a name="l00098"></a><span class="lineno"> 98</span> <span class="preprocessor">#endif </span><span class="comment">/* INCLUDED_MICROTUNE_XXXX_EVAL_BOARD_H */</span><span class="preprocessor"></span></div>
</div><!-- fragment --></div><!-- contents -->
</div><!-- doc-content -->
<!-- start footer part -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
<ul>
<li class="navelem"><a class="el" href="dir_284717b6cb06147531c058220802c6d1.html">gnuradio-core</a></li><li class="navelem"><a class="el" href="dir_7c24473031c549da670035bb20d1e97e.html">src</a></li><li class="navelem"><a class="el" href="dir_84906bae47c76101f1fa015cf813f8a2.html">lib</a></li><li class="navelem"><a class="el" href="dir_4a2470a59e95113f1bc77f5cd957cdf2.html">io</a></li><li class="navelem"><a class="el" href="microtune__xxxx__eval__board_8h.html">microtune_xxxx_eval_board.h</a></li>
<li class="footer">Generated on Fri Apr 19 2013 16:20:33 for GNU Radio 3.6.4.1 C++ API by
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.8.3 </li>
</ul>
</div>
</body>
</html>
