FCL/sf/os/kernelhwsrv: comparison kernel/eka/include/drivers/mmc.h

equal deleted inserted replaced

-:48e57fb1237e
+:ddfd5aa0d58f
-// Copyright (c) 1999-2009 Nokia Corporation and/or its subsidiary(-ies).
+// Copyright (c) 1999-2010 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".
 //
 // Contributors:
 //
 // Description:
 // Generic MMC controller types and standard classes for MMC manipulation
-// This controller follows MMC spec V2.1
+// This controller follows MMC spec V4.4+
 //
 //
 /**
 @file
 #if !defined(__MMC_H__)
 #define __MMC_H__
 #include <drivers/pbus.h>
 #include <d32locd.h>
+#include <drivers/rpmbpacket.h>
 // MMC Card maximum system settings
 const TInt KMaxMmcSockets = KMaxPBusSockets;
 class TMMCMachineInfo;
 class TMapping;
 class TMMCPasswordStore;
 class TMMCEraseInfo;
 class TMMCMachineInfoV4;
+class TMMCMachineInfoV44;
+typedef TPckg<TMMCMachineInfo> TMMCardMachineInfoPckg;
 typedef TPckg<TMMCMachineInfoV4> TMMCMachineInfoV4Pckg;
+typedef TPckg<TMMCMachineInfoV44> TMMCMachineInfoV44Pckg;
 enum TMMCAppCommand {EMMCNormalCmd,EMMCApplicationCmd};
 // Typedefs
 @see KMMCErrAll
 @see KMMCErrBasic
 */
 typedef TUint32 TMMCErr;
-//		MMC Enums and inline functions
+/**
+A structure to define global parameters for the initialisation of an RPMB object.
+This is required for devices with emmc4.4+
+@internalComponent
+*/
+struct TRpmbDeviceParms
+{
+DMMCSocket* iSocketPtr;
+TUint iCardNumber;
+};
+/*
+Global counter for number or RPMB partitions. Only one partition per device
+*/
+GLREF_D TUint NumberOfRpmbs;
+/*
+Global holder for RPMB parameters
+*/
+GLREF_D TRpmbDeviceParms TheRpmbs[KMaxPBusSockets*4];
+GLREF_D TBool RpmbParmsPopulated;
+/**
+Max number of RPMB devices
+*/
+const TUint MaxIndexRpmb = 0;
+/**
+MMC Enums and inline functions
+*/
 /**
 @publishedPartner
 @released
 	ERespTypeR5,			// 32 bits IRQ
 	ERespTypeR6,
 	ERespTypeR7				// not currently defined for MMC
 	};
+/**
+* Client InterfaceIDs for GetExtInterface
+* @publishedPartner
+*
+*/
+enum TMMCExtInterfaceId
+{
+KInterfaceRpmb
+};
+class MMCMExtInterface
+{
+public:
+virtual TInt Func() = 0;
+};
+/**
+Interface class to return information for an RPMB capable device.
+Used for emmc v4.4+
+*/
+class MRpmbInfo
+{
+public:
+virtual inline TInt RpmbInfo(TUint aDeviceIndex, TRpmbDeviceParms& aParams);
+};
+/**
+A generic adapter function for returning an interface of specified type
+The caller should set aInterfacePtr to NULL before calling
+@aInterfaceId Denotes the required interface to be returned
+@aInterfacePtr On completion contains an interface of type specified by aInterfaceId
+@aThis Extends the interface to provide further access to DMMCSession
+*/
+IMPORT_C TInt MMCGetExtInterface(TMMCExtInterfaceId aInterfaceId, MMCMExtInterface*& aInterfacePtr, TAny* aThis = NULL);
 /**
 @publishedPartner
 @released
 	ECIMWriteIO				 =12,
 	ECIMLockUnlock			 =13,
 	ECIMLockStack			 =14,
 	ECIMInitStackAfterUnlock =15,
 	ECIMAutoUnlock			 =16,
-	ECIMSleep				 =17
+	ECIMSleep				 =17,
+ECIMRpmbAccess           =18
 	};
-const TUint KMMCMaxSessionTypeNumber  = 18;
+const TUint KMMCMaxSessionTypeNumber  = 19;
 const TUint KMMCMinCustomSession	  = 1024;
 const TUint KMMCCmdDirDirBitPosition=	KBit0;			//fixed - dont change it
 const TUint KMMCCmdDirIndBitPosition=	(KBit5-KBit0);	//fixed - dont change it
 const TUint KMMCCmdDirWBitArgument=		KBit5;
 const TUint KMMCCmdDirNegate=			KBit6;
 const TUint KMMCCmdDirWBitDirect=		KBit7;
 const TUint KMMCCmdReliableWrite	=	KBit31;
+const TUint KMMCCmdTrim             =   KBit0;			//Trim command arg
 /**
 @publishedPartner
 @released
 class TExtendedCSD
 /**
 	Extended CSD register class.
 	For more information about this register, see the MultimediaCard System
-	Specification, Version 4.1+
+	Specification, Version 4.4
 	@publishedPartner
 	@released
 */
 	{
 		EHighSpeedInterfaceTimingIndex = 185,
 		/** Offset of the BUS_WIDTH field */
 		EBusWidthModeIndex = 183,
 		/** Offset of the BOOT_CONFIG field */
 		EBootConfigIndex = 179,
+/** Offset of the BOOT_CONFIG_PROT field */
+EBootConfigProtectionIndex = 178,
 		/** Offset of the BOOT_BUS_WIDTH field */
 		EBootBusWidthIndex = 177,
 		/** Offset of the ERASE_GROUP_DEF field */
-		EEraseGroupDefIndex = 175
+		EEraseGroupDefIndex = 175,
+/** Offset of the BOOT_WP field */
+EBootAreaWriteProtectionIndex = 173,
+/** Offset of the USER_WP field */
+EUserAreaWriteProtectionIndex = 171,
+/** Offset of the FW_CONFIG field */
+EFwConfigIndex = 169,
+/** Offset of the RST_n_FUNCTION field */
+EHardwareResetFunctionIndex = 162,
+/** Offset of the PARTITIONS_ATTRIBUTE field */
+EPartitionsAttributeIndex = 156,
+/** Offset of the PARTITION_SETTING_COMPLETED field */
+EPartitionSettingIndex = 155,
+/** Offset of the GP_SIZE_MULT field */
 		};
 	/**
 	This enum defines various field offsets into the Properties Segment (i.e.
 	the read-only part) of the Extended CSD register.
 		/** Offset of the ACC_SIZE field */
 		EAccessSizeIndex = 225,
 		/** Offset of the HC_ERASE_GRP_SIZE field */
 		EHighCapacityEraseGroupSizeIndex = 224
 		};
+	/**	This enum defines the values for the Extended CSD Revision register	*/
+	enum TExtendedCSDRev
+		{
+		EExtendedCSDRev1_0 = 0,
+		EExtendedCSDRev1_1 = 1,
+		EExtendedCSDRev1_2 = 2,
+		EExtendedCSDRev1_3 = 3,
+		EExtendedCSDRev1_4 = 4,
+		EExtendedCSDRev1_5 = 5
+		};
 	/** This enum defines the bus width encoding used by the BUS_WIDTH field */
 	enum TExtCSDBusWidths
 		{
 		EExtCsdBusWidth1 = 0x00,
 		};
 	/**
 	This enum defines the boot config encoding used by the BOOT_CONFIG field
 	*/
-	enum TExtCSDBootConfig
+	enum TExtCSDBootConfig // in v4.4 this is now called PARTITION_CONFIG
 		{
 		ESelectUserArea	 				= 0x00,
 		ESelectBootPartition1 			= 0x01,
 		ESelectBootPartition2 			= 0x02,
+		ESelectRPMB						= 0x03, // R/W Replay Protected Memory Block (RPMB)
+		ESelectGPAPartition1			= 0x04, // Access to General Purpose Area partition 1
+		ESelectGPAPartition2			= 0x05, // Access to General Purpose Area partition 2
+		ESelectGPAPartition3 			= 0x06, // Access to General Purpose Area partition 3
+		ESelectGPAPartition4 			= 0x07, // Access to General Purpose Area partition 4
 		EEnableBootPartition1forBoot 	= 0x08,
 		EEnableBootPartition2forBoot 	= 0x10,
 		EEnableUserAreaforBoot			= 0x38,
-		EEnableBootAck  				= 0x40
+		EEnableBootAck  				= 0x40,
+		EPartitionTestMode              = 0x100 // Indicates test mode for eMMC partitions
 		};
 	/**
 	This enum defines the Boot Bus Width encoding used by the BOOT_BUS_WIDTH field
 	*/
 	inline TUint BootInfo() const;
 	/** returns the contents of the BOOT_SIZE_MUTLI field */
 	inline TUint BootSizeMultiple() const;
+	/** returns the size of the boot partitions in sectors */
+	inline TUint32 BootSizeInSectors() const;
 	/** returns the contents of the ERASE_TIMEOUT_MULT field */
 	inline TUint EraseTimeoutMultiple() const;
 	/** returns the contents of the REL_WR_SEC_C field */
 	inline TUint ReliableWriteSector() const;
 	inline TUint SleepAwakeTimeout() const;
 	/** returns True if the CARD_TYPE field conatains a valid value **/
 	inline TBool IsSupportedCardType() const;
+/** returns the contents of the ERASED_MEM_CONT field */
+inline TUint ErasedMemoryContent() const;
+/** returns the contents of the BOOT_CONFIG_PROT field */
+inline TUint BootConfigProt() const;
+/** returns the contents of the BOOT_WP field */
+inline TUint BootAreaWriteProtectionReg() const;
+/** returns the contents of the USER_WP field */
+inline TUint UserAreaWriteProtectionReg() const;
+/** returns the contents of the FW_CONFIG field */
+inline TUint FwConfiguration() const;
+/** returns the RPMB size based on contents of the RPMB_SIZE_MULT field */
+inline TUint32 RpmbSize() const;
+/** returns the RPMB size in sectors */
+inline TUint32 RpmbSizeInSectors() const;
+/** returns the contents of the RST_n_FUNCTION field */
+inline TUint HwResetFunction() const;
+/** returns the contents of the PARTITIONING_SUPPORT field */
+inline TUint PartitioningSupport() const;
+/** returns the Max Enhanced Area Size base on the contents of the
+MAX_ENH_SIZE_MULT field */
+inline TUint32 MaxEnhancedAreaSize() const;
+/** returns the contents of the PARTITIONS_ATTRIBUTE field */
+inline TUint PartitionsAttribute() const;
+/** returns the contents of the PARTITION_SETTING_COMPLETED field */
+inline TUint PartitioningSetting() const;
+/** returns the General purpose partition sizes based on contents of the
+GP_SIZE_MULT fields */
+inline TUint64 GeneralPurposePartition1Size() const;
+inline TUint64 GeneralPurposePartition2Size() const;
+inline TUint64 GeneralPurposePartition3Size() const;
+inline TUint64 GeneralPurposePartition4Size() const;
+/** returns the General Purpose Partition sizes in sectors */
+inline TUint32 GeneralPurposePartition1SizeInSectors() const;
+inline TUint32 GeneralPurposePartition2SizeInSectors() const;
+inline TUint32 GeneralPurposePartition3SizeInSectors() const;
+inline TUint32 GeneralPurposePartition4SizeInSectors() const;
+/** returns the Enhanced User Data Area Size based on thec contents of the
+ENH_SIZE_MULT fields */
+inline TUint64 EnhancedUserDataAreaSize() const;
+/** returns the Enhanced User Data Start Address based on the contents of
+the ENH_START_ADDR fields */
+inline TUint32 EnhancedUserDataStartAddress() const;
+/** returns the contents of the SEC_BAD_BLK_MGMNT field */
+inline TUint BadBlockManagementMode() const;
 private:
+inline TUint64 PartitionSize(TUint8 aMult0, TUint8 aMult1, TUint8 aMult2, TUint32 aMultiplier) const;
 	/**
 	@internalComponent little endian 512 byte field representing extended CSD
 	*/
 	TUint8 iData[KMMCExtendedCSDLength];
 	};
+const TInt KMMCSelectPartitionMask		= KBit0 | KBit1 | KBit2;
 //	32 bit MMC card status field (response R1)
 const TUint32 KMMCStatAppCmd=			KBit5;
 const TUint32 KMMCStatSwitchError=		KBit7;
 const TUint32 KMMCStatErrBlockLenError=	KBit29;
 const TUint32 KMMCStatErrAddressError=	KBit30;
 const TUint32 KMMCStatErrOutOfRange=	KBit31;
 const TUint32 KMMCStatErrorMask=		KMMCStatErrOutOfRange	|
+										KMMCStatSwitchError		|
 										KMMCStatErrAddressError	|
 										KMMCStatErrBlockLenError|
 										KMMCStatErrEraseSeqError|
 										KMMCStatErrEraseParam	|
 										KMMCStatErrWPViolation	|
 const TUint32 KMMCCmdFlagBlockAddress=	KBit5;	// Block addressing mode
 const TUint32 KMMCCmdFlagDMARamValid=   KBit6;  // Memory is DMA'able flag
 const TUint32 KMMCCmdFlagDoubleBuffer=  KBit7;  // The current DT command is double-buffered
 const TUint32 KMMCCmdFlagPhysAddr=		KBit8;  // Address is a physical address
 const TUint32 KMMCCmdFlagReliableWrite=	KBit9;  // Current command is Reliable Write
+const TUint32 KMMCCmdFlagDeleteNotify=  KBit10; // Current command is Delete Notify
+const TUint32 KMMCCmdFlagRpmbIO=        KBit11; // Current command is of RPMB type
 const TUint32 KMMCCmdFlagASSPFlags=	KMMCCmdFlagBytesValid	|
 									KMMCCmdFlagTransStopped	|
 									KMMCCmdFlagStatusReceived;
 	// Data transfer macros setup (block mode)
 	inline void SetupCIMReadBlock(TMMCArgument aBlockAddr, TUint8* aMemoryP, TUint32 aBlocks = 1);
 	inline void SetupCIMWriteBlock(TMMCArgument aBlockAddr, TUint8* aMemoryP, TUint32 aBlocks = 1);
 	inline void SetupCIMEraseMSector(TMMCArgument aBlockAddr, TUint32 aBlocks = 1);
 	inline void SetupCIMEraseMGroup(TMMCArgument aBlockAddr, TUint32 aBlocks = 1);
+	// RPMB access macros setup
+	inline void SetupRpmbSendRequest(TBool aSetReliableWrite);
+inline void SetupRpmbReceiveResponse();
+inline void SetupRpmbSendReadResultRegisterRequest();
 	// Raw commands (must be used in the locked bus state only)
 	// Known commands with or without (with a default) argument
 	IMPORT_C void SetupCommand(TMMCCommandEnum aCommand, TMMCArgument anArgument=0);
 	IMPORT_C void FillCommandArgs(TMMCArgument anArgument, TUint32 aLength, TUint8* aMemoryP, TUint32 aBlkLen);
 	inline TMMCCommandDesc& Command();	// The current command descriptor
 	inline void PushCommandStack();
 	inline void PopCommandStack();
+	inline void SetPartition(TInt aPartition);
+	inline TInt Partition() const;
 	// Methods for double-buffered data transfer:
 	inline TBool RequestMoreData();
 	inline void EnableDoubleBuffering(TUint32 aNumBlocks);							  /**< @internalTechnology */
 	inline void SetDataTransferCallback(TMMCCallBack& aCallback);					  /**< @internalTechnology */
 	TMMCCommandDesc iCommand[KMaxMMCCommandStackDepth];	// Command stack
 	TMMCCallBack iDataTransferCallback;	// A callback function, used to request more data when performing double-buffering
-	TUint32 iSpare[21];				// Spare data (stolen from iCommand)
+	TUint32 iSpare[20];					// Spare data (stolen from iCommand)
+	TUint32 iPartition;					// The targetted partition
 	TMMCard* iSavedCardP;			// Saved copy of iCardP
 	TMMCStateMachine iMachine;		// State Machine context
 #ifdef __EPOC32__
 	NTimer iPollTimer;
 	inline   TMMCErr RetryGapTimerSM();
 	static   TMMCErr ProgramTimerSMST(TAny *aStackP);
 	inline   TMMCErr ProgramTimerSM();
 	static   TMMCErr GoIdleSMST(TAny* aStackP);
 	inline	 TMMCErr GoIdleSM();
+	static   TMMCErr SwitchPartitionSMST(TAny* aStackP);
+	inline	 TMMCErr SwitchPartitionSM();
 	static   TMMCErr SwitchToLowVoltageSMST(TAny* aStackP);
 	static   TMMCErr DoWakeUpSMST(TAny* aStackP);
 	static   TMMCErr LowVoltagePowerupTimerSMST(TAny *aStackP);
 	TMMCErr LowVoltagePowerupTimerSM();
 	static   TMMCErr ExecBusTestSMST(TAny* aStackP);
 	inline	 TMMCErr ExecBusTestSM();
+	static TMMCErr CIMRpmbAccessSMST(TAny* aStackP);
+TMMCErr CIMRpmbAccessSM();
+	static TMMCErr  CIMRpmbWriteAuthenticationKeySMST(TAny* aStackP);
+TMMCErr CIMRpmbWriteAuthenticationKeySM();
+	static TMMCErr CIMRpmbReadWrCounterSMST(TAny* aStackP);
+TMMCErr CIMRpmbReadWrCounterSM();
+	static TMMCErr CIMRpmbWriteSMST(TAny* aStackP);
+TMMCErr CIMRpmbWriteSM();
+	static TMMCErr CIMRpmbReadSMST(TAny* aStackP);
+TMMCErr CIMRpmbReadSM();
 	enum TBusWidthAndClock
 		{
 		E1Bit20Mhz  = 0x0000,
 	TMMCStackConfig iMasterConfig;
 	friend class DMMCSocket;
 	friend class DMMCSession;
 	friend class TMMCardArray;
-private:
-//
-// Dummy functions to maintain binary compatibility
-IMPORT_C virtual void Dummy1();
 protected:
 	/**
 	Gets an interface from a derived class
 	N.B the derived class should call the base class's default implementation of this function
 	if it does not support the specified interface
 	DBody* iBody;
 	};
 class TMMCMachineInfo
 /**
 	Platform-specific configuration information for the
 	MultiMediaCard stack.
 	An object of this type is passed to the Variant implementation
 TInt iBaseBusNumber;
 	};
-typedef TPckg<TMMCMachineInfo> TMMCardMachineInfoPckg;
 /**
 	Platform-specific configuration information for the
 	MultiMediaCard stack. Contains information pertinent to
 	MMC specification version 4.0/4.1
 	register. i.e. 0=65mA, 1=70mA, ... 10=250mA.
 	See MMC sepcification version 4.1, EXT_CSD register.
 */
 	enum TLoVoltagePowerClasses {ELo065mA, ELo070mA, ELo080mA, ELo090mA, ELo100mA, ELo120mA, ELo140mA, ELo160mA, ELo180mA, ELo200mA, ELo250mA };
 	TUint iLowVoltagePowerClass;
+	};
+/**
+	Platform-specific configuration information for the
+	MultiMediaCard stack. Contains information pertinent to
+	MMC specification version 4.4
+	An object of this type is passed to the Variant implementation
+	of DMMCStack::MachineInfo(), which should fill the public data
+	members with appropriate information and values.
+@internalComponent
+*/
+class TMMCMachineInfoV44 : public TMMCMachineInfoV4
+	{
+public:
+	inline TMMCMachineInfoV44() {memclr(this, sizeof(*this));}
+	/**
+	The version of the structure returned by the PSL in a call to
+	DMMStack::MachineInfo()
+	The fields defined in TMMCMachineInfoV44 are only valid if the
+	version is EVersion44 or higher
+	*/
+	enum TVersion {EVersion3, EVersion4, EVersion44};
+/**
+Use iRpmbSlotCount and iRpmbSlotList to define a list of up to
+	four slots for devices containing an RPMB partitions to be
+	exposed
+*/
+	TUint iRpmbSlotCount;
+	TUint * iRpmbSlotList;
+	TUint8 iSpare[14];
 	};
 class DMMCPsu : public DPBusPsuBase
 /**
 		EMMCInvalidDBBlockLength		=17,
 		EMMCUnblockingInWrongContext	=18,
 		EMMCInvalidCardNumber			=19,
 		EMMCNotInDfcContext				=20,
 		EMMCAddressCardNotSupported		=21,
+		EMMCInvalidPartitionNumber      =22
 		};
 IMPORT_C static void Panic(TMMCPanic aPanic);
 	friend class DMMCStack;
 	friend class DMMCSession;
 	friend class DMMCMediaChange;

changeset 287	ddfd5aa0d58f
parent 244	a77889bee936
child 291	206a6eaaeb71