<!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_image 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_image Struct Reference<div class="ingroups"><a class="el" href="group___f_n___i_m_a_g_e.html">Flash image format</a></div></div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<div class="textblock"><p>Image format for backing up and restoring bladeRF flash contents</p>
<p>The on disk format generated by the bladerf_image_write function is a serialized version of this structure and its contents. When written to disk, values are converted to big-endian byte order, for ease of reading in a hex editor.</p>
<p>When creating and using a <a class="el" href="structbladerf__image.html">bladerf_image</a> of type BLADERF_IMAGE_TYPE_RAW, the address and length fields must be erase-block aligned. </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03688">3688</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:a91f000c62f901f00281ae577cb054c67"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__image.html#a91f000c62f901f00281ae577cb054c67">magic</a> [<a class="el" href="group___f_n___i_m_a_g_e.html#ga7297bc686ce62eee043b1bc41ec870e5">BLADERF_IMAGE_MAGIC_LEN</a>+1]</td></tr>
<tr class="separator:a91f000c62f901f00281ae577cb054c67"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a46c22fe33486cccc7f1792463d0ee8da"><td class="memItemLeft" align="right" valign="top">uint8_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__image.html#a46c22fe33486cccc7f1792463d0ee8da">checksum</a> [<a class="el" href="group___f_n___i_m_a_g_e.html#gafca19d753cc94ef889a59476ca916b0a">BLADERF_IMAGE_CHECKSUM_LEN</a>]</td></tr>
<tr class="separator:a46c22fe33486cccc7f1792463d0ee8da"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a43d7274c288b72f4cc877d48042f2f2c"><td class="memItemLeft" align="right" valign="top">struct <a class="el" href="structbladerf__version.html">bladerf_version</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__image.html#a43d7274c288b72f4cc877d48042f2f2c">version</a></td></tr>
<tr class="separator:a43d7274c288b72f4cc877d48042f2f2c"><td class="memSeparator" colspan="2"> </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__image.html#a465bef81f6478756e5443025b1f2ddfa">timestamp</a></td></tr>
<tr class="separator:a465bef81f6478756e5443025b1f2ddfa"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aaa74f66cc1ee926c3c8e871411c8fa5f"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__image.html#aaa74f66cc1ee926c3c8e871411c8fa5f">serial</a> [<a class="el" href="group___f_n___i_n_i_t.html#ga71d5667028394cdb4ec7b5b9110834c7">BLADERF_SERIAL_LENGTH</a>+1]</td></tr>
<tr class="separator:aaa74f66cc1ee926c3c8e871411c8fa5f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:a109b0c141251e496ab3b3b6588dec2f0"><td class="memItemLeft" align="right" valign="top">char </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__image.html#a109b0c141251e496ab3b3b6588dec2f0">reserved</a> [<a class="el" href="group___f_n___i_m_a_g_e.html#ga3e72319dec467b8e0d95aedc7fb06d8d">BLADERF_IMAGE_RESERVED_LEN</a>]</td></tr>
<tr class="separator:a109b0c141251e496ab3b3b6588dec2f0"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:af9f42cdfa1fceaec8db32c7ff98a96bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="group___f_n___i_m_a_g_e.html#ga1aa4fb0b92b337280968c0a536080759">bladerf_image_type</a> </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__image.html#af9f42cdfa1fceaec8db32c7ff98a96bf">type</a></td></tr>
<tr class="separator:af9f42cdfa1fceaec8db32c7ff98a96bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ac0d31ca829f934cccd89f8054e02773e"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__image.html#ac0d31ca829f934cccd89f8054e02773e">address</a></td></tr>
<tr class="separator:ac0d31ca829f934cccd89f8054e02773e"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:aebb70c2aab3407a9f05334c47131a43b"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__image.html#aebb70c2aab3407a9f05334c47131a43b">length</a></td></tr>
<tr class="separator:aebb70c2aab3407a9f05334c47131a43b"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:abe222f6d3581e7920dcad5306cc906a8"><td class="memItemLeft" align="right" valign="top">uint8_t * </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__image.html#abe222f6d3581e7920dcad5306cc906a8">data</a></td></tr>
<tr class="separator:abe222f6d3581e7920dcad5306cc906a8"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Field Documentation</h2>
<a class="anchor" id="ac0d31ca829f934cccd89f8054e02773e"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t address</td>
</tr>
</table>
</div><div class="memdoc">
<p>Address of the flash data in this image. A value of 0xffffffff implies that this field is left unspecified (i.e., "don't care"). </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03739">3739</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="a46c22fe33486cccc7f1792463d0ee8da"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t checksum[<a class="el" href="group___f_n___i_m_a_g_e.html#gafca19d753cc94ef889a59476ca916b0a">BLADERF_IMAGE_CHECKSUM_LEN</a>]</td>
</tr>
</table>
</div><div class="memdoc">
<p>SHA256 checksum of the flash image. This is computed over the entire image, with this field filled with 0's. </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03703">3703</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="abe222f6d3581e7920dcad5306cc906a8"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8_t* data</td>
</tr>
</table>
</div><div class="memdoc">
<p>Image data </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03745">3745</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="aebb70c2aab3407a9f05334c47131a43b"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32_t length</td>
</tr>
</table>
</div><div class="memdoc">
<p>Length of the data contained in the image </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03742">3742</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="a91f000c62f901f00281ae577cb054c67"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char magic[<a class="el" href="group___f_n___i_m_a_g_e.html#ga7297bc686ce62eee043b1bc41ec870e5">BLADERF_IMAGE_MAGIC_LEN</a>+1]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Magic value used to identify image file format.</p>
<p>Note that an extra character is added to store a NUL-terminator, to allow this field to be printed. This NUL-terminator is <em>NOT</em> written in the serialized image. </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03697">3697</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="a109b0c141251e496ab3b3b6588dec2f0"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char reserved[<a class="el" href="group___f_n___i_m_a_g_e.html#ga3e72319dec467b8e0d95aedc7fb06d8d">BLADERF_IMAGE_RESERVED_LEN</a>]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Reserved for future metadata. Should be 0's. </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03728">3728</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="aaa74f66cc1ee926c3c8e871411c8fa5f"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">char serial[<a class="el" href="group___f_n___i_n_i_t.html#ga71d5667028394cdb4ec7b5b9110834c7">BLADERF_SERIAL_LENGTH</a>+1]</td>
</tr>
</table>
</div><div class="memdoc">
<p>Serial number of the device that the image was obtained from. This field should be all '\0' if irrelevant.</p>
<p>The +1 here is actually extraneous; BLADERF_SERIAL_LENGTH already accounts for a NUL terminator. However, this is left here to avoid breaking backwards compatibility. </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03723">3723</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>UTC image timestamp, in seconds since the Unix Epoch </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03713">3713</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="af9f42cdfa1fceaec8db32c7ff98a96bf"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname"><a class="el" href="group___f_n___i_m_a_g_e.html#ga1aa4fb0b92b337280968c0a536080759">bladerf_image_type</a> type</td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of data contained in the image. Serialized as a uint32_t. </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03733">3733</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="a43d7274c288b72f4cc877d48042f2f2c"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structbladerf__version.html">bladerf_version</a> version</td>
</tr>
</table>
</div><div class="memdoc">
<p>Image format version. Only the major, minor, and patch fields are written to the disk; the describe field is not used. The version is serialized as: [major | minor | patch] </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03710">3710</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>
