// Copyright (c) 1998-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:

// e32\include\drivers\pccard.h

// 

//

/**

 @file

 @publishedPartner

 @released

*/

#ifndef __P32PCCD_H__

#define __P32PCCD_H__

#include <drivers/pbus.h>

const TUint KPccdIntMaskIReq=0x1;

const TUint KPccdIntMaskIndChg=0x2;

const TUint KPccdIntMaskRdyChg=0x4;

enum TPccdInt

	{

	EPccdIntIReq=0,

	EPccdIntIndChange=1,

	EPccdIntRdyChange=2,

	};

const TUint KPccdEvFlagIReqLevelMode=0x00000001;

const TUint KPccdEvFlagReserved=0x80000000;

//

// PC Card maximum system settings

//

const TInt KMaxPccdSockets=KMaxPBusSockets;

const TInt KMaxPccdMediaChanges=2;

const TInt KMaxPccdVccSupplies=2;

const TUint KMaxFuncPerCard=8;

const TUint KDefaultAttribMemSize=0x10000;	  // 64K Bytes (32K CIS)

const TSocket KInvalidSocket=-1;

const TUint8 KInvalidFuncNum=(KMaxFuncPerCard+1);

//

// PC Card Enumerates

//

enum TPccdFuncType {EGlobalCard,EVendorMultiFuncCard,EMemoryCard,ESerialCard,

					EParallelCard,EFixedDiskCard,EVideoCard,ENetworkCard,EAimsCard,

					EScsiCard,EVendorSpecificCard,EUnknownCard}; // Order important

enum TPccdMemType {EPccdAttribMem,EPccdCommon8Mem,EPccdCommon16Mem,EPccdIo8Mem,EPccdIo16Mem};

enum TPccdCardStatus {ECardNotPresent,ECardNotReady,ECardBad,ECardReady};

enum TPccdAccessSpeed {EAcSpeed50nS,EAcSpeed100nS,EAcSpeed150nS,EAcSpeed200nS,

					   EAcSpeed250nS,EAcSpeed300nS,EAcSpeed450nS,EAcSpeed600nS,

					   EAcSpeed750nS,EAcSpeedExtended,EAcSpeedInValid};

enum TMemDeviceType {EDeviceNull,EDeviceRom,EDeviceOTP,EDeviceEPROM,

					 EDeviceEEPROM,EDeviceFlash,EDeviceSRam,EDeviceDRam,

					 EDeviceFunSpec,EDeviceInvalid}; // Order important

// Active signals (correspond to Config entry tuple - dont change)

const TUint KSigBvdActive=0x00000010;	

const TUint KSigWpActive=0x00000020;	

const TUint KSigReadyActive=0x00000040;

const TUint KSigWaitRequired=0x00000080;	

const TUint KSigWaitSupported=KSigWaitRequired;	

//

const TUint KPccdVcc_5V0=0x01;

const TUint KPccdVcc_3V3=0x02;

const TUint KPccdVcc_xVx=0x04;

const TUint KPccdVcc_yVy=0x08;

// Interrupt info 

const TUint KPccdIntShare=0x00000080;	

const TUint KPccdIntPulse=0x00000040;	

const TUint KPccdIntLevel=0x00000020;	

enum TPccdSocketVcc	{EPccdSocket_Invalid=0,EPccdSocket_5V0=KPccdVcc_5V0,EPccdSocket_3V3=KPccdVcc_3V3,

					 EPccdSocket_xVx=KPccdVcc_xVx,EPccdSocket_yVy=KPccdVcc_yVy};

enum TPccdOpCritical {EPccdOpCritical,EPccdOpNonCritical};

//

// PC Card memory chunk speed/type/signal definitions

//

#define __IS_COMMON_MEM(aMemType) (aMemType==EPccdCommon8Mem||aMemType==EPccdCommon16Mem)

#define __IS_IO_MEM(aMemType) (aMemType==EPccdIo8Mem||aMemType==EPccdIo16Mem)

#define __IS_ATTRIB_MEM(aMemType) (aMemType==EPccdAttribMem)

#define DEF_IO_ACSPEED  EAcSpeed200nS

#define DEF_MEM_ACSPEED EAcSpeed250nS

#define DEF_ATTR_ACSPEED EAcSpeed600nS 

//

// PC Card Vcc definitions

//

const TInt KVcc_Level_5V=5000;

const TInt KVcc_Level_3V3=3300;

const TInt KVcc_Level_xVx=0;

const TInt KVcc_Level_yVy=0;

//

// General tuple parsing definitions

//

const TInt KSmallTplBufSize=16;

const TInt KLargeTplBufSize=257;

const TInt KMaxCfEntriesPerCis=20;

//

// Link Tuple definitions

//

const TUint KPccdLinkA=0x00000001;

const TUint KPccdLinkC=0x00000002;

const TUint KPccdLinkMFC=0x00000004;

const TUint KPccdNoLink=0x00000008;

//

// Tuple codes

//

const TUint8 KCisTplNull=0x00;

const TUint8 KCisTplDevice=0x01;

const TUint8 KCisTplLongLinkMfc=0x06;

const TUint8 KCisTplCheckSum=0x10;

const TUint8 KCisTplLongLinkA=0x11;

const TUint8 KCisTplLongLinkC=0x12;

const TUint8 KCisTplLinkTarget=0x13;

const TUint8 KCisTplNoLink=0x14;

const TUint8 KCisTplVers1=0x15;

const TUint8 KCisTplAltStr=0x16;

const TUint8 KCisTplDeviceA=0x17;

const TUint8 KCisTplJedecC=0x18;

const TUint8 KCisTplJedecA=0x19;

const TUint8 KCisTplConfig=0x1A;

const TUint8 KCisTplCfTableEntry=0x1B;

const TUint8 KCisTplDeviceOC=0x1C;

const TUint8 KCisTplDeviceOA=0x1D;

const TUint8 KCisTplDeviceGeo=0x1E;

const TUint8 KCisTplDeviceGeoA=0x1F;

const TUint8 KCisTplManfId=0x20;

const TUint8 KCisTplFuncId=0x21;

const TUint8 KCisTplFunce=0x22;

const TUint8 KCisTplSwIl=0x23;

const TUint8 KCisTplVers2=0x40;

const TUint8 KCisTplFormat=0x41;

const TUint8 KCisTplGeometry=0x42;

const TUint8 KCisTplByteOrder=0x43;

const TUint8 KCisTplDate=0x44;

const TUint8 KCisTplBattery=0x45;

const TUint8 KCisTplOrg=0x46;

const TUint8 KCisTplLongLinkCB=0x47;

const TUint8 KCisTplVendorSpecific1=0x80;

const TUint8 KCisTplVendorSpecific2=0x81;

const TUint8 KCisTplVendorSpecific3=0x82;

const TUint8 KCisTplEnd=0xFF;

//

const TUint8 KPccdNonSpecificTpl=0xff;

const TUint8 KInvalidConfOpt=0xFF;

const TUint KPccdRestartCis=0x8000;

//

// PC Card Configuration Register definitions

//

const TUint KConfigOptionReg=0;

const TUint KConfigOptionRegM=0x00000001;

const TUint KConfigAndStatusReg=1;

const TUint KConfigAndStatusRegM=0x00000002;

const TUint KPinReplacementReg=2;

const TUint KPinReplacementRegM=0x00000004;

const TUint KSocketAndCopyReg=3;

const TUint KSocketAndCopyRegM=0x00000008;

const TUint KConfOptConfM=0x0000003F;

const TUint KConfOptLevIReqM=0x00000040;

const TUint KConfOptSResetM=0x00000080;

const TUint KConfStatIntrAckM=0x00000001;

const TUint KConfStatIntrM=0x00000002;

const TUint KConfStatPwrDwnM=0x00000004;

const TUint KConfStatAudioEnableM=0x00000008;

const TUint KConfStatIoIs8M=0x00000020;

const TUint KConfStatSigChgM=0x00000040;

const TUint KConfStatChangedM=0x00000080;

const TUint KPinRepWProtM=0x00000001;

const TUint KPinRepReadyM=0x00000002;

const TUint KPinRepBvdM=0x0000000C;

//

// Pc Card Flag definitions - Mem request/setup and others

//

const TUint KPccdRequestWait=0x00000001;			// Memory request

const TUint KPccdChunkCacheable=0x00000010;			// Memory request

const TUint KPccdChunkShared=0x00000020;			// Memory request

const TUint KPccdChunkPermanent=0x00000040;			// Memory request

const TUint KPccdChunkSystemOwned=0x00000080;		// Memory request

const TUint KPccdDisableWaitStateCntrl=0x00000100; 	// Memory chunk setup

const TUint KPccdBusWidth32=0x00000200; 			// Memory chunk setup

const TUint KPccdReturnLinkTpl=0x00001000;			// Cis parsing

const TUint KPccdReportErrors=0x00002000;			// Cis parsing

const TUint KPccdFindOnly=0x00004000;				// Cis parsing

const TUint KPccdCompatNoVccCheck=0x00000001;	    // Config compatibility checking

const TUint KPccdCompatNoVppCheck=0x00000002;	    // Config compatibility checking

const TUint KPccdCompatNoPwrCheck=0x00000004;	    // Config compatibility checking

const TUint KPccdConfigRestorable=0x00000001;	    // Configuration request

//

// PC Card tick definitions

//

const TInt KPccdPowerUpReqInterval=20000;	// Units 1uS

const TInt KResetOnDefaultLen=5;			// Units 20ms

const TInt KResetOffDefaultLen=5;			// Units 20ms

const TInt KPwrUpTimeOut=125;				// Units 20mS

const TUint KResetOnMask=0x0000FFFF;

const TUint KResetOffMask=0x7FFF0000;

const TInt KResetOffShift=16;

const TInt KResetProfileDefault=((KResetOffDefaultLen<<KResetOffShift)|KResetOnDefaultLen);

	/**

	 This class contains  information of Size, base address and memory type information on a particular 

	 memory chunk of a Pc Card. 

	 This class is used as a member of TPcCardRegion or TPcCardConfig, when Pc Card memory needs to be configured.

	 TPccdChnk  can  be used directly in a call to DPcCardController::RequestMemory() to request

	 a chunk of PC Card memory. 

     @publishedPartner

	 @released

	 */

class TPccdChnk

	{

public:

	/**

	 Initializes the object with memory type to EPccdAttribMem type,BaseAddress and size to 0.

	 Pc Card contains following memory types : EPccdAttribMem,EPccdCommon8Mem,EPccdCommon16Mem,EPccdIo8Mem,EPccdIo16Mem.

	 Default constructor initializes to EPccAttribMem.

	 */

	IMPORT_C TPccdChnk();

	/**

	 Initializes the object with the specified memory type, base address and size.

	 @param aType		Type of Pc Card memory to be configured.

	 @param aBaseAddr   Base address of the Pc Card to be configured.

	 @param aLen        Length of the memory to be configured.

	 @see TPccdMemType

	 */	

	IMPORT_C TPccdChnk(TPccdMemType aType,TUint32 aBaseAddr,TUint32 aLen);

public:

    /**

	 Pc Card memory type (EPccdAttribMem,EPccdCommon8Mem,EPccdCommon16Mem,EPccdIo8Mem,EPccdIo16Mem).

	 @see TPccMemType

     */

	TPccdMemType iMemType;

	/** 

	 Start address of memory region.

	 */

	TUint32 iMemBaseAddr;

	/**

 	 Size of memory region (in bytes).

	 */

	TUint32 iMemLen;

	};

    /** 

	 The maximum number of chunks that can be used per configuration.

	 */

const TInt KMaxChunksPerConfig=2;

	 /**

	 This class provides information on a particular configuration option of a Pc Card.

     This Card Information Structure (CIS) is used to determine the type of card and 

     what device drivers need to be loaded to support it.

	 This is retrieved after a call of TCisReader::FindReadConfig() and can then be passed in a call of  

     DPcCardController::RequestConfig() to request a configuration.

     @publishedPartner

	 @released

     */

class TPcCardConfig

	{

public:

    /**

	 Default Constructor

	 It sets the iConfigOption data member to KInvalidConfOpt.

	 This guarantees that we start with the 1st configuration entry.

	 */

	IMPORT_C TPcCardConfig();

 	/**

	 Determines whether a configuration is compatible with the specification of 

	 the indicated socket 'aSocket' on the machine.

	 This is called after a call to TCisReader::FindReadRegion().

	 It checks Vcc level compatibility, WAIT signal compatibility and access speed compatibility. 

	 It also masks out active signals (in iActiveSignals) that are not supported by the machine.

	 @param aSocket  The socket for which the machine compatibility is to be performed.

	 @param aFlag    It is possible to disable some aspects of compatibility checking by ORing aFlag with 

					 KPccdCompatNoVccCheck, KPccdCompatNoVppCheck or KPccdCompatNoPwrCheck.

	 @return True if a configuration is compatible with the specification of the indicated socket 'aSocket' on the machine.

	 */

	IMPORT_C TBool IsMachineCompatible(TSocket aSocket,TInt aFlag=0);

public:								 

	/** 

 	 Access speed of memory involved (EAcSpeed50nS, 100ns, 150ns, 200ns, 250ns, 300ns, 450ns, 600ns,

	 750nS, EAcSpeedExtended, EAcSpeedInValid).

 	 */

	TPccdAccessSpeed iAccessSpeed;

	/** 

 	 Pc Card signals supported - KSigWaitRequired, KSigReadyActive, KSigWpActive, KSigBvdActive.

 	 */

	TUint iActiveSignals;

	/**

	 Maximum Vcc for this configuration.

	 */

	TInt iVccMaxInMilliVolts;			

	/**

	 Minimum Vcc for this configuration.

	 */

	TInt iVccMinInMilliVolts;						

	/**

	 Size, type and base address of Pc Card regions enabled with this configuration.

	 */

	TPccdChnk iChnk[KMaxChunksPerConfig];

	/**

     Number of elements of iChnk which are valid.

	 */

	TInt iValidChunks;

	/**

	 TRUE - i/o and memory, FALSE - memory only.

	 */

	TBool iIsIoAndMem;

	/**

	 True if CIS indicates this is default option.

	 */

	TBool iIsDefault;

	/**

	 True if power down supported.

	 */

	TBool iPwrDown;

	/**

	 Maximum Vpp for this configuration.

	 */

	TInt iVppMaxInMilliVolts;						

	/**

	 Minimum Vpp for this configuration.

	 */

	TInt iVppMinInMilliVolts;						

    /**

	 Operation current drawn when card is in this configuration.

	 */

	TInt iOperCurrentInMicroAmps;				   

    /**

	 Current drawn in this configuration when Pc Card is in  power down mode.

	 */

	TInt iPwrDwnCurrentInMicroAmps;				 

	/**

	 Interrupt features supported. Any of:- KPccdIntShare, KPccdIntPulse,KPccdIntLevel.

	 */

	TUint iInterruptInfo;

	/**

	 Value to be written in to ConfigOptionReg for this configuration.

	 */

	TInt iConfigOption;

	/**

	 Base address of configuration registers (in attribute memory).

	 */

	TUint32 iConfigBaseAddr;

	/**

	 Mask of configuration registers present.

	 */

	TUint32 iRegPresent;	

	};

	/**

	 Information about a specific memory region of a Pc Card.

	 This is retrieved by calling TCisReader::FindReadRegion().

	 An object of this type contains a TPccdChunk object, and can be passed to 

	 DPcCardController::RequestMemory() to request the corresponding memory chunk.

	 @publishedPartner

	 @released

	 */

class TPcCardRegion 

	{

public:

	/**

	 Initializes iDeviceType to EDeviceInvalid.

	 This guarantees that we start with the 1st device information entry.

	 */

	IMPORT_C TPcCardRegion();

	/**	

	 Used after TCisReader::FindReadRegion() to determine if a configuration is compatible with the specification of 

	 the indicated socket 'aSocket' on the machine. Checks Vcc level compatibility,

	 WAIT signal compatibility and access speed compatibility. Also masks out active signals (in iActiveSignals)

	 which aren't supported by the machine.

	 @param aSocket  Socket for which the machine compatibility to be performed.

	 @return True if a configuration is compatible with the specification of the indicated socket 'aSocket' on the machine.

	 */

	IMPORT_C TBool IsMachineCompatible(TSocket aSocket);

public:										

	/** 

 	 Access speed of memory involved (EAcSpeed50nS, 100ns, 150ns, 200ns, 250ns, 300ns, 450ns, 600ns,

	 750nS, EAcSpeedExtended, EAcSpeedInValid).

 	 */

	TPccdAccessSpeed iAccessSpeed;

    /** 

 	 Pc Card signals supported - KSigWaitRequired, KSigReadyActive, KSigWpActive, KSigBvdActive.

 	 */

	TUint iActiveSignals;

	/**

     Info on the memory regions applies when the card is powered at this voltage.

	 */

	TPccdSocketVcc iVcc;

    /**

	 TPccdChnk object holds size, type and base address of Pc Card region.

	 */

	TPccdChnk iChnk;

	/**

	 Memory device type present (e.g. ROM, SRAM, OTP etc.).

	 */

	TMemDeviceType iDeviceType;

	/**

	 When iAccessSpeed, i.e, extended device speed field converted to speed in nS.

	 */

	TInt iExtendedAccSpeedInNanoSecs;

	};

	/**

	 Contains platform-specific information about the Pc Card.

	 @publishedPartner

	 @released

	 */

class TPccdType

	{

public:

	/**

	 Default Constructor, initializes maximum functions performed by the Pc Card.

	 */

	IMPORT_C TPccdType();

public:

	/**

	 Gets the function type of the Pc Card. 

	 @see TPccdFuncType

	 */

	TPccdFuncType iFuncType[KMaxFuncPerCard];

	/**

	 Total number of fuctions performed by the Pc Card.

	 */

	TInt iFuncCount;

	};

enum TPccdBatteryState {EPccBattZero,EPccBattVeryLow,EPccBattLow,EPccBattGood};

class TSocketIndicators

	{

public:

	TBool iCardDetected;

	TInt iVoltSense;

	TBool iWriteProtected;

	TPccdBatteryState iBatState;

	};

    /**

	 Contains platform-specific information about the PC card Socket.

	 @publishedPartner

	 @released

	 */

class TPcCardSocketInfo

	{

public:

	/**

	 Minimum Vpp in Millivolts for the socket of the Pc Card.

	 */

	TInt iNomVppInMilliVolts;

	/**

	 Maximum Vpp in Micro Amps for the socket of the Pc Card.

	 */

	TInt iMaxVppCurrentInMicroAmps;

	/**

	 Supported signals used to check for machine compatability of Pc Card. i.e, KSigWaitRequired, KSigReadyActive, KSigWpActive, KSigBvdActive.

	 */

	TUint iSupportedSignals;

	/**

     Maximum access speed of attribute memory , used to check requested access speed of attribute memory for Machine compatability.

	 */

	TPccdAccessSpeed iMaxAttribAccSpeed;

    /**

	 Maximum access speed of Common Io Memory ,used to check requested access speed of Io memory for Machine compatability.

	 */

	TPccdAccessSpeed iMaxCommonIoAccSpeed;

	};

//

	/**

	 Platform-specific configuration information for the Pc Card stack.

	 @publishedPartner

	 @released

	 */

class TPcCardMachineInfo

	{

public:

    /**

	 Total number of sockets for the Pc Card.

	 */

	TInt iTotalSockets;

	/**

	 Total number of times Media changes have occurred.

	 */

	TInt iTotalMediaChanges;

	/**

	 Not currently used.

	 Set this value to zero.

	 */