Ieee80211Frame.msg

Msg File src/inet/linklayer/ieee80211/mac/Ieee80211Frame.msg

Name Type Description
BitVector class (no description)
Ieee80211FrameType enum

802.11 frame type constants (type+subtype), for the "type" field of Ieee80211FrameControl
AckPolicy enum

Ack policy values for the 802.11 QoS control field
Ieee80211Frame packet

The common part of 802.11 frames.
Ieee80211OneAddressFrame packet

Format of a 802.11 frame with address1 present, like ACK and CTS
Ieee80211ACKFrame packet

Format of the 802.11 ACK frame
Ieee80211TwoAddressFrame packet

Format of a 802.11 frame with address1 and address2 present
Ieee80211RTSFrame packet

Format of the 802.11 RTS frame
Ieee80211CTSFrame packet

Format of the 802.11 CTS frame
Ieee80211DataOrMgmtFrame packet

Common base class for 802.11 data and management frames
Ieee80211DataFrame packet

Format of the 802.11 data frame
Ieee80211DataFrameWithSNAP packet

802.11 data frame with the 8-byte SNAP header (AA AA 03, 00 00 00, <2-byte EtherType>)
Ieee80211ManagementFrame packet

Base class for 802.11 management frames (subclasses will add frame body contents)
Ieee80211ActionFrame packet

8.3.3.13 Action frame format -- mgmt frame with subtype action
Ieee80211MsduSubframe packet (no description)
Ieee80211AMsdu packet (no description)
Ieee80211AddbaRequest packet

Table 8-203���ADDBA Request frame Action field format -- 736p.
Ieee80211AddbaResponse packet (no description)
Ieee80211Delba packet

8.5.5.4 DELBA frame format
Ieee80211BlockAckReq packet

8.3.1.8 BlockAckReq frame format
Ieee80211BasicBlockAckReq packet (no description)
Ieee80211CompressedBlockAckReq packet (no description)
Ieee80211MultiTidBlockAckReq packet (no description)
Ieee80211BlockAck packet

8.3.1.9 BlockAck frame format -- 410p.
Ieee80211BasicBlockAck packet

8.3.1.9.2 Basic BlockAck variant -- 411p.
Ieee80211CompressedBlockAck packet

8.3.1.9.3 Compressed BlockAck variant
Ieee80211MultiTidBlockAck packet

8.3.1.9.4 Multi-TID BlockAck variant

Source code

//
// Copyright (C) 2006 Andras Varga
// Copyright (C) 2001 Eric Wu and Steve Woon, Monash University, Melbourne, Australia
//
// This program is free software; you can redistribute it and/or
// modify it under the terms of the GNU Lesser General Public License
// as published by the Free Software Foundation; either version 2
// of the License, or (at your option) any later version.
//
// This program is distributed in the hope that it will be useful,
// but WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
// GNU Lesser General Public License for more details.
//
// You should have received a copy of the GNU Lesser General Public License
// along with this program; if not, see <http://www.gnu.org/licenses/>.


import inet.linklayer.common.MACAddress;
import inet.linklayer.common.Ieee802Ctrl;

cplusplus {{
#include "inet/common/BitVector.h"
}}

namespace inet;

class BitVector
{
    @existingClass;
    @opaque;
    @toString(.toString());
}

namespace inet::ieee80211;

cplusplus {{
const unsigned int LENGTH_RTS = 160;    //bits
const unsigned int LENGTH_CTS = 112;    //bits
const unsigned int LENGTH_ACK = 112;    //bits
const unsigned int LENGTH_MGMT = 28 * 8;    //bits
const unsigned int LENGTH_ADDBAREQ = LENGTH_MGMT + 9*8; // mgmt length + action body length
const unsigned int LENGTH_BASIC_BLOCKACK = (16 + 2 + (2 + 128) + 4) * 8; // header + ba control + ba information + fcs
const unsigned int DATAFRAME_HEADER_MINLENGTH = 28 * 8;    //bits without QoS, without Address4, without SNAP: 2 + 2 + 3*6(addresses) + 2 + 4(crc)
const unsigned int QOSCONTROL_BITS = 2 * 8;    // QoS Control field length (bits)
const unsigned int SNAP_HEADER_BYTES = 8;
const short int MAX_NUM_FRAGMENTS = 16;
const unsigned int LENGTH_A_MSDU_SUBFRAME_HEADER = 14 * 8; //48 + 48 + 16 bits
}}

//
// 802.11 frame type constants (type+subtype), for the "type" field of
// Ieee80211FrameControl
//
enum Ieee80211FrameType
{
    // management:
    ST_ASSOCIATIONREQUEST = 0x00;
    ST_ASSOCIATIONRESPONSE = 0x01;
    ST_REASSOCIATIONREQUEST = 0x02;
    ST_REASSOCIATIONRESPONSE = 0x03;
    ST_PROBEREQUEST = 0x04;
    ST_PROBERESPONSE = 0x05;
    ST_BEACON = 0x08;
    ST_ATIM = 0x09;
    ST_DISASSOCIATION = 0x0a;
    ST_AUTHENTICATION = 0x0b;
    ST_DEAUTHENTICATION = 0x0c;
    ST_ACTION = 0x0d;
    ST_NOACKACTION = 0x0e;

    // control (CFEND/CFEND_CFACK omitted):
    ST_PSPOLL = 0x1a;
    ST_RTS = 0x1b;
    ST_CTS = 0x1c;
    ST_ACK = 0x1d;
    ST_BLOCKACK_REQ = 0x18;
    ST_BLOCKACK     = 0x19;

    // data (CFPOLL/CFACK subtypes omitted):
    ST_DATA = 0x20;
    ST_DATA_WITH_QOS = 0x28;
    //Feedback frame for multicast tramsmission
    ST_LBMS_REQUEST = 0x30;
    ST_LBMS_REPORT = 0x31;
}

//
// Ack policy values for the 802.11 QoS control field
//
enum AckPolicy
{
    NORMAL_ACK = 0;
    NO_ACK = 1;
    NO_EXPLICIT_ACK = 2;
    BLOCK_ACK = 3;
}

//
// The common part of 802.11 frames.
//
// NOTE:
// FCS value is not explicitly modeled, but it is included in the length.
// Frame control format fields not supported by this model are omitted:
// MoreFlag, PowerMgmt, MoreData, WEP, Order.
//
packet Ieee80211Frame
{
    byteLength = LENGTH_ACK / 8;
    short type @enum(Ieee80211FrameType); // type and subtype
    bool toDS;
    bool fromDS;
    bool retry;
    bool moreFragments;
    // TODO: rename to durationField (levy)
    simtime_t duration = -1; // "duration" in the Duration/ID field (-1=no duration)
    short AID = -1;          // "id" (Association ID) in the Duration/ID field (-1=no ID)
    MACAddress receiverAddress; // aka address1
    simtime_t MACArrive;    // FIXME remove it, technical data, used inside of MAC module
}

//
// Format of a 802.11 frame with address1 present, like ACK and CTS
//
packet Ieee80211OneAddressFrame extends Ieee80211Frame
{
}

//
// Format of the 802.11 ACK frame
//
packet Ieee80211ACKFrame extends Ieee80211OneAddressFrame
{
    byteLength = LENGTH_ACK / 8;
    type = ST_ACK;
}

//
// Format of a 802.11 frame with address1 and address2 present
//
packet Ieee80211TwoAddressFrame extends Ieee80211OneAddressFrame
{
    byteLength = LENGTH_RTS / 8;
    MACAddress transmitterAddress; // aka address2
}

//
// Format of the 802.11 RTS frame
//
packet Ieee80211RTSFrame extends Ieee80211TwoAddressFrame
{
    byteLength = LENGTH_RTS / 8;
    type = ST_RTS;
}

//
// Format of the 802.11 CTS frame
//
packet Ieee80211CTSFrame extends Ieee80211OneAddressFrame
{
    byteLength = LENGTH_CTS / 8;
    type = ST_CTS;
}

//
// Common base class for 802.11 data and management frames
//
packet Ieee80211DataOrMgmtFrame extends Ieee80211TwoAddressFrame
{
    byteLength = LENGTH_MGMT / 8;
    MACAddress address3;
    short fragmentNumber;
    uint16 sequenceNumber;
}

//
// Format of the 802.11 data frame
//
packet Ieee80211DataFrame extends Ieee80211DataOrMgmtFrame
{
//  The presence of the Address 4 field is determined by the setting of the To DS and From DS subfields of
//  the Frame Control field (see below). The QoS Control field is present when the QoS subfield of the Subtype
//  field is set to 1 (8.3.2.1 Data frame format)
//  FIXME: byteLength is not a constant value (DATAFRAME_HEADER_MINLENGTH / 8 = 28).
//  For example, with Address 4 and without QoS the correct length is 34 bytes.
//  Without Address 4 and QoS the correct value is indeed 28.
//  With Address 4 and QoS the correct value is indeed 36.
    byteLength = DATAFRAME_HEADER_MINLENGTH / 8;
    type = ST_DATA;         // or ST_DATA_WITH_QOS
    MACAddress address4;    // optional field, exists when toDS and fromDS are true
    uint16 qos;             // TODO nobody uses this currently, only its parts like tid below... 
    int ackPolicy @enum(AckPolicy); //FIXME in real life this is part of the optional qos field above...
    uint8 tid; //FIXME in real life this is part of the optional qos field above...
    bool aMsduPresent = false; // 8.2.4.5.9 A-MSDU Present subfield FIXME in real life this is part of the optional qos field above...
}

//TODO this can be introduced when the SNAP header 
//packet Ieee80211QoSDataFrame extends Ieee80211DataFrame
//{
//    type = ST_DATA_WITH_QOS;
//    byteLength = (DATAFRAME_HEADER_MINLENGTH + QOSCONTROL_BITS) / 8;
//    int ackPolicy @enum(AckPolicy); //FIXME in real life this is part of the optional qos field above...
//    uint8 tid;
//    // TODO: other QoS control field parts
//}

//
// 802.11 data frame with the 8-byte SNAP header (AA AA 03, 00 00 00, <2-byte ~EtherType>)
//
packet Ieee80211DataFrameWithSNAP extends Ieee80211DataFrame
{
    byteLength = DATAFRAME_HEADER_MINLENGTH / 8 + SNAP_HEADER_BYTES; // TODO: LLC(SNAP) headers should be in a separate packet
    int etherType @enum(EtherType);
}

//
// Base class for 802.11 management frames (subclasses will add frame body contents)
//
packet Ieee80211ManagementFrame extends Ieee80211DataOrMgmtFrame
{
}

// 8.3.3.13 Action frame format -- mgmt frame with subtype action
packet Ieee80211ActionFrame extends Ieee80211ManagementFrame
{
    type = ST_ACTION;
    short category;
    // TODO: subclasses will add action subfield contents
    //short action @enum(WirelessNetworkManagementAction); // action TODO: remove it
}

packet Ieee80211MsduSubframe
{
    bitLength = LENGTH_A_MSDU_SUBFRAME_HEADER; // + snap header if necessary
    MACAddress sa; // source addr.
    MACAddress da; // destination addr.
    int length;
    int etherType @enum(EtherType); // TODO: review optional snap header (the standard does not define it: Figure 8-32���A-MSDU subframe structure) 
}

packet Ieee80211AMsdu
{
    Ieee80211MsduSubframe subframes[];
}

//
// Table 8-203���ADDBA Request frame Action field format -- 736p.
//
packet Ieee80211AddbaRequest extends Ieee80211ActionFrame
{
    byteLength = LENGTH_ADDBAREQ / 8;
    category = 3; // representing Block Ack
    int blockAckAction = 0; // representing ADDBA request
    int dialogToken = 1; // nonzero, arbitrary

    // Block Ack Parameter Set field
    bool aMsduSupported; // The A-MSDU Supported subfield determines whether an A-MSDU may be carried in a QoS data MPDU sent under this Block Ack agreement.
    bool blockAckPolicy; // The Block Ack Policy subfield is set to 1 for immediate Block Ack and 0 for delayed Block Ack.
    int tid; // The TID subfield contains the value of the TC or TS for which the BlockAck is being requested.
    int bufferSize; // The Buffer Size subfield indicates the number of buffers available for this particular TID

    // Block Ack Timeout Value field
    // The Block Ack Timeout Value field contains the duration, in TUs, after which the Block Ack setup is
    // terminated, if there are no frame exchanges (see 10.5.4) within this duration using this Block Ack
    //  agreement. A value of 0 disables the timeout.
    simtime_t blockAckTimeoutValue;

    // Block Ack Starting Sequence Control
    // The Starting Sequence Number subfield of the Block Ack Starting Sequence Control subfield contains the sequence number of the first MSDU for which this Basic
    // BlockAckReq frame is sent. The Fragment Number subfield is set to 0.
    int _fragmentNumber = 0; // FIXME: DataOrMgmtFreme has a fragmentNumber
    int startingSequenceNumber; // the sequence number of the first MSDU

}

packet Ieee80211AddbaResponse extends Ieee80211ActionFrame
{
    // byteLength TODO
    category = 3; // representing Block Ack
    int blockAckAction = 1; // representing ADDBA response
    int dialogToken = 1; // The Dialog Token field value is copied from the corresponding received ADDBA Request frame.
    int statusCode; // The Status Code field is used in a response management frame to indicate the success or failure of a requested operation.

    // Block Ack Parameter Set field
    bool aMsduSupported; // The A-MSDU Supported subfield determines whether an A-MSDU may be carried in a QoS data MPDU sent under this Block Ack agreement.
    bool blockAckPolicy; // The Block Ack Policy subfield is set to 1 for immediate Block Ack and 0 for delayed Block Ack.
    int tid; // The TID subfield contains the value of the TC or TS for which the BlockAck is being requested.
    int bufferSize; // The Buffer Size subfield indicates the number of buffers available for this particular TID

    // Block Ack Timeout Value field
    // The Block Ack Timeout Value field contains the duration, in TUs, after which the Block Ack setup is
    // terminated, if there are no frame exchanges (see 10.5.4) within this duration using this Block Ack
    //  agreement. A value of 0 disables the timeout.
    simtime_t blockAckTimeoutValue;
}

//
// 8.5.5.4 DELBA frame format
//
packet Ieee80211Delba extends Ieee80211ActionFrame
{
    // byteLength TODO
    category = 3;
    int blockAckAction = 2; // representing DELBA

    // DELBA Parameter Set
    // It is set to 1 to indicate the originator and is set to 0 to indicate the recipient.
    // The Initiator subfield indicates if the originator or the recipient of the data is sending this frame.
    bool initiator;

    // The TID subfield indicates the TSID or the UP for which the Block Ack has been originally set up.
    int tid;

    // This Reason Code field is used to indicate the reason that an unsolicited notification management frame of
    // type Disassociation, Deauthentication, DELTS, DELBA, DLS Teardown, or Mesh Peering Close was
    // generated.
    int reasonCode;
}



//
// 8.3.1.8 BlockAckReq frame format
//
packet Ieee80211BlockAckReq extends Ieee80211TwoAddressFrame
{
    // byteLength TODO
    // The RA field of the BlockAck frame is the address of the recipient STA that requested the Block Ack.
    // The TA field is the address of the STA transmitting the BlockAck frame.
    type = ST_BLOCKACK_REQ;

    bool multiTid;
    bool compressedBitmap;
    bool barAckPolicy; // 0-Normal Acknowledgment, 1-No Acknowledgment.
}

packet Ieee80211BasicBlockAckReq extends Ieee80211BlockAckReq
{
    // byteLength TODO

    int tidInfo; //  The TID_INFO subfield of the BAR Control field of the Basic BlockAckReq frame contains the TID for which a Basic BlockAck frame is requested.

    // The BAR Information field of the Basic BlockAckReq frame contains the Block Ack Starting Sequence
    // Control subfield, as shown in Figure 8-21. The Starting Sequence Number subfield of the Block Ack
    // Starting Sequence Control subfield contains the sequence number of the first MSDU for which this Basic
    // BlockAckReq frame is sent. The Fragment Number subfield is set to 0.
    int fragmentNumber = 0;
    int startingSequenceNumber;

    multiTid = 0;
    compressedBitmap = 0;
}


packet Ieee80211CompressedBlockAckReq extends Ieee80211BlockAckReq
{
    // byteLength TODO

    int tidInfo; // The TID_INFO subfield of the BAR Control field of the Compressed BlockAckReq frame contains the TID for which a BlockAck frame is requested.

    // The RA field of the BlockAck frame is the address of the recipient STA that requested the Block Ack.
    // The TA field is the address of the STA transmitting the BlockAck frame.
    type = ST_BLOCKACK_REQ;
    // The BAR Information field of the Compressed BlockAckReq frame contains the Block Ack Starting
    // Sequence Control subfield, as shown in Figure 8-21. The Starting Sequence Number subfield of the Block
    // Ack Starting Sequence Control subfield contains the sequence number of the first MSDU or A-MSDU for
    // which this BlockAckReq frame is sent. The Fragment Number subfield of the Block Ack Starting Sequence
    // Control subfield is set to 0.

    int fragmentNumber = 0;
    int startingSequenceNumber;

    multiTid = 0;
    compressedBitmap = 1;
}

packet Ieee80211MultiTidBlockAckReq extends Ieee80211BlockAckReq
{
    // byteLength TODO
    // The RA field of the BlockAck frame is the address of the recipient STA that requested the Block Ack.
    // The TA field is the address of the STA transmitting the BlockAck frame.
    type = ST_BLOCKACK_REQ;
    // The BAR Information field of the Compressed BlockAckReq frame contains the Block Ack Starting
    // Sequence Control subfield, as shown in Figure 8-21. The Starting Sequence Number subfield of the Block
    // Ack Starting Sequence Control subfield contains the sequence number of the first MSDU or A-MSDU for
    // which this BlockAckReq frame is sent. The Fragment Number subfield of the Block Ack Starting Sequence
    // Control subfield is set to 0.

    multiTid = 1;
    compressedBitmap = 1;

    // TODO: unimplemented
}


//
// 8.3.1.9 BlockAck frame format -- 410p.
//
packet Ieee80211BlockAck extends Ieee80211TwoAddressFrame
{
    // byteLength TODO
    // The RA field of the BlockAck frame is the address of the recipient STA that requested the Block Ack.
    // The TA field is the address of the STA transmitting the BlockAck frame.
    type = ST_BLOCKACK;

    // BA Control
    bool blockAckPolicy; // Table 8-17���BA Ack Policy subfield: 0-Normal Acknowledgment, 1-No Acknowledgment.

    // Table 8-18���BlockAck frame variant encoding
    bool multiTid;
    bool compressedBitmap;
}

//
// 8.3.1.9.2 Basic BlockAck variant -- 411p.
//
packet Ieee80211BasicBlockAck extends Ieee80211BlockAck
{
    // byteLength TODO
    multiTid = 0;
    compressedBitmap = 0;

    // The BA Information field of the Basic BlockAck frame comprises the Block Ack Starting Sequence Control
    // subfield and the Block Ack Bitmap subfield, as shown in Figure 8-26.

    int fragmentNumber = 0; // ??
    int startingSequenceNumber;
    // The Block Ack Bitmap subfield is 128 octets in length and is used to indicate the received status of up to
    // 64 MSDUs. Bit position n of the Block Ack bitmap, if equal to 1, acknowledges receipt of an MPDU with an
    // MPDU sequence control value equal to (Block Ack Starting Sequence Control + n). Bit position n of the
    // Block Ack bitmap, if equal to 0, indicates that an MPDU with MPDU sequence control value equal to
    // (Block Ack Starting Sequence Control + n) has not been received. Each of the MPDU Sequence Control
    // field and Block Ack Starting Sequence Control subfield values are treated as a 16-bit unsigned integer. For
    // unused fragment numbers of an MSDU, the corresponding bits in the bitmap are set to 0.
    BitVector blockAckBitmap[64]; // 64 * 16 bitmatrix

    // The TID_INFO subfield of the BA Control field of the Basic BlockAck frame contains the TID for which
    // this BlockAck frame is sent.
    int tidInfo;
}

//
// 8.3.1.9.3 Compressed BlockAck variant
//
packet Ieee80211CompressedBlockAck extends Ieee80211BlockAck
{
    // byteLength TODO
    multiTid = 0;
    compressedBitmap = 1;

    // The BA Information field of the Compressed BlockAck frame comprises the Block Ack Starting Sequence
    // Control subfield and the Block Ack Bitmap subfield, as shown in Figure 8-27.

    int fragmentNumber = 0;
    int startingSequenceNumber;
    BitVector blockAckBitmap; // 64 bits

    // The TID_INFO subfield of the BA Control field of the Compressed BlockAck frame contains the TID for
    // which this BlockAck frame is sent.
    int tidInfo;
}

//
// 8.3.1.9.4 Multi-TID BlockAck variant
//
packet Ieee80211MultiTidBlockAck extends Ieee80211BlockAck
{
    // byteLength TODO
    multiTid = 1;
    compressedBitmap = 1;

    // TODO: unimplemented
}

This documentation is released under the Creative Commons license