N64FlashcartMenu/flashcart_8h_source.html

164 lines
19 KiB
HTML
Raw Normal View 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.9.5"/>
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<title>N64FlashcartMenu: flashcart.h 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>
<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.9.5 -->
<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" 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');
$(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">
<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 class="header">
<div class="headertitle"><div class="title">flashcart.h</div></div>
</div><!--header-->
<div class="contents">
<a href="flashcart_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a id="l00001" name="l00001"></a><span class="lineno"> 1</span> </div>
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="preprocessor">#ifndef FLASHCART_H__</span></div>
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="preprocessor">#define FLASHCART_H__</span></div>
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span> </div>
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span> </div>
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="preprocessor">#include &lt;stdbool.h&gt;</span></div>
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="preprocessor">#include &lt;stdint.h&gt;</span></div>
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span> </div>
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span> </div>
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"><a class="line" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73"> 16</a></span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> FLASHCART_OK,</div>
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span> FLASHCART_ERR_OUTDATED,</div>
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span> FLASHCART_ERR_SD_CARD,</div>
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> FLASHCART_ERR_BBFS,</div>
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span> FLASHCART_ERR_ARGS,</div>
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> FLASHCART_ERR_LOAD,</div>
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span> FLASHCART_ERR_INT,</div>
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span> FLASHCART_ERR_FUNCTION_NOT_SUPPORTED,</div>
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span>} <a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a>;</div>
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span> </div>
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"><a class="line" href="flashcart_8h.html#a956fff40ddf9cba0ca30fabc0cecb016"> 28</a></span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"> 29</span> FLASHCART_FEATURE_64DD,</div>
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span> FLASHCART_FEATURE_RTC,</div>
<div class="line"><a id="l00031" name="l00031"></a><span class="lineno"> 31</span> FLASHCART_FEATURE_USB,</div>
<div class="line"><a id="l00032" name="l00032"></a><span class="lineno"> 32</span>} <a class="code hl_enumeration" href="flashcart_8h.html#a956fff40ddf9cba0ca30fabc0cecb016">flashcart_features_t</a>;</div>
<div class="line"><a id="l00033" name="l00033"></a><span class="lineno"> 33</span> </div>
<div class="line"><a id="l00035" name="l00035"></a><span class="lineno"><a class="line" href="flashcart_8h.html#a51261e17f581033419e18c3e3d0c2cf2"> 35</a></span><span class="keyword">typedef</span> <span class="keyword">enum</span> {</div>
<div class="line"><a id="l00036" name="l00036"></a><span class="lineno"> 36</span> FLASHCART_SAVE_TYPE_NONE,</div>
<div class="line"><a id="l00037" name="l00037"></a><span class="lineno"> 37</span> FLASHCART_SAVE_TYPE_EEPROM_4KBIT,</div>
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"> 38</span> FLASHCART_SAVE_TYPE_EEPROM_16KBIT,</div>
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> FLASHCART_SAVE_TYPE_SRAM_256KBIT,</div>
<div class="line"><a id="l00040" name="l00040"></a><span class="lineno"> 40</span> FLASHCART_SAVE_TYPE_SRAM_BANKED,</div>
<div class="line"><a id="l00041" name="l00041"></a><span class="lineno"> 41</span> FLASHCART_SAVE_TYPE_SRAM_1MBIT,</div>
<div class="line"><a id="l00042" name="l00042"></a><span class="lineno"> 42</span> FLASHCART_SAVE_TYPE_FLASHRAM_1MBIT,</div>
<div class="line"><a id="l00043" name="l00043"></a><span class="lineno"> 43</span> FLASHCART_SAVE_TYPE_FLASHRAM_PKST2,</div>
<div class="line"><a id="l00044" name="l00044"></a><span class="lineno"> 44</span> __FLASHCART_SAVE_TYPE_END</div>
<div class="line"><a id="l00045" name="l00045"></a><span class="lineno"> 45</span>} <a class="code hl_enumeration" href="flashcart_8h.html#a51261e17f581033419e18c3e3d0c2cf2">flashcart_save_type_t</a>;</div>
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"> 46</span> </div>
<div class="line"><a id="l00048" name="l00048"></a><span class="lineno"><a class="line" href="flashcart_8h.html"> 48</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00049" name="l00049"></a><span class="lineno"> 49</span> <span class="keywordtype">bool</span> development_drive;</div>
<div class="line"><a id="l00050" name="l00050"></a><span class="lineno"> 50</span> uint8_t disk_type;</div>
<div class="line"><a id="l00051" name="l00051"></a><span class="lineno"> 51</span> <span class="keywordtype">bool</span> bad_system_area_lbas[24];</div>
<div class="line"><a id="l00052" name="l00052"></a><span class="lineno"> 52</span> uint8_t defect_tracks[16][12];</div>
<div class="line"><a id="l00053" name="l00053"></a><span class="lineno"> 53</span>} <a class="code hl_struct" href="flashcart_8h.html#structflashcart__disk__parameters__t">flashcart_disk_parameters_t</a>;</div>
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"> 54</span> </div>
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span><span class="keyword">typedef</span> <span class="keywordtype">void</span> flashcart_progress_callback_t (<span class="keywordtype">float</span> progress);</div>
<div class="line"><a id="l00056" name="l00056"></a><span class="lineno"> 56</span> </div>
<div class="line"><a id="l00058" name="l00058"></a><span class="lineno"><a class="line" href="structflashcart__t.html"> 58</a></span><span class="keyword">typedef</span> <span class="keyword">struct </span>{</div>
<div class="line"><a id="l00060" name="l00060"></a><span class="lineno"><a class="line" href="structflashcart__t.html#ae9fbf76776c3074703a1f26c233e8a41"> 60</a></span> <a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> (*init) (void);</div>
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="structflashcart__t.html#a5a7ab71f8d1ddc3040fc9038298bf830"> 62</a></span> <a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> (*deinit) (void);</div>
<div class="line"><a id="l00064" name="l00064"></a><span class="lineno"><a class="line" href="structflashcart__t.html#aa2fe700083b66bd2eabf3dd61fa822d7"> 64</a></span> bool (*has_feature) (<a class="code hl_enumeration" href="flashcart_8h.html#a956fff40ddf9cba0ca30fabc0cecb016">flashcart_features_t</a> feature);</div>
<div class="line"><a id="l00066" name="l00066"></a><span class="lineno"><a class="line" href="structflashcart__t.html#a55abdb31614d2847d5d2c4d1b0a0d0a8"> 66</a></span> <a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> (*load_rom) (<span class="keywordtype">char</span> *rom_path, flashcart_progress_callback_t *progress);</div>
<div class="line"><a id="l00068" name="l00068"></a><span class="lineno"><a class="line" href="structflashcart__t.html#a179d217ce8b7d1001e0ed9024506eda5"> 68</a></span> <a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> (*load_file) (<span class="keywordtype">char</span> *file_path, uint32_t rom_offset, uint32_t file_offset);</div>
<div class="line"><a id="l00070" name="l00070"></a><span class="lineno"><a class="line" href="structflashcart__t.html#a7bf8b1451e6bab79870dd36c10c02263"> 70</a></span> <a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> (*load_save) (<span class="keywordtype">char</span> *save_path);</div>
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="structflashcart__t.html#a565a653be5e8c7100f3e171b1a685fb3"> 72</a></span> <a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> (*load_64dd_ipl) (<span class="keywordtype">char</span> *ipl_path, flashcart_progress_callback_t *progress);</div>
<div class="line"><a id="l00074" name="l00074"></a><span class="lineno"><a class="line" href="structflashcart__t.html#ac69df979cdaf9dad1df8ce52593ea009"> 74</a></span> <a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> (*load_64dd_disk) (<span class="keywordtype">char</span> *disk_path, <a class="code hl_struct" href="flashcart_8h.html#structflashcart__disk__parameters__t">flashcart_disk_parameters_t</a> *disk_parameters);</div>
<div class="line"><a id="l00076" name="l00076"></a><span class="lineno"><a class="line" href="structflashcart__t.html#ac6fb8bf7d1957a4200273068c94d13b4"> 76</a></span> <a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> (*set_save_type) (<a class="code hl_enumeration" href="flashcart_8h.html#a51261e17f581033419e18c3e3d0c2cf2">flashcart_save_type_t</a> save_type);</div>
<div class="line"><a id="l00078" name="l00078"></a><span class="lineno"><a class="line" href="structflashcart__t.html#a19eba40921dc872c15fab58bdcc853b1"> 78</a></span> <a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> (*set_save_writeback) (<span class="keywordtype">char</span> *save_path);</div>
<div class="line"><a id="l00079" name="l00079"></a><span class="lineno"> 79</span>} <a class="code hl_struct" href="structflashcart__t.html">flashcart_t</a>;</div>
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"> 80</span> </div>
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span> </div>
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span><span class="keywordtype">char</span> *flashcart_convert_error_message (<a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> err);</div>
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> flashcart_init (<span class="keyword">const</span> <span class="keywordtype">char</span> **storage_prefix);</div>
<div class="line"><a id="l00084" name="l00084"></a><span class="lineno"> 84</span><a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> flashcart_deinit (<span class="keywordtype">void</span>);</div>
<div class="line"><a id="l00085" name="l00085"></a><span class="lineno"> 85</span><span class="keywordtype">bool</span> flashcart_has_feature (<a class="code hl_enumeration" href="flashcart_8h.html#a956fff40ddf9cba0ca30fabc0cecb016">flashcart_features_t</a> feature);</div>
<div class="line"><a id="l00086" name="l00086"></a><span class="lineno"> 86</span><a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> flashcart_load_rom (<span class="keywordtype">char</span> *rom_path, <span class="keywordtype">bool</span> byte_swap, flashcart_progress_callback_t *progress);</div>
<div class="line"><a id="l00087" name="l00087"></a><span class="lineno"> 87</span><a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> flashcart_load_file (<span class="keywordtype">char</span> *file_path, uint32_t rom_offset, uint32_t file_offset);</div>
<div class="line"><a id="l00088" name="l00088"></a><span class="lineno"> 88</span><a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> flashcart_load_save (<span class="keywordtype">char</span> *save_path, <a class="code hl_enumeration" href="flashcart_8h.html#a51261e17f581033419e18c3e3d0c2cf2">flashcart_save_type_t</a> save_type);</div>
<div class="line"><a id="l00089" name="l00089"></a><span class="lineno"> 89</span><a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> flashcart_load_64dd_ipl (<span class="keywordtype">char</span> *ipl_path, flashcart_progress_callback_t *progress);</div>
<div class="line"><a id="l00090" name="l00090"></a><span class="lineno"> 90</span><a class="code hl_enumeration" href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a> flashcart_load_64dd_disk (<span class="keywordtype">char</span> *disk_path, <a class="code hl_struct" href="flashcart_8h.html#structflashcart__disk__parameters__t">flashcart_disk_parameters_t</a> *disk_parameters);</div>
<div class="line"><a id="l00091" name="l00091"></a><span class="lineno"> 91</span> </div>
<div class="line"><a id="l00092" name="l00092"></a><span class="lineno"> 92</span> </div>
<div class="line"><a id="l00093" name="l00093"></a><span class="lineno"> 93</span><span class="preprocessor">#endif</span></div>
<div class="ttc" id="aflashcart_8h_html_a324286864a7bc56dbbeeb791aa81ab73"><div class="ttname"><a href="flashcart_8h.html#a324286864a7bc56dbbeeb791aa81ab73">flashcart_err_t</a></div><div class="ttdeci">flashcart_err_t</div><div class="ttdoc">Flashcart error enumeration.</div><div class="ttdef"><b>Definition:</b> flashcart.h:16</div></div>
<div class="ttc" id="aflashcart_8h_html_a51261e17f581033419e18c3e3d0c2cf2"><div class="ttname"><a href="flashcart_8h.html#a51261e17f581033419e18c3e3d0c2cf2">flashcart_save_type_t</a></div><div class="ttdeci">flashcart_save_type_t</div><div class="ttdoc">Flashcart save type enumeration.</div><div class="ttdef"><b>Definition:</b> flashcart.h:35</div></div>
<div class="ttc" id="aflashcart_8h_html_a956fff40ddf9cba0ca30fabc0cecb016"><div class="ttname"><a href="flashcart_8h.html#a956fff40ddf9cba0ca30fabc0cecb016">flashcart_features_t</a></div><div class="ttdeci">flashcart_features_t</div><div class="ttdoc">List of optional supported flashcart features.</div><div class="ttdef"><b>Definition:</b> flashcart.h:28</div></div>
<div class="ttc" id="aflashcart_8h_html_structflashcart__disk__parameters__t"><div class="ttname"><a href="flashcart_8h.html#structflashcart__disk__parameters__t">flashcart_disk_parameters_t</a></div><div class="ttdoc">Flashcart Disk Parameter Structure.</div><div class="ttdef"><b>Definition:</b> flashcart.h:48</div></div>
<div class="ttc" id="astructflashcart__t_html"><div class="ttname"><a href="structflashcart__t.html">flashcart_t</a></div><div class="ttdoc">Flashcart Structure.</div><div class="ttdef"><b>Definition:</b> flashcart.h:58</div></div>
</div><!-- fragment --></div><!-- contents -->
<!-- start footer part -->
<hr class="footer"/><address class="footer"><small>
Generated on Wed Jun 12 2024 22:09:27 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.9.5
</small></address>
</body>
</html>