williamr@4: // Copyright (c) 2004-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@4: // All rights reserved.
williamr@4: // This component and the accompanying materials are made available
williamr@4: // under the terms of the License "Eclipse Public License v1.0"
williamr@4: // which accompanies this distribution, and is available
williamr@4: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
williamr@4: //
williamr@4: // Initial Contributors:
williamr@4: // Nokia Corporation - initial contribution.
williamr@4: //
williamr@4: // Contributors:
williamr@4: //
williamr@4: // Description:
williamr@4: // omap3530/omap3530_drivers/usbcc/omap3530_usbc.h
williamr@4: // Platform-dependent USB client controller layer (USB PSL).
williamr@4: //
williamr@4: 
williamr@4: 
williamr@4: #ifndef __OMAP3530_USBC_H__
williamr@4: #define __OMAP3530_USBC_H__
williamr@4: 
williamr@4: #include <e32cmn.h>
williamr@4: #include <drivers/usbc.h>
williamr@4: #include <assp/omap3530_assp/omap3530_assp_priv.h>
williamr@4: 
williamr@4: // This is the header file for the implementation of the USB driver PSL layer for an imaginary USB client
williamr@4: // (device) controller.
williamr@4: // For simplicity's sake we assume the following endpoint layout of the controller.
williamr@4: // We have 5 endpoints in total - two Bulk endpoints (IN and OUT), two Isochronous endpoint (IN and OUT),
williamr@4: // one Interrupt endpoint (IN), and of course endpoint zero (Ep0).
williamr@4: //
williamr@4: // This is the mapping of "Hardware Endpoint Numbers" to "Real Endpoints" (and thus is also
williamr@4: // used as the array index for our local TTemplateAsspUsbcc::iEndpoints[]):
williamr@4: //
williamr@4: //	0 -	 0 (Ep0 OUT)
williamr@4: //	0 -	 1 (Ep0 IN)
williamr@4: //	1 -	 3 (Bulk  IN, Address 0x11, -> EpAddr2Idx(0x11) =  3)
williamr@4: //	2 -	 4 (Bulk OUT, Address 0x02, -> EpAddr2Idx(0x02) =  4)
williamr@4: //	3 -	 7 (Iso   IN, Address 0x13, -> EpAddr2Idx(0x13) =  7)
williamr@4: //	4 -	 8 (Iso  OUT, Address 0x04, -> EpAddr2Idx(0x04) =  8)
williamr@4: //	5 - 11 (Int   IN, Address 0x15, -> EpAddr2Idx(0x15) = 11)
williamr@4: //
williamr@4: // For the reason why this is so (or rather for the perhaps not so obvious system behind it),
williamr@4: // see the comment at the beginning of \e32\drivers\usbcc\ps_usbc.cpp and also the structure
williamr@4: // DeviceEndpoints[] at the top of pa_usbc.cpp.
williamr@4: 
williamr@4: // The total number of endpoints in our local endpoint array:
williamr@4: static const TInt KUsbTotalEndpoints = 16; //32; // Disabled due to limited FIFO space
williamr@4: 
williamr@4: // The numbers used in the following macros are 'aRealEndpoint's (i.e. array indices):
williamr@4: #define IS_VALID_ENDPOINT(x)	((x) > 0 && (x) < KUsbTotalEndpoints)
williamr@4: #define IS_OUT_ENDPOINT(x)		IS_VALID_ENDPOINT(x) && ((x) == 0 || (x) == 2 || (x) == 4 || (x) == 6 || (x) == 8 || (x) == 10 || (x) == 12 || (x) == 14 || (x) == 16 || (x) == 18 || (x) == 20 || (x) == 22 ||(x) == 24 || (x) == 26 ||(x) == 28) 
williamr@4: #define IS_IN_ENDPOINT(x)		IS_VALID_ENDPOINT(x) && ((x) == 1 || (x) == 3 || (x) == 5 || (x) == 7 || (x) == 9 || (x) == 11 || (x) == 13 || (x) == 15 || (x) == 17 || (x) == 19 || (x) == 21 || (x) == 23 ||(x) == 25 || (x) == 27 ||(x) == 29)
williamr@4: #define IS_BULK_IN_ENDPOINT(x)	IS_VALID_ENDPOINT(x) && ((x) == 1 || (x) == 3 || (x) == 5 || (x) == 7 || (x) == 9 || (x) == 11 || (x) == 13 || (x) == 15 || (x) == 17 || (x) == 19 || (x) == 21 || (x) == 23 ||(x) == 25 || (x) == 27)
williamr@4: #define IS_BULK_OUT_ENDPOINT(x)		IS_VALID_ENDPOINT(x) &&((x) == 2 || (x) == 4 || (x) == 6 || (x) == 8 || (x) == 10 || (x) == 12 || (x) == 14 || (x) == 16 || (x) == 18 || (x) == 20 || (x) == 22 ||(x) == 24 || (x) == 26 ||(x) == 28) 
williamr@4: #define IS_BULK_ENDPOINT(x)		(IS_BULK_IN_ENDPOINT(x) || IS_BULK_OUT_ENDPOINT(x))
williamr@4: #define IS_ISO_IN_ENDPOINT(x)	EFalse
williamr@4: #define IS_ISO_OUT_ENDPOINT(x)	EFalse
williamr@4: #define IS_ISO_ENDPOINT(x)		(IS_ISO_IN_ENDPOINT(x) || IS_ISO_OUT_ENDPOINT(x))
williamr@4: #define IS_INT_IN_ENDPOINT(x)	IS_VALID_ENDPOINT(x) && ((x) == 29)
williamr@4: 
williamr@4: // This takes as an index the TTemplateAsspUsbcc::iEndpoints index (== aRealEndpoint) 0..11
williamr@4: // and returns the hardware endpoint number 0..5 (note that not all input indices are valid;
williamr@4: // these will return -1):
williamr@4: /*static const TInt TBeagleAsspEndpoints[KUsbTotalEndpoints] = 
williamr@4: {0, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30};*/
williamr@4: static const TInt TBeagleAsspEndpoints[KUsbTotalEndpoints] = 
williamr@4: {0, 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14};
williamr@4: 
williamr@4: // And here is a function to use the above array:
williamr@4: static inline TInt ArrayIdx2TemplateEp(TInt aRealEndpoint)
williamr@4: 	{
williamr@4: 	if (IS_VALID_ENDPOINT(aRealEndpoint)) return TBeagleAsspEndpoints[aRealEndpoint];
williamr@4: 	else return -1;
williamr@4: 	}
williamr@4: 	
williamr@4: static inline TInt TemplateEp2ArrayIdx(TInt aRealEndpoint)
williamr@4: 	{
williamr@4: 	for(TInt x=0; x<KUsbTotalEndpoints; x++)
williamr@4: 		{
williamr@4: 		if(TBeagleAsspEndpoints[x]==aRealEndpoint)
williamr@4: 			return x;
williamr@4: 		}
williamr@4: 	return -1;
williamr@4: 	}
williamr@4: 
williamr@4: // Access to clocks is reference counted
williamr@4: static TInt iSICLKEnabled;
williamr@4: 
williamr@4: // Endpoint max packet sizes
williamr@4: static const TInt KEp0MaxPktSz = 64;						// Control
williamr@4: static const TInt KIntMaxPktSz = 64;							// Interrupt
williamr@4: static const TInt KBlkMaxPktSz = 512;						// Bulk
williamr@4: static const TInt KIsoMaxPktSz = 256;						// Isochronous
williamr@4: static const TInt KEp0MaxPktSzMask = KUsbEpSize64;			// Control
williamr@4: static const TInt KIntMaxPktSzMask = KUsbEpSize64;			// Interrupt
williamr@4: static const TInt KBlkMaxPktSzMask = /*KUsbEpSize64 | */KUsbEpSize512;			// Bulk
williamr@4: static const TInt KIsoMaxPktSzMask = KUsbEpSize256;			// Isochronous
williamr@4: 
williamr@4: // 1 ms (i.e. the shortest delay possible with the sort of timer used) seems to give
williamr@4: // the best results, both for Bulk and Iso, and also (in the USBRFLCT test program)
williamr@4: // both for loop tests as well as unidirectional transfers.
williamr@4: static const TInt KRxTimerTimeout = 5;						// milliseconds
williamr@4: 
williamr@4: // Used in descriptors
williamr@4: static const TUint16 KUsbVendorId	= KUsbVendorId_Symbian;	// Symbian
williamr@4: static const TUint16 KUsbProductId	= 0x0666;				// bogus...
williamr@4: static const TUint16 KUsbDevRelease = 0x0100;				// bogus... (BCD!)
williamr@4: static const TUint16 KUsbLangId		= 0x0409;				// English (US) Language ID
williamr@4: 
williamr@4: // String descriptor default values
williamr@4: static const wchar_t KStringManufacturer[] = L"Symbian Software Ltd.";
williamr@4: static const wchar_t KStringProduct[]	   = L"BeagleBoard";
williamr@4: static const wchar_t KStringSerialNo[]	   = L"0123456789";
williamr@4: static const wchar_t KStringConfig[]	   = L"First and Last and Always";
williamr@4: 
williamr@4: 
williamr@4: // We use our own Ep0 state enum:
williamr@4: enum TEp0State
williamr@4: 	{
williamr@4: 	EP0_IDLE = 0,											// These identifiers don't conform to
williamr@4: 	EP0_OUT_DATA_PHASE = 1,									// Symbian's coding standard... ;)
williamr@4: 	EP0_IN_DATA_PHASE = 2,
williamr@4: 	EP0_END_XFER = 3,
williamr@4: 	};
williamr@4: 
williamr@4: 
williamr@4: 
williamr@4: class DOmap3530Usbcc;
williamr@4: // The lowest level endpoint abstraction
williamr@4: struct TEndpoint
williamr@4: 	{
williamr@4: 	TEndpoint();
williamr@4: 	static void RxTimerCallback(TAny* aPtr);
williamr@4: 	// data
williamr@4: 	DOmap3530Usbcc* iController;						// pointer to controller object
williamr@4: 	union
williamr@4: 		{
williamr@4: 		TUint8* iRxBuf;										// where to store /
williamr@4: 		const TUint8* iTxBuf;								// from where to send
williamr@4: 		};
williamr@4: 	union
williamr@4: 		{
williamr@4: 		TInt iReceived;										// bytes already rx'ed /
williamr@4: 		TInt iTransmitted;									// bytes already tx'ed
williamr@4: 		};
williamr@4: 	TInt iLength;											// number of bytes to be transferred
williamr@4: 	TBool iZlpReqd;											// ZeroLengthPacketRequired
williamr@4: 	TBool iNoBuffer;										// no data buffer was available when it was needed
williamr@4: 	TBool iDisabled;										// dto but stronger
williamr@4: 	TInt iPackets;											// number of packets rx'ed or tx'ed
williamr@4: 	TInt iLastError;										//
williamr@4: 	TUsbcRequestCallback* iRequest;							//
williamr@4: 	NTimer iRxTimer;										//
williamr@4: 	TBool iRxTimerSet;										// true if iRxTimer is running
williamr@4: 	TBool iRxMoreDataRcvd;									// true if after setting timer data have arrived
williamr@4: 	TUsbcPacketArray* iPacketIndex;							// actually TUsbcPacketArray (*)[]
williamr@4: 	TUsbcPacketArray* iPacketSize;							// actually TUsbcPacketArray (*)[]
williamr@4: 	};
williamr@4: 
williamr@4: 
williamr@4: // The hardware driver object proper
williamr@4: class Omap3530BoardAssp;
williamr@4: class MOmap3530UsbPhy;
williamr@4: 
williamr@4: NONSHARABLE_CLASS( DOmap3530Usbcc ) : public DUsbClientController
williamr@4: 	{
williamr@4: friend void TEndpoint::RxTimerCallback(TAny*);
williamr@4: 
williamr@4: public:
williamr@4: 	enum TPHYMode
williamr@4: 		{
williamr@4: 		ENormal,
williamr@4: 		EPowerUp,
williamr@4: 		EPeripheralChirp,
williamr@4: 		EUART
williamr@4: 		};
williamr@4: 
williamr@4: public:
williamr@4: 	DOmap3530Usbcc();
williamr@4: 	TInt Construct();
williamr@4: 	virtual ~DOmap3530Usbcc();
williamr@4: 	virtual void DumpRegisters();
williamr@4: 
williamr@4: private:
williamr@4: 	virtual TInt SetDeviceAddress(TInt aAddress);
williamr@4: 	virtual TInt ConfigureEndpoint(TInt aRealEndpoint, const TUsbcEndpointInfo& aEndpointInfo);
williamr@4: 	virtual TInt DeConfigureEndpoint(TInt aRealEndpoint);
williamr@4: 	virtual TInt AllocateEndpointResource(TInt aRealEndpoint, TUsbcEndpointResource aResource);
williamr@4: 	virtual TInt DeAllocateEndpointResource(TInt aRealEndpoint, TUsbcEndpointResource aResource);
williamr@4: 	virtual TBool QueryEndpointResource(TInt aRealEndpoint, TUsbcEndpointResource aResource) const;
williamr@4: 	virtual TInt OpenDmaChannel(TInt aRealEndpoint);
williamr@4: 	virtual void CloseDmaChannel(TInt aRealEndpoint);
williamr@4: 	virtual TInt SetupEndpointRead(TInt aRealEndpoint, TUsbcRequestCallback& aCallback);
williamr@4: 	virtual TInt SetupEndpointWrite(TInt aRealEndpoint, TUsbcRequestCallback& aCallback);
williamr@4: 	virtual TInt CancelEndpointRead(TInt aRealEndpoint);
williamr@4: 	virtual TInt CancelEndpointWrite(TInt aRealEndpoint);
williamr@4: 	virtual TInt SetupEndpointZeroRead();
williamr@4: 	virtual TInt SetupEndpointZeroWrite(const TUint8* aBuffer, TInt aLength, TBool aZlpReqd = EFalse);
williamr@4: 	virtual TInt SendEp0ZeroByteStatusPacket();
williamr@4: 	virtual TInt StallEndpoint(TInt aRealEndpoint);
williamr@4: 	virtual TInt ClearStallEndpoint(TInt aRealEndpoint);
williamr@4: 	virtual TInt EndpointStallStatus(TInt aRealEndpoint) const;
williamr@4: 	virtual TInt EndpointErrorStatus(TInt aRealEndpoint) const;
williamr@4: 	virtual TInt ResetDataToggle(TInt aRealEndpoint);
williamr@4: 	virtual TInt SynchFrameNumber() const;
williamr@4: 	virtual void SetSynchFrameNumber(TInt aFrameNumber);
williamr@4: 	virtual TInt StartUdc();
williamr@4: 	virtual TInt StopUdc();
williamr@4: 	virtual TInt UdcConnect();
williamr@4: 	virtual TInt UdcDisconnect();
williamr@4: 	virtual TBool UsbConnectionStatus() const;
williamr@4: 	virtual TBool UsbPowerStatus() const;
williamr@4: 	virtual TBool DeviceSelfPowered() const;
williamr@4: 	virtual const TUsbcEndpointCaps* DeviceEndpointCaps() const;
williamr@4: 	virtual TInt DeviceTotalEndpoints() const;
williamr@4: 	virtual TBool SoftConnectCaps() const;
williamr@4: 	virtual TBool DeviceStateChangeCaps() const;
williamr@4: 	virtual void Suspend();
williamr@4: 	virtual void Resume();
williamr@4: 	virtual void Reset();
williamr@4: 	virtual TInt SignalRemoteWakeup();
williamr@4: 	virtual void Ep0ReadSetupPktProceed();
williamr@4: 	virtual void Ep0ReceiveProceed();
williamr@4: 	virtual TDfcQue* DfcQ(TInt aUnit);
williamr@4: 	virtual TBool CurrentlyUsingHighSpeed();
williamr@4: 
williamr@4: private:
williamr@4: 	// general
williamr@4: 	void EnableEndpointInterrupt(TInt aEndpoint);
williamr@4: 	void DisableEndpointInterrupt(TInt aEndpoint);
williamr@4: 	void ClearEndpointInterrupt(TInt aEndpoint);
williamr@4: 	void InitialiseUdcRegisters();
williamr@4: 	void UdcEnable();
williamr@4: 	void UdcDisable();
williamr@4: 	TInt SetupUdcInterrupt();
williamr@4: 	void ReleaseUdcInterrupt();
williamr@4: 	void UdcInterruptService();
williamr@4: 	void EndpointIntService(TInt aEndpoint);
williamr@4: 	TInt ResetIntService();
williamr@4: 	void SuspendIntService();
williamr@4: 	void ResumeIntService();
williamr@4: 	void SofIntService();
williamr@4: 	static void UdcIsr(TAny* aPtr);
williamr@4: 	static TInt UsbClientConnectorCallback(TAny* aPtr);
williamr@4: 	// endpoint zero
williamr@4: 	void Ep0IntService();
williamr@4: 	void Ep0ReadSetupPkt();
williamr@4: 	void Ep0Receive();
williamr@4: 	void Ep0Transmit();
williamr@4: 	void Ep0EndXfer();
williamr@4: 	void Ep0Cancel();
williamr@4: 	void Ep0PrematureStatusOut();
williamr@4: 	void Ep0StatusIn();
williamr@4: 	void Ep0NextState(TEp0State aNextState);
williamr@4: 	// endpoint n with n != 0
williamr@4: 	void BulkTransmit(TInt aEndpoint);
williamr@4: 	void BulkReceive(TInt aEndpoint);
williamr@4: 	void BulkReadRxFifo(TInt aEndpoint);
williamr@4: 	void IsoTransmit(TInt aEndpoint);
williamr@4: 	void IsoReceive(TInt aEndpoint);
williamr@4: 	void IsoReadRxFifo(TInt aEndpoint);
williamr@4: 	void IntTransmit(TInt aEndpoint);
williamr@4: 	void RxComplete(TEndpoint* aEndpoint);
williamr@4: 	void StopRxTimer(TEndpoint* aEndpoint);
williamr@4: 	
williamr@4: private:
williamr@4: 	void EnableSICLK();
williamr@4: 	void DisableSICLK();
williamr@4: 	
williamr@4: 	// Dfc functions
williamr@4: 	static void SuspendDfcFn(TAny *aPtr);
williamr@4: 	static void ResumeDfcFn(TAny *aPtr);
williamr@4: 	static void ResetDfcFn(TAny *aPtr);
williamr@4: 	
williamr@4: public:
williamr@4: 	TBool DeviceHighSpeedCaps() const;
williamr@4: 
williamr@4: private:
williamr@4: 	// general
williamr@4: 	TBool iSoftwareConnectable;
williamr@4: 	TBool iCableDetectable;
williamr@4: 	TBool iCableConnected;
williamr@4: 	TBool iBusIsPowered;
williamr@4: 	TBool iInitialized;
williamr@4: 	TInt (*iUsbClientConnectorCallback)(TAny *);
williamr@4: 	Omap3530Assp* iAssp;
williamr@4: 	// endpoint zero
williamr@4: 	TBool iEp0Configured;
williamr@4: 	TEp0State iEp0State;
williamr@4: 	// endpoints n
williamr@4: 	TEndpoint iEndpoints[KUsbTotalEndpoints];				// for how this is indexed, see top of pa_usbc.cpp
williamr@4: 		
williamr@4: 	// Dfc's for configuring the Tranceiver when we get a Suspend/Resume/Reset interrupt.
williamr@4: 	TDfcQue* iDfcQueue;
williamr@4: 	
williamr@4: 	TDfc iSuspendDfc;
williamr@4: 	TDfc iResumeDfc;
williamr@4: 	TDfc iResetDfc;
williamr@4: 
williamr@4: 	MOmap3530UsbPhy*	iPhy;
williamr@4: 	TUint	iPrmClientId;
williamr@4: 	};
williamr@4: 
williamr@4: 
williamr@4: class MOmap3530UsbPhy
williamr@4: 	{
williamr@4: public:
williamr@4: 	IMPORT_C static MOmap3530UsbPhy* New();
williamr@4: 
williamr@4: 	virtual void StartPHY() = 0;
williamr@4: 	virtual void SetPHYMode( DOmap3530Usbcc::TPHYMode aMode ) = 0;
williamr@4: 	virtual void EnablePHY() = 0;
williamr@4: 	virtual void DisablePHY() = 0;
williamr@4: 	};
williamr@4: 
williamr@4: 
williamr@4: #endif // __PA_USBC_H__