efs_intern.h

此为整套uC/FS程序

/*
**********************************************************************
*                          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_Intern.h
Purpose     : Internal EFS File System Layer header
---------------------------END-OF-HEADER------------------------------
*/

#ifndef _EFS_INTERN_H_
#define _EFS_INTERN_H_

#include "FS_Int.h"
#include "EFS.h"

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


/*********************************************************************
*
*       #define constants
*
**********************************************************************
*/



/*********************************************************************
*
*       #define constants
*
**********************************************************************
*/

#define EFS_VERSION   0x300
#define EFS_SIGNATURE 0x00534645      /* "EFS" */

#define EFS_MAX_DIR_ENTRY_SIZE 255
#define SIZEOF_EFS_TABLE_ENTRY  32
#define EFS_FIRST_CLUSTER        2

/*********************************************************************
*
*       EFS_SECTOR_...
*
*/
#define EFS_SECTOR_INFO        0    /* Info sector */
#define EFS_SECTOR_STATUS      1    /* Status sector */
#define EFS_SECTOR_ALLOC_TABLE 2    /* Start sector of allocation map */

/*********************************************************************
*
*       DIR_ENTRY_OFF_...
*
*  Purpose
*    Defines the position of the individual elements in a directory entry
*/
#define DIR_ENTRY_OFF_OFFNEXT        0x00
#define DIR_ENTRY_OFF_ISVALID        0x01
#define DIR_ENTRY_OFF_ATTRIB         0x02
#define DIR_ENTRY_OFF_NAMELEN        0x03
#define DIR_ENTRY_OFF_FIRSTCLUSTER   0x04
#define DIR_ENTRY_OFF_SIZELO         0x08
#define DIR_ENTRY_OFF_SIZEHI         0x0C
#define DIR_ENTRY_OFF_TIMESTAMP      0x10
#define DIR_ENTRY_OFF_NAME           0x14

#define DIR_ENTRY_FIXED_SIZE         0x14       /* For total size of entry, add len of file name */


/*********************************************************************
*
*       INFO_OFF_...
*
*  Purpose
*    Defines the position of the individual elements in the info sector
*/
#define INFO_OFF_SIGNATURE             0x0
#define INFO_OFF_VERSION               0x4
#define INFO_OFF_LD_BPS                0x6          /* ld Bytes per sector */
#define INFO_OFF_NUM_SECTORS           0x8
#define INFO_OFF_NUM_CLUSTERS          0xc
#define INFO_OFF_FIRST_DATA_SECTOR     0x10
#define INFO_OFF_LD_SPC                0x14         /* ld Sectors per cluster */

/*********************************************************************
*
*       DIR_...
*
*/
#define DIR_MAX_SIZE                 0x7FFFFFFF



/*********************************************************************
*
*       defines non configurable
*
**********************************************************************
*/
#define FS_EFS_DENTRY_SIZE       0x20

#define FS_EFS_ATTR_READ_ONLY    FS_ATTR_READ_ONLY
#define FS_EFS_ATTR_HIDDEN       FS_ATTR_HIDDEN
#define FS_EFS_ATTR_SYSTEM       FS_ATTR_SYSTEM
#define FS_EFS_ATTR_ARCHIVE      FS_ATTR_ARCHIVE
#define FS_EFS_ATTR_DIRECTORY    FS_ATTR_DIRECTORY

#define FS_EFS_ATTR_MASK        (FS_EFS_ATTR_READ_ONLY | FS_EFS_ATTR_HIDDEN | FS_EFS_ATTR_SYSTEM | FS_EFS_ATTR_ARCHIVE | FS_EFS_ATTR_DIRECTORY)

#define FS_EFS_MAX_DIRNAME      255

#define INVALID_NUM_FREE_CLUSTERS_VALUE   0xFFFFFFFF

/*********************************************************************
*
*             Global function prototypes
*
**********************************************************************
*/

/*********************************************************************
*
*       EFS_Misc
*/
U32          FS_EFS_ClusterId2SectorNo(FS_EFS_INFO * pEFSInfo, U32 ClusterId);
U32          FS_EFS_FindFreeCluster   (FS_VOLUME * pVolume, FS_SB * pSB, U32 FirstCluster);
void         FS_EFS_LinkCluster       (FS_VOLUME * pVolume, FS_SB * pSB, U32 LastCluster, U32 NewCluster);
char         FS_EFS_MarkClusterEOC    (FS_VOLUME * pVolume, FS_SB * pSB, U32 Cluster);
U32          FS_EFS_WalkCluster       (FS_VOLUME * pVolume, FS_SB * pSB, U32 StartCluster, U32 NumClusters);
U32          FS_EFS_WalkClusterEx     (FS_VOLUME * pVolume, FS_SB * pSB, U32 Cluster, U32 * pNumClusters);
U32          FS_EFS_AllocCluster      (FS_VOLUME * pVolume, FS_SB * pSB, U32 LastCluster);
U32          FS_EFS_ReadEFSEntry      (FS_VOLUME * pVolume, FS_SB * pSB, U32 ClusterId);
U32          FS_EFS_FindLastCluster   (FS_VOLUME * pVolume, FS_SB * pSB, U32 ClusterId, U32 * pNumClusters);
U32          FS_EFS_FreeClusterChain  (FS_VOLUME * pVolume, FS_SB * pSB, U32 ClusterId, U32 NumClusters);

U16          FS_EFS_GetNumAdjClustersInChain(FS_VOLUME * pVolume, FS_SB * pSB, U32 CurCluster);
int          FS_EFS_GotoCluster          (FS_FILE * pFile, FS_SB * pSBEfs);

int          FS_EFS_GotoClusterAllocIfReq(FS_FILE *pFile, FS_SB * pSBEfs);

U32          FS_EFS_FindDir              (FS_VOLUME * pVolume,  char  * pDirName, U32 DirStart, U32 DirSize);
char         FS_EFS_FindPath             (FS_VOLUME * pVolume,  FS_SB * pSB, const char *pFullName, const char ** ppFileName, FS_FILE *pDirFile);
char         FS_EFS_FindEmptyDirEntry    (FS_FILE   * pDirFile, FS_SB * pSB,            unsigned * pEntryLen);
char         FS_EFS_DeleteFileOrDir      (FS_FILE   * pDirFile, FS_SB * pSB, U8 IsFile);
char         FS_EFS_FindDirEntry         (FS_FILE   * pDirFile, FS_SB * pSB, const char *pEntryName, int NameLen);
char         FS_EFS_FindEmptyDirEntry    (FS_FILE   * pDirFile, FS_SB * pSB, unsigned * pEntryLen);
void         FS_EFS_MarkDirEntryAsInvalid(FS_FILE   * pDirFile, FS_SB * pSB);
U8           FS_EFS_ReadDirEntry         (FS_FILE   * pDirFile, FS_SB * pSB, U8 * pBuffer);
char         FS_EFS_WriteDirEntry        (FS_FILE   * pDirFile, FS_SB * pSB, const char * pFileName, unsigned EntryLen, U32 TimeDate, U32 Size, U32 ClusterId, U8 Attrib);
char         FS_EFS_OpenDirFile          (FS_FILE   * pDirFile, FS_VOLUME * pVolume,   U32 DirStart);
void         FS__EFS_GetDirEntryInfo     (FS_FILE   * pDirFile, FS_SB * pSB, U32 * pFirstCluster, U32 * pFileSize, U8 * pAttributes, U32 * pTimeStamp);


U32 FS_EFS_ReadData    (FS_FILE * pFile,       U8 * pData, U32 NumBytesReq,    FS_SB * pSB, U8 Type);
U32 FS_EFS_WriteDataEx (FS_FILE * pFile, const U8 * pData, U32 NumBytes2Write, FS_SB * pSB, char * pDirUpdateRequired, U8 Type);
char FS_EFS_CreateDirEntry(FS_FILE * pDirFile, FS_SB * pSB, const char * pFileName, U32 TimeStamp, U32 Size, U32 ClusterId, U8 Attrib);

int FS_EFS_AllocClusterBlock(FS_VOLUME * pVolume, U32 FirstCluster, U32 NumClusters, FS_SB * pSB);

/*********************************************************************
*
*       Directory handling
*/
int          FS_EFS_CreateDirEx(FS_VOLUME * pVolume, const char *pDirName, U32 DirStart, FS_SB * pSB);

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

#endif  /* _EFS_INTERN_H_ */

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