lr-wpan-mac-pl-headers.h

Go to the documentation of this file.

/*
 * Copyright (c) 2019 Ritsumeikan University, Shiga, Japan.
 *
 * 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: Alberto Gallegos Ramonet <ramonet@fc.ritsumei.ac.jp>
 */
 
#ifndef LR_WPAN_MAC_PL_HEADERS_H
#define LR_WPAN_MAC_PL_HEADERS_H
 
#include "lr-wpan-fields.h"
 
#include <ns3/header.h>
#include <ns3/mac16-address.h>
#include <ns3/mac64-address.h>
 
namespace ns3
{
namespace lrwpan
{
 
/**
 * \ingroup lr-wpan
 * Implements the header for the MAC payload beacon frame according to
 * the IEEE 802.15.4-2011 Std.
 */
class BeaconPayloadHeader : public Header
{
  public:
    BeaconPayloadHeader();
    /**
     * \brief Get the type ID.
     * \return the object TypeId
     */
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
    /**
     * Set the superframe specification field to the beacon payload header.
     * \param sfrmField The superframe specification field (bitmap)
     */
    void SetSuperframeSpecField(uint16_t sfrmField);
    /**
     * Set the superframe Guaranteed Time Slot (GTS) fields to the beacon payload header.
     * \param gtsFields The GTS fields.
     */
    void SetGtsFields(GtsFields gtsFields);
    /**
     * Set the superframe Pending Address fields to the beacon payload header.
     * \param pndAddrFields The Pending Address fields.
     */
    void SetPndAddrFields(PendingAddrFields pndAddrFields);
    /**
     * Get the superframe specification field from the beacon payload header.
     * \return The superframe specification field (bitmap)
     */
    uint16_t GetSuperframeSpecField() const;
    /**
     * Get the Guaranteed Time Slots (GTS) fields from the beacon payload header.
     * \return The GTS fields.
     */
    GtsFields GetGtsFields() const;
    /**
     * Get the pending address fields from the beacon payload header.
     * \return The Pending Address fields.
     */
    PendingAddrFields GetPndAddrFields() const;
 
  private:
    /**
     * Superframe Specification Field
     */
    uint16_t m_superframeField;
    /**
     * GTS Fields
     */
    GtsFields m_gtsFields;
    /**
     * Pending Address Fields
     */
    PendingAddrFields m_pndAddrFields;
};
 
/**
 * \ingroup lr-wpan
 * Implements the header for the MAC payload command frame according to
 * the IEEE 802.15.4-2011 Std.
 * - Association Response Command (See 5.3.2.2.)
 * - Coordinator Realigment Command (See 5.3.8.)
 * - Association Request Command (See 5.3.1.)
 */
class CommandPayloadHeader : public Header
{
  public:
    /**
     *  The MAC command frames.
     *  See IEEE 802.15.4-2011, Table 5
     */
    enum MacCommand
    {
        ASSOCIATION_REQ = 0x01,      //!< Association request (RFD true: Tx)
        ASSOCIATION_RESP = 0x02,     //!< Association response (RFD true: Rx)
        DISASSOCIATION_NOTIF = 0x03, //!< Disassociation notification (RFD true: TX, Rx)
        DATA_REQ = 0x04,             //!< Data Request (RFD true: Tx)
        PANID_CONFLICT = 0x05,       //!< Pan ID conflict notification (RFD true: Tx)
        ORPHAN_NOTIF = 0x06,         //!< Orphan Notification (RFD true: Tx)
        BEACON_REQ = 0x07,           //!< Beacon Request (RFD true: none )
        COOR_REALIGN = 0x08,         //!< Coordinator Realignment (RFD true: Rx)
        GTS_REQ = 0x09,              //!< GTS Request (RFD true: none)
        CMD_RESERVED = 0xff          //!< Reserved
    };
 
    CommandPayloadHeader();
    /**
     * Constructor
     * \param macCmd the command type of this command header
     */
    CommandPayloadHeader(MacCommand macCmd);
    /**
     * \brief Get the type ID.
     * \return the object TypeId
     */
    static TypeId GetTypeId();
    TypeId GetInstanceTypeId() const override;
    uint32_t GetSerializedSize() const override;
    void Serialize(Buffer::Iterator start) const override;
    uint32_t Deserialize(Buffer::Iterator start) override;
    void Print(std::ostream& os) const override;
 
    /**
     * Set the command frame type
     * \param macCmd the command frame type
     */
    void SetCommandFrameType(MacCommand macCmd);
    /**
     * Set the Capability Information Field to the command payload header (Association Request
     * Command).
     * \param cap The capability Information field
     */
    void SetCapabilityField(uint8_t cap);
    /**
     *  Set the coordinator short address (16 bit address).
     * \param addr The coordinator short address.
     */
    void SetCoordShortAddr(Mac16Address addr);
    /**
     *  Set the logical channel number.
     * \param channel The channel number.
     */
    void SetChannel(uint8_t channel);
    /**
     *  Set the logical channel page number.
     * \param page The page number.
     */
    void SetPage(uint8_t page);
    /**
     * Get the PAN identifier.
     * \param id The PAN identifier.
     */
    void SetPanId(uint16_t id);
    /**
     * Set the Short Address Assigned by the coordinator
     * (Association Response and Coordinator Realigment Commands).
     * \param shortAddr The short address assigned by the coordinator
     */
    void SetShortAddr(Mac16Address shortAddr);
    /**
     * Set status resulting from the association attempt (Association Response Command).
     * \param status The status resulting from the association attempt
     */
    void SetAssociationStatus(uint8_t status);
    /**
     * Get the Short address assigned by the coordinator
     * (Association Response and Coordinator Realigment commands).
     * \return The Mac16Address assigned by the coordinator
     */
    Mac16Address GetShortAddr() const;
    /**
     * Get the status resulting from an association request (Association Response Command).
     * \return The resulting status from an association request
     */
    uint8_t GetAssociationStatus() const;
    /**
     * Get the command frame type ID
     * \return The command type ID from the command payload header
     */
    MacCommand GetCommandFrameType() const;
    /**
     * Get the Capability Information Field from the command payload header.
     * (Association Request Command)
     * \return The Capability Information Field (8 bit bitmap)
     */
    uint8_t GetCapabilityField() const;
    /**
     *  Get the coordinator short address.
     * \return The coordinator short address (16 bit address)
     */
    Mac16Address GetCoordShortAddr() const;
    /**
     *  Get the logical channel number.
     * \return The channel number
     */
    uint8_t GetChannel() const;
    /**
     *  Get the logical channel page number.
     * \return The page number.
     */
    uint8_t GetPage() const;
    /**
     * Get the PAN identifier.
     * \return The PAN Identifier
     */
    uint16_t GetPanId() const;
 
  private:
    MacCommand m_cmdFrameId;       //!< The command Frame Identifier (Used by all commands)
    uint8_t m_capabilityInfo;      //!< Capability Information Field
                                   //!< (Association Request Command)
    Mac16Address m_shortAddr;      //!< Contains the short address assigned by the coordinator
                                   //!< (Association Response and Coordinator Realiagment Command)
    Mac16Address m_coordShortAddr; //!< The coordinator short address
                                   //!< (Coordinator realigment command)
    uint16_t m_panid;              //!< The PAN identifier (Coordinator realigment command)
    uint8_t m_logCh;               //!< The channel number (Coordinator realigment command)
    uint8_t m_logChPage;           //!< The channel page number (Coordinator realigment command)
    uint8_t m_assocStatus;         //!< Association Status (Association Response Command)
};
 
} // namespace lrwpan
} // namespace ns3
 
#endif /* LR_WPAN_MAC_PL_HEADERS_H */