1 /*

     2 * Copyright (c) 2002-2009 Nokia Corporation and/or its subsidiary(-ies).

     3 * All rights reserved.

     4 * This component and the accompanying materials are made available

     5 * under the terms of the License "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:   Declaration of the MWlanUserEvent class

    15 *

    16 */

    17 

    18 /*

    19 * %version: 34 %

    20 */

    21 

    22 #ifndef MWLANUSEREVENT_H

    23 #define MWLANUSEREVENT_H

    24 

    25 #include "umacoidmsg.h"

    26 

    27 class WlanContextImpl;

    28 class TDataBuffer;

    29 struct TMacAddress;

    30 

    31 /**

    32 *  Interface class for events originating from WLAN mgmt client

    33 */

    34 class MWlanUserEvent

    35     {

    36 

    37 public:

    38     

    39     /**

    40     * Connect (authenticate and associate) to a WLAN network

    41     *

    42     * @since S60 3.1

    43     * @param aCtxImpl statemachine context

    44     * @param aSSID Name of the network

    45     * @param aBSSID BSSID of the access point

    46     * @param aAuthAlgorithmNbr Authentication algorithm number to be used

    47     * @param aEncryptionStatus Used encryption level

    48     * @param aIsInfra ETrue when connecting to infrastructure network

    49     * @param aScanResponseFrameBodyLength length of the scan response frame body

    50     * @param aScanResponseFrameBody scan response frame body

    51     * @param aIeData The IE(s) to be included into the (re-)association request.

    52     *              NULL, if none to be included

    53     * @param aIeDataLength Length of the IE(s) to be included into the 

    54     *                    (re-)association request

    55     * @return ETrue if a state transition occurred

    56     *         EFalse otherwise

    57     */

    58     virtual TBool Connect(

    59         WlanContextImpl& aCtxImpl,

    60         const TSSID& aSSID,                 

    61         const TMacAddress& aBSSID,          

    62         TUint16 aAuthAlgorithmNbr,      

    63         TEncryptionStatus aEncryptionStatus,

    64         TBool aIsInfra,

    65         TUint16 aScanResponseFrameBodyLength,

    66         const TUint8* aScanResponseFrameBody,

    67         const TUint8* aIeData,

    68         TUint16 aIeDataLength ) = 0;

    69 

    70     /**

    71     * Add TKIP key

    72     * @param aCtxImpl statemachine context

    73     * @param aData data blob that holds TKIP parameters

    74     * @param aLength length of the data blob

    75     * @param aKeyIndex value for key id field of WEP IV

    76     * @param aMacAddr MAC address of the peer station

    77     * @return ETrue if state transition occurred, EFalse otherwise

    78     */

    79     virtual TBool AddTkIPKey( 

    80         WlanContextImpl& aCtxImpl,

    81         const TUint8* aData, 

    82         TUint32 aLength,

    83         T802Dot11WepKeyId aKeyIndex,

    84         const TMacAddress& aMacAddr ) = 0;

    85 

    86     /**

    87     * Add multicast TKIP key.

    88     * @param aCtxImpl statemachine context

    89     * @param aKeyIndex  Value for the key id field of WEP IV.

    90     * @param aLength    Length of the TKIP parameters.

    91     * @param aData      TKIP parameters.

    92     * @return ETrue if state transition occurred, EFalse otherwise

    93     */

    94     virtual TBool AddMulticastTKIPKey( 

    95         WlanContextImpl& aCtxImpl,

    96         T802Dot11WepKeyId aKeyIndex,

    97         TUint32 aLength,

    98         const TUint8* aData ) = 0;

    99 

   100     /**

   101     * Add (or replace) a pairwise AES key.

   102     *

   103     * @param aCtxImpl statemachine context

   104     * @param aData AES parameters.

   105     * @param aLength Length of the AES parameters.

   106     * @param aMacAddr MAC address of the peer station

   107     * @return ETrue if state transition occurred, EFalse otherwise

   108     */

   109     virtual TBool AddAesKey( 

   110         WlanContextImpl& aCtxImpl,

   111         const TUint8* aData, 

   112         TUint32 aLength,

   113         const TMacAddress& aMacAddr ) = 0;

   114 

   115     /**

   116     * Add (or replace) an AES group key.

   117     *

   118     * @param aCtxImpl statemachine context

   119     * @param aKeyIndex Value for the key id field of WEP IV.

   120     * @param aLength Length of the AES parameters.

   121     * @param aData AES parameters.

   122     * @return ETrue if state transition occurred, EFalse otherwise

   123     */

   124     virtual TBool AddMulticastAesKey( 

   125         WlanContextImpl& aCtxImpl,

   126         T802Dot11WepKeyId aKeyIndex,

   127         TUint32 aLength,

   128         const TUint8* aData ) = 0;

   129     

   130     /**

   131     * Add (or replace) a multicast WAPI key.

   132     * @param aCtxImpl statemachine context

   133     * @param aKeyIndex  Value for the key id field of WEP IV.

   134     * @param aLength    Length of the WAPI parameters.

   135     * @param aData      WAPI parameters.

   136     * @return ETrue if state transition occurred, EFalse otherwise

   137     */

   138     virtual TBool AddMulticastWapiKey( 

   139         WlanContextImpl& aCtxImpl,

   140         T802Dot11WepKeyId aKeyIndex,

   141         TUint32 aLength,

   142         const TUint8* aData ) = 0;

   143 

   144     /**

   145     * Add (or replace) a pairwise WAPI key.

   146     *

   147     * @param aCtxImpl statemachine context

   148     * @param aData data blob that holds WAPI parameters

   149     * @param aLength length of the data blob

   150     * @param aKeyIndex value for key id field of WEP IV

   151     * @param aMacAddr MAC address of the peer station

   152     * @return ETrue if state transition occurred, EFalse otherwise

   153     */

   154     virtual TBool AddUnicastWapiKey( 

   155         WlanContextImpl& aCtxImpl,

   156         const TUint8* aData, 

   157         TUint32 aLength,

   158         T802Dot11WepKeyId aKeyIndex,

   159         const TMacAddress& aMacAddr ) = 0;

   160 

   161     /**

   162     * Start an own IBSS network if there doesn't already exist a network

   163     * with that name. If does then it is joined

   164     * @param aCtxImpl statemachine context

   165     * @param aSSID name of the network

   166     * @param aBeaconInterval Beacon period in TUs (kusec). range:[1, 1024]

   167     * @param aAtim ATIM window

   168     * @param aChannel Used channel (1-14). 

   169     *        Has to be legal at the current region.

   170     * @param aEncryptionStatus, used encryption level

   171     * @return KErrNone command completed successfully 

   172     * any other = failure

   173     */

   174     virtual TBool StartIBSS(

   175         WlanContextImpl& aCtxImpl,

   176         const TSSID& aSSID,                 

   177         TUint32 aBeaconInterval,            

   178         TUint32 aAtim,                      

   179         TUint32 aChannel,                   

   180         TEncryptionStatus aEncryptionStatus) = 0;  

   181 

   182     /**

   183     * Scan all available networks. 

   184     * @param aCtxImpl statemachine context

   185     * @param aMode passive or active scan see #TScanMode

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

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

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

   189     *                        a channel

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

   191     *                        a channel

   192     * @param aSplitScan if ETrue, use split scan

   193     * @return KErrNone command completed successfully 

   194     * any other = failure

   195     */

   196     virtual TBool Scan(

   197         WlanContextImpl& aCtxImpl,

   198         TScanMode aMode,                   

   199         const TSSID& aSSID,                

   200         TRate aScanRate,                   

   201         SChannels& aChannels,

   202         TUint32 aMinChannelTime,            

   203         TUint32 aMaxChannelTime,

   204         TBool aSplitScan ) = 0;       

   205     

   206     /**

   207     * Stop a previously started scan process. 

   208     *

   209     * @since S60 3.2

   210     * @param aCtxImpl global statemachine context

   211     * @return ETrue if a state transition occurred

   212     *         EFalse otherwise

   213     */

   214     virtual TBool StopScan( WlanContextImpl& aCtxImpl ) = 0;

   215 

   216     /**

   217     * Disconnect STA from current network.

   218     * @param aCtxImpl statemachine context

   219     * @return KErrNone command completed successfully 

   220     * any other = failure

   221     */

   222     virtual TBool Disconnect( WlanContextImpl& aCtxImpl ) = 0;

   223 

   224     /**

   225     * Set 802.11 power mgmt mode in infrastructure networks.

   226     * @param aCtxImpl statemachine context

   227     * @param aPowerMode desired power mode

   228     * @param aDisableDynamicPowerModeManagement If ETrue, disables the dynamic

   229     *        power mode management handling. Relevant only when aPowerMode

   230     *        is EPowerModePs

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

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

   233     *        modes 2 and 3 in Light PS mode. 

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

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

   236     *        modes 2 and 3 in Deep PS mode

   237     * @return ETrue if a state transition occurred

   238     *         EFalse otherwise

   239     */

   240     virtual TBool SetPowerMode(

   241         WlanContextImpl& aCtxImpl,

   242         TPowerMode aPowerMode,

   243         TBool aDisableDynamicPowerModeManagement,

   244         TWlanWakeUpInterval aWakeupModeInLightPs, 

   245         TUint8 aListenIntervalInLightPs,

   246         TWlanWakeUpInterval aWakeupModeInDeepPs,

   247         TUint8 aListenIntervalInDeepPs ) = 0;

   248 

   249     /**

   250     * Set trigger level for RCPI trigger. 

   251     * @param aCtxImpl statemachine context

   252     * @param aRcpiTrigger RCPI trigger level

   253     * @return KErrNone command completed successfully 

   254     * any other = failure

   255     */

   256     virtual TBool SetRcpiTriggerLevel(

   257         WlanContextImpl& aCtxImpl,

   258         TUint32 aRcpiTrigger) = 0;          

   259 

   260     /**

   261     * Set transmission power level. This has to be legal at the current region.

   262     * @param aCtxImpl statemachine context

   263     * @param aLevel Transmission power level in mW.

   264     * @return KErrNone command completed successfully 

   265     * any other = failure

   266     */

   267     virtual TBool SetTxPowerLevel(

   268         WlanContextImpl& aCtxImpl,

   269         TUint32 aLevel) = 0;                

   270 

   271     /**

   272     * Set inital WLAN specific parameters

   273     * @param aCtxImpl statemachine context

   274     * @param aRTSThreshold 

   275     * @param aMaxTxMSDULifetime 

   276     * @param aVoiceCallEntryTimeout when we are not in Voice over WLAN Call

   277     *        state and we transmit at least aVoiceCallEntryTxThreshold

   278     *        Voice priority frames during the time period (microseconds)

   279     *        denoted by this parameter, we enter Voice over WLAN Call state

   280     * @param aVoiceCallEntryTxThreshold Threshold value for the number of 

   281     *        Voice priority Tx frames to enter Voice over WLAN Call state    

   282     * @param aVoiceNullTimeout NULL frame sending interval during a Voice over

   283     *        WLAN call in U-APSD power save mode

   284     * @param aNoVoiceTimeout after this long time of no Voice priority data 

   285     *        Tx, exit Voice over WLAN call state

   286     * @param aKeepAliveTimeout Keep Alive frame sending interval in 

   287     *        infrastructure mode

   288     * @param aSpRcpiIndicationLevel If this RCPI level is predicted to be

   289     *        reached within the time specified by aSpTimeToCountPrediction,

   290     *        a signal loss prediction indication is sent. 

   291     * @param aSpTimeToCountPrediction Specifies the time (in microseconds)

   292     *        how far into the future signal prediction is done.

   293     * @param aSpMinIndicationInterval The minimum time difference (in 

   294     *        microseconds) between two signal loss prediction indications.

   295     * @return KErrNone command completed successfully 

   296     * any other = failure

   297     */        

   298     virtual TBool Configure(

   299         WlanContextImpl& aCtxImpl,

   300         TUint32 aRTSThreshold,              

   301         TUint32 aMaxTxMSDULifetime,

   302         TUint32 aVoiceCallEntryTimeout,

   303         TUint32 aVoiceCallEntryTxThreshold,

   304         TUint32 aVoiceNullTimeout,

   305         TUint32 aNoVoiceTimeout,

   306         TUint32 aKeepAliveTimeout,

   307         TUint32 aSpRcpiIndicationLevel,

   308         TUint32 aSpTimeToCountPrediction,

   309         TUint32 aSpMinIndicationInterval ) = 0;    

   310 

   311     /**

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

   313     * @param aCtxImpl statemachine context

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

   315     * @param aKeyLength Length of the key in BYTES

   316     * @param aKey The WEP key

   317     * @param aMac MAC address associated with the key

   318     * @return KErrNone command completed successfully 

   319     * any other = failure

   320     */

   321     virtual TBool AddBroadcastWepKey(

   322         WlanContextImpl& aCtxImpl,

   323         TUint32 aKeyIndex,             

   324         TBool aUseAsDefaulKey,                

   325         TUint32 aKeyLength,                      

   326         const TUint8 aKey[KMaxWEPKeyLength],

   327         const TMacAddress& aMac ) = 0;   

   328 

   329     /**

   330     * Add (or replace) a unicast WEP key.

   331     * @param aCtxImpl statemachine context

   332     * @param aMacAddr MAC address to which the WEP key corresponds to

   333     * @param aKeyLength Length of the key in BYTES

   334     * @param aKey The WEP key

   335     * @return KErrNone command completed successfully 

   336     * any other = failure

   337     */

   338     virtual TBool AddUnicastWepKey(

   339         WlanContextImpl& aCtxImpl,

   340         const TMacAddress& aMacAddr,

   341         TUint32 aKeyLength,                      

   342         const TUint8 aKey[KMaxWEPKeyLength]) = 0;   

   343 

   344     /**

   345     * Disable user data from/to protcol stack 

   346     * (802.1x: block data during authentication).

   347     * @param aCtxImpl statemachine context

   348     * @return KErrNone command completed successfully 

   349     * any other = failure

   350     */

   351     virtual TBool DisableUserData(

   352         WlanContextImpl& aCtxImpl ) = 0;

   353 

   354     /**

   355     * Enable user data from/to protcol stack 

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

   357     * @param aCtxImpl statemachine context

   358     * @return KErrNone command completed successfully 

   359     * any other = failure

   360     */

   361     virtual TBool EnableUserData(

   362         WlanContextImpl& aCtxImpl ) = 0;

   363 

   364     /**

   365     * Gets last RCPI value

   366     * @param aCtxImpl statemachine context

   367     * @return KErrNone command completed successfully 

   368     * any other = failure

   369     */

   370     virtual TBool GetLastRcpi(

   371         WlanContextImpl& aCtxImpl ) = 0;   

   372     

   373     /**

   374     * Adds a multicast MAC address and starts to filter (Rx) multicast 

   375     * traffic sent to any other MAC addresses than those that have been 

   376     * specified using this method

   377     * @param aCtxImpl statemachine context

   378     * @param aMacAddr The address to be added

   379     * @return 

   380     */

   381     virtual TBool AddMulticastAddr(

   382         WlanContextImpl& aCtxImpl,

   383         const TMacAddress& aMacAddr ) = 0;        

   384     

   385     /**

   386     * Removes a multicast MAC address from multicast (Rx) filtering

   387     * configuration. So any packet that we receive and which has been sent

   388     * to the multicast address in question is not accepted any more (i.e. 

   389     * it is filtered).

   390     * However, if there are no addresses left in the multicast (Rx) filtering

   391     * configuration after this remove, the multicast filtering is disabled

   392     * and all (otherwise acceptable) multicast packets are accepted again.

   393     * @param aCtxImpl statemachine context

   394     * @param aMacAddr The address to be removed

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

   396     *         EFalse otherwise

   397     */

   398     virtual TBool RemoveMulticastAddr(

   399         WlanContextImpl& aCtxImpl,

   400         TBool aRemoveAll,

   401         const TMacAddress& aMacAddr ) = 0;

   402 

   403     /**

   404     * Triggers the setting of the Tx offset on the protocol stack side for 

   405     * every frame type which can be transmitted

   406     *

   407     * @param aCtxImpl statemachine context

   408     */

   409     virtual void SetProtocolStackTxOffset( 

   410         WlanContextImpl& aCtxImpl ) const = 0;

   411     

   412     /**

   413     * Transmit a protocol stack frame

   414     * 

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

   416     * @param aCtxImpl global state machine context

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

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

   419     *              EFalse otherwise

   420     */

   421     virtual TBool TxData( 

   422         WlanContextImpl& aCtxImpl,

   423         TDataBuffer& aDataBuffer,

   424         TBool aMore ) = 0;

   425 

   426     /**

   427     * Write for management data

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

   429     * @param aCtxImpl statemachine context

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

   431     */

   432     virtual void TxMgmtData( 

   433         WlanContextImpl& aCtxImpl,

   434         TDataBuffer& aDataBuffer ) = 0;

   435 

   436     /**

   437      * System finit method.

   438      * Make system ready for unloading

   439      *

   440      * @since S60 3.1

   441      */

   442     virtual void FinitSystem( WlanContextImpl& aCtxImpl ) = 0;

   443     

   444     /**

   445      * Configures the parameters which define when BSS lost is indicated.

   446      * The indication is sent when either one of the specified thresholds

   447      * is exceeded.

   448      *

   449      * @since S60 v3.1

   450      * @param aCtxImpl statemachine context

   451      * @param aBeaconLostCount beacon lost count threshold

   452      * @param aFailedTxPacketCount failed Tx packet count threshold

   453      * @return ETrue if a state change occurred

   454      *         EFalse otherwise

   455      */

   456     virtual TBool ConfigureBssLost( 

   457         WlanContextImpl& aCtxImpl,

   458         TUint32 aBeaconLostCount,

   459         TUint8 aFailedTxPacketCount ) = 0;

   460 

   461     /**

   462     * Sets the Tx rate adaptation algorithm parameters

   463     *

   464     * @since S60 3.1

   465     * @param aCtxImpl statemachine context

   466     * @param aMinStepUpCheckpoint minimum and initial rate increase 

   467     *        checkpoint in units of frames

   468     *        Range: [aStepDownCheckpoint,aMaxStepUpCheckpoint]

   469     * @param aMaxStepUpCheckpoint maximum rate increase checkpoint in units 

   470     *        of frames

   471     *        Range: [aStepDownCheckpoint,UCHAR_MAX]

   472     * @param aStepUpCheckpointFactor StepUpCheckpoint is multiplied with this

   473     *        value if sending a probe frame fails

   474     *        Range: [1,aMaxStepUpCheckpoint]

   475     * @param aStepDownCheckpoint after this many frames the need to decrease

   476     *        the rate is checked

   477     *        Range: [2,UCHAR_MAX]

   478     * @param aMinStepUpThreshold minimum and initial StepUpThreshold 

   479     *        percentage

   480     *        Range: [1,aMaxStepUpThreshold]

   481     * @param aMaxStepUpThreshold maximum StepUpThreshold percentage

   482     *        Range: [1,100]

   483     * @param aStepUpThresholdIncrement StepUpThreshold is incremented by this

   484     *        value if sending a probe frame fails

   485     *        Range: [0,aMaxStepUpThreshold]

   486     * @param aStepDownThreshold if the percentage of frames which failed to

   487     *        be transmitted at the originally requested rate is at least 

   488     *        aStepDownThreshold at the aStepDownCheckpoint, the rate will

   489     *        be decreased

   490     *        Range: [1,100]

   491     * @param aDisableProbeHandling if EFalse, the rate adaptation algorithm

   492     *        handles the first frame transmitted after a rate increase in a

   493     *        special way. Otherwise the special handling is disabled

   494     * @return ETrue if a state change occurred

   495     *         EFalse otherwise

   496     */

   497     virtual TBool SetTxRateAdaptParams( 

   498         WlanContextImpl& aCtxImpl,

   499         TUint8 aMinStepUpCheckpoint,

   500         TUint8 aMaxStepUpCheckpoint,

   501         TUint8 aStepUpCheckpointFactor,

   502         TUint8 aStepDownCheckpoint,

   503         TUint8 aMinStepUpThreshold,

   504         TUint8 aMaxStepUpThreshold,

   505         TUint8 aStepUpThresholdIncrement,

   506         TUint8 aStepDownThreshold,

   507         TBool aDisableProbeHandling ) = 0;

   508       

   509     /**

   510      * Configures Tx rate policy objects, sets the policy object to use for 

   511      * every Tx Queue / QoS AC, and also sets the Initial Max Tx Rate to be 

   512      * used for the configured policy objects

   513      *

   514      * @since S60 v3.1

   515      * @param aCtxImpl statemachine context

   516      * @param aRatePolicy rate policy (policy objects)

   517      * @param aQueue2RateClass Tx queue (AC) to rate policy object mapping

   518      * @param aInitialMaxTxRate4RateClass initial max Tx rate for the

   519      *        policy objects

   520      * @param aAutoRatePolicy auto rate policy

   521      * @param aHtMcsPolicy HT MCS policy 

   522      * @return ETrue if a state change occurred

   523      *         EFalse otherwise

   524      */

   525     virtual TBool ConfigureTxRatePolicies( 

   526         WlanContextImpl& aCtxImpl,

   527         const TTxRatePolicy& aRatePolicy,

   528         const TQueue2RateClass& aQueue2RateClass,

   529         const TInitialMaxTxRate4RateClass& aInitialMaxTxRate4RateClass,

   530         const TTxAutoRatePolicy& aAutoRatePolicy,

   531         const THtMcsPolicy& aHtMcsPolicy ) = 0;

   532 

   533     /**

   534     * Sets the dynamic power mode transition algorithm parameters

   535     *

   536     * @since S60 3.1

   537     * @param aCtxImpl statemachine context

   538     * @param aToLightPsTimeout time interval in microseconds after which 

   539     *        transition from Active mode to Light PS mode is considered

   540     * @param aToLightPsFrameThreshold frame count threshold used when 

   541     *        considering transition from Active to Light PS mode

   542     * @param aToActiveTimeout time interval in microseconds after which the 

   543     *        frame counter used when considering transition from Light PS 

   544     *        to Active mode is reset

   545     * @param aToActiveFrameThreshold frame count threshold used when 

   546     *        considering transition from Light PS to Active mode

   547     * @param aToDeepPsTimeout time interval in microseconds after which 

   548     *        transition from Light PS mode to Deep PS mode is considered

   549     * @param aToDeepPsFrameThreshold frame count threshold used when 

   550     *        considering transition from Light PS to Deep PS mode

   551     * @param aUapsdRxFrameLengthThreshold received frame 

   552     *        payload length (in bytes) threshold in U-APSD network for

   553     *        Best Effort Access Category

   554     * @return ETrue if a state change occurred

   555     *         EFalse otherwise

   556     */

   557     virtual TBool SetPowerModeManagementParameters(

   558         WlanContextImpl& aCtxImpl,

   559         TUint32 aToLightPsTimeout,

   560         TUint16 aToLightPsFrameThreshold,

   561         TUint32 aToActiveTimeout,

   562         TUint16 aToActiveFrameThreshold,

   563         TUint32 aToDeepPsTimeout,

   564         TUint16 aToDeepPsFrameThreshold,

   565         TUint16 aUapsdRxFrameLengthThreshold ) = 0;

   566         

   567     /**

   568     * Configures dynamic power mode management traffic override

   569     *

   570     * The settings here become effective once using the PS mode has been 

   571     * allowed by WLAN Mgmt Client.

   572     * When a setting below is ETrue, any amount of Rx or Tx traffic via

   573     * the AC in question won't cause a change from PS to CAM mode once PS

   574     * mode has been entered, and traffic via that AC won't make us to 

   575     * stay in CAM either.

   576     * Every AC has a separate setting for U-APSD and legacy PS.

   577     * The U-APSD setting is used if U-APSD is used for the AC in question.

   578     * Otherwise the corresponding legacy setting is used.

   579     *    

   580     * @since S60 3.2

   581     * @param aCtxImpl statemachine context

   582     * @param aStayInPsDespiteUapsdVoiceTraffic U-APSD Voice AC setting

   583     * @param aStayInPsDespiteUapsdVideoTraffic U-APSD Video AC setting

   584     * @param aStayInPsDespiteUapsdBestEffortTraffic U-APSD Best Effort AC 

   585     *                                               setting

   586     * @param aStayInPsDespiteUapsdBackgroundTraffic U-APSD Background AC 

   587     *                                               setting

   588     * @param aStayInPsDespiteLegacyVoiceTraffic legacy Voice AC setting

   589     * @param aStayInPsDespiteLegacyVideoTraffic legacy Video AC setting

   590     * @param aStayInPsDespiteLegacyBestEffortTraffic legacy Best Effort AC 

   591     *                                                setting

   592     * @param aStayInPsDespiteLegacyBackgroundTraffic legacy Background AC 

   593     *                                                setting

   594     * @return ETrue if a state change occurred

   595     *         EFalse otherwise

   596     */

   597     virtual TBool ConfigurePwrModeMgmtTrafficOverride( 

   598         WlanContextImpl& aCtxImpl,

   599         TBool aStayInPsDespiteUapsdVoiceTraffic,

   600         TBool aStayInPsDespiteUapsdVideoTraffic,

   601         TBool aStayInPsDespiteUapsdBestEffortTraffic, 

   602         TBool aStayInPsDespiteUapsdBackgroundTraffic,

   603         TBool aStayInPsDespiteLegacyVoiceTraffic,

   604         TBool aStayInPsDespiteLegacyVideoTraffic,

   605         TBool aStayInPsDespiteLegacyBestEffortTraffic,

   606         TBool aStayInPsDespiteLegacyBackgroundTraffic ) = 0;

   607 

   608     /**

   609      * Gets data frame Rx & Tx statistics

   610      *

   611      * @since S60 v3.2

   612      * @param aCtxImpl statemachine context

   613      * @return ETrue if a state change occurred

   614      *         EFalse otherwise

   615      */

   616     virtual TBool GetFrameStatistics( WlanContextImpl& aCtxImpl ) = 0;

   617     

   618     /**

   619      * Configures U-APSD usage

   620      *

   621      * @since S60 v3.2

   622      * @param aCtxImpl statemachine context

   623      * @param aMaxServicePeriodLength

   624      * @param aUapsdForVoice if ETrue the Voice AC is made both trigger and 

   625      *                       delivery enabled when connecting to a QoS AP 

   626      *                       supporting U-APSD.

   627      *                       Otherwise it's made neither trigger nor delivery 

   628      *                       enabled

   629      * @param aUapsdForVideo if ETrue the Video AC is made both trigger and 

   630      *                       delivery enabled 

   631      *                       when connecting to a QoS AP supporting U-APSD.

   632      *                       Otherwise it's made neither trigger nor delivery 

   633      *                       enabled

   634      * @param aUapsdForBestEffort if ETrue the Best Effort AC is made both 

   635      *                            trigger and delivery enabled when connecting

   636      *                            to a QoS AP supporting U-APSD.

   637      *                            Otherwise it's made neither trigger nor 

   638      *                            delivery enabled    

   639      * @param aUapsdForBackground if ETrue the Background AC is made both 

   640      *                            trigger and delivery enabled when connecting

   641      *                            to a QoS AP supporting U-APSD.

   642      *                            Otherwise it's made neither trigger nor 

   643      *                            delivery enabled    

   644      */

   645     virtual TBool ConfigureUapsd( 

   646         WlanContextImpl& aCtxImpl,

   647         TMaxServicePeriodLength aMaxServicePeriodLength,

   648         TBool aUapsdForVoice,

   649         TBool aUapsdForVideo,

   650         TBool aUapsdForBestEffort,

   651         TBool aUapsdForBackground ) = 0;    

   652 

   653     /**

   654      * Reconfigures the specified Tx queue if necessary

   655      *

   656      * @since S60 v3.2

   657      * @param aCtxImpl statemachine context

   658      * @param aQueueId ID of the queue to reconfigure

   659      * @param aMediumTime The amount of time the queue is allowed to access 

   660      *                    the WLAN air interface.

   661      * @param aMaxTxMSDULifetime Maximum Transmit MSDU Lifetime to be used 

   662      *                           for the specified queue.

   663      * @return ETrue if a state change occurred

   664      *         EFalse otherwise

   665      */

   666     virtual TBool ConfigureTxQueueIfNecessary( 

   667             WlanContextImpl& aCtxImpl,

   668             TQueueId aQueueId,

   669             TUint16 aMediumTime,

   670             TUint32 aMaxTxMSDULifetime ) = 0;

   671 

   672     /**

   673      * Get our own MAC address

   674      *

   675      * @since S60 v3.1

   676      * @param aCtxImpl statemachine context

   677      * @return ETrue if a state change occurred

   678      *         EFalse otherwise

   679      */

   680     virtual TBool GetMacAddress(

   681         WlanContextImpl& aCtxImpl ) = 0;

   682 

   683     /**

   684     * Configures ARP IP address filtering

   685     * 

   686     * @param aCtxImpl statemachine context

   687     * @param aEnableFiltering If ETrue, filtering is enabled

   688     *                         If EFalse, filtering is disabled

   689     * @param aIpv4Address If the target IP Address in a received ARP request 

   690     *        doesn't match this address, the packet shall be discarded

   691     *        on the lower layers.

   692     *        Relevant only when enabling filtering.

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

   694     *         EFalse otherwise

   695     */

   696     virtual TBool ConfigureArpIpAddressFiltering(

   697         WlanContextImpl& aCtxImpl,

   698         TBool aEnableFiltering,

   699         TIpv4Address aIpv4Address ) = 0;        

   700 

   701     /**

   702     * Configures HT Block Ack use

   703     * 

   704     * @param aCtxImpl statemachine context

   705     * @param aTxBlockAckUsage Bit map defining Block Ack use in Tx direction

   706     * @param aRxBlockAckUsage Bit map defining Block Ack use in Rx direction

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

   708     *         EFalse otherwise

   709     */

   710     virtual TBool ConfigureHtBlockAck(

   711         WlanContextImpl& aCtxImpl, 

   712         TUint8 aTxBlockAckUsage,

   713         TUint8 aRxBlockAckUsage ) = 0;

   714     

   715     /**

   716     * Configures Proprietary SNAP header. 

   717     * Valid received 802.11 Data frames containing this SNAP header

   718     * are accepted and forwarded to the WLAN Management Client.

   719     * 

   720     * @param aCtxImpl statemachine context

   721     * @param 

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

   723     *         EFalse otherwise

   724     */

   725     virtual TBool ConfigureProprietarySnapHdr(

   726         WlanContextImpl& aCtxImpl, 

   727         const TSnapHeader& aSnapHeader ) = 0;        

   728     };

   729     

   730 #endif      // MWLANUSEREVENT_H