efs.h

ucfsv2.36 trail,包含VC工作空间

/*
**********************************************************************
*                          Micrium, Inc.
*                      949 Crestview Circle
*                     Weston,  FL 33327-1848
*
*                            uC/FS
*
*             (c) Copyright 2001 - 2007, Micrium, Inc.
*                      All rights reserved.
*
***********************************************************************


**** 礐/FS file system for embedded applications ****
礐/FS is protected by international copyright laws. Knowledge of the
source code may not be used to write a similar product. This file may
only be used in accordance with a license and should not be re-
distributed in any way. We appreciate your understanding and fairness.
----------------------------------------------------------------------
File        : EFS.h
Purpose     : EFS File System Layer header
---------------------------END-OF-HEADER------------------------------
*/

#ifndef _EFS_H_
#define _EFS_H_

#include "FS_Int.h"

#if defined(__cplusplus)
extern "C" {     /* Make sure we have C-declarations in C++ programs */
#endif

/*********************************************************************
*
*       EFS_Read
*/
U32  FS_EFS_Read(FS_FILE *pFile, void *pData, U32 NumBytesReq);

/*********************************************************************
*
*       EFS_Write
*/
U32  FS_EFS_Write  (FS_FILE   * pFile, const void *pData, U32 NumBytes);
void FS_EFS_Close  (FS_FILE   * pFile);
void FS_EFS_Unmount(FS_VOLUME * pVolume);


/*********************************************************************
*
*       EFS_Open
*/
char FS_EFS_Open   (const char * pFileName, FS_FILE * pFile, char DoDel, char DoOpen, char DoCreate);

/*********************************************************************
*
*       EFS_Misc
*/
int  FS_EFS_CheckInfoSector     (FS_VOLUME * pVolume);
int  FS_EFS_CreateJournalFile   (FS_VOLUME * pVolume, U32 NumClusters, U32 * pFirstSector, U32 * pNumSectors);
int  FS_EFS_OpenJournalFile     (FS_VOLUME * pVolume);
U32  FS_EFS_GetIndexOfLastSector(FS_VOLUME * pVolume);


/*********************************************************************
*
*       EFS_Format
*/
int  FS_EFS_Format        (FS_VOLUME * pVolume, FS_FORMAT_INFO  * pFormatInfo);
int  FS_EFS_GetDiskInfo   (FS_VOLUME * pVolume, FS_DISK_INFO    * pDiskInfo);
U32  FS_EFS_GetDiskSpace  (FS_VOLUME * pVolume);
int  FS_EFS_GetVolumeLabel(FS_VOLUME * pVolume, char * pVolumeLabel, unsigned VolumeLabelSize);
int  FS_EFS_SetVolumeLabel(FS_VOLUME * pVolume, const char * pVolumeLabel);


/*********************************************************************
*
*       EFS_Move
*/
int   FS_EFS_Move(const char * sOldName, const char * sNewName, FS_VOLUME * pVolume);


/*********************************************************************
*
*       FS_EFS_DirEntry
*
*/
char  FS_EFS_SetDirEntryInfo(FS_VOLUME * pVolume, const char * sName, const void * p, int Mask);
char  FS_EFS_GetDirEntryInfo(FS_VOLUME * pVolume, const char * sName,       void * p, int Mask);

/*********************************************************************
*
*       EFS_Rename
*/
int   FS_EFS_Rename(const char * sOldName, const char * sNewName, FS_VOLUME * pVolume);

/*********************************************************************
*
*       EFS_Dir
*/
int   FS_EFS_OpenDir  (const char *pDirName, FS__DIR *pDir);
int   FS_EFS_CloseDir (FS__DIR *pDir);
int   FS_EFS_ReadDir  (FS__DIR *pDir, FS_DIRENTRY_INFO * pDirEntryInfo);
int   FS_EFS_RemoveDir(FS_VOLUME * pVolume, const char *pDirName);
int   FS_EFS_CreateDir(FS_VOLUME * pVolume, const char *pDirName);

/*********************************************************************
*
*       EFS_SetEndOfFile
*
*/
int FS_EFS_SetEndOfFile(FS_FILE * pFile);

/*********************************************************************
*
*       FS_EFS_CheckDisk
*
*/
int FS_EFS__CheckDisk(FS_VOLUME * pVolume, FS_DISK_INFO * pDiskInfo, void * pBuffer, U32 BufferSize, int MaxRecursionLevel, FS_QUERY_F_TYPE * pfOnError);

#if defined(__cplusplus)
}                /* Make sure we have C-declarations in C++ programs */
#endif

#endif  /* _EFS_H_ */

/*************************** End of file ****************************/