lorawan-mac-end-device.h

Go to the documentation of this file.

/* -*- Mode:C++; c-file-style:"gnu"; indent-tabs-mode:nil; -*- */
/*
 * Copyright (c) 2017 University of Padova
 *
 * 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: Davide Magrin <magrinda@dei.unipd.it>
 *         Martina Capuzzo <capuzzom@dei.unipd.it>
 *
 * Modified by: Peggy Anderson <peggy.anderson@usask.ca>
 *              Bastien Tauran <bastien.tauran@viveris.fr>
 */
 
#ifndef LORAWAN_MAC_END_DEVICE_H
#define LORAWAN_MAC_END_DEVICE_H
 
#include "lora-device-address.h"
#include "lora-frame-header.h"
#include "lora-logical-channel-helper.h"
#include "lora-logical-channel.h"
#include "lorawan-mac-header.h"
#include "lorawan-mac.h"
#include "satellite-ut-mac.h"
 
#include <ns3/random-variable-stream.h>
#include <ns3/traced-value.h>
 
#include <list>
#include <stdint.h>
#include <vector>
 
namespace ns3
{
 
class LorawanMacEndDevice : public LorawanMac
{
  public:
    static TypeId GetTypeId(void);
 
    LorawanMacEndDevice();
    LorawanMacEndDevice(Ptr<Node> node, uint32_t satId, uint32_t beamId);
    virtual ~LorawanMacEndDevice();
 
    // Sending methods //
 
    virtual void Send(Ptr<Packet> packet);
 
    virtual void DoSend(Ptr<Packet> packet);
 
    virtual void SendToPhy(Ptr<Packet> packet);
 
    virtual void postponeTransmission(Time nextTxDelay, Ptr<Packet>);
 
    // Receiving methods //
 
    virtual void Receive(Ptr<Packet> packet) = 0;
    virtual void Receive(SatPhy::PacketContainer_t packets, Ptr<SatSignalParameters> /*rxParams*/);
 
    virtual void FailedReception(Ptr<const Packet> packet);
 
    virtual void TxFinished();
 
    // Getters and Setters //
 
    virtual void resetRetransmissionParameters();
 
    void SetDataRateAdaptation(bool adapt);
 
    bool GetDataRateAdaptation(void);
 
    void SetMaxNumberOfTransmissions(uint8_t maxNumbTx);
 
    uint8_t GetMaxNumberOfTransmissions(void);
 
    void SetDataRate(uint8_t dataRate);
 
    uint8_t GetDataRate(void);
 
    virtual uint8_t GetTransmissionPower(void);
 
    void SetDeviceAddress(LoraDeviceAddress address);
 
    LoraDeviceAddress GetDeviceAddress(void);
 
    // void SetRx1DrOffset (uint8_t rx1DrOffset);
 
    // uint8_t GetRx1DrOffset (void);
 
    double GetAggregatedDutyCycle(void);
 
    // MAC command methods //
 
    void ApplyNecessaryOptions(LoraFrameHeader& frameHeader);
 
    void ApplyNecessaryOptions(LorawanMacHeader& macHeader);
 
    void SetMType(LorawanMacHeader::MType mType);
 
    LorawanMacHeader::MType GetMType(void);
 
    void ParseCommands(LoraFrameHeader frameHeader);
 
    void OnLinkCheckAns(uint8_t margin, uint8_t gwCnt);
 
    void OnLinkAdrReq(uint8_t dataRate,
                      uint8_t txPower,
                      std::list<int> enabledChannels,
                      int repetitions);
 
    void OnDutyCycleReq(double dutyCycle);
 
    void OnRxParamSetupReq(Ptr<RxParamSetupReq> rxParamSetupReq);
 
    virtual void OnRxClassParamSetupReq(Ptr<RxParamSetupReq> rxParamSetupReq);
 
    void OnDevStatusReq(void);
 
    void OnNewChannelReq(uint8_t chIndex,
                         double frequency,
                         uint8_t minDataRate,
                         uint8_t maxDataRate);
 
    // Logical channel administration //
 
    void AddLogicalChannel(double frequency);
 
    void SetLogicalChannel(uint8_t chIndex,
                           double frequency,
                           uint8_t minDataRate,
                           uint8_t maxDataRate);
 
    void AddLogicalChannel(Ptr<LoraLogicalChannel> logicalChannel);
 
    void AddLoraSubBand(double startFrequency,
                        double endFrequency,
                        double dutyCycle,
                        double maxTxPowerDbm);
 
    void AddLorawanMacCommand(Ptr<LorawanMacCommand> macCommand);
 
    typedef Callback<void, Mac48Address> GatewayUpdateCallback;
 
    void SetGatewayUpdateCallback(LorawanMacEndDevice::GatewayUpdateCallback cb);
 
    typedef Callback<void, uint32_t, uint32_t> HandoverCallback;
 
    void SetHandoverCallback(LorawanMacEndDevice::HandoverCallback cb);
 
    typedef Callback<void, Ptr<Node>> UpdateAddressAndIdentifierCallback;
 
    void SetUpdateAddressAndIdentifierCallback(
        LorawanMacEndDevice::UpdateAddressAndIdentifierCallback cb);
 
    void SetGwAddress(Mac48Address gwAddress);
 
    void SetSatAddress(Mac48Address satAddress);
 
    void SetRegenerative(bool isRegenerative);
 
    void SetRaChannel(uint32_t raChannel);
 
    void SetPhyRx(Ptr<SatLoraPhyRx> phyRx);
 
    Ptr<SatLoraPhyRx> GetPhyRx();
 
    void ChangeBeam(uint32_t satId, uint32_t beamId);
 
  protected:
    struct LoraRetxParameters
    {
        Time firstAttempt;
        Ptr<Packet> packet = 0;
        bool waitingAck = false;
        uint8_t retxLeft;
    };
 
    Ptr<Node> m_node;
 
    bool m_enableDRAdapt;
 
    uint8_t m_maxNumbTx;
 
    TracedValue<uint8_t> m_dataRate;
 
    TracedValue<double> m_txPower;
 
    uint8_t m_codingRate;
 
    bool m_headerDisabled;
 
    LoraDeviceAddress m_address;
 
    bool CheckHandovers();
 
    virtual Time GetNextClassTransmissionDelay(Time waitingTime);
 
    Ptr<LoraLogicalChannel> GetChannelForTx(void);
 
    uint8_t m_receiveWindowDurationInSymbols;
 
    std::list<Ptr<LorawanMacCommand>> m_macCommandList;
 
    /* Structure containing the retransmission parameters
     * for this device.
     */
    struct LoraRetxParameters m_retxParams;
 
    Ptr<UniformRandomVariable> m_uniformRV;
 
    //  Callbacks  //
 
    TracedCallback<uint8_t, bool, Time, Ptr<Packet>> m_requiredTxCallback;
 
    LorawanMacEndDevice::GatewayUpdateCallback m_gatewayUpdateCallback;
 
    Mac48Address m_gwAddress;
 
    uint32_t m_raChannel;
 
    Ptr<SatLoraPhyRx> m_phyRx;
 
    bool m_isRegenerative;
 
  private:
    std::vector<Ptr<LoraLogicalChannel>> Shuffle(std::vector<Ptr<LoraLogicalChannel>> vector);
 
    Time GetNextTransmissionDelay(void);
 
    bool m_controlDataRate;
 
    EventId m_nextTx;
 
    EventId m_nextRetx;
 
    TracedValue<double> m_lastKnownLinkMargin;
 
    TracedValue<int> m_lastKnownGatewayCount;
 
    TracedValue<double> m_aggregatedDutyCycle;
 
    LorawanMacHeader::MType m_mType;
 
    uint16_t m_currentFCnt;
 
    LorawanMacEndDevice::HandoverCallback m_handoverCallback;
 
    LorawanMacEndDevice::UpdateAddressAndIdentifierCallback m_updateAddressAndIdentifierCallback;
};
 
} /* namespace ns3 */
 
#endif /* LORAWAN_MAC_END_DEVICE_H */