/*

* Copyright (c) 2002-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:   Declaration of the WlanDot11State class

*

*/

/*

* %version: 57 %

*/

#ifndef WLANDOT11STATE_H

#define WLANDOT11STATE_H

#include "umacinternaldefinitions.h"

#include "UmacMacActionState.h"

class WlanWsaAddKey;

class WlanElementLocator;

/**

*  ?one_line_short_description.

*  ?other_description_lines

*

*  @lib wlanumac.lib

*  @since S60 3.1

*/

class WlanDot11State : public WlanMacActionState

    {

public:

    /**

    * Destructor.

    */

    virtual ~WlanDot11State() {};

    void AddDefaultBroadcastWepKeyComplete( 

        WlanContextImpl& aCtxImpl ) const;

    // Functions from base classes

    /**

    * Scan all available networks. 

    * This SW module decides is background scan or foreground scan used

    * @param aCtxImpl statemachine context

    * @param aMode passive or active scan see #TScanMode

    * @param aSSID Network that APs are scanned. Can be broadcast SSID.

    * @param aScanRate Rate that is used in active scanning see #TRate

    * @param aMinChannelTime min. time to listen beacons/probe responses on 

    *                        a channel

    * @param aMaxChannelTime max. time to listen beacons/probe responses on 

    *                        a channel

    * @param aSplitScan if ETrue, use split scan

    * @return KErrNone = command completed successfully, 

    * any other = failure

    */

    virtual TBool Scan(

        WlanContextImpl& aCtxImpl,

        TScanMode aMode,                    

        const TSSID& aSSID,                 

        TRate aScanRate, 

        SChannels& aChannels,

        TUint32 aMinChannelTime,            

        TUint32 aMaxChannelTime,

        TBool aSplitScan );               

    /**

    * From WlanMacState.

    * Stop a previously started scan process. 

    *

    * @since S60 3.2

    * @param aCtxImpl global statemachine context

    * @return ETrue if a state transition occurred

    *         EFalse otherwise

    */

    virtual TBool StopScan( WlanContextImpl& aCtxImpl );

    /**

    * From WlanMacState.

    * Set 802.11 power mgmt mode in infrastructure networks.

    * @param aCtxImpl statemachine context

    * @param aPowerMode desired power mode

    * @param aDisableDynamicPowerModeManagement If ETrue, disables the dynamic

    *        power mode management handling. Relevant only when aPowerMode

    *        is EPowerModePs

    * @param aWakeupModeInLightPs WLAN wake-up mode in Light PS mode

    * @param aListenIntervalInLightPs specifies the value of N for wake-up

    *        modes 2 and 3 in Light PS mode. 

    * @param aWakeupModeInDeepPs WLAN wake-up mode in Deep PS mode

    * @param aListenIntervalInDeepPs specifies the value of N for wake-up 

    *        modes 2 and 3 in Deep PS mode

    * @return ETrue if a state transition occurred

    *         EFalse otherwise

    */

    virtual TBool SetPowerMode(

        WlanContextImpl& aCtxImpl,

        TPowerMode aPowerMode,

        TBool aDisableDynamicPowerModeManagement,

        TWlanWakeUpInterval aWakeupModeInLightPs, 

        TUint8 aListenIntervalInLightPs,

        TWlanWakeUpInterval aWakeupModeInDeepPs,

        TUint8 aListenIntervalInDeepPs );

    /**

    * Enable user data from/to protcol stack 

    * (802.1x: pass data through after succesfull authentication)

    * @param aCtxImpl statemachine context

    * @return KErrNone command completed successfully 

    */

    virtual TBool EnableUserData(

        WlanContextImpl& aCtxImpl );

    /**

    * Disable user data from/to protcol stack 

    * (802.1x: block data during authentication).

    * @param aCtxImpl global state machine context

    * @return KErrNone command completed successfully 

    * any other = failure

    */

    virtual TBool DisableUserData(

        WlanContextImpl& aCtxImpl );

    /**

    * Transmit a protocol stack frame

    * 

    * The frame to be sent needs to be in 802.3 format

    * @param aCtxImpl global state machine context

    * @param aDataBuffer meta header of the frame to be transmitted

    * @param aMore ETrue if another frame is also ready to be transmitted

    *              EFalse otherwise

    */

    virtual TBool TxData( 

        WlanContextImpl& aCtxImpl,

        TDataBuffer& aDataBuffer,

        TBool aMore );

    virtual void TxMgmtData( 

        WlanContextImpl& aCtxImpl,

        TDataBuffer& aDataBuffer );

    // Frame receive

    virtual TAny* RequestForBuffer ( 

        WlanContextImpl& aCtxImpl,             

        TUint16 aLength );

    virtual void ReceivePacket( 

        WlanContextImpl& aCtxImpl, 

        WHA::TStatus aStatus,

        const void* aFrame,

        TUint16 aLength,

        WHA::TRate aRate,

        WHA::TRcpi aRcpi,

        WHA::TChannelNumber aChannel,

        TUint8* aBuffer,

        TUint32 aFlags );

    // from packet scheduler

    /**

     * Method called when packet has been transferred to the WLAN device

     *

     * @since S60 3.1

     * @param aCtxImpl global state machine context

     * @param aPacketId packet whose transfer is complete

     * @param aMetaHeader frame meta header

     */

    virtual void OnPacketTransferComplete( 

        WlanContextImpl& aCtxImpl, 

        TUint32 aPacketId,

        TDataBuffer* aMetaHeader );

    virtual void OnPacketSendComplete(

        WlanContextImpl& aCtxImpl, 

        WHA::TStatus aStatus,

        TUint32 aPacketId,

        WHA::TRate aRate,

        TUint32 aPacketQueueDelay,

        TUint32 aMediaDelay,

        TUint aTotalTxDelay,

        TUint8 aAckFailures,

        WHA::TQueueId aQueueId,

        WHA::TRate aRequestedRate,

        TBool aMulticastData );

    /**

    * Method called when Packet Scheduler's packet scheduling method 

    * should be called, as there exists a packet that is suitable for 

    * transmission.

    * NOTE: if any other Packet Scheduler method is called within this

    * context the result is undefined.

    * 

    * @param aMore ETrue if another frame is also ready to be transmitted

    *              EFalse otherwise

    */

    virtual void CallPacketSchedule( 

        WlanContextImpl& aCtxImpl,

        TBool aMore );

    /**

     * Method called when packet has been flushed (removed)

     * from packet scheduler

     *

     * @since S60 3.1

     * @param aCtxImpl global state machine context

     * @param aPacketId packet that was flushed

     * @param aMetaHeader frame meta header

     */

    virtual void OnPacketFlushEvent(

        WlanContextImpl& aCtxImpl, 

        TUint32 aPacketId,

        TDataBuffer* aMetaHeader );

    virtual void OnPacketPushPossible( WlanContextImpl& aCtxImpl );

    virtual void Indication( 

        WlanContextImpl& aCtxImpl, 

        WHA::TIndicationId aIndicationId,

        const WHA::UIndicationParams& aIndicationParams );

    /**

    * Configure Tx queue parameters to WHA (adaptation) layer

    * 

    * @param aCtxImpl statemachine context

    * @param aQueueId Id of the queue to configure

    * @param aCompleteManagementRequest ETrue if this request came from the

    *                                   WLAN Mgmt client and that request

    *                                   needs to be completed.

    *                                   EFalse otherwise.

    * @return ETrue if a state change occurred in the state machine 

    *         EFalse otherwise

    */

    TBool ConfigureTxQueue( 

        WlanContextImpl& aCtxImpl,

        WHA::TQueueId aQueueId,

        TBool aCompleteManagementRequest = EFalse );            

    virtual TBool ConfigureAcParams( 

        WlanContextImpl& aCtxImpl );                    

    /**

    * ?member_description.

    * @since Series 60 3.1

    * @param aCtxImpl global statemachine context

    */

    virtual TBool SetCtsToSelfMib( WlanContextImpl& aCtxImpl );

    /**

    * Informs lower layer about the dynamic HT configuration

    * of the target/current network

    * @param aCtxImpl statemachine context

    * @return ETrue if a state change occurred

    *         EFalse otherwise

    */

    virtual TBool ConfigureHtBssOperation( WlanContextImpl& aCtxImpl );

protected:

    static const TUint32 KCompleteManagementRequest = 0xACDCACDC;

    /**

    * C++ default constructor.

    */

    WlanDot11State() {};

    /**

     * Add/set (or replace) a broadcast WEP key,

     * conditionally set it as the default key and as a pairwise key 

     *

     * @since S60 3.1

     * @param aCtxImpl statemachine context

     * @param aKeyIndex Index of the key in the default key table 

     * @param aUseAsDefaulKey use as the default key

     * @param aUseAsPairwiseKey use as the pairwise key

     * @param aKeyLength Length of the key in BYTES

     * @param aKey The WEP key

     * @param aMac MAC address associated with the key

     * @return ETrue if state transition occurred, EFalse otherwise

     */

    TBool OnAddBroadcastWepKey(

        WlanContextImpl& aCtxImpl,

        TUint32 aKeyIndex,             

        TBool aUseAsDefaulKey,                

        TBool aUseAsPairwiseKey,

        TUint32 aKeyLength,                      

        const TUint8 aKey[KMaxWEPKeyLength],

        const TMacAddress& aMac );   

    /**

    * Set inital WLAN specific parameters. 

    * @param aCtxImpl statemachine context

    * @param aRTSThreshold 

    * limit for packet size when to use RTS/CTS protocol

    * @param aMaxTxMSDULifetime 

    * Max. time to (re-)send whole MSDU packet. (In TUs.)

    * @return status of the command, 

    */        

    static void OnConfigureUmacMib(

        WlanContextImpl& aCtxImpl,

        TUint16 aRTSThreshold,             

        TUint32 aMaxTxMSDULifetime);   

    /**

    * 

    *

    * @since S60 3.2

    * @param aCtxImpl statemachine context

    * @param 

    * @return ETrue if ...

    */

    TBool InitNetworkConnect( 

        WlanContextImpl& aCtxImpl,

        TUint16 aScanResponseFrameBodyLength,

        const TUint8* aScanResponseFrameBody ) const;

    /**

    * Resolves correct transmit queue for frame

    *

    * @since S60 3.1

    * @param aCtxImpl statemachine context

    * @param aDot11MacHeader start of dot11 mac header

    * @return transmit queue id to use for the packet

    */

    WHA::TQueueId QueueId( 

        const WlanContextImpl& aCtxImpl,

        const TUint8* aDot11MacHeader ) const;

    /**

    * Transmit dot11-deauthenticate frame.

    *

    * @since S60 3.1

    * @param aCtxImpl global statemachine context

    * @param aReason reason code of the frame

    * @param aWaitIfIntTxBufNotFree if ETrue, the caller wants to wait for the

    *        internal Tx buffer to become free if it is not free now

    *        if EFalse, the caller doesn't want to wait for the internal Tx 

    *        buffer in case it happens to be occupied

    * @return ETrue if Packet Scheduler accepted the frame for transmit

    *         EFalse otherwise

    */

    TBool TxDeauthenticate( 

        WlanContextImpl& aCtxImpl, 

        T802Dot11ManagementReasonCode aReason,

        TBool aWaitIfIntTxBufNotFree = EFalse ) const;

    /**

    * Transmit dot11-disassociate frame.

    *

    * @since S60 3.1

    * @param aCtxImpl global statemachine context

    * @param aReason reason code of the frame

    * @param aWaitIfIntTxBufNotFree if ETrue, the caller wants to wait for the

    *        internal Tx buffer to become free if it is not free now

    *        if EFalse, the caller doesn't want to wait for the internal Tx 

    *        buffer in case it happens to be occupied

    * @return ETrue if Packet Scheduler accepted the frame for transmit

    *         EFalse otherwise

    */

    TBool TxDisassociate( 

        WlanContextImpl& aCtxImpl, 

        T802Dot11ManagementReasonCode aReason,

        TBool aWaitIfIntTxBufNotFree = EFalse ) const;

    /**

    * Creates AES pairwise key setting context

    *

    * @since Series 60 3.1

    * @param aCtxImpl global statemachine context

    * @param aWhaAddKey reference to WHA Add Key command object

    * @param aMacAddr MAC address to be associated to the key

    */

    static WHA::SAesPairwiseKey* CreateAesPtkCtx( 

        WlanContextImpl& aCtxImpl,

        WlanWsaAddKey& aWhaAddKey,

        const TUint8* aData, 

        const TMacAddress& aMacAddr );

    /**

    * Creates TKIP pairwise key setting context

    *

    * @since Series 60 3.1

    * @param aCtxImpl global statemachine context

    * @param aWhaAddKey reference to WHA Add Key command object

    * @param aMacAddr MAC address to be associated to the key

    */

    static WHA::STkipPairwiseKey* CreateTkipPtkCtx( 

        WlanContextImpl& aCtxImpl,

        WlanWsaAddKey& aWhaAddKey,

        const TUint8* aData, 

        T802Dot11WepKeyId aKeyIndex, 

        const TMacAddress& aMacAddr );

    /**

    * Creates WEP pairwise key setting context

    *

    * @since Series 60 3.1

    * @param aCtxImpl global statemachine context

    * @param aWhaAddKey reference to WHA Add Key command object

    * @param aMacAddr MAC address to be associated with the key

    * @param aKeyLength length of the key

    * @param aKey the key

    */

    static WHA::SWepPairwiseKey* CreateUnicastWepKeyCtx(

        WlanContextImpl& aCtxImpl,

        WlanWsaAddKey& aWhaAddKey,

        const TMacAddress& aMacAddr,

        TUint32 aKeyLength,                      

        const TUint8 aKey[KMaxWEPKeyLength] );

    /**

    * Creates WAPI pairwise key setting context

    *

    * @param aCtxImpl global statemachine context

    * @param aWhaAddKey reference to WHA Add Key command object

    * @param aData key data

    * @param aKeyIndex key index

    * @param aMacAddr MAC address to be associated to the key

    */

    static WHA::SWapiPairwiseKey* CreateWapiPtkCtx( 

        WlanContextImpl& aCtxImpl,

        WlanWsaAddKey& aWhaAddKey,

        const TUint8* aData, 

        T802Dot11WepKeyId aKeyIndex, 

        const TMacAddress& aMacAddr );

    /**

    * Determines the initial transmit rate for Null Data, Qos Null

    * and PS Poll templates.

    * @since Series 60 3.1

    * @param aCtxImpl Global statemachine context

    * @return Initial transmit rate

    */

    WHA::TRate InitialSpecialFrameTxRate( 

        const WlanContextImpl& aCtxImpl ) const;

    /**

    * Transfers a dot11 frame up to the client of the management interface

    *

    * @since Series 60 3.2

    * @param aCtxImpl global statemachine context

    * @param aFrame frame to be transferred

    * @param aLength length of the frame

    * @param aRcpi RCPI of the frame

    * @param aBuffer pointer to the beginning of the Rx buffer allocated

    *        for the frame

    */

    TBool XferDot11FrameToMgmtClient( 

        WlanContextImpl& aCtxImpl,

        const void* aFrame,

        TUint32 aLength,

        const WHA::TRcpi aRcpi,

        TUint8* aBuffer ) const;

    virtual TBool DoErrorIndication( 

        WlanContextImpl& aCtxImpl, 

        WHA::TStatus aStatus );

    virtual void OnWhaCommandResponse( 

        WlanContextImpl& aCtxImpl, 

        WHA::TCommandId aCommandId, 

        WHA::TStatus aStatus,

        const WHA::UCommandResponseParams& aCommandResponseParams,

        TUint32 aAct );

    virtual TBool OnWlanWakeUpIntervalChange( WlanContextImpl& aCtxImpl );    

    /**

    * Returns a WHA queue ID / WMM Access Category corresponding to the 802.1d

    * priority given as the parameter

    * @since Series 60 3.1

    * @param aPriority 802.1d priority

    */

    static WHA::TQueueId Queue( TUint8 aPriority );

    static TBool UapsdEnabledInNetwork( 

        const SRxWmmIeData& aRxWmmIE );

    static TBool UapsdEnabledInNetwork( 

        const SWmmParamElemData& aWmmParamElem );

    static void EnableQos( WlanContextImpl& aCtxImpl, 

        TBool aUapsdEnabledInNw );

    /**

     * Determines if U-APSD will be used for the ACs/Tx Queues.

     * This depends on whether U-APSD is supported by the AP, and if it

     * is, whether WLAN Mgmt Client has requested U-APSD to be used

     * for the AC.

     * Also freezes the dynamic power mode management traffic override 

     * settings.

     * 

     * @since S60 v3.2

     * @param aCtxImpl statemachine context

     */

    static void DetermineAcUapsdUsage( WlanContextImpl& aCtxImpl );

    /**

    * Resets the specified AC (Access Category) parameters to default values.

    * 

    * @param aCtxImpl statemachine context

    * @param aAccessCategory access category

    * @param aUseAandGvalues If ETrue uses the 802.11a/g specific

    *        default values. Otherwise uses the 802.11b default values

    */

    static void ResetAcParameters( 

        WlanContextImpl& aCtxImpl,

        WHA::TQueueId aAccessCategory,

        TBool aUseAandGvalues );

    /**

    * Resets the AC (Access Category) parameters of every AC to default values.

    * @param aCtxImpl statemachine context

    * @param aUseAandGvalues If ETrue uses the 802.11a/g specific

    *        default values. Otherwise uses the 802.11b default values

    */