Skip to content

Commit

Permalink
docs: add docs for backup media 64KB Flash
Browse files Browse the repository at this point in the history
  • Loading branch information
laqieer committed Jul 2, 2021
1 parent 327dbbe commit 8c803b2
Show file tree
Hide file tree
Showing 24 changed files with 731 additions and 31 deletions.
2 changes: 2 additions & 0 deletions docs/dir_d44c64559bbebec7f509842c48db8b23.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,6 +76,8 @@
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gba__eeprom_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gba__eeprom_8h.html">gba_eeprom.h</a> <a href="gba__eeprom_8h_source.html">[code]</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gba__flash_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gba__flash_8h.html">gba_flash.h</a> <a href="gba__flash_8h_source.html">[code]</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:gba__sram_8h"><td class="memItemLeft" align="right" valign="top">file &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="gba__sram_8h.html">gba_sram.h</a> <a href="gba__sram_8h_source.html">[code]</a></td></tr>
<tr class="separator:"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
Expand Down
11 changes: 10 additions & 1 deletion docs/err__def_8h.html
Original file line number Diff line number Diff line change
Expand Up @@ -76,10 +76,15 @@
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a06fc87d81c62e9abb8790b6e5713c55b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <a class="el" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bac3121e429a129b2ccb51a92b7c78c4b4">E_SUCCESS</a> = 0
<tr class="memitem:a06fc87d81c62e9abb8790b6e5713c55b"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom">{ <br />
&#160;&#160;<a class="el" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bac3121e429a129b2ccb51a92b7c78c4b4">E_SUCCESS</a> = 0
, <a class="el" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bae3f8b3898cff048b2d029c22ea796dde">E_INVALID_PARAM</a>
, <a class="el" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bac95aae50914dd67abb66b03f16cb4e36">E_OUT_OF_RANGE</a>
, <a class="el" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba4dcea7ec7e6647fcf78a4d795f847206">E_VERIFY_FAIL</a>
, <br />
&#160;&#160;<a class="el" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba5a0a6eaf461148a87347243490149da7">E_UNSUPPORTED_DEVICE</a>
, <a class="el" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba0bc27e0d9f5ecbf8ee1468a90724e088">E_TIMEOUT</a>
<br />
}</td></tr>
<tr class="separator:a06fc87d81c62e9abb8790b6e5713c55b"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
Expand All @@ -104,6 +109,10 @@ <h2 class="memtitle"><span class="permalink"><a href="#a06fc87d81c62e9abb8790b6e
</td></tr>
<tr><td class="fieldname"><a id="a06fc87d81c62e9abb8790b6e5713c55ba4dcea7ec7e6647fcf78a4d795f847206"></a>E_VERIFY_FAIL&#160;</td><td class="fielddoc"><p>Failed to verify written data. </p>
</td></tr>
<tr><td class="fieldname"><a id="a06fc87d81c62e9abb8790b6e5713c55ba5a0a6eaf461148a87347243490149da7"></a>E_UNSUPPORTED_DEVICE&#160;</td><td class="fielddoc"><p>Flash chip's device type is not supported. </p>
</td></tr>
<tr><td class="fieldname"><a id="a06fc87d81c62e9abb8790b6e5713c55ba0bc27e0d9f5ecbf8ee1468a90724e088"></a>E_TIMEOUT&#160;</td><td class="fielddoc"><p>Operation timeout. </p>
</td></tr>
</table>

</div>
Expand Down
10 changes: 7 additions & 3 deletions docs/err__def_8h_source.html
Original file line number Diff line number Diff line change
Expand Up @@ -77,10 +77,14 @@
<div class="line"><a name="l00006"></a><span class="lineno"><a class="line" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bae3f8b3898cff048b2d029c22ea796dde"> 6</a></span>&#160; <a class="code" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bae3f8b3898cff048b2d029c22ea796dde">E_INVALID_PARAM</a>, </div>
<div class="line"><a name="l00007"></a><span class="lineno"><a class="line" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bac95aae50914dd67abb66b03f16cb4e36"> 7</a></span>&#160; <a class="code" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bac95aae50914dd67abb66b03f16cb4e36">E_OUT_OF_RANGE</a>, </div>
<div class="line"><a name="l00008"></a><span class="lineno"><a class="line" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba4dcea7ec7e6647fcf78a4d795f847206"> 8</a></span>&#160; <a class="code" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba4dcea7ec7e6647fcf78a4d795f847206">E_VERIFY_FAIL</a>, </div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;};</div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160; </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* ERR_DEF_H */</span><span class="preprocessor"></span></div>
<div class="line"><a name="l00009"></a><span class="lineno"><a class="line" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba5a0a6eaf461148a87347243490149da7"> 9</a></span>&#160; <a class="code" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba5a0a6eaf461148a87347243490149da7">E_UNSUPPORTED_DEVICE</a>, </div>
<div class="line"><a name="l00010"></a><span class="lineno"><a class="line" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba0bc27e0d9f5ecbf8ee1468a90724e088"> 10</a></span>&#160; <a class="code" href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba0bc27e0d9f5ecbf8ee1468a90724e088">E_TIMEOUT</a>, </div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;};</div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160; </div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="preprocessor">#endif </span><span class="comment">/* ERR_DEF_H */</span><span class="preprocessor"></span></div>
<div class="ttc" id="aerr__def_8h_html_a06fc87d81c62e9abb8790b6e5713c55ba0bc27e0d9f5ecbf8ee1468a90724e088"><div class="ttname"><a href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba0bc27e0d9f5ecbf8ee1468a90724e088">E_TIMEOUT</a></div><div class="ttdeci">@ E_TIMEOUT</div><div class="ttdoc">Operation timeout.</div><div class="ttdef"><b>Definition:</b> err_def.h:10</div></div>
<div class="ttc" id="aerr__def_8h_html_a06fc87d81c62e9abb8790b6e5713c55ba4dcea7ec7e6647fcf78a4d795f847206"><div class="ttname"><a href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba4dcea7ec7e6647fcf78a4d795f847206">E_VERIFY_FAIL</a></div><div class="ttdeci">@ E_VERIFY_FAIL</div><div class="ttdoc">Failed to verify written data.</div><div class="ttdef"><b>Definition:</b> err_def.h:8</div></div>
<div class="ttc" id="aerr__def_8h_html_a06fc87d81c62e9abb8790b6e5713c55ba5a0a6eaf461148a87347243490149da7"><div class="ttname"><a href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55ba5a0a6eaf461148a87347243490149da7">E_UNSUPPORTED_DEVICE</a></div><div class="ttdeci">@ E_UNSUPPORTED_DEVICE</div><div class="ttdoc">Flash chip's device type is not supported.</div><div class="ttdef"><b>Definition:</b> err_def.h:9</div></div>
<div class="ttc" id="aerr__def_8h_html_a06fc87d81c62e9abb8790b6e5713c55bac3121e429a129b2ccb51a92b7c78c4b4"><div class="ttname"><a href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bac3121e429a129b2ccb51a92b7c78c4b4">E_SUCCESS</a></div><div class="ttdeci">@ E_SUCCESS</div><div class="ttdoc">No error.</div><div class="ttdef"><b>Definition:</b> err_def.h:5</div></div>
<div class="ttc" id="aerr__def_8h_html_a06fc87d81c62e9abb8790b6e5713c55bac95aae50914dd67abb66b03f16cb4e36"><div class="ttname"><a href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bac95aae50914dd67abb66b03f16cb4e36">E_OUT_OF_RANGE</a></div><div class="ttdeci">@ E_OUT_OF_RANGE</div><div class="ttdoc">Address is out of range.</div><div class="ttdef"><b>Definition:</b> err_def.h:7</div></div>
<div class="ttc" id="aerr__def_8h_html_a06fc87d81c62e9abb8790b6e5713c55bae3f8b3898cff048b2d029c22ea796dde"><div class="ttname"><a href="err__def_8h.html#a06fc87d81c62e9abb8790b6e5713c55bae3f8b3898cff048b2d029c22ea796dde">E_INVALID_PARAM</a></div><div class="ttdeci">@ E_INVALID_PARAM</div><div class="ttdoc">Invalid input parameter.</div><div class="ttdef"><b>Definition:</b> err_def.h:6</div></div>
Expand Down
3 changes: 2 additions & 1 deletion docs/files.html
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,8 @@
<tr id="row_0_" class="even"><td class="entry"><span style="width:0px;display:inline-block;">&#160;</span><span id="arr_0_" class="arrow" onclick="toggleFolder('0_')">&#9660;</span><span id="img_0_" class="iconfopen" onclick="toggleFolder('0_')">&#160;</span><a class="el" href="dir_d44c64559bbebec7f509842c48db8b23.html" target="_self">include</a></td><td class="desc"></td></tr>
<tr id="row_0_0_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="err__def_8h_source.html"><span class="icondoc"></span></a><a class="el" href="err__def_8h.html" target="_self">err_def.h</a></td><td class="desc"></td></tr>
<tr id="row_0_1_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="gba__eeprom_8h_source.html"><span class="icondoc"></span></a><a class="el" href="gba__eeprom_8h.html" target="_self">gba_eeprom.h</a></td><td class="desc"></td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="gba__sram_8h_source.html"><span class="icondoc"></span></a><a class="el" href="gba__sram_8h.html" target="_self">gba_sram.h</a></td><td class="desc"></td></tr>
<tr id="row_0_2_"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="gba__flash_8h_source.html"><span class="icondoc"></span></a><a class="el" href="gba__flash_8h.html" target="_self">gba_flash.h</a></td><td class="desc"></td></tr>
<tr id="row_0_3_" class="even"><td class="entry"><span style="width:32px;display:inline-block;">&#160;</span><a href="gba__sram_8h_source.html"><span class="icondoc"></span></a><a class="el" href="gba__sram_8h.html" target="_self">gba_sram.h</a></td><td class="desc"></td></tr>
</table>
</div><!-- directory -->
</div><!-- contents -->
Expand Down
Loading

0 comments on commit 8c803b2

Please sign in to comment.