625 lines
31 KiB
HTML
625 lines
31 KiB
HTML
|
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "https://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.9.1"/>
|
||
|
|
<meta name="viewport" content="width=device-width, initial-scale=1"/>
|
||
|
|
<title>RTOS_MSPM0: RTOS_Labs_common/eFile.h File 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>
|
||
|
|
<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="RobotSensors.png"/></td>
|
||
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
||
|
|
<div id="projectname">RTOS_MSPM0
|
||
|
|
 <span id="projectnumber">1.1</span>
|
||
|
|
</div>
|
||
|
|
<div id="projectbrief">ECE445M starter code</div>
|
||
|
|
</td>
|
||
|
|
</tr>
|
||
|
|
</tbody>
|
||
|
|
</table>
|
||
|
|
</div>
|
||
|
|
<!-- end header part -->
|
||
|
|
<!-- Generated by Doxygen 1.9.1 -->
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
var searchBox = new SearchBox("searchBox", "search",false,'Search','.html');
|
||
|
|
/* @license-end */
|
||
|
|
</script>
|
||
|
|
<script type="text/javascript" src="menudata.js"></script>
|
||
|
|
<script type="text/javascript" src="menu.js"></script>
|
||
|
|
<script type="text/javascript">
|
||
|
|
/* @license magnet:?xt=urn:btih:cf05388f2679ee054f2beb29a391d25f4e673ac3&dn=gpl-2.0.txt GPL-v2 */
|
||
|
|
$(function() {
|
||
|
|
initMenu('',true,false,'search.php','Search');
|
||
|
|
$(document).ready(function() { init_search(); });
|
||
|
|
});
|
||
|
|
/* @license-end */</script>
|
||
|
|
<div id="main-nav"></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_d9737668015ddda3d9b152d7c8d1103c.html">RTOS_Labs_common</a></li> </ul>
|
||
|
|
</div>
|
||
|
|
</div><!-- top -->
|
||
|
|
<div class="header">
|
||
|
|
<div class="summary">
|
||
|
|
<a href="#func-members">Functions</a> </div>
|
||
|
|
<div class="headertitle">
|
||
|
|
<div class="title">eFile.h File Reference</div> </div>
|
||
|
|
</div><!--header-->
|
||
|
|
<div class="contents">
|
||
|
|
|
||
|
|
<p>high-level file system
|
||
|
|
<a href="#details">More...</a></p>
|
||
|
|
|
||
|
|
<p><a href="e_file_8h_source.html">Go to the source code of this file.</a></p>
|
||
|
|
<table class="memberdecls">
|
||
|
|
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
|
||
|
|
Functions</h2></td></tr>
|
||
|
|
<tr class="memitem:aabd3d6fbc5392d6fc27e65c63d633548"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#aabd3d6fbc5392d6fc27e65c63d633548">eFile_Init</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:aabd3d6fbc5392d6fc27e65c63d633548"><td class="mdescLeft"> </td><td class="mdescRight">Activate the file system, without formating. <a href="e_file_8h.html#aabd3d6fbc5392d6fc27e65c63d633548">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:aabd3d6fbc5392d6fc27e65c63d633548"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ae7812a1b639e7107dbf5ebb166737cec"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#ae7812a1b639e7107dbf5ebb166737cec">eFile_Format</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:ae7812a1b639e7107dbf5ebb166737cec"><td class="mdescLeft"> </td><td class="mdescRight">Format the disk. <a href="e_file_8h.html#ae7812a1b639e7107dbf5ebb166737cec">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:ae7812a1b639e7107dbf5ebb166737cec"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a175858e382e046a5d5f0480daee1b9b4"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#a175858e382e046a5d5f0480daee1b9b4">eFile_Mount</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:a175858e382e046a5d5f0480daee1b9b4"><td class="mdescLeft"> </td><td class="mdescRight">Mount the disk. <a href="e_file_8h.html#a175858e382e046a5d5f0480daee1b9b4">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a175858e382e046a5d5f0480daee1b9b4"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a548c5dcc4470498b97d186155a07e97d"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#a548c5dcc4470498b97d186155a07e97d">eFile_Create</a> (const char name[])</td></tr>
|
||
|
|
<tr class="memdesc:a548c5dcc4470498b97d186155a07e97d"><td class="mdescLeft"> </td><td class="mdescRight">Create a new file. <a href="e_file_8h.html#a548c5dcc4470498b97d186155a07e97d">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a548c5dcc4470498b97d186155a07e97d"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:affacb9ae88be59c21e50fb68eb548525"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#affacb9ae88be59c21e50fb68eb548525">eFile_WOpen</a> (const char name[])</td></tr>
|
||
|
|
<tr class="memdesc:affacb9ae88be59c21e50fb68eb548525"><td class="mdescLeft"> </td><td class="mdescRight">Open an existing file for writing. <a href="e_file_8h.html#affacb9ae88be59c21e50fb68eb548525">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:affacb9ae88be59c21e50fb68eb548525"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a415411e65611acb96456b352f651b992"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#a415411e65611acb96456b352f651b992">eFile_Write</a> (const char data)</td></tr>
|
||
|
|
<tr class="memdesc:a415411e65611acb96456b352f651b992"><td class="mdescLeft"> </td><td class="mdescRight">Write one byte. <a href="e_file_8h.html#a415411e65611acb96456b352f651b992">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a415411e65611acb96456b352f651b992"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a585c9732df8434c496d2d7fd36c2dc8f"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#a585c9732df8434c496d2d7fd36c2dc8f">eFile_WriteString</a> (const char *pt)</td></tr>
|
||
|
|
<tr class="memdesc:a585c9732df8434c496d2d7fd36c2dc8f"><td class="mdescLeft"> </td><td class="mdescRight">Write string. <a href="e_file_8h.html#a585c9732df8434c496d2d7fd36c2dc8f">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a585c9732df8434c496d2d7fd36c2dc8f"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a23c837266c45626a92d8a76549f55b45"><td class="memItemLeft" align="right" valign="top"><a id="a23c837266c45626a92d8a76549f55b45"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>eFile_WriteUDec</b> (uint32_t n)</td></tr>
|
||
|
|
<tr class="separator:a23c837266c45626a92d8a76549f55b45"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a6e7c85de691b8a32e635f99bed8d9aa2"><td class="memItemLeft" align="right" valign="top"><a id="a6e7c85de691b8a32e635f99bed8d9aa2"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>eFile_WriteSDec</b> (int32_t num)</td></tr>
|
||
|
|
<tr class="separator:a6e7c85de691b8a32e635f99bed8d9aa2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9368a9a0eea7054fb8537a58817d9c38"><td class="memItemLeft" align="right" valign="top"><a id="a9368a9a0eea7054fb8537a58817d9c38"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>eFile_WriteSFix2</b> (int32_t n)</td></tr>
|
||
|
|
<tr class="separator:a9368a9a0eea7054fb8537a58817d9c38"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:ab2da8f7d4dd4d9f2bf66baf697abbf47"><td class="memItemLeft" align="right" valign="top"><a id="ab2da8f7d4dd4d9f2bf66baf697abbf47"></a>
|
||
|
|
int </td><td class="memItemRight" valign="bottom"><b>eFile_WriteUFix2</b> (uint32_t num)</td></tr>
|
||
|
|
<tr class="separator:ab2da8f7d4dd4d9f2bf66baf697abbf47"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a68df762a5710e57e759cb51c89d96c2c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#a68df762a5710e57e759cb51c89d96c2c">eFile_WClose</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:a68df762a5710e57e759cb51c89d96c2c"><td class="mdescLeft"> </td><td class="mdescRight">Close the file that was being written. <a href="e_file_8h.html#a68df762a5710e57e759cb51c89d96c2c">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a68df762a5710e57e759cb51c89d96c2c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:af01f22c7056d24a1ceaa9cef49c789f7"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#af01f22c7056d24a1ceaa9cef49c789f7">eFile_ROpen</a> (const char name[])</td></tr>
|
||
|
|
<tr class="memdesc:af01f22c7056d24a1ceaa9cef49c789f7"><td class="mdescLeft"> </td><td class="mdescRight">Open an existing file for reading. <a href="e_file_8h.html#af01f22c7056d24a1ceaa9cef49c789f7">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:af01f22c7056d24a1ceaa9cef49c789f7"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:acd2e14c3498c0d9a820737cd459ef6fb"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#acd2e14c3498c0d9a820737cd459ef6fb">eFile_ReadNext</a> (char *pt)</td></tr>
|
||
|
|
<tr class="memdesc:acd2e14c3498c0d9a820737cd459ef6fb"><td class="mdescLeft"> </td><td class="mdescRight">Retreive data from open file. <a href="e_file_8h.html#acd2e14c3498c0d9a820737cd459ef6fb">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:acd2e14c3498c0d9a820737cd459ef6fb"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a683c8ad0648f79ec7015b96bf4abedb6"><td class="memItemLeft" align="right" valign="top">uint32_t </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#a683c8ad0648f79ec7015b96bf4abedb6">eFileReadNextWord</a> (uint32_t *pt)</td></tr>
|
||
|
|
<tr class="memdesc:a683c8ad0648f79ec7015b96bf4abedb6"><td class="mdescLeft"> </td><td class="mdescRight">Retreive data from open file. <a href="e_file_8h.html#a683c8ad0648f79ec7015b96bf4abedb6">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a683c8ad0648f79ec7015b96bf4abedb6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a0d4b4d9cddb15950b6d7fa76a1870f1c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#a0d4b4d9cddb15950b6d7fa76a1870f1c">eFile_RClose</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:a0d4b4d9cddb15950b6d7fa76a1870f1c"><td class="mdescLeft"> </td><td class="mdescRight">Close the file that was being read. <a href="e_file_8h.html#a0d4b4d9cddb15950b6d7fa76a1870f1c">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a0d4b4d9cddb15950b6d7fa76a1870f1c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a30475bde635f805a8bf401363c8633ae"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#a30475bde635f805a8bf401363c8633ae">eFile_Delete</a> (const char name[])</td></tr>
|
||
|
|
<tr class="memdesc:a30475bde635f805a8bf401363c8633ae"><td class="mdescLeft"> </td><td class="mdescRight">delete this file <a href="e_file_8h.html#a30475bde635f805a8bf401363c8633ae">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a30475bde635f805a8bf401363c8633ae"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aaffe5a87b9896a73bced4118d58c58a2"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#aaffe5a87b9896a73bced4118d58c58a2">eFile_DOpen</a> (const char name[])</td></tr>
|
||
|
|
<tr class="separator:aaffe5a87b9896a73bced4118d58c58a2"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a74fc1df4e9e5eec7d839c715ca02104c"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#a74fc1df4e9e5eec7d839c715ca02104c">eFile_DirNext</a> (char *name[], unsigned long *size)</td></tr>
|
||
|
|
<tr class="separator:a74fc1df4e9e5eec7d839c715ca02104c"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:aa2c0f95143245afd527c942c32c353ab"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#aa2c0f95143245afd527c942c32c353ab">eFile_DClose</a> (void)</td></tr>
|
||
|
|
<tr class="separator:aa2c0f95143245afd527c942c32c353ab"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
<tr class="memitem:a9efd23e106b34bac8b267a1b9a5515e6"><td class="memItemLeft" align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="e_file_8h.html#a9efd23e106b34bac8b267a1b9a5515e6">eFile_Unmount</a> (void)</td></tr>
|
||
|
|
<tr class="memdesc:a9efd23e106b34bac8b267a1b9a5515e6"><td class="mdescLeft"> </td><td class="mdescRight">Unmount the disk. <a href="e_file_8h.html#a9efd23e106b34bac8b267a1b9a5515e6">More...</a><br /></td></tr>
|
||
|
|
<tr class="separator:a9efd23e106b34bac8b267a1b9a5515e6"><td class="memSeparator" colspan="2"> </td></tr>
|
||
|
|
</table>
|
||
|
|
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
|
||
|
|
<div class="textblock"><p>high-level file system </p>
|
||
|
|
<p>This file system sits on top of eDisk. </p><dl class="section version"><dt>Version</dt><dd>V1.0 </dd></dl>
|
||
|
|
<dl class="section author"><dt>Author</dt><dd>Valvano </dd></dl>
|
||
|
|
<dl class="section copyright"><dt>Copyright</dt><dd>Copyright 2026 by Jonathan W. Valvano, <a href="#" onclick="location.href='mai'+'lto:'+'val'+'va'+'no@'+'ma'+'il.'+'ut'+'exa'+'s.'+'edu'; return false;">valva<span style="display: none;">.nosp@m.</span>no@m<span style="display: none;">.nosp@m.</span>ail.u<span style="display: none;">.nosp@m.</span>texa<span style="display: none;">.nosp@m.</span>s.edu</a>, </dd></dl>
|
||
|
|
<dl class="section warning"><dt>Warning</dt><dd>AS-IS </dd></dl>
|
||
|
|
<dl class="section note"><dt>Note</dt><dd>For more information see <a href="http://users.ece.utexas.edu/~valvano/">http://users.ece.utexas.edu/~valvano/</a> </dd></dl>
|
||
|
|
<dl class="section date"><dt>Date</dt><dd>Dec 30, 2025 </dd></dl>
|
||
|
|
</div><h2 class="groupheader">Function Documentation</h2>
|
||
|
|
<a id="a548c5dcc4470498b97d186155a07e97d"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a548c5dcc4470498b97d186155a07e97d">◆ </a></span>eFile_Create()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_Create </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const char </td>
|
||
|
|
<td class="paramname"><em>name</em>[]</td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Create a new file. </p>
|
||
|
|
<p>Create a new, empty file with one allocated block </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">name</td><td>file name is an ASCII string up to seven characters </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., already exists) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aa2c0f95143245afd527c942c32c353ab"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aa2c0f95143245afd527c942c32c353ab">◆ </a></span>eFile_DClose()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_DClose </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Close the directory </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., wasn't open) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a30475bde635f805a8bf401363c8633ae"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a30475bde635f805a8bf401363c8633ae">◆ </a></span>eFile_Delete()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_Delete </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const char </td>
|
||
|
|
<td class="paramname"><em>name</em>[]</td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>delete this file </p>
|
||
|
|
<p>Delete the file with this name, recover blocks so they can be used by another file </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">name</td><td>file name is an ASCII string up to seven characters </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., file doesn't exist) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a74fc1df4e9e5eec7d839c715ca02104c"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a74fc1df4e9e5eec7d839c715ca02104c">◆ </a></span>eFile_DirNext()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_DirNext </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">char * </td>
|
||
|
|
<td class="paramname"><em>name</em>[], </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td class="paramkey"></td>
|
||
|
|
<td></td>
|
||
|
|
<td class="paramtype">unsigned long * </td>
|
||
|
|
<td class="paramname"><em>size</em> </td>
|
||
|
|
</tr>
|
||
|
|
<tr>
|
||
|
|
<td></td>
|
||
|
|
<td>)</td>
|
||
|
|
<td></td><td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Retreive directory entry from open directory </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">pointers</td><td>to return file name and size by reference </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., end of directory) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aaffe5a87b9896a73bced4118d58c58a2"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aaffe5a87b9896a73bced4118d58c58a2">◆ </a></span>eFile_DOpen()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_DOpen </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const char </td>
|
||
|
|
<td class="paramname"><em>name</em>[]</td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
<p>Open a (sub)directory, read into RAM </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">directory</td><td>name is an ASCII string up to seven characters if subdirectories are supported (optional, empty sring for root directory) </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., trouble reading from flash) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="ae7812a1b639e7107dbf5ebb166737cec"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#ae7812a1b639e7107dbf5ebb166737cec">◆ </a></span>eFile_Format()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_Format </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Format the disk. </p>
|
||
|
|
<p>Erase all files, create blank directory, initialize free space manager </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., trouble writing to flash) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="aabd3d6fbc5392d6fc27e65c63d633548"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#aabd3d6fbc5392d6fc27e65c63d633548">◆ </a></span>eFile_Init()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_Init </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Activate the file system, without formating. </p>
|
||
|
|
<p>This function must be called first, before calling any of the other eFile functions </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (already initialized) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a175858e382e046a5d5f0480daee1b9b4"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a175858e382e046a5d5f0480daee1b9b4">◆ </a></span>eFile_Mount()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_Mount </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Mount the disk. </p>
|
||
|
|
<p>Mount disk and load file system metadata information </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., already mounted) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a0d4b4d9cddb15950b6d7fa76a1870f1c"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a0d4b4d9cddb15950b6d7fa76a1870f1c">◆ </a></span>eFile_RClose()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_RClose </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Close the file that was being read. </p>
|
||
|
|
<p>Close the file, leave disk in a state power can be removed. </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., wasn't open) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="acd2e14c3498c0d9a820737cd459ef6fb"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#acd2e14c3498c0d9a820737cd459ef6fb">◆ </a></span>eFile_ReadNext()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_ReadNext </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">char * </td>
|
||
|
|
<td class="paramname"><em>pt</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Retreive data from open file. </p>
|
||
|
|
<p>Read one byte from disk into RAM </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">pt</td><td>call by reference pointer to place to save data </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., trouble reading from flash) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="af01f22c7056d24a1ceaa9cef49c789f7"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#af01f22c7056d24a1ceaa9cef49c789f7">◆ </a></span>eFile_ROpen()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_ROpen </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const char </td>
|
||
|
|
<td class="paramname"><em>name</em>[]</td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Open an existing file for reading. </p>
|
||
|
|
<p>Open the file for reading, read first block into RAM </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">name</td><td>file name is an ASCII string up to seven characters </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., trouble reading from flash) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a9efd23e106b34bac8b267a1b9a5515e6"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a9efd23e106b34bac8b267a1b9a5515e6">◆ </a></span>eFile_Unmount()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_Unmount </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Unmount the disk. </p>
|
||
|
|
<p>Unmount and deactivate the file system. </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., trouble writing to flash) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a68df762a5710e57e759cb51c89d96c2c"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a68df762a5710e57e759cb51c89d96c2c">◆ </a></span>eFile_WClose()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_WClose </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">void </td>
|
||
|
|
<td class="paramname"></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Close the file that was being written. </p>
|
||
|
|
<p>Close the file, leave disk in a state power can be removed. This function will flush all RAM buffers to the disk. </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">none</td><td></td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., trouble writing to flash) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="affacb9ae88be59c21e50fb68eb548525"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#affacb9ae88be59c21e50fb68eb548525">◆ </a></span>eFile_WOpen()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_WOpen </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const char </td>
|
||
|
|
<td class="paramname"><em>name</em>[]</td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Open an existing file for writing. </p>
|
||
|
|
<p>Open the file for writing, read into RAM last block </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">name</td><td>file name is an ASCII string up to seven characters </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., trouble reading from flash) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a415411e65611acb96456b352f651b992"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a415411e65611acb96456b352f651b992">◆ </a></span>eFile_Write()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_Write </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const char </td>
|
||
|
|
<td class="paramname"><em>data</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Write one byte. </p>
|
||
|
|
<p>Save one byte at end of the open file </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">data</td><td>byte to be saved on the disk </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., trouble writing to flash) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a585c9732df8434c496d2d7fd36c2dc8f"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a585c9732df8434c496d2d7fd36c2dc8f">◆ </a></span>eFile_WriteString()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">int eFile_WriteString </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">const char * </td>
|
||
|
|
<td class="paramname"><em>pt</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Write string. </p>
|
||
|
|
<p>Save string at end of the open file </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">pt</td><td>pointer to string to be saved </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., trouble writing to flash) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
<a id="a683c8ad0648f79ec7015b96bf4abedb6"></a>
|
||
|
|
<h2 class="memtitle"><span class="permalink"><a href="#a683c8ad0648f79ec7015b96bf4abedb6">◆ </a></span>eFileReadNextWord()</h2>
|
||
|
|
|
||
|
|
<div class="memitem">
|
||
|
|
<div class="memproto">
|
||
|
|
<table class="memname">
|
||
|
|
<tr>
|
||
|
|
<td class="memname">uint32_t eFileReadNextWord </td>
|
||
|
|
<td>(</td>
|
||
|
|
<td class="paramtype">uint32_t * </td>
|
||
|
|
<td class="paramname"><em>pt</em></td><td>)</td>
|
||
|
|
<td></td>
|
||
|
|
</tr>
|
||
|
|
</table>
|
||
|
|
</div><div class="memdoc">
|
||
|
|
|
||
|
|
<p>Retreive data from open file. </p>
|
||
|
|
<p>Read one 32-bit word from disk into RAM, little endian </p><dl class="params"><dt>Parameters</dt><dd>
|
||
|
|
<table class="params">
|
||
|
|
<tr><td class="paramname">pt</td><td>call by reference pointer to place to save data </td></tr>
|
||
|
|
</table>
|
||
|
|
</dd>
|
||
|
|
</dl>
|
||
|
|
<dl class="section return"><dt>Returns</dt><dd>0 if successful and 1 on failure (e.g., trouble reading from flash) </dd></dl>
|
||
|
|
|
||
|
|
</div>
|
||
|
|
</div>
|
||
|
|
</div><!-- contents -->
|
||
|
|
<!-- start footer part -->
|
||
|
|
<hr class="footer"/><address class="footer"><small>
|
||
|
|
Generated by <a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.1
|
||
|
|
</small></address>
|
||
|
|
</body>
|
||
|
|
</html>
|