/* dosFsFatP.h - DOS file system FAT module header file*/
 
/* Copyright 1998-2001, 2004, 2009-2010 Wind River Systems, Inc. */
 
/* 
modification history 
-------------------- 
01i,29apr10,pad  Moved extern C statement after include statements.
01h,05aug09,yjl  adapt for 64bit 
01g,21mar04,act  changes to support clean bit
01f,20sep01,jkf  SPR#69031, common code for both AE & 5.x.
01e,29feb00,jkf  T3 changes
01d,31jul99,jkf  T2 merge, tidiness & spelling.
01c,23sep98,vld  field <syncEnabled> added to structure MS_FAT_DESC
01b,20sep98,mjc  descriptor structure name changed from DOS_FAT16_DESC
		 to MS_FAT_DESC
01a,23feb98,mjc  written, preliminary 
*/

#ifndef __INCdosFath
#define __INCdosFath

#include "private/dosFsLibP.h"

#ifdef __cplusplus
extern "C" {
#endif


/* defines */

/* conversions of sector <-> cluster numbers */

#define CLUST_TO_SEC( pVolDesc, clustNum )                                  \
                ( ((clustNum) - DOS_MIN_CLUST) * (pVolDesc)->secPerClust +  \
                  (pVolDesc)->dataStartSec )

#define SEC_TO_CLUST( pVolDesc, secNum )                                    \
                                ( ((secNum) -  (pVolDesc)->dataStartSec) /  \
                                  (pVolDesc)->secPerClust + DOS_MIN_CLUST )

/* typedefs */

typedef enum fat_rw	{FAT_READ, FAT_WRITE_GROUP, FAT_WRITE_CLUST} FAT_RW;

/*
 * Should change dosFatDesc to a pointer, and move its activeCopyNum
 * member here, then we could point at a single statically-allocated
 * FatDesc for each kind of FAT (12, 16, 32).  Then should probably
 * move the bad/eof values, too.
 */
typedef struct
    {
    DOS_FAT_DESC	dosFatDesc;	    /* generic DOS FAT descriptor */

    SEM_ID		    allocSem;	    /* semaphore to guard allocations */
    uint32_t		fatStartSec;	/* FAT starting sector number */
    uint32_t		nFatEnts;	    /* number of entries in FAT */
    uint32_t		fatEntFreeCnt;	/* count of free clusters */
    uint32_t		dos_fat_avail;	/* cluster is available: 0x0000 */
    uint32_t        dos_fat_reserv;	/* reserved cluster marker: 0xff(f)0 */
    uint32_t		dos_fat_bad;	/* bad cluster marker: 0xff(f)7 */
    uint32_t		dos_fat_eof;	/* end-of-file marker: 0xff(f)f */
    uint32_t		fatGroupSize;	/* size clusters */
    uint32_t		groupAllocStart;/* initialize to DOS_MIN_CLUST */
    uint32_t		clustAllocStart;/* initialize to DOS_MIN_CLUST */
    BOOL		    syncEnabled;	/* FAT copies mirroring enabling */
    } MS_FAT_DESC;

typedef MS_FAT_DESC * MS_FAT_DESC_ID;

/* defines */

#ifdef __cplusplus
}
#endif

#endif /* __INCdosFath */