<!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.11"/>
<title>libbladeRF: Bandwidth configuration</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="search/search.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="search/searchdata.js"></script>
<script type="text/javascript" src="search/search.js"></script>
<script type="text/javascript">
$(document).ready(function() { init_search(); });
</script>
<script type="text/x-mathjax-config">
MathJax.Hub.Config({
extensions: ["tex2jax.js"],
jax: ["input/TeX","output/HTML-CSS"],
});
</script><script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js"></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 id="projectlogo"><img alt="Logo" src="logo.png"/></td>
<td id="projectalign" style="padding-left: 0.5em;">
<div id="projectname">libbladeRF
 <span id="projectnumber">1.7.2</span>
</div>
<div id="projectbrief">Nuand bladeRF library</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.11 -->
<script type="text/javascript">
var searchBox = new SearchBox("searchBox", "search",false,'Search');
</script>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main Page</span></a></li>
<li class="current"><a href="modules.html"><span>API Sections</span></a></li>
<li>
<div id="MSearchBox" class="MSearchBoxInactive">
<span class="left">
<img id="MSearchSelect" src="search/mag_sel.png"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
alt=""/>
<input type="text" id="MSearchField" value="Search" accesskey="S"
onfocus="searchBox.OnSearchFieldFocus(true)"
onblur="searchBox.OnSearchFieldFocus(false)"
onkeyup="searchBox.OnSearchFieldChange(event)"/>
</span><span class="right">
<a id="MSearchClose" href="javascript:searchBox.CloseResultsWindow()"><img id="MSearchCloseImg" border="0" src="search/close.png" alt=""/></a>
</span>
</div>
</li>
</ul>
</div>
</div><!-- top -->
<!-- window showing the filter options -->
<div id="MSearchSelectWindow"
onmouseover="return searchBox.OnSearchSelectShow()"
onmouseout="return searchBox.OnSearchSelectHide()"
onkeydown="return searchBox.OnSearchSelectKey(event)">
</div>
<!-- iframe showing the search results (closed by default) -->
<div id="MSearchResultsWindow">
<iframe src="javascript:void(0)" frameborder="0"
name="MSearchResults" id="MSearchResults">
</iframe>
</div>
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> |
<a href="#enum-members">Enumerations</a> |
<a href="#func-members">Functions</a> </div>
<div class="headertitle">
<div class="title">Bandwidth configuration</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>This section defines functionality for configuring the device's LPF bandwidth. In most cases, one should define the bandwidth to be less than the sample rate to minimize the impact of aliases.</p>
<p>To determine the required bandwidth setting for a desired sample rate (or vice versa), review the TX/RX LPF amplitude response plots in the LMS6002D datasheet. (This was Figure 6 as of datasheet v1.2r0.)</p>
<p>These functions are thread-safe. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga2c9cc06755537bec67585023fb52deec"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga2c9cc06755537bec67585023fb52deec">BLADERF_BANDWIDTH_MIN</a>   1500000u</td></tr>
<tr class="separator:ga2c9cc06755537bec67585023fb52deec"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1ab01091c58d6d8fcfcc1dc23ccfe057"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga1ab01091c58d6d8fcfcc1dc23ccfe057">BLADERF_BANDWIDTH_MAX</a>   28000000u</td></tr>
<tr class="separator:ga1ab01091c58d6d8fcfcc1dc23ccfe057"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:ga84be5ff3d9ae3bd603b4beaeb7efa09a"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga84be5ff3d9ae3bd603b4beaeb7efa09a">bladerf_lpf_mode</a> { <a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#gga84be5ff3d9ae3bd603b4beaeb7efa09aaa6ad89ee9e5fd299e23c200c3f8a1ca8">BLADERF_LPF_NORMAL</a>,
<a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#gga84be5ff3d9ae3bd603b4beaeb7efa09aa291c6be29cbcd9f713a47bd2897c7956">BLADERF_LPF_BYPASSED</a>,
<a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#gga84be5ff3d9ae3bd603b4beaeb7efa09aa9d72d6fb52d1b462244c63a1d65bffef">BLADERF_LPF_DISABLED</a>
}</td></tr>
<tr class="separator:ga84be5ff3d9ae3bd603b4beaeb7efa09a"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ga1214e2bb1ec38f981015aeafdd846c29"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga1214e2bb1ec38f981015aeafdd846c29">bladerf_set_bandwidth</a> (struct bladerf *dev, <a class="el" href="group___f_n___m_o_d_u_l_e.html#gab12571146a3d4c5d79ac497a74b3fb5e">bladerf_module</a> module, unsigned int bandwidth, unsigned int *actual)</td></tr>
<tr class="separator:ga1214e2bb1ec38f981015aeafdd846c29"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gad788c9932498fa0f0f88e98cc287a00e"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#gad788c9932498fa0f0f88e98cc287a00e">bladerf_get_bandwidth</a> (struct bladerf *dev, <a class="el" href="group___f_n___m_o_d_u_l_e.html#gab12571146a3d4c5d79ac497a74b3fb5e">bladerf_module</a> module, unsigned int *bandwidth)</td></tr>
<tr class="separator:gad788c9932498fa0f0f88e98cc287a00e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga1268e31035d93697b49e9a9e4760019a"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga1268e31035d93697b49e9a9e4760019a">bladerf_set_lpf_mode</a> (struct bladerf *dev, <a class="el" href="group___f_n___m_o_d_u_l_e.html#gab12571146a3d4c5d79ac497a74b3fb5e">bladerf_module</a> module, <a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga84be5ff3d9ae3bd603b4beaeb7efa09a">bladerf_lpf_mode</a> mode)</td></tr>
<tr class="separator:ga1268e31035d93697b49e9a9e4760019a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5ceafefe5c64e722aa1c7a8cd27632e5"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga5ceafefe5c64e722aa1c7a8cd27632e5">bladerf_get_lpf_mode</a> (struct bladerf *dev, <a class="el" href="group___f_n___m_o_d_u_l_e.html#gab12571146a3d4c5d79ac497a74b3fb5e">bladerf_module</a> module, <a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga84be5ff3d9ae3bd603b4beaeb7efa09a">bladerf_lpf_mode</a> *mode)</td></tr>
<tr class="separator:ga5ceafefe5c64e722aa1c7a8cd27632e5"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="ga1ab01091c58d6d8fcfcc1dc23ccfe057"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BLADERF_BANDWIDTH_MAX   28000000u</td>
</tr>
</table>
</div><div class="memdoc">
<p>Maximum bandwidth, in Hz </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l00948">948</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga2c9cc06755537bec67585023fb52deec"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BLADERF_BANDWIDTH_MIN   1500000u</td>
</tr>
</table>
</div><div class="memdoc">
<p>Minimum bandwidth, in Hz </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l00945">945</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Enumeration Type Documentation</h2>
<a class="anchor" id="ga84be5ff3d9ae3bd603b4beaeb7efa09a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga84be5ff3d9ae3bd603b4beaeb7efa09a">bladerf_lpf_mode</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Low-Pass Filter (LPF) mode </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga84be5ff3d9ae3bd603b4beaeb7efa09aaa6ad89ee9e5fd299e23c200c3f8a1ca8"></a>BLADERF_LPF_NORMAL </td><td class="fielddoc">
<p>LPF connected and enabled </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga84be5ff3d9ae3bd603b4beaeb7efa09aa291c6be29cbcd9f713a47bd2897c7956"></a>BLADERF_LPF_BYPASSED </td><td class="fielddoc">
<p>LPF bypassed </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga84be5ff3d9ae3bd603b4beaeb7efa09aa9d72d6fb52d1b462244c63a1d65bffef"></a>BLADERF_LPF_DISABLED </td><td class="fielddoc">
<p>LPF disabled </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l00953">953</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="gad788c9932498fa0f0f88e98cc287a00e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_get_bandwidth </td>
<td>(</td>
<td class="paramtype">struct bladerf * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___f_n___m_o_d_u_l_e.html#gab12571146a3d4c5d79ac497a74b3fb5e">bladerf_module</a> </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int * </td>
<td class="paramname"><em>bandwidth</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the bandwidth of the LMS LPF</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>Device Handle </td></tr>
<tr><td class="paramname">module</td><td>Module for bandwidth request </td></tr>
<tr><td class="paramname">bandwidth</td><td>Actual bandwidth in Hz</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, value from <a class="el" href="group___r_e_t_c_o_d_e_s.html">Error codes</a> list on failure </dd></dl>
</div>
</div>
<a class="anchor" id="ga5ceafefe5c64e722aa1c7a8cd27632e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_get_lpf_mode </td>
<td>(</td>
<td class="paramtype">struct bladerf * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___f_n___m_o_d_u_l_e.html#gab12571146a3d4c5d79ac497a74b3fb5e">bladerf_module</a> </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga84be5ff3d9ae3bd603b4beaeb7efa09a">bladerf_lpf_mode</a> * </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the current mode of the LMS LPF</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>Device handle </td></tr>
<tr><td class="paramname">module</td><td>Module for mode request </td></tr>
<tr><td class="paramname">mode</td><td>Current mode of the LPF</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, value from <a class="el" href="group___r_e_t_c_o_d_e_s.html">Error codes</a> list on failure </dd></dl>
</div>
</div>
<a class="anchor" id="ga1214e2bb1ec38f981015aeafdd846c29"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_set_bandwidth </td>
<td>(</td>
<td class="paramtype">struct bladerf * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___f_n___m_o_d_u_l_e.html#gab12571146a3d4c5d79ac497a74b3fb5e">bladerf_module</a> </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int </td>
<td class="paramname"><em>bandwidth</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">unsigned int * </td>
<td class="paramname"><em>actual</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the bandwidth of the LMS LPF to specified value in Hz</p>
<p>The underlying device is capable of a discrete set of bandwidth values. The caller should check the <code>actual</code> parameter to determine which of these discrete bandwidth values is actually used for the requested bandwidth.</p>
<p>Values outside the range of [ <a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga2c9cc06755537bec67585023fb52deec">BLADERF_BANDWIDTH_MIN</a>, <a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga1ab01091c58d6d8fcfcc1dc23ccfe057">BLADERF_BANDWIDTH_MAX</a> ] will be clamped.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">dev</td><td>Device handle </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">module</td><td>Module for bandwidth request </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">bandwidth</td><td>Desired bandwidth </td></tr>
<tr><td class="paramdir">[out]</td><td class="paramname">actual</td><td>If non-NULL, written with the actual bandwidth that the device was able to achieve.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, value from <a class="el" href="group___r_e_t_c_o_d_e_s.html">Error codes</a> list on failure </dd></dl>
</div>
</div>
<a class="anchor" id="ga1268e31035d93697b49e9a9e4760019a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> int <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_set_lpf_mode </td>
<td>(</td>
<td class="paramtype">struct bladerf * </td>
<td class="paramname"><em>dev</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___f_n___m_o_d_u_l_e.html#gab12571146a3d4c5d79ac497a74b3fb5e">bladerf_module</a> </td>
<td class="paramname"><em>module</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="group___f_n___b_a_n_d_w_i_d_t_h.html#ga84be5ff3d9ae3bd603b4beaeb7efa09a">bladerf_lpf_mode</a> </td>
<td class="paramname"><em>mode</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Set the LMS LPF mode to bypass or disable it</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">dev</td><td>Device handle </td></tr>
<tr><td class="paramname">module</td><td>Module for mode request </td></tr>
<tr><td class="paramname">mode</td><td>Mode to be set</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 on success, value from <a class="el" href="group___r_e_t_c_o_d_e_s.html">Error codes</a> list on failure </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 29 2016 16:51:01 for libbladeRF by  <a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.11
</small></address>
</body>
</html>
