/*

* Copyright (c) 2002-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 UmacContextImpl class

*

*/

/*

*/

#ifndef WLANCONTEXTIMPL_H

#define WLANCONTEXTIMPL_H

#ifndef RD_WLAN_DDK

#include <wha_types.h>

#else

#include <wlanwha_types.h>

#endif

#include "Umac.h"

#include "FrameXferBlock.h"

#include "802dot11.h"

#include "umacinternaldefinitions.h"

#include "UmacMib.h"

#include "UmacAuthSeqNmbrExpected.h"

#include "umaceventdispatcher.h"

#include "umacpacketscheduler.h"

#include "umacpacketschedulerclient.h"

#include "umacnullsender.h"

#include "UmacDot11MacError.h"

#include "UmacDot11InitPhase1.h" 

#include "UmacDot11Idle.h"

#include "UmacDot11PrepareForBssMode.h"

#include "UmacDot11DisassociationPending.h"

#include "UmacDot11Synchronize.h"

#include "umacdot11idlescanningmode.h"

#include "UmacDot11ReassociationPending.h"

#include "UmacDot11SoftReset.h"

#include "UmacDot11OpenAuthPending.h"

#include "UmacDot11SharedAuthPending.h"

#include "UmacDot11AssociationPending.h"

#include "UmacDot11DeauthPending.h"

#include "UmacDot11InfrastructureModeInit.h"

#include "UmacDot11PrepareForIbssMode.h"

#include "umacdot11ibssnormalmode.h"

#include "umacdot11ibssscanningmode.h"

#include "umacdot11infrastructurenormalmode.h"

#include "umacdot11infrastructurescanningmode.h"

#include "umacdot11pwrmgmttransitionmode.h"

#include "UmacDot11MibDefaultConfigure.h"

#include "umacconnectcontext.h"

#include "umacprivacymodefilters.h"

#include "UmacTxRateAdaptation.h"

#include "UmacPRNGenerator.h"

#include "umacusertxdatacntx.h"

#include "umacdynamicpowermodemgmtcntx.h"

#include "umacnullsendcontroller.h"

#include "umacsignalpredictor.h"

class WlanMacState;

class WlanConnectContext;

class UmacManagementSideUmacCb;

class WlanAddBroadcastWepKey;

class WlanConfigureTxQueueParams;

class WlanConfigureTxAutoRatePolicy;

class WlanWsaInitiliaze;

class WlanWsaConfigure;

class WlanWsaJoin;

class WlanWsaScan;

class WlanWhaStopScan;

class WlanWsaReadMib;

class WlanWsaWriteMib;

class WlanWsaDisconnect;

class WlanWsaSetBssParameters;

class WlanWsaAddKey;

class WlanWsaRemoveKey;

class WlanWsaSetPsMode;

class WlanWhaConfigureQueue;

class WlanWhaConfigureAc;

class WlanWhaRelease;

struct SWsaCommands;

/**

*  WLAN context implementation

*/

class WlanContextImpl : 

    public WHA::MWhaCb,

    public MWlanPacketSchedulerClient,

    public MWlanNullSender      

    {

public:

    /**

    * Return value type for AddMulticastAddress() method

    */

    enum TGroupAddStatus

        {

        EOk,            

        EFull,          

        EAlreadyExists

        };                      

    /**

    * Lookup table to map 802.11 rate defintions 

    */

    class SupportedRateLookUp

        {

        public: // Methods

            /** Ctor */

            SupportedRateLookUp() : 

                // these initial values don't really matter as they are always

                // overwritten

                iSupportedRate( E802Dot11Rate1MBit ), iWsaRate( 0 ) {};

        private: // Methods

            // Prohibit copy constructor

            SupportedRateLookUp( const SupportedRateLookUp& );

            // Prohibit assigment operator

            SupportedRateLookUp& operator== ( const SupportedRateLookUp&);

        public: // Data

            /** 802.11 rate defintions */

            T802Dot11SupportedRate  iSupportedRate;

            /** corresponding WHA rate */

            TUint32                 iWsaRate;

        };

protected:

    /**

    * The states of the statemachine

    */

    struct States

        {

        public: // Methods

            /**

            * Ctor

            */

            States() {};

        private: // Methods

            // Prohibit assignment operator 

            States& operator= ( const States& );

            // Prohibit copy constructor 

            States( const States& );

        public: // Data

            WlanDot11InitPhase1 iInitPhase1State;

            WlanDot11MibDefaultConfigure iMibDefaultConfigure;

            WlanDot11Idle iIdleState;

            WlanDot11PrepareForBssMode iPrepareForBssMode;

            WlanDot11PrepareForIbssMode iPrepareForIbssMode;  

            WlanDot11OpenAuthPending iOpenAuthPendingState;

            WlanDot11SharedAuthPending iSharedAuthPending;

            WlanDot11AssociationPending iAssociationPendingState;

            WlanDot11InfrastructureModeInit iInfrastructureModeInit;

            WlanDot11IdleScanningMode iIdleScanningMode;

            WlanDot11IbssNormalMode iIbssNormalMode;

            WlanDot11IbssScanningMode iIbssScanningMode;

            WlanDot11InfrastructureScanningMode

                iInfrastructureScanningMode;

            WlanDot11InfrastructureNormalMode 

                iInfrastructureNormalMode;

            WlanDot11PwrMgmtTransitionMode iPwrMgmtTransitionMode;

            WlanDot11DisassociationPending iDisassociationPendingState;

            WlanDot11Synchronize iSynchronizeState;

            WlanDot11ReassociationPending iReassociationPendingState;

            WlanDot11DeauthPending iDeauthPendingState;

            WlanDot11SoftReset iSoftResetState;

            WlanDot11MacError iMacError;

        };

    /**

    * 802.11 management frame templates

    */

    class ManagementFrameTemplates

        {

        public: // Methods

            /** Ctor */

            ManagementFrameTemplates() :

                ialign1( 0 ),

                ialign2( 0 ),

                ialign3( 0 ),

                ialign4( 0 ),

                ialign5( 0 ),

                ialign6( 0 ),

                ialign7( 0 ),

                ialign8( 0 ),

                ialign9( 0 )

                {};

        private: // Methdods

            // Prohibit copy constructor

            ManagementFrameTemplates( const ManagementFrameTemplates& );

            // Prohibit assigment operator

            ManagementFrameTemplates& operator== ( 

                const ManagementFrameTemplates& );

        public: // Data

            /** authenticate frame template */

            SAuthenticationFrame        iAuthenticationFrame;

            /** 

            * 32-bit align 

            * only needed because these structs are packed

            */

            TUint32                     ialign1;

            /** authenticate frame template with HT Control field */

            SHtAuthenticationFrame      iHtAuthenticationFrame;

            /** 

            * 32-bit align 

            * only needed because these structs are packed

            */

            TUint32                     ialign2;

            /** association frame template */

            SAssociationRequestFrame    iAssociationRequestFrame;

            /** 

            * 32-bit align 

            * only needed because these structs are packed

            */

            TUint32                     ialign3;

            /** association frame template with HT Control field */

            SHtAssociationRequestFrame  iHtAssociationRequestFrame;

            /** 

            * 32-bit align 

            * only needed because these structs are packed

            */

            TUint32                     ialign4;

            /** deauthenticate frame template */

            SDeauthenticateFrame        iDeauthenticateFrame;                

            /** 

            * 32-bit align 

            * only needed because these structs are packed

            */

            TUint32                     ialign5;

            /** deauthenticate frame template with HT Control field */

            SHtDeauthenticateFrame      iHtDeauthenticateFrame;                

            /** 

            * 32-bit align 

            * only needed because these structs are packed

            */

            TUint32                     ialign6;

            /** disassociation frame template */

            SDisassociateFrame          iDisassociationFrame;

            /** 

            * 32-bit align 

            * only needed because these structs are packed

            */

            TUint32                     ialign7;

            /** disassociation frame template with HT Control field */

            SHtDisassociateFrame        iHtDisassociationFrame;

            /** 

            * 32-bit align 

            * only needed because these structs are packed

            */

            TUint32                     ialign8;

            /** resassociation frame template */

            SReassociationRequestFrame  iReassociationRequestFrame;

            /** 

            * 32-bit align 

            * only needed because these structs are packed

            */

            TUint32                     ialign9;

            /** resassociation frame template with HT Control field */

            SHtReassociationRequestFrame iHtReassociationRequestFrame;

        };

        /**

        * Container for multicast groups (specified by group mac addresses)

        * that we have joined. 

        *

        * When we have joined any multicast groups

        * we would like to receive only multicast packets that have been

        * sent to those groups.

        */

        class JoinedMulticastGroups

            {            

            public:

                /** Ctor */

                JoinedMulticastGroups();

                /**

                * Adds a group.

                * @param 

                * @return ETrue if aGroup was not fou

                */

                TGroupAddStatus AddGroup( const TMacAddress& aGroup );

                /**

                * Removes a group.

                * @param aGroup Group to be removed

                * @return ETrue if aGroup was found (and hence removed)

                *         EFalse otherwise

                */

                TBool RemoveGroup( const TMacAddress& aGroup );

                /**

                * Returns the number of groups that we are joined into

                * currently.

                * @return The number of groups joined currently.

                */

                TUint8 Count() const;

                /**

                * Gets all the groups by passing back a pointer to the 1st

                * group which is followed by all the other groups that 

                * we are joined into.

                * @return The number of groups (group addresses) returned

                */

                TUint8 GetGroups( const TMacAddress*& aGroups ) const;

                /**

                * Clears the whole container by removing all groups from it

                */

                void Reset();

            private:

                /**

                * Finds aGroup

                * @param aGroup Group to be located

                * @param aIndex Index pointing to aGroup if aGroup was found

                * @return ETrue if aGroup was found

                *         EFalse otherwise

                */

                TBool FindGroup( 

                    const TMacAddress& aGroup, 

                    TUint& aIndex ) const;

                // Prohibit copy constructor

                JoinedMulticastGroups( const JoinedMulticastGroups& );

                // Prohibit assigment operator

                JoinedMulticastGroups& operator= 

                    ( const JoinedMulticastGroups& );

            private: // Data

                /** 

                * The maximum number of multicast groups that we allow.

                * Note that the adaptation layer may support also

                * any smaller number of addresses, including zero

                */

                enum { KMaxNbrOfGroups = 32 };

                /** storage for group entries */

                TMacAddress iStorage[KMaxNbrOfGroups];

                /** is the corresponding storage entry free */

                TBool iFree[KMaxNbrOfGroups];

                /** 

                * 1st free index. As there are no empty storage entries in 

                * the middle, this is also the number of groups that we are

                * joined into currently */

                TUint8 iFirstFreeIndex;

            };

public:

    /**

    * C++ constructor.

    * @param WlanContext context that owns us

    */

    explicit WlanContextImpl( Umac& aUmac ); 

    /**

    * Dtor

    */

    virtual ~WlanContextImpl();

    /**

    * Constructs our supported rates lookup table

    */

    void MakeLookUpTable();

    void AttachWsa( WHA::Wha* aWha );

    void BootUp(

        const TUint8* aPda, 

        TUint32 aPdaLength,

        const TUint8* aFw, 

        TUint32 aFwLength );

    inline WlanManagementSideUmacCb& WlanManagementSideCb() { return iUmac; }

    inline WHA::Wha& Wha() { return *iWha; }

    inline WlanMacState& CurrentState();

    TBool OnDeferredWhaCommandComplete( 

        WHA::TCompleteCommandId aCompleteCommandId, 

        WHA::TStatus aStatus,

        const WHA::UCommandCompletionParams& aCommandCompletionParams );

    TBool OnDeferredInternalEvent( TInternalEvent aInternalEvent );

    inline void RegisterEvent( const TOIDHeader& aOid );

    inline void RegisterEvent( TInternalEvent aInternalEvent );

    inline TBool ChannelEnabled( WlanEventDispatcher::TChannel aChannel ) const;

    inline void Enable( WlanEventDispatcher::TChannel aChannelMask );

    inline void Disable( WlanEventDispatcher::TChannel aChannelMask );

    inline TBool DispatchEvent();

    /**

     * Determines if a command completion event for the specified 

     * command is registered

     *

     * @param aCommandId Id of the command to check

     * @return ETrue if command completion event is registered

     *         EFalse otherwise

     */

    inline TBool CommandCompletionEventRegistered( 

        WHA::TCompleteCommandId aCommandId ) const;

    /**

     * Dispatches a single command completion event

     *

     * @since S60 3.1

     * @return ETrue If a global state change occurred as a result of the event

     *               dispatching

     *         EFalse otherwise

     */

    inline TBool DispatchCommandCompletionEvent();

    inline TBool ProtocolStackTxDataAllowed() const;

    /**

    * Second level initializer. Does statemachine initialization

    * @return ETrue success EFalse failure

    */

    TBool Initialize();

    WlanAddBroadcastWepKey&         AddBroadcastWepKey();

    WlanConfigureTxQueueParams&     ConfigureTxQueueParams();

    WlanConfigureTxAutoRatePolicy&  ConfigureTxAutoRatePolicy();    

    WlanWsaInitiliaze&              WsaInitiliaze();

    WlanWsaConfigure&               WsaConfigure();

    WlanWsaReadMib&                 WsaReadMib();

    WlanWsaWriteMib&                WsaWriteMib();

    WlanWsaJoin&                    WsaJoin();

    WlanWsaScan&                    WsaScan();

    WlanWhaStopScan&                WhaStopScan();

    WlanWsaDisconnect&              WsaDisconnect();

    WlanWsaSetBssParameters&        WsaSetBssParameters();

    WlanWsaAddKey&                  WsaAddKey();

    WlanWhaConfigureQueue&          WhaConfigureQueue();

    WlanWsaSetPsMode&               WsaSetPsMode();

    WlanWhaConfigureAc&             WhaConfigureAc();

    WlanWhaRelease&                 WhaRelease();

    inline void WHASettings( const WHA::SSettings& aSettings );

    inline WHA::SSettings& WHASettings();

    inline const WHA::SSettings& WHASettings() const;

    /**

    * Gets authentication frame template

    * @return authentication frame template

    */

    inline SAuthenticationFrame& GetAuthenticationFrame();

    /**

    * Gets authentication frame template with HT Control field

    * @return authentication frame template

    */

    inline SHtAuthenticationFrame& GetHtAuthenticationFrame();

    /**

    * Gets association request frame template

    * @return association request frame template

    */

    inline SAssociationRequestFrame& GetAssociationRequestFrame();

    /**

    * Gets association request frame template with HT Control field

    * @return association request frame template

    */

    inline SHtAssociationRequestFrame& GetHtAssociationRequestFrame();

    /**

    * Gets deauthenticate frame template

    * @return deauthenticate frame template

    */

    inline SDeauthenticateFrame& GetDeauthenticateFrame();

    /**

    * Gets deauthenticate frame template with HT Control field

    * @return deauthenticate frame template

    */

    inline SHtDeauthenticateFrame& GetHtDeauthenticateFrame();

    /**

    * Gets disassociation frame template

    * @return disassociation frame template

    */

    inline SDisassociateFrame& GetDisassociationFrame();

    /**

    * Gets disassociation frame template with HT Control field

    * @return disassociation frame template

    */

    inline SHtDisassociateFrame& GetHtDisassociationFrame();