SOES/soes/doc/html/structfoe__cfg__t.html

135 lines
5.6 KiB
HTML

<!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"/>
<title>SOES: foe_cfg_t Struct Reference</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<link href="doxygen.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<!-- Generated by Doxygen 1.7.4 -->
<div id="top">
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
<td style="padding-left: 0.5em;">
<div id="projectname">SOES&#160;<span id="projectnumber">v1.0.0</span></div>
</td>
</tr>
</tbody>
</table>
</div>
<div id="navrow1" class="tabs">
<ul class="tablist">
<li><a href="index.html"><span>Main&#160;Page</span></a></li>
<li class="current"><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="files.html"><span>Files</span></a></li>
</ul>
</div>
<div id="navrow2" class="tabs2">
<ul class="tablist">
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li><a href="functions.html"><span>Data&#160;Fields</span></a></li>
</ul>
</div>
</div>
<div class="header">
<div class="summary">
<a href="#pub-attribs">Data Fields</a> </div>
<div class="headertitle">
<div class="title">foe_cfg_t Struct Reference</div> </div>
</div>
<div class="contents">
<!-- doxytag: class="foe_cfg_t" -->
<p><code>#include &lt;esc_foe.h&gt;</code></p>
<table class="memberdecls">
<tr><td colspan="2"><h2><a name="pub-attribs"></a>
Data Fields</h2></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8 *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfoe__cfg__t.html#a401e481b06a1c7e3fcb30a02ad7ddafb">fbuffer</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint8&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfoe__cfg__t.html#a846f4765e3b5973542e18e25665a4a98">empty_write</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfoe__cfg__t.html#a12e068a6428f1cf89d3516d104a905dd">buffer_size</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">uint32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfoe__cfg__t.html#a04948966334af92b549a8f668357e52e">n_files</a></td></tr>
<tr><td class="memItemLeft" align="right" valign="top">foe_writefile_cfg_t *&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="structfoe__cfg__t.html#af7d4da24697018ed33e17a6c12d91ed9">files</a></td></tr>
</table>
<hr/><h2>Field Documentation</h2>
<a class="anchor" id="a12e068a6428f1cf89d3516d104a905dd"></a><!-- doxytag: member="foe_cfg_t::buffer_size" ref="a12e068a6428f1cf89d3516d104a905dd" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32 <a class="el" href="structfoe__cfg__t.html#a12e068a6428f1cf89d3516d104a905dd">foe_cfg_t::buffer_size</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Buffer size before we flush to destination </p>
</div>
</div>
<a class="anchor" id="a846f4765e3b5973542e18e25665a4a98"></a><!-- doxytag: member="foe_cfg_t::empty_write" ref="a846f4765e3b5973542e18e25665a4a98" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8 <a class="el" href="structfoe__cfg__t.html#a846f4765e3b5973542e18e25665a4a98">foe_cfg_t::empty_write</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Write this to fill-up, ex. 0xFF for "non write" </p>
</div>
</div>
<a class="anchor" id="a401e481b06a1c7e3fcb30a02ad7ddafb"></a><!-- doxytag: member="foe_cfg_t::fbuffer" ref="a401e481b06a1c7e3fcb30a02ad7ddafb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint8* <a class="el" href="structfoe__cfg__t.html#a401e481b06a1c7e3fcb30a02ad7ddafb">foe_cfg_t::fbuffer</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Allocate static in caller func to fit buffer_size </p>
</div>
</div>
<a class="anchor" id="af7d4da24697018ed33e17a6c12d91ed9"></a><!-- doxytag: member="foe_cfg_t::files" ref="af7d4da24697018ed33e17a6c12d91ed9" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">foe_writefile_cfg_t* <a class="el" href="structfoe__cfg__t.html#af7d4da24697018ed33e17a6c12d91ed9">foe_cfg_t::files</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Pointer to files configured to be used by FoE </p>
</div>
</div>
<a class="anchor" id="a04948966334af92b549a8f668357e52e"></a><!-- doxytag: member="foe_cfg_t::n_files" ref="a04948966334af92b549a8f668357e52e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">uint32 <a class="el" href="structfoe__cfg__t.html#a04948966334af92b549a8f668357e52e">foe_cfg_t::n_files</a></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>Number of files used in firmware update </p>
</div>
</div>
<hr/>The documentation for this struct was generated from the following file:<ul>
<li><a class="el" href="esc__foe_8h.html">esc_foe.h</a></li>
</ul>
</div>
<hr class="footer"/><address class="footer"><small>Generated on Wed Jul 10 2013 11:14:19 for SOES by&#160;
<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/></a> 1.7.4 </small></address>
</body>
</html>