// Copyright (c) 2000-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/drivers/usbcc/chapter9.cpp

// Platform independent layer (PIL) of the USB Device controller driver:

// Processing of USB spec chapter 9 standard requests.

// 

//

/**

 @file chapter9.cpp

 @internalTechnology

*/

#include <drivers/usbc.h>

//#define ENABLE_EXCESSIVE_DEBUG_OUTPUT

//

// The way functions are called after an request has been completed by the PSL:

//

//                                         Ep0RequestComplete

//                                                 |

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

//                                       |                                                |

//                              ProcessEp0ReceiveDone                            ProcessEp0TransmitDone

//                                       |                                                |

//                   ---------------------------------------                              |

//                  |                                       |                             |

//        ProcessEp0SetupReceived                 ProcessEp0DataReceived        ProcessDataTransferDone

//                  |                                       |

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

//        |                     |                    |               |

//   ProcessXXX       ProcessDataTransferDone   ProceedXXX  ProcessDataTransferDone

//

//   XXX = Specific_Request

//

//

// === USB Controller member function implementation - PSL API (protected) ========================

//

/** Used to synchronize the Ep0 state machine between the PSL and PIL.

	Accepts a SETUP packet and returns the next Ep0 state.

	@param aSetupBuf The SETUP packet just received by the PSL.

	@return The next Ep0 state.

	@publishedPartner @released

*/

TUsbcEp0State DUsbClientController::EnquireEp0NextState(const TUint8* aSetupBuf) const

	{

	__KTRACE_OPT(KUSB, Kern::Printf("DUsbClientController::EnquireEp0NextState()"));

	// This function may be called by the PSL from within an ISR -- so we have

	// to take care what we do here (and also in all functions that get called

	// from here).

	if (SWAP_BYTES_16((reinterpret_cast<const TUint16*>(aSetupBuf)[3])) == 0) // iLength

		{

		__KTRACE_OPT(KUSB, Kern::Printf("  --> EEp0StateStatusIn"));

		return EEp0StateStatusIn;							// No-data Control => Status_IN

		}

	else if ((aSetupBuf[0] & KUsbRequestType_DirMask) == KUsbRequestType_DirToDev)

		{

		__KTRACE_OPT(KUSB, Kern::Printf("  --> EEp0StateDataOut"));

		return EEp0StateDataOut;							// Control Write => Data_OUT

		}

	else

		{

		__KTRACE_OPT(KUSB, Kern::Printf("  --> EEp0StateDataIn"));

		return EEp0StateDataIn;								// Control Read => Data_IN

		}

	}

TInt DUsbClientController::ProcessEp0ReceiveDone(TInt aCount)

	{

	__KTRACE_OPT(KUSB, Kern::Printf("DUsbClientController::ProcessEp0ReceiveDone()"));

	TInt r;

	if (iEp0DataReceiving == EFalse)

		{

		// It's obviously a Setup packet, so...

		r = ProcessEp0SetupReceived(aCount);

		}

	else

		{

		// If it isn't a Setup, it must be data...

		// (This is actually not quite true, as it could also be - in theory - a new Setup packet

		//  when the host has abandoned, for whatever reason, the previous one which was still

		//  in progress. However no such case is known to have occurred with this driver, or at

		//  least it didn't lead to problems.

		//  Some UDCs have a dedicated interrupt for Setup packets, but so far this driver hasn't

		//  made use of such a feature (as it would require a PSL/PIL API change).)

		r = ProcessEp0DataReceived(aCount);

		}

	return r;

	}

TInt DUsbClientController::ProcessEp0TransmitDone(TInt aCount, TInt aError)

	{

	__KTRACE_OPT(KUSB, Kern::Printf("DUsbClientController::ProcessEp0TransmitDone()"));

	// In any case: there's now no longer a write pending

	iEp0WritePending = EFalse;

	// If it was a client who set up this transmission, we report to that client

	if (iEp0ClientDataTransmitting)

		{

		iEp0ClientDataTransmitting = EFalse;

		TUsbcRequestCallback* const p = iRequestCallbacks[KEp0_Tx];

		if (p)

			{

			__ASSERT_DEBUG((p->iTransferDir == EControllerWrite), Kern::Fault(KUsbPILPanicCat, __LINE__));

			p->iError = aError;

			p->iTxBytes = aCount;

			ProcessDataTransferDone(*p);

			return KErrNone;

			}

		__KTRACE_OPT(KPANIC, Kern::Printf("  Error: DUsbClientController::ProcessEpTransmitDone: Stalling Ep0"));

		StallEndpoint(KEp0_In);								// request not found

		return KErrNotFound;

		}

	// If _we_ sent the data, we simply do nothing here...

	return KErrNone;

	}

#define USB_PROCESS_REQUEST(request) \

	if (Process ## request(packet) != KErrNone) \

		{ \

		__KTRACE_OPT(KUSB, \

					 Kern::Printf("  ProcessEp0SetupReceived: Stalling Ep0")); \

		StallEndpoint(KEp0_In); \

		}

TInt DUsbClientController::ProcessEp0SetupReceived(TInt aCount)

	{

	__KTRACE_OPT(KUSB, Kern::Printf("DUsbClientController::ProcessEp0SetupReceived()"));

	if (aCount > iEp0MaxPacketSize)

		{

		// Fatal error: too much data!

		aCount = iEp0MaxPacketSize;

		}

	// first we split the data into meaningful units:

	TUsbcSetup packet;

	Buffer2Setup(iEp0_RxBuf, packet);

#if defined(_DEBUG) && defined(ENABLE_EXCESSIVE_DEBUG_OUTPUT)

	// let's see what we've got:

	__KTRACE_OPT(KUSB, Kern::Printf("  bmRequestType = 0x%02x", packet.iRequestType));

	if ((packet.iRequestType & KUsbRequestType_TypeMask) == KUsbRequestType_TypeStd)

		{

		switch (packet.iRequest)

			{

		case KUsbRequest_GetStatus:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (GET_STATUS)",

											KUsbRequest_GetStatus));

			break;

		case KUsbRequest_ClearFeature:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (CLEAR_FEATURE)",

											KUsbRequest_ClearFeature));

			break;

		case KUsbRequest_SetFeature:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (SET_FEATURE)",

											KUsbRequest_SetFeature));

			break;

		case KUsbRequest_SetAddress:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (SET_ADDRESS)",

											KUsbRequest_SetAddress));

			break;

		case KUsbRequest_GetDescriptor:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (GET_DESCRIPTOR)",

											KUsbRequest_GetDescriptor));

			break;

		case KUsbRequest_SetDescriptor:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (SET_DESCRIPTOR)",

											KUsbRequest_SetDescriptor));

			break;

		case KUsbRequest_GetConfig:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (GET_CONFIGURATION)",

											KUsbRequest_GetConfig));

			break;

		case KUsbRequest_SetConfig:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (SET_CONFIGURATION)",

											KUsbRequest_SetConfig));

			break;

		case KUsbRequest_GetInterface:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (GET_INTERFACE)",

											KUsbRequest_GetInterface));

			break;

		case KUsbRequest_SetInterface:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (SET_INTERFACE)",

											KUsbRequest_SetInterface));

			break;

		case KUsbRequest_SynchFrame:

			__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (SYNCH_FRAME)",

											KUsbRequest_SynchFrame));

			break;

		default:

			__KTRACE_OPT(KPANIC, Kern::Printf("  Error: bRequest = 0x%02x (UNKNWON STANDARD REQUEST)",

											  packet.iRequest));

			break;

			}

		}

	else

		{

		__KTRACE_OPT(KUSB, Kern::Printf("  bRequest      = 0x%02x (NON-STANDARD REQUEST)",

										packet.iRequest));

		}

	__KTRACE_OPT(KUSB, Kern::Printf("  wValue        = 0x%04x", packet.iValue));

	__KTRACE_OPT(KUSB, Kern::Printf("  wIndex        = 0x%04x", packet.iIndex));

	__KTRACE_OPT(KUSB, Kern::Printf("  wLength       = 0x%04x", packet.iLength));

#endif // defined(_DEBUG) && defined(ENABLE_EXCESSIVE_DEBUG_OUTPUT)

	// now the actual analysis

	if ((packet.iRequestType & KUsbRequestType_TypeMask) == KUsbRequestType_TypeStd)

		{

		iEp0ReceivedNonStdRequest = EFalse;

		switch (packet.iRequest)

			{

		case KUsbRequest_GetStatus:

			switch (packet.iRequestType & KUsbRequestType_DestMask)

				{ // Recipient

			case KUsbRequestType_DestDevice:

				USB_PROCESS_REQUEST(GetDeviceStatus);

				break;

			case KUsbRequestType_DestIfc:

				USB_PROCESS_REQUEST(GetInterfaceStatus);

				break;

			case KUsbRequestType_DestEp:

				USB_PROCESS_REQUEST(GetEndpointStatus);

				break;

			default:

				__KTRACE_OPT(KPANIC, Kern::Printf("  Error: GET STATUS - Other or Unknown recipient"));

				__KTRACE_OPT(KPANIC, Kern::Printf("  -> DUsbClientController::ProcessEp0SetupReceived: "

												  "Stalling Ep0"));

				StallEndpoint(KEp0_In);

				break;

				}

			break;

		case KUsbRequest_ClearFeature:

		case KUsbRequest_SetFeature:

			switch (packet.iRequestType & KUsbRequestType_DestMask)

				{ // Recipient

			case KUsbRequestType_DestDevice:

				USB_PROCESS_REQUEST(SetClearDevFeature);

				break;

			case KUsbRequestType_DestIfc:

				USB_PROCESS_REQUEST(SetClearIfcFeature);

				break;

			case KUsbRequestType_DestEp:

				USB_PROCESS_REQUEST(SetClearEpFeature);

				break;

			default:

				__KTRACE_OPT(KPANIC, Kern::Printf("  Error: SET/CLEAR FEATURE - "

												  "Other or Unknown recipient"));

				__KTRACE_OPT(KPANIC, Kern::Printf("  -> Stalling Ep0"));

				StallEndpoint(KEp0_In);

				break;

				}

			break;

		case KUsbRequest_SetAddress:

			USB_PROCESS_REQUEST(SetAddress);

			break;

		case KUsbRequest_GetDescriptor:

			USB_PROCESS_REQUEST(GetDescriptor);

			break;

		case KUsbRequest_SetDescriptor:

			USB_PROCESS_REQUEST(SetDescriptor);

			break;

		case KUsbRequest_GetConfig:

			USB_PROCESS_REQUEST(GetConfiguration);

			break;

		case KUsbRequest_SetConfig:

			USB_PROCESS_REQUEST(SetConfiguration);

			break;

		case KUsbRequest_GetInterface:

			USB_PROCESS_REQUEST(GetInterface);

			break;

		case KUsbRequest_SetInterface:

			USB_PROCESS_REQUEST(SetInterface);

			break;

		case KUsbRequest_SynchFrame:

			USB_PROCESS_REQUEST(SynchFrame);

			break;

		default:

			__KTRACE_OPT(KPANIC, Kern::Printf("  Error: Unknown/unsupported Std Setup Request"));

			__KTRACE_OPT(KPANIC, Kern::Printf("  -> Stalling Ep0"));

			StallEndpoint(KEp0_In);

			break;

			}

		}

	else

		{

		// Type mask != KUsbRequestType_TypeStd => class- or vendor-specific request

        iEp0ReceivedNonStdRequest = ETrue;

		const DBase* client = NULL;

		switch (packet.iRequestType & KUsbRequestType_DestMask)

			{ // Recipient

		case KUsbRequestType_DestDevice:

			client = iEp0DeviceControl;

			break;

		case KUsbRequestType_DestIfc:

		    //Add this mutex to protect the interface set data structure

		    if (NKern::CurrentContext() == EThread)

		        {

		        NKern::FMWait(&iMutex);

		        }

			if (iTrackDeviceState && iDeviceState < EUsbcDeviceStateConfigured)

				{

				__KTRACE_OPT(KPANIC, Kern::Printf("  Error: Invalid device state"));

				}

			else

				{

				const TUsbcInterfaceSet* const ifcset_ptr =

					InterfaceNumber2InterfacePointer(packet.iIndex);

				//In some rare case, ifcset_ptr is not NULL but the ifcset_ptr->iInterfaces.Count() is 0,

				//so panic will happen when excute the following line. so I add the conditon

				//0 != ifcset_ptr->iInterfaces.Count() here.

				if (ifcset_ptr && 0 != ifcset_ptr->iInterfaces.Count())

					{

					if (ifcset_ptr->CurrentInterface()->iNoEp0Requests)

						{

						__KTRACE_OPT(KUSB, Kern::Printf("  Recipient says: NoEp0RequestsPlease"));

						}

					else

						{

						client = ifcset_ptr->iClientId;

						}

					}

				else

					{

					__KTRACE_OPT(KPANIC, Kern::Printf("  Error: Interface 0x%02x does not exist",

													  packet.iIndex));

					}

				}

	        if (NKern::CurrentContext() == EThread)

	            {

                NKern::FMSignal(&iMutex);

	            }

			break;

		case KUsbRequestType_DestEp:

		    //Add this mutex to protect the interface set data structure

	        if (NKern::CurrentContext() == EThread)

	            {

                NKern::FMWait(&iMutex);

	            }

			if (iTrackDeviceState && iDeviceState < EUsbcDeviceStateConfigured)

				{

				__KTRACE_OPT(KPANIC, Kern::Printf("  Error: Invalid device state"));

				}

			else if (EndpointExists(packet.iIndex) == EFalse)

				{

				__KTRACE_OPT(KPANIC, Kern::Printf("  Error: Endpoint 0x%02x does not exist",

												  packet.iIndex));

				}

			else

				{

				const TInt idx = EpAddr2Idx(packet.iIndex);

				const TUsbcInterfaceSet* const ifcset_ptr =

					iRealEndpoints[idx].iLEndpoint->iInterface->iInterfaceSet;

				if (ifcset_ptr->CurrentInterface()->iNoEp0Requests)

					{

					__KTRACE_OPT(KUSB, Kern::Printf("  Recipient says: NoEp0RequestsPlease"));

					}

				else

					{

					client = ifcset_ptr->iClientId;

					}

				}

            if (NKern::CurrentContext() == EThread)

                {

                NKern::FMSignal(&iMutex);

                }

			break;

		default:

			__KTRACE_OPT(KPANIC, Kern::Printf("  Error: Other or Unknown recipient"));

			break;

			}

		if (client != NULL)

			{

			// Try to relay packet to the appropriate recipient

			TSglQueIter<TUsbcRequestCallback> iter(iEp0ReadRequestCallbacks);

			TUsbcRequestCallback* p;

			while ((p = iter++) != NULL)

				{

				if (p->Owner() == client)

					{

					__ASSERT_DEBUG((p->iEndpointNum == 0), Kern::Fault(KUsbPILPanicCat, __LINE__));

					__ASSERT_DEBUG((p->iTransferDir == EControllerRead), Kern::Fault(KUsbPILPanicCat, __LINE__));

					__KTRACE_OPT(KUSB, Kern::Printf("  Found Ep0 read request"));

					if (packet.iLength != 0)

						{

						if ((packet.iRequestType & KUsbRequestType_DirMask) == KUsbRequestType_DirToDev)

							{

							// Data transfer & direction OUT => there'll be a DATA_OUT stage

							__KTRACE_OPT(KUSB, Kern::Printf("  Next is DATA_OUT: setting up DataOutVars"));

							SetEp0DataOutVars(packet, client);

							}

						else if ((packet.iRequestType & KUsbRequestType_DirMask) == KUsbRequestType_DirToHost)

							{

							// For possible later use (ZLP).

							iEp0_TxNonStdCount = packet.iLength;

							}

						}

					memcpy(p->iBufferStart, iEp0_RxBuf, aCount);

					p->iError = KErrNone;					// if it wasn't 'KErrNone' we wouldn't be here

					*(p->iPacketSize) = aCount;

					p->iRxPackets = 1;

					*(p->iPacketIndex) = 0;

					ProcessDataTransferDone(*p);

					return KErrNone;

					}

				}

			__KTRACE_OPT(KUSB, Kern::Printf("  Ep0 read request not found: setting RxExtra vars (Setup)"));

			iEp0_RxExtraCount = aCount;

			iEp0_RxExtraData = ETrue;

			return KErrNotFound;

			}

		else // if (client == NULL)

			{

			__KTRACE_OPT(KPANIC, Kern::Printf("  Ep0 request error: Stalling Ep0"));

			StallEndpoint(KEp0_In);

			return KErrGeneral;

			}

		}

	return KErrNone;

	}

#undef USB_PROCESS_REQUEST

TInt DUsbClientController::ProcessEp0DataReceived(TInt aCount)

	{

	__KTRACE_OPT(KUSB, Kern::Printf("DUsbClientController::ProcessEp0DataReceived()"));

	__KTRACE_OPT(KUSB, Kern::Printf("  : %d bytes", aCount));

	if (aCount > iEp0MaxPacketSize)

		{

		__KTRACE_OPT(KPANIC, Kern::Printf("  Error: Too much data"));

		aCount = iEp0MaxPacketSize;

		}

	iEp0DataReceived += aCount;

	if (iEp0ClientId == NULL)

		{

		// it is us (not an app), who owns this transaction

		switch (iSetup.iRequest)

			{

#ifdef USB_SUPPORTS_SET_DESCRIPTOR_REQUEST

		case KUsbRequest_SetDescriptor:

			memcpy(iEp0_RxCollectionBuf + iEp0DataReceived, iEp0_RxBuf, aCount);

			ProceedSetDescriptor();

			break;

#endif

		default:

			__KTRACE_OPT(KPANIC, Kern::Printf("  Error: invalid request in iSetup"));

			__KTRACE_OPT(KPANIC, Kern::Printf("  -> DUsbClientController::ProcessEp0DataReceived: Stalling Ep0"));

			StallEndpoint(KEp0_In);

			ResetEp0DataOutVars();

			break;

			}

		}

	else

		{

		// pass the data on to a client

		TSglQueIter<TUsbcRequestCallback> iter(iEp0ReadRequestCallbacks);

		TUsbcRequestCallback* p;

		while ((p = iter++) != NULL)

			{

			if (p->Owner() == iEp0ClientId)

				{

				__ASSERT_DEBUG((p->iEndpointNum == 0), Kern::Fault(KUsbPILPanicCat, __LINE__));

				__ASSERT_DEBUG((p->iTransferDir == EControllerRead), Kern::Fault(KUsbPILPanicCat, __LINE__));

				__KTRACE_OPT(KUSB, Kern::Printf("  Found Ep0 read request"));

				memcpy(p->iBufferStart, iEp0_RxBuf, aCount);

				p->iError = KErrNone;						// if it wasn't 'KErrNone' we wouldn't be here

				*(p->iPacketSize) = aCount;

				p->iRxPackets = 1;

				*(p->iPacketIndex) = 0;

				ProcessDataTransferDone(*p);

				goto found;

				}

			}

		__KTRACE_OPT(KUSB, Kern::Printf("  Ep0 read request not found: setting RxExtra vars (Data)"));

		iEp0_RxExtraCount = aCount;

		iEp0_RxExtraData = ETrue;

		iEp0DataReceived -= aCount;

		return KErrNotFound;

		}

 found:

	if (iEp0DataReceived >= iSetup.iLength)

		{

		// all data seems now to be here

		ResetEp0DataOutVars();

		}

	return KErrNone;

	}

// --- The USB Spec Chapter 9 Standard Endpoint Zero Device Requests ---

TInt DUsbClientController::ProcessGetDeviceStatus(const TUsbcSetup& aPacket)

	{

	__KTRACE_OPT(KUSB, Kern::Printf("DUsbClientController::ProcessGetDeviceStatus()"));

	if (iTrackDeviceState && iDeviceState < EUsbcDeviceStateAddress)

		{

		__KTRACE_OPT(KPANIC, Kern::Printf("  Error: Invalid device state"));

		return KErrGeneral;

		}

	const TUint16 status = ((DeviceSelfPowered() ? KUsbDevStat_SelfPowered : 0) |

					  (iRmWakeupStatus_Enabled ? KUsbDevStat_RemoteWakeup : 0));

	__KTRACE_OPT(KUSB, Kern::Printf("  Reporting device status: 0x%02x", status));