Kernel - Doxygen fixes

[tpg/acess2.git] / Kernel / include / vfs.h

diff --git a/Kernel/include/vfs.h b/Kernel/include/vfs.h
index cded047..91771c8 100644 (file)
--- a/Kernel/include/vfs.h
+++ b/Kernel/include/vfs.h
@@ -67,6 +67,15 @@ typedef struct sVFS_SelectList       tVFS_SelectList;
  * inherit the GID of the parent.
  */
 #define VFS_FFLAG_SETGID       0x10
+
+/**
+ * \brief "Don't do Write-Back" Flag
+ *
+ * Stops the VFS from calling tVFS_Node.Write on dirty pages when a region
+ * is unmapped. Nice for read-only files and memory-only files (or 
+ * pseudo-readonly filesystems)
+ */
+#define VFS_FFLAG_NOWRITEBACK
 /**
  * \}
  */
@@ -85,7 +94,7 @@ typedef struct sVFS_Node
         *        corresponds to.
         * \{
         */
-       Uint64  Inode;  //!< Inode ID (Essentially another ImplInt)
+       Uint64  Inode;  //!< Inode ID - Must identify the node uniquely if tVFS_Driver.GetNodeFromINode is non-NULL
        Uint    ImplInt;        //!< Implementation Usable Integer
        void    *ImplPtr;       //!< Implementation Usable Pointer
        /**
@@ -146,6 +155,7 @@ typedef struct sVFS_Node
        
        /**
         * \name VFS_Select() fields
+        * \note Used by the VFS internals, drivers should use VFS_Mark*
         * \{
         */
         int    DataAvaliable;
@@ -157,6 +167,15 @@ typedef struct sVFS_Node
        /**
         * \}
         */
+
+       /**
+        * \name VFS_MMap() fields
+        * \{
+        */
+       void    *MMapInfo;
+       /**
+        * \}
+        */
        
        /**
         * \name Common Functions
@@ -215,6 +234,17 @@ typedef struct sVFS_Node
         * \return Number of bytes read
         */
        Uint64  (*Write)(struct sVFS_Node *Node, Uint64 Offset, Uint64 Length, void *Buffer);
+
+       /**
+        * \brief Map a region of a file into memory
+        * \param Node  Pointer to this node
+        * \param Offset        Start of the region (page aligned)
+        * \param Length        Length of the region (page aligned)
+        * \param Dest  Location to which to map
+        * \return Boolean Failure
+        * \note If NULL, the VFS implements it using .Read
+        */
+        int    (*MMap)(struct sVFS_Node *Node, Uint64 Offset, int Length, void *Dest);
        
        /**
         * \}
@@ -283,16 +313,30 @@ typedef struct sVFS_Node
  */
 typedef struct sVFS_Driver
 {
-       //! \brief Unique Identifier for this filesystem type
+       /**
+        * \brief Unique Identifier for this filesystem type
+        */
        const char      *Name;
-       //! \brief Flags applying to this driver
+       /**
+        * \brief Flags applying to this driver
+        */
        Uint    Flags;
        
-       //! \brief Callback to mount a device
+       /**
+        * \brief Callback to mount a device
+        */
        tVFS_Node       *(*InitDevice)(const char *Device, const char **Options);
-       //! \brief Callback to unmount a device
+       /**
+        * \brief Callback to unmount a device
+        */
        void    (*Unmount)(tVFS_Node *Node);
-       //! \brief Used internally (next driver in the chain)
+       /**
+        * \brief Retrieve a VFS node from an inode
+        */
+       tVFS_Node       *(*GetNodeFromINode)(tVFS_Node *RootNode, Uint64 InodeValue);
+       /**
+        * \brief Used internally (next driver in the chain)
+        */
        struct sVFS_Driver      *Next;
 } tVFS_Driver;
 
@@ -326,7 +370,6 @@ extern tVFS_ACL     gVFS_ACL_EveryoneRO;    //!< Everyone Read only
  */
 extern int     VFS_AddDriver(tVFS_Driver *Info);
 /**
- * \fn tVFS_Driver *VFS_GetFSByName(char *Name)
  * \brief Get the information structure of a driver given its name
  * \param Name Name of filesystem driver to find
  */
@@ -356,13 +399,15 @@ extern void       VFS_CleanupNode(tVFS_Node *Node);
 extern tVFS_ACL        *VFS_UnixToAcessACL(Uint Mode, Uint Owner, Uint Group);
 
 /**
+ * \brief Flags fro \a TypeFlag of VFS_SelectNode
+ * \{
+ */
+#define VFS_SELECT_READ        0x01
+#define VFS_SELECT_WRITE       0x02
+#define VFS_SELECT_ERROR       0x04
+/**
+ * \}
  */
-enum eVFS_SelectTypes
-{
-       VFS_SELECT_READ,
-       VFS_SELECT_WRITE,
-       VFS_SELECT_ERROR
-};
 
 /**
  * \brief Wait for an event on a node
@@ -372,13 +417,19 @@ enum eVFS_SelectTypes
  * \param Name Name to show in debug output
  * \return Number of nodes that actioned (0 or 1)
  */
-extern int     VFS_SelectNode(tVFS_Node *Node, enum eVFS_SelectTypes Type, tTime *Timeout, const char *Name);
+extern int     VFS_SelectNode(tVFS_Node *Node, int Type, tTime *Timeout, const char *Name);
 
 /**
  * \brief Change the full flag on a node
  */
 extern int     VFS_MarkFull(tVFS_Node *Node, BOOL IsBufferFull);
+/**
+ * \brief Alter the space avaliable flag on a node
+ */
 extern int     VFS_MarkAvaliable(tVFS_Node *Node, BOOL IsDataAvaliable);
+/**
+ * \brief Alter the error flags on a node
+ */
 extern int     VFS_MarkError(tVFS_Node *Node, BOOL IsErrorState);
 
 // --- Node Cache --