epoc32/include/d32locd.inl
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100 (2010-03-31)
branchSymbian2
changeset 3 e1b950c65cb4
parent 0 061f57f2323e
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     4
// under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// e32\include\d32locd.inl
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
// class RLocalDrive
williamr@2
    19
inline TVersion RLocalDrive::VersionRequired() const
williamr@2
    20
	{ return TVersion(KLocalDriveMajorVersion,KLocalDriveMinorVersion,KLocalDriveBuildVersion); }
williamr@2
    21
/**
williamr@2
    22
@capability TCB
williamr@2
    23
*/
williamr@2
    24
inline TInt RLocalDrive::Connect(TInt aDriveNumber, TBool& aChangedFlag)
williamr@2
    25
	{ return DoCreate(KLitLocalDriveLddName,VersionRequired(),aDriveNumber,NULL,(const TDesC8*)&aChangedFlag,EOwnerProcess); }
williamr@2
    26
inline TInt RLocalDrive::Enlarge(TInt aLength)
williamr@2
    27
	{ return DoControl(EControlEnlarge, (TAny*)aLength); }
williamr@2
    28
inline TInt RLocalDrive::Reduce(TInt aPos, TInt aLength)
williamr@2
    29
	{ return DoControl(EControlReduce, (TAny*)aPos, (TAny*)aLength); }
williamr@2
    30
inline TInt RLocalDrive::Read(TInt64 aPos, TInt aLength, const TAny* aTrg, TInt aMessageHandle, TInt aOffset, TInt aFlags)
williamr@2
    31
	{ TLocalDriveMessageData d(aPos,aLength,aTrg,aMessageHandle,aOffset,aFlags); return DoControl(EControlRead, &d); }
williamr@2
    32
inline TInt RLocalDrive::Read(TInt64 aPos, TInt aLength, const TAny* aTrg, TInt aMessageHandle, TInt anOffset)
williamr@2
    33
	{ TLocalDriveMessageData d(aPos,aLength,aTrg,aMessageHandle,anOffset,0); return DoControl(EControlRead, &d); }
williamr@2
    34
inline TInt RLocalDrive::Read(TInt64 aPos, TInt aLength, TDes8& aTrg)
williamr@2
    35
	{ TLocalDriveMessageData d(aPos,aLength,&aTrg,KLocalMessageHandle,0,ELocDrvMetaData); return DoControl(EControlRead, &d); }
williamr@2
    36
inline TInt RLocalDrive::Write(TInt64 aPos, TInt aLength, const TAny* aSrc, TInt aMessageHandle, TInt aOffset, TInt aFlags)
williamr@2
    37
	{ TLocalDriveMessageData d(aPos,aLength,aSrc,aMessageHandle,aOffset,aFlags); return DoControl(EControlWrite, &d); }
williamr@2
    38
inline TInt RLocalDrive::Write(TInt64 aPos, TInt aLength, const TAny* aSrc, TInt aMessageHandle, TInt anOffset)
williamr@2
    39
	{ TLocalDriveMessageData d(aPos,aLength,aSrc,aMessageHandle,anOffset,0); return DoControl(EControlWrite, &d); }
williamr@2
    40
inline TInt RLocalDrive::Write(TInt64 aPos, const TDesC8& aSrc)
williamr@2
    41
	{ TLocalDriveMessageData d(aPos,aSrc.Length(),&aSrc,KLocalMessageHandle,0,ELocDrvMetaData); return DoControl(EControlWrite, &d); }
williamr@2
    42
inline TInt RLocalDrive::Caps(TDes8& anInfo)
williamr@2
    43
	{ return DoControl(EControlCaps, &anInfo); }
williamr@2
    44
inline TInt RLocalDrive::Format(TInt64 aPos, TInt aLength)
williamr@2
    45
	{ TLocalDriveMessageData d(aPos,aLength,NULL,KLocalMessageHandle,0,0); return DoControl(EControlFormat, &d); }
williamr@2
    46
inline TInt RLocalDrive::ForceMediaChange(TInt aMode)
williamr@2
    47
	{ return DoControl(EControlForceMediaChange, (TAny*)aMode); }
williamr@2
    48
inline void RLocalDrive::NotifyChange(TRequestStatus* aStatus)
williamr@2
    49
	{ *aStatus=KRequestPending; DoControl(EControlNotifyChange, aStatus); }
williamr@2
    50
inline void RLocalDrive::NotifyChangeCancel()
williamr@2
    51
	{ DoControl(EControlNotifyChangeCancel); }
williamr@2
    52
inline TMediaDevice RLocalDrive::MediaDevice()
williamr@2
    53
	{ return (TMediaDevice)DoControl(EControlMediaDevice); }
williamr@2
    54
inline TInt RLocalDrive::SetMountInfo(const TDesC8* aInfo,TInt aMessageHandle)
williamr@2
    55
	{ TLocalDriveMessageData d(0,0,aInfo,aMessageHandle,0,0); return DoControl(EControlSetMountInfo, &d); }
williamr@2
    56
inline TInt RLocalDrive::IsRemovable(TInt& aSocketNum)
williamr@2
    57
	{ return DoControl(EControlIsRemovable,&aSocketNum); }
williamr@2
    58
inline TInt RLocalDrive::ControlIO(TInt aCommand, TAny* aParam1, TAny* aParam2)
williamr@2
    59
	{ TLocalDriveControlIOData d(aCommand,aParam1,aParam2,KLocalMessageHandle); return DoControl(EControlControlIO,&d); }
williamr@2
    60
williamr@2
    61
williamr@2
    62
// RLocalDrive Password Control (Set/Lock/Unlock)
williamr@2
    63
inline TInt RLocalDrive::Unlock(const TDesC8& aPassword, TBool aStorePassword)
williamr@2
    64
	{ TLocalDrivePasswordData d((TDesC8&)aPassword, (TDesC8&)aPassword, aStorePassword); return DoControl(EControlPasswordUnlock, &d); }
williamr@2
    65
inline TInt RLocalDrive::SetPassword(const TDesC8& aOldPassword, const TDesC8& aNewPassword, TBool aStorePassword)
williamr@2
    66
	{ TLocalDrivePasswordData d((TDesC8&)aOldPassword, (TDesC8&)aNewPassword, aStorePassword); return DoControl(EControlPasswordLock, &d); }
williamr@2
    67
inline TInt RLocalDrive::Clear(const TDesC8& aPassword)
williamr@2
    68
	{ TLocalDrivePasswordData d((TDesC8&)aPassword, (TDesC8&)aPassword, EFalse); return DoControl(EControlPasswordClear, &d); }
williamr@2
    69
inline TInt RLocalDrive::ErasePassword()
williamr@2
    70
	{ return DoControl(EControlPasswordErase); }
williamr@2
    71
williamr@2
    72
// RLocalDrive Password Store Control (Read/Write/Length)
williamr@2
    73
inline TInt RLocalDrive::ReadPasswordData(TDesC8& aStoreData)
williamr@2
    74
	{ return DoControl(EControlReadPasswordStore, (TDesC8*)&aStoreData); }
williamr@2
    75
inline TInt RLocalDrive::WritePasswordData(const TDesC8& aStoreData)
williamr@2
    76
	{ return DoControl(EControlWritePasswordStore, (TDesC8*)&aStoreData); }
williamr@2
    77
inline TInt RLocalDrive::PasswordStoreLengthInBytes()
williamr@2
    78
	{ TInt length=0; return DoControl(EControlPasswordStoreLengthInBytes, (TAny*)&length)==KErrNone?length:0; }
williamr@2
    79
williamr@2
    80
inline TInt RLocalDrive::DeleteNotify(TInt64 aPos, TInt aLength)
williamr@2
    81
	{ TLocalDriveMessageData d(aPos,aLength,0,KLocalMessageHandle,0,0); return DoControl(EControlDeleteNotify, &d); }
williamr@2
    82
williamr@2
    83
// Get Last Error Info
williamr@2
    84
inline TInt RLocalDrive::GetLastErrorInfo(TDesC8& aErrorInfo)
williamr@2
    85
	{ return DoControl(EControlGetLastErrorInfo, (TDesC8*)&aErrorInfo); }
williamr@2
    86
williamr@2
    87
williamr@2
    88
inline TLDFormatInfo::TLDFormatInfo()
williamr@2
    89
                     :iCapacity(0),iSectorsPerCluster(0),iSectorsPerTrack(0),iNumberOfSides(0),iFATBits(EFBDontCare),
williamr@2
    90
                     iReservedSectors(0), iFlags(0), iPad(0)
williamr@2
    91
    {
williamr@2
    92
    }
williamr@2
    93
williamr@2
    94
inline TInt64 TLocalDriveCapsV4::MediaSizeInBytes()
williamr@2
    95
	{
williamr@2
    96
	//
williamr@2
    97
	// Return the actual size of the media (as opposed to the partition size)
williamr@2
    98
	//
williamr@2
    99
	// Note : We calculate including iNumPagesPerBlock to maintain compatibility with NAND flash
williamr@2
   100
	//		  where iNumberOfSectors == iNumOfBlocks and iSectorSizeInBytes == iNumBytesMain.
williamr@2
   101
	//		  The local media subsystem sets a default value of iNumPagesPerBlock == 1.
williamr@2
   102
	//
williamr@2
   103
	return(TInt64(iNumberOfSectors) * iSectorSizeInBytes * iNumPagesPerBlock);
williamr@2
   104
	}