<!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: Environment Variables</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><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>
<!-- 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><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">Environment Variables </div> </div>
</div><!--header-->
<div class="contents">
<div class="textblock"><p>libbladeRF uses a few environment variables to allow users and developers to modify behavior at runtime. These enviroment variables should be treated as diagnostic features, rather than part of the API. They may be modified or removed in future versions of the library.</p>
<h3>BLADERF_LOG_LEVEL</h3>
<p>This enviroment variable controls the default log level setting, which is usually <a class="el" href="group___f_n___m_i_s_c.html#ggae7bf9817ba736192231b78bd1115bc29a48cf3980d4d5c556f7fcbd311c157da2">BLADERF_LOG_LEVEL_INFO</a>.</p>
<p>This may be useful when a program using libbladeRF is encountering errors. Setting the log level to <code>debug</code> or <code>verbose</code> often yields information that allows the reason for failures to be identified.</p>
<p>Note that this environment variable may not help if a program overrides the default log level by calling <a class="el" href="group___f_n___m_i_s_c.html#gae2de133be7904c2c11224f0b08bc0b36">bladerf_log_set_verbosity()</a>.</p>
<p>The values supplied to this environment variable correspond directly with the <a class="el" href="group___f_n___m_i_s_c.html#gae7bf9817ba736192231b78bd1115bc29">bladerf_log_level</a> values of the same name. The available values are listed below, and are handled in a case-insensitive manner.</p>
<ul>
<li>
critical </li>
<li>
error </li>
<li>
warning </li>
<li>
info </li>
<li>
debug </li>
<li>
verbose </li>
</ul>
<p><br />
</p><h3>BLADERF_SEARCH_DIR</h3>
<p>Usually, libbladeRF searches the following directories for files, such as FPGA bitstreams for software-based autoloading.</p>
<p><b>Linux and OSX:</b> </p><ul>
<li>
The current working directory </li>
<li>
The directory containing the program being executed </li>
<li>
<code>~/.config/Nuand/bladeRF</code> </li>
<li>
<code>~/.Nuand/bladeRF</code> </li>
<li>
<code>/etc/Nuand/bladeRF</code> </li>
<li>
<code>/usr/share/Nuand/bladeRF</code> </li>
</ul>
<p><b>Windows:</b> </p><ul>
<li>
The current working directory </li>
<li>
The directory containing the program being executed </li>
<li>
<code>C:\Users\USERNAME\AppData\Roaming\Nuand\bladeRF</code> (via <a href="https://msdn.microsoft.com/en-us/library/windows/desktop/dd378457%28v=vs.85%29.aspx" class="el">FOLDERID_RoamingAppData</a>) </li>
<li>
The installation path, via <code>HKEY_LOCAL_MACHINE\Software\Nuand LLC\Path</code> </li>
</ul>
<p>This environment variable may be used to specify a path to search prior to those listed above.</p>
<p><br />
</p><h3>BLADERF_DEFAULT_TUNING_MODE</h3>
<p>Normally, the default tuning mode is set per the conditions described in the documentation of the <a class="el" href="group___f_n___t_u_n_i_n_g.html#ga1052a36566cb6dc311242981c9ab4c47">bladerf_tuning_mode</a> enumeration.</p>
<p>This environment variable allows this default to be overridden at runtime and is intended to facilitate debugging. Valid values are: <code>host</code> and <code>fpga</code>.</p>
<p>Generally this environment variable is most useful when set to <code>host</code> and used in conjunction with setting the BLADERF_LOG_LEVEL environment variable to <code>verbose</code>. This allows low-level information about the frequency tuning operation to be observed, even though a program may not provide a means to change the log level or tuning mode.</p>
<p>Attempting to force the tuning mode to <code>fpga</code> on FPGA versions that do not support this will yield unexpected (and likely undesirable) behavior.</p>
<p><br />
</p><h3>BLADERF_FORCE_LEGACY_NIOS_PKT</h3>
<p>If defined, this forces libbladeRF to use the legacy packet format when communicating with the FPGA. This is intended for development and debugging.</p>
<p><br />
</p><h3>BLADERF_FORCE_NO_FPGA_PRESENT</h3>
<p>Defining this forces libbladeRF to behave as if it does not detect that an FPGA is loaded. This prevents it from attempting to initialize the device.</p>
<p>This was added as a means to allow users to remove an incompatible FPGA from flash, should they have forgotten to do so prior to updating libbladeRF and FX3 firmware.</p>
<p><br />
</p><h3>BLADERF_SKIP_FPGA_SIZE_CHECK</h3>
<p>Defining this overrides a check for the correct FPGA bitstream size when loading an FPGA bitstream from the host or writing it to flash for headless loading.</p>
<p>Under normal circumstances, users should <b>not</b> need to use this. This is intended to allow developers and those making customizations (e.g., adding FPGA compression) to skip this check without needing to rebuild libbladeRF.</p>
<p>If the size check is reporting an error, the most likely scenario is that an incorrect or corrupted FPGA bitstream is being provided. Check that the bitstream file is appropriate for the target device. </p>
</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>
