1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/kernelhwsrv/userlibandfileserver/fileserver/sfat32/inc/sl_bpb.inl Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,464 @@
1.4 +// Copyright (c) 1996-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// under the terms of the License "Eclipse Public License v1.0"
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// f32\sfat32\inc\sl_bpb.inl
1.18 +//
1.19 +//
1.20 +
1.21 +#ifndef SL_BPB_INL
1.22 +#define SL_BPB_INL
1.23 +
1.24 +
1.25 +/**
1.26 +Defined cast of Fat directory entry data read to structure allowing
1.27 +access to data
1.28 +
1.29 +@internalTechnology
1.30 +*/
1.31 +#define pDir ((SFatDirEntry*)&iData[0])
1.32 +
1.33 +/**
1.34 +Returns Sectors in Fat table for 32 bit volume
1.35 +
1.36 +@return iFatSectors32
1.37 +*/
1.38 +inline TUint32 TFatBootSector::FatSectors32() const
1.39 + {return iFatSectors32;}
1.40 +/**
1.41 +Fat flags
1.42 +
1.43 +@return iFATFlags
1.44 +*/
1.45 +inline TUint16 TFatBootSector::FATFlags() const
1.46 + {return iFATFlags;}
1.47 +/**
1.48 +Version number of the file system
1.49 +
1.50 +@return iVersionNumber
1.51 +*/
1.52 +inline TUint16 TFatBootSector::VersionNumber() const
1.53 + {return iVersionNumber;}
1.54 +/**
1.55 +Cluster number of the root directory
1.56 +
1.57 +@return iRootClusterNum
1.58 +*/
1.59 +inline TUint32 TFatBootSector::RootClusterNum() const
1.60 + {return iRootClusterNum;}
1.61 +/**
1.62 +Sector number containing the FSIInfo structure
1.63 +
1.64 +@return iFSInfoSectorNum
1.65 +*/
1.66 +inline TUint16 TFatBootSector::FSInfoSectorNum() const
1.67 + {return iFSInfoSectorNum;}
1.68 +/**
1.69 +Backup boot sector
1.70 +
1.71 +@return iBkBootRecSector
1.72 +*/
1.73 +inline TUint16 TFatBootSector::BkBootRecSector() const
1.74 + {return iBkBootRecSector;}
1.75 +/**
1.76 +Sets the number of sectors in Fat table for 32 bit volume
1.77 +
1.78 +@param aFatSectors32
1.79 +*/
1.80 +inline void TFatBootSector::SetFatSectors32(TUint32 aFatSectors32)
1.81 + {iFatSectors32 = aFatSectors32;}
1.82 +/**
1.83 +Sets the Fat flags
1.84 +
1.85 +@param aFATFlags
1.86 +*/
1.87 +inline void TFatBootSector::SetFATFlags(TUint16 aFATFlags)
1.88 + {iFATFlags = aFATFlags;}
1.89 +/**
1.90 +Sets the version number of the file system
1.91 +
1.92 +@param aVersionNumber
1.93 +*/
1.94 +inline void TFatBootSector::SetVersionNumber(TUint16 aVersionNumber)
1.95 + {iVersionNumber = aVersionNumber;}
1.96 +/**
1.97 +Sets the cluster number of the root directory
1.98 +
1.99 +@param aRootClusterNum
1.100 +*/
1.101 +inline void TFatBootSector::SetRootClusterNum(TUint32 aRootClusterNum)
1.102 + {iRootClusterNum = aRootClusterNum;}
1.103 +/**
1.104 +Set the sector number containing the FSIInfo structure
1.105 +
1.106 +@param aFSInfoSectorNum
1.107 +*/
1.108 +inline void TFatBootSector::SetFSInfoSectorNum(TUint16 aFSInfoSectorNum)
1.109 + {iFSInfoSectorNum = aFSInfoSectorNum;}
1.110 +/**
1.111 +Set the backup boot sector
1.112 +
1.113 +@param aBkBootRecSector
1.114 +*/
1.115 +inline void TFatBootSector::SetBkBootRecSector(TUint16 aBkBootRecSector)
1.116 + {iBkBootRecSector = aBkBootRecSector;}
1.117 +
1.118 +/**
1.119 +Returns the vendor ID of the file system that formatted the volume
1.120 +
1.121 +@return A descriptor containing the vendor ID
1.122 +*/
1.123 +inline const TPtrC8 TFatBootSector::VendorId() const
1.124 + {return TPtrC8(iVendorId,KVendorIdSize);}
1.125 +/**
1.126 +Return the bytes per sector
1.127 +
1.128 +@return iBytesPerSector
1.129 +*/
1.130 +inline TUint16 TFatBootSector::BytesPerSector() const
1.131 + {return iBytesPerSector;}
1.132 +/**
1.133 +Returns the sectors per cluster ratio
1.134 +
1.135 +@return iSectorsPerCluster
1.136 +*/
1.137 +inline TInt TFatBootSector::SectorsPerCluster() const
1.138 + {return iSectorsPerCluster;}
1.139 +/**
1.140 +Returns the number of reserved sectors on the volume
1.141 +
1.142 +@return iReservedSectors
1.143 +*/
1.144 +inline TInt TFatBootSector::ReservedSectors() const
1.145 + {return iReservedSectors;}
1.146 +/**
1.147 +Returns the number of Fats on the volume
1.148 +
1.149 +@return iNumberOfFats
1.150 +*/
1.151 +inline TInt TFatBootSector::NumberOfFats() const
1.152 + {return iNumberOfFats;}
1.153 +/**
1.154 +Returns the number of entries allowed in the root directory, specific to Fat12/16, zero for FAT32
1.155 +
1.156 +@return iRootDirEntries
1.157 +*/
1.158 +inline TInt TFatBootSector::RootDirEntries() const
1.159 + {return iRootDirEntries;}
1.160 +/**
1.161 +Returns the total sectors on the volume, zero for FAT32
1.162 +
1.163 +@return iTotalSectors
1.164 +*/
1.165 +inline TInt TFatBootSector::TotalSectors() const
1.166 + {return iTotalSectors;}
1.167 +/**
1.168 +Returns the media descriptor
1.169 +
1.170 +@return iMediaDescriptor
1.171 +*/
1.172 +inline TUint8 TFatBootSector::MediaDescriptor() const
1.173 + {return iMediaDescriptor;}
1.174 +/**
1.175 +Returns sectors used for the Fat table, zero for FAT32
1.176 +
1.177 +@return iFatSectors
1.178 +*/
1.179 +inline TInt TFatBootSector::FatSectors() const
1.180 + {return iFatSectors;}
1.181 +/**
1.182 +Returns sectors per track
1.183 +
1.184 +@return iSectorsPerTrack
1.185 +*/
1.186 +inline TInt TFatBootSector::SectorsPerTrack() const
1.187 + {return iSectorsPerTrack;}
1.188 +/**
1.189 +Returns the number of heads
1.190 +
1.191 +@return iNumberOfHeads
1.192 +*/
1.193 +inline TInt TFatBootSector::NumberOfHeads() const
1.194 + {return iNumberOfHeads;}
1.195 +/**
1.196 +Returns the number of hidden sectors in the volume
1.197 +
1.198 +@return iHiddenSectors
1.199 +*/
1.200 +inline TInt TFatBootSector::HiddenSectors() const
1.201 + {return iHiddenSectors;}
1.202 +/**
1.203 +Returns total sectors in the volume, Used if totalSectors > 65535
1.204 +
1.205 +@return iHugeSectors
1.206 +*/
1.207 +inline TInt TFatBootSector::HugeSectors() const
1.208 + {return iHugeSectors;}
1.209 +/**
1.210 +Returns the physical drive number, not used in Symbian OS
1.211 +
1.212 +@return iPhysicalDriveNumber
1.213 +*/
1.214 +inline TInt TFatBootSector::PhysicalDriveNumber() const
1.215 + {return iPhysicalDriveNumber;}
1.216 +/**
1.217 +Returns the extended boot signiture
1.218 +
1.219 +@return iExtendedBootSignature
1.220 +*/
1.221 +inline TInt TFatBootSector::ExtendedBootSignature() const
1.222 + {return iExtendedBootSignature;}
1.223 +/**
1.224 +Returns the unique volume ID
1.225 +
1.226 +@return iUniqueID
1.227 +*/
1.228 +inline TUint32 TFatBootSector::UniqueID() const
1.229 + {return iUniqueID;}
1.230 +/**
1.231 +Returns the volume's label
1.232 +
1.233 +@return A descriptor containing the volume label
1.234 +*/
1.235 +inline const TPtrC8 TFatBootSector::VolumeLabel() const
1.236 + {return TPtrC8(iVolumeLabel,KVolumeLabelSize);}
1.237 +/**
1.238 +Returns the file system type
1.239 +
1.240 +@return A descriptor containing the file system type
1.241 +*/
1.242 +inline const TPtrC8 TFatBootSector::FileSysType() const
1.243 + {return TPtrC8(iFileSysType,KFileSysTypeSize);}
1.244 +/**
1.245 +Returns the boot sector signiture
1.246 +
1.247 +@return KBootSectorSignature
1.248 +*/
1.249 +inline TInt TFatBootSector::BootSectorSignature() const
1.250 + {return KBootSectorSignature;}
1.251 +/**
1.252 +Set the jump instruction
1.253 +*/
1.254 +inline void TFatBootSector::SetJumpInstruction()
1.255 + {iJumpInstruction[0]=0xE9;iJumpInstruction[2]=0x90;}
1.256 +/**
1.257 +Set the vendor ID of the file system that formatted the volume
1.258 +
1.259 +@param aDes Descriptor containing the Vendor ID
1.260 +*/
1.261 +inline void TFatBootSector::SetVendorID(const TDesC8& aDes)
1.262 + {
1.263 + __ASSERT_DEBUG(aDes.Length()<=KVendorIdSize,Fault(EFatBadBootSectorParameter));
1.264 + TPtr8 buf(iVendorId,KVendorIdSize);
1.265 + buf=aDes;
1.266 + }
1.267 +/**
1.268 +Sets the bytes per sector
1.269 +
1.270 +@param aBytesPerSector Number of bytes per sector
1.271 +*/
1.272 +inline void TFatBootSector::SetBytesPerSector(TInt aBytesPerSector)
1.273 + {
1.274 + __ASSERT_DEBUG(!(aBytesPerSector&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
1.275 + iBytesPerSector=(TUint16)aBytesPerSector;
1.276 + }
1.277 +/**
1.278 +Set the sectors per cluster ratio
1.279 +
1.280 +@param aSectorsPerCluster Number of sectors per cluster
1.281 +*/
1.282 +inline void TFatBootSector::SetSectorsPerCluster(TInt aSectorsPerCluster)
1.283 + {
1.284 + __ASSERT_DEBUG(!(aSectorsPerCluster&~KMaxTUint8),Fault(EFatBadBootSectorParameter));
1.285 + iSectorsPerCluster=(TUint8)aSectorsPerCluster;
1.286 + }
1.287 +/**
1.288 +Sets the number of reserved sectors on the volume
1.289 +
1.290 +@param aReservedSectors Number of reserved sectors
1.291 +*/
1.292 +inline void TFatBootSector::SetReservedSectors(TInt aReservedSectors)
1.293 + {
1.294 + __ASSERT_DEBUG(!(aReservedSectors&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
1.295 + iReservedSectors=(TUint16)aReservedSectors;
1.296 + }
1.297 +/**
1.298 +Sets the number of Fats on the volume
1.299 +
1.300 +@param aNumberOfFats Number of fats
1.301 +*/
1.302 +inline void TFatBootSector::SetNumberOfFats(TInt aNumberOfFats)
1.303 + {
1.304 + __ASSERT_DEBUG(!(aNumberOfFats&~KMaxTUint8),Fault(EFatBadBootSectorParameter));
1.305 + iNumberOfFats=(TUint8)aNumberOfFats;
1.306 + }
1.307 +/**
1.308 +Number of entries allowed in the root directory, specific to Fat12/16, zero for FAT32
1.309 +
1.310 +@param aRootDirEntries
1.311 +*/
1.312 +inline void TFatBootSector::SetRootDirEntries(TInt aRootDirEntries)
1.313 + {
1.314 + __ASSERT_DEBUG(!(aRootDirEntries&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
1.315 + iRootDirEntries=(TUint16)aRootDirEntries;
1.316 + }
1.317 +/**
1.318 +Total sectors on the volume, zero for FAT32
1.319 +
1.320 +@param aTotalSectors Total number of sectors
1.321 +*/
1.322 +inline void TFatBootSector::SetTotalSectors(TInt aTotalSectors)
1.323 + {
1.324 + __ASSERT_DEBUG(!(aTotalSectors&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
1.325 + iTotalSectors=(TUint16)aTotalSectors;
1.326 + }
1.327 +/**
1.328 +Set the media descriptor
1.329 +
1.330 +@param aMediaDescriptor
1.331 +*/
1.332 +inline void TFatBootSector::SetMediaDescriptor(TUint8 aMediaDescriptor)
1.333 + {iMediaDescriptor=aMediaDescriptor;}
1.334 +/**
1.335 +Sectors used for the Fat table, zero for FAT32
1.336 +
1.337 +@param aFatSectors Number of Fat sectors
1.338 +*/
1.339 +inline void TFatBootSector::SetFatSectors(TInt aFatSectors)
1.340 + {
1.341 + __ASSERT_DEBUG(!(aFatSectors&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
1.342 + iFatSectors=(TUint16)aFatSectors;
1.343 + }
1.344 +/**
1.345 +Set the sectors per track
1.346 +
1.347 +@param aSectorsPerTrack Number of sectors per track
1.348 +*/
1.349 +inline void TFatBootSector::SetSectorsPerTrack(TInt aSectorsPerTrack)
1.350 + {
1.351 + __ASSERT_DEBUG(!(aSectorsPerTrack&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
1.352 + iSectorsPerTrack=(TUint16)aSectorsPerTrack;
1.353 + }
1.354 +/**
1.355 +Set the number of heads
1.356 +
1.357 +@param aNumberOfHeads Number of heads
1.358 +*/
1.359 +inline void TFatBootSector::SetNumberOfHeads(TInt aNumberOfHeads)
1.360 + {
1.361 + __ASSERT_DEBUG(!(aNumberOfHeads&~KMaxTUint16),Fault(EFatBadBootSectorParameter));
1.362 + iNumberOfHeads=(TUint16)aNumberOfHeads;
1.363 + }
1.364 +/**
1.365 +Set the number of hidden sectors in the volume
1.366 +
1.367 +@param aHiddenSectors Number of hidden sectors
1.368 +*/
1.369 +inline void TFatBootSector::SetHiddenSectors(TUint32 aHiddenSectors)
1.370 + {
1.371 + iHiddenSectors=aHiddenSectors;
1.372 + }
1.373 +/**
1.374 +Set the total sectors in the volume, Used if totalSectors > 65535
1.375 +
1.376 +@param aHugeSectors
1.377 +*/
1.378 +inline void TFatBootSector::SetHugeSectors(TUint32 aHugeSectors)
1.379 + {iHugeSectors=aHugeSectors;}
1.380 +/**
1.381 +Physical drive number, not used in Symbian OS
1.382 +
1.383 +@param aPhysicalDriveNumber Physical drive number
1.384 +*/
1.385 +inline void TFatBootSector::SetPhysicalDriveNumber(TInt aPhysicalDriveNumber)
1.386 + {
1.387 + __ASSERT_DEBUG(!(aPhysicalDriveNumber&~KMaxTUint8),Fault(EFatBadBootSectorParameter));
1.388 + iPhysicalDriveNumber=(TUint8)aPhysicalDriveNumber;
1.389 + }
1.390 +/**
1.391 +Set the reserved byte value
1.392 +
1.393 +@param aReservedByte Value for reserved byte
1.394 +*/
1.395 +inline void TFatBootSector::SetReservedByte(TUint8 aReservedByte)
1.396 + {iReserved=aReservedByte;}
1.397 +/**
1.398 +Set the extended boot signiture
1.399 +
1.400 +@param anExtendedBootSignature The extended boot signiture
1.401 +*/
1.402 +inline void TFatBootSector::SetExtendedBootSignature(TInt anExtendedBootSignature)
1.403 + {
1.404 + __ASSERT_DEBUG(!(anExtendedBootSignature&~KMaxTUint8),Fault(EFatBadBootSectorParameter));
1.405 + iExtendedBootSignature=(TUint8)anExtendedBootSignature;
1.406 + }
1.407 +/**
1.408 +Set the unique volume ID
1.409 +
1.410 +@param anUniqueID Set the unique ID
1.411 +*/
1.412 +inline void TFatBootSector::SetUniqueID(TUint32 anUniqueID)
1.413 + {iUniqueID=anUniqueID;}
1.414 +/**
1.415 +Set the volume's label
1.416 +
1.417 +@param aDes A descriptor containg the volume label
1.418 +*/
1.419 +inline void TFatBootSector::SetVolumeLabel(const TDesC8& aDes)
1.420 + {
1.421 + __ASSERT_DEBUG(aDes.Length()<=KVolumeLabelSize,Fault(EFatBadBootSectorParameter));
1.422 + TPtr8 buf(iVolumeLabel,KVolumeLabelSize);
1.423 + buf=aDes;
1.424 + }
1.425 +/**
1.426 +Set the file system type
1.427 +
1.428 +@param aDes A descriptor containing the file system type
1.429 +*/
1.430 +inline void TFatBootSector::SetFileSysType(const TDesC8& aDes)
1.431 + {
1.432 + __ASSERT_DEBUG(aDes.Length()<=8,Fault(EFatBadBootSectorParameter));
1.433 + TPtr8 buf(iFileSysType,8);
1.434 + buf=aDes;
1.435 + }
1.436 +
1.437 +
1.438 +/**
1.439 +Returns the number of free clusters
1.440 +
1.441 +@return iFreeCount
1.442 +*/
1.443 +inline TUint32 TFSInfo::FreeClusterCount() const
1.444 + {return iFreeCount;}
1.445 +/**
1.446 +Returns the next free cluster
1.447 +
1.448 +@return iNextFree
1.449 +*/
1.450 +inline TUint32 TFSInfo::NextFreeCluster() const
1.451 + {return iNextFree;}
1.452 +/**
1.453 +Sets the number of free clusters
1.454 +
1.455 +@param aFreeCount Number of free clusters
1.456 +*/
1.457 +inline void TFSInfo::SetFreeClusterCount(TUint32 aFreeCount)
1.458 + {iFreeCount = aFreeCount;}
1.459 +/**
1.460 +Sets the next free cluster
1.461 +
1.462 +@param aNextCluster Cluster number of the next free cluster
1.463 +*/
1.464 +inline void TFSInfo::SetNextFreeCluster(TUint32 aNextCluster)
1.465 + {iNextFree = aNextCluster;}
1.466 +
1.467 +#endif //SL_BPB_INL