sl@0: // Copyright (c) 1996-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // f32\sfat32\inc\sl_std.inl
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef SL_STD_INL
sl@0: #define SL_STD_INL
sl@0: 
sl@0: 
sl@0: 
sl@0: //---------------------------------------------------------------------------------------------------------------------------------
sl@0: // class TEntryPos
sl@0: TUint32 TEntryPos::Cluster() const 
sl@0:     {
sl@0:     return (TUint32) iCluster;
sl@0:     }
sl@0: 
sl@0: TUint32 TEntryPos::Pos() const 
sl@0:     {
sl@0:     return (TUint32) iPos;
sl@0:     }
sl@0: 
sl@0: TBool TEntryPos::operator==(const TEntryPos& aRhs) const
sl@0:     {
sl@0:     ASSERT(this != &aRhs);
sl@0:     return (iCluster == aRhs.iCluster && iPos == aRhs.iPos);
sl@0:     }
sl@0: 
sl@0: 
sl@0: //---------------------------------------------------------------------------------------------------------------------------------
sl@0: // class CFatMountCB
sl@0: 
sl@0: inline TInt CFatMountCB::RootDirectorySector() const
sl@0:     {return iVolParam.RootDirectorySector();}
sl@0: 
sl@0: inline TUint CFatMountCB::RootDirEnd() const
sl@0:     {return iVolParam.RootDirEnd();}
sl@0: 
sl@0: inline TUint32 CFatMountCB::RootClusterNum() const
sl@0:     {return iVolParam.RootClusterNum(); }        
sl@0: 
sl@0: 
sl@0: inline TInt CFatMountCB::StartCluster(const TFatDirEntry & anEntry) const
sl@0: 	{
sl@0: 	if(Is32BitFat())	
sl@0: 		return anEntry.StartCluster();
sl@0: 	else
sl@0: 		return 0xFFFF&anEntry.StartCluster();
sl@0: 	}
sl@0: 
sl@0: /**
sl@0: returns true for root dir on Fat12/16 (fixed root dir versions of Fat) false on fat32 
sl@0: this function is used to handle special cases for reading/writing the root directory on FAT via the use of cluster zero.
sl@0: 
sl@0: @param aEntry position on volume being queried
sl@0: @return Whether Root dir position or not
sl@0: */
sl@0: TBool CFatMountCB::IsRootDir(const TEntryPos &aEntry) const
sl@0: 	{
sl@0: 	if(Is32BitFat())
sl@0: 		return EFalse;
sl@0: 	else
sl@0: 		return((aEntry.iCluster==0) ? (TBool)ETrue : (TBool)EFalse);	
sl@0: 	}
sl@0: /**
sl@0: Indicates the root directory cluster, For Fat12/16 root is always indicated by cluster number zero, on Fat32 the is a root cluster number
sl@0: @return The root cluster indicator
sl@0: */
sl@0: TInt CFatMountCB::RootIndicator() const
sl@0: 	{
sl@0: 	if(Is32BitFat())
sl@0:         return iVolParam.RootClusterNum();
sl@0: 	else
sl@0: 		return 0;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /** @return Log2 of cluster size on volume */
sl@0: TInt CFatMountCB::ClusterSizeLog2() const
sl@0:     {return(iVolParam.ClusterSizeLog2());}
sl@0: 
sl@0: /** @return Log2 of media sector size  */
sl@0: TInt CFatMountCB::SectorSizeLog2() const
sl@0:     {return(iVolParam.SectorSizeLog2());}
sl@0: 
sl@0: /** @return sector per cluster */
sl@0: TInt CFatMountCB::SectorsPerCluster() const
sl@0:     {return(1<<(iVolParam.ClusterSizeLog2()-iVolParam.SectorSizeLog2()));}
sl@0: 
sl@0: /** @return the base position of a cluster */
sl@0: TInt CFatMountCB::ClusterBasePosition() const
sl@0: 	{return(iFirstFreeByte);}
sl@0: 
sl@0: /** @return the offset into a cluster of a byte address */
sl@0: TInt CFatMountCB::ClusterRelativePos(TInt aPos) const
sl@0: 	{return(aPos&((1<<ClusterSizeLog2())-1));}
sl@0: 
sl@0: /**
sl@0: Calculates the maximum number of clusters
sl@0: @return  maximum number of clusters
sl@0: */
sl@0: TUint32 CFatMountCB::MaxClusterNumber() const
sl@0:     {return(TotalSectors()>>(ClusterSizeLog2()-SectorSizeLog2()));}
sl@0: 
sl@0: /** @return the the total sectors on volume */
sl@0: TInt CFatMountCB::TotalSectors() const
sl@0:     {return iVolParam.TotalSectors();}
sl@0: 
sl@0: /** @return total size of a Fat in bytes */
sl@0: TInt CFatMountCB::FatSizeInBytes() const
sl@0:     {return iVolParam.FatSizeInBytes();}
sl@0: 
sl@0: /** @return first sector of the Fat */
sl@0: TUint32 CFatMountCB::FirstFatSector() const
sl@0:     {return iVolParam.FirstFatSector();}
sl@0: 
sl@0: /** @return the byte offset of the Fat */
sl@0: TInt CFatMountCB::StartOfFatInBytes() const
sl@0: 	{return(FirstFatSector()<<SectorSizeLog2());}
sl@0: 
sl@0: /** @return Number of Fats used by the volume */
sl@0: TInt CFatMountCB::NumberOfFats() const
sl@0:     {return iVolParam.NumberOfFats();}
sl@0: 
sl@0: 
sl@0: /** @return refrence to the fat table owned by the mount */
sl@0: CFatTable& CFatMountCB::FAT() const
sl@0: 	{return(*iFatTable);}
sl@0: /**
sl@0:     @return refrence to the file system object that has produced this CFatMountCB
sl@0: */
sl@0: CFatFileSystem& CFatMountCB::FatFileSystem() const
sl@0: 	{
sl@0:     return (CFatFileSystem&)(*FileSystem()); //-- CMountCB::FileSystem() provides correct answer
sl@0:     }
sl@0: 
sl@0: 
sl@0: /** @return  refrence to a raw disk object owned by the mount */
sl@0: CRawDisk& CFatMountCB::RawDisk() const
sl@0: 	{return(*iRawDisk);}
sl@0: 
sl@0: /**
sl@0: @return ETrue if aCluster value is bad cluster marker defined in FAT specification
sl@0: */
sl@0: TBool CFatMountCB::IsBadCluster(TInt aCluster) const
sl@0: 	{return Is32BitFat() ? aCluster==0xFFFFFF7 : Is16BitFat() ? aCluster==0xFFF7 : aCluster==0xFF7;}
sl@0: 
sl@0: /**
sl@0: Returns whether the current mount is running as rugged Fat or not, this is held in the file system object
sl@0: @return Is rugged fat flag
sl@0: */
sl@0: TBool CFatMountCB::IsRuggedFSys() const
sl@0: 	{return Drive().IsRugged();}
sl@0: 
sl@0: /**
sl@0: Sets the rugged flag in the file system object
sl@0: @param Flag to set or clear the rugged flag
sl@0: */
sl@0: void CFatMountCB::SetRuggedFSys(TBool aVal)
sl@0: 	{Drive().SetRugged(aVal);}
sl@0: 
sl@0: /** @return the usable clusters count for a volume */
sl@0: TUint32 CFatMountCB::UsableClusters() const
sl@0: 	{return(iUsableClusters);}
sl@0: 
sl@0: 
sl@0: TUint CFatMountCB::StartOfRootDirInBytes() const
sl@0:     {return iVolParam.RootDirectorySector()<<SectorSizeLog2();}
sl@0: 
sl@0: 
sl@0: /** @return FAT type for this mount */
sl@0: TFatType CFatMountCB::FatType() const
sl@0: {
sl@0:     return iFatType;
sl@0: }
sl@0: 
sl@0: /** @return ETrue if the mount has 16bit FAT */
sl@0: TBool CFatMountCB::Is16BitFat() const
sl@0: {
sl@0:     return FatType() == EFat16;
sl@0: } 
sl@0: 
sl@0: /** @return ETrue if the mount has 32bit FAT */
sl@0: TBool CFatMountCB::Is32BitFat() const
sl@0: {   
sl@0:     return FatType() == EFat32;
sl@0: }
sl@0: 
sl@0: CAsyncNotifier* CFatMountCB::Notifier() const
sl@0: 	{return iNotifier;}	
sl@0: 
sl@0: 
sl@0: 
sl@0: /**
sl@0:     Set or reset Read Only mode for the mount.
sl@0:     @param    aReadOnlyMode if ETrue, the mount will be set RO.
sl@0: */
sl@0: void  CFatMountCB::SetReadOnly(TBool aReadOnlyMode) 
sl@0:     {
sl@0:     iReadOnly = aReadOnlyMode;
sl@0:     }
sl@0: 
sl@0: 
sl@0: /**
sl@0:     @return ETrue if the volume is in Read-Only state
sl@0: */
sl@0: TBool CFatMountCB::ReadOnly(void) const
sl@0:     {
sl@0:     return iReadOnly;
sl@0:     }
sl@0: 
sl@0: /** @return state of the CFatMountCB*/
sl@0: CFatMountCB::TFatMntState CFatMountCB::State() const 
sl@0:     {
sl@0:     return iState;
sl@0:     }
sl@0: 
sl@0: /** 
sl@0:     Set state of the CFatMountCB
sl@0:     @param  aState state to set
sl@0: */
sl@0: void CFatMountCB::SetState(TFatMntState aState)
sl@0:     {
sl@0:     __PRINT3(_L("#- CFatMountCB::SetState() drv:%d, %d->%d\n"),DriveNumber(),iState,aState);
sl@0:     iState = aState;
sl@0:     }
sl@0: 
sl@0: 
sl@0: TDriveInterface& CFatMountCB::DriveInterface() const 
sl@0:     {
sl@0:     return (TDriveInterface&)iDriverInterface; 
sl@0:     }
sl@0: 
sl@0: const TFatConfig& CFatMountCB::FatConfig() const 
sl@0:     {
sl@0:     return iFatConfig;
sl@0:     }
sl@0: 
sl@0: //---------------------------------------------------------------------------------------------------------------------------------
sl@0: /** 
sl@0: Check if the XFileCreationHelper object is initialised.
sl@0: */
sl@0: TBool CFatMountCB::XFileCreationHelper::IsInitialised() const 
sl@0: 	{
sl@0: 	return isInitialised;
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Get number of new entries for file creation.
sl@0: */
sl@0: TUint16	CFatMountCB::XFileCreationHelper::NumOfAddingEntries() const
sl@0: 	{
sl@0: 	ASSERT(isInitialised); 
sl@0: 	return iNumOfAddingEntries;
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Get position of new entries for file creation.
sl@0: */
sl@0: TEntryPos CFatMountCB::XFileCreationHelper::EntryAddingPos() const 
sl@0: 	{
sl@0: 	ASSERT(isInitialised); 
sl@0: 	return iEntryAddingPos;
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Check if position of new entries has been found.
sl@0: */
sl@0: TBool CFatMountCB::XFileCreationHelper::IsNewEntryPosFound() const 
sl@0: 	{
sl@0: 	ASSERT(isInitialised); 
sl@0: 	return isNewEntryPosFound;
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Check if file name of the new file is a legal dos name.
sl@0: */
sl@0: TBool CFatMountCB::XFileCreationHelper::IsTrgNameLegalDosName() const
sl@0: 	{
sl@0: 	ASSERT(isInitialised); 
sl@0: 	return isTrgNameLegalDosName;
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Set entry position for new entries to be added.
sl@0: */
sl@0: void CFatMountCB::XFileCreationHelper::SetEntryAddingPos(const TEntryPos& aEntryPos) 
sl@0: 	{
sl@0: 	iEntryAddingPos = aEntryPos;
sl@0: 	}
sl@0: 
sl@0: /** 
sl@0: Set condition if position of new entries has been found.
sl@0: */
sl@0: void CFatMountCB::XFileCreationHelper::SetIsNewEntryPosFound(TBool aFound) 
sl@0: 	{
sl@0: 	isNewEntryPosFound = aFound;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0:     Checks for "EOC" for all Fat types
sl@0:     @param  aCluster FAT table entry (cluster number) to check
sl@0:     @return ETrue    if aCluster is a EOC for the FAT type being used by CFatMountCB
sl@0: */
sl@0: TBool CFatMountCB::IsEndOfClusterCh(TInt aCluster) const
sl@0: 	{
sl@0:     ASSERT(iFatEocCode);
sl@0: 
sl@0:     if((TUint32)aCluster >= iFatEocCode)
sl@0:         return ETrue;
sl@0: 
sl@0:     ASSERT((TUint32)aCluster <= iFatEocCode+7);
sl@0: 
sl@0: 	return EFalse;
sl@0:     }
sl@0: 
sl@0: /**
sl@0:     Sets "End of Cluster Chain" value in aCluster depending on the FAT type.
sl@0:     @param aCluster cluster to set to end of chain marker
sl@0: */
sl@0: void CFatMountCB::SetEndOfClusterCh(TInt &aCluster) const
sl@0: 	{
sl@0:     ASSERT(iFatEocCode);
sl@0:     aCluster = iFatEocCode+7;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: //-------  debug methods
sl@0: #ifdef  _DEBUG
sl@0: /**
sl@0: Debug function indicates whether write fails are active or not, for test
sl@0: @return ETrue if write fails on or not
sl@0: */
sl@0: TBool CFatMountCB::IsWriteFail()const
sl@0: 	{return(iIsWriteFail);}
sl@0: /**
sl@0: Switches write fails on or off, for test
sl@0: @param aIsWriteFail set true or false to set write fails on or off
sl@0: */
sl@0: void CFatMountCB::SetWriteFail(TBool aIsWriteFail)
sl@0: 	{iIsWriteFail=aIsWriteFail;}
sl@0: 
sl@0: /** @return number of write fails to occur, for test */
sl@0: TInt CFatMountCB::WriteFailCount()const
sl@0: 	{return(iWriteFailCount);}
sl@0: 
sl@0: /**
sl@0: Set the number of Write fails 
sl@0: @param aFailCount number of write fails, for test
sl@0: */
sl@0: void CFatMountCB::SetWriteFailCount(TInt aFailCount)
sl@0: 	{iWriteFailCount=aFailCount;}
sl@0: 
sl@0: /** Decrement the number of write fails, for test */
sl@0: void CFatMountCB::DecWriteFailCount()
sl@0: 	{--iWriteFailCount;}
sl@0: 
sl@0: /** @return Error for a write failure, for test */
sl@0: TInt CFatMountCB::WriteFailError()const
sl@0: 	{return iWriteFailError;}
sl@0: 
sl@0: /**
sl@0: Set the write fail error code, for test
sl@0: @param aErrorValue The Error for a write fails
sl@0: */
sl@0: void CFatMountCB::SetWriteFailError(TInt aErrorValue)
sl@0: 	{iWriteFailError=aErrorValue;}
sl@0: 
sl@0: #endif
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: //---------------------------------------------------------------------------------------------------------------------------------
sl@0: // class CFatFormatCB
sl@0: 
sl@0: /** @return pointer to the owning mount object */
sl@0: CFatMountCB& CFatFormatCB::FatMount()
sl@0: 	{return *(CFatMountCB*)&Mount();}
sl@0: 
sl@0: /**
sl@0: Returns the local drive used by the file systems from the owning mount
sl@0: @return Pointer to the local drive 
sl@0: */
sl@0: CProxyDrive* CFatFormatCB::LocalDrive()
sl@0: 	{return(FatMount().LocalDrive());}
sl@0: 
sl@0: 
sl@0: //---------------------------------------------------------------------------------------------------------------------------------
sl@0: // class CFatFileCB
sl@0: 
sl@0: /**
sl@0: Returns the owning mount from file object
sl@0: 
sl@0: @return pointer to the owning mount object
sl@0: */
sl@0: CFatMountCB& CFatFileCB::FatMount() const
sl@0: 	{return((CFatMountCB&)Mount());}
sl@0: 
sl@0: /**
sl@0: Returns the fat table used by the file system for this mount
sl@0: 
sl@0: @return Refrence to the Fat table owned by the mount
sl@0: */
sl@0: CFatTable& CFatFileCB::FAT()
sl@0: 	{return(FatMount().FAT());}
sl@0: 
sl@0: /**
sl@0: Position with in a cluster for a given address
sl@0: 
sl@0: @param aPos Byte position 
sl@0: */
sl@0: TInt CFatFileCB::ClusterRelativePos(TInt aPos)
sl@0: 	{return(FatMount().ClusterRelativePos(aPos));}
sl@0: /**
sl@0: Returns Log2 of cluster size from mount
sl@0: 
sl@0: @return cluster size
sl@0: */
sl@0: TInt CFatFileCB::ClusterSizeLog2()
sl@0: 	{return(FatMount().ClusterSizeLog2());}
sl@0: 
sl@0: /*
sl@0:  Note: this replaces SeekIndex() which was only used in sl_mnt
sl@0:  to verify whether the seek index had been created/initialised
sl@0: */
sl@0: inline TBool CFatFileCB::IsSeekIndex() const
sl@0: {return (iSeekIndex==NULL?(TBool)EFalse:(TBool)ETrue); }
sl@0: 
sl@0: 
sl@0: //---------------------------------------------------------------------------------------------------------------------------------
sl@0: // class CFatDirCB
sl@0: 
sl@0: /**
sl@0: Returns the owning mount from directory object
sl@0: 
sl@0: @return pointer to the owning mount object
sl@0: */
sl@0: CFatMountCB& CFatDirCB::FatMount()
sl@0: 	{return((CFatMountCB&)Mount());}
sl@0: 
sl@0: 
sl@0: 
sl@0: //---------------------------------------------------------------------------------------------------------------------------------
sl@0: // class CFatTable
sl@0: 
sl@0: TUint32 CFatTable::FreeClusters() const 
sl@0:     {
sl@0:     return iFreeClusters;
sl@0:     }
sl@0: 
sl@0: 
sl@0: //---------------------------------------------------------------------------------------------------------------------------------
sl@0: 
sl@0: inline TFatType CFatTable::FatType() const 
sl@0:     {
sl@0:     return iFatType;
sl@0:     }
sl@0: 
sl@0: inline TBool CFatTable::IsFat12() const
sl@0:     {
sl@0:     return iFatType == EFat12;
sl@0:     }
sl@0: 
sl@0: inline TBool CFatTable::IsFat16() const
sl@0:     {
sl@0:     return iFatType == EFat16;
sl@0:     }
sl@0: 
sl@0: inline TBool CFatTable::IsFat32() const
sl@0:     {
sl@0:     return iFatType == EFat32;
sl@0:     }
sl@0: 
sl@0: 
sl@0: /**
sl@0:     Checks for "EOC" for all Fat types
sl@0:     @param  aCluster FAT table entry (cluster number) to check
sl@0:     @return ETrue    if aCluster is a EOC for the FAT type being used by CFatMountCB that owns the CFatTable
sl@0: */
sl@0: inline TBool CFatTable::IsEndOfClusterCh(TUint32 aCluster) const
sl@0:     {
sl@0:     ASSERT(iFatEocCode);
sl@0: 
sl@0:     if(aCluster >= iFatEocCode)
sl@0:         return ETrue;
sl@0: 
sl@0:     ASSERT((TUint32)aCluster <= iFatEocCode+7);
sl@0: 	return EFalse;
sl@0:     }
sl@0: 
sl@0: 
sl@0: /**
sl@0: @return Maximal number of addresable FAT entries. This value is taken from the owning mount
sl@0: */
sl@0: inline TUint32 CFatTable::MaxEntries() const
sl@0:     {
sl@0:         ASSERT(iMaxEntries > 0);
sl@0:         return iMaxEntries;
sl@0:     }
sl@0: 
sl@0: 
sl@0: // class TDriveInterface
sl@0: TBool TDriveInterface::NotifyUser() const
sl@0: 	{return(iMount->GetNotifyUser());}
sl@0: 
sl@0: 
sl@0: //----------------------------------------------------------------------------------------------------
sl@0: // class CRawDisk
sl@0: 
sl@0: /**
sl@0:     Get pointer to the directory cache interface. Any client that reads/writes directory entries 
sl@0:     MUST do it via this interface.
sl@0:     Default implementation returns NULL
sl@0: 
sl@0:     @return     pointer to the MWTCacheInterface interface, or NULL if it is not present.
sl@0: */
sl@0: MWTCacheInterface* CRawDisk::DirCacheInterface()
sl@0:     {
sl@0:     return NULL;
sl@0:     }
sl@0: 
sl@0: //---------------------------------------------------------------------------------------------------------------------------------	
sl@0: 
sl@0: /**
sl@0:     Calculate offset of the page starting position in the cluster 
sl@0:     @param aPos  the current entry position in bytes in the cluster
sl@0:     @param aPageSzLog2	page size in log2
sl@0:     @return		the starting position of the page that contains aPos
sl@0: */
sl@0: inline TUint32 CalculatePageOffsetInCluster(TUint32 aPos, TUint aPageSzLog2)
sl@0: 	{
sl@0: 	return (aPos >> aPageSzLog2) << aPageSzLog2;
sl@0: 	}
sl@0: 
sl@0: #endif //SL_STD_INL
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: