aaron/discoverpixy
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Updated docu.

Browse Source
This commit is contained in:
Timo Lang
2015-06-08 11:04:50 +02:00
parent 86eb39b3a8
commit 42b6e3af36
202 changed files with 11953 additions and 976 deletions
Download Patch File Download Diff File Expand all files Collapse all files

177
filesystem_8c_source.html Normal file
View File

@@ -0,0 +1,177 @@
<!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.9.1"/>
<title>discoverpixy: common/filesystem/filesystem.c Source File</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>
<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 style="padding-left: 0.5em;">
<div id="projectname">discoverpixy
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.9.1 -->
<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&#160;Page</span></a></li>
<li><a href="modules.html"><span>Modules</span></a></li>
<li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
<li class="current"><a href="files.html"><span>Files</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="files.html"><span>File&#160;List</span></a></li>
<li><a href="globals.html"><span>Globals</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 id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_bdd9a5d540de89e9fe90efdfc6973a4f.html">common</a></li><li class="navelem"><a class="el" href="dir_0a50ab14f1d261d61cd33403a26c32cc.html">filesystem</a></li> </ul>
</div>
</div><!-- top -->
<div class="header">
<div class="headertitle">
<div class="title">filesystem.c</div> </div>
</div><!--header-->
<div class="contents">
<a href="filesystem_8c.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span>&#160;<span class="comment">/**************************************************************************************************************************************</span></div>
<div class="line"><a name="l00002"></a><span class="lineno"> 2</span>&#160;<span class="comment">* Project: discoverpixy</span></div>
<div class="line"><a name="l00003"></a><span class="lineno"> 3</span>&#160;<span class="comment">* Website: https://github.com/t-moe/discoverpixy</span></div>
<div class="line"><a name="l00004"></a><span class="lineno"> 4</span>&#160;<span class="comment">* Authors: Aaron Schmocker, Timo Lang</span></div>
<div class="line"><a name="l00005"></a><span class="lineno"> 5</span>&#160;<span class="comment">* Institution: BFH Bern University of Applied Sciences</span></div>
<div class="line"><a name="l00006"></a><span class="lineno"> 6</span>&#160;<span class="comment">* File: common/filesystem/filesystem.c</span></div>
<div class="line"><a name="l00007"></a><span class="lineno"> 7</span>&#160;<span class="comment">*</span></div>
<div class="line"><a name="l00008"></a><span class="lineno"> 8</span>&#160;<span class="comment">* Version History:</span></div>
<div class="line"><a name="l00009"></a><span class="lineno"> 9</span>&#160;<span class="comment">* Date Autor Email SHA Changes</span></div>
<div class="line"><a name="l00010"></a><span class="lineno"> 10</span>&#160;<span class="comment">* 2015-05-10 timolang@gmail.com e2bce8f Added filesystem module, tests and implementation for it in emulator.</span></div>
<div class="line"><a name="l00011"></a><span class="lineno"> 11</span>&#160;<span class="comment">* 2015-05-15 timolang@gmail.com 9a16865 Added doxgen comments to filesyste, checkbox, numupdown and screen module. And some minor changes to the other modules.</span></div>
<div class="line"><a name="l00012"></a><span class="lineno"> 12</span>&#160;<span class="comment">*</span></div>
<div class="line"><a name="l00013"></a><span class="lineno"> 13</span>&#160;<span class="comment">**************************************************************************************************************************************/</span></div>
<div class="line"><a name="l00014"></a><span class="lineno"> 14</span>&#160;</div>
<div class="line"><a name="l00015"></a><span class="lineno"> 15</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="filesystem_8h.html">filesystem.h</a>&quot;</span></div>
<div class="line"><a name="l00016"></a><span class="lineno"> 16</span>&#160;<span class="preprocessor">#include &quot;<a class="code" href="ll__filesystem_8h.html">ll_filesystem.h</a>&quot;</span></div>
<div class="line"><a name="l00017"></a><span class="lineno"> 17</span>&#160;</div>
<div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="group__filesystem.html#ga367ec5e73c77ddf5047d05021cf97a8f"> 18</a></span>&#160;<span class="keywordtype">bool</span> <a class="code" href="group__filesystem.html#ga367ec5e73c77ddf5047d05021cf97a8f">filesystem_init</a>()</div>
<div class="line"><a name="l00019"></a><span class="lineno"> 19</span>&#160;{</div>
<div class="line"><a name="l00020"></a><span class="lineno"> 20</span>&#160; <span class="keywordflow">return</span> <a class="code" href="group__ll__filesystem.html#ga5e9b54813d51bd15dff031285911a95e">ll_filesystem_init</a>();</div>
<div class="line"><a name="l00021"></a><span class="lineno"> 21</span>&#160;}</div>
<div class="line"><a name="l00022"></a><span class="lineno"> 22</span>&#160;</div>
<div class="line"><a name="l00023"></a><span class="lineno"><a class="line" href="group__filesystem.html#ga8b1099cbd3464fbe64f2010f16d87101"> 23</a></span>&#160;<a class="code" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a>* <a class="code" href="group__filesystem.html#ga8b1099cbd3464fbe64f2010f16d87101">filesystem_dir_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* path)</div>
<div class="line"><a name="l00024"></a><span class="lineno"> 24</span>&#160;{</div>
<div class="line"><a name="l00025"></a><span class="lineno"> 25</span>&#160; <span class="keywordflow">return</span> <a class="code" href="group__ll__filesystem.html#ga572cb127d4e8affa9701d8562397389e">ll_filesystem_dir_open</a>(path);</div>
<div class="line"><a name="l00026"></a><span class="lineno"> 26</span>&#160;}</div>
<div class="line"><a name="l00027"></a><span class="lineno"> 27</span>&#160;</div>
<div class="line"><a name="l00028"></a><span class="lineno"><a class="line" href="group__filesystem.html#gab8001e040f37dc57b18e4155532b59ce"> 28</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__filesystem.html#gab8001e040f37dc57b18e4155532b59ce">filesystem_dir_close</a>(<a class="code" href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a>* dir)</div>
<div class="line"><a name="l00029"></a><span class="lineno"> 29</span>&#160;{</div>
<div class="line"><a name="l00030"></a><span class="lineno"> 30</span>&#160; <a class="code" href="group__ll__filesystem.html#ga43292876112535a7cf9bb26201ed8096">ll_filesystem_dir_close</a>(dir);</div>
<div class="line"><a name="l00031"></a><span class="lineno"> 31</span>&#160;}</div>
<div class="line"><a name="l00032"></a><span class="lineno"> 32</span>&#160;</div>
<div class="line"><a name="l00033"></a><span class="lineno"><a class="line" href="group__filesystem.html#gabd043128e80a4f0573b1360d921b046c"> 33</a></span>&#160;<a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* <a class="code" href="group__filesystem.html#gabd043128e80a4f0573b1360d921b046c">filesystem_file_open</a>(<span class="keyword">const</span> <span class="keywordtype">char</span>* filename)</div>
<div class="line"><a name="l00034"></a><span class="lineno"> 34</span>&#160;{</div>
<div class="line"><a name="l00035"></a><span class="lineno"> 35</span>&#160; <span class="keywordflow">return</span> <a class="code" href="group__ll__filesystem.html#ga61e4a1cdb3435031c3a9df014ab21d08">ll_filesystem_file_open</a>(filename);</div>
<div class="line"><a name="l00036"></a><span class="lineno"> 36</span>&#160;}</div>
<div class="line"><a name="l00037"></a><span class="lineno"> 37</span>&#160;</div>
<div class="line"><a name="l00038"></a><span class="lineno"><a class="line" href="group__filesystem.html#ga0e6cc31bf4c889249e13254306994c2f"> 38</a></span>&#160;<span class="keywordtype">void</span> <a class="code" href="group__filesystem.html#ga0e6cc31bf4c889249e13254306994c2f">filesystem_file_close</a>(<a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* handle)</div>
<div class="line"><a name="l00039"></a><span class="lineno"> 39</span>&#160;{</div>
<div class="line"><a name="l00040"></a><span class="lineno"> 40</span>&#160; <a class="code" href="group__ll__filesystem.html#ga847113d1c2bffa87807991e2c047bd17">ll_filesystem_file_close</a>(handle);</div>
<div class="line"><a name="l00041"></a><span class="lineno"> 41</span>&#160;}</div>
<div class="line"><a name="l00042"></a><span class="lineno"> 42</span>&#160;</div>
<div class="line"><a name="l00043"></a><span class="lineno"><a class="line" href="group__filesystem.html#gac447af479c334caa207d6c279571d8a2"> 43</a></span>&#160;<a class="code" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a> <a class="code" href="group__filesystem.html#gac447af479c334caa207d6c279571d8a2">filesystem_file_seek</a>(<a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* handle, uint32_t offset)</div>
<div class="line"><a name="l00044"></a><span class="lineno"> 44</span>&#160;{</div>
<div class="line"><a name="l00045"></a><span class="lineno"> 45</span>&#160; <span class="keywordflow">return</span> <a class="code" href="group__ll__filesystem.html#ga27b21c519c928bc7767fbdcbb9209148">ll_filesystem_file_seek</a>(handle, offset);</div>
<div class="line"><a name="l00046"></a><span class="lineno"> 46</span>&#160;}</div>
<div class="line"><a name="l00047"></a><span class="lineno"> 47</span>&#160;</div>
<div class="line"><a name="l00048"></a><span class="lineno"><a class="line" href="group__filesystem.html#ga9e7f715d0000e7b99e2b4732416a0221"> 48</a></span>&#160;<a class="code" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a> <a class="code" href="group__filesystem.html#ga9e7f715d0000e7b99e2b4732416a0221">filesystem_file_read</a>(<a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* handle, uint8_t* buf, uint32_t size)</div>
<div class="line"><a name="l00049"></a><span class="lineno"> 49</span>&#160;{</div>
<div class="line"><a name="l00050"></a><span class="lineno"> 50</span>&#160; <span class="keywordflow">return</span> <a class="code" href="group__ll__filesystem.html#ga8826f1d0e79cc734ea38315e5516f109">ll_filesystem_file_read</a>(handle, buf, size);</div>
<div class="line"><a name="l00051"></a><span class="lineno"> 51</span>&#160;}</div>
<div class="line"><a name="l00052"></a><span class="lineno"> 52</span>&#160;</div>
<div class="line"><a name="l00053"></a><span class="lineno"><a class="line" href="group__filesystem.html#gae7124857f3ab32f6032ef129f2a80000"> 53</a></span>&#160;<a class="code" href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a> <a class="code" href="group__filesystem.html#gae7124857f3ab32f6032ef129f2a80000">filesystem_file_write</a>(<a class="code" href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a>* handle, uint8_t* buf, uint32_t size)</div>
<div class="line"><a name="l00054"></a><span class="lineno"> 54</span>&#160;{</div>
<div class="line"><a name="l00055"></a><span class="lineno"> 55</span>&#160; <span class="keywordflow">return</span> <a class="code" href="group__ll__filesystem.html#gab7ce3131ebbf7c556c9ebeea312fce02">ll_filesystem_file_write</a>(handle, buf, size);</div>
<div class="line"><a name="l00056"></a><span class="lineno"> 56</span>&#160;}</div>
<div class="ttc" id="group__filesystem_html_gac447af479c334caa207d6c279571d8a2"><div class="ttname"><a href="group__filesystem.html#gac447af479c334caa207d6c279571d8a2">filesystem_file_seek</a></div><div class="ttdeci">FILE_STATUS filesystem_file_seek(FILE_HANDLE *handle, uint32_t offset)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00043">filesystem.c:43</a></div></div>
<div class="ttc" id="group__ll__filesystem_html_ga27b21c519c928bc7767fbdcbb9209148"><div class="ttname"><a href="group__ll__filesystem.html#ga27b21c519c928bc7767fbdcbb9209148">ll_filesystem_file_seek</a></div><div class="ttdeci">FILE_STATUS ll_filesystem_file_seek(FILE_HANDLE *handle, uint32_t offset)</div></div>
<div class="ttc" id="group__ll__filesystem_html_ga5e9b54813d51bd15dff031285911a95e"><div class="ttname"><a href="group__ll__filesystem.html#ga5e9b54813d51bd15dff031285911a95e">ll_filesystem_init</a></div><div class="ttdeci">bool ll_filesystem_init()</div></div>
<div class="ttc" id="group__ll__filesystem_html_ga847113d1c2bffa87807991e2c047bd17"><div class="ttname"><a href="group__ll__filesystem.html#ga847113d1c2bffa87807991e2c047bd17">ll_filesystem_file_close</a></div><div class="ttdeci">void ll_filesystem_file_close(FILE_HANDLE *handle)</div></div>
<div class="ttc" id="group__ll__filesystem_html_gab7ce3131ebbf7c556c9ebeea312fce02"><div class="ttname"><a href="group__ll__filesystem.html#gab7ce3131ebbf7c556c9ebeea312fce02">ll_filesystem_file_write</a></div><div class="ttdeci">FILE_STATUS ll_filesystem_file_write(FILE_HANDLE *handle, uint8_t *buf, uint32_t size)</div></div>
<div class="ttc" id="group__ll__filesystem_html_ga8826f1d0e79cc734ea38315e5516f109"><div class="ttname"><a href="group__ll__filesystem.html#ga8826f1d0e79cc734ea38315e5516f109">ll_filesystem_file_read</a></div><div class="ttdeci">FILE_STATUS ll_filesystem_file_read(FILE_HANDLE *handle, uint8_t *buf, uint32_t size)</div></div>
<div class="ttc" id="struct_f_i_l_e___h_a_n_d_l_e_html"><div class="ttname"><a href="struct_f_i_l_e___h_a_n_d_l_e.html">FILE_HANDLE</a></div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00081">filesystem.h:81</a></div></div>
<div class="ttc" id="group__filesystem_html_gabd043128e80a4f0573b1360d921b046c"><div class="ttname"><a href="group__filesystem.html#gabd043128e80a4f0573b1360d921b046c">filesystem_file_open</a></div><div class="ttdeci">FILE_HANDLE * filesystem_file_open(const char *filename)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00033">filesystem.c:33</a></div></div>
<div class="ttc" id="group__filesystem_html_ga0e6cc31bf4c889249e13254306994c2f"><div class="ttname"><a href="group__filesystem.html#ga0e6cc31bf4c889249e13254306994c2f">filesystem_file_close</a></div><div class="ttdeci">void filesystem_file_close(FILE_HANDLE *handle)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00038">filesystem.c:38</a></div></div>
<div class="ttc" id="filesystem_8h_html"><div class="ttname"><a href="filesystem_8h.html">filesystem.h</a></div></div>
<div class="ttc" id="ll__filesystem_8h_html"><div class="ttname"><a href="ll__filesystem_8h.html">ll_filesystem.h</a></div></div>
<div class="ttc" id="group__filesystem_html_gae7124857f3ab32f6032ef129f2a80000"><div class="ttname"><a href="group__filesystem.html#gae7124857f3ab32f6032ef129f2a80000">filesystem_file_write</a></div><div class="ttdeci">FILE_STATUS filesystem_file_write(FILE_HANDLE *handle, uint8_t *buf, uint32_t size)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00053">filesystem.c:53</a></div></div>
<div class="ttc" id="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t_html"><div class="ttname"><a href="struct_d_i_r_e_c_t_o_r_y___s_t_r_u_c_t.html">DIRECTORY_STRUCT</a></div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00072">filesystem.h:72</a></div></div>
<div class="ttc" id="group__filesystem_html_ga8b1099cbd3464fbe64f2010f16d87101"><div class="ttname"><a href="group__filesystem.html#ga8b1099cbd3464fbe64f2010f16d87101">filesystem_dir_open</a></div><div class="ttdeci">DIRECTORY_STRUCT * filesystem_dir_open(const char *path)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00023">filesystem.c:23</a></div></div>
<div class="ttc" id="group__filesystem_html_ga367ec5e73c77ddf5047d05021cf97a8f"><div class="ttname"><a href="group__filesystem.html#ga367ec5e73c77ddf5047d05021cf97a8f">filesystem_init</a></div><div class="ttdeci">bool filesystem_init()</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00018">filesystem.c:18</a></div></div>
<div class="ttc" id="group__ll__filesystem_html_ga43292876112535a7cf9bb26201ed8096"><div class="ttname"><a href="group__ll__filesystem.html#ga43292876112535a7cf9bb26201ed8096">ll_filesystem_dir_close</a></div><div class="ttdeci">void ll_filesystem_dir_close(DIRECTORY_STRUCT *dir)</div></div>
<div class="ttc" id="group__ll__filesystem_html_ga572cb127d4e8affa9701d8562397389e"><div class="ttname"><a href="group__ll__filesystem.html#ga572cb127d4e8affa9701d8562397389e">ll_filesystem_dir_open</a></div><div class="ttdeci">DIRECTORY_STRUCT * ll_filesystem_dir_open(const char *path)</div></div>
<div class="ttc" id="group__filesystem_html_gab08f51089a5ddbb470a1a36a9478dda4"><div class="ttname"><a href="group__filesystem.html#gab08f51089a5ddbb470a1a36a9478dda4">FILE_STATUS</a></div><div class="ttdeci">FILE_STATUS</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8h_source.html#l00090">filesystem.h:90</a></div></div>
<div class="ttc" id="group__ll__filesystem_html_ga61e4a1cdb3435031c3a9df014ab21d08"><div class="ttname"><a href="group__ll__filesystem.html#ga61e4a1cdb3435031c3a9df014ab21d08">ll_filesystem_file_open</a></div><div class="ttdeci">FILE_HANDLE * ll_filesystem_file_open(const char *filename)</div></div>
<div class="ttc" id="group__filesystem_html_gab8001e040f37dc57b18e4155532b59ce"><div class="ttname"><a href="group__filesystem.html#gab8001e040f37dc57b18e4155532b59ce">filesystem_dir_close</a></div><div class="ttdeci">void filesystem_dir_close(DIRECTORY_STRUCT *dir)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00028">filesystem.c:28</a></div></div>
<div class="ttc" id="group__filesystem_html_ga9e7f715d0000e7b99e2b4732416a0221"><div class="ttname"><a href="group__filesystem.html#ga9e7f715d0000e7b99e2b4732416a0221">filesystem_file_read</a></div><div class="ttdeci">FILE_STATUS filesystem_file_read(FILE_HANDLE *handle, uint8_t *buf, uint32_t size)</div><div class="ttdef"><b>Definition:</b> <a href="filesystem_8c_source.html#l00048">filesystem.c:48</a></div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Jun 8 2015 11:01:18 for discoverpixy by &#160;<a href="http://www.doxygen.org/index.html">
<img class="footer" src="doxygen.png" alt="doxygen"/>
</a> 1.8.9.1
</small></address>
</body>
</html>