1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/kernelhwsrv/userlibandfileserver/fileserver/sfat32/inc/sl_bpb.h Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,209 @@
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.h
1.18 +// @file
1.19 +// @internalTechnology
1.20 +//
1.21 +//
1.22 +
1.23 +
1.24 +
1.25 +#ifndef SL_BPB_H
1.26 +#define SL_BPB_H
1.27 +
1.28 +#include "filesystem_fat.h"
1.29 +using FileSystem_FAT::TFatSubType;
1.30 +typedef TFatSubType TFatType;
1.31 +
1.32 +
1.33 +const TInt KVolumeLabelSize =11; ///< Volume lable size
1.34 +const TInt KFileSysTypeSize =8; ///< File system type parameter size
1.35 +const TInt KVendorIdSize =8; ///< Vendor ID parameter size
1.36 +const TInt KBootSectorSignature =0xAA55;///< File system Boot sector signiture
1.37 +const TInt KFat16VolumeLabelPos =43; ///< Position of volume lable in BPB for Fat12/16
1.38 +const TInt KFat32VolumeLabelPos =71; ///< Position of volume lable in BPB for Fat32
1.39 +const TInt KSizeOfFatBootSector = 90; ///< Size in bytes of Boot sector parameter block (BPB)
1.40 +
1.41 +const TUint32 KBootSectorNum =0; ///< Main Boot Sector number (always 0)
1.42 +const TUint32 KFSInfoSectorNum =1; ///< Main FSInfo sector number. This is a default value. The actual value shall be taken from the BPB
1.43 +const TUint32 KReservedBootSectorNum=2; ///< Reserved Boot Sector (always 2)
1.44 +
1.45 +const TUint32 KBkBootSectorNum =6; ///< Backup Boot Sector number (must be 6 by default)
1.46 +const TUint32 KBkFSInfoSectorNum =KBkBootSectorNum+1; ///< Backup FSInfo sector number, follows the backup bpb sector
1.47 +const TUint32 KBkReservedBootSectorNum=KBkBootSectorNum+2; ///< Backup Reserved Boot Sector number, follows the backup FSInfo sector number
1.48 +
1.49 +
1.50 +
1.51 +//-------------------------------------------------------------------------------------------------------------------
1.52 +
1.53 +/**
1.54 +Boot sector parameter block, enables access to all file system parameters.
1.55 +Data is populated at mount time from the BPB sector
1.56 +*/
1.57 +class TFatBootSector
1.58 + {
1.59 +public:
1.60 + //-- simple getters / setters
1.61 + inline const TPtrC8 VendorId() const;
1.62 + inline TUint16 BytesPerSector() const;
1.63 + inline TInt SectorsPerCluster() const;
1.64 + inline TInt ReservedSectors() const;
1.65 + inline TInt NumberOfFats() const;
1.66 + inline TInt RootDirEntries() const;
1.67 + inline TInt TotalSectors() const;
1.68 + inline TUint8 MediaDescriptor() const;
1.69 + inline TInt FatSectors() const;
1.70 + inline TInt SectorsPerTrack() const;
1.71 + inline TInt NumberOfHeads() const;
1.72 + inline TInt HiddenSectors() const;
1.73 + inline TInt HugeSectors() const;
1.74 + inline TInt PhysicalDriveNumber() const;
1.75 + inline TInt ExtendedBootSignature() const;
1.76 + inline TUint32 UniqueID() const;
1.77 + inline const TPtrC8 VolumeLabel() const;
1.78 + inline const TPtrC8 FileSysType() const;
1.79 + inline TInt BootSectorSignature() const;
1.80 + inline TUint32 FatSectors32() const;
1.81 + inline TUint16 FATFlags() const;
1.82 + inline TUint16 VersionNumber() const;
1.83 + inline TUint32 RootClusterNum() const;
1.84 + inline TUint16 FSInfoSectorNum() const;
1.85 + inline TUint16 BkBootRecSector() const;
1.86 +
1.87 + inline void SetJumpInstruction();
1.88 + inline void SetVendorID(const TDesC8& aDes);
1.89 + inline void SetBytesPerSector(TInt aBytesPerSector);
1.90 + inline void SetSectorsPerCluster(TInt aSectorsPerCluster);
1.91 + inline void SetReservedSectors(TInt aReservedSectors);
1.92 + inline void SetNumberOfFats(TInt aNumberOfFats);
1.93 + inline void SetRootDirEntries(TInt aRootDirEntries);
1.94 + inline void SetTotalSectors(TInt aTotalSectors);
1.95 + inline void SetMediaDescriptor(TUint8 aMediaDescriptor);
1.96 + inline void SetFatSectors(TInt aFatSectors);
1.97 + inline void SetSectorsPerTrack(TInt aSectorsPerTrack);
1.98 + inline void SetNumberOfHeads(TInt aNumberOfHeads);
1.99 + inline void SetHiddenSectors(TUint32 aHiddenSectors);
1.100 + inline void SetHugeSectors(TUint32 aTotalSectors);
1.101 + inline void SetPhysicalDriveNumber(TInt aPhysicalDriveNumber);
1.102 + inline void SetReservedByte(TUint8 aReservedByte);
1.103 + inline void SetExtendedBootSignature(TInt anExtendedBootSignature);
1.104 + inline void SetUniqueID(TUint32 anUniqueID);
1.105 + inline void SetVolumeLabel(const TDesC8& aDes);
1.106 + inline void SetFileSysType(const TDesC8& aDes);
1.107 + inline void SetFatSectors32(TUint32 aFatSectors32);
1.108 + inline void SetFATFlags(TUint16 aFATFlags);
1.109 + inline void SetVersionNumber(TUint16 aVersionNumber);
1.110 + inline void SetRootClusterNum(TUint32 aRootCusterNum);
1.111 + inline void SetFSInfoSectorNum(TUint16 aFSInfoSectorNum);
1.112 + inline void SetBkBootRecSector(TUint16 aBkBootRecSector);
1.113 +
1.114 +public:
1.115 + TFatBootSector();
1.116 +
1.117 + void Initialise();
1.118 + TBool IsValid() const;
1.119 + TFatType FatType(void) const;
1.120 +
1.121 + void Internalize(const TDesC8& aBuf);
1.122 + void Externalize(TDes8& aBuf) const;
1.123 + void PrintDebugInfo() const;
1.124 +
1.125 + //-- more advanced API, works for all FAT types
1.126 + TInt FirstFatSector() const;
1.127 + TInt RootDirStartSector() const;
1.128 + TInt FirstDataSector() const;
1.129 +
1.130 + TUint32 VolumeTotalSectorNumber() const;
1.131 + TUint32 TotalFatSectors() const;
1.132 + TUint32 RootDirSectors() const;
1.133 +
1.134 +protected:
1.135 +
1.136 + TUint8 iJumpInstruction[3]; ///< +0 Jump instruction used for bootable volumes
1.137 + TUint8 iVendorId[KVendorIdSize]; ///< +3 Vendor ID of the file system that formatted the volume
1.138 + TUint16 iBytesPerSector; ///< +11/0x0b Bytes per sector
1.139 + TUint8 iSectorsPerCluster; ///< +13/0x0d Sectors per cluster ratio
1.140 + TUint16 iReservedSectors; ///< +14/0x0e Number of reserved sectors on the volume
1.141 + TUint8 iNumberOfFats; ///< +16/0x10 Number of Fats on the volume
1.142 + TUint16 iRootDirEntries; ///< +17/0x11 Number of entries allowed in the root directory, specific to Fat12/16, zero for FAT32
1.143 + TUint16 iTotalSectors; ///< +19/0x13 Total sectors on the volume, zero for FAT32
1.144 + TUint8 iMediaDescriptor; ///< +12/0x15 Media descriptor
1.145 + TUint16 iFatSectors; ///< +22/0x16 Sectors used for the Fat table, zero for FAT32
1.146 + TUint16 iSectorsPerTrack; ///< +24/0x18 Sectors per track
1.147 + TUint16 iNumberOfHeads; ///< +26/0x1a Number of heads
1.148 + TUint32 iHiddenSectors; ///< +28/0x1c Number of hidden sectors in the volume
1.149 + TUint32 iHugeSectors; ///< +32/0x20 Total sectors in the volume, Used if totalSectors > 65535
1.150 + TUint32 iFatSectors32; ///< +36/0x24 Start of additional elements @ offset 36 for FAT32, Sectors in Fat table for 32 bit volume
1.151 + TUint16 iFATFlags; ///< +40/0x28 Fat flags
1.152 + TUint16 iVersionNumber; ///< +42/0x2a Version number of the file system
1.153 + TUint32 iRootClusterNum; ///< +44/0x2c Cluster number of the root directory
1.154 + TUint16 iFSInfoSectorNum; ///< +48/0x30 Sector number containing the FSIInfo structure
1.155 + TUint16 iBkBootRecSector; ///< +50/0x32 Backup boot sector
1.156 + TUint8 iReserved2[12]; ///< +52/0x34 Reserved space, End of Fat32 Only parameters section
1.157 + TUint8 iPhysicalDriveNumber; ///< +64/0x40 Physical drive number, not used in Symbian OS
1.158 + TUint8 iReserved; ///< +65/0x41 Reserved byte
1.159 + TUint8 iExtendedBootSignature; ///< +66/0x42 Extended boot signiture
1.160 + TUint32 iUniqueID; ///< +67/0x43 Unique volume ID
1.161 + TUint8 iVolumeLabel[KVolumeLabelSize]; ///< +71/0x47 The volume's label
1.162 + TUint8 iFileSysType[KFileSysTypeSize]; ///< +82/0x52 File system type
1.163 + };
1.164 +
1.165 +
1.166 +
1.167 +
1.168 +//-------------------------------------------------------------------------------------------------------------------
1.169 +
1.170 +const TUint32 KSizeOfFSInfo = 0x200; ///< Size in bytes of the FSInfo structures
1.171 +const TUint32 KFSInfoReserved1Size= 480; ///< Size of first reserved area in FSInfo
1.172 +const TUint32 KFSInfoReserved2Size= 12; ///< Size of second reserved area in FSInfo
1.173 +
1.174 +/**
1.175 +TFSinfo hold the File system information comprising the free cluster count
1.176 +and next free cluster. It is found in the sector after the BPB and contains
1.177 +several identification signitures along with resverved space. It is not
1.178 +mandatory to support this feature.
1.179 +*/
1.180 +class TFSInfo
1.181 + {
1.182 +
1.183 +public:
1.184 + TFSInfo();
1.185 +
1.186 + void Initialise();
1.187 + TBool IsValid() const;
1.188 + void Internalize(const TDesC8& aBuf);
1.189 + void Externalize(TDes8& aBuf) const;
1.190 + void PrintDebugInfo() const;
1.191 +
1.192 +public:
1.193 +
1.194 + inline TUint32 FreeClusterCount() const;
1.195 + inline TUint32 NextFreeCluster() const;
1.196 +
1.197 + inline void SetFreeClusterCount(TUint32 aFreeCount);
1.198 + inline void SetNextFreeCluster(TUint32 aNextCluster);
1.199 +
1.200 +protected:
1.201 + TUint32 iLeadSig; ///< +0 lead in signature, should always equal 0x41615252
1.202 + TUint8 iReserved1[KFSInfoReserved1Size]; ///< +4 First reserved region of 480 bytes
1.203 + TUint32 iStructureSig; ///< +484/0x1e4 Structure signature, should equal 0x61417272
1.204 + TUint32 iFreeCount; ///< +488/0x1e8 last known free cluster count
1.205 + TUint32 iNextFree; ///< +492/0x1ec hint to file system as to where to start looking for free clusters
1.206 + TUint8 iReserved2[KFSInfoReserved2Size]; ///< +496/0x1f0 Second reserved region of 12 bytes
1.207 + TUint32 iTrainlingSig; ///< +508/0x1fc Trailing Signature (Bytes 510 and 511 = 55 and AA respectively)
1.208 + };
1.209 +
1.210 +
1.211 +
1.212 +#endif //SL_BPB_H