mirror of
https://github.com/EnderIce2/Fennix.git
synced 2025-05-27 15:04:31 +00:00
193 lines
18 KiB
HTML
193 lines
18 KiB
HTML
<!-- HTML header for doxygen 1.9.1-->
|
|
<!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.8" />
|
|
<meta name="viewport" content="width=device-width, initial-scale=1" />
|
|
<title>Fennix: Kernel/include/interface/block.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="../../navtree.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="../../resize.js"></script>
|
|
<script type="text/javascript" src="../../navtreedata.js"></script>
|
|
<script type="text/javascript" src="../../navtree.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" />
|
|
<link href="../../doxygen-awesome.css" rel="stylesheet" type="text/css"/>
|
|
<link href="../../custom.css" rel="stylesheet" type="text/css"/>
|
|
<script type="text/javascript" src="../../doxygen-awesome-darkmode-toggle.js"></script>
|
|
<script type="text/javascript" src="../../doxygen-awesome-fragment-copy-button.js"></script>
|
|
<script type="text/javascript" src="../../doxygen-awesome-paragraph-link.js"></script>
|
|
<script type="text/javascript" src="../../doxygen-awesome-interactive-toc.js"></script>
|
|
<script type="text/javascript" src="../../doxygen-awesome-tabs.js"></script>
|
|
<script type="text/javascript">
|
|
DoxygenAwesomeDarkModeToggle.init()
|
|
DoxygenAwesomeFragmentCopyButton.init()
|
|
DoxygenAwesomeParagraphLink.init()
|
|
DoxygenAwesomeInteractiveToc.init()
|
|
DoxygenAwesomeTabs.init()
|
|
</script>
|
|
</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="../../favicon.ico" /></td>
|
|
<td id="projectalign" style="padding-left: 0.5em;">
|
|
<div id="projectname">Fennix
|
|
 <span
|
|
id="projectnumber">1.0.0</span>
|
|
</div>
|
|
<div id="projectbrief">Full Documentation</div>
|
|
</td>
|
|
</tr>
|
|
</tbody>
|
|
</table>
|
|
</div>
|
|
<!-- end header part --><!-- Generated by Doxygen 1.9.8 -->
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&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&dn=expat.txt MIT */
|
|
$(function() {
|
|
initMenu('../../',true,false,'search.php','Search');
|
|
$(document).ready(function() { init_search(); });
|
|
});
|
|
/* @license-end */
|
|
</script>
|
|
<div id="main-nav"></div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function() { init_codefold(1); });
|
|
/* @license-end */
|
|
</script>
|
|
</div><!-- top -->
|
|
<div id="side-nav" class="ui-resizable side-nav-resizable">
|
|
<div id="nav-tree">
|
|
<div id="nav-tree-contents">
|
|
<div id="nav-sync" class="sync"></div>
|
|
</div>
|
|
</div>
|
|
<div id="splitbar" style="-moz-user-select:none;"
|
|
class="ui-resizable-handle">
|
|
</div>
|
|
</div>
|
|
<script type="text/javascript">
|
|
/* @license magnet:?xt=urn:btih:d3d9a9a6595521f9666a5e94cc830dab83b65699&dn=expat.txt MIT */
|
|
$(document).ready(function(){initNavTree('de/d40/block_8h_source.html','../../'); initResizable(); });
|
|
/* @license-end */
|
|
</script>
|
|
<div id="doc-content">
|
|
<!-- 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 class="header">
|
|
<div class="headertitle"><div class="title">block.h</div></div>
|
|
</div><!--header-->
|
|
<div class="contents">
|
|
<a href="../../de/d40/block_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><span class="comment">/*</span></div>
|
|
<div class="line"><a id="l00002" name="l00002"></a><span class="lineno"> 2</span><span class="comment"> This file is part of Fennix Kernel.</span></div>
|
|
<div class="line"><a id="l00003" name="l00003"></a><span class="lineno"> 3</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00004" name="l00004"></a><span class="lineno"> 4</span><span class="comment"> Fennix Kernel is free software: you can redistribute it and/or</span></div>
|
|
<div class="line"><a id="l00005" name="l00005"></a><span class="lineno"> 5</span><span class="comment"> modify it under the terms of the GNU General Public License as</span></div>
|
|
<div class="line"><a id="l00006" name="l00006"></a><span class="lineno"> 6</span><span class="comment"> published by the Free Software Foundation, either version 3 of</span></div>
|
|
<div class="line"><a id="l00007" name="l00007"></a><span class="lineno"> 7</span><span class="comment"> the License, or (at your option) any later version.</span></div>
|
|
<div class="line"><a id="l00008" name="l00008"></a><span class="lineno"> 8</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00009" name="l00009"></a><span class="lineno"> 9</span><span class="comment"> Fennix Kernel is distributed in the hope that it will be useful,</span></div>
|
|
<div class="line"><a id="l00010" name="l00010"></a><span class="lineno"> 10</span><span class="comment"> but WITHOUT ANY WARRANTY; without even the implied warranty of</span></div>
|
|
<div class="line"><a id="l00011" name="l00011"></a><span class="lineno"> 11</span><span class="comment"> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the</span></div>
|
|
<div class="line"><a id="l00012" name="l00012"></a><span class="lineno"> 12</span><span class="comment"> GNU General Public License for more details.</span></div>
|
|
<div class="line"><a id="l00013" name="l00013"></a><span class="lineno"> 13</span><span class="comment"></span> </div>
|
|
<div class="line"><a id="l00014" name="l00014"></a><span class="lineno"> 14</span><span class="comment"> You should have received a copy of the GNU General Public License</span></div>
|
|
<div class="line"><a id="l00015" name="l00015"></a><span class="lineno"> 15</span><span class="comment"> along with Fennix Kernel. If not, see <https://www.gnu.org/licenses/>.</span></div>
|
|
<div class="line"><a id="l00016" name="l00016"></a><span class="lineno"> 16</span><span class="comment">*/</span></div>
|
|
<div class="line"><a id="l00017" name="l00017"></a><span class="lineno"> 17</span> </div>
|
|
<div class="line"><a id="l00018" name="l00018"></a><span class="lineno"> 18</span><span class="preprocessor">#ifndef __FENNIX_API_BLOCK_H__</span></div>
|
|
<div class="line"><a id="l00019" name="l00019"></a><span class="lineno"> 19</span><span class="preprocessor">#define __FENNIX_API_BLOCK_H__</span></div>
|
|
<div class="line"><a id="l00020" name="l00020"></a><span class="lineno"> 20</span> </div>
|
|
<div class="line"><a id="l00021" name="l00021"></a><span class="lineno"> 21</span><span class="preprocessor">#include <types.h></span></div>
|
|
<div class="line"><a id="l00022" name="l00022"></a><span class="lineno"> 22</span> </div>
|
|
<div class="line"><a id="l00023" name="l00023"></a><span class="lineno"> 23</span><span class="preprocessor">#if __has_include(<interface/fs.h>)</span></div>
|
|
<div class="line"><a id="l00024" name="l00024"></a><span class="lineno"> 24</span><span class="preprocessor">#include <<a class="code" href="../../df/d26/fs_8h.html">interface/fs.h</a>></span></div>
|
|
<div class="line"><a id="l00025" name="l00025"></a><span class="lineno"> 25</span><span class="preprocessor">#else</span></div>
|
|
<div class="line"><a id="l00026" name="l00026"></a><span class="lineno"> 26</span><span class="preprocessor">#include <<a class="code" href="../../df/d26/fs_8h.html">fs.h</a>></span></div>
|
|
<div class="line"><a id="l00027" name="l00027"></a><span class="lineno"> 27</span><span class="preprocessor">#endif</span></div>
|
|
<div class="line"><a id="l00028" name="l00028"></a><span class="lineno"> 28</span> </div>
|
|
<div class="foldopen" id="foldopen00029" data-start="{" data-end="};">
|
|
<div class="line"><a id="l00029" name="l00029"></a><span class="lineno"><a class="line" href="../../de/d40/block_8h.html"> 29</a></span><span class="keyword">struct </span><a class="code hl_struct" href="../../de/d40/block_8h.html#da/df6/structBlockDevice">BlockDevice</a></div>
|
|
<div class="line"><a id="l00030" name="l00030"></a><span class="lineno"> 30</span>{</div>
|
|
<div class="line"><a id="l00038" name="l00038"></a><span class="lineno"><a class="line" href="../../de/d40/block_8h.html#ac89f7fabb9b61c6adaff880b4d300a8f"> 38</a></span> <span class="keyword">const</span> <span class="keywordtype">char</span> *<a class="code hl_variable" href="../../de/d40/block_8h.html#ac89f7fabb9b61c6adaff880b4d300a8f">Name</a>;</div>
|
|
<div class="line"><a id="l00039" name="l00039"></a><span class="lineno"> 39</span> </div>
|
|
<div class="line"><a id="l00046" name="l00046"></a><span class="lineno"><a class="line" href="../../de/d40/block_8h.html#a5c99e12972a959e55d35667b073f0338"> 46</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="../../de/d40/block_8h.html#a5c99e12972a959e55d35667b073f0338">Size</a>;</div>
|
|
<div class="line"><a id="l00047" name="l00047"></a><span class="lineno"> 47</span> </div>
|
|
<div class="line"><a id="l00054" name="l00054"></a><span class="lineno"><a class="line" href="../../de/d40/block_8h.html#a04a25b932f09124e40b427312bb51437"> 54</a></span> uint32_t <a class="code hl_variable" href="../../de/d40/block_8h.html#a04a25b932f09124e40b427312bb51437">BlockSize</a>;</div>
|
|
<div class="line"><a id="l00055" name="l00055"></a><span class="lineno"> 55</span> </div>
|
|
<div class="line"><a id="l00062" name="l00062"></a><span class="lineno"><a class="line" href="../../de/d40/block_8h.html#a0f27ac20f77368f3847ca934c3449239"> 62</a></span> <span class="keywordtype">size_t</span> <a class="code hl_variable" href="../../de/d40/block_8h.html#a0f27ac20f77368f3847ca934c3449239">BlockCount</a>;</div>
|
|
<div class="line"><a id="l00063" name="l00063"></a><span class="lineno"> 63</span> </div>
|
|
<div class="line"><a id="l00072" name="l00072"></a><span class="lineno"><a class="line" href="../../de/d40/block_8h.html#a00ca2ebbf46a93847c9c56f1d9c79772"> 72</a></span> <span class="keyword">const</span> <a class="code hl_struct" href="../../db/de6/structInodeOperations.html">InodeOperations</a> *<a class="code hl_variable" href="../../de/d40/block_8h.html#a00ca2ebbf46a93847c9c56f1d9c79772">Ops</a>;</div>
|
|
<div class="line"><a id="l00073" name="l00073"></a><span class="lineno"> 73</span> </div>
|
|
<div class="line"><a id="l00080" name="l00080"></a><span class="lineno"><a class="line" href="../../de/d40/block_8h.html#a76a65f2f7a85cd15fff4f1a9859ca508"> 80</a></span> <span class="keywordtype">void</span> *<a class="code hl_variable" href="../../de/d40/block_8h.html#a76a65f2f7a85cd15fff4f1a9859ca508">PrivateData</a>;</div>
|
|
<div class="line"><a id="l00081" name="l00081"></a><span class="lineno"> 81</span>};</div>
|
|
</div>
|
|
<div class="line"><a id="l00082" name="l00082"></a><span class="lineno"> 82</span> </div>
|
|
<div class="line"><a id="l00083" name="l00083"></a><span class="lineno"> 83</span><span class="preprocessor">#ifndef __kernel__</span></div>
|
|
<div class="line"><a id="l00095" name="l00095"></a><span class="lineno"><a class="line" href="../../de/d40/block_8h.html#a09eca2dff18d5b57780c356d331db570"> 95</a></span>dev_t <a class="code hl_function" href="../../de/d40/block_8h.html#a09eca2dff18d5b57780c356d331db570">RegisterBlockDevice</a>(<span class="keyword">struct</span> <a class="code hl_struct" href="../../de/d40/block_8h.html#da/df6/structBlockDevice">BlockDevice</a> *Device);</div>
|
|
<div class="line"><a id="l00096" name="l00096"></a><span class="lineno"> 96</span> </div>
|
|
<div class="line"><a id="l00107" name="l00107"></a><span class="lineno"><a class="line" href="../../de/d40/block_8h.html#aa2fbd9e6d3f42f3c7f94c48795acddad"> 107</a></span><span class="keywordtype">int</span> <a class="code hl_function" href="../../de/d40/block_8h.html#aa2fbd9e6d3f42f3c7f94c48795acddad">UnregisterBlockDevice</a>(dev_t DeviceID);</div>
|
|
<div class="line"><a id="l00108" name="l00108"></a><span class="lineno"> 108</span><span class="preprocessor">#endif </span><span class="comment">// __kernel__</span></div>
|
|
<div class="line"><a id="l00109" name="l00109"></a><span class="lineno"> 109</span> </div>
|
|
<div class="line"><a id="l00110" name="l00110"></a><span class="lineno"> 110</span><span class="preprocessor">#endif </span><span class="comment">// __FENNIX_API_BLOCK_H__</span></div>
|
|
<div class="ttc" id="ablock_8h_html_a00ca2ebbf46a93847c9c56f1d9c79772"><div class="ttname"><a href="../../de/d40/block_8h.html#a00ca2ebbf46a93847c9c56f1d9c79772">BlockDevice::Ops</a></div><div class="ttdeci">const InodeOperations * Ops</div><div class="ttdoc">Pointer to the block device operations structure.</div><div class="ttdef"><b>Definition</b> <a href="../../de/d40/block_8h_source.html#l00072">block.h:72</a></div></div>
|
|
<div class="ttc" id="ablock_8h_html_a04a25b932f09124e40b427312bb51437"><div class="ttname"><a href="../../de/d40/block_8h.html#a04a25b932f09124e40b427312bb51437">BlockDevice::BlockSize</a></div><div class="ttdeci">uint32_t BlockSize</div><div class="ttdoc">Size of a single block in bytes.</div><div class="ttdef"><b>Definition</b> <a href="../../de/d40/block_8h_source.html#l00054">block.h:54</a></div></div>
|
|
<div class="ttc" id="ablock_8h_html_a09eca2dff18d5b57780c356d331db570"><div class="ttname"><a href="../../de/d40/block_8h.html#a09eca2dff18d5b57780c356d331db570">RegisterBlockDevice</a></div><div class="ttdeci">dev_t RegisterBlockDevice(struct BlockDevice *Device)</div><div class="ttdoc">Registers a block device with the kernel block subsystem.</div></div>
|
|
<div class="ttc" id="ablock_8h_html_a0f27ac20f77368f3847ca934c3449239"><div class="ttname"><a href="../../de/d40/block_8h.html#a0f27ac20f77368f3847ca934c3449239">BlockDevice::BlockCount</a></div><div class="ttdeci">size_t BlockCount</div><div class="ttdoc">Number of blocks in the device.</div><div class="ttdef"><b>Definition</b> <a href="../../de/d40/block_8h_source.html#l00062">block.h:62</a></div></div>
|
|
<div class="ttc" id="ablock_8h_html_a5c99e12972a959e55d35667b073f0338"><div class="ttname"><a href="../../de/d40/block_8h.html#a5c99e12972a959e55d35667b073f0338">BlockDevice::Size</a></div><div class="ttdeci">size_t Size</div><div class="ttdoc">Total size of the device in bytes.</div><div class="ttdef"><b>Definition</b> <a href="../../de/d40/block_8h_source.html#l00046">block.h:46</a></div></div>
|
|
<div class="ttc" id="ablock_8h_html_a76a65f2f7a85cd15fff4f1a9859ca508"><div class="ttname"><a href="../../de/d40/block_8h.html#a76a65f2f7a85cd15fff4f1a9859ca508">BlockDevice::PrivateData</a></div><div class="ttdeci">void * PrivateData</div><div class="ttdoc">Opaque pointer to driver-specific or hardware-specific data.</div><div class="ttdef"><b>Definition</b> <a href="../../de/d40/block_8h_source.html#l00080">block.h:80</a></div></div>
|
|
<div class="ttc" id="ablock_8h_html_aa2fbd9e6d3f42f3c7f94c48795acddad"><div class="ttname"><a href="../../de/d40/block_8h.html#aa2fbd9e6d3f42f3c7f94c48795acddad">UnregisterBlockDevice</a></div><div class="ttdeci">int UnregisterBlockDevice(dev_t DeviceID)</div><div class="ttdoc">Unregisters a block device from the kernel block subsystem.</div></div>
|
|
<div class="ttc" id="ablock_8h_html_ac89f7fabb9b61c6adaff880b4d300a8f"><div class="ttname"><a href="../../de/d40/block_8h.html#ac89f7fabb9b61c6adaff880b4d300a8f">BlockDevice::Name</a></div><div class="ttdeci">const char * Name</div><div class="ttdoc">Base name of the device.</div><div class="ttdef"><b>Definition</b> <a href="../../de/d40/block_8h_source.html#l00038">block.h:38</a></div></div>
|
|
<div class="ttc" id="ablock_8h_html_da/df6/structBlockDevice"><div class="ttname"><a href="../../de/d40/block_8h.html#da/df6/structBlockDevice">BlockDevice</a></div><div class="ttdef"><b>Definition</b> <a href="../../de/d40/block_8h_source.html#l00029">block.h:30</a></div></div>
|
|
<div class="ttc" id="afs_8h_html"><div class="ttname"><a href="../../df/d26/fs_8h.html">fs.h</a></div></div>
|
|
<div class="ttc" id="astructInodeOperations_html"><div class="ttname"><a href="../../db/de6/structInodeOperations.html">InodeOperations</a></div><div class="ttdef"><b>Definition</b> <a href="../../df/d26/fs_8h_source.html#l00304">fs.h:305</a></div></div>
|
|
</div><!-- fragment --></div><!-- contents -->
|
|
</div><!-- doc-content -->
|
|
<!-- start footer part -->
|
|
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
|
|
<ul>
|
|
<li class="navelem"><a class="el" href="../../dir_52bed8acfaac088d5968cb2c84d7645d.html">Kernel</a></li><li class="navelem"><a class="el" href="../../dir_2c335c1ccbf6ef7c89cc08c9ed88be2e.html">include</a></li><li class="navelem"><a class="el" href="../../dir_811a06ffcfc34bd0f88967f0406a39f5.html">interface</a></li><li class="navelem"><a class="el" href="../../de/d40/block_8h.html">block.h</a></li>
|
|
<li class="footer">Generated on Sun May 18 2025 20:18:23 for Fennix by <a href="https://www.doxygen.org/index.html"><img class="footer" src="../../doxygen.svg" width="104" height="31" alt="doxygen"/></a> 1.9.8 </li>
|
|
</ul>
|
|
</div>
|
|
</body>
|
|
</html>
|