/*

* Copyright (c) 2005-2010 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:   Declaration of the DWlanLogicalChannel class.

*

*/

/*

*/

#ifndef DWLANLOGICALCHANNEL_H

#define DWLANLOGICALCHANNEL_H

#include "UmacManagementSideUmacCb.h"

#include "UmacProtocolStackSideUmacCb.h"

#include "wllddlogicalchannelbase.h"

#include "RWlanLogicalChannel.h"

#include "wllddoidmsgstorage.h"

#include "wlldddmausablememory.h"

#include "wllddpowerindicator.h"

#include "wllddpowerhandler.h"

#include "EtherCardApi.h"

#include "FrameXferBlock.h"

class DWlanLogicalDevice;

class Umac;

#ifdef RD_WLAN_DDK

class WlanOsa;

#endif

class DEthernetFrameMemMngr;

class RFrameXferBlock;

class WlanChunk;

class DWlanLogicalChannel : 

    public DWlanLogicalChannelBase,

    public WlanManagementSideUmacCb,

    public WlanProtocolStackSideUmacCb,

    public MWlanPowerIndicator

    {

    // type definitions

    // linked list entry for storing indications

    struct TIndicationListEntry

        {

        TIndication indication;        

        struct TIndicationListEntry *next;

        };

    /** max number of indication list entries */

    enum { KMaxIndicationListEntries = 6 };

public:

#ifndef RD_WLAN_DDK

    DWlanLogicalChannel( 

        DWlanLogicalDevice& aParent, 

        Umac& aUmac,

        TDynamicDfcQue& aDfcQ,

        DMutex& aMutex, 

        DChunk*& aSharedMemoryChunk,

        WlanChunk*& aRxFrameMemoryPool );

#else        

    DWlanLogicalChannel( 

        DWlanLogicalDevice& aParent,

        Umac& aUmac,

        TDynamicDfcQue& aDfcQ,

        WlanOsa*& aOsa,

        DChunk*& aSharedMemoryChunk,

        WlanChunk*& aRxFrameMemoryPool );

#endif        

    virtual ~DWlanLogicalChannel();

    /**

    * Returns a reference to a pointer pointing to the only shared memory

    * chunk instance

    *

    * @return See above

    */

	DChunk*& SharedMemoryChunk();

    /**

    * Sets the number of extra bytes required to align Rx buffer start

    * address, to be returned to WHA layer, to allocation unit boundary

    */

    void SetRxBufAlignmentPadding( TInt aRxBufAlignmentPadding );

    /**

    * Returns the number of extra bytes required to align Rx buffer start

    * address, to be returned to WHA layer, to allocation unit boundary

    * @return See above

    */

    TInt RxBufAlignmentPadding() const;

    /**	

    * Second phase constructor for DLogicalChannelBase objects.

    *

    * It is called in creating thread context in a critical section with

    * no fast mutexes	held.

    * The default implementation does nothing.

    *

    * @since S60 3.1

    * @param	aUnit	Requested unit number

    * @param	aInfo	Additional info supplied by client

    * @param	aVer	Requested interface version

    *

    * @return	KErrNone if construction was successful,

    *           otherwise one of the other system-wide error codes.

    */

	virtual TInt DoCreate(TInt aUnit, const TDesC8* aInfo, const TVersion& aVer);

	/**

	* Processes a message for this logical channel.

	* This function is called in the context of a DFC thread.

    *

    * @since S60 3.1

	* @param aMsg     The message to process.

	*                 The iValue member of this distinguishes the message type:

	*                 iValue==ECloseMsg, channel close message

	*                 iValue==KMaxTInt, a 'DoCancel' message

	*                 iValue>=0, a 'DoControl' message with function number equal to iValue

	*                 iValue<0, a 'DoRequest' message with function number equal to ~iValue

	*/

	virtual void HandleMsg(TMessageBase* aMsg);

    /**

     * Process a function for this logical channel.

     * @param aFunction Defines the operation/function to be performed.

     * @param param     Function specific parameter

     * @return function specific return value.

     */

private:

    /**

    * Called from statemachine when oid has been completed. 

    * Triggers handling of a new oid

    * @param aOid OID handled

    * @param aReason completion code

    */

    virtual void OnOidCompleted( 

        TInt aReason, 

        SOidOutputData& OidOutputData );

    /**

    * Sets the Tx offset for every frame type which can be transmitted

    *

    * @since S60 5.0

    * @param aEthernetFrameTxOffset Tx offset for Ethernet frames and Ethernet

    *        Test frames

    * @param aDot11FrameTxOffset Tx offset for 802.11 frames

    * @param aSnapFrameTxOffset Tx offset for SNAP frames

    */

    virtual void SetMgmtSideTxOffsets( 

        TUint32 aEthernetFrameTxOffset,

        TUint32 aDot11FrameTxOffset,

        TUint32 aSnapFrameTxOffset );

    /**

    * Gets buffer for Rx data

    * @param aLengthinBytes Requested buffer length

    * @return buffer for Rx data upon success

    *         NULL otherwise

    */

    virtual TUint8* GetBufferForRxData( TUint aLengthinBytes );

    /**

    * Completes a data read operation from management side

    *

    * @param aBufferStart first element of the array that holds pointers to

    *        Rx frame meta headers

    * @param aNumOfBuffers number of meta header pointers in the array

    */

    virtual void MgmtDataReceiveComplete( 

        TUint32 aNumOfBuffers );

    /**

    * Completes a data write operation from management side

    * @param aErr completion code 

    */

    virtual void MgmtPathWriteComplete ( TInt aErr );

    /**

    * Sends a indication to the management side

    * @param aIndication indication code 

    */

    virtual void OnInDicationEvent( TIndication aIndication );

    /**

    * Frees the specified Rx frame buffer

    *

    * @param aBufferToFree The buffer to free

    */

    virtual void MarkRxBufFree( TUint8* aBufferToFree );

    /**

    * Sets the Tx offset for every frame type which can be transmitted

    *

    * @since S60 5.0

    * @param aEthernetFrameTxOffset Tx offset for Ethernet frames

    */

    virtual void SetProtocolStackTxOffset( 

        TUint32 aEthernetFrameTxOffset );

    /**

    * Called when the Tx packet in question has been trasferred to the WLAN

    * device.

    * 

    * @param aCompletionCode Status of the operation.

    * @param aMetaHeader Meta header associated with the related Tx packet

    */

    virtual void OnTxProtocolStackDataComplete( 

        TInt aCompletionCode,

        TDataBuffer* aMetaHeader );

    /**

    * Called when a Tx packet - submitted by someone else than the Protocol

    * Stack Side Client - has been trasferred to the WLAN device.

    */

    virtual void OnOtherTxDataComplete();

    /**

    * Called when the Tx of a frame has completed (either successfully or

    * unsuccessfully). 

    */

    virtual void OnTxDataSent();

    virtual TUint8* DmaPrivateTxMemory();

    /**

    * Completes a data read operation from protocol stack side

    *

    * @param aBufferStart first element of the array that holds pointers to

    *        Rx frame meta headers

    * @param aNumOfBuffers number of meta header pointers in the array

    * @return ETrue if this event was processed successfully

    *         EFalse otherwise

    */

    virtual TBool ProtocolStackDataReceiveComplete( 

        TUint32 aNumOfBuffers );

    /**

    * Determines if the Protocol Stack Side client is ready to handle any

    * callbacks from UMAC

    *

    * @return ETrue if the client is ready

    *         EFalse if the client is not ready

    */

    virtual TBool ProtocolStackSideClientReady() const;

    /**

    * From WlanProtocolStackSideUmacCb.

    * Indicates that WLAN Mgmt Client has (re-)enabled protocol stack side

    * user data Tx.

    */

    virtual void UserDataReEnabled();

    virtual void RegisterTimeout( 

        TUint32 aTimeoutInMicroSeconds, 

        TWlanTimer aTimer );

    virtual void CancelTimeout( TWlanTimer aTimer );

    virtual void RegisterDfc( TAny* aCntx );

    virtual void CancelDfc();

    /**

    * Allocates Rx frame meta header

    * @return Rx frame meta header upon success

    *         NULL otherwise

    */

    virtual TDataBuffer* GetRxFrameMetaHeader();

    /**

    * Deallocates Rx frame meta header

    * @param aMetaHeader Meta header to deallocate

    */

    virtual void FreeRxFrameMetaHeader( TDataBuffer* aMetaHeader );

    void DoCancel( TInt aMask );

    TInt DoRequest( 

        TInt aReqNo, 

        TRequestStatus* aStatus, 

        TAny* a1, 

        TAny* a2 );

    TInt OnMgmtSideDoRequest( 

        TInt aReqNo, 

        TRequestStatus* aStatus, 

        TAny* a1, 

        TAny* a2 );

    TInt OnEthernetSideRequest( 

        TInt aReqNo, 

        TRequestStatus* aStatus, 

        TAny* a1, 

        TAny* a2 );

    TInt DoControl( TInt aFunction, TAny* a1, TAny* a2);

    TInt OnMgmtSideControl( TInt aFunction, TAny* a1, TAny* a2 );

    TInt OnEthernetSideControl( TInt aFunction, TAny* a1, TAny* a2 );

    TInt OnInitialiseEthernetFrameBuffers( 

        TSharedChunkInfo* aSharedChunkInfo );

    void OnReleaseEthernetFrameBuffers();

    void TxProtocolStackData();

    void TxManagementData();

    TBool OnReadEthernetFrameRequest();

    /**

    * Stores a indication to indication list

    * @param aIndication indication to be stored

    */

    void StoreIndication( TIndication aIndication );

    /**

    * Gets first stored indication and assigns it to indication buffer

    * @return ETrue a stored indication existed, otherwise EFalse

    */

    TBool GetStoredIndication();

    /**

    * Calls GetStoredIndication() and after that 

    * completes the outstanding request

    */

    void TryToCompleteIndicationRequest();

    /**

    * Relases a indication list entry

    * @param entry to be relased

    */

    void ReleaseIndicationListEntry( TIndicationListEntry* aEntry );

    /**

    * Gets a next free indication list entry

    * @return a next free indication list entry

    */

    TIndicationListEntry* GetFreeIndicationListEntry();

    /**

    * Deallocates the indication list and marks all pointers NULL

    */

    void FreeIndicationList();

    /**

    * Clears all indication list entrys

    */

    void PurgeIndicationList();

    /**

    * From CWlanPhy

    * Registers the notification to the PDD.

    * This request is used for registering indication buffer to PDD

    * @param aBuffer pointer to TIndication 

    */

    void IndicationRequest( TIndication* aBuffer );

    /**

    * From CWlanPhy

    * Releases indication buffer from PDD

    */

	void CancelIndicationRequest();

    /**

    * Called by the PDD when a notification is received.

    */

    void IndicationComplete();

    TBool InitIndicationListEntries();

    /**

    * Default Timer timeout callback function

    *

    * @since S60 3.1

    * @param aPtr A pointer passed to the callback function when called.

    *             This pointer was given to the timer in timer construction.

    */

    static void OnTimeOut( TAny *aPtr );

    /**

    * Voice Call Entry Timer timeout DFC callback method

    *

    * @since S60 3.2

    */

    void RealVoiceCallEntryTimerDfc();

    /**

    * Voice Call Entry Timer timeout DFC callback function

    *

    * @since S60 3.2

    * @param aPtr this pointer (pointer to this object instance)

    */

    static void VoiceCallEntryTimerDfcDoToggle( TAny* aPtr );

    /**

    * Voice Call Entry Timer timeout callback function

    *

    * @since S60 3.2

    * @param aPtr A pointer passed to the callback function when called.

    *             This pointer was given to the timer in timer construction.

    */

    static void OnVoiceCallEntryTimerTimeOut( TAny *aPtr );

    /**

    * Null Timer timeout DFC callback method

    *

    * @since S60 3.2

    */

    void RealNullTimerDfc();

    /**

    * Null Timer timeout DFC callback function

    *

    * @since S60 3.2

    * @param aPtr this pointer (pointer to this object instance)

    */

    static void NullTimerDfcDoToggle( TAny* aPtr );

    /**

    * Null Timer timeout callback function

    *

    * @since S60 3.2

    * @param aPtr A pointer passed to the callback function when called.

    *             This pointer was given to the timer in timer construction.

    */

    static void OnNullTimerTimeOut( TAny *aPtr );

    /**

    * No Voice Timer timeout DFC callback method

    *

    * @since S60 3.2

    */

    void RealNoVoiceTimerDfc();

    /**

    * No Voice Timer timeout DFC callback function

    *

    * @since S60 3.2

    * @param aPtr this pointer (pointer to this object instance)

    */

    static void NoVoiceTimerDfcDoToggle( TAny* aPtr );

    /**

    * No Voice Timer timeout callback function

    *

    * @since S60 3.2

    * @param aPtr A pointer passed to the callback function when called.

    *             This pointer was given to the timer in timer construction.

    */

    static void OnNoVoiceTimerTimeOut( TAny *aPtr );

    /**

    * Keep Alive Timer timeout DFC callback method

    *

    * @since S60 3.2

    */

    void RealKeepAliveTimerDfc();

    /**

    * Keep Alive Timer timeout DFC callback function

    *

    * @since S60 3.2

    * @param aPtr this pointer (pointer to this object instance)

    */

    static void KeepAliveTimerDfcDoToggle( TAny* aPtr );

    /**

    * Keep Alive Timer timeout callback function

    *

    * @since S60 3.2

    * @param aPtr A pointer passed to the callback function when called.

    *             This pointer was given to the timer in timer construction.

    */

    static void OnKeepAliveTimerTimeOut( TAny *aPtr );

    /**

    * Active to Light PS Timer timeout DFC callback method

    *

    * @since S60 5.1

    */

    void RealActiveToLightPsTimerDfc();

    /**

    * Active to Light PS Timer timeout DFC callback function

    *