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_bpb.inl
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef SL_BPB_INL
sl@0: #define SL_BPB_INL
sl@0: 
sl@0: 
sl@0: /**
sl@0: Defined cast of Fat directory entry data read to structure allowing
sl@0: access to data
sl@0: 
sl@0: @internalTechnology
sl@0: */
sl@0: #define pDir ((SFatDirEntry*)&iData[0])
sl@0: 
sl@0: /**
sl@0: Returns Sectors in Fat table for 32 bit volume
sl@0: 
sl@0: @return iFatSectors32
sl@0: */
sl@0: inline TUint32 TFatBootSector::FatSectors32() const	
sl@0: 	{return iFatSectors32;}
sl@0: /**
sl@0: Fat flags
sl@0: 
sl@0: @return iFATFlags
sl@0: */
sl@0: inline TUint16 TFatBootSector::FATFlags() const		
sl@0: 	{return iFATFlags;}
sl@0: /**
sl@0: Version number of the file system
sl@0: 
sl@0: @return iVersionNumber
sl@0: */
sl@0: inline TUint16 TFatBootSector::VersionNumber() const		
sl@0: 	{return iVersionNumber;}
sl@0: /**
sl@0: Cluster number of the root directory
sl@0: 
sl@0: @return iRootClusterNum
sl@0: */
sl@0: inline TUint32 TFatBootSector::RootClusterNum() const	
sl@0: 	{return iRootClusterNum;}
sl@0: /**
sl@0: Sector number containing the FSIInfo structure
sl@0: 
sl@0: @return iFSInfoSectorNum
sl@0: */
sl@0: inline TUint16 TFatBootSector::FSInfoSectorNum() const
sl@0: 	{return iFSInfoSectorNum;}
sl@0: /**
sl@0: Backup boot sector
sl@0: 
sl@0: @return iBkBootRecSector
sl@0: */
sl@0: inline TUint16 TFatBootSector::BkBootRecSector() const
sl@0: 	{return iBkBootRecSector;}
sl@0: /**
sl@0: Sets the number of sectors in Fat table for 32 bit volume
sl@0: 
sl@0: @param aFatSectors32
sl@0: */
sl@0: inline void TFatBootSector::SetFatSectors32(TUint32	aFatSectors32)
sl@0: 	{iFatSectors32 = aFatSectors32;}
sl@0: /**
sl@0: Sets the Fat flags
sl@0: 
sl@0: @param aFATFlags
sl@0: */
sl@0: inline void TFatBootSector::SetFATFlags(TUint16 aFATFlags)
sl@0: 	{iFATFlags = aFATFlags;}
sl@0: /**
sl@0: Sets the version number of the file system
sl@0: 
sl@0: @param aVersionNumber
sl@0: */
sl@0: inline void TFatBootSector::SetVersionNumber(TUint16 aVersionNumber)
sl@0: 	{iVersionNumber = aVersionNumber;}
sl@0: /**
sl@0: Sets the cluster number of the root directory
sl@0: 
sl@0: @param aRootClusterNum
sl@0: */
sl@0: inline void TFatBootSector::SetRootClusterNum(TUint32 aRootClusterNum)	
sl@0: 	{iRootClusterNum = aRootClusterNum;}
sl@0: /**
sl@0: Set the sector number containing the FSIInfo structure
sl@0: 
sl@0: @param aFSInfoSectorNum
sl@0: */
sl@0: inline void TFatBootSector::SetFSInfoSectorNum(TUint16 aFSInfoSectorNum)
sl@0: 	{iFSInfoSectorNum = aFSInfoSectorNum;}
sl@0: /**
sl@0: Set the backup boot sector
sl@0: 
sl@0: @param aBkBootRecSector
sl@0: */
sl@0: inline void TFatBootSector::SetBkBootRecSector(TUint16 aBkBootRecSector)
sl@0: 	{iBkBootRecSector = aBkBootRecSector;}	
sl@0: 
sl@0: /**
sl@0: Returns the vendor ID of the file system that formatted the volume
sl@0: 
sl@0: @return A descriptor containing the vendor ID 
sl@0: */
sl@0: inline const TPtrC8 TFatBootSector::VendorId() const
sl@0: 	{return TPtrC8(iVendorId,KVendorIdSize);}
sl@0: /**
sl@0: Return the bytes per sector
sl@0: 
sl@0: @return iBytesPerSector
sl@0: */
sl@0: inline TUint16 TFatBootSector::BytesPerSector() const
sl@0: 	{return iBytesPerSector;}
sl@0: /**
sl@0: Returns the sectors per cluster ratio
sl@0: 
sl@0: @return iSectorsPerCluster
sl@0: */
sl@0: inline TInt TFatBootSector::SectorsPerCluster() const
sl@0: 	{return iSectorsPerCluster;}
sl@0: /**
sl@0: Returns the number of reserved sectors on the volume
sl@0: 
sl@0: @return iReservedSectors
sl@0: */
sl@0: inline TInt TFatBootSector::ReservedSectors() const
sl@0: 	{return iReservedSectors;}
sl@0: /**
sl@0: Returns the number of Fats on the volume
sl@0: 
sl@0: @return iNumberOfFats
sl@0: */
sl@0: inline TInt TFatBootSector::NumberOfFats() const
sl@0: 	{return iNumberOfFats;}
sl@0: /**
sl@0: Returns the number of entries allowed in the root directory, specific to Fat12/16, zero for FAT32
sl@0: 
sl@0: @return iRootDirEntries
sl@0: */
sl@0: inline TInt TFatBootSector::RootDirEntries() const
sl@0: 	{return iRootDirEntries;}
sl@0: /**
sl@0: Returns the total sectors on the volume, zero for FAT32
sl@0: 
sl@0: @return iTotalSectors
sl@0: */
sl@0: inline TInt TFatBootSector::TotalSectors() const
sl@0: 	{return iTotalSectors;}
sl@0: /**
sl@0: Returns the media descriptor
sl@0: 
sl@0: @return iMediaDescriptor
sl@0: */
sl@0: inline TUint8 TFatBootSector::MediaDescriptor() const
sl@0: 	{return iMediaDescriptor;}
sl@0: /**
sl@0: Returns sectors used for the Fat table, zero for FAT32
sl@0: 
sl@0: @return iFatSectors
sl@0: */
sl@0: inline TInt TFatBootSector::FatSectors() const
sl@0: 	{return iFatSectors;}
sl@0: /**
sl@0: Returns sectors per track
sl@0: 
sl@0: @return iSectorsPerTrack
sl@0: */
sl@0: inline TInt TFatBootSector::SectorsPerTrack() const
sl@0: 	{return iSectorsPerTrack;}
sl@0: /**
sl@0: Returns the number of heads 
sl@0: 
sl@0: @return iNumberOfHeads
sl@0: */
sl@0: inline TInt TFatBootSector::NumberOfHeads() const
sl@0: 	{return iNumberOfHeads;}
sl@0: /**
sl@0: Returns the number of hidden sectors in the volume
sl@0: 
sl@0: @return iHiddenSectors
sl@0: */
sl@0: inline TInt TFatBootSector::HiddenSectors() const
sl@0: 	{return iHiddenSectors;}
sl@0: /**
sl@0: Returns total sectors in the volume, Used if totalSectors > 65535
sl@0: 
sl@0: @return iHugeSectors
sl@0: */
sl@0: inline TInt TFatBootSector::HugeSectors() const
sl@0: 	{return iHugeSectors;}
sl@0: /**
sl@0: Returns the physical drive number, not used in Symbian OS
sl@0: 
sl@0: @return iPhysicalDriveNumber
sl@0: */
sl@0: inline TInt TFatBootSector::PhysicalDriveNumber() const
sl@0: 	{return iPhysicalDriveNumber;}
sl@0: /**
sl@0: Returns the extended boot signiture
sl@0: 
sl@0: @return iExtendedBootSignature
sl@0: */
sl@0: inline TInt TFatBootSector::ExtendedBootSignature() const
sl@0: 	{return iExtendedBootSignature;}
sl@0: /**
sl@0: Returns the unique volume ID
sl@0: 
sl@0: @return iUniqueID
sl@0: */
sl@0: inline TUint32 TFatBootSector::UniqueID() const
sl@0: 	{return iUniqueID;}
sl@0: /**
sl@0: Returns the volume's label
sl@0: 
sl@0: @return A descriptor containing the volume label
sl@0: */
sl@0: inline const TPtrC8 TFatBootSector::VolumeLabel() const
sl@0: 	{return TPtrC8(iVolumeLabel,KVolumeLabelSize);}
sl@0: /**
sl@0: Returns the file system type
sl@0: 
sl@0: @return A descriptor containing the file system type
sl@0: */
sl@0: inline const TPtrC8 TFatBootSector::FileSysType() const
sl@0: 	{return TPtrC8(iFileSysType,KFileSysTypeSize);}
sl@0: /**
sl@0: Returns the boot sector signiture
sl@0: 
sl@0: @return KBootSectorSignature
sl@0: */
sl@0: inline TInt TFatBootSector::BootSectorSignature() const
sl@0: 	{return KBootSectorSignature;}
sl@0: /**
sl@0: Set the jump instruction 
sl@0: */
sl@0: inline void TFatBootSector::SetJumpInstruction()
sl@0: 	{iJumpInstruction[0]=0xE9;iJumpInstruction[2]=0x90;}
sl@0: /**
sl@0: Set the vendor ID of the file system that formatted the volume
sl@0: 
sl@0: @param aDes Descriptor containing the Vendor ID
sl@0: */
sl@0: inline void TFatBootSector::SetVendorID(const TDesC8& aDes)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aDes.Length()<=KVendorIdSize,Fault(EFatBadBootSectorParameter));
sl@0: 	TPtr8 buf(iVendorId,KVendorIdSize);
sl@0: 	buf=aDes;
sl@0: 	}
sl@0: /**
sl@0: Sets the bytes per sector 
sl@0: 
sl@0: @param aBytesPerSector Number of bytes per sector
sl@0: */
sl@0: inline void TFatBootSector::SetBytesPerSector(TInt aBytesPerSector)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(aBytesPerSector&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
sl@0: 	iBytesPerSector=(TUint16)aBytesPerSector;
sl@0: 	}
sl@0: /**
sl@0: Set the sectors per cluster ratio
sl@0: 
sl@0: @param aSectorsPerCluster Number of sectors per cluster
sl@0: */
sl@0: inline void TFatBootSector::SetSectorsPerCluster(TInt aSectorsPerCluster)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(aSectorsPerCluster&~KMaxTUint8),Fault(EFatBadBootSectorParameter));
sl@0: 	iSectorsPerCluster=(TUint8)aSectorsPerCluster;
sl@0: 	}
sl@0: /**
sl@0: Sets the number of reserved sectors on the volume
sl@0: 
sl@0: @param aReservedSectors Number of reserved sectors
sl@0: */
sl@0: inline void TFatBootSector::SetReservedSectors(TInt aReservedSectors)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(aReservedSectors&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
sl@0: 	iReservedSectors=(TUint16)aReservedSectors;
sl@0: 	}
sl@0: /**
sl@0: Sets the number of Fats on the volume
sl@0: 
sl@0: @param aNumberOfFats Number of fats
sl@0: */
sl@0: inline void TFatBootSector::SetNumberOfFats(TInt aNumberOfFats)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(aNumberOfFats&~KMaxTUint8),Fault(EFatBadBootSectorParameter));
sl@0: 	iNumberOfFats=(TUint8)aNumberOfFats;
sl@0: 	}
sl@0: /**
sl@0: Number of entries allowed in the root directory, specific to Fat12/16, zero for FAT32
sl@0: 
sl@0: @param aRootDirEntries
sl@0: */
sl@0: inline void TFatBootSector::SetRootDirEntries(TInt aRootDirEntries)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(aRootDirEntries&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
sl@0: 	iRootDirEntries=(TUint16)aRootDirEntries;
sl@0: 	}
sl@0: /**
sl@0: Total sectors on the volume, zero for FAT32
sl@0: 
sl@0: @param aTotalSectors Total number of sectors
sl@0: */
sl@0: inline void TFatBootSector::SetTotalSectors(TInt aTotalSectors)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(aTotalSectors&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
sl@0: 	iTotalSectors=(TUint16)aTotalSectors;
sl@0: 	}
sl@0: /**
sl@0: Set the media descriptor
sl@0: 
sl@0: @param aMediaDescriptor
sl@0: */
sl@0: inline void TFatBootSector::SetMediaDescriptor(TUint8 aMediaDescriptor)
sl@0: 	{iMediaDescriptor=aMediaDescriptor;}
sl@0: /**
sl@0: Sectors used for the Fat table, zero for FAT32
sl@0: 
sl@0: @param aFatSectors Number of Fat sectors
sl@0: */
sl@0: inline void TFatBootSector::SetFatSectors(TInt aFatSectors)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(aFatSectors&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
sl@0: 	iFatSectors=(TUint16)aFatSectors;
sl@0: 	}
sl@0: /**
sl@0: Set the sectors per track
sl@0: 
sl@0: @param aSectorsPerTrack Number of sectors per track
sl@0: */
sl@0: inline void TFatBootSector::SetSectorsPerTrack(TInt aSectorsPerTrack)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(aSectorsPerTrack&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
sl@0: 	iSectorsPerTrack=(TUint16)aSectorsPerTrack;
sl@0: 	}
sl@0: /**
sl@0: Set the number of heads
sl@0: 
sl@0: @param aNumberOfHeads Number of heads
sl@0: */
sl@0: inline void TFatBootSector::SetNumberOfHeads(TInt aNumberOfHeads)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(aNumberOfHeads&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
sl@0: 	iNumberOfHeads=(TUint16)aNumberOfHeads;
sl@0: 	}
sl@0: /**
sl@0: Set the number of hidden sectors in the volume
sl@0: 
sl@0: @param aHiddenSectors Number of hidden sectors
sl@0: */
sl@0: inline void TFatBootSector::SetHiddenSectors(TUint32 aHiddenSectors)
sl@0: 	{
sl@0: 	iHiddenSectors=aHiddenSectors;
sl@0: 	}
sl@0: /**
sl@0: Set the total sectors in the volume, Used if totalSectors > 65535
sl@0: 
sl@0: @param aHugeSectors
sl@0: */
sl@0: inline void TFatBootSector::SetHugeSectors(TUint32 aHugeSectors)
sl@0: 	{iHugeSectors=aHugeSectors;}
sl@0: /**
sl@0: Physical drive number, not used in Symbian OS
sl@0: 
sl@0: @param aPhysicalDriveNumber Physical drive number 
sl@0: */
sl@0: inline void TFatBootSector::SetPhysicalDriveNumber(TInt aPhysicalDriveNumber)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(aPhysicalDriveNumber&~KMaxTUint8),Fault(EFatBadBootSectorParameter));
sl@0: 	iPhysicalDriveNumber=(TUint8)aPhysicalDriveNumber;
sl@0: 	}
sl@0: /**
sl@0: Set the reserved byte value
sl@0: 
sl@0: @param aReservedByte Value for reserved byte
sl@0: */
sl@0: inline void TFatBootSector::SetReservedByte(TUint8 aReservedByte)
sl@0: 	{iReserved=aReservedByte;}
sl@0: /**
sl@0: Set the extended boot signiture
sl@0: 
sl@0: @param anExtendedBootSignature The extended boot signiture
sl@0: */
sl@0: inline void TFatBootSector::SetExtendedBootSignature(TInt anExtendedBootSignature)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(!(anExtendedBootSignature&~KMaxTUint8),Fault(EFatBadBootSectorParameter));
sl@0: 	iExtendedBootSignature=(TUint8)anExtendedBootSignature;
sl@0: 	}
sl@0: /**
sl@0: Set the unique volume ID
sl@0: 
sl@0: @param anUniqueID Set the unique ID
sl@0: */
sl@0: inline void TFatBootSector::SetUniqueID(TUint32 anUniqueID)
sl@0: 	{iUniqueID=anUniqueID;}
sl@0: /**
sl@0: Set the volume's label
sl@0: 
sl@0: @param aDes A descriptor containg the volume label
sl@0: */
sl@0: inline void TFatBootSector::SetVolumeLabel(const TDesC8& aDes)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aDes.Length()<=KVolumeLabelSize,Fault(EFatBadBootSectorParameter));
sl@0: 	TPtr8 buf(iVolumeLabel,KVolumeLabelSize);
sl@0: 	buf=aDes;
sl@0: 	}
sl@0: /**
sl@0: Set the file system type
sl@0: 
sl@0: @param aDes A descriptor containing the file system type
sl@0: */
sl@0: inline void TFatBootSector::SetFileSysType(const TDesC8& aDes)
sl@0: 	{
sl@0: 	__ASSERT_DEBUG(aDes.Length()<=8,Fault(EFatBadBootSectorParameter));
sl@0: 	TPtr8 buf(iFileSysType,8);
sl@0: 	buf=aDes;
sl@0: 	}
sl@0: 
sl@0: 
sl@0: /**
sl@0: Returns the number of free clusters
sl@0: 
sl@0: @return iFreeCount
sl@0: */
sl@0: inline TUint32 TFSInfo::FreeClusterCount() const
sl@0: 	{return iFreeCount;}
sl@0: /**
sl@0: Returns the next free cluster
sl@0: 
sl@0: @return iNextFree
sl@0: */
sl@0: inline TUint32 TFSInfo::NextFreeCluster() const
sl@0: 	{return iNextFree;}
sl@0: /**
sl@0: Sets the number of free clusters
sl@0: 
sl@0: @param aFreeCount Number of free clusters
sl@0: */
sl@0: inline void TFSInfo::SetFreeClusterCount(TUint32 aFreeCount)
sl@0: 	{iFreeCount = aFreeCount;}
sl@0: /**
sl@0: Sets the next free cluster
sl@0: 
sl@0: @param aNextCluster Cluster number of the next free cluster 
sl@0: */
sl@0: inline void TFSInfo::SetNextFreeCluster(TUint32 aNextCluster)
sl@0: 	{iNextFree = aNextCluster;}
sl@0: 
sl@0: #endif //SL_BPB_INL