// Copyright (c) 2006-2010 Nokia Corporation and/or its subsidiary(-ies).

// All rights reserved.

// This component and the accompanying materials are made available

// under the terms of "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:

// This file implements the CIPv4Binder class, which handles the transmission

// of IPv4 data to and from the TCP/IP stack.

// 

//

/**

 @file

*/

#include "OstTraceDefinitions.h"

#ifdef OST_TRACE_COMPILER_IN_USE

#include "IPv4BinderTraces.h"

#endif

#include <etelpckt.h>

#include <in_iface.h>

#include "RawIPFlow.h"

#include "IPv4Binder.h"

#include <comms-infras/linkprovision.h>

#include <u32hal.h>

using namespace ESock;

#ifdef WCDMA_STUB

#include <networking/umtsnifcontrolif.h>

#endif

CIPv4Binder::CIPv4Binder(CRawIPFlow& aFlow)

/**

 * Constructor

 */ 

	: CBinderBase(aFlow),

	  iSpeedMetric(KDefaultSpeedMetric)

	{

	}

CIPv4Binder::~CIPv4Binder()

/**

 *	Destructor

 */

	{

	}

MLowerDataSender* CIPv4Binder::Bind(MUpperDataReceiver* aUpperReceiver, MUpperControl* aUpperControl)

/**

 * Binds TCP/IP protocol to Flow

 *

 * @param aUpperReceiver A pointer to Upper layer Receive class

 * @param aUpperControl A pointer to Upper layer control class

 */

	{

	CBinderBase::Bind(aUpperReceiver, aUpperControl); // Call the superclass's method.

	return this;

	}

TInt CIPv4Binder::Control(TUint aLevel, TUint aName, TDes8& aOption)

/**

 * The main function called by the TCP/IP protocol to control the interface.

 * Can perform a variety of general IP tasks (such as getting IP config)

 * and "3G" specific tasks (such as deleting the context).

 *

 * @param aLevel The level of the interface to control - always KSOLInterface

 * @param aName The command to perform

 * @param aOption Data to be input/output as a result of the command

 * @return Standard error codes

 */

	{

	OstTraceDefExt2(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_CONTROL_1, "CIPv4Binder::Control [aLevel=%d, aName=%d]",aLevel, aName);

	if (aLevel == KSOLInterface)

		{

		switch (aName)

			{

		case KSoIfHardwareAddr:

			// unsupported because we don't have a h/w address

			break;

		// 3G-specific configuration commands are below this point.

#ifdef WCDMA_STUB

		case KRegisterEventHandler:

			// Raw IP NIF Events are not supported

		case KContextSetEvents:

			// Raw IP NIF Events are not supported

			break;

		case KContextCreate:

			// We don't support creating new secondary contexts.

			break;

		case KContextDelete:

			// Deletes the primary PDP context. This will shut down the Nif.

			return DeleteContext(aOption);

		case KContextActivate:

			// If the IPv4 interface is up, then the context will already have

			// been activated. So this command should fail with 

			// KErrAlreadyExists

			{

			TUint8* ptr = CONST_CAST(TUint8*, aOption.Ptr()); 

			TContextParameters* contextParams =

				REINTERPRET_CAST(TContextParameters*, ptr);

			if (contextParams->iContextInfo.iContextId != 

				STATIC_CAST(TInt8, GetFlow().GetBcaController()->Nsapi()))

				{

				contextParams->iReasonCode = KErrNotFound;

				}

			else

				{

				contextParams->iContextInfo.iStatus =

					GetFlow().GetContextStatus();

				contextParams->iReasonCode = KErrAlreadyExists;

				}

			return KErrNone;

			}

		case KNifSetDefaultQoS:

		case KContextQoSSet:

			// Setting the QoS is meaningless over GPRS, so we just return that

			// we don't support these operations.

			break;

		case KContextTFTModify:

			// As we only have one primary context, we don't support anything

			// to do with traffic flow templates, which are used by secondary

			// contexts.

			break;

		case KContextModifyActive:

			// This command is only valid aftermodifying TFT/QoS parameters. 

			// As we don't support any of these operations,

			// this command is never valid.

			break;

#endif

		default:

		(void)aOption;

			break;

			}

		}

	return KErrNotSupported;

	}

TInt CIPv4Binder::GetConfig(TBinderConfig& aConfig)

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_GETCONFIG_1, "CIPv4Binder::GetConfig");

    TBinderConfig4* config = TBinderConfig::Cast<TBinderConfig4>(aConfig);

   	if(config == NULL)

   		{

   		return KErrNotSupported;

   		}

	config->iFamily = KAfInet;		/* KAfInet - selects TBinderConfig4 */

	config->iInfo.iFeatures = KIfCanBroadcast | KIfCanMulticast;		/* Feature flags */

#if defined __EABI__

    // Default value for Tx and Rx packet size

#else // WINS

    // Set default values in case patch is not present in epoc.ini

    config->iInfo.iMtu = KDefaultMtu;

    config->iInfo.iRMtu = KDefaultMtu;

    // for the emulator process is patched via the epoc.ini file

    UserSvr::HalFunction(EHalGroupEmulator,EEmulatorHalIntProperty,(TAny*)"rawip_KMtuIPv4",&(config->iInfo.iMtu));

    UserSvr::HalFunction(EHalGroupEmulator,EEmulatorHalIntProperty,(TAny*)"rawip_KRMtuIPv4",&(config->iInfo.iRMtu));

#endif

	config->iInfo.iSpeedMetric = iSpeedMetric;		/* approximation of the interface speed in Kbps. */

	OstTraceDefExt4(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_GETCONFIG_2, "Local IP address from TBinderConfig = %u.%u.%u.%u",iSettings.iLocalAddr >> 24, (iSettings.iLocalAddr >> 16) & 0xFF, (iSettings.iLocalAddr >> 8) & 0xFF, iSettings.iLocalAddr & 0xFF);   

	config->iAddress.SetAddress(iSettings.iLocalAddr);		/* Interface IP address. */

	config->iNetMask.SetAddress(iSettings.iNetMask);			/* IP netmask. */

	config->iBrdAddr.SetAddress(iSettings.iBroadcastAddr);	/* IP broadcast address. */

	config->iDefGate.SetAddress(iSettings.iDefGateway);		/* IP default gateway or peer address (if known). */

	config->iNameSer1.SetAddress(iSettings.iPrimaryDns);		/* IP primary name server (if any). */

	config->iNameSer2.SetAddress(iSettings.iSecondaryDns);	/* IP secondary name server (if any). */

	return KErrNone;

	}

#ifdef WCDMA_STUB

TInt CIPv4Binder::DeleteContext(TDes8& aContextParameters)

/**

 * Deletes a context. As the NIF is responsible for one primary context,

 * this is equivalent to closing down the NIF.

 *

 * @param aContextParameters Parameters of the context to delete

 * @return KErrArgument if an incorrect structure is passed, otherwise KErrNone

 */

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_DELETECONTEXT_1, "CIPv4Binder::DeleteContext");

	if (aContextParameters.Length() != sizeof(TContextParameters))

		{

		return KErrArgument;

		}

	TUint8* ptr = CONST_CAST(TUint8*, aContextParameters.Ptr());

	TContextParameters* params = REINTERPRET_CAST(TContextParameters*, ptr);

	if (params->iContextInfo.iContextId != 

		STATIC_CAST(TInt8, GetFlow().GetBcaController()->Nsapi()))

		{

		params->iReasonCode = KErrBadName;

		}

	else

		{

		params->iReasonCode = KErrNone; 

		GetFlow().Stop(KErrNone, MNifIfNotify::EDisconnect);

		}

	return KErrNone;

	}

#endif

/**

 * Called when the context has been activated to set our IP address and get

 * any other required settings from CommDB.

 *

 * @param aConfig The new context config

 */

void CIPv4Binder::UpdateContextConfigL(const TPacketDataConfigBase& aConfig)

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_1, "CIPv4Binder::UpdateContextConfig");

	// Get our IP address from the GPRS context config.

	TInetAddr address;

	TBuf<RPacketContext::KMaxPDPAddressLength> tempAddr;

	const RPacketContext::TProtocolConfigOptionV2* pco;

	TInt rel = const_cast<TPacketDataConfigBase&>(aConfig).ExtensionId();

	if (rel == TPacketDataConfigBase::KConfigGPRS) 

	    {

	    tempAddr.Copy(static_cast<const RPacketContext::TContextConfigGPRS&>(aConfig).iPdpAddress);

	    pco = &static_cast<const RPacketContext::TContextConfigGPRS&>(aConfig).iProtocolConfigOption;

	    }

    else

        {

        ASSERT(rel == TPacketDataConfigBase::KConfigRel99Rel4 || rel == TPacketDataConfigBase::KConfigRel5);

	    tempAddr.Copy(static_cast<const RPacketContext::TContextConfigR99_R4&>(aConfig).iPdpAddress);

	    pco = &static_cast<const RPacketContext::TContextConfigR99_R4&>(aConfig).iProtocolConfigOption;

        }

	TInt ret = address.Input(tempAddr);

	// We've got our IP address! Let's save it.

	if (ret == KErrNone)

		{

		iSettings.iLocalAddr = address.Address();

		OstTraceDefExt4(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_2, "Got local IP address from context = %u.%u.%u.%u",iSettings.iLocalAddr >> 24, (iSettings.iLocalAddr >> 16) & 0xFF, (iSettings.iLocalAddr >> 8) & 0xFF, iSettings.iLocalAddr & 0xFF);

		iSettings.iDefGateway = address.Address();

		OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_3, "Set Default Gateway to local IP address");

		}

	else

		{

		OstTraceDef1(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_4, "Couldn't get IP address from GPRS config (err: %d)",ret);

		// Don't leave on this error: we may still be OK if we read some

		// settings from CommDB.

		}

	// @todo - is this correct. We can only get the DNS addresses

	// from the TSY using the iProtocolConfigOption data. Yet a client could

	// access those DNS config details without knowing about the state of the

	// iSettings.iGetDnsFromServer flag.

	if ((iSettings.iGetDnsFromServer) ||

		((iSettings.iPrimaryDns == 0) &&

		 (iSettings.iSecondaryDns == 0)) ) 

		{

		TBuf<RPacketContext::KMaxPDPAddressLength> tempAddr;

		tempAddr.Copy(pco->iDnsAddresses.iPrimaryDns);

		ret = address.Input(tempAddr);

		if (ret == KErrNone)

			{

			iSettings.iPrimaryDns = address.Address();

			OstTraceDefExt4(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_5, "Got primary DNS from context PCO = %u.%u.%u.%u",iSettings.iPrimaryDns >> 24, (iSettings.iPrimaryDns >> 16) & 0xFF, (iSettings.iPrimaryDns >> 8) & 0xFF, iSettings.iPrimaryDns & 0xFF);

			}

		else

			{

			OstTraceDef1(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_6, "Couldn't get primary DNS address from GPRS config (err: %d)",ret);

			// Don't leave on this error: we may still be OK if we read some

			// settings from CommDB.

			}

		tempAddr.Copy(pco->iDnsAddresses.iSecondaryDns);

		ret = address.Input(tempAddr);

		if (ret == KErrNone)

			{

			iSettings.iSecondaryDns = address.Address();

	        OstTraceDefExt4(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_7, "Got secondary DNS from context PCO = %u.%u.%u.%u",iSettings.iSecondaryDns >> 24, (iSettings.iSecondaryDns >> 16) & 0xFF, (iSettings.iSecondaryDns >> 8) & 0xFF, iSettings.iSecondaryDns);

			}

		else

			{

			OstTraceDef1(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_8, "Couldn't get secondary DNS address from GPRS config (err: %d)",ret);

			// Don't leave on this error: we may still be OK if we read some

			// settings from CommDB.

			}

		}

	else

		{

        OstTraceDefExt4(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_9, "Using CommDB DNS address - Primary = %u.%u.%u.%u",iSettings.iPrimaryDns >> 24, (iSettings.iPrimaryDns >> 16) & 0xFF, (iSettings.iPrimaryDns >> 8) & 0xFF, iSettings.iPrimaryDns & 0xFF);

		OstTraceDefExt4(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_10, "                         - Secondary = %u.%u.%u.%u",iSettings.iSecondaryDns >> 24, (iSettings.iSecondaryDns >> 16) & 0xFF, (iSettings.iSecondaryDns >> 8) & 0xFF, iSettings.iSecondaryDns);

		}

	// TProtocolConfigOptionV2::iMiscBuffer is not the correct way to pass a gateway

	// address - data needs to be passed in TLV format but there are no TLV content tags

	// defined for a gateway address and any UMTS/GPRS hardware which claims to be able

	// to supply this address is erroneous (3gpp standard 24.008, section 10.5.6.3).

	// This misuse of iMiscBuffer was preventing other correctly formed parameters from

	// being passed (INC113612).

/*	if (iSettings.iGetGatewayFromServer)

		{

		tempAddr.Copy(aConfig.iProtocolConfigOption.iMiscBuffer);

		ret = address.Input(tempAddr);

		if (ret == KErrNone)

			{

			iSettings.iDefGateway = address.Address();

			LOG_IP_ADDRESS("Got default gateway", iSettings.iDefGateway);

			}

		else

			{

			OstTraceDef1(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_UPDATECONTEXTCONFIGL_4, "Couldn't get default gateway from GPRS config (err: %d)",ret);

			}

		}*/

	}

void CIPv4Binder::UpdateConnectionSpeed(TUint aConnectionSpeed)

/**

 * Sets the speed metric to return to TCP/IP, based on what the TSY tells us.

 *

 * @param aConnectionSpeed Our connection speed

 */

	{

	iSpeedMetric = aConnectionSpeed;

	}

MLowerDataSender::TSendResult CIPv4Binder::Send(RMBufChain& aPdu)

/**

 * Called by the protocol to send an outgoing IP packet to the network.

 *

 * @param aPdu The outgoing packet

 * @return MLowerDataSender::ESendBlocked or ESendAccepted based on state of flow.

 */

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_SEND_1, "CIPv4Binder::Send");

#ifdef __BTT_LOGGING__

	LogPacket(aPdu);

#endif

	// Return ESendBlocked: flow cannot accept any more packets [blocked, queue full, etc]

	// Return ESendAccepted: flow has accepted this packet and can accept another.

	return GetFlow().SendPacket(aPdu, NULL, KIp4FrameType);

	}

TInt CIPv4Binder::Notification(TAgentToNifEventType /*aEvent*/, 

	void* /*aInfo*/)

/**

 * The Nif will ignore any notification sent

 *

 * @param aEvent Not used

 * @param aInfo Not used 

 */

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_NOTIFICATION_1, "CIPv4Binder::Notification");

	return KErrNone;

	}

void CIPv4Binder::StartSending()

/**

 * Indicates to the protocol layer that the NIF is ready to send packets.

 *

 * @param aProtocol A pointer to a protocol

 */

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_STARTSENDING_1, "CIPv4Binder::StartSending()");

	CBinderBase::StartSending();

	}

TBool CIPv4Binder::WantsProtocol(TUint16 aProtocolCode)

/**

 * Indicates the type of protocol implemented by this class.

 *

 * @param aProtocolCode The protocol type

 */

	{

	OstTraceDef1(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_WANTSPROTOCOL_1, "CIPv4Binder::WantsProtocol [aProtocolCode=%X]",aProtocolCode);

#ifdef RAWIP_HEADER_APPENDED_TO_PACKETS

	return ((aProtocolCode & 0x00FF) == KIp4FrameType);

#else

	(void) aProtocolCode;

	return ETrue;

#endif // RAWIP_HEADER_APPENDED_TO_PACKETS

	}

void CIPv4Binder::Process(RMBufChain& aPdu)

/**

 * Called when an incoming IP packet has arrived. Send packets up to the

 * TCP/IP stack.

 *

 * @param aPdu The incoming packet

 */

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_PROCESS_1, "CIPv4Binder::Process");

#ifdef __BTT_LOGGING__

	LogPacket(aPdu);

#endif

	// Pass incoming packets up to the protocol, unless it hasn't

	// been bound yet.

	if (iUpperReceiver)						// ASSERT(iUpperReceiver) ?

		{

		OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_PROCESS_2, "CIPv4Binder: Packet Sent to TCP/IP Protocol!!!");

		iUpperReceiver->Process(aPdu);

		}

	else 

		{

		OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_PROCESS_3, "WARNING: dumping incoming packet, no protocol bound");

		aPdu.Free();

		}

	}

//

// MLowerControl methods

//

TInt CIPv4Binder::GetName(TDes& aName)

/**

*/

	{

	WriteIfName(aName);

	return KErrNone;

	}

//

// CBinderBase methods

//

void CIPv4Binder::SetProvision(const CIPConfig& aProvision)

/**

Set provisioning information for IPv4 binder.

Called from RawIP Flow.

@param aProvision Provisioning structure from Control side.

*/

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_SETPROVISION_1, "CIPv4Binder::SetProvision");

	iSettings.iLocalAddr	 = aProvision.GetIpAddress();

	iSettings.iNetMask		 = aProvision.GetIpNetMask();

	iSettings.iBroadcastAddr = aProvision.GetBroadCastAddr();

	iSettings.iDefGateway	 = aProvision.GetIpGateway();

	iSettings.iPrimaryDns	 = aProvision.GetIp4NameServer1();

	iSettings.iSecondaryDns	 = aProvision.GetIp4NameServer2();

	iSettings.iGetGatewayFromServer = aProvision.GetIpAddrFromServer();

	iSettings.iGetDnsFromServer		= aProvision.GetIp4DNSAddrFromServer();

    OstTraceDefExt4(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_SETPROVISION_2, "Local IP address from Provisioning = %u.%u.%u.%u",iSettings.iLocalAddr >> 24, (iSettings.iLocalAddr >> 16) & 0xFF, (iSettings.iLocalAddr >> 8) & 0xFF, iSettings.iLocalAddr & 0xFF);

	}

#ifdef __BTT_LOGGING__

void CIPv4Binder::LogPacket(const RMBufChain& aPacket)

/**

* Logs packet information into log file.

*

* @param aPacket The packet 

*/

	{

	OstTraceDef0(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_LOGPACKET_1, "CIPv4Binder::LogPacket");

	TInt mBufLength = aPacket.Length() - aPacket.First()->Length();

	OstTraceDef1(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_LOGPACKET_2, "Analysis of %d byte packet:", mBufLength);

	//Note: All the constants used on this method are a pragmatic guess of the

	//IP header fields. The only porpose of this method is logging.

	if (mBufLength < 20)

		{

		OstTraceDef1(OST_TRACE_CATEGORY_DEBUG, TRACE_INTERNALS, CIPV4BINDER_LOGPACKET_3, " -doesn't appear to be a valid IPv4 packet (length=%d)", mBufLength);