/*

* 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:   Header file mainly for 802.11 specific declarations and 

*                definitions.

*

*/

/*

*/

#ifndef WLAN802DOT11_H

#define WLAN802DOT11_H

#include "umac_types.h"

// for copy, equal and operator != support

#include "algorithm.h"

#include "pack.h"

/**

 * Returns a TUint16 host byte order value in WLAN MAC layer byte order 

 * (LSB first)

 *

 * @since S60 3.1

 * @param aNw value in network byte order

 * @return value in host byte order

 */

extern TUint16 os_Hton( TUint16 aHost );

/**

 * Returns a TUint16 WLAN MAC layer byte order (LSB first) value in host byte 

 * order

 *

 * @since S60 3.1

 * @param aNw value in network byte order

 * @return value in host byte order

 */

extern TUint16 os_Ntoh( TUint16 aNw );

/**

 * Returns a TUint32 host byte order value in WLAN MAC layer byte order 

 * (LSB first)

 *

 * @param aNw value in network byte order

 * @return value in host byte order

 */

extern TUint32 os_H32ton( TUint32 aHost );

/**

 * Returns a TUint32 WLAN MAC layer byte order (LSB first) value in host byte 

 * order

 *

 * @param aNw value in network byte order

 * @return value in host byte order

 */

extern TUint32 os_N32toh( TUint32 aNw );

/**

 * Allows also unaligned reading of a TUint16 WLAN MAC layer byte order 

 * (LSB first) value and returns the result in the byte order which

 * is in use in the host

 *

 * @since S60 3.1

 * @param aNwSource where to read the WLAN MAC layer byte order value from

 * @return the value which was read, in host byte order

 */

#ifdef __ARMCC_VERSION

/* Use the __packed qualifier for ARM compilations */

inline TUint16 ReadUint16Toh( const __packed TUint16* aNwSource )

#else

inline TUint16 ReadUint16Toh( const TUint16* aNwSource )

#endif

    {

    const TUint16 loByte ( static_cast<const TUint16>( 

            ( reinterpret_cast<const TUint8*>(aNwSource) )[0] ) );

    const TUint16 hiByte ( static_cast<const TUint16>(

            ( reinterpret_cast<const TUint8*>(aNwSource) )[1] ) << 8 );

    return ( os_Ntoh( loByte | hiByte ) );

    }

/**

 * Allows also unaligned writing of a TUint16 host byte order value

 * into WLAN MAC layer byte order

 *

 * @since S60 3.1

 * @param aNwTarget where to write the WLAN MAC layer byte order value to

 * @param aHostValue the host byte order value to be written

 */

#ifdef __ARMCC_VERSION

/* Use the __packed qualifier for ARM compilations */

inline void WriteHtoUint16( __packed TUint16* aNwTarget, TUint16 aHostValue )

#else

inline void WriteHtoUint16( TUint16* aNwTarget, TUint16 aHostValue )

#endif

    {

    TUint16 nwValue = os_Hton( aHostValue );

    reinterpret_cast<TUint8*>(aNwTarget)[0] = 

        ( reinterpret_cast<TUint8*>(&nwValue) )[0];

    reinterpret_cast<TUint8*>(aNwTarget)[1] = 

        ( reinterpret_cast<TUint8*>(&nwValue) )[1];

    }

/**

 * Allows also unaligned reading of a TUint32 WLAN MAC layer byte order 

 * (LSB first) value and returns the result in the byte order which

 * is in use in the host

 *

 * @param aNwSource where to read the WLAN MAC layer byte order value from

 * @return the value which was read, in host byte order

 */

#ifdef __ARMCC_VERSION

/* Use the __packed qualifier for ARM compilations */

inline TUint32 ReadUint32Toh( const __packed TUint32* aNwSource )

#else

inline TUint32 ReadUint32Toh( const TUint32* aNwSource )

#endif

    {

    const TUint32 byte0 ( static_cast<const TUint32>( 

            ( reinterpret_cast<const TUint8*>(aNwSource) )[0] ) );

    const TUint32 byte1 ( static_cast<const TUint32>(

            ( reinterpret_cast<const TUint8*>(aNwSource) )[1] ) << 8 );

    const TUint32 byte2 ( static_cast<const TUint32>(

            ( reinterpret_cast<const TUint8*>(aNwSource) )[2] ) << 16 );

    const TUint32 byte3 ( static_cast<const TUint32>(

            ( reinterpret_cast<const TUint8*>(aNwSource) )[3] ) << 24 );

    return ( os_N32toh( byte0 | byte1 | byte2 | byte3 ) );

    }

/**

 * Allows also unaligned writing of a TUint32 host byte order value

 * into WLAN MAC layer byte order

 *

 * @param aNwTarget where to write the WLAN MAC layer byte order value to

 * @param aHostValue the host byte order value to be written

 */

#ifdef __ARMCC_VERSION

/* Use the __packed qualifier for ARM compilations */

inline void WriteHtoUint32( __packed TUint32* aNwTarget, TUint32 aHostValue )

#else

inline void WriteHtoUint32( TUint32* aNwTarget, TUint32 aHostValue )

#endif

    {

    TUint32 nwValue = os_H32ton( aHostValue );

    reinterpret_cast<TUint8*>(aNwTarget)[0] = 

        ( reinterpret_cast<TUint8*>(&nwValue) )[0];

    reinterpret_cast<TUint8*>(aNwTarget)[1] = 

        ( reinterpret_cast<TUint8*>(&nwValue) )[1];

    reinterpret_cast<TUint8*>(aNwTarget)[2] = 

        ( reinterpret_cast<TUint8*>(&nwValue) )[2];

    reinterpret_cast<TUint8*>(aNwTarget)[3] = 

        ( reinterpret_cast<TUint8*>(&nwValue) )[3];

    }

/**

 * Reverses the byte order of a TUint16 value

 *

 * @since S60 3.1

 * @param aOriginal value whose byte order is to be reversed

 * @return the input parameter in reversed byte order

 */

inline TUint16 ReverseUint16( TUint16 aOriginal )

    {

    return ( ( aOriginal >> 8 ) | ( aOriginal << 8 ) );

    }

/**

* A measurement of time equal to 1024 µs.

*/

const TUint16 KTU = 1024;

/**

* Length of MAC header

*/

const TUint8 KMacHeaderLength = 24;

/**

* Length of QoS MAC header

*/

const TUint8 KQoSMacHeaderLength = 26;

/**

* Length of HT Control field in bytes

*/

const TUint32 KHtControlFieldLength = 4;

/**

* Length of QoS MAC header with HT Control field in bytes

*/

const TUint8 KHtQoSMacHeaderLength = 

    KQoSMacHeaderLength + KHtControlFieldLength;

/**

* Maximum number of 802.11b supported rates 

* 1, 2, 5.5, 11 MBit/s

*/

const TUint8 KMaxNumberOfDot11bRates = 4; 

/**

* Maximum number of actual supported rate elements in 

* supported rates information element

*/

const TUint8 KMaxNumberOfRates = 8;

/**

* Maximum number of actual 802.11 supported rate elements in 

* extended supported rates information element

*/

const TUint8 KMaxNumberOfExtendedRates = 255;

/**

* Maximum number of 802.11b plus 802.11g supported rates 

*/

const TUint8 KMaxNumberOfDot11bAndgRates = 14; 

/**

* Bit mask for checking is supported rate element 

* part of BSS Basic Rate Set (MSB bit is set)

*/

const TUint8 KBasicRateMask = 0x80;

/**

* Maximum length for a WEP key in BYTES

*/

const TUint32 KMaxWEPKeyLength = 29;    // 232 bits

/**

* Length of TKIP key;

*/

const TUint8 KTKIPKeyLength = 16;

/**

* Length of WEP Init.Vector in BYTES

*/

const TUint8 KWepIVLength = 4;

/**

* Length of WEP ICV in BYTES

*/

const TUint8 KWEPICVLength = 4;

/**

* Length of Extended IV field in bytes.

*/

const TUint8 KWepExtendedIVLength = 4;

/**

* Length of CCMP header in bytes.

*/

const TUint8 KCcmpHeaderLength = 8;

/**

* Length of WAPI header in bytes.

*/

const TUint8 KWapiHeaderLength = 18;

/**

* Length of WAPI MIC in bytes.

*/

const TUint8 KWapiMicLength = 16;

/**

* Mask to determine is Ext IV bit up in WEP IV

*/

const TUint32 KWepExtendedIvMask = 0x20000000;

/**

* Mask for Use Protection bit in ERP Information IE

*/

const TUint8 KUseProtectionMask = 0x02;

/**

* Length of MIC in BYTEs

*/

const TUint8 KMicLength = 8;

/** 

* Length of the MIC key in BYTEs

*/ 

const TUint8 KMicKeyLength = 8;

/**

* Length of ID and Length fields of an information element.

*/

const TUint8 KInfoElementHeaderLength = 2;

/**

* Length of the challenge text in BYTES used in shared key authentication

*/

const TUint8 KChallengeTextLength = 128;

/**

* Ethernet header type field identifier for Bounce type packet

*/

const TUint16 KBounceType = 0x8013;

/**

* Ethernet header type field identifier for EAPOL type packet (IEEE 802.1X)

*/

const TUint16 KEapolType = 0x888E;

/**

* Ethernet header type field identifier for WAPI authentication, i.e. WAI,

* type packet

*/

const TUint16 KWaiType = 0x88B4;

/**

* Ethernet header type field identifier for IP type packet

*/

const TUint16 KIpType = 0x0800;

/**

* Ethernet header type field identifier for IPv6 type packet

*/

const TUint16 KIpv6Type = 0x86DD;

/**

* Ethernet header type field identifier for ARP type packet

*/

const TUint16 KArpType = 0x0806;

/**

* Length of OUI field in SNAP header

*/

const TUint8 KOIULength = 3;

/**

* Maximum length of 802.11 MSDU in bytes

*/

const TUint16 KMaxDot11MsduLength = 2304;

/**

* Maximum length of 802.11 A-MSDU in bytes

*/

const TUint16 KMaxDot11AmsduLength = 7935;

/**

* Length of trailing FCS in bytes

*/

const TUint32 KFcsLength = 4;

/**

* Maximum length in bytes of security encapsulation header in a

* 802.11 MPDU

*/

const TUint16 KMaxDot11SecurityHeaderLength = KWapiHeaderLength; // 18

/**

* Maximum length in bytes of security encapsulation trailer in a

* 802.11 MPDU

*/

const TUint16 KMaxDot11SecurityTrailerLength = KWapiMicLength;   // 16

/**

* Maximum length in bytes of security encapsulation header and trailer in a

* 802.11 MPDU

*/

const TUint16 KMaxDot11SecurityEncapsulationLength =    // 34

    KMaxDot11SecurityHeaderLength +                     // 18

    KMaxDot11SecurityTrailerLength;                     // 16    

/**

* Maximum length of 802.11 MPDU we will receive.

* This excludes the tailing FCS ( HW strips it )

* and Address4 field in the MPDU header 

* ( AP-to-AP mode frames are filtered out )

*/

const TUint16 KMaxDot11RxMpduLength =        // 7999

    KHtQoSMacHeaderLength +                  //   30

    KMaxDot11SecurityEncapsulationLength +   //   34

    KMaxDot11AmsduLength;                    // 7935

/**

* Maximum length of 802.11 MPDU we will transmit.

* This excludes the tailing FCS ( HW strips it )

* and Address4 field in the MPDU header 

* ( AP-to-AP mode frames are filtered out )

* Additionally we don't currently support A-MSDU Tx 

*/

const TUint16 KMaxDot11TxMpduLength =        // 2368

    KHtQoSMacHeaderLength +                  //   30

    KMaxDot11SecurityEncapsulationLength +   //   34

    KMaxDot11MsduLength;                     // 2304

/**

* Maximum length of ethernet frame

*/

const TUint16 KMaxEthernetFrameLength = 1514;

/**

* Maximum value in ethernet length field

*/

const TUint16 KMaxEthernetLengthFieldvalue = 1500;

/**

* Length of the TKIP key in BYTEs

*/

const TUint8 KTkIpKeyLength = 16;

/**

* Length of IPv4 address field in BYTEs

*/

const TUint8 KIpv4AddrLength = 4;

/**

* Length of the priority field used in WPA MIC calculation

*/

const TUint32 KWpaPriorityVecLen = 4;

/**

* WPA priority field used in MIC calculation

*/

const TUint8 KWpaPriorityVec[KWpaPriorityVecLen] = {0,0,0,0};

/**

* Mask for frame type for frame control field.

*/

const TUint32 K802Dot11FrameTypeMask = 0xFFFF;

/**

* Mask to determine if U-APSD bit is up in QoS info field of WMM IE

*/

const TUint8 KUapsdQosInfoMask = 0x80;

/**

* Mask for parameter set count in QoS info field of WMM IE

*/

const TUint8 KParamSetCountQosInfoMask = 0x0F;

/**

* Length of WMM Information Element

*/

const TUint8 KWmmInfoElemLen = 7;

/**

* Length of OUI field in Information Elements

*/

const TUint8 KIeOuiLength = 3;

typedef TUint8 TIeOui[KIeOuiLength];

/**

* OUI value of WMM Information Element and

* WMM Parameter Element

*/

const TIeOui KWmmElemOui = { 0x00, 0x50, 0xF2 };

/**

* OUI Type value of WMM Information Element and

* WMM Parameter Element

*/

const TUint8 KWmmElemOuiType = 2;

/**

* OUI Subtype value of WMM Information Element

*/

const TUint8 KWmmInfoElemOuiSubType = 0;

/**

* OUI Subtype value of WMM Parameter Element

*/

const TUint8 KWmmParamElemOuiSubtype = 1;

/**

* Version of WMM Information Element

*/

const TUint8 KWmmInfoElemVersion = 1;

/**

* Version of WMM Parameter Element

*/

const TUint8 KWmmParamElemVersion = 1;

/**

* AC flags in QoS info field of WMM IE

* When a flag is set the corresponding AC is both trigger and delivery enabled

*/

enum TQosInfoUapsdFlag

    {

    EAcVoUapsdFlag = 0x01, // Voice 

    EAcViUapsdFlag = 0x02, // Video 

    EAcBkUapsdFlag = 0x04, // Background 

    EAcBeUapsdFlag = 0x08  // Best Effort 

    };

/**

* Maximum U-APSD Service Period length. Indicates the max number of MSDUs and 

* MMPDUs the WMM AP may deliver to a WMM STA during any service period 

* triggered by the WMM STA.

*/

enum TQosInfoUapsdMaxSpLen

    {

    EMaxSpLenAllFrames  = 0x00,

    EMaxSpLenTwoFrames  = 0x20,

    EMaxSpLenFourFrames = 0x40,

    EMaxSpLenSixFrames  = 0x60

    };

const TUint8 K802Dot11AccessCategoryMask = 0x60;

/**

* WMM Access Categories

*/

enum TWmmAccessCategory

    {

    EAcBestEffort   = 0x00, 

    EAcBackground   = 0x20,

    EAcVideo        = 0x40,

    EAcVoice        = 0x60