<!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: bladerf_metadata Struct Reference</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>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data Structures</span></a></li>
<li><a href="classes.html"><span>Data Structure Index</span></a></li>
<li><a href="functions.html"><span>Data Fields</span></a></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="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">bladerf_metadata Struct Reference<div class="ingroups"><a class="el" href="group___f_m_t___m_e_t_a.html">Sample formats and metadata</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>Sample metadata</p>
<p>This structure is used in conjunction with the <a class="el" href="group___f_m_t___m_e_t_a.html#gga4c61587834fd4de51a8e2d34e14a73b2a4af3974535ba338bbcecaa8d7500de03">BLADERF_FORMAT_SC16_Q11_META</a> format to TX scheduled bursts or retrieve timestamp information about received samples. </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l02908">2908</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
<p><code>#include <<a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>></code></p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr class="memitem:a465bef81f6478756e5443025b1f2ddfa"><td class="memItemLeft" align="right" valign="top">uint64_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__metadata.html#a465bef81f6478756e5443025b1f2ddfa">timestamp</a></td></tr>
<tr class="separator:a465bef81f6478756e5443025b1f2ddfa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a773b39d480759f67926cb18ae2219281"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__metadata.html#a773b39d480759f67926cb18ae2219281">flags</a></td></tr>
<tr class="separator:a773b39d480759f67926cb18ae2219281"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ade20423e91627f07e610924cb0081623"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__metadata.html#ade20423e91627f07e610924cb0081623">status</a></td></tr>
<tr class="separator:ade20423e91627f07e610924cb0081623"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a0a144ddaed8845788d38379d7b469960"><td class="memItemLeft" align="right" valign="top">unsigned int </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__metadata.html#a0a144ddaed8845788d38379d7b469960">actual_count</a></td></tr>
<tr class="separator:a0a144ddaed8845788d38379d7b469960"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a60f55957c042aa67ccfc8a0d996c19bb"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__metadata.html#a60f55957c042aa67ccfc8a0d996c19bb">reserved</a> [32]</td></tr>
<tr class="separator:a60f55957c042aa67ccfc8a0d996c19bb"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="a0a144ddaed8845788d38379d7b469960"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">unsigned int actual_count</td>
</tr>
</table>
</div><div class="memdoc">
<p>This output parameter is updated to reflect the actual number of contiguous samples that have been populated in an RX buffer during a <a class="el" href="group___f_n___d_a_t_a___s_y_n_c.html#gacbe845827dd4ad717f3cbc812e66b204">bladerf_sync_rx()</a> call.</p>
<p>This will not be equal to the requested count in the event of a discontinuity (i.e., when the status field has the <a class="el" href="group___f_m_t___m_e_t_a.html#ga5c2c095d1681ffe8928d84c8b4cca714">BLADERF_META_STATUS_OVERRUN</a> flag set). When an overrun occurs, it is important not to read past the number of samples specified by this value, as the remaining contents of the buffer are undefined.</p>
<p>This parameter is not currently used by <a class="el" href="group___f_n___d_a_t_a___s_y_n_c.html#gac4a13bf1cb10d9a3e547b8c654268c35">bladerf_sync_tx()</a>. </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l02951">2951</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="a773b39d480759f67926cb18ae2219281"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t flags</td>
</tr>
</table>
</div><div class="memdoc">
<p>Input bit field to control the behavior of the call that the metadata structure is passed to. API calls read this field from the provided data structure, and do not modify it.</p>
<p>Valid flags include <a class="el" href="group___f_m_t___m_e_t_a.html#ga2aef16902d542172be1b87917d89de10">BLADERF_META_FLAG_TX_BURST_START</a>, <a class="el" href="group___f_m_t___m_e_t_a.html#gaa9a2d61688c4b775b52a0acfed32f50a">BLADERF_META_FLAG_TX_BURST_END</a>, <a class="el" href="group___f_m_t___m_e_t_a.html#ga1b97e995f8d20531427e316fbac3c1f9">BLADERF_META_FLAG_TX_NOW</a>, <a class="el" href="group___f_m_t___m_e_t_a.html#gacc23fedbd8cf35143670969718ca46cb">BLADERF_META_FLAG_TX_UPDATE_TIMESTAMP</a>, and <a class="el" href="group___f_m_t___m_e_t_a.html#ga63edd4df536045366c24df13d2c49899">BLADERF_META_FLAG_RX_NOW</a> </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l02926">2926</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="a60f55957c042aa67ccfc8a0d996c19bb"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t reserved[32]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserved for future use. This is not used by any functions. It is recommended that users zero out this field. </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l02957">2957</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="ade20423e91627f07e610924cb0081623"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t status</td>
</tr>
</table>
</div><div class="memdoc">
<p>Output bit field to denoting the status of transmissions/receptions. API calls will write this field.</p>
<p>Possible status flags include <a class="el" href="group___f_m_t___m_e_t_a.html#ga5c2c095d1681ffe8928d84c8b4cca714">BLADERF_META_STATUS_OVERRUN</a> and <a class="el" href="group___f_m_t___m_e_t_a.html#gae7bfccab53ac74c940fd052e57fbe50b">BLADERF_META_STATUS_UNDERRUN</a>; </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l02936">2936</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="a465bef81f6478756e5443025b1f2ddfa"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint64_t timestamp</td>
</tr>
</table>
</div><div class="memdoc">
<p>Free-running FPGA counter that monotonically increases at the sample rate of the associated module. </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l02913">2913</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a></li>
</ul>
</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>
