Kernel/include/fs_sysfs.h

   1 /*
   2  * Acess2
   3  * - SysFS Export Header
   4  */
   5 /**
   6  * \file fs_sysfs.h
   7  * \brief ProcDev/SysFS Interface
   8  * \author John Hodge (thePowersGang)
   9  *
  10  *
  11  */
  12 #ifndef _FS_SYSFS_H_
  13 #define _FS_SYSFS_H_
  14
  15 /**
  16  * \brief Registers a file in the SysFS tree
  17  * \param Path  Path relative to the SysFS root (no .. or .)
  18  * \param Data  File buffer address
  19  * \param Length        Length of the file buffer
  20  * \return An ID number to refer to the file, or -1 on error
  21  * \note \a Data must be maintained until ::SysFS_UpdateFile is called
  22  *       with a different buffer, or ::SysFS_RemoveFile is called.
  23  */
  24 extern int      SysFS_RegisterFile(const char *Path, const char *Data, int Length);
  25
  26 /**
  27  * \brief Updates the size/pointer associated with a SysFD file
  28  * \param ID    Number returned by ::SysFS_RegisterFile
  29  * \param Data  New buffer address
  30  * \param Length        New length of the file
  31  * \return Boolean Success
  32  */
  33 extern int      SysFS_UpdateFile(int ID, const char *Data, int Length);
  34
  35 /**
  36  * \brief Removes a file from the SysFS tree
  37  * \param ID    Number returned by ::SysFS_RegisterFile
  38  */
  39 extern int      SysFS_RemoveFile(int ID);
  40
  41 #endif