The-Homebrew-Cloud/N64FlashcartMenu
2
0
Fork 0
mirror of https://github.com/Polprzewodnikowy/N64FlashcartMenu.git synced 2025-04-18 09:51:23 +02:00
Code Issues Packages Projects Releases Wiki Activity
N64FlashcartMenu/flashcart__utils_8h.html
networkfusion 1d900b619a deploy: 22515a6fdf0ffb38f2a991323a2faca1cc8ef0e1
2025-03-31 15:28:34 +00:00

324 lines
16 KiB
HTML
Raw Permalink Blame History

<!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" lang="en-US">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=11"/>
<meta name="generator" content="Doxygen 1.12.0"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>N64FlashcartMenu: flashcart_utils.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>
<script type="text/javascript" src="clipboard.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="cookie.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 id="projectrow">
<td id="projectalign">
<div id="projectname">N64FlashcartMenu
</div>
</td>
</tr>
</tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.12.0 -->
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
var searchBox = new SearchBox("searchBox", "search/",'.html');
/* @license-end */
</script>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() { codefold.init(0); });
/* @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:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function() {
initMenu('',true,false,'search.php','Search',false);
$(function() { init_search(); });
});
/* @license-end */
</script>
<div id="main-nav"></div>
<script type="text/javascript">
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&amp;dn=expat.txt MIT */
$(function(){ initResizable(false); });
/* @license-end */
</script>
<!-- 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">
<div id="MSearchResults">
<div class="SRPage">
<div id="SRIndex">
<div id="SRResults"></div>
<div class="SRStatus" id="Loading">Loading...</div>
<div class="SRStatus" id="Searching">Searching...</div>
<div class="SRStatus" id="NoMatches">No Matches</div>
</div>
</div>
</div>
</div>
<div id="nav-path" class="navpath">
<ul>
<li class="navelem"><a class="el" href="dir_68267d1309a1af8e8297ef4c3efbcdba.html">src</a></li><li class="navelem"><a class="el" href="dir_abdc04f88b2866c1353f358c089205e4.html">flashcart</a></li> </ul>
</div>
</div><!-- top -->
<div id="doc-content">
<div class="header">
<div class="summary">
<a href="#define-members">Macros</a> &#124;
<a href="#enum-members">Enumerations</a> &#124;
<a href="#func-members">Functions</a> </div>
<div class="headertitle"><div class="title">flashcart_utils.h File Reference</div></div>
</div><!--header-->
<div class="contents">
<p>Flashcart utilities.
<a href="#details">More...</a></p>
<p><a href="flashcart__utils_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 id="define-members" name="define-members"></a>
Macros</h2></td></tr>
<tr class="memitem:aef1be394be8374f266f4caf0d0270795" id="r_aef1be394be8374f266f4caf0d0270795"><td class="memItemLeft" align="right" valign="top"><a id="aef1be394be8374f266f4caf0d0270795" name="aef1be394be8374f266f4caf0d0270795"></a>
#define&#160;</td><td class="memItemRight" valign="bottom"><b>SAVE_WRITEBACK_MAX_SECTORS</b>&#160;&#160;&#160;(256)</td></tr>
<tr class="separator:aef1be394be8374f266f4caf0d0270795"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="enum-members" name="enum-members"></a>
Enumerations</h2></td></tr>
<tr class="memitem:a7796f7897be4ba858f0f76139f41c89d" id="r_a7796f7897be4ba858f0f76139f41c89d"><td class="memItemLeft" align="right" valign="top">enum &#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a7796f7897be4ba858f0f76139f41c89d">address_type_t</a> { <a class="el" href="#a7796f7897be4ba858f0f76139f41c89da3f901313b89f1999895e49423cd4bb4d">ADDRESS_TYPE_MEM</a>
, <a class="el" href="#a7796f7897be4ba858f0f76139f41c89daf78626787a354c6eb9c073b351372848">ADDRESS_TYPE_PI</a>
}</td></tr>
<tr class="memdesc:a7796f7897be4ba858f0f76139f41c89d"><td class="mdescLeft">&#160;</td><td class="mdescRight">Address types for DMA operations. <a href="#a7796f7897be4ba858f0f76139f41c89d">More...</a><br /></td></tr>
<tr class="separator:a7796f7897be4ba858f0f76139f41c89d"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table><table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a id="func-members" name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:ae5b7ee93a018d6488b00e87b9a8f0626" id="r_ae5b7ee93a018d6488b00e87b9a8f0626"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ae5b7ee93a018d6488b00e87b9a8f0626">pi_dma_read_data</a> (void *src, void *dst, size_t length)</td></tr>
<tr class="memdesc:ae5b7ee93a018d6488b00e87b9a8f0626"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform a DMA read operation from the PI (Peripheral Interface). <br /></td></tr>
<tr class="separator:ae5b7ee93a018d6488b00e87b9a8f0626"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ac7698e2930f7e565626659acda24004c" id="r_ac7698e2930f7e565626659acda24004c"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#ac7698e2930f7e565626659acda24004c">pi_dma_write_data</a> (void *src, void *dst, size_t length)</td></tr>
<tr class="memdesc:ac7698e2930f7e565626659acda24004c"><td class="mdescLeft">&#160;</td><td class="mdescRight">Perform a DMA write operation to the PI (Peripheral Interface). <br /></td></tr>
<tr class="separator:ac7698e2930f7e565626659acda24004c"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a9b17d7de83d3f7a435ed2f25ca3f6844" id="r_a9b17d7de83d3f7a435ed2f25ca3f6844"><td class="memItemLeft" align="right" valign="top">void&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a9b17d7de83d3f7a435ed2f25ca3f6844">fatfs_fix_file_size</a> (FIL *fil)</td></tr>
<tr class="memdesc:a9b17d7de83d3f7a435ed2f25ca3f6844"><td class="mdescLeft">&#160;</td><td class="mdescRight">Fix the file size in the FAT filesystem. <br /></td></tr>
<tr class="separator:a9b17d7de83d3f7a435ed2f25ca3f6844"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:a8ea4b97918b42944b1d190984ebdde56" id="r_a8ea4b97918b42944b1d190984ebdde56"><td class="memItemLeft" align="right" valign="top">bool&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="#a8ea4b97918b42944b1d190984ebdde56">fatfs_get_file_sectors</a> (char *path, uint32_t *address, <a class="el" href="#a7796f7897be4ba858f0f76139f41c89d">address_type_t</a> address_type, uint32_t max_sectors)</td></tr>
<tr class="memdesc:a8ea4b97918b42944b1d190984ebdde56"><td class="mdescLeft">&#160;</td><td class="mdescRight">Get the file sectors in the FAT filesystem. <br /></td></tr>
<tr class="separator:a8ea4b97918b42944b1d190984ebdde56"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<a name="details" id="details"></a><h2 class="groupheader">Detailed Description</h2>
<div class="textblock"><p>Flashcart utilities. </p>
</div><h2 class="groupheader">Enumeration Type Documentation</h2>
<a id="a7796f7897be4ba858f0f76139f41c89d" name="a7796f7897be4ba858f0f76139f41c89d"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a7796f7897be4ba858f0f76139f41c89d">&#9670;&#160;</a></span>address_type_t</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">enum <a class="el" href="#a7796f7897be4ba858f0f76139f41c89d">address_type_t</a></td>
</tr>
</table>
</div><div class="memdoc">
<p>Address types for DMA operations. </p>
<table class="fieldtable">
<tr><th colspan="2">Enumerator</th></tr><tr><td class="fieldname"><a id="a7796f7897be4ba858f0f76139f41c89da3f901313b89f1999895e49423cd4bb4d" name="a7796f7897be4ba858f0f76139f41c89da3f901313b89f1999895e49423cd4bb4d"></a>ADDRESS_TYPE_MEM&#160;</td><td class="fielddoc"><p>Memory address type. </p>
</td></tr>
<tr><td class="fieldname"><a id="a7796f7897be4ba858f0f76139f41c89daf78626787a354c6eb9c073b351372848" name="a7796f7897be4ba858f0f76139f41c89daf78626787a354c6eb9c073b351372848"></a>ADDRESS_TYPE_PI&#160;</td><td class="fielddoc"><p>Peripheral Interface address type. </p>
</td></tr>
</table>
</div>
</div>
<h2 class="groupheader">Function Documentation</h2>
<a id="ae5b7ee93a018d6488b00e87b9a8f0626" name="ae5b7ee93a018d6488b00e87b9a8f0626"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ae5b7ee93a018d6488b00e87b9a8f0626">&#9670;&#160;</a></span>pi_dma_read_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pi_dma_read_data </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>dst</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>length</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform a DMA read operation from the PI (Peripheral Interface). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>Source address. </td></tr>
<tr><td class="paramname">dst</td><td>Destination address. </td></tr>
<tr><td class="paramname">length</td><td>Length of data to read. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="ac7698e2930f7e565626659acda24004c" name="ac7698e2930f7e565626659acda24004c"></a>
<h2 class="memtitle"><span class="permalink"><a href="#ac7698e2930f7e565626659acda24004c">&#9670;&#160;</a></span>pi_dma_write_data()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void pi_dma_write_data </td>
<td>(</td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>src</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">void *</td> <td class="paramname"><span class="paramname"><em>dst</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">size_t</td> <td class="paramname"><span class="paramname"><em>length</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Perform a DMA write operation to the PI (Peripheral Interface). </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">src</td><td>Source address. </td></tr>
<tr><td class="paramname">dst</td><td>Destination address. </td></tr>
<tr><td class="paramname">length</td><td>Length of data to write. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a9b17d7de83d3f7a435ed2f25ca3f6844" name="a9b17d7de83d3f7a435ed2f25ca3f6844"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a9b17d7de83d3f7a435ed2f25ca3f6844">&#9670;&#160;</a></span>fatfs_fix_file_size()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">void fatfs_fix_file_size </td>
<td>(</td>
<td class="paramtype">FIL *</td> <td class="paramname"><span class="paramname"><em>fil</em></span></td><td>)</td>
<td></td>
</tr>
</table>
</div><div class="memdoc">
<p>Fix the file size in the FAT filesystem. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fil</td><td>Pointer to the file object.</td></tr>
</table>
</dd>
</dl>
<p>Fix the file size in the FAT filesystem.</p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">fil</td><td>Pointer to the file object. </td></tr>
</table>
</dd>
</dl>
</div>
</div>
<a id="a8ea4b97918b42944b1d190984ebdde56" name="a8ea4b97918b42944b1d190984ebdde56"></a>
<h2 class="memtitle"><span class="permalink"><a href="#a8ea4b97918b42944b1d190984ebdde56">&#9670;&#160;</a></span>fatfs_get_file_sectors()</h2>
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">bool fatfs_get_file_sectors </td>
<td>(</td>
<td class="paramtype">char *</td> <td class="paramname"><span class="paramname"><em>path</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t *</td> <td class="paramname"><span class="paramname"><em>address</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype"><a class="el" href="#a7796f7897be4ba858f0f76139f41c89d">address_type_t</a></td> <td class="paramname"><span class="paramname"><em>type</em></span>, </td>
</tr>
<tr>
<td class="paramkey"></td>
<td></td>
<td class="paramtype">uint32_t</td> <td class="paramname"><span class="paramname"><em>max_sectors</em></span>&#160;)</td>
</tr>
</table>
</div><div class="memdoc">
<p>Get the file sectors in the FAT filesystem. </p>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Path to the file. </td></tr>
<tr><td class="paramname">address</td><td>Pointer to store the address of the file sectors. </td></tr>
<tr><td class="paramname">address_type</td><td>The type of address (memory or PI). </td></tr>
<tr><td class="paramname">max_sectors</td><td>Maximum number of sectors. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if successful, false otherwise.</dd></dl>
<dl class="params"><dt>Parameters</dt><dd>
<table class="params">
<tr><td class="paramname">path</td><td>Path to the file. </td></tr>
<tr><td class="paramname">address</td><td>Pointer to store the address of the file sectors. </td></tr>
<tr><td class="paramname">type</td><td>The type of address (memory or PI). </td></tr>
<tr><td class="paramname">max_sectors</td><td>Maximum number of sectors. </td></tr>
</table>
</dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd>true if an error occurred, false otherwise. </dd></dl>
</div>
</div>
</div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Mon Mar 31 2025 15:28:33 for N64FlashcartMenu by&#160;<a href="https://www.doxygen.org/index.html"><img class="footer" src="doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.12.0
</small></address>
</div><!-- doc-content -->
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink