mirror of
https://github.com/encounter/libnx.git
synced 2026-03-30 11:18:54 -07:00
doozer-agent
117 lines
18 KiB
HTML
117 lines
18 KiB
HTML
<!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.11"/>
|
|
<title>libnx: include/switch/runtime/devices/fs_dev.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>
|
|
<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 id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">libnx
|
|
</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part -->
|
|
<!-- Generated by Doxygen 1.8.11 -->
|
|
<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 Page</span></a></li>
|
|
<li><a href="pages.html"><span>Related Pages</span></a></li>
|
|
<li><a href="annotated.html"><span>Data 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 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_d44c64559bbebec7f509842c48db8b23.html">include</a></li><li class="navelem"><a class="el" href="dir_42bea3d40f1f1694e41a8f3166c98108.html">switch</a></li><li class="navelem"><a class="el" href="dir_afd0453aeaaca58db0f3a26ffe540381.html">runtime</a></li><li class="navelem"><a class="el" href="dir_8e84a2b4adc47392539d92413dc3768e.html">devices</a></li> </ul>
|
|
</div>
|
|
</div><!-- top -->
|
|
<div class="header">
|
|
<div class="headertitle">
|
|
<div class="title">fs_dev.h</div> </div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="fs__dev_8h.html">Go to the documentation of this file.</a><div class="fragment"><div class="line"><a name="l00001"></a><span class="lineno"> 1</span> <span class="comment">/**</span></div><div class="line"><a name="l00002"></a><span class="lineno"> 2</span> <span class="comment"> * @file fs_dev.h</span></div><div class="line"><a name="l00003"></a><span class="lineno"> 3</span> <span class="comment"> * @brief FS driver, using devoptab.</span></div><div class="line"><a name="l00004"></a><span class="lineno"> 4</span> <span class="comment"> * @author yellows8</span></div><div class="line"><a name="l00005"></a><span class="lineno"> 5</span> <span class="comment"> * @author mtheall</span></div><div class="line"><a name="l00006"></a><span class="lineno"> 6</span> <span class="comment"> * @copyright libnx Authors</span></div><div class="line"><a name="l00007"></a><span class="lineno"> 7</span> <span class="comment"> */</span></div><div class="line"><a name="l00008"></a><span class="lineno"> 8</span> <span class="preprocessor">#pragma once</span></div><div class="line"><a name="l00009"></a><span class="lineno"> 9</span> </div><div class="line"><a name="l00010"></a><span class="lineno"> 10</span> <span class="preprocessor">#include <sys/types.h></span></div><div class="line"><a name="l00011"></a><span class="lineno"> 11</span> <span class="preprocessor">#include "../../services/fs.h"</span></div><div class="line"><a name="l00012"></a><span class="lineno"> 12</span> </div><div class="line"><a name="l00013"></a><span class="lineno"><a class="line" href="fs__dev_8h.html#ad6e9d067a702af02a3d353ae34c0689e"> 13</a></span> <span class="preprocessor">#define FSDEV_DIRITER_MAGIC 0x66736476 </span><span class="comment">///< "fsdv"</span></div><div class="line"><a name="l00014"></a><span class="lineno"> 14</span> <span class="comment"></span></div><div class="line"><a name="l00015"></a><span class="lineno"> 15</span> <span class="comment">/// Open directory struct</span></div><div class="line"><a name="l00016"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html"> 16</a></span> <span class="comment"></span><span class="keyword">typedef</span> <span class="keyword">struct</span></div><div class="line"><a name="l00017"></a><span class="lineno"> 17</span> {</div><div class="line"><a name="l00018"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html#a5fcbe07d06351a9efcfa2ce4e762af16"> 18</a></span>  <a class="code" href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a> <a class="code" href="structfsdev__dir__t.html#a5fcbe07d06351a9efcfa2ce4e762af16">magic</a>; <span class="comment">///< "fsdv"</span></div><div class="line"><a name="l00019"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html#a644adafed15480977127f5e4b222550c"> 19</a></span> <span class="comment"></span> <a class="code" href="structFsDir.html">FsDir</a> <a class="code" href="structfsdev__dir__t.html#a644adafed15480977127f5e4b222550c">fd</a>; <span class="comment">///< File descriptor</span></div><div class="line"><a name="l00020"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html#af603e154cdaaa7b6c3d3cd233cf1e914"> 20</a></span> <span class="comment"></span> ssize_t <a class="code" href="structfsdev__dir__t.html#af603e154cdaaa7b6c3d3cd233cf1e914">index</a>; <span class="comment">///< Current entry index</span></div><div class="line"><a name="l00021"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html#a2b6a04ec1a69f845865a00d461611aa3"> 21</a></span> <span class="comment"></span> <span class="keywordtype">size_t</span> <a class="code" href="structfsdev__dir__t.html#a2b6a04ec1a69f845865a00d461611aa3">size</a>; <span class="comment">///< Current batch size</span></div><div class="line"><a name="l00022"></a><span class="lineno"><a class="line" href="structfsdev__dir__t.html#a2039dfea4683c6aa5049f6b1d553d5cd"> 22</a></span> <span class="comment"></span> <a class="code" href="structFsDirectoryEntry.html">FsDirectoryEntry</a> entry_data[32]; <span class="comment">///< Temporary storage for reading entries</span></div><div class="line"><a name="l00023"></a><span class="lineno"> 23</span> <span class="comment"></span>} <a class="code" href="structfsdev__dir__t.html">fsdev_dir_t</a>;</div><div class="line"><a name="l00024"></a><span class="lineno"> 24</span> <span class="comment"></span></div><div class="line"><a name="l00025"></a><span class="lineno"> 25</span> <span class="comment">/// Initializes and mounts the sdmc device if accessible. Also initializes current working directory to point to the folder containing the path to the executable (argv[0]), if it is provided by the environment.</span></div><div class="line"><a name="l00026"></a><span class="lineno"> 26</span> <span class="comment"></span><a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code" href="fs__dev_8h.html#adbb4e3052a264aac8de47b53f3e41327">fsdevMountSdmc</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00027"></a><span class="lineno"> 27</span> <span class="comment"></span></div><div class="line"><a name="l00028"></a><span class="lineno"> 28</span> <span class="comment">/// Mounts the input fs with the specified device name. fsdev will handle closing the fs when required, including when fsdevMountDevice() fails.</span></div><div class="line"><a name="l00029"></a><span class="lineno"> 29</span> <span class="comment">/// Returns -1 when any errors occur.</span></div><div class="line"><a name="l00030"></a><span class="lineno"> 30</span> <span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="fs__dev_8h.html#a9e65c89226ab22ed62eb9776896ede2f">fsdevMountDevice</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name, <a class="code" href="structFsFileSystem.html">FsFileSystem</a> fs);</div><div class="line"><a name="l00031"></a><span class="lineno"> 31</span> <span class="comment"></span></div><div class="line"><a name="l00032"></a><span class="lineno"> 32</span> <span class="comment">/// Unmounts the specified device.</span></div><div class="line"><a name="l00033"></a><span class="lineno"> 33</span> <span class="comment"></span><span class="keywordtype">int</span> <a class="code" href="fs__dev_8h.html#ad5bd2af2a4d2a011f431bf2c0d1679f2">fsdevUnmountDevice</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div><div class="line"><a name="l00034"></a><span class="lineno"> 34</span> <span class="comment"></span></div><div class="line"><a name="l00035"></a><span class="lineno"> 35</span> <span class="comment">/// Uses fsFsCommit() with the specified device. This must be used after any savedata-write operations(not just file-write).</span></div><div class="line"><a name="l00036"></a><span class="lineno"> 36</span> <span class="comment">/// This is not used automatically at device unmount.</span></div><div class="line"><a name="l00037"></a><span class="lineno"> 37</span> <span class="comment"></span><a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code" href="fs__dev_8h.html#aa9634b8f9ff2c8e3ad90e6f8e2906a14">fsdevCommitDevice</a>(<span class="keyword">const</span> <span class="keywordtype">char</span> *name);</div><div class="line"><a name="l00038"></a><span class="lineno"> 38</span> <span class="comment"></span></div><div class="line"><a name="l00039"></a><span class="lineno"> 39</span> <span class="comment">/// Returns the FsFileSystem for the default device (SD card), if mounted. Used internally by romfs_dev.</span></div><div class="line"><a name="l00040"></a><span class="lineno"> 40</span> <span class="comment"></span><a class="code" href="structFsFileSystem.html">FsFileSystem</a>* <a class="code" href="fs__dev_8h.html#a32fea478a82e0b1c5a51588c69f1d1ae">fsdevGetDefaultFileSystem</a>(<span class="keywordtype">void</span>);</div><div class="line"><a name="l00041"></a><span class="lineno"> 41</span> <span class="comment"></span></div><div class="line"><a name="l00042"></a><span class="lineno"> 42</span> <span class="comment">/// Unmounts all devices and cleans up any resources used by the FS driver.</span></div><div class="line"><a name="l00043"></a><span class="lineno"> 43</span> <span class="comment"></span><a class="code" href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a> <a class="code" href="fs__dev_8h.html#ad13800ff0e52530283b410ed3ec03d3c">fsdevUnmountAll</a>(<span class="keywordtype">void</span>);</div><div class="ttc" id="structfsdev__dir__t_html_a644adafed15480977127f5e4b222550c"><div class="ttname"><a href="structfsdev__dir__t.html#a644adafed15480977127f5e4b222550c">fsdev_dir_t::fd</a></div><div class="ttdeci">FsDir fd</div><div class="ttdoc">File descriptor. </div><div class="ttdef"><b>Definition:</b> fs_dev.h:19</div></div>
|
|
<div class="ttc" id="fs__dev_8h_html_aa9634b8f9ff2c8e3ad90e6f8e2906a14"><div class="ttname"><a href="fs__dev_8h.html#aa9634b8f9ff2c8e3ad90e6f8e2906a14">fsdevCommitDevice</a></div><div class="ttdeci">Result fsdevCommitDevice(const char *name)</div><div class="ttdoc">Uses fsFsCommit() with the specified device. </div></div>
|
|
<div class="ttc" id="structfsdev__dir__t_html_af603e154cdaaa7b6c3d3cd233cf1e914"><div class="ttname"><a href="structfsdev__dir__t.html#af603e154cdaaa7b6c3d3cd233cf1e914">fsdev_dir_t::index</a></div><div class="ttdeci">ssize_t index</div><div class="ttdoc">Current entry index. </div><div class="ttdef"><b>Definition:</b> fs_dev.h:20</div></div>
|
|
<div class="ttc" id="structfsdev__dir__t_html_a2b6a04ec1a69f845865a00d461611aa3"><div class="ttname"><a href="structfsdev__dir__t.html#a2b6a04ec1a69f845865a00d461611aa3">fsdev_dir_t::size</a></div><div class="ttdeci">size_t size</div><div class="ttdoc">Current batch size. </div><div class="ttdef"><b>Definition:</b> fs_dev.h:21</div></div>
|
|
<div class="ttc" id="fs__dev_8h_html_a32fea478a82e0b1c5a51588c69f1d1ae"><div class="ttname"><a href="fs__dev_8h.html#a32fea478a82e0b1c5a51588c69f1d1ae">fsdevGetDefaultFileSystem</a></div><div class="ttdeci">FsFileSystem * fsdevGetDefaultFileSystem(void)</div><div class="ttdoc">Returns the FsFileSystem for the default device (SD card), if mounted. Used internally by romfs_dev...</div></div>
|
|
<div class="ttc" id="types_8h_html_ad1be2721625a17f1be47fac918032afe"><div class="ttname"><a href="types_8h.html#ad1be2721625a17f1be47fac918032afe">Result</a></div><div class="ttdeci">u32 Result</div><div class="ttdoc">Function error code result type. </div><div class="ttdef"><b>Definition:</b> types.h:46</div></div>
|
|
<div class="ttc" id="fs__dev_8h_html_adbb4e3052a264aac8de47b53f3e41327"><div class="ttname"><a href="fs__dev_8h.html#adbb4e3052a264aac8de47b53f3e41327">fsdevMountSdmc</a></div><div class="ttdeci">Result fsdevMountSdmc(void)</div><div class="ttdoc">Initializes and mounts the sdmc device if accessible. Also initializes current working directory to p...</div></div>
|
|
<div class="ttc" id="fs__dev_8h_html_ad13800ff0e52530283b410ed3ec03d3c"><div class="ttname"><a href="fs__dev_8h.html#ad13800ff0e52530283b410ed3ec03d3c">fsdevUnmountAll</a></div><div class="ttdeci">Result fsdevUnmountAll(void)</div><div class="ttdoc">Unmounts all devices and cleans up any resources used by the FS driver. </div></div>
|
|
<div class="ttc" id="types_8h_html_afaa62991928fb9fb18ff0db62a040aba"><div class="ttname"><a href="types_8h.html#afaa62991928fb9fb18ff0db62a040aba">u32</a></div><div class="ttdeci">uint32_t u32</div><div class="ttdoc">32-bit unsigned integer. </div><div class="ttdef"><b>Definition:</b> types.h:23</div></div>
|
|
<div class="ttc" id="fs__dev_8h_html_a9e65c89226ab22ed62eb9776896ede2f"><div class="ttname"><a href="fs__dev_8h.html#a9e65c89226ab22ed62eb9776896ede2f">fsdevMountDevice</a></div><div class="ttdeci">int fsdevMountDevice(const char *name, FsFileSystem fs)</div><div class="ttdoc">Mounts the input fs with the specified device name. </div></div>
|
|
<div class="ttc" id="structfsdev__dir__t_html_a5fcbe07d06351a9efcfa2ce4e762af16"><div class="ttname"><a href="structfsdev__dir__t.html#a5fcbe07d06351a9efcfa2ce4e762af16">fsdev_dir_t::magic</a></div><div class="ttdeci">u32 magic</div><div class="ttdoc">"fsdv" </div><div class="ttdef"><b>Definition:</b> fs_dev.h:18</div></div>
|
|
<div class="ttc" id="structfsdev__dir__t_html"><div class="ttname"><a href="structfsdev__dir__t.html">fsdev_dir_t</a></div><div class="ttdoc">Open directory struct. </div><div class="ttdef"><b>Definition:</b> fs_dev.h:16</div></div>
|
|
<div class="ttc" id="structFsFileSystem_html"><div class="ttname"><a href="structFsFileSystem.html">FsFileSystem</a></div><div class="ttdef"><b>Definition:</b> fs.h:23</div></div>
|
|
<div class="ttc" id="fs__dev_8h_html_ad5bd2af2a4d2a011f431bf2c0d1679f2"><div class="ttname"><a href="fs__dev_8h.html#ad5bd2af2a4d2a011f431bf2c0d1679f2">fsdevUnmountDevice</a></div><div class="ttdeci">int fsdevUnmountDevice(const char *name)</div><div class="ttdoc">Unmounts the specified device. </div></div>
|
|
<div class="ttc" id="structFsDir_html"><div class="ttname"><a href="structFsDir.html">FsDir</a></div><div class="ttdef"><b>Definition:</b> fs.h:31</div></div>
|
|
<div class="ttc" id="structFsDirectoryEntry_html"><div class="ttname"><a href="structFsDirectoryEntry.html">FsDirectoryEntry</a></div><div class="ttdoc">Directory entry. </div><div class="ttdef"><b>Definition:</b> fs.h:52</div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
<!-- start footer part -->
|
|
<hr class="footer"/><address class="footer"><small>
|
|
Generated by  <a href="http://www.doxygen.org/index.html">
|
|
<img class="footer" src="doxygen.png" alt="doxygen"/>
|
|
</a> 1.8.11
|
|
</small></address>
|
|
</body>
|
|
</html>
|