#ifndef __CONTROL_TRANSFER_REQUESTS_H

#define __CONTROL_TRANSFER_REQUESTS_H

/*

* Copyright (c) 2007-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:

* @file ControlTransferRequests.h

* @internalComponent

* 

*

*/

#include <e32base.h>

#include <e32ver.h>

#include <d32usbdi.h>

namespace NUnitTesting_USBDI

	{

//These values MUST be kept in line with each other

const _LIT8(KNumberFormatString, "%08d");

const TUint KNumberStringLength = 8;

//These values MUST be kept in line with each other

const _LIT8(KTwoNumberFormatString, "%08d%08d");

const TUint KTwoNumberStringLength = 16;

//These values MUST be kept in line with each other

const _LIT8(KSplitWriteNumberFormatString, "%08d%08d%08d");

const TUint KSplitWriteNumberStringLength = 24;

const TUint KNumSplitWriteSections = 3;

//These values MUST be kept in line with each other

const _LIT8(KClientPassString, "PASS");

const _LIT8(KClientFailString, "FAIL");

const TUint KPassFailStringLength = 4;

const TUint KTestBufferLength = 32; //must be more than KPassFailStringLength

const TUint KMaxSendSize = 2048;	

// ------------- bRequest -----------------

const TUint8 KVendorEmptyRequest(0x00);

const TUint8 KVendorPutPayloadRequest(0x01);

const TUint8 KVendorGetPayloadRequest(0x02);

const TUint8 KVendorGetRecordedNumBytesReadInPayloadRequest (0x03);

const TUint8 KVendorGetRecordedNumBytesWrittenInPayloadRequest (0x04);

const TUint8 KVendorStallRequest(0x05);

const TUint8 KVendorRemoteWakeupRequest(0x06);

const TUint8 KVendorReconnectRequest(0x07);

const TUint8 KVendorWriteToEndpointRequest(0x08);

const TUint8 KVendorPatternWriteToEndpointRequest(0x09);

const TUint8 KVendorCancelWriteToEndpointRequest(0x0a);

const TUint8 KVendorPatternWriteSynchronousToEndpointRequest(0x0b);

const TUint8 KVendorPatternWriteSynchronousToAndHaltEndpointRequest(0x0c);

const TUint8 KVendorStringValidationRequest(0x0d);

const TUint8 KVendorWriteSynchronousCachedReadRequest(0x0e);

const TUint8 KVendorWriteCachedReadRequest(0x0f);

const TUint8 KVendorRepeatedPatternWriteDataRequest (0x10);

const TUint8 KVendorSplitWriteSynchronousCachedReadRequest(0x11);

const TUint8 KVendorReadFromEndpointRequest(0x12);

const TUint8 KVendorReadUntilShortFromEndpointRequest(0x13);

const TUint8 KVendorReadFromAndHaltEndpointRequest(0x14);

const TUint8 KVendorRepeatedReadAndValidateDataRequest(0x15);

const TUint8 KVendorRecordedValidationResultRequest (0x16);

const TUint8 KVendorCancelAnyReadFromEndpointRequest (0x17);

const TUint8 KVendorTestCasePassed(0x20);

const TUint8 KVendorTestCaseFailed(0x21);

const TUint8 KVendorUnrespondRequest(0x22);

const TUint8 KVendorDisconnectDeviceAThenConnectDeviceCRequest(0x23);

const TUint8 KVendorDisconnectDeviceCThenConnectDeviceARequest(0x24);

// class specific

// audio

const TUint8 KAudioClassSetCur(0x01);

// ------------- bmRequestType -----------------

// D7: Data phase transfer direction

const TUint8 KHostToDevice(0x00);

const TUint8 KDeviceToHost(0x80);

// D6..5: Type

const TUint8 KTypeStandard(0x00);

const TUint8 KTypeClass(0x20);

const TUint8 KTypeVendor(0x40);

// D4..0: Recipient

const TUint8 KRecipientDevice(0x00);

const TUint8 KRecipientInterface(0x01);

const TUint8 KRecipientEndpoint(0x02);

const TUint8 KRecipientOther(0x03);

// ------------------------------------------------------------------

// The customised requests (i.e. non standard control requests)

// ------------------------------------------------------------------

/**

This policy class represents the basic control request setup packet

that the user will derive from and customise to describe usable control requests

otherwise with the default values it represents a 'standard device request'

*/

class TControlSetupPacket : public ::RUsbInterface::TUsbTransferRequestDetails

	{

protected:

	TControlSetupPacket()

		{

		iRequestType = 0;

		iRequest = 0;

		iValue = 0;

		iIndex = 0;

		}

	};

/**

This class represents a control request to the client that does not request 

data from the client.  It merely instructs the client

*/

class TEmptyRequest : public TControlSetupPacket

	{

protected:

	TEmptyRequest()

		{

		iRequestType |= KHostToDevice;

		iRequestType |= KTypeVendor;

		iRequest = KVendorEmptyRequest;

		}

	};

/**

 */

 class TDataSendRequest : public TControlSetupPacket

 	{

 	friend class CEp0Transfer;

 protected:

 	TDataSendRequest()

 		{

		iRequestType |= KHostToDevice;

		iRequestType |= KTypeVendor;

		}

 	explicit TDataSendRequest(const TDesC8& aData)

 		{

 		iRequestType |= KHostToDevice;

 		iRequestType |= KTypeVendor;

 		iSendData.Copy(aData);

 		}

 	explicit TDataSendRequest(const TDesC16& aData)

 		{

 		iRequestType |= KHostToDevice;

 		iRequestType |= KTypeVendor;

 		iSendData.Copy(aData);

 		}

 	protected:

 	TBuf8<KMaxSendSize> iSendData;

 	};

/**

*/

class TClassDataSendRequest : public TControlSetupPacket

	{

	friend class CEp0Transfer;

protected:

	explicit TClassDataSendRequest(const TDesC8& aData)

		{

		iRequestType |= KHostToDevice;

		iRequestType |= KTypeClass;

		iSendData.Copy(aData);

		}

	explicit TClassDataSendRequest(const TDesC16& aData)

		{

		iRequestType |= KHostToDevice;

		iRequestType |= KTypeClass;

		iSendData.Copy(aData);

		}

	protected:

	TBuf8<KMaxSendSize> iSendData;

	};

/**

This class represents a control request to the client that requests some data 

in response to the request

*/

class TDataRecvRequest : public TControlSetupPacket

	{

	friend class CEp0Transfer;

protected:

	explicit TDataRecvRequest(TDes8& aData) : iRecvData(aData)

		{

		iRequestType |= KDeviceToHost;

		iRequestType |= KTypeVendor;

		}

protected:

	TDes8& iRecvData;

	};

/**

*/

class TDescriptorGetRequest : public TDataRecvRequest

	{

public:

	/**

	Constructor, build a request to fetch a descriptor from the device

	@param aTypeAndIndex the type of the descriptor and the index

	@param aLanguage Id the identity of the language

	@param aData the symbian descriptor to hold the usb descriptor data 

	*/

	TDescriptorGetRequest(TUint16 aTypeAndIndex,TUint16 aLanguageId,TDes8& aData)

	:	TDataRecvRequest(aData)

		{

		iRequestType = 0; // Will overwrite KTypeVendor in base class

		iRequestType |= KDeviceToHost;	

		iRequest = 0x06; // Standard device GET_DESCRIPTOR

		iValue = aTypeAndIndex;

		iIndex = aLanguageId;

		}

	};

/**

This class represents an empty request that is directed at the device.

i.e. a request that does not require data from the client device

*/

class TEmptyDeviceRequest : public TEmptyRequest

	{

public:

	TEmptyDeviceRequest()

		{

		iRequestType |= KRecipientDevice;

		}

	};

/** 

This class represents an empty request that is directed at the interface.

i.e. a request that does not require data from the client interface

*/

class TEmptyInterfaceRequest : public TEmptyRequest

	{

public:

	explicit TEmptyInterfaceRequest(TUint16 aInterfaceNumber)

		{

		iRequestType |= KRecipientInterface;

		iIndex = aInterfaceNumber;

		}

	};

/**

This class represents a device directed request that send a payload

*/

class TDevicePutPayloadRequest : public TDataSendRequest

	{

public:

	TDevicePutPayloadRequest(const TDesC8& aData) : TDataSendRequest(aData)

		{

		iRequestType |= KRecipientDevice;

		iRequest = KVendorPutPayloadRequest;

		iValue = 0;

		iIndex = 0;

		}

	};

/**

This class represents a device directed request that retrieves a payload

from the client device

*/

class TDeviceGetPayloadRequest : public TDataRecvRequest

	{

public:

	explicit TDeviceGetPayloadRequest(TDes8& aData) : TDataRecvRequest(aData)

		{

		iRequestType |= KRecipientDevice;

		iRequest = KVendorGetPayloadRequest;

		iValue = 0;

		iIndex = 0;

		}

	};

/**

This class represents a device directed request that retrieves a payload

from the client device containing the number of bytes read on an endpoint 

performing a 'Repeated Read'. 

*/

class TInterfaceGetRecordedNumBytesReadInPayload : public TDataRecvRequest

	{

public:

	explicit TInterfaceGetRecordedNumBytesReadInPayload(const TUint16 aInterfaceNumber,const TUint8 aReadEndpointNumber,TDes8& aData) : TDataRecvRequest(aData)

		{

		iRequestType |= KRecipientInterface;

		iRequest = KVendorGetRecordedNumBytesReadInPayloadRequest;

		iValue = aReadEndpointNumber;

		iIndex = aInterfaceNumber;

		}

	};

/**

This class represents a device directed request that retrieves a payload

from the client device containing the number of bytes written on an endpoint 

performing a 'Repeated Write'. 

*/

class TInterfaceGetRecordedNumBytesWrittenInPayload : public TDataRecvRequest

	{

public:

	explicit TInterfaceGetRecordedNumBytesWrittenInPayload(const TUint16 aInterfaceNumber,const TUint8 aWriteEndpointNumber,TDes8& aData) : TDataRecvRequest(aData)

		{

		iRequestType |= KRecipientInterface;

		iRequest = KVendorGetRecordedNumBytesWrittenInPayloadRequest;

		iValue = aWriteEndpointNumber;

		iIndex = aInterfaceNumber;

		}

	};

/**

This class represents an interface directed request that sends a payload

*/

class TInterfacePutPayloadRequest : public TDataSendRequest

	{

public:

	TInterfacePutPayloadRequest(TUint16 aInterfaceNumber,const TDesC8& aData) : TDataSendRequest(aData)

		{

		iRequestType |= KRecipientInterface;

		iRequest = KVendorPutPayloadRequest;

		iValue = 0;

		iIndex = aInterfaceNumber;

		}

	};

/**

This class represents a device directed request that retrieves a payload

from the client device

*/

class TInterfaceGetPayloadRequest : public TDataRecvRequest

	{

public:

	explicit TInterfaceGetPayloadRequest(TUint16 aInterfaceNumber,TDes8& aData) : TDataRecvRequest(aData)

		{

		iRequestType |= KRecipientInterface;

		iRequest = KVendorGetPayloadRequest;

		iValue = 0;

		iIndex = aInterfaceNumber;

		}

	};

/**

This class represents a control request to stall a specified endpoint

*/

class TInterfaceEndpointBaseRequest : public TEmptyRequest

	{

public:

	/**

	Constructor, build a request containing a specified endpoint and a specified interface

	@param aEndpointNumber the endpoint to use

	@param aInterfaceNumber the interface to use

	*/

	TInterfaceEndpointBaseRequest(TUint16 aEndpointNumber,TUint16 aInterfaceNumber)

	: TEmptyRequest()

		{

		iRequestType |= KRecipientInterface;

		iValue = aEndpointNumber;

		iIndex = aInterfaceNumber;

		}

	};

/**

This class represents a control request to stall a specified endpoint

*/

class TStallEndpointRequest : public TInterfaceEndpointBaseRequest

	{

public:

	/**

	Constructor, build a request to stall a specified endpoint

	@param aEndpointNumber the endpoint to stall

	*/

	TStallEndpointRequest(TUint16 aEndpointNumber,TUint16 aInterfaceNumber)

	: TInterfaceEndpointBaseRequest(aEndpointNumber, aInterfaceNumber)

		{

		iRequest = KVendorStallRequest;

		}

	};

/**

This class represents a control request to use a validation previously recorded in the endpoint

to update the interface's PASS\FAIL string.

*/

class TRecordedValidationResultRequest : public TInterfaceEndpointBaseRequest

	{

public:

	/**

	Constructor, build a request to update the interface's PASS\FAIL 

	string using a previously recorded validation.

	@param aEndpointNumber the endpoint to from which to retrieve the previously recorded validation

	*/

TRecordedValidationResultRequest(TUint16 aEndpointNumber,TUint16 aInterfaceNumber)

	: TInterfaceEndpointBaseRequest(aEndpointNumber, aInterfaceNumber)

		{

		iRequest = KVendorRecordedValidationResultRequest;

		}

	};

/**

This class represents a control request to stall a specified endpoint

*/

class TEndpointCancelWriteRequest : public TInterfaceEndpointBaseRequest

	{

public:

	/**

	Constructor, build a request to stall a specified endpoint

	@param aEndpointNumber the endpoint to stall

	*/

	TEndpointCancelWriteRequest(TUint16 aEndpointNumber,TUint16 aInterfaceNumber)

	: TInterfaceEndpointBaseRequest(aEndpointNumber, aInterfaceNumber)

		{

		iRequest = KVendorCancelWriteToEndpointRequest;

		}

	};

/**

This class represents a control request to stall a specified endpoint

*/

class TEndpointCancelReadRequest : public TInterfaceEndpointBaseRequest

	{

public:

	/**

	Constructor, build a request to stall a specified endpoint

	@param aEndpointNumber the endpoint to stall

	*/

	TEndpointCancelReadRequest(TUint16 aEndpointNumber,TUint16 aInterfaceNumber)

	: TInterfaceEndpointBaseRequest(aEndpointNumber, aInterfaceNumber)

		{

		iRequest = KVendorCancelAnyReadFromEndpointRequest;

		}

	};

/**

This class represents a control request to the device to initiate a remote

wake-up after the supplied interval has elapsed.

*/

class TRemoteWakeupRequest : public TEmptyRequest

	{

public:

	explicit TRemoteWakeupRequest(TUint16 aWakeupInterval)

		{

		iRequestType |= KRecipientDevice;

		iRequest = KVendorRemoteWakeupRequest;

		iValue = aWakeupInterval;

		}

	};

/**

This class represents a control request to the device to reconnect to the host after 

the supplied interval has elapsed

*/

class TReconnectRequest : public TEmptyRequest

	{

public:

	explicit TReconnectRequest(TUint16 aReconnectInterval)

		{

		iRequestType |= KRecipientDevice;

		iRequest = KVendorReconnectRequest;

		iValue = aReconnectInterval;		

		}

	};

/**

This class represents a control request to the device to disconnect device A and connect 

device C to the host 

*/

class TDisconnectDeviceAThenConnectDeviceCRequest : public TEmptyRequest

	{

public:

	/**

	Constructor, build a request that informs the client device of a successful test case status

	*/

	TDisconnectDeviceAThenConnectDeviceCRequest()

		{

		iRequestType |= KRecipientDevice;

		iRequest = KVendorDisconnectDeviceAThenConnectDeviceCRequest;

		iValue = KErrNone;

		}

	};

/**

This class represents a control request to the device to disconnect device C and connect 

device A to the host 

*/

class TDisconnectDeviceCThenConnectDeviceARequest : public TEmptyRequest

	{

public:

	/**

	Constructor, build a request that informs the client device of a successful test case status

	*/

	TDisconnectDeviceCThenConnectDeviceARequest()

		{