X-Git-Url: https://git.ucc.asn.au/?a=blobdiff_plain;f=Kernel%2Finclude%2Ffs_devfs.h;h=54f4280d19245b761fbb1fbb664a32441f22e0ab;hb=48c3c3735e3445cb2f182a12be4b24507b4a995a;hp=4b29cf1be15a6d29eabeb24582b9f2262e1840ed;hpb=8bc40333b1401d7616b225945fee53d972c2f418;p=tpg%2Facess2.git diff --git a/Kernel/include/fs_devfs.h b/Kernel/include/fs_devfs.h index 4b29cf1b..54f4280d 100644 --- a/Kernel/include/fs_devfs.h +++ b/Kernel/include/fs_devfs.h @@ -1,20 +1,30 @@ -/* - * Acess 2 - * Device Filesystem (DevFS) - * - vfs/fs/devfs.c +/** + * \file fs_devfs.h + * \brief Acess Device Filesystem interface + * \author John Hodge (thePowersGang) */ #ifndef _FS_DEVFS_H #define _FS_DEVFS_H #include // === TYPES === -typedef struct sDevFS_Driver { - struct sDevFS_Driver *Next; - char *Name; - tVFS_Node RootNode; +/** + * \brief DevFS driver definition + */ +typedef struct sDevFS_Driver +{ + struct sDevFS_Driver *Next; //!< Set to NULL by drivers (used internally) + char *Name; //!< Name of the driver file/folder (must be unique) + tVFS_Node RootNode; //!< Root node of driver } tDevFS_Driver; // === FUNCTIONS === +/** + * \fn int DevFS_AddDevice(tDevFS_Driver *Dev) + * \brief Registers a device in the Device filesystem + * \param Dev Pointer to a persistant structure that represents the driver + * \return Boolean success + */ extern int DevFS_AddDevice(tDevFS_Driver *Dev); #endif