sl@0: // Copyright (c) 2008-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of the License "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // e32/include/d32usbcshared.h
sl@0: // User side class definitions for USB Device support.
sl@0: // 
sl@0: //
sl@0: 
sl@0: /**
sl@0:  @file d32usbcshared.h
sl@0:  @publishedPartner
sl@0:  @released
sl@0: */
sl@0: 
sl@0: #ifndef __D32USBCSHARED_H__
sl@0: #define __D32USBCSHARED_H__
sl@0: 
sl@0: // USB driver error codes
sl@0: 
sl@0: /** USB driver specific error codes start from here
sl@0: */
sl@0: const TInt KErrUsbDriverBase = -6701;
sl@0: 
sl@0: /**	Attempt at data transfer, or something interface related,
sl@0: 	when neither an Interface has been set up nor Device Control is owned by
sl@0: 	the channel
sl@0: */
sl@0: const TInt KErrUsbInterfaceNotReady = -6702;
sl@0: 
sl@0: /**	Attempt at data transfer on an endpoint that does not belong to the active interface
sl@0: */
sl@0: const TInt KErrUsbEpNotInInterface = -6703;
sl@0: 
sl@0: /**	Attempt at data transfer in a direction not supported by the endpoint
sl@0: */
sl@0: const TInt KErrUsbEpBadDirection = -6704;
sl@0: 
sl@0: /**	The data transfer size specified exceeds that of the source or
sl@0: 	destination buffer descriptor
sl@0: */
sl@0: const TInt KErrUsbTransferSize = -6705;
sl@0: 
sl@0: /**	This has multiple uses:
sl@0: 	1) User request completed because device is no longer in configured state
sl@0: 	2) Something endpoint related, stall, unstall, status enquiry etc,
sl@0: 	   that requires the device to be configured
sl@0: */
sl@0: const TInt KErrUsbDeviceNotConfigured = -6706;
sl@0: 
sl@0: /**	Requested endpoint properties inconsistent during Interface setup
sl@0: */
sl@0: const TInt KErrUsbBadEndpoint = -6707;
sl@0: 
sl@0: /**	User data request completed because channel is closing (channel destructor called)
sl@0: */
sl@0: const TInt KErrUsbDeviceClosing = -6708;
sl@0: 
sl@0: /**	User data request completed because current endpoint set is being
sl@0: 	replaced since alternate setting is changing
sl@0: */
sl@0: const TInt KErrUsbInterfaceChange = -6709;
sl@0: 
sl@0: /**	User data request completed because cable has been detached (or equivalent)
sl@0: */
sl@0: const TInt KErrUsbCableDetached = -6710;
sl@0: 
sl@0: /**	User data request completed because cable has been detached (or equivalent)
sl@0: */
sl@0: const TInt KErrUsbDeviceBusReset = -6711;
sl@0: 
sl@0: /**	This means that read data is still available when a write request is made.
sl@0: 	Relates to bidirectional eps only (ep0).
sl@0: 	A bidirectional ep must consume all of its read data before attempting to write.
sl@0: */
sl@0: const TInt KErrUsbEpNotReady = -6712;
sl@0: 
sl@0: /** These are states that are described in the USB standard.
sl@0: 
sl@0: 	@see RDevUsbcClient::DeviceStatus()
sl@0: 	@see RDevUsbcClient::AlternateDeviceStatusNotify()
sl@0: */
sl@0: enum TUsbcDeviceState
sl@0: 	{
sl@0: 	EUsbcDeviceStateUndefined,								// 0
sl@0: 	EUsbcDeviceStateAttached,								// 1
sl@0: 	EUsbcDeviceStatePowered,								// 2
sl@0: 	EUsbcDeviceStateDefault,								// 3
sl@0: 	EUsbcDeviceStateAddress,								// 4
sl@0: 	EUsbcDeviceStateConfigured,								// 5
sl@0: 	EUsbcDeviceStateSuspended,								// 6
sl@0:  	EUsbcNoState = 0xff										// 255 (used as a place holder)
sl@0: 	};
sl@0: 
sl@0: /** The endpoint states.
sl@0: 
sl@0: 	@see RDevUsbcClient::EndpointStatus()
sl@0: 	@see RDevUsbcClient::EndpointStatusNotify()
sl@0: */
sl@0: enum TEndpointState
sl@0: 	{
sl@0: 	EEndpointStateNotStalled,
sl@0: 	EEndpointStateStalled,
sl@0: 	EEndpointStateUnknown
sl@0: 	};
sl@0: 
sl@0: /** Endpoint resources/behaviours.
sl@0: 
sl@0: 	@see AllocateEndpointResource()
sl@0: 	@see DeAllocateEndpointResource()
sl@0: 	@see QueryEndpointResourceUse()
sl@0: */
sl@0: enum TUsbcEndpointResource
sl@0: 	{
sl@0: 	/** Requests the use of DMA. */
sl@0: 	EUsbcEndpointResourceDMA = 0,
sl@0: 	/** Requests the use of double FIFO buffering. */
sl@0: 	EUsbcEndpointResourceDoubleBuffering = 1
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /** The USB client device capability class.
sl@0: */
sl@0: class TCapsDevUsbc
sl@0: 	{
sl@0: public:
sl@0: 	/** The device version. */
sl@0: 	TVersion version;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /** The maximum number of endpoints supported by the device, excluding ep0.
sl@0: */
sl@0: const TInt KUsbcMaxEndpoints = 30;
sl@0: 
sl@0: /** The maximum number of endpoints per interface, excluding ep0.
sl@0: */
sl@0: const TInt KMaxEndpointsPerClient = 5;
sl@0: 
sl@0: /** @internalComponent
sl@0: */
sl@0: const TInt KInvalidEndpointNumber = 31;
sl@0: 
sl@0: /** The alternate setting flag; when this bit is set the state change notified by
sl@0: 	RDevUsbcClient::AlternateDeviceStatusNotify() is an alternate setting number.
sl@0: */
sl@0: const TUint KUsbAlternateSetting = 0x80000000;
sl@0: 
sl@0: /** The USB cable detection feature flag; used by TUsbDeviceCapsV01::iFeatureWord1.
sl@0: 	When this bit is set then the USB controller hardware (UDC) supports detection
sl@0: 	of a plugged-in USB cable even when not powered.
sl@0: 
sl@0: 	@see TUsbDeviceCapsV01
sl@0: */
sl@0: const TUint KUsbDevCapsFeatureWord1_CableDetectWithoutPower = 0x00000001;
sl@0: 
sl@0: /** If this flag is set then the driver supports the new endpoint resource
sl@0: 	allocation scheme for DMA and Double-buffering via
sl@0: 	TUsbcEndpointInfo::iFeatureWord1.
sl@0: 
sl@0: 	@see TUsbDeviceCapsV01
sl@0: */
sl@0: const TUint KUsbDevCapsFeatureWord1_EndpointResourceAllocV2 = 0x00000002;
sl@0: 
sl@0: 
sl@0: /** Device USB capabilities.
sl@0: */
sl@0: class TUsbDeviceCapsV01
sl@0: 	{
sl@0: public:
sl@0: 	/** The total number of endpoints on the device. */
sl@0: 	TInt iTotalEndpoints;
sl@0: 	/** Indicates whether the device supports software connect/disconnect. */
sl@0: 	TBool iConnect;
sl@0: 	/** Indicates whether the device is self powered. */
sl@0: 	TBool iSelfPowered;
sl@0: 	/** Indicates whether the device can send Remote Wakeup. */
sl@0: 	TBool iRemoteWakeup;
sl@0: 	/** Indicates whether the device supports High-speed mode. */
sl@0: 	TBool iHighSpeed;
sl@0: 	/** 32 flag bits indicating miscellaneous UDC/device features.
sl@0: 		Currently defined are:
sl@0: 		- KUsbDevCapsFeatureWord1_CableDetectWithoutPower = 0x00000001
sl@0: 		- KUsbDevCapsFeatureWord1_EndpointResourceAllocV2 = 0x00000002
sl@0: 	*/
sl@0: 	TUint32 iFeatureWord1;
sl@0: 	/** Reserved for future use. */
sl@0: 	TUint32 iReserved;
sl@0: 	};
sl@0: 
sl@0: /** Package buffer for a TUsbDeviceCapsV01 object.
sl@0: 
sl@0: 	@see TUsbDeviceCapsV01
sl@0: */
sl@0: typedef TPckgBuf<TUsbDeviceCapsV01> TUsbDeviceCaps;
sl@0: 
sl@0: /** Bitmaps for TUsbcEndpointCaps.iSizes.
sl@0: 
sl@0: 	This endpoint is not available (= no size).
sl@0: */
sl@0: const TUint KUsbEpNotAvailable = 0x00000000;
sl@0: /**	Max packet size is continuously variable up to some size specified.
sl@0: 	(Interrupt and Isochronous endpoints only.)
sl@0: */
sl@0: const TUint KUsbEpSizeCont     = 0x00000001;
sl@0: /** Max packet size 8 bytes is supported
sl@0: */
sl@0: const TUint KUsbEpSize8        = 0x00000008;
sl@0: /** Max packet size 16 bytes is supported
sl@0: */
sl@0: const TUint KUsbEpSize16       = 0x00000010;
sl@0: /** Max packet size 32 bytes is supported
sl@0: */
sl@0: const TUint KUsbEpSize32       = 0x00000020;
sl@0: /** Max packet size 64 bytes is supported
sl@0: */
sl@0: const TUint KUsbEpSize64       = 0x00000040;
sl@0: /** Max packet size 128 bytes is supported
sl@0: */
sl@0: const TUint KUsbEpSize128      = 0x00000080;
sl@0: /** Max packet size 256 bytes is supported
sl@0: */
sl@0: const TUint KUsbEpSize256      = 0x00000100;
sl@0: /** Max packet size 512 bytes is supported
sl@0: */
sl@0: const TUint KUsbEpSize512      = 0x00000200;
sl@0: /** Max packet size 1023 bytes is supported
sl@0: */
sl@0: const TUint KUsbEpSize1023     = 0x00000400;
sl@0: /** Max packet size 1024 bytes is supported
sl@0: */
sl@0: const TUint KUsbEpSize1024     = 0x00000800;
sl@0: 
sl@0: 
sl@0: /** Bitmaps for TUsbcEndpointCaps.iSupportedTypesAndDir.
sl@0: 
sl@0: 	Endpoint supports Control transfer type.
sl@0: */
sl@0: const TUint KUsbEpTypeControl     = 0x00000001;
sl@0: /** Endpoint supports Isochronous transfer type.
sl@0: */
sl@0: const TUint KUsbEpTypeIsochronous = 0x00000002;
sl@0: /** Endpoint supports Bulk transfer type.
sl@0: */
sl@0: const TUint KUsbEpTypeBulk        = 0x00000004;
sl@0: /** Endpoint supports Interrupt transfer type.
sl@0: */
sl@0: const TUint KUsbEpTypeInterrupt   = 0x00000008;
sl@0: /** Endpoint supports IN transfers.
sl@0: */
sl@0: const TUint KUsbEpDirIn           = 0x80000000;
sl@0: /** Endpoint supports OUT transfers.
sl@0: */
sl@0: const TUint KUsbEpDirOut          = 0x40000000;
sl@0: /** Endpoint supports bidirectional (Control) transfers only.
sl@0: */
sl@0: const TUint KUsbEpDirBidirect     = 0x20000000;
sl@0: 
sl@0: 
sl@0: /** Converts an absolute size value into a KUsbEpSize... mask.
sl@0: */
sl@0: static inline TUint PacketSize2Mask(TInt aSize);
sl@0: 
sl@0: /** Converts an endpoint type mask KUsbEpType...  into an endpoint attribute
sl@0: 	value KUsbEpAttr_....
sl@0: */
sl@0: static inline TUint EpTypeMask2Value(TInt aType);
sl@0: 
sl@0: 
sl@0: /** Endpoint capabilities as reported by the driver.
sl@0: */
sl@0: class TUsbcEndpointCaps
sl@0: 	{
sl@0: public:
sl@0: 	/** Returns the greatest available packet size for this endpoint. */
sl@0: 	TInt MaxPacketSize() const;
sl@0: 	/** Returns the smallest available packet size for this endpoint. */
sl@0: 	TInt MinPacketSize() const;
sl@0: public:
sl@0: 	/** The supported maximum packet sizes. */
sl@0: 	TUint iSizes;
sl@0: 	/** The supported endpoint types and directions. */
sl@0: 	TUint iTypesAndDir;
sl@0: 	/** This is a 'high-speed, high bandwidth' endpoint. */
sl@0: 	TBool iHighBandwidth;
sl@0: 	/** Reserved for future use. */
sl@0: 	TUint32 iReserved[2];
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /** Endpoint capabilities as returned by RDevUsbcClient::EndpointCaps().
sl@0: */
sl@0: class TUsbcEndpointData
sl@0: 	{
sl@0: public:
sl@0: 	/** Detail of endpoint capabilities. */
sl@0: 	TUsbcEndpointCaps iCaps;
sl@0: 	/** Indicates whether this endpoint is already claimed. */
sl@0: 	TBool iInUse;
sl@0: 	};
sl@0: 
sl@0: /** The endpoint resource allocation flags;
sl@0: 	used by TUsbcEndpointInfo::iFeatureWord1.
sl@0: 
sl@0: 	@see TUsbcEndpointInfo
sl@0: */
sl@0: const TUint KUsbcEndpointInfoFeatureWord1_DMA             = 0x00000001;
sl@0: const TUint KUsbcEndpointInfoFeatureWord1_DoubleBuffering = 0x00000002;
sl@0: 
sl@0: /** The desired endpoint capabilities used in RDevUsbcClient::SetInterface().
sl@0: */
sl@0: class TUsbcEndpointInfo
sl@0: 	{
sl@0: public:
sl@0: 	TUsbcEndpointInfo(TUint aType=KUsbEpTypeBulk, TUint aDir=KUsbEpDirOut,
sl@0: 					  TInt aSize=0, TInt aInterval=0, TInt aExtra=0);
sl@0: 	/** @internalComponent */
sl@0: 	TInt AdjustEpSizes(TInt& aEpSize_Fs, TInt& aEpSize_Hs) const;
sl@0: 	/** @internalComponent */
sl@0: 	TInt AdjustPollInterval();
sl@0: public:
sl@0: 	/** Endpoint type (mask: KUsbEpTypeControl, etc., but used as value). */
sl@0: 	TUint iType;
sl@0: 	/** Direction (mask: KUsbEpDirIn, etc., but used as value). */
sl@0: 	TUint iDir;
sl@0: 	/** Maximum packet size (literal, no mask). */
sl@0: 	TInt iSize;
sl@0: 	/** Interval for polling full-speed interrupt and isochronous endpoints.
sl@0: 		Expressed either directly in milliseconds with a valid range 1..255
sl@0: 		(interrupt), or for use as 'value' in the expression interval=2^(value-1)
sl@0: 		with a valid range 1..16 (isochronous).
sl@0: 	*/
sl@0: 	TInt iInterval;
sl@0: 	/** Interval for polling high-speed interrupt and isochronous endpoints,
sl@0: 		or to specify the NAK rate for high-speed control and bulk OUT endpoints.
sl@0: 		Expressed either for use as 'value' in the expression interval=2^(value-1)
sl@0: 		with a valid range 1..16 (interrupt and isochronous), or directly as the
sl@0: 		maximum NAK rate with a valid range 0..255 (control and bulk).
sl@0: 	*/
sl@0: 	TInt iInterval_Hs;
sl@0: 	/** The number of additional transactions per uframe to be scheduled (0..2)
sl@0: 		(A value greater than zero is only valid for high-speed high bandwidth
sl@0: 		 interrupt and isochronous endpoints. Also note that there are endpoint size
sl@0: 		 restrictions associated with additional transactions - see 9.6.6.)
sl@0: 	*/
sl@0: 	TInt iTransactions;
sl@0: 	/** The number of extra bytes that the standard endpoint descriptor should be extended by.
sl@0: 		In almost all cases, this should be 0 (zero).
sl@0: 	*/
sl@0: 	TInt iExtra;
sl@0: 	/** 32 flag bits indicating miscellaneous endpoint features.
sl@0: 		Currently defined are:
sl@0: 		- KUsbcEndpointInfoFeatureWord1_DMA             = 0x00000001
sl@0: 		- KUsbcEndpointInfoFeatureWord1_DoubleBuffering = 0x00000002
sl@0: 	*/
sl@0: 	TUint32 iFeatureWord1;
sl@0: 	/** Reserved for future use. */
sl@0: 	TUint32 iReserved;
sl@0: 	};
sl@0: 
sl@0: /** USB Class information used in RDevUsbcClient::SetInterface().
sl@0: */
sl@0: class TUsbcClassInfo
sl@0: 	{
sl@0: public:
sl@0: 	TUsbcClassInfo(TInt aClass=0, TInt aSubClass=0, TInt aProtocol=0);
sl@0: public:
sl@0: 	/** The class type number. */
sl@0: 	TInt iClassNum;
sl@0: 	/** The sub-class type number. */
sl@0: 	TInt iSubClassNum;
sl@0: 	/** The protocol number. */
sl@0: 	TInt iProtocolNum;
sl@0: 	/** Reserved for future use. */
sl@0: 	TUint32 iReserved;
sl@0: 	};
sl@0: 
sl@0: 
sl@0: /** The Ep0 Setup request 'unsubscribe' flag; used by
sl@0: 	TUsbcInterfaceInfo::iFeatureWord. When this bit is set then valid vendor-
sl@0: 	or class-specific Ep0 requests addressed to this interface or any of its
sl@0: 	endpoints will be stalled by the USB PDD PIL.
sl@0: 
sl@0: 	@see TUsbcInterfaceInfo
sl@0: */
sl@0: const TUint KUsbcInterfaceInfo_NoEp0RequestsPlease = 0x00000001;
sl@0: 
sl@0: #include <d32usbcshared.inl>
sl@0: 
sl@0: #endif