<!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: Flash image format</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="#nested-classes">Data Structures</a> |
<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">Flash image format</div> </div>
</div><!--header-->
<div class="contents">
<a name="details" id="details"></a><h2 class="groupheader">Description</h2>
<p>This section contains a file format and associated routines for storing and loading flash contents with metadata.</p>
<p>These functions are thread-safe. </p>
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="nested-classes"></a>
Data Structures</h2></td></tr>
<tr class="memitem:"><td class="memItemLeft" align="right" valign="top">struct  </td><td class="memItemRight" valign="bottom"><a class="el" href="structbladerf__image.html">bladerf_image</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2"> </td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:ga7297bc686ce62eee043b1bc41ec870e5"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_m_a_g_e.html#ga7297bc686ce62eee043b1bc41ec870e5">BLADERF_IMAGE_MAGIC_LEN</a>   7</td></tr>
<tr class="separator:ga7297bc686ce62eee043b1bc41ec870e5"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:gafca19d753cc94ef889a59476ca916b0a"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_m_a_g_e.html#gafca19d753cc94ef889a59476ca916b0a">BLADERF_IMAGE_CHECKSUM_LEN</a>   32</td></tr>
<tr class="separator:gafca19d753cc94ef889a59476ca916b0a"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga3e72319dec467b8e0d95aedc7fb06d8d"><td class="memItemLeft" align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_m_a_g_e.html#ga3e72319dec467b8e0d95aedc7fb06d8d">BLADERF_IMAGE_RESERVED_LEN</a>   128</td></tr>
<tr class="separator:ga3e72319dec467b8e0d95aedc7fb06d8d"><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:ga1aa4fb0b92b337280968c0a536080759"><td class="memItemLeft" align="right" valign="top">enum  </td><td class="memItemRight" valign="bottom"><a class="el" href="group___f_n___i_m_a_g_e.html#ga1aa4fb0b92b337280968c0a536080759">bladerf_image_type</a> { <br />
  <a class="el" href="group___f_n___i_m_a_g_e.html#gga1aa4fb0b92b337280968c0a536080759a546a21715b5879fcc3c07f1ead99a118">BLADERF_IMAGE_TYPE_INVALID</a> = -1,
<a class="el" href="group___f_n___i_m_a_g_e.html#gga1aa4fb0b92b337280968c0a536080759ab72a785923a7c764f0374cbed5093a94">BLADERF_IMAGE_TYPE_RAW</a>,
<a class="el" href="group___f_n___i_m_a_g_e.html#gga1aa4fb0b92b337280968c0a536080759a38908f1cb1b26d8650c900b8ae67dd5d">BLADERF_IMAGE_TYPE_FIRMWARE</a>,
<a class="el" href="group___f_n___i_m_a_g_e.html#gga1aa4fb0b92b337280968c0a536080759a59775c2bca93dd1e41d2dd12da7ba365">BLADERF_IMAGE_TYPE_FPGA_40KLE</a>,
<br />
  <a class="el" href="group___f_n___i_m_a_g_e.html#gga1aa4fb0b92b337280968c0a536080759aec3992176cde80e1788622e3b96367e7">BLADERF_IMAGE_TYPE_FPGA_115KLE</a>,
<a class="el" href="group___f_n___i_m_a_g_e.html#gga1aa4fb0b92b337280968c0a536080759a4ea36b4e2e0a6dd96a3226e2282e8faa">BLADERF_IMAGE_TYPE_CALIBRATION</a>,
<a class="el" href="group___f_n___i_m_a_g_e.html#gga1aa4fb0b92b337280968c0a536080759a5be81cfec5a09d1867acf051822cd698">BLADERF_IMAGE_TYPE_RX_DC_CAL</a>,
<a class="el" href="group___f_n___i_m_a_g_e.html#gga1aa4fb0b92b337280968c0a536080759a6dd8bc2de905f3f7eccebfe04d292304">BLADERF_IMAGE_TYPE_TX_DC_CAL</a>,
<br />
  <a class="el" href="group___f_n___i_m_a_g_e.html#gga1aa4fb0b92b337280968c0a536080759a4ff575efb549451af1477812d9fea3ec">BLADERF_IMAGE_TYPE_RX_IQ_CAL</a>,
<a class="el" href="group___f_n___i_m_a_g_e.html#gga1aa4fb0b92b337280968c0a536080759a68c483815b7677ae4b953e5f3a902c50">BLADERF_IMAGE_TYPE_TX_IQ_CAL</a>
<br />
}</td></tr>
<tr class="separator:ga1aa4fb0b92b337280968c0a536080759"><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:gada0d4f8c3241a1f7b95e4a2899e7a1d9"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> struct <a class="el" href="structbladerf__image.html">bladerf_image</a> *<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___i_m_a_g_e.html#gada0d4f8c3241a1f7b95e4a2899e7a1d9">bladerf_alloc_image</a> (<a class="el" href="group___f_n___i_m_a_g_e.html#ga1aa4fb0b92b337280968c0a536080759">bladerf_image_type</a> type, uint32_t address, uint32_t length)</td></tr>
<tr class="separator:gada0d4f8c3241a1f7b95e4a2899e7a1d9"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga244960c96d1fabe8660d540191c911bf"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> struct <a class="el" href="structbladerf__image.html">bladerf_image</a> *<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___i_m_a_g_e.html#ga244960c96d1fabe8660d540191c911bf">bladerf_alloc_cal_image</a> (<a class="el" href="group___f_n___i_n_f_o.html#ga4aa81f78e6aebb2f764d608d5e7f3e54">bladerf_fpga_size</a> fpga_size, uint16_t vctcxo_trim)</td></tr>
<tr class="separator:ga244960c96d1fabe8660d540191c911bf"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga5a232da3c5bef2860d1e9c0e417c95e3"><td class="memItemLeft" align="right" valign="top"><a class="el" href="libblade_r_f_8h.html#a5e3652cae8b48c1ad174f0b06bbd06d0">API_EXPORT</a> void <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___i_m_a_g_e.html#ga5a232da3c5bef2860d1e9c0e417c95e3">bladerf_free_image</a> (struct <a class="el" href="structbladerf__image.html">bladerf_image</a> *image)</td></tr>
<tr class="separator:ga5a232da3c5bef2860d1e9c0e417c95e3"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga75dab015d7ea3fdeb159b111092ed99f"><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___i_m_a_g_e.html#ga75dab015d7ea3fdeb159b111092ed99f">bladerf_image_write</a> (struct <a class="el" href="structbladerf__image.html">bladerf_image</a> *image, const char *file)</td></tr>
<tr class="separator:ga75dab015d7ea3fdeb159b111092ed99f"><td class="memSeparator" colspan="2"> </td></tr>
<tr class="memitem:ga086d8ec1767e718627502cc595769956"><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___i_m_a_g_e.html#ga086d8ec1767e718627502cc595769956">bladerf_image_read</a> (struct <a class="el" href="structbladerf__image.html">bladerf_image</a> *image, const char *file)</td></tr>
<tr class="separator:ga086d8ec1767e718627502cc595769956"><td class="memSeparator" colspan="2"> </td></tr>
</table>
<h2 class="groupheader">Macro Definition Documentation</h2>
<a class="anchor" id="gafca19d753cc94ef889a59476ca916b0a"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BLADERF_IMAGE_CHECKSUM_LEN   32</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of bladeRF flash image checksum </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03670">3670</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga7297bc686ce62eee043b1bc41ec870e5"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BLADERF_IMAGE_MAGIC_LEN   7</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of the magic signature at the beginning of bladeRF image files </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03665">3665</a> of file <a class="el" href="libblade_r_f_8h_source.html">libbladeRF.h</a>.</p>
</div>
</div>
<a class="anchor" id="ga3e72319dec467b8e0d95aedc7fb06d8d"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define BLADERF_IMAGE_RESERVED_LEN   128</td>
</tr>
</table>
</div><div class="memdoc">
<p>Size of reserved region of flash image </p>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03675">3675</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="ga1aa4fb0b92b337280968c0a536080759"></a>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="group___f_n___i_m_a_g_e.html#ga1aa4fb0b92b337280968c0a536080759">bladerf_image_type</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Type of data stored in a flash image </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a class="anchor" id="gga1aa4fb0b92b337280968c0a536080759a546a21715b5879fcc3c07f1ead99a118"></a>BLADERF_IMAGE_TYPE_INVALID </td><td class="fielddoc">
<p>Used to denote invalid value </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga1aa4fb0b92b337280968c0a536080759ab72a785923a7c764f0374cbed5093a94"></a>BLADERF_IMAGE_TYPE_RAW </td><td class="fielddoc">
<p>Misc. raw data </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga1aa4fb0b92b337280968c0a536080759a38908f1cb1b26d8650c900b8ae67dd5d"></a>BLADERF_IMAGE_TYPE_FIRMWARE </td><td class="fielddoc">
<p>Firmware data </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga1aa4fb0b92b337280968c0a536080759a59775c2bca93dd1e41d2dd12da7ba365"></a>BLADERF_IMAGE_TYPE_FPGA_40KLE </td><td class="fielddoc">
<p>FPGA bitstream for 40 KLE device </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga1aa4fb0b92b337280968c0a536080759aec3992176cde80e1788622e3b96367e7"></a>BLADERF_IMAGE_TYPE_FPGA_115KLE </td><td class="fielddoc">
<p>FPGA bitstream for 115 KLE device </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga1aa4fb0b92b337280968c0a536080759a4ea36b4e2e0a6dd96a3226e2282e8faa"></a>BLADERF_IMAGE_TYPE_CALIBRATION </td><td class="fielddoc">
<p>Board calibration </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga1aa4fb0b92b337280968c0a536080759a5be81cfec5a09d1867acf051822cd698"></a>BLADERF_IMAGE_TYPE_RX_DC_CAL </td><td class="fielddoc">
<p>RX DC offset calibration table </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga1aa4fb0b92b337280968c0a536080759a6dd8bc2de905f3f7eccebfe04d292304"></a>BLADERF_IMAGE_TYPE_TX_DC_CAL </td><td class="fielddoc">
<p>TX DC offset calibration table </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga1aa4fb0b92b337280968c0a536080759a4ff575efb549451af1477812d9fea3ec"></a>BLADERF_IMAGE_TYPE_RX_IQ_CAL </td><td class="fielddoc">
<p>RX IQ balance calibration table </p>
</td></tr>
<tr><td class="fieldname"><a class="anchor" id="gga1aa4fb0b92b337280968c0a536080759a68c483815b7677ae4b953e5f3a902c50"></a>BLADERF_IMAGE_TYPE_TX_IQ_CAL </td><td class="fielddoc">
<p>TX IQ balance calibration table </p>
</td></tr>
</table>
<p>Definition at line <a class="el" href="libblade_r_f_8h_source.html#l03649">3649</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="ga244960c96d1fabe8660d540191c911bf"></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> struct <a class="el" href="structbladerf__image.html">bladerf_image</a>* <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_alloc_cal_image </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___f_n___i_n_f_o.html#ga4aa81f78e6aebb2f764d608d5e7f3e54">bladerf_fpga_size</a> </td>
<td class="paramname"><em>fpga_size</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint16_t </td>
<td class="paramname"><em>vctcxo_trim</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Create a flash image initialized to contain a calibration data region. This is intended to be used in conjunction with <a class="el" href="group___f_n___i_m_a_g_e.html#ga75dab015d7ea3fdeb159b111092ed99f">bladerf_image_write()</a>, or a write of the image's <code>data</code> field to flash.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fpga_size</td><td>Target FPGA size </td></tr>
<tr><td class="paramname">vctcxo_trim</td><td>VCTCXO oscillator trim value.</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>Pointer to allocated and initialized structure on success, NULL on memory allocation failure </dd></dl>
</div>
</div>
<a class="anchor" id="gada0d4f8c3241a1f7b95e4a2899e7a1d9"></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> struct <a class="el" href="structbladerf__image.html">bladerf_image</a>* <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_alloc_image </td>
<td>(</td>
<td class="paramtype"><a class="el" href="group___f_n___i_m_a_g_e.html#ga1aa4fb0b92b337280968c0a536080759">bladerf_image_type</a> </td>
<td class="paramname"><em>type</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>address</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t </td>
<td class="paramname"><em>length</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Allocate and initialize an image structure.</p>
<p>This following <a class="el" href="structbladerf__image.html">bladerf_image</a> fields are populated: <code>magic</code>, <code>version</code>, <code>timestamp</code>, <code>type</code>, <code>address</code>, and <code>length</code></p>
<p>The following <a class="el" href="structbladerf__image.html">bladerf_image</a> fields are zeroed out: <code>checksum</code>, <code>serial</code>, and <code>reserved</code>,</p>
<p>If the <code>length</code> parameter is not 0, the <a class="el" href="structbladerf__image.html">bladerf_image</a> <code>data</code> field will be dynamically allocated. Otherwise, <code>data</code> will be set to NULL.</p>
<dl class="section note"><dt>Note</dt><dd>A non-zero <code>lenth</code> should be use only with <a class="el" href="group___f_n___i_m_a_g_e.html#ga75dab015d7ea3fdeb159b111092ed99f">bladerf_image_write()</a>; <a class="el" href="group___f_n___i_m_a_g_e.html#ga086d8ec1767e718627502cc595769956">bladerf_image_read()</a> allocates and sets <code>data</code> based upon size of the image contents, and does not attempt to free() the <code>data</code> field before setting it.</dd></dl>
<p>The <code>address</code> and <code>length</code> fields should be set 0 when reading an image from a file.</p>
<dl class="section return"><dt>Returns</dt><dd>Pointer to allocated and initialized structure on success, NULL on memory allocation failure or invalid address/length. </dd></dl>
</div>
</div>
<a class="anchor" id="ga5a232da3c5bef2860d1e9c0e417c95e3"></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> void <a class="el" href="libblade_r_f_8h.html#a66285a1fe575693f5f275b212891222e">CALL_CONV</a> bladerf_free_image </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structbladerf__image.html">bladerf_image</a> * </td>
<td class="paramname"><em>image</em></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Free a <a class="el" href="structbladerf__image.html">bladerf_image</a> previously obtained via bladerf_alloc_image. If the <a class="el" href="structbladerf__image.html">bladerf_image</a>'s <code>data</code> field is non-NULL, it will be freed. </p>
</div>
</div>
<a class="anchor" id="ga086d8ec1767e718627502cc595769956"></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_image_read </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structbladerf__image.html">bladerf_image</a> * </td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Read flash image from a file.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[out]</td><td class="paramname">image</td><td>Flash image structure to populate.</td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File to read image from.</td></tr>
</table>
</dd>
</dl>
<dl class="section pre"><dt>Precondition</dt><dd>The <code>image</code> parameter has been obtained via a call to <a class="el" href="group___f_n___i_m_a_g_e.html#gada0d4f8c3241a1f7b95e4a2899e7a1d9">bladerf_alloc_image()</a>, with a <code>length</code> of 0.</dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd>The <code>image</code> fields will be populated upon success, overwriting any previous values.</dd></dl>
<dl class="section note"><dt>Note</dt><dd>The contents of the <code>image</code> paramater should not be used if this function fails.</dd></dl>
<dl class="section return"><dt>Returns</dt><dd>0 upon success,<br />
BLADERF_ERR_CHECKSUM upon detecting a checksum mismatch,<br />
BLADERF_ERR_INVAL if any image fields are invalid,<br />
BLADERF_ERR_IO on a file I/O error,<br />
or a value from <a class="el" href="group___r_e_t_c_o_d_e_s.html">Error codes</a> list on any other failure<br />
</dd></dl>
</div>
</div>
<a class="anchor" id="ga75dab015d7ea3fdeb159b111092ed99f"></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_image_write </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structbladerf__image.html">bladerf_image</a> * </td>
<td class="paramname"><em>image</em>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">const char * </td>
<td class="paramname"><em>file</em> </td>
</tr>
<tr>
<td></td>
<td>)</td>
<td></td><td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Write a flash image to a file.</p>
<p>This function will fill in the checksum field before writing the contents to the specified file. The user-supplied contents of this field are ignored.</p>
<dl class="section pre"><dt>Precondition</dt><dd><code>image</code> has been initialized using <a class="el" href="group___f_n___i_m_a_g_e.html#gada0d4f8c3241a1f7b95e4a2899e7a1d9">bladerf_alloc_image()</a> </dd></dl>
<dl class="section post"><dt>Postcondition</dt><dd><code>image->checksum</code> will be populated if this function succeeds</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramdir">[in]</td><td class="paramname">image</td><td>Flash image </td></tr>
<tr><td class="paramdir">[in]</td><td class="paramname">file</td><td>File to write the flash image to</td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>0 upon success, or a 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>
