lr-wpan-mac-header.h

Go to the documentation of this file.

/*
 * Copyright (c) 2011 The Boeing Company
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License version 2 as
 * published by the Free Software Foundation;
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
 *
 *  Author: kwong yin <kwong-sang.yin@boeing.com>
 */
 
/*
 * the following classes implements the 802.15.4 Mac Header
 * There are 4 types of 802.15.4 Mac Headers Frames, and they have these fields
 *
 *    Headers Frames  : Fields
 *    -------------------------------------------------------------------------------------------
 *    Beacon          : Frame Control, Sequence Number, Address Fields+, Auxiliary Security
 * Header++. Data            : Frame Control, Sequence Number, Address Fields++, Auxiliary Security
 * Header++. Acknowledgment  : Frame Control, Sequence Number. Command         : Frame Control,
 * Sequence Number, Address Fields++, Auxiliary Security Header++.
 *
 *    + - The Address fields in Beacon frame is made up of the Source PAN Id and address only and
 * size is  4 or 8 octets whereas the other frames may contain the Destination PAN Id and address as
 *        well. (see specs).
 *    ++ - These fields are optional and of variable size
 */
 
#ifndef LR_WPAN_MAC_HEADER_H
#define LR_WPAN_MAC_HEADER_H
 
#include <ns3/header.h>
#include <ns3/mac16-address.h>
#include <ns3/mac64-address.h>
 
namespace ns3
{
 
class LrWpanMacHeader : public Header
{
  public:
    enum LrWpanMacType
    {
        LRWPAN_MAC_BEACON = 0,         
        LRWPAN_MAC_DATA = 1,           
        LRWPAN_MAC_ACKNOWLEDGMENT = 2, 
        LRWPAN_MAC_COMMAND = 3,        
        LRWPAN_MAC_RESERVED            
    };
 
    enum AddrModeType
    {
        NOADDR = 0,
        RESADDR = 1,
        SHORTADDR = 2,
        EXTADDR = 3
    };
 
    enum KeyIdModeType
    {
        IMPLICIT = 0,
        NOKEYSOURCE = 1,
        SHORTKEYSOURCE = 2,
        LONGKEYSOURCE = 3
    };
 
    LrWpanMacHeader();
 
    LrWpanMacHeader(LrWpanMacType wpanMacType, uint8_t seqNum);
 
    ~LrWpanMacHeader() override;
 
    LrWpanMacType GetType() const;
    uint16_t GetFrameControl() const;
    bool IsSecEnable() const;
    bool IsFrmPend() const;
    bool IsAckReq() const;
    bool IsPanIdComp() const;
    uint8_t GetFrmCtrlRes() const;
    uint8_t GetDstAddrMode() const;
    uint8_t GetFrameVer() const;
    uint8_t GetSrcAddrMode() const;
    uint8_t GetSeqNum() const;
    uint16_t GetDstPanId() const;
    Mac16Address GetShortDstAddr() const;
    Mac64Address GetExtDstAddr() const;
    uint16_t GetSrcPanId() const;
    Mac16Address GetShortSrcAddr() const;
    Mac64Address GetExtSrcAddr() const;
    uint8_t GetSecControl() const;
    uint32_t GetFrmCounter() const;
 
    uint8_t GetSecLevel() const;
    uint8_t GetKeyIdMode() const;
    uint8_t GetSecCtrlReserved() const;
    uint32_t GetKeyIdSrc32() const;
    uint64_t GetKeyIdSrc64() const;
    uint8_t GetKeyIdIndex() const;
    bool IsBeacon() const;
    bool IsData() const;
    bool IsAcknowledgment() const;
    bool IsCommand() const;
    void SetType(LrWpanMacType wpanMacType);
    void SetFrameControl(uint16_t frameControl);
    void SetSecEnable();
    void SetSecDisable();
    void SetFrmPend();
    void SetNoFrmPend();
    void SetAckReq();
    void SetNoAckReq();
    void SetPanIdComp();
    void SetNoPanIdComp();
    void SetFrmCtrlRes(uint8_t res);
    void SetDstAddrMode(uint8_t addrMode);
    void SetFrameVer(uint8_t ver);
    void SetSrcAddrMode(uint8_t addrMode);
    void SetSeqNum(uint8_t seqNum);
    /* The Source/Destination Addressing fields are only set if SrcAddrMode/DstAddrMode are set */
    void SetSrcAddrFields(uint16_t panId, Mac16Address addr);
    void SetSrcAddrFields(uint16_t panId, Mac64Address addr);
    void SetDstAddrFields(uint16_t panId, Mac16Address addr);
    void SetDstAddrFields(uint16_t panId, Mac64Address addr);
 
    /* Auxiliary Security Header is only set if Sec Enable (SecU) field is set to 1 */
    void SetSecControl(uint8_t secLevel);
    void SetFrmCounter(uint32_t frmCntr);
    void SetSecLevel(uint8_t secLevel);
    void SetKeyIdMode(uint8_t keyIdMode);
    void SetSecCtrlReserved(uint8_t res);
    /* Variable length will be dependent on Key Id Mode*/
    void SetKeyId(uint8_t keyIndex);
    void SetKeyId(uint32_t keySrc, uint8_t keyIndex);
    void SetKeyId(uint64_t keySrc, uint8_t keyIndex);
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
 
    void Print(std::ostream& os) const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
 
  private:
    /* Frame Control 2 Octets */
    /* Frame Control field - see 7.2.1.1 */
    uint8_t m_fctrlFrmType; 
    uint8_t m_fctrlSecU;    
    uint8_t m_fctrlFrmPending;  
    uint8_t m_fctrlAckReq;      
    uint8_t m_fctrlPanIdComp;   
    uint8_t m_fctrlReserved;    
    uint8_t m_fctrlDstAddrMode; 
    uint8_t m_fctrlFrmVer;      
    uint8_t m_fctrlSrcAddrMode; 
 
    /* Sequence Number */
    uint8_t m_SeqNum; 
 
    /* Addressing fields */
    uint16_t m_addrDstPanId;         
    Mac16Address m_addrShortDstAddr; 
    Mac64Address m_addrExtDstAddr;   
    uint16_t m_addrSrcPanId;         
    Mac16Address m_addrShortSrcAddr; 
    Mac64Address m_addrExtSrcAddr;   
 
    /* Auxiliary Security Header - See 7.6.2 - 0, 5, 6, 10 or 14 Octets */
    // uint8_t m_auxSecCtrl;              // 1 Octet see below
    uint32_t m_auxFrmCntr; 
 
    /* Security Control fields - See 7.6.2.2 */
    uint8_t m_secctrlSecLevel;  
    uint8_t m_secctrlKeyIdMode; 
                                // = 0 - Key is determined implicitly
                                //       from originator and recipient
                                // = 1 - 1 Octet Key Index
                                // = 2 - 1 Octet Key Index and 4 oct Key src
                                // = 3 - 1 Octet Key Index and 8 oct Key src
 
    uint8_t m_secctrlReserved; 
 
    union {
        uint32_t m_auxKeyIdKeySrc32; 
        uint64_t m_auxKeyIdKeySrc64; 
    };                               
 
    uint8_t m_auxKeyIdKeyIndex; 
 
}; // LrWpanMacHeader
 
}; // namespace ns3
 
#endif /* LR_WPAN_MAC_HEADER_H */