<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<html><head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
<title>UbixOS V2: src/sys/include/vfs/vfs.h File Reference</title>
<link href="doxygen.css" rel="stylesheet" type="text/css">
<link href="tabs.css" rel="stylesheet" type="text/css">
</head><body>
<!-- Generated by Doxygen 1.4.7 -->
<div class="tabs">
<ul>
<li><a href="main.html"><span>Main Page</span></a></li>
<li><a href="classes.html"><span>Data Structures</span></a></li>
<li id="current"><a href="files.html"><span>Files</span></a></li>
<li><a href="dirs.html"><span>Directories</span></a></li>
<li>
<form action="search.php" method="get">
<table cellspacing="0" cellpadding="0" border="0">
<tr>
<td><label> <u>S</u>earch for </label></td>
<td><input type="text" name="query" value="" size="20" accesskey="s"/></td>
</tr>
</table>
</form>
</li>
</ul></div>
<div class="tabs">
<ul>
<li><a href="files.html"><span>File List</span></a></li>
<li><a href="globals.html"><span>Globals</span></a></li>
</ul></div>
<div class="nav">
<a class="el" href="dir_897b6a2d7bab147dd1db58381aad3984.html">src</a> » <a class="el" href="dir_832905b1f7f5feaf61a306b40c0ac817.html">sys</a> » <a class="el" href="dir_caf4200c438ae9601464168e21e8e4d8.html">include</a> » <a class="el" href="dir_77bb06880a0e48020cb00f59405a6b13.html">vfs</a></div>
<h1>vfs.h File Reference</h1><code>#include <<a class="el" href="types_8h-source.html">ubixos/types.h</a>></code><br>
<code>#include <<a class="el" href="file_8h-source.html">vfs/file.h</a>></code><br>
<code>#include <<a class="el" href="mount_8h-source.html">vfs/mount.h</a>></code><br>
<code>#include <<a class="el" href="sysproto_8h-source.html">sys/sysproto.h</a>></code><br>
<code>#include <<a class="el" href="thread_8h-source.html">sys/thread.h</a>></code><br>
<p>
Include dependency graph for vfs.h:<p><center><img src="vfs_8h__incl.png" border="0" usemap="#src/sys/include/vfs/vfs.h_map" alt=""></center>
<map name="src/sys/include/vfs/vfs.h_map">
<area href="types_8h.html" shape="rect" coords="596,132,716,159" alt="">
<area href="file_8h.html" shape="rect" coords="257,107,337,134" alt="">
<area href="mount_8h.html" shape="rect" coords="425,158,527,184" alt="">
<area href="sysproto_8h.html" shape="rect" coords="239,208,356,235" alt="">
<area href="thread_8h.html" shape="rect" coords="424,259,528,286" alt="">
<area href="__types_8h.html" shape="rect" coords="767,132,871,159" alt="">
<area href="dirCache_8h.html" shape="rect" coords="407,107,545,134" alt="">
<area href="signal_8h.html" shape="rect" coords="425,208,527,235" alt="">
</map>
<p>
This graph shows which files directly or indirectly include this file:<p><center><img src="vfs_8h__dep__incl.png" border="0" usemap="#src/sys/include/vfs/vfs.hdep_map" alt=""></center>
<map name="src/sys/include/vfs/vfs.hdep_map">
<area href="devfs_8c.html" shape="rect" coords="269,6,432,32" alt="">
<area href="buf_8h.html" shape="rect" coords="257,56,444,83" alt="">
<area href="ffs_8c.html" shape="rect" coords="555,132,680,159" alt="">
<area href="ubixfs_8h.html" shape="rect" coords="239,411,463,438" alt="">
<area href="init_8h.html" shape="rect" coords="513,335,721,362" alt="">
<area href="thread_8c.html" shape="rect" coords="531,399,704,426" alt="">
<area href="ubixfs_8c.html" shape="rect" coords="532,456,703,483" alt="">
<area href="vitals_8h.html" shape="rect" coords="239,563,463,590" alt="">
<area href="file_8c.html" shape="rect" coords="553,538,681,564" alt="">
<area href="vfs_8c.html" shape="rect" coords="553,588,681,615" alt="">
<area href="ffs_8h.html" shape="rect" coords="260,158,441,184" alt="">
<area href="ufs_8c.html" shape="rect" coords="553,208,681,235" alt="">
<area href="ufs_8h.html" shape="rect" coords="259,259,443,286" alt="">
<area href="ld_8c.html" shape="rect" coords="280,664,421,691" alt="">
<area href="kmod_8c.html" shape="rect" coords="265,715,436,742" alt="">
</map>
<p>
<a href="vfs_8h-source.html">Go to the source code of this file.</a><table border="0" cellpadding="0" cellspacing="0">
<tr><td></td></tr>
<tr><td colspan="2"><br><h2>Data Structures</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">struct </td><td class="memItemRight" valign="bottom"><a class="el" href="structfileSystem.html">fileSystem</a></td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">filesSystem Structure <a href="structfileSystem.html#_details">More...</a><br></td></tr>
<tr><td colspan="2"><br><h2>Defines</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#0b9c2cfc0e4cef01ef0f439550a080d8">fdAvail</a> 1</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#4907ecb6121af1b80c5c5b436ebe3cb5">fdEof</a> 4</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#249a3d8cdfed3302062ad215b95a4294">fdOpen</a> 2</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#a461f4419baab36cdd1143cd0fe66e0e">fdRead</a> 3</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#e4c27d5653358d16438504434867dfff">fileAppend</a> 0x0008</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#3e8798b0a6e30da29349c1b6d827f52a">fileBinary</a> 0x0004</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#e8e814536103f514b8460ec7a0fc4553">fileRead</a> 0x0001</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#4898b5a1a1daebda9d11b4afde062e5c">fileWrite</a> 0x0002</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">#define </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#7345172cf7a0188e85f54fca04e800fb">maxFd</a> 32</td></tr>
<tr><td colspan="2"><br><h2>Functions</h2></td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top"><a class="el" href="structfileSystem.html">fileSystem</a> * </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#025f2b08eb8930f06292f32f960ad0c7">vfs_findFS</a> (int)</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#ca585ca14c08d6c1a07e1b886fc9749a">vfs_init</a> ()</td></tr>
<tr><td class="memItemLeft" nowrap align="right" valign="top">int </td><td class="memItemRight" valign="bottom"><a class="el" href="vfs_8h.html#8652b1ccbcf7d2a872c5781640f7d59a">vfsRegisterFS</a> (struct <a class="el" href="structfileSystem.html">fileSystem</a>)</td></tr>
<tr><td class="mdescLeft"> </td><td class="mdescRight">register a file system <a href="#8652b1ccbcf7d2a872c5781640f7d59a"></a><br></td></tr>
</table>
<hr><h2>Define Documentation</h2>
<a class="anchor" name="0b9c2cfc0e4cef01ef0f439550a080d8"></a><!-- doxytag: member="vfs.h::fdAvail" ref="0b9c2cfc0e4cef01ef0f439550a080d8" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fdAvail 1 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="vfs_8h-source.html#l00040">40</a> of file <a class="el" href="vfs_8h-source.html">vfs.h</a>.
</div>
</div><p>
<a class="anchor" name="4907ecb6121af1b80c5c5b436ebe3cb5"></a><!-- doxytag: member="vfs.h::fdEof" ref="4907ecb6121af1b80c5c5b436ebe3cb5" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fdEof 4 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="vfs_8h-source.html#l00043">43</a> of file <a class="el" href="vfs_8h-source.html">vfs.h</a>.
<p>
Referenced by <a class="el" href="file_8c-source.html#l00220">feof()</a>, and <a class="el" href="ubixfs_8c-source.html#l00194">readUbixFS()</a>.
</div>
</div><p>
<a class="anchor" name="249a3d8cdfed3302062ad215b95a4294"></a><!-- doxytag: member="vfs.h::fdOpen" ref="249a3d8cdfed3302062ad215b95a4294" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fdOpen 2 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="vfs_8h-source.html#l00041">41</a> of file <a class="el" href="vfs_8h-source.html">vfs.h</a>.
<p>
Referenced by <a class="el" href="file_8c-source.html#l00274">fopen()</a>, and <a class="el" href="ubixfs_8c-source.html#l00118">writeFileByte()</a>.
</div>
</div><p>
<a class="anchor" name="a461f4419baab36cdd1143cd0fe66e0e"></a><!-- doxytag: member="vfs.h::fdRead" ref="a461f4419baab36cdd1143cd0fe66e0e" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fdRead 3 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="vfs_8h-source.html#l00042">42</a> of file <a class="el" href="vfs_8h-source.html">vfs.h</a>.
<p>
Referenced by <a class="el" href="ubixfs_8c-source.html#l00118">writeFileByte()</a>.
</div>
</div><p>
<a class="anchor" name="e4c27d5653358d16438504434867dfff"></a><!-- doxytag: member="vfs.h::fileAppend" ref="e4c27d5653358d16438504434867dfff" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fileAppend 0x0008 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="vfs_8h-source.html#l00049">49</a> of file <a class="el" href="vfs_8h-source.html">vfs.h</a>.
<p>
Referenced by <a class="el" href="file_8c-source.html#l00274">fopen()</a>.
</div>
</div><p>
<a class="anchor" name="3e8798b0a6e30da29349c1b6d827f52a"></a><!-- doxytag: member="vfs.h::fileBinary" ref="3e8798b0a6e30da29349c1b6d827f52a" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fileBinary 0x0004 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="vfs_8h-source.html#l00048">48</a> of file <a class="el" href="vfs_8h-source.html">vfs.h</a>.
<p>
Referenced by <a class="el" href="file_8c-source.html#l00274">fopen()</a>.
</div>
</div><p>
<a class="anchor" name="e8e814536103f514b8460ec7a0fc4553"></a><!-- doxytag: member="vfs.h::fileRead" ref="e8e814536103f514b8460ec7a0fc4553" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fileRead 0x0001 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="vfs_8h-source.html#l00046">46</a> of file <a class="el" href="vfs_8h-source.html">vfs.h</a>.
<p>
Referenced by <a class="el" href="file_8c-source.html#l00274">fopen()</a>, and <a class="el" href="ubixfs_8c-source.html#l00046">openFileUbixFS()</a>.
</div>
</div><p>
<a class="anchor" name="4898b5a1a1daebda9d11b4afde062e5c"></a><!-- doxytag: member="vfs.h::fileWrite" ref="4898b5a1a1daebda9d11b4afde062e5c" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define fileWrite 0x0002 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="vfs_8h-source.html#l00047">47</a> of file <a class="el" href="vfs_8h-source.html">vfs.h</a>.
<p>
Referenced by <a class="el" href="file_8c-source.html#l00274">fopen()</a>, and <a class="el" href="ubixfs_8c-source.html#l00046">openFileUbixFS()</a>.
</div>
</div><p>
<a class="anchor" name="7345172cf7a0188e85f54fca04e800fb"></a><!-- doxytag: member="vfs.h::maxFd" ref="7345172cf7a0188e85f54fca04e800fb" args="" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">#define maxFd 32 </td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="vfs_8h-source.html#l00039">39</a> of file <a class="el" href="vfs_8h-source.html">vfs.h</a>.
</div>
</div><p>
<hr><h2>Function Documentation</h2>
<a class="anchor" name="025f2b08eb8930f06292f32f960ad0c7"></a><!-- doxytag: member="vfs.h::vfs_findFS" ref="025f2b08eb8930f06292f32f960ad0c7" args="(int)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">struct <a class="el" href="structfileSystem.html">fileSystem</a>* vfs_findFS </td>
<td>(</td>
<td class="paramtype">int </td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
</div>
</div><p>
<a class="anchor" name="ca585ca14c08d6c1a07e1b886fc9749a"></a><!-- doxytag: member="vfs.h::vfs_init" ref="ca585ca14c08d6c1a07e1b886fc9749a" args="()" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vfs_init </td>
<td>(</td>
<td class="paramname"> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
<p>
Definition at line <a class="el" href="vfs_8c-source.html#l00048">48</a> of file <a class="el" href="vfs_8c-source.html">vfs.c</a>.
<p>
References <a class="el" href="vitals_8h-source.html#l00045">vitalsStruct::fileSystems</a>, <a class="el" href="kprintf_8c-source.html#l00038">kprintf()</a>, and <a class="el" href="timer_8S-source.html#l00035">systemVitals</a>.
<p>
Here is the call graph for this function:<p><center><img src="vfs_8h_ca585ca14c08d6c1a07e1b886fc9749a_cgraph.png" border="0" usemap="#vfs_8h_ca585ca14c08d6c1a07e1b886fc9749a_cgraph_map" alt=""></center>
<map name="vfs_8h_ca585ca14c08d6c1a07e1b886fc9749a_cgraph_map">
<area href="kprint_8h.html#b2761bdf0cca73ad0fb5880895210cd8" shape="rect" coords="125,5,192,32" alt="">
</map>
</div>
</div><p>
<a class="anchor" name="8652b1ccbcf7d2a872c5781640f7d59a"></a><!-- doxytag: member="vfs.h::vfsRegisterFS" ref="8652b1ccbcf7d2a872c5781640f7d59a" args="(struct fileSystem)" -->
<div class="memitem">
<div class="memproto">
<table class="memname">
<tr>
<td class="memname">int vfsRegisterFS </td>
<td>(</td>
<td class="paramtype">struct <a class="el" href="structfileSystem.html">fileSystem</a> </td>
<td class="paramname"> <em>newFS</em> </td>
<td> ) </td>
<td width="100%"></td>
</tr>
</table>
</div>
<div class="memdoc">
<p>
register a file system
<p>
This registers a new filesystem into the vfs which is referenced when trying to mount a device<p>
<dl compact><dt><b>Parameters:</b></dt><dd>
<table border="0" cellspacing="2" cellpadding="0">
<tr><td valign="top"></td><td valign="top"><em>newFS</em> </td><td>pointer to <a class="el" href="structfileSystem.html">fileSystem</a> structure </td></tr>
</table>
</dl>
<p>
Definition at line <a class="el" href="vfs_8c-source.html#l00081">81</a> of file <a class="el" href="vfs_8c-source.html">vfs.c</a>.
<p>
References <a class="el" href="vitals_8h-source.html#l00045">vitalsStruct::fileSystems</a>, <a class="el" href="kmalloc_8c-source.html#l00247">kmalloc()</a>, <a class="el" href="kprintf_8c-source.html#l00038">kprintf()</a>, <a class="el" href="lib_2string_8h.html#e33b18edb618c656b9b795b9fce2316c">memcpy()</a>, <a class="el" href="vfs_8h-source.html#l00058">fileSystem::next</a>, <a class="el" href="types_8h-source.html#l00036">NULL</a>, <a class="el" href="vfs_8h-source.html#l00057">fileSystem::prev</a>, <a class="el" href="timer_8S-source.html#l00035">systemVitals</a>, <a class="el" href="vfs_8c-source.html#l00059">vfsFindFS()</a>, <a class="el" href="vfs_8h-source.html#l00067">fileSystem::vfsType</a>, and <a class="el" href="ap-boot_8S-source.html#l00006">x1</a>.
<p>
Referenced by <a class="el" href="devfs_8c-source.html#l00215">devfs_init()</a>, <a class="el" href="ubixfs_8c-source.html#l00456">ubixfs_init()</a>, and <a class="el" href="ufs_8c-source.html#l00314">ufs_init()</a>.
<p>
Here is the call graph for this function:<p><center><img src="vfs_8h_8652b1ccbcf7d2a872c5781640f7d59a_cgraph.png" border="0" usemap="#vfs_8h_8652b1ccbcf7d2a872c5781640f7d59a_cgraph_map" alt=""></center>
<map name="vfs_8h_8652b1ccbcf7d2a872c5781640f7d59a_cgraph_map">
<area href="kmalloc_8h.html#150eab2ac4ce4553e21ca10e7f441762" shape="rect" coords="174,284,248,311" alt="">
<area href="kprint_8h.html#b2761bdf0cca73ad0fb5880895210cd8" shape="rect" coords="724,360,791,387" alt="">
<area href="lib_2string_8h.html#e33b18edb618c656b9b795b9fce2316c" shape="rect" coords="171,461,251,488" alt="">
<area href="vfs_8c.html#c49aa10a62b250834a055476c849b7b3" shape="rect" coords="168,512,254,539" alt="">
<area href="kmalloc_8c.html#f6c4ea5cb961c72548d92ff65d7e33a4" shape="rect" coords="303,183,423,209" alt="">
<area href="spinlock_8h.html#2cd9a4502680fb8e7f0fe6b029e558b1" shape="rect" coords="718,208,798,235" alt="">
<area href="spinlock_8h.html#dd996cbbb3b9826dd9c8cf02b66a4c65" shape="rect" coords="710,56,806,83" alt="">
<area href="kmalloc_8c.html#eb1c3f1ef8eb9063c2e5c4af488dd2d0" shape="rect" coords="302,309,424,336" alt="">
<area href="kpanic_8h.html#db9a182aa071791a306163d50d653deb" shape="rect" coords="534,309,600,336" alt="">
<area href="lib_2string_8h.html#ce4b911463887af5e748326323e99a23" shape="rect" coords="528,157,606,184" alt="">
<area href="paging_8h.html#541f0b43826a40b9e978f5479080bb0e" shape="rect" coords="472,107,662,133" alt="">
</map>
</div>
</div><p>
<hr size="1"><address style="align: right;"><small>Generated on Fri Dec 15 11:22:25 2006 for UbixOS V2 by
<a href="http://www.doxygen.org/index.html">
<img src="doxygen.png" alt="doxygen" align="middle" border="0"></a> 1.4.7 </small></address>
</body>
</html>
