// 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".

//

// Initial Contributors:

// Nokia Corporation - initial contribution.

//

// Contributors:

//

// Description:

// Generic MMC controller types and standard classes for MMC manipulation

// This controller follows MMC spec V4.4+

// 

//

/**

 @file

 @internalComponent

*/

#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;

// Forward type declarations

class TMMC;

class TCID;

class TCSD;

class TExtendedCSD;

class TRCA;

class TDSR;

class TMMCStatus;

class TMMCArgument;

class TMMCard;

class TMMCCommandDesc;

class TMMCBusConfig;

class TMMCStackConfig;

class TMMCRCAPool;

class TMMCSessRing;

class TMMCStateMachine;

class DMMCSocket;

class DMMCSession;

class DMMCStack;

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

/**

@publishedPartner

@released

Represents the MultiMediaCard error code bit set.

MultiMediaCard error codes are defined as bit masks, mainly for use with

the state machine where the error trap mask may be used. 

The function DMMCSession::EpocErrorCode() converts these error bit values

into standard Symbian OS error values.

@see KMMCErrNone

@see KMMCErrResponseTimeOut

@see KMMCErrDataTimeOut

@see KMMCErrBusyTimeOut

@see KMMCErrBusTimeOut

@see KMMCErrTooManyCards

@see KMMCErrResponseCRC

@see KMMCErrDataCRC

@see KMMCErrCommandCRC

@see KMMCErrStatus

@see KMMCErrNoCard

@see KMMCErrBrokenLock

@see KMMCErrPowerDown

@see KMMCErrAbort

@see KMMCErrStackNotReady

@see KMMCErrNotSupported

@see KMMCErrHardware

@see KMMCErrBusInconsistent

@see KMMCErrBypass

@see KMMCErrInitContext

@see KMMCErrArgument

@see KMMCErrSingleBlock

@see KMMCErrLocked

@see KMMCErrNotFound

@see KMMCErrAlreadyExists

@see KMMCErrGeneral

@see KMMCErrAll

@see KMMCErrBasic

*/

typedef TUint32 TMMCErr;

/**

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

Defines a set of symbols corresponding to the MultiMediaCard bus commands.

A command is one of the parameter values inserted into a TMMCCommandDesc object.

The commands themselves are defined by the MultiMediaCard specification.

@see TMMCCommandDesc

*/

enum TMMCCommandEnum

	{

	/**

	CMD0; reset all cards to idle state.

	*/

	ECmdGoIdleState			=0,

	/**

	CMD1; all cards in the idle state send their operating conditions.

	*/

	ECmdSendOpCond			=1,

	/**

	CMD2; all cards send their CID number.

	*/

	ECmdAllSendCID			=2,

	/**

	CMD3; assign relative address to a card.

	*/

	ECmdSetRelativeAddr		=3,

	/**

	CMD4; program the DSR register of all cards.

	*/

	ECmdSetDSR				=4,

	/**

	CMD5; toggle device between Sleep and Awake states.

	*/

	ECmd5					=5,

	ECmdSleepAwake			=5,

	/**

	CMD6; Switch

	*/

	ECmd6					=6,

	ECmdSwitch				=6,

	/**

	CMD7; toggle a card between standby and transfer state, or between

	programming and disconnected state.

    The card is selected by its RCA and deselected by any other address.

	*/

	ECmdSelectCard			=7,

	/**

	CMD8; addressed card sends its extended CSD.

	*/

	ECmd8					=8,

	ECmdSendExtendedCSD		=8,

	/**

	CMD9; addressed card sends its CSD.

	*/

	ECmdSendCSD				=9,

	/**

	CMD10; addressed card sends its CID.

	*/

	ECmdSendCID				=10,

	/**

	CMD11; read data stream from the card starting at the given address until

	an ECmdStopTransmission follows.

	@see ECmdStopTransmission

	*/

	ECmdReadDatUntilStop	=11,

	/**

	CMD12; force the card to stop transmission.

	*/

	ECmdStopTransmission	=12,

	/**

	CMD13; addressed card sends its status register.

	*/

	ECmdSendStatus			=13,

	/**

	CMD14; BUSTEST_R - Reads the reversed bus testing data pattern from the card.

	@see ECmdBustest_W

	*/

	ECmd14					=14,

	ECmdBustest_R			=14,

	/**

	CMD15; set the card to the inactive state.

	*/

	ECmdGoInactiveState		=15,

	/**

	CMD16; set the block length for all following block commands.

	*/

	ECmdSetBlockLen			=16,

	/**

	CMD17; read a single data block from the card.

	*/

	ECmdReadSingleBlock		=17,

	/**

	CMD18; continuously transfer data blocks from the card until interrupted

	by ECmdStopTransmission.

	@see ECmdStopTransmission

	*/

	ECmdReadMultipleBlock	=18,

	/**

	CMD19; BUSTEST_W - Sends a test data pattern to the card to determine the bus characteristics

	@see ECmdBustest_R

	*/

	ECmd19					=19,

	ECmdBustest_W			=19,

	/**

	CMD20; write data stream from the host starting at the given address

	until interrupted by ECmdStopTransmission.

	@see ECmdStopTransmission

	*/

	ECmdWriteDatUntilStop	=20,

	/**

	CMD21; reserved for future use.	

	*/

	ECmd21					=21,

	/**

	CMD22; reserved for future use.	

	*/

	ECmd22					=22,

	/**

	CMD23; define the number of blocks to be transferred in the following

	multiple block read or write command.

	*/

	ECmdSetBlockCount		=23,

	/**

	CMD24; write a single block to the card.

	*/

	ECmdWriteBlock			=24,

	/**

	CMD25; continuously transfer data blocks to the card until interrupted

	by ECmdStopTransmission.

	@see ECmdStopTransmission

	*/

	ECmdWriteMultipleBlock	=25,

	/**

	CMD26; programming of the CID.

	This is issued once per card, and is normally reserved for

	the manufacturer.

	*/

	ECmdProgramCID			=26,

	/**

	CMD27; programming of the programmable bits of the CSD.

	*/

	ECmdProgramCSD			=27,

	/**

	CMD28; set the write protect bit of the addressed group, if the card has

	write protection features.

	*/

	ECmdSetWriteProt		=28,

	/**

	CMD29; clear the write protect bit of the addressed group, if the card has

	write protection features.

	*/

	ECmdClearWriteProt		=29,

	/**

	CMD30; ask the card to send the status of the write protect bit, if

	the card has write protection features.

	*/

	ECmdSendWriteProt		=30,

	/**

	CMD31; reserved for future use.	

	*/

	ECmd31					=31,

	/**

	CMD32; set the address of the first sector of the erase group.

	*/

	ECmdTagSectorStart		=32,

	/**

	CMD33; set the address of the last sector in a continuous range within

	the selected erase group, or the address of a single sector to be

	selected for erase.

	*/

	ECmdTagSectorEnd		=33,

	/**

	CMD34; remove one previously selected sector from the erase selection.

	*/

	ECmdUntagSector			=34,

	/**

	CMD35; set the the address of the first erase group within a continuous

	range to be selected for erase.

	*/

	ECmdTagEraseGroupStart	=35,

	/**

	CMD36; set the address of the last erase group within a continuous range

	to be selected for erase.

	*/

	ECmdTagEraseGroupEnd	=36,

	/**

	CMD37; removes one previously selected erase group from the erase selection.

	*/

	ECmdUntagEraseGroup		=37,

	/**

	CMD38; erase all previously selected sectors.

	*/

	ECmdErase				=38,

	/**

	CMD39; read and write 8 bit (register) data fields.

	*/

	ECmdFastIO				=39,

	/**

	CMD40; set the system into interrupt mode.

	*/

	ECmdGoIRQState			=40,

	/**

	CMD41; reserved for future use.	

	*/

	ECmd41					=41,

	/**

	CMD42; set/reset the password or lock/unlock the card.

	*/

	ECmdLockUnlock			=42,

	/**

	CMD43; reserved for future use.	

	*/

	ECmd43					=43,

	/**

	CMD44; reserved for future use.	

	*/

	ECmd44					=44,

	/**

	CMD45; reserved for future use.	

	*/

	ECmd45					=45,

	/**

	CMD46; reserved for future use.	

	*/

	ECmd46					=46,

	/**

	CMD47; reserved for future use.	

	*/

	ECmd47					=47,

	/**

	CMD48; reserved for future use.	

	*/

	ECmd48					=48,

	/**

	CMD49; reserved for future use.

	*/

	ECmd49					=49,

	/**

	CMD50; reserved for future use.	

	*/

	ECmd50					=50,

	/**

	CMD51; reserved for future use.	

	*/

	ECmd51					=51,

	/**

	CMD52; reserved for future use.	

	*/

	ECmd52					=52,

	/**

	CMD53; reserved for future use.	

	*/

	ECmd53					=53,

	/**

	CMD54; reserved for future use.	

	*/

	ECmd54					=54,

	/**

	CMD55; indicate to the card that the next command is an application

	specific command rather than a standard command.

	*/

	ECmdAppCmd				=55,