--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/userlibandfileserver/fileserver/smassstorage/drivemanager.cpp Thu Dec 17 09:24:54 2009 +0200
@@ -0,0 +1,794 @@
+// Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
+// All rights reserved.
+// This component and the accompanying materials are made available
+// under the terms of the License "Eclipse Public License v1.0"
+// which accompanies this distribution, and is available
+// at the URL "http://www.eclipse.org/legal/epl-v10.html".
+//
+// Initial Contributors:
+// Nokia Corporation - initial contribution.
+//
+// Contributors:
+//
+// Description:
+// Class implementation of CDriveManager and CMassStorageDrive.
+//
+//
+
+/**
+ @file
+ @internalTechnology
+*/
+
+#include <f32fsys.h>
+#include "massstoragedebug.h"
+#include "usbmsshared.h"
+#include "drivemanager.h"
+
+///////////////////////////////////////////////////////////////////////////////
+
+
+/**
+A private structure that, when Connected, holds references to
+the CProxyDrive and the corresponding TBusLocalDrive's Media Changed flag.
+*/
+struct CMassStorageDrive::CLocalDriveRef : public CBase
+ {
+ CLocalDriveRef(CProxyDrive& aProxyDrive, TBool& aMediaChanged)
+ : iProxyDrive(aProxyDrive), iMediaChanged(aMediaChanged), iDriveState(EIdle)
+ {
+ }
+ CProxyDrive& iProxyDrive;
+ TBool& iMediaChanged;
+ /**
+ The Drive Media state machine
+ */
+ TDriveState iDriveState;
+ };
+
+/**
+@param aCritSec A Critical Section object shared by all drives.
+@param aDrives Reference to the list of CMassStorageDrive objects.
+@param aDriveMap Reference to array mapping lun to drive number for supported
+ mass storage drives.
+@post Object is fully constructed
+ */
+CMassStorageDrive::CMassStorageDrive(RCriticalSection& aCritSec,
+ RDriveStateChangedPublisher& aDriveStateChangedPublisher)
+ :
+ iCritSec(aCritSec),
+ iMountState(EDisconnected),
+ iDriveStateChangedPublisher(aDriveStateChangedPublisher)
+ {
+ __FNLOG("CMassStorageDrive::CMassStorageDrive");
+
+ }
+
+CMassStorageDrive::~CMassStorageDrive()
+ {
+ delete iLocalDrive;
+ }
+
+/**
+Read from the target drive unit.
+@return KErrNone on success, otherwise system wide error code
+*/
+TInt CMassStorageDrive::Read(const TInt64& aPos, TInt aLength, TDes8& aBuf, TBool aWholeMedia)
+ {
+ __FNLOG("CMassStorageDrive::Read");
+
+ TInt err = KErrUnknown; // never return this
+ iCritSec.Wait();
+
+ if(iMountState != EConnected)
+ {
+ err = KErrDisconnected;
+ }
+ else
+ {
+ if(aWholeMedia)
+ {
+ err = SafeProxyDrive().Read(aPos, aLength, &aBuf, KLocalMessageHandle, 0, RLocalDrive::ELocDrvWholeMedia);
+ }
+ else
+ {
+ err = SafeProxyDrive().Read(aPos, aLength, aBuf);
+ }
+
+ if(err == KErrNone)
+ {
+#ifndef USB_TRANSFER_PUBLISHER
+ iBytesRead += aBuf.Length();
+ __PRINT1(_L("iBytesRead=%d\n"),iBytesRead);
+#endif
+ }
+
+ else if(err == KErrLocked)
+ {
+ SetDriveState(ELocked);
+ }
+ }
+
+ iCritSec.Signal();
+ return err;
+ }
+
+/**
+Write to the target drive unit.
+@return KErrNone on success, otherwise system wide error code
+*/
+TInt CMassStorageDrive::Write(const TInt64& aPos, TDesC8& aBuf, TBool aWholeMedia)
+ {
+ __FNLOG("CMassStorageDrive::Write");
+
+ TInt err = KErrNone;
+ iCritSec.Wait();
+
+ if (iMountState != EConnected)
+ {
+ err = KErrDisconnected;
+ }
+ else
+ {
+ __ASSERT_DEBUG(iLocalDrive, User::Invariant());
+ TDriveState oldState = iLocalDrive->iDriveState;
+ if(oldState != EActive)
+ {
+ // SCSI hasn't called SetCritical
+ SetDriveState(EActive);
+ }
+
+ if (aWholeMedia)
+ {
+ err = SafeProxyDrive().Write(aPos, aBuf.Length(), &aBuf, KLocalMessageHandle, 0, RLocalDrive::ELocDrvWholeMedia);
+ }
+ else
+ {
+ err = SafeProxyDrive().Write(aPos,aBuf);
+ }
+
+ if (err == KErrNone)
+ {
+#ifndef USB_TRANSFER_PUBLISHER
+ iBytesWritten += aBuf.Length();
+#endif
+ }
+
+ if (err == KErrLocked)
+ {
+ SetDriveState(ELocked);
+ }
+ else if (oldState != EActive)
+ {
+ SetDriveState(oldState);
+ }
+ }
+
+ iCritSec.Signal();
+ return err;
+ }
+
+/**
+Get the capabilities of the target drive unit.
+@return KErrNone on success, otherwise system wide error code
+*/
+TInt CMassStorageDrive::Caps(TLocalDriveCapsV4& aInfo)
+ {
+ __FNLOG("CMassStorageDrive::Caps");
+
+ TInt err = KErrNone;
+ iCritSec.Wait();
+
+ if(iMountState != EConnected)
+ {
+ err = KErrDisconnected;
+ }
+ else
+ {
+ // Initialise in case Caps() fails
+ aInfo.iType = ::EMediaUnknown;
+ err = DoCaps(aInfo);
+
+ __PRINTERR(_L("CheckDriveState: DoCaps err=%d\n"), err);
+
+ if(err == KErrNotReady || (err==KErrNone && aInfo.iType == ::EMediaNotPresent))
+ {
+ __PRINT(_L("CMassStorageDrive::Caps detected MediaNotPresent\n"));
+ SetDriveState(CMassStorageDrive::EMediaNotPresent);
+ }
+ }
+
+ iCritSec.Signal();
+ return err;
+ }
+
+/**
+Provides an interface to CProxyDrive::Caps that hides the
+package buffer.
+@return KErrNone on success, otherwise system wide error code
+@param aInfo
+*/
+TInt CMassStorageDrive::DoCaps(TLocalDriveCapsV4& aInfo)
+ {
+ __FNLOG("CMassStorageDrive::DoCaps");
+
+ TLocalDriveCapsV4Buf buf;
+ buf.FillZ();
+ CProxyDrive& pd = SafeProxyDrive();
+
+ __PRINT(_L("CMassStorageDrive::DoCaps calling Caps\n"));
+ TInt err = pd.Caps(buf);
+
+ __PRINT1(_L("CMassStorageDrive::DoCaps: Caps returned %d\n"), err);
+
+ if(err==KErrNone)
+ {
+ // Invoke function call operator to cast to TLocalDriveCapsV4&
+ aInfo = buf();
+ }
+
+ return err;
+ }
+
+/**
+Publish media error, user should reinsert the memory card.
+Similar to FAT32's TDriver::HandleCriticalError.
+Note: User notification is not implemented, instead we abort and dismount.
+*/
+TInt CMassStorageDrive::HandleCriticalError()
+ {
+ __FNLOG("CMassStorageDrive::HandleCriticalError");
+ iDriveMediaErrorPublisher.PublishError(ETrue);
+ return KErrAbort;
+ }
+
+
+TInt CMassStorageDrive::ClearCriticalError()
+ {
+ iDriveMediaErrorPublisher.PublishError(EFalse);
+ return KErrNone;
+ }
+
+
+/**
+Checks the Media Changed flag, and optionally resets it.
+@return The state of the Media Changed flag.
+@param aReset If true, the Media Changed flag is reset to EFalse.
+*/
+TBool CMassStorageDrive::IsMediaChanged(TBool aReset)
+ {
+ __FNLOG("CMassStorageDrive::IsMediaChanged");
+
+ iCritSec.Wait();
+
+ TBool mediaChanged = EFalse;
+ if(iLocalDrive)
+ {
+ mediaChanged = iLocalDrive->iMediaChanged;
+ if(aReset)
+ {
+ iLocalDrive->iMediaChanged = EFalse;
+ }
+ }
+ else
+ {
+ __PRINT(_L("CMassStorageDrive::IsMediaChanged: no drive\n"));
+ }
+
+ iCritSec.Signal();
+
+ __PRINT1(_L("CMassStorageDrive::IsMediaChanged: returning %d\n"), mediaChanged);
+ return mediaChanged;
+ }
+
+/**
+Set the Drive State to Active or Idle.
+@return KErrNone on success, KErrNotReady if media not present, KErrDisMounted if not mounted
+@param aCritical ETrue for Active, EFalse for Idle
+*/
+TInt CMassStorageDrive::SetCritical(TBool aCritical)
+ {
+ __FNLOG("CMassStorageDrive::SetCritical");
+
+ TInt err = KErrDisMounted;
+
+ iCritSec.Wait();
+
+ if(iLocalDrive)
+ {
+ if(iLocalDrive->iDriveState == CMassStorageDrive::EMediaNotPresent)
+ {
+ err = KErrNotReady;
+ }
+ else
+ {
+ SetDriveState(
+ aCritical
+ ? CMassStorageDrive::EActive
+ : CMassStorageDrive::EIdle );
+
+ err = KErrNone;
+ }
+ }
+
+ iCritSec.Signal();
+
+ return err;
+ }
+
+/**
+Set the mount state
+*/
+TInt CMassStorageDrive::SetMountConnected(CProxyDrive& aProxyDrive, TBool& aMediaChanged)
+ {
+ __FNLOG("CMassStorageDrive::SetMountConnected");
+ CLocalDriveRef* localDrive = NULL;
+
+ __PRINT(_L("SetMountConnected entering critical section\n"));
+ iCritSec.Wait(); // note: signalled in SetMountState
+
+ if (iLocalDrive == NULL)
+ {
+ localDrive = new CLocalDriveRef(aProxyDrive, aMediaChanged);
+ if (localDrive==NULL)
+ {
+ iCritSec.Signal();
+ return KErrNoMemory;
+ }
+ }
+
+ return SetMountState(EConnected, localDrive);
+ }
+
+/**
+@return KErrNone
+@param aNewState
+@param aLocalDrive Only provide this if aNewState is EConnected.
+*/
+TInt CMassStorageDrive::SetMountState(TMountState aNewState, CLocalDriveRef* aLocalDrive/*=NULL*/)
+ {
+ __FNLOG("CMassStorageDrive::SetMountState");
+
+ if(iMountState == aNewState)
+ {
+ __PRINT(_L("SetMountState: No change\n"));
+ }
+ else
+ {
+ // If called from SetMountConnected, already in critical section,
+ // otherwise, must enter it here.
+ if(EConnected!=aNewState)
+ {
+ __PRINT(_L("SetMountState entering critical section\n"));
+ iCritSec.Wait();
+ }
+
+ switch(aNewState)
+ {
+ case EConnected:
+ if(aLocalDrive)
+ {
+ __ASSERT_DEBUG(!iLocalDrive, User::Invariant());
+ iLocalDrive = aLocalDrive;
+ }
+ __ASSERT_DEBUG(iLocalDrive, User::Invariant());
+ break;
+
+ case EDisconnected:
+ delete iLocalDrive;
+ iLocalDrive = NULL;
+#ifndef USB_TRANSFER_PUBLISHER
+ iBytesWritten = iBytesRead = 0;
+#endif
+ break;
+
+ case EDisconnecting:
+ case EConnecting:
+ // Do not change iLocalDrive for these state changes
+ break;
+ }
+
+ iMountState = aNewState;
+ __PRINT1(_L("SetMountState: state=%d\n"), iMountState);
+
+ iDriveStateChangedPublisher.DriveStateChanged();
+
+ iCritSec.Signal();
+ __PRINT(_L("SetMountState has left the critical section\n"));
+ }
+
+ return KErrNone;
+ }
+
+/**
+@return Current drive media state
+*/
+CMassStorageDrive::TDriveState CMassStorageDrive::DriveState() const
+ {
+ return iLocalDrive ? iLocalDrive->iDriveState : EErrDisMounted;
+ }
+
+/**
+Check for media not present, and return the drive state.
+@return Current drive media state
+*/
+CMassStorageDrive::TDriveState CMassStorageDrive::CheckDriveState()
+ {
+ __FNLOG("CMassStorageDrive::CheckDriveState");
+
+ CMassStorageDrive::TDriveState state = EErrDisMounted;
+
+ iCritSec.Wait();
+
+ if (iLocalDrive)
+ {
+ TInt err = KErrGeneral;
+ TLocalDriveCapsV4 caps;
+
+ FOREVER
+ {
+ // Initialise in case Caps() fails
+ caps.iType = ::EMediaNotPresent;
+
+ err = DoCaps(caps);
+ __PRINTERR(_L("CheckDriveState: DoCaps err=%d\n"), err);
+ if (err == KErrNotReady || (err == KErrNone && caps.iType == ::EMediaNotPresent))
+ {
+ __PRINT(_L("CheckDriveState: detected MediaNotPresent\n"));
+
+ SetDriveState(CMassStorageDrive::EMediaNotPresent);
+
+ if (HandleCriticalError() == KErrAbort)
+ break;
+ }
+ else
+ {
+ ClearCriticalError();
+ break;
+ }
+ }
+
+ if (err == KErrNone && caps.iType != ::EMediaNotPresent)
+ {
+ if (iLocalDrive->iDriveState == CMassStorageDrive::EMediaNotPresent)
+ {
+ __PRINT(_L("CheckDriveState: detected media inserted\n"));
+ SetDriveState(CMassStorageDrive::EIdle);
+ }
+ else if (iLocalDrive->iDriveState == CMassStorageDrive::ELocked &&
+ !(caps.iMediaAtt & KMediaAttLocked))
+ {
+ __PRINT(_L("CheckDriveState: detected media unlocked\n"));
+ SetDriveState(CMassStorageDrive::EIdle);
+ }
+ else if (caps.iMediaAtt & KMediaAttLocked)
+ {
+ __PRINT(_L("CheckDriveState: detected media locked\n"));
+ SetDriveState(CMassStorageDrive::ELocked);
+ }
+
+ iWholeMediaAccess = !(caps.iDriveAtt & KDriveAttLogicallyRemovable);
+ }
+
+ // Get the current state
+ state = iLocalDrive->iDriveState;
+ }
+
+ iCritSec.Signal();
+
+ return state;
+ }
+
+static TBool IsActive(CMassStorageDrive::TDriveState aDriveState)
+ {
+ return aDriveState==CMassStorageDrive::EActive;
+ }
+
+/**
+@param aNewState
+*/
+void CMassStorageDrive::SetDriveState(TDriveState aNewState)
+ {
+ __FNLOG("CMassStorageDrive::SetDriveState");
+
+ __ASSERT_DEBUG(aNewState == EIdle ||
+ (iMountState == EConnected && NULL != iLocalDrive) ||
+ (iMountState == EDisconnecting && NULL != iLocalDrive),
+ User::Invariant());
+
+ if(!iLocalDrive)
+ {
+ __PRINT(_L("SetDriveState: Drive not mounted.\n"));
+ }
+ else
+ {
+ __PRINT2(_L("SetDriveState: %d->%d\n"), iLocalDrive->iDriveState, aNewState);
+
+ if(iLocalDrive->iDriveState != aNewState)
+ {
+ CMountCB* mount = SafeProxyDrive().Mount();
+#if !defined(USBMSDRIVE_TEST)
+ __ASSERT_DEBUG(mount != NULL, User::Invariant());
+#endif
+ if(mount)
+ {
+ if(!IsActive(iLocalDrive->iDriveState) && IsActive(aNewState))
+ {
+ mount->IncLock();
+ }
+ else if(IsActive(iLocalDrive->iDriveState) && !IsActive(aNewState))
+ {
+ mount->DecLock();
+ }
+ __PRINT1(_L("SetDriveState: LockStatus=%d\n"), mount->LockStatus());
+ }
+
+ iLocalDrive->iDriveState = aNewState;
+
+ iDriveStateChangedPublisher.DriveStateChanged();
+ }
+ }
+ }
+
+/**
+Accessor for iProxyDrive; asserts if NULL
+*/
+CProxyDrive& CMassStorageDrive::SafeProxyDrive() const
+ {
+ __ASSERT_ALWAYS(NULL!=iLocalDrive, User::Invariant());
+ return iLocalDrive->iProxyDrive;
+ }
+
+/////////////////////////////////////////////////////////////////
+
+/**
+Construct a CDriveManager object.
+@param aDriveMap Reference to array mapping lun to drive number for supported
+ mass storage drives.
+*/
+CDriveManager* CDriveManager::NewL(TRefDriveMap aDriveMap)
+ {
+ __FNLOG("CDriveManager::NewL");
+ __PRINT1(_L("CDriveManager::NewL - %d drives\n"), aDriveMap.Count());
+
+ CDriveManager* self = new (ELeave) CDriveManager(aDriveMap);
+ CleanupStack::PushL(self);
+ self->ConstructL();
+ CleanupStack::Pop();
+ return self;
+ }
+
+CDriveManager::CDriveManager(const RArray<TInt>& aDriveMap)
+ : iDriveMap(aDriveMap)
+ {}
+
+/**
+Construct a CDriveManager object.
+*/
+void CDriveManager::ConstructL()
+ {
+ __FNLOG("CDriveManager::ConstructL");
+
+ User::LeaveIfError(iDriveCritSec.CreateLocal());
+
+ iDriveStateChangedPublisher = new (ELeave) RDriveStateChangedPublisher(iDrives, iDriveMap);
+
+ for(TInt i = 0; i < iDriveMap.Count(); i++)
+ {
+ iDrives[i] = new (ELeave) CMassStorageDrive(iDriveCritSec, *iDriveStateChangedPublisher);
+ }
+
+ // Publish initial drive state
+ if (iDriveMap.Count() > 0)
+ {
+ iDriveStateChangedPublisher->DriveStateChanged();
+ }
+ }
+
+/**
+Destructor
+*/
+CDriveManager::~CDriveManager()
+ {
+ __FNLOG("CDriveManager::~CDriveManager");
+
+ iDrives.DeleteAll();
+ delete iDriveStateChangedPublisher;
+ iDriveCritSec.Close();
+ }
+
+/**
+Set the mount state to Connected and specify the Proxy Drive.
+@return KErrNone on success, otherwise system wide error code
+@param aDrive The mounted Proxy Drive
+@param aLun The Logical Drive Unit identifier (0..numDrives-1)
+@pre If the Mount State is Connected, then aDrive must be the
+ same as it was the last time this function was called.
+@post The Mount State will be Connected.
+*/
+TInt CDriveManager::RegisterDrive(CProxyDrive& aProxyDrive, TBool& aMediaChanged, TUint aLun)
+ {
+ __FNLOG("CDriveManager::RegisterDrive");
+ __PRINT1(_L("Lun=%d \n"),aLun);
+ TInt err = KErrUnknown; // never return this
+ CMassStorageDrive* drive = CDriveManager::Drive(aLun, err);
+ if(drive)
+ {
+ drive->SetMountConnected(aProxyDrive, aMediaChanged);
+ }
+
+ __PRINT1(_L("CDriveManager::RegisterDrive err=%d\n"), err);
+ return err;
+ }
+
+/**
+Set the mount state to Disconnected.
+@return KErrNone on success, otherwise system wide error code
+@param aLun The Logical Drive Unit identifier (0..numDrives-1)
+@post The Mount State will be Disconnected.
+*/
+TInt CDriveManager::DeregisterDrive(TUint aLun)
+ {
+ __FNLOG("CDriveManager::DeregisterDrive");
+
+ TInt err = KErrUnknown; // never return this
+ if(CMassStorageDrive* drive = Drive(aLun, err))
+ {
+ err = drive->SetMountDisconnected();
+ }
+
+ __PRINT1(_L("CDriveManager::DeregisterDrive err=%d\n"), err);
+ return err;
+ }
+
+/**
+Return a pointer to the drive specified aLun, or NULL if
+aLun is invalid.
+
+@return Pointer to the specified drive, or NULL.
+@param aLun The Logical Drive Unit identifier (0..numDrives-1)
+@param aError KErrNone on success, KErrArgument if NULL is returned.
+*/
+CMassStorageDrive* CDriveManager::Drive(TUint aLun, TInt& aError) const
+ {
+ aError = KErrNone;
+ CMassStorageDrive* drive = NULL;
+
+ // Check if aLun exceeds the specified number of drives
+ // (This will panic if it exceeds KMaxLun).
+ if(aLun>=KUsbMsMaxDrives || !iDrives[aLun])
+ {
+ aError = KErrArgument;
+ }
+ else
+ {
+ drive = iDrives[aLun];
+ }
+ return drive;
+ }
+
+/**
+Checks the Media Changed flag, and optionally resets it.
+@return The state of the Media Changed flag.
+@param aLun The Logical Drive Unit identifier (0..numDrives-1)
+@param aReset If true, the Media Changed flag is reset to EFalse.
+*/
+TBool CDriveManager::IsMediaChanged(TUint aLun, TBool aReset)
+ {
+ __FNLOG("CDriveManager::IsMediaChanged");
+
+ TInt err; // not used, but is a required parameter
+ CMassStorageDrive* drive = Drive(aLun, err);
+
+ if(!drive)
+ {
+ __PRINT1(_L("CDriveManager::IsMediaChanged: LUN=%d not found, returning false\n"), aLun);
+ return ETrue;
+ }
+ else
+ {
+ return drive->IsMediaChanged(aReset);
+ }
+ }
+
+/**
+Set the Drive State to Active or Idle.
+Ref: 3.6.3.2 - PREVENT_MEDIUM_REMOVAL
+@return KErrNone on success, otherwise system wide error code
+@param aLun The Logical Drive Unit identifier (0..numDrives-1)
+@param aCritical ETrue for Active, EFalse for Idle
+*/
+TInt CDriveManager::SetCritical(TUint aLun, TBool aCritical)
+ {
+ __FNLOG("CDriveManager::SetCritical");
+
+ TInt err = KErrUnknown; // never return this
+
+ TInt i=aLun;
+ TInt cnt=aLun+1;
+
+ if (aLun == KAllLuns)
+ {
+ i=0;
+ cnt= iDriveMap.Count();
+ }
+
+ for(; i<cnt; i++)
+ {
+
+ CMassStorageDrive* drive = Drive(i, err);
+ if(drive)
+ {
+ err = drive->SetCritical(aCritical);
+ }
+ }
+ return err;
+ }
+
+/**
+Inititiate transition to Connected.
+@return KErrNone on success, otherwise system wide error code
+@param aLun The Logical Drive Unit identifier (0..numDrives-1)
+@post The Mount State will be Connected or Connecting.
+*/
+TInt CDriveManager::Connect(TUint aLun)
+ {
+ __FNLOG("CDriveManager::Connect");
+
+ TInt err = KErrUnknown; // never return this
+ CMassStorageDrive* drive = Drive(aLun, err);
+
+ __PRINT3(_L("CDriveManager::Connect lun=%d, err=%d, mountState=%d\n"), aLun, err, drive->MountState());
+
+ if(drive)
+ {
+ switch(drive->MountState())
+ {
+ case CMassStorageDrive::EDisconnected:
+ err = drive->SetMountConnecting();
+ break;
+ case CMassStorageDrive::EDisconnecting:
+ err = drive->SetMountConnected();
+ break;
+ case CMassStorageDrive::EConnected:
+ case CMassStorageDrive::EConnecting:
+ // do nothing
+ break;
+ }
+ }
+ return err;
+ }
+
+/**
+Inititiate transition to Disconnected.
+@return KErrNone on success, otherwise system wide error code
+@param aLun The Logical Drive Unit identifier (0..numDrives-1)
+@post The Mount State will be Disconnected or Disconnecting.
+*/
+TInt CDriveManager::Disconnect(TUint aLun)
+ {
+ __FNLOG("CDriveManager::Disconnect");
+
+ TInt err = KErrUnknown; // never return this
+ CMassStorageDrive* drive = Drive(aLun, err);
+
+ if(drive)
+ {
+ switch(drive->MountState())
+ {
+ case CMassStorageDrive::EConnected:
+ err = drive->SetMountDisconnecting();
+ break;
+ case CMassStorageDrive::EConnecting:
+ err = drive->SetMountDisconnected();
+ break;
+ case CMassStorageDrive::EDisconnected:
+ case CMassStorageDrive::EDisconnecting:
+ // do nothing
+ break;
+ }
+ }
+ return err;
+ }
+
+