sl@0: // Copyright (c) 1995-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: //
sl@0: //  Collection of common constants, utility functions, etc. for the file server and file systems.
sl@0: //  Definitions here must be filesystem-agnostic, i.e. generic enougs to be used by every file system
sl@0: //
sl@0: //  This is the internal file and must not be exported.
sl@0: 
sl@0: /**
sl@0:     @file
sl@0:     @internalTechnology
sl@0: */
sl@0: 
sl@0: #if !defined(__FILESYSTEM_UTILS_H__)
sl@0: #define __FILESYSTEM_UTILS_H__
sl@0: 
sl@0: #if !defined(__E32BASE_H__)
sl@0: #include <e32base.h>
sl@0: #endif
sl@0: 
sl@0: //#######################################################################################################################################
sl@0: //#   constants definitions
sl@0: //#######################################################################################################################################
sl@0: 
sl@0: const TUint KBitsInByteLog2 = 3;
sl@0: const TUint KBitsInByte = 1<<KBitsInByteLog2;
sl@0: 
sl@0: 
sl@0: const TUint16 K1KiloByteLog2 = 10;
sl@0: const TUint32 K1KiloByte = 1<<K1KiloByteLog2; 
sl@0: const TUint32 K1MegaByte = 1<<20; 
sl@0: 
sl@0: const TUint32 K1uSec = 1;               ///< 1 misrosecond in TTimeIntervalMicroSeconds32
sl@0: const TUint32 K1mSec = 1000;            ///< 1 millisecond in TTimeIntervalMicroSeconds32
sl@0: const TUint32 K1Sec  = 1000*K1mSec;     ///< 1 second in TTimeIntervalMicroSeconds32
sl@0: 
sl@0: //---------------------------------------------------------------------------------------------------------------------------------------
sl@0: 
sl@0: const TUint KDefSectorSzLog2=9;                         ///< Log2 of the default sector size for the media 
sl@0: const TUint KDefaultSectorSize = 1 << KDefSectorSzLog2; ///< Default sector size for the media, 512 bytes
sl@0: 
sl@0: //#######################################################################################################################################
sl@0: //#   some useful utility functions
sl@0: //#######################################################################################################################################
sl@0: 
sl@0: inline TUint32 Pow2(TUint32 aVal);          //-- return 2^aVal
sl@0: inline TUint32 Pow2_32(TUint32 aVal);       //-- return 2^aVal
sl@0: inline TUint64 Pow2_64(TUint32 aVal);       //-- return 2^aVal
sl@0: 
sl@0: inline TBool IsPowerOf2(TUint32 aVal);      //-- return ETrue if aVal is a power of 2 
sl@0: inline TBool IsPowerOf2_64(TUint64 aVal);   //-- return ETrue if aVal is a power of 2 
sl@0: 
sl@0: inline TUint32 RoundDown(TUint32 aVal, TUint32 aGranularityLog2);
sl@0: inline TUint32 RoundUp(TUint32 aVal, TUint32 aGranularityLog2);
sl@0: 
sl@0: inline TBool BoolXOR(TBool a1, TBool a2);           //-- return Boolean XOR of a1 and a2
sl@0: 
sl@0: inline TUint32 Log2_inline(TUint32 aVal);           //-- Calculates the Log2(aVal)
sl@0: TUint32 Log2(TUint32 aVal);                         //-- Calculates the Log2(aVal)
sl@0: 
sl@0: inline TUint32 Count1Bits_inline(TUint32 aVal);     //-- counts number of '1' bits in the aVal
sl@0: TUint32 Count1Bits(TUint32 aVal);                   //-- counts number of '1' bits in the aVal
sl@0: 
sl@0: //-----------------------------------------------------------------------------
sl@0: 
sl@0: TPtrC RemoveTrailingDots(const TDesC& aName); //-- Removes trailing dots from aName. "Name..." -> "Name"
sl@0: 
sl@0: 
sl@0: //#######################################################################################################################################
sl@0: /**
sl@0:     A class representing a simple abstraction of the 32 bit flags
sl@0: */
sl@0: class T32Bits
sl@0: {
sl@0:  public:
sl@0:     T32Bits() : iData(0) {}
sl@0: 
sl@0:     inline void  Clear();
sl@0:     inline TBool HasBitsSet() const;
sl@0:     inline void SetBit(TUint32 aIndex);
sl@0:     inline TBool operator[](TUint32 aIndex) const;
sl@0: 
sl@0:  private:
sl@0:     TUint32 iData; ///< 32 bits data
sl@0: };
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: #include "filesystem_utils.inl"
sl@0: 
sl@0: 
sl@0: #endif //__FILESYSTEM_UTILS_H__
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: 
sl@0: